webspicy 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a450b7c37c1dd58a30dcb2bc1e9317509f1d5e5
-  data.tar.gz: 6f471bbb4aea22f92564c22f720e6eaf50ff5937
+  metadata.gz: 297f6b02ba888bdb7d04063e70ab34a53d572c64
+  data.tar.gz: 551b6a4a2e66adfc8274f949943ede49e8d926a9
 SHA512:
-  metadata.gz: 4bf135af59ee9a2b9dff46a9849b2b2539bf612728d88c719835ed5012c101ae8f0b8b8c1ba4d00010f8db93c42aeb48200e9ccf2b086d133d492bb43bfb7ac1
-  data.tar.gz: 65d79ba0f514277d7bc52e81b3cd92d311708fc58bd570476ab03cc7e4d78ef51e1780a06accc59fbeb686ac17d88fac10e80f6347100ff0f38c23b46d2ee33d
+  metadata.gz: 910823668c7fda4b201c4508ac7c4ac4b43f026970e40c43569fff53756ca4bd2f6d6241e4ad07285aafce3a89628f414ba7f5997b6c6411745200b2791ad0b9
+  data.tar.gz: 2a8769e405659e083e37cdcd0b28125ea3eccfd1783653822e5ce2dc477f737cb72e2ca22d1bc4fcaa960e4e03606773d334997e2941bfcaafab55adae29a22c

data/examples/restful/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.9.0)
+    webspicy (0.10.0)
       finitio (>= 0.5.2)
       http (~> 2)
       path (~> 1.3)
@@ -16,7 +16,7 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     citrus (3.0.2)
     diff-lcs (1.3)
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     finitio (0.5.2)
       citrus (>= 2.4, < 4.0)

data/examples/restful/app.rb

@@ -119,7 +119,22 @@ def loaded_body
   when /csv/
     csv = ::CSV.new(request.body.read, :headers => true, :header_converters => :symbol)
     csv.map {|row| row.to_hash }
+  when /multipart\/form-data/
+    file_body params[:file]
   else
-    halt [415,{},["Unsupported content type"]]
+    halt [415,{},["Unsupported content type: `#{ctype}`"]]
   end
-end
+end
+
+def file_body(file)
+  ctype = Path(file[:filename] || file["filename"]).extname
+  ctype = (file[:type] || file["type"]) if ctype.nil? or ctype.empty?
+  case ctype
+  when /csv/
+    str = file[:tempfile].read
+    csv = ::CSV.new(str, :headers => true, :header_converters => :symbol)
+    csv.map {|row| row.to_hash }
+  else
+    halt [415,{},["Unsupported content type: `#{ctype}`\n#{file.inspect}"]]
+  end
+end

data/examples/restful/webspicy/todo/postFile.yml

@@ -0,0 +1,37 @@
+---
+name: |-
+  Todo
+
+url: |-
+  /todo/
+
+services:
+- method: |-
+    POST
+
+  description: |-
+    Creates new todo items through a CSV file upload
+
+  preconditions: |-
+
+  input_schema: |-
+    .
+
+  output_schema: |-
+    { count: Integer }
+
+  error_schema: |-
+    ErrorSchema
+
+  examples:
+
+    - description: |-
+        when requested with a valid CSV file
+      file_upload:
+        path: ./todos.csv
+        content_type: "text/csv"
+      expected:
+        content_type: application/json
+        status: 201
+      assert:
+        - "pathFD('', count: 3)"

data/examples/restful/webspicy/todo/todos.csv

@@ -0,0 +1,4 @@
+id,description
+10,Write documentation
+11,Create website
+12,Add smart tools

data/lib/webspicy.rb

@@ -14,6 +14,7 @@ module Webspicy
   ###
 
   require 'webspicy/configuration'
+  require 'webspicy/file_upload'
   require 'webspicy/scope'
   require 'webspicy/client'
   require 'webspicy/client/http_client'
@@ -46,7 +47,9 @@ module Webspicy
 
   def resource(raw, file = nil, scope = default_scope)
     with_scope(scope) do
-      FORMALDOC["Resource"].dress(raw)
+      r = FORMALDOC["Resource"].dress(raw)
+      r.located_at!(file) if file
+      r
     end
   end
   module_function :resource

data/lib/webspicy/client/http_client.rb

@@ -23,7 +23,8 @@ module Webspicy
 
       # Instantiate the parameters
       headers = test_case.headers
-      params = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params
+      params  = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params
+      body    = test_case.body || test_case.located_file_upload
 
       # Instantiate the url and strip parameters
       url, params = resource.instantiate_url(params)
@@ -32,7 +33,7 @@ module Webspicy
       url = scope.to_real_url(url, test_case)
 
       # Invoke the service now
-      api.public_send(service.method.to_s.downcase.to_sym, url, params, headers, test_case.body)
+      api.public_send(service.method.to_s.downcase.to_sym, url, params, headers, body)
 
       # Return the result
       Resource::Service::Invocation.new(service, test_case, api.last_response, self)
@@ -70,12 +71,18 @@ module Webspicy
         url = url + "?" + Rack::Utils.build_query(params) if body && !params.empty?
 
         headers ||= {}
-        headers['Content-Type'] ||= 'application/json'
 
-        if body
-          @last_response = HTTP[headers].post(url, body: body)
-        else
+        case body
+        when NilClass
+          headers['Content-Type'] ||= 'application/json'
           @last_response = HTTP[headers].post(url, body: params.to_json)
