rest-core 2.0.4 → 2.1.0

data/lib/rest-core/util/payload.rb

@@ -0,0 +1,162 @@
+
+# stolen and modified from rest-client
+
+require 'rest-core/error'
+
+require 'mime/types'
+
+require 'stringio'
+require 'tempfile'
+
+module RestCore; end
+module RestCore::Payload
+  include RestCore
+  module_function
+
+  def generate payload
+    if payload.respond_to?(:read)
+      Streamed.new(payload)
+
+    elsif payload.kind_of?(String)
+      StreamedString.new(payload)
+
+    elsif payload.kind_of?(Hash)
+      if Middleware.contain_binary?(payload)
+        Multipart.new(payload)
+
+      else
+        UrlEncoded.new(payload)
+      end
+
+    else
+      raise Error.new("Payload should be either String, Hash, or" \
+                      " responding to `read', but: #{payload.inspect}")
+    end
+  end
+
+  class Streamed
+    def initialize payload
+      @io = payload
+    end
+
+    attr_reader  :io
+    alias_method :to_io, :io
+
+    def read bytes=nil
+      io.read(bytes)
+    end
+
+    def headers
+      {'Content-Length' => size.to_s}
+    end
+
+    def size
+      if io.respond_to?(:size)
+        io.size
+      elsif io.respond_to?(:stat)
+        io.stat.size
+      else
+        0
+      end
+    end
+
+    def close  ; io.close unless closed?; end
+    def closed?; io.closed?             ; end
+  end
+
+  class StreamedString < Streamed
+    def initialize payload
+      super(StringIO.new(payload))
+    end
+  end
+
+  class UrlEncoded < StreamedString
+    def initialize payload
+      super(RestCore::Middleware.percent_encode(payload))
+    end
+
+    def headers
+      super.merge('Content-Type' => 'application/x-www-form-urlencoded')
+    end
+  end
+
+  class Multipart < Streamed
+    EOL = "\r\n"
+
+    def initialize payload
+      super(Tempfile.new("rest-core.payload.#{boundary}"))
+
+      io.binmode
+
+      payload.each_with_index do |(k, v), i|
+        if v.kind_of?(Array)
+          v.each{ |vv| part(k, vv) }
+        else
+          part(k, v)
+        end
+      end
+      io.write("--#{boundary}--#{EOL}")
+      io.rewind
+    end
+
+    def part k, v
+      io.write("--#{boundary}#{EOL}Content-Disposition: form-data")
+      io.write("; name=\"#{k}\"") if k
+      if v.respond_to?(:read)
+        part_binary(k, v)
+      else
+        part_plantext(k, v)
+      end
+    end
+
+    def part_plantext k, v
+      io.write("#{EOL}#{EOL}#{v}#{EOL}")
+    end
+
+    def part_binary k, v
+      if v.respond_to?(:original_filename)                   # Rails
+        io.write("; filename=\"#{v.original_filename}\"#{EOL}")
+      elsif v.respond_to?(:path)                             # files
+        io.write("; filename=\"#{File.basename(v.path)}\"#{EOL}")
+      else                                                   # io
+        io.write("; filename=\"#{k}\"#{EOL}")
+      end
+
+      # supply your own content type for regular files, will you?
+      if v.respond_to?(:content_type)                        # Rails
+        io.write("Content-Type: #{v.content_type}#{EOL}#{EOL}")
+      elsif v.respond_to?(:path) && type = mime_type(v.path) # files
+        io.write("Content-Type: #{type}#{EOL}#{EOL}")
+      else
+        io.write(EOL)
+      end
+
+      while data = v.read(8192)
+        io.write(data)
+      end
+
+      io.write(EOL)
+
+    ensure
+      v.close if v.respond_to?(:close)
+    end
+
+    def mime_type path
+      mime = MIME::Types.type_for(path)
+      mime.first && mime.first.content_type
+    end
+
+    def boundary
+      @boundary ||= rand(1_000_000).to_s
+    end
+
+    def headers
+      super.merge('Content-Type' =>
+                    "multipart/form-data; boundary=#{boundary}")
+    end
+
+    def close
+      io.close! unless io.closed?
+    end
+  end
+end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '2.0.4'
+  VERSION = '2.1.0'
 end

data/rest-core.gemspec

@@ -2,14 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "2.0.4"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [
   "Cardinal Blue",
   "Lin Jen-Shin (godfat)"]
