rest-builder 0.9.0

data/test/test_payload.rb

@@ -0,0 +1,205 @@
+
+require 'rest-builder/test'
+
+describe RestBuilder::Payload do
+  describe 'A regular Payload' do
+    would 'use standard enctype as default content-type' do
+      RestBuilder::Payload::UrlEncoded.new({}).headers['Content-Type'].
+        should.eq 'application/x-www-form-urlencoded'
+    end
+
+    would 'form properly encoded params' do
+      RestBuilder::Payload::UrlEncoded.new(:foo => 'bar').read.
+        should.eq 'foo=bar'
+      RestBuilder::Payload::UrlEncoded.new(:foo => 'bar', :baz => 'qux').read.
+        should.eq 'baz=qux&foo=bar'
+    end
+
+    would 'escape parameters' do
+      RestBuilder::Payload::UrlEncoded.new('foo ' => 'bar').read.
+        should.eq 'foo%20=bar'
+    end
+
+    would 'properly handle arrays as repeated parameters' do
+      RestBuilder::Payload::UrlEncoded.new(:foo => ['bar']).read.
+        should.eq 'foo=bar'
+      RestBuilder::Payload::UrlEncoded.new(:foo => ['bar', 'baz']).read.
+        should.eq 'foo=bar&foo=baz'
+    end
+
+    would 'not close if stream already closed' do
+      p = RestBuilder::Payload::UrlEncoded.new('foo ' => 'bar')
+      p.close
+      2.times{ p.close.should.eq nil }
+    end
+  end
+
+  describe 'A multipart Payload' do
+    would 'use standard enctype as default content-type' do
+      p = RestBuilder::Payload::Multipart.new({})
+      stub(p).boundary{123}
+      p.headers['Content-Type'].should.eq 'multipart/form-data; boundary=123'
+    end
+
+    would 'not error on close if stream already closed' do
+      p = RestBuilder::Payload::Multipart.new(:file => File.open(__FILE__))
+      p.close
+      2.times{ p.close.should.eq nil }
+    end
+
+    would 'form properly separated multipart data' do
+      p = RestBuilder::Payload::Multipart.new(:bar => 'baz', :foo => 'bar')
+      p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; name="bar"\r
+\r
+baz\r
+--#{p.boundary}\r
+Content-Disposition: form-data; name="foo"\r
+\r
+bar\r
+--#{p.boundary}--\r
+      EOS
+    end
+
+    would 'form multiple files with the same name' do
+      with_img do |f, n|
+        with_img do |ff, nn|
+          p = RestBuilder::Payload::Multipart.new(:foo => [f, ff])
+          p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; name="foo"; filename="#{n}"\r
+Content-Type: image/jpeg\r
+\r
+#{'a'*10}\r
+--#{p.boundary}\r
+Content-Disposition: form-data; name="foo"; filename="#{nn}"\r
+Content-Type: image/jpeg\r
+\r
+#{'a'*10}\r
+--#{p.boundary}--\r
+          EOS
+        end
+      end
+    end
+
+    would 'not escape parameters names' do
+      p = RestBuilder::Payload::Multipart.new('bar ' => 'baz')
+      p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; name="bar "\r
+\r
+baz\r
+--#{p.boundary}--\r
+      EOS
+    end
+
+    would 'form properly separated multipart data' do
+      with_img do |f, n|
+        p = RestBuilder::Payload::Multipart.new(:foo => f)
+        p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; name="foo"; filename="#{n}"\r
+Content-Type: image/jpeg\r
+\r
+#{File.read(f.path)}\r
+--#{p.boundary}--\r
+        EOS
+      end
+    end
+
+    would "ignore the name attribute when it's not set" do
+      with_img do |f, n|
+        p = RestBuilder::Payload::Multipart.new(nil => f)
+        p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; filename="#{n}"\r
+Content-Type: image/jpeg\r
+\r
+#{File.read(f.path)}\r
+--#{p.boundary}--\r
+        EOS
+      end
+    end
+
+    would 'detect optional (original) content type and filename' do
+      File.open(__FILE__) do |f|
+        def f.content_type     ; 'image/jpeg'; end
+        def f.original_filename; 'foo.txt'   ; end
+        p = RestBuilder::Payload::Multipart.new(:foo => f)
+        p.read.should.eq <<-EOS
+--#{p.boundary}\r
+Content-Disposition: form-data; name="foo"; filename="foo.txt"\r
+Content-Type: image/jpeg\r
+\r
+#{File.read(f.path)}\r
+--#{p.boundary}--\r
+        EOS
+      end
+    end
+  end
+
+  describe 'streamed payloads' do
+    would 'properly determine the size of file payloads' do
+      File.open(__FILE__) do |f|
+        p = RestBuilder::Payload.generate(f)
+        p.size.should.eq f.stat.size
+      end
+    end
+
+    would 'properly determine the size of other kinds of payloads' do
+      s = StringIO.new('foo')
+      p = RestBuilder::Payload.generate(s)
+      p.size.should.eq 3
+
+      begin
+        f = Tempfile.new('rest-core')
+        f.write('foo bar')
+        f.rewind
+
+        p = RestBuilder::Payload.generate(f)
+        p.size.should.eq 7
+      ensure
+        f.close!
+      end
+    end
+  end
+
+  describe 'Payload generation' do
+    would 'recognize standard urlencoded params' do
+      RestBuilder::Payload.generate('foo' => 'bar').should.
+        kind_of?(RestBuilder::Payload::UrlEncoded)
+    end
+
+    would 'recognize multipart params' do
+      File.open(__FILE__) do |f|
+        RestBuilder::Payload.generate('foo' => f).should.
+          kind_of?(RestBuilder::Payload::Multipart)
+      end
+    end
+
+    would 'return data if none of the above' do
+      RestBuilder::Payload.generate('data').should.
+        kind_of?(RestBuilder::Payload::StreamedString)
+    end
+
+    would 'recognize nested multipart payloads in arrays' do
+      File.open(__FILE__) do |f|
+        RestBuilder::Payload.generate('foo' => [f]).should.
+          kind_of?(RestBuilder::Payload::Multipart)
+      end
+    end
+
+    would 'recognize file payloads that can be streamed' do
+      File.open(__FILE__) do |f|
+        RestBuilder::Payload.generate(f).
+          should.kind_of?(RestBuilder::Payload::Streamed)
+      end
+    end
+
+    would 'recognize other payloads that can be streamed' do
+      RestBuilder::Payload.generate(StringIO.new('foo')).should.
+        kind_of?(RestBuilder::Payload::Streamed)
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rest-builder
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Lin Jen-Shin (godfat)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: promise_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Modular Ruby clients interface for REST APIs.
+
+  Build your own API clients for less dependencies, less codes, less memory,
+  less conflicts, and run faster. Checkout [rest-core][] for pre-built
+  middleware and [rest-more][] for pre-built clients.
+
+  [rest-core]: https://github.com/godfat/rest-core
+  [rest-more]: https://github.com/godfat/rest-more
+email:
+- godfat (XD) godfat.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/rest-builder.rb
+- lib/rest-builder/builder.rb
+- lib/rest-builder/client.rb
+- lib/rest-builder/engine.rb
+- lib/rest-builder/engine/dry.rb
+- lib/rest-builder/engine/http-client.rb
+- lib/rest-builder/error.rb
+- lib/rest-builder/event_source.rb
+- lib/rest-builder/middleware.rb
+- lib/rest-builder/payload.rb
+- lib/rest-builder/promise.rb
+- lib/rest-builder/test.rb
+- lib/rest-builder/version.rb
+- rest-builder.gemspec
+- task/README.md
+- task/gemgem.rb
+- test/test_builder.rb
+- test/test_client.rb
+- test/test_event_source.rb
+- test/test_future.rb
+- test/test_httpclient.rb
+- test/test_payload.rb
+homepage: https://github.com/godfat/rest-builder
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Modular Ruby clients interface for REST APIs.
+test_files:
+- test/test_builder.rb
+- test/test_client.rb
+- test/test_event_source.rb
+- test/test_future.rb
+- test/test_httpclient.rb
+- test/test_payload.rb