+        when FileUpload
+          @last_response = HTTP[headers].post(url, form: {
+            body.param_name.to_sym => HTTP::FormData::File.new(body.path, content_type: body.content_type)
+          })
+        else
+          headers['Content-Type'] ||= 'application/json'
+          @last_response = HTTP[headers].post(url, body: body)
         end
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")

data/lib/webspicy/client/rack_test_client.rb

@@ -16,8 +16,8 @@ module Webspicy
 
       # Instantiate the parameters
       headers = test_case.headers.dup
-      params = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params
-      body = test_case.body
+      params  = test_case.dress_params? ? service.dress_params(test_case.params) : test_case.params
+      body    = test_case.body || test_case.located_file_upload
 
       # Instantiate the url and strip parameters
       url, params = resource.instantiate_url(params)
@@ -94,12 +94,17 @@ module Webspicy
 
         url = url + "?" + Rack::Utils.build_query(params) if body && !params.empty?
 
-        Webspicy.info("POST #{url} -- #{params.inspect} -- #{headers.inspect}")
-
-        if body
-          handler.post(url, body)
-        else
+        case body
+        when NilClass
+          Webspicy.info("POST #{url} -- #{params.inspect} -- #{headers.inspect}")
           handler.post(url, params.to_json, {"CONTENT_TYPE" => "application/json"})
+        when FileUpload
+          file = Rack::Test::UploadedFile.new(body.path, body.content_type)
+          Webspicy.info("POST #{url} -- #{params.inspect} -- #{body}")
+          handler.post(url, body.param_name.to_sym => file)
+        else
+          Webspicy.info("POST #{url} -- #{params.inspect} -- #{body.inspect[0..25]}")
+          handler.post(url, body)
         end
         @last_response = handler.last_response
 

data/lib/webspicy/file_upload.rb

@@ -0,0 +1,35 @@
+module Webspicy
+  class FileUpload
+
+    def initialize(raw)
+      @path = raw[:path]
+      @content_type = raw[:content_type]
+      @param_name = raw[:param_name] || "file"
+    end
+
+    attr_reader :path, :content_type, :param_name
+
+    def self.info(raw)
+      new(raw)
+    end
+
+    def locate(resource)
+      FileUpload.new({
+        path: resource.locate(path),
+        content_type: content_type
+      })
+    end
+
+    def to_info
+      { path: path.to_s,
+        content_type: content_type,
+        param_name: param_name }
+    end
+
+    def to_s
+      "FileUpload(#{to_info})"
+    end
+    alias :inspect :to_s
+
+  end # class FileUpload
+end # module Webspicy

data/lib/webspicy/formaldoc.fio

@@ -6,6 +6,13 @@ Schema =
       \( s | ::Webspicy.schema(s) )
       \( s | raise "Unsupported"  )
 
+FileUpload =
+    .Webspicy::FileUpload <info> {
+        path         :  String
+        content_type :  String
+        param_name   :? String
+    }
+
 Resource =
     .Webspicy::Resource <info> {
         name: String
@@ -31,9 +38,10 @@ TestCase =
     .Webspicy::Resource::Service::TestCase <info> {
         description      : String
         dress_params     :? Boolean
-        params           : Params
+        params           :? Params
         headers          :? .Hash
         body             :? String
+        file_upload      :? FileUpload
         seeds            :? String
         requester        :? String
         expected: {

data/lib/webspicy/resource.rb

@@ -1,8 +1,9 @@
 module Webspicy
   class Resource
 
-    def initialize(raw)
+    def initialize(raw, location = nil)
       @raw = raw
+      @location = location
       bind_services
     end
 
@@ -10,6 +11,16 @@ module Webspicy
       new(raw)
     end
 
+    def located_at!(location)
+      @location = Path(location)
+    end
+
+    def locate(relative_path)
+      file = @location.parent/relative_path
+      raise "File not found: #{file}" unless file.exists?
+      file
+    end
+
     def url
       @raw[:url]
     end

data/lib/webspicy/resource/service/test_case.rb

@@ -34,13 +34,21 @@ module Webspicy
         alias :dress_params? :dress_params
 
         def params
-          @raw[:params]
+          @raw[:params] || {}
         end
 
         def body
           @raw[:body]
         end
 
+        def file_upload
+          @raw[:file_upload]
+        end
+
+        def located_file_upload
+          file_upload ? file_upload.locate(resource) : nil
+        end
+
         def expected_content_type
           @raw[:expected].fetch(:content_type){ 'application/json' }
         end

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 9
-    TINY  = 1
+    MINOR = 10
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -146,13 +146,16 @@ files:
 - examples/restful/webspicy/todo/options.yml
 - examples/restful/webspicy/todo/patchTodo.yml
 - examples/restful/webspicy/todo/postCsv.yml
+- examples/restful/webspicy/todo/postFile.yml
 - examples/restful/webspicy/todo/postTodos.yml
+- examples/restful/webspicy/todo/todos.csv
 - lib/webspicy.rb
 - lib/webspicy/checker.rb
 - lib/webspicy/client.rb
 - lib/webspicy/client/http_client.rb
 - lib/webspicy/client/rack_test_client.rb
 - lib/webspicy/configuration.rb
+- lib/webspicy/file_upload.rb
 - lib/webspicy/formaldoc.fio
 - lib/webspicy/resource.rb
 - lib/webspicy/resource/service.rb