-  s.date = "2013-04-30"
-  s.description = "Modular Ruby clients interface for REST APIs\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed rest-core, which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-more]: https://github.com/cardinalblue/rest-more"
+  s.date = "2013-05-08"
+  s.description = "Modular Ruby clients interface for REST APIs.\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed rest-core, which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-more]: https://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [
   ".gitignore",
@@ -68,6 +68,7 @@ Gem::Specification.new do |s|
   "lib/rest-core/util/hmac.rb",
   "lib/rest-core/util/json.rb",
   "lib/rest-core/util/parse_query.rb",
+  "lib/rest-core/util/payload.rb",
   "lib/rest-core/version.rb",
   "lib/rest-core/wrapper.rb",
   "rest-core.gemspec",
@@ -78,8 +79,9 @@ Gem::Specification.new do |s|
   "test/test_cache.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_default_payload.rb",
   "test/test_default_query.rb",
-  "test/test_em_http_request.rb",
+  "test/test_em-http-request.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
   "test/test_error_handler.rb",
@@ -88,22 +90,26 @@ Gem::Specification.new do |s|
   "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
+  "test/test_rest-client.rb",
   "test/test_simple.rb",
   "test/test_timeout.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]
   s.homepage = "https://github.com/cardinalblue/rest-core"
