split 0.22.0 & 0.23.0 (with ring-swagger changes)

Author: ikitommi

CHANGELOG.md

@@ -1,10 +1,21 @@
-## 0.22.0-SNAPSHOT
+## 0.23.0-SNAPSHOT
+
+* Ring-swagger 0.21.0
+  * **BREAKING**: new signature for dispatching custom JSON Schema transformations, old signature will break (nicely at compile-time), see [Readme](https://github.com/metosin/ring-swagger/blob/master/README.md) for details.
+  * **BREAKING**: File support moved to ring-swagger. Use `ring.swagger.upload` instead of `compojure.api.upload`.
+  * Support for collections in query parameters. E.g. `:query-params [x :- [Long]]` & url `?x=1&x=2&x=3` should result in `x` being `[1 2 3]`.
+
+## 0.22.0 (30.6.2015)
 
 * Optional integration with [Component](https://github.com/stuartsierra/component).
   Use either `:components`-option of `api-middleware` or `wrap-components`-middleware
   to associate the components with your API. Then you can use `:components`-restructuring
   to destructure your components using letk syntax.
 * fix for [#123](https://github.com/metosin/compojure-api/issues/123)
+* support for pluggable coercion, at both api-level & endpoint-level with option `:coercion`. See the[the tests](./test/compojure/api/coercion_test.clj).
+  * coercion is a function of type - `ring-request->coercion-type->coercion-matcher` allowing protocol-based coercion in the future
+  ** BREAKING**: if you have created custom restructurings using `src-coerce`, they will break (nicely at compile-time)
+
 * new restucturing `:swagger` just for swagger-docs. Does not do any coercion.
 
 ```clojure
@@ -17,11 +28,6 @@
   ...)
 ```
 
-* Ring-swagger 0.21.0
-  * **BREAKING**: new signature for dispatching custom JSON Schema transformations, old signature will break (nicely at compile-time), see [Readme](https://github.com/metosin/ring-swagger/blob/master/README.md) for details.
-  * **BREAKING**: File support moved to ring-swagger. Use `ring.swagger.upload` instead of `compojure.api.upload`.
-  * Support for collections in query parameters. E.g. `:query-params [x :- [Long]]` & url `?x=1&x=2&x=3` should result in `x` being `[1 2 3]`.
-
 ```clojure
 [metosin/ring-swagger "0.21.0-SNAPSHOT"] is available but we use "0.20.4"
 [cheshire "5.5.0"] is available but we use "5.4.0"

README.md

@@ -658,6 +658,10 @@ Mostly provided by Ring-Swagger. Restructuring `:multipart-params` pushes also `
 available consumption.
 
 ```clojure
+;; versions before 0.23.0
+(require '[compojure.api.upload :as upload])
+
+;; versions 0.23.0+
 (require '[ring.swagger.upload :as upload])
 
 (POST* 

examples/src/examples/thingie.clj

@@ -1,7 +1,7 @@
 (ns examples.thingie
   (:require [ring.util.http-response :refer :all]
             [compojure.api.sweet :refer :all]
-            [ring.swagger.upload :refer :all]
+            [compojure.api.upload :refer :all]
             [schema.core :as s]
             ring.swagger.json-schema-dirty
             [examples.pizza :refer [pizza-routes Pizza]]

project.clj

@@ -13,7 +13,8 @@
                  [prismatic/schema "0.4.3"]
                  [org.tobereplaced/lettercase "1.0.0"]
                  [metosin/ring-http-response "0.6.2"]
-                 [metosin/ring-swagger "0.21.0-SNAPSHOT"]
+                 [metosin/ring-swagger "0.20.4"]
+                 [metosin/schema-tools "0.4.3"]
                  [metosin/ring-middleware-format "0.6.0"]
                  [backtick "0.3.3"]
                  [metosin/ring-swagger-ui "2.1.5-M2"]]

src/compojure/api/meta.clj

@@ -70,7 +70,7 @@
   "Return source code for coerce! for a schema with coercion type,
    extracted from a key in a ring request."
   [schema, key, type :- mw/CoercionType]
-  (assert (not (#{:query :json} type)) (str type " is DEPRECATED"))
+  (assert (not (#{:query :json} type)) (str type " is DEPRECATED since 0.22.0. Use :body or :string instead."))
   `(let [value# (keywordize-keys (~key ~+compojure-api-request+))]
      (if-let [matcher# (~type (mw/get-coercion-matcher-provider ~+compojure-api-request+))]
        (schema/coerce! ~schema value# matcher#)

src/compojure/api/upload.clj

@@ -0,0 +1,36 @@
+(ns compojure.api.upload
+  (:require [potemkin :refer [import-vars]]
+            [ring.middleware.multipart-params]
+            [ring.swagger.json-schema :as js]
+            [schema.core :as s]))
+
+(import-vars
+  [ring.middleware.multipart-params
+
+   wrap-multipart-params])
+
+; Works exactly like map schema but wrapped in record for json-type dispatch
+(defrecord Upload [m]
+  schema.core.Schema
+  (walker [this]
+    (let [sub-walker (s/subschema-walker m)]
+      (clojure.core/fn [x]
+       (if (schema.utils/error? x)
+         x
+         (sub-walker x)))))
+  (explain [this] (cons 'file m)))
+
+(def TempFileUpload
+  "Schema for file param created by ring.middleware.multipart-params.temp-file store."
+  (->Upload {:filename s/Str
+             :content-type s/Str
+             :size s/Int
+             (s/optional-key :tempfile) java.io.File}))
+
+(def ByteArrayUpload
+  "Schema for file param created by ring.middleware.multipart-params.byte-array store."
+  (->Upload {:filename s/Str
+             :content-type s/Str
+             :bytes s/Any}))
+
+(defmethod js/json-type Upload [_] {:type "file"})

test/compojure/api/integration_test.clj

@@ -1039,7 +1039,8 @@
           status => 200
           body => {:magic 42})))))
 
-(fact "sequential string parameters"
+; TODO: works with 0.23.0-SNAPSHOT
+#_(fact "sequential string parameters"
   (let [app (api
               (GET* "/ints" []
                 :query-params [i :- [s/Int]]