+  s.licenses = ["Apache License 2.0"]
+  s.post_install_message = "# [rest-core] Incompatible changes for POST requests:\n\n* We no longer support Rails-like POST payload, like translating\n  `{:foo => [1, 2]}` to `'foo[]=1&foo[]=2'`. It would now be translated to\n  `'foo=1&foo=2'`. If you like `'foo[]'` as the key, simply pass it as\n  `{'foo[]' => [1, 2]}`.\n\n* This also applies to nested hashes like `{:foo => {:bar => 1}`. If you\n  want that behaviour, just pass `{'foo[bar]' => 1}` which would then be\n  translated to `'foo[bar]=1'`.\n"
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.0"
-  s.summary = "Modular Ruby clients interface for REST APIs"
+  s.rubygems_version = "2.0.3"
+  s.summary = "Modular Ruby clients interface for REST APIs."
   s.test_files = [
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
   "test/test_cache.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_default_payload.rb",
   "test/test_default_query.rb",
-  "test/test_em_http_request.rb",
+  "test/test_em-http-request.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
   "test/test_error_handler.rb",
@@ -112,6 +118,7 @@ Gem::Specification.new do |s|
   "test/test_json_response.rb",
   "test/test_oauth1_header.rb",
   "test/test_payload.rb",
+  "test/test_rest-client.rb",
   "test/test_simple.rb",
   "test/test_timeout.rb",
   "test/test_universal.rb",

data/task/gemgem.rb

@@ -14,6 +14,7 @@ module Gemgem
 
       s.description = description.join
       s.summary     = description.first
+      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
 
       s.rubygems_version = Gem::VERSION
       s.date             = Time.now.strftime('%Y-%m-%d')
@@ -33,8 +34,8 @@ module Gemgem
     @readme ||=
       if path
         ps = "##{File.read(path)}".
-             scan(/((#+)[^\n]+\n\n.+?(?=\n\n\2[^#\n]+\n))/m).map(&:first)
-        ps.inject({'HEADER' => ps.first}){ |r, s, i|
+             scan(/((#+)[^\n]+\n\n.+?(?=(\n\n\2[^#\n]+\n)|\Z))/m).map(&:first)
+        ps.inject('HEADER' => ps.first){ |r, s, i|
           r[s[/\w+/]] = s
           r
         }
@@ -44,7 +45,7 @@ module Gemgem
   end
 
   def description
-    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
+    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines
   end
 
   def changes
@@ -104,9 +105,9 @@ module Gemgem
   end
 
   def split_lines ruby
-    ruby.gsub(/(.+?)\[(.+?)\]/){ |s|
+    ruby.gsub(/(.+?)\s*=\s*\[(.+?)\]/){ |s|
       if $2.index(',')
-        "#{$1}[\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
+        "#{$1} = [\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
       else
         s
       end
@@ -179,7 +180,7 @@ namespace :gem do
 
 desc 'Install gem'
 task :install => [:build] do
-  sh("#{Gem.ruby} -S gem install pkg/#{Gemgem.gem_tag}")
+  sh("#{Gem.ruby} -S gem install pkg/#{Gemgem.gem_tag}.gem")
 end
 
 desc 'Build gem'

data/test/test_auth_basic.rb

@@ -6,6 +6,8 @@ describe RC::AuthBasic do
     @auth = RC::AuthBasic.new(RC::Dry.new, nil, nil)
   end
 
+  env = {RC::REQUEST_HEADERS => {}}
+
   should 'do nothing' do
     @auth.call({}){ |res| res.should.eq({}) }
   end
@@ -14,9 +16,9 @@ describe RC::AuthBasic do
     @auth.instance_eval{@username = 'Aladdin'}
     @auth.instance_eval{@password = 'open sesame'}
 
-    @auth.call({}){ |res|
-      res.should.eq({RC::REQUEST_HEADERS =>
-        {'Authorization' => 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='}})
+    @auth.call(env){ |res|
+      res.should.eq(RC::REQUEST_HEADERS =>
+        {'Authorization' => 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=='})
     }
 
     acc = {'Accept' => 'text/plain'}
@@ -30,11 +32,11 @@ describe RC::AuthBasic do
 
   should 'leave a log if username are not both provided' do
     @auth.instance_eval{@username = 'Aladdin'}
-    @auth.call({}){ |res| res[RC::LOG].size.should.eq 1 }
+    @auth.call(env){ |res| res[RC::LOG].size.should.eq 1 }
   end
 
   should 'leave a log if password are not both provided' do
     @auth.instance_eval{@password = 'open sesame'}
-    @auth.call({}){ |res| res[RC::LOG].size.should.eq 1 }
+    @auth.call(env){ |res| res[RC::LOG].size.should.eq 1 }
   end
 end

data/test/test_cache.rb

@@ -149,6 +149,12 @@ describe RC::Cache do
     }
   end
 
+  should 'not cache dry run' do
+    c = RC::Builder.client{use RC::Cache, {}, nil}.new
+    c.url('test')
+    c.cache.should.eq({})
+  end
+
   should 'update cache if there is cache option set to false' do
     url, body = "https://cache", 'ok'
     stub_request(:get, url).to_return(:body => body)

data/test/test_client_oauth1.rb

@@ -18,30 +18,30 @@ describe RC::ClientOauth1 do
     sig = Digest::MD5.hexdigest('e&a=b&c=d')
     data_sig = data.merge('sig' => sig)
     data_json = RC::Json.encode(data_sig)
-    @client = client.new(:data => data, :consumer_secret => 'e')
+    c = client.new(:data => data, :consumer_secret => 'e')
 
-    @client.send(:calculate_sig).should.eq sig
-    @client.data_json.should.eq data_json
+    c.send(:calculate_sig).should.eq sig
+    c.data_json.should.eq data_json
 
-    @client.data_json = data_json
-    @client.data.should.eq data_sig
+    c.data_json = data_json
+    c.data.should.eq data_sig
 
-    @client.data_json = RC::Json.encode(data_sig.merge('sig' => 'wrong'))
-    @client.data.should.eq({})
+    c.data_json = RC::Json.encode(data_sig.merge('sig' => 'wrong'))
+    c.data.should.eq({})
 
-    @client.data_json = data_json
-    @client.data.should.eq data_sig
+    c.data_json = data_json
+    c.data.should.eq data_sig
 
-    @client.data_json = 'bad json'
-    @client.data.should.eq({})
+    c.data_json = 'bad json'
+    c.data.should.eq({})
   end
 
   should 'have correct default data' do
-    @client = client.new
-    @client.data.should.eq({})
-    @client.data = nil
-    @client.data['a'] = 'b'
-    @client.data['a'].should.eq 'b'
+    c = client.new
+    c.data.should.eq({})
+    c.data = nil
+    c.data['a'] = 'b'
+    c.data['a'].should.eq 'b'
   end
 
   should 'authorize' do
@@ -51,12 +51,12 @@ describe RC::ClientOauth1 do
     stub_request(:post, 'http://nocalhost').
       to_return(:body => 'user_id=123&haha=point')
 
-    @client = client.new(:request_token_path => 'http://localhost',
-                         :authorize_path     => 'http://mocalhost',
-                         :access_token_path  => 'http://nocalhost')
+    c = client.new(:request_token_path => 'http://localhost',
+                   :authorize_path     => 'http://mocalhost',
+                   :access_token_path  => 'http://nocalhost')
 
-    @client.authorize_url!.should.eq 'http://mocalhost?oauth_token=abc'
-    @client.authorize!.should.eq('user_id' => '123', 'haha' => 'point',
-                                 'authorized' => 'true')
+    c.authorize_url!.should.eq 'http://mocalhost?oauth_token=abc'
+    c.authorize!.should.eq('user_id' => '123', 'haha' => 'point',
+                           'authorized' => 'true')
   end
 end

data/test/test_default_payload.rb

@@ -0,0 +1,38 @@
+
+require 'rest-core/test'
+
+describe RC::DefaultPayload do
+  app = RC::DefaultPayload.new(RC::Dry.new, {})
+  env = {RC::REQUEST_PAYLOAD => {}}
+
+  should 'do nothing' do
+    app.call(env){ |r| r[RC::REQUEST_PAYLOAD].should.eq({}) }
+  end
+
+  should 'merge payload' do
+    app.instance_eval{@payload = {'pay' => 'load'}}
+
+    app.call(env){ |r| r.should.eq({RC::REQUEST_PAYLOAD =>
+      {'pay' => 'load'}}) }
+
+    format = {'format' => 'json'}
+    env    = {RC::REQUEST_PAYLOAD => format}
+
+    app.call(env){ |r| r.should.eq({RC::REQUEST_PAYLOAD =>
+      {'pay' => 'load'}.merge(format)})}
+  end
+
+  should 'accept non-hash payload' do
+    u = RC::Universal.new(:log_method => false)
+    env = {RC::REQUEST_PAYLOAD => 'payload'}
+    u.request_full(env, u.dry)[RC::REQUEST_PAYLOAD].should.eq('payload')
+
+    u.payload = 'default'
+    u.request_full(env, u.dry)[RC::REQUEST_PAYLOAD].should.eq('payload')
+    u.request_full({} , u.dry)[RC::REQUEST_PAYLOAD].should.eq('default')
+
+    u = RC::Builder.client{use RC::DefaultPayload, 'maylord'}.new
+    u.request_full({} , u.dry)[RC::REQUEST_PAYLOAD].should.eq('maylord')
+    u.request_full(env, u.dry)[RC::REQUEST_PAYLOAD].should.eq('payload')
+  end
+end

data/test/test_default_query.rb

@@ -6,34 +6,36 @@ describe RC::DefaultQuery do
     @app = RC::DefaultQuery.new(RC::Dry.new, {})
   end
 
+  env = {RC::REQUEST_QUERY => {}}
+
   describe 'when given query' do
     should 'do nothing' do
-      @app.call({}){ |r| r[RC::REQUEST_QUERY].should.eq({}) }
+      @app.call(env){ |r| r[RC::REQUEST_QUERY].should.eq({}) }
     end
 
     should 'merge query' do
       @app.instance_eval{@query = {'q' => 'uery'}}
 
-      @app.call({}){ |r| r.should.eq({RC::REQUEST_QUERY => {'q' => 'uery'}}) }
+      @app.call(env){ |r| r.should.eq({RC::REQUEST_QUERY => {'q' => 'uery'}}) }
 
       format = {'format' => 'json'}
-      env    = {RC::REQUEST_QUERY => format}
+      e      = {RC::REQUEST_QUERY => format}
 
-      @app.call(env){ |r|
+      @app.call(e){ |r|
         r.should.eq({RC::REQUEST_QUERY => {'q' => 'uery'}.merge(format)}) }
     end
 
     should 'string_keys in query' do
-      env = {'query' => {:symbol => 'value'}}
-      @app.call(env){ |r|
-        r.should.eq({RC::REQUEST_QUERY => {'symbol' => 'value'}}.merge(env))
+      e = {'query' => {:symbol => 'value'}}
+      @app.call(env.merge(e)){ |r|
+        r.should.eq({RC::REQUEST_QUERY => {'symbol' => 'value'}}.merge(e))
       }
     end
   end
 
   describe 'when not given query' do
     should 'merge query with {}' do
-      @app.call({}){ |r| r.should.eq({RC::REQUEST_QUERY => {}}) }
+      @app.call(env){ |r| r.should.eq(RC::REQUEST_QUERY => {}) }
     end
   end
 end