rest-core 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b126115b38499438877d2c55fe68b14c3d9989bd
-  data.tar.gz: 6ba8f157a2025d94fe326767dc36823d11585854
+  metadata.gz: 5cc0c6118d2d5169988871b31d9b5544e2f28f60
+  data.tar.gz: c73e366ba7c4cdbdec4a5a76528ed5d8df21aed4
 SHA512:
-  metadata.gz: 14b1c0022f58a2af1a26bb0126159937b0540ee462bb6fe96db3fa777e0ba7cd14183e6ff8e051e45acc65c02708a69f51b31ad3371d0792e4124c2811029720
-  data.tar.gz: 4a3e037e2b30b77c57e7b030c05322389c1a585766ba414d137ce790c8c3e0b1c141c281a1dd664d07e47150a1f9f2a963059e42ffdad91d63549afd07ce095f
+  metadata.gz: c175b2f84c14257fe189ae82bee8f1d3a2bd205ac4da36ab8b0b596ccfdf47253d05b8cb4940c4ebe47e770385ed282b6dfadf53db04a1fba67adc4975ae177e
+  data.tar.gz: 53cd1bed753213a3a27637ceb85acf9577504aaa48cf0b760c48c20a6cd35c87f96f8b8c2dc438b568adc8404d1b4c19066dbb5efc6c40871d5ea91e78cd43e5

data/CHANGES.md

@@ -1,5 +1,18 @@
 # CHANGES
 
+## rest-core 2.1.1 -- 2013-05-21
+
+### Bugs fixes
+
+* Fixed em-http-request support.
+
+### Enhancement
+
+* [`Payload`] Now it is a class rather than a module.
+* [`Paylaod`] Introduced `Payload.generate_with_headers`.
+* [`Paylaod`] Give a `nil` if payload passing to `Payload.generate` should
+  not have any payload at all.
+
 ## rest-core 2.1.0 -- 2013-05-08
 
 ### Incompatible changes

data/Rakefile

@@ -24,7 +24,7 @@ task 'gem:spec' do
     s.email    = ['dev (XD) cardinalblue.com']
 
     s.post_install_message = <<-MARKDOWN
-# [rest-core] Incompatible changes for POST requests:
+# [rest-core] Since 2.1.0, Incompatible changes for POST requests:
 
 * We no longer support Rails-like POST payload, like translating
   `{:foo => [1, 2]}` to `'foo[]=1&foo[]=2'`. It would now be translated to

data/lib/rest-core/engine/em-http-request.rb

@@ -20,41 +20,37 @@ class RestCore::EmHttpRequest
               FUTURE           => future)
   end
 
-  def close client, tmpfile
-    (client.instance_variable_get(:@callbacks)||[]).clear
-    (client.instance_variable_get(:@errbacks )||[]).clear
-    client.close
-    if tmpfile.respond_to?(:close!)   # tempfile
-      tmpfile.close!
-    elsif tmpfile.respond_to?(:close) # regular IO
-      tmpfile.close
-    end
-  end
-
   def request future, env
-    payload = Payload.generate(env[REQUEST_PAYLOAD])
-    tmpfile = payload2file(payload)
-    args    = if tmpfile.respond_to?(:path)
-                {:file => tmpfile.path}
-              else
-                {:body => tmpfile}
-              end
-    client  = ::EventMachine::HttpRequest.new(request_uri(env)).send(
-                 env[REQUEST_METHOD], args.merge(
-                   :head => payload.headers.merge(env[REQUEST_HEADERS])))
+    payload, headers = Payload.generate_with_headers(env[REQUEST_PAYLOAD],
+                                                     env[REQUEST_HEADERS])
+    args = if payload.nil?
+             {}
+           else
+             tmpfile = payload2file(payload)
+             if tmpfile.respond_to?(:path)
+               {:file => tmpfile.path}
+             else
+               {:body => tmpfile}
+             end
+           end.merge(:head => headers)
+
+    client  = ::EventMachine::HttpRequest.new(request_uri(env)).
+                send(env[REQUEST_METHOD], args)
 
     client.callback{
-      close(client, tmpfile)
+      close_tmpfile(tmpfile)
       future.on_load(client.response,
                      client.response_header.status,
                      client.response_header)}
 
     client.errback{
-      close(client, tmpfile)
+      close_client(client)
+      close_tmpfile(tmpfile)
       future.on_error(client.error)}
 
     env[TIMER].on_timeout{
-      close(client, tmpfile)
+      close_client(client)
+      close_tmpfile(tmpfile)
       future.on_error(env[TIMER].error)
     } if env[TIMER]
   end
@@ -77,4 +73,18 @@ class RestCore::EmHttpRequest
     IO.copy_stream(io, tempfile)
     tempfile
   end
+
+  def close_client client
+    (client.instance_variable_get(:@callbacks)||[]).clear
+    (client.instance_variable_get(:@errbacks )||[]).clear
+    client.close
+  end
+
+  def close_tmpfile tmpfile
+    if tmpfile.respond_to?(:close!)   # tempfile
+      tmpfile.close!
+    elsif tmpfile.respond_to?(:close) # regular IO
+      tmpfile.close
+    end
+  end
 end

data/lib/rest-core/engine/rest-client.rb

@@ -10,29 +10,8 @@ class RestCore::RestClient
   def call env, &k
     future  = Future::FutureThread.new(env, k, env[ASYNC])
 
-    t = future.wrap{ # we can implement thread pool in the future
-      begin
-        payload = Payload.generate(env[REQUEST_PAYLOAD])
-        headers = env[REQUEST_HEADERS].merge(payload.headers)
-        res = ::RestClient::Request.execute(:method  => env[REQUEST_METHOD],
-                                            :url     => request_uri(env)   ,
-                                            :payload => payload            ,
-                                            :headers => headers            ,
-                                            :max_redirects => 0)
-        future.on_load(res.body, res.code, normalize_headers(res.raw_headers))
-
-      rescue ::RestClient::Exception => e
-        if res = e.response
-          # we don't want to raise an exception for 404 requests
-          future.on_load(res.body, res.code,
-            normalize_headers(res.raw_headers))
-        else
-          future.on_error(e)
-        end
-      rescue Exception => e
-        future.on_error(e)
-      end
-    }
+    # we can implement thread pool in the future
+    t = future.wrap{ request(future, env) }
 
     env[TIMER].on_timeout{
       t.kill
@@ -45,6 +24,27 @@ class RestCore::RestClient
               FUTURE           => future)
   end
 
+  def request future, env
+    payload, headers = Payload.generate_with_headers(env[REQUEST_PAYLOAD],
+                                                     env[REQUEST_HEADERS])
+    res = ::RestClient::Request.execute(:method   => env[REQUEST_METHOD],
+                                        :url      => request_uri(env)   ,
+                                        :payload  => payload            ,
+                                        :headers  => headers            ,
+                                        :max_redirects => 0)
+    future.on_load(res.body, res.code, normalize_headers(res.raw_headers))
+
+  rescue ::RestClient::Exception => e
+    if res = e.response
+      # we don't want to raise an exception for 404 requests
+      future.on_load(res.body, res.code, normalize_headers(res.raw_headers))
+    else
+      future.on_error(e)
+    end
+  rescue Exception => e
+    future.on_error(e)
+  end
+
   def normalize_headers raw_headers
     raw_headers.inject({}){ |r, (k, v)|
       r[k.to_s.upcase.tr('-', '_')] = if v.kind_of?(Array) && v.size == 1

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

@@ -9,11 +9,19 @@ require 'stringio'
 require 'tempfile'
 
 module RestCore; end
-module RestCore::Payload
+class RestCore::Payload
   include RestCore
-  module_function
 
-  def generate payload
+  def self.generate_with_headers payload, headers
+    h = if p = generate(payload)
+          p.headers.merge(headers)
+        else
+          headers
+        end
+    [p, h]
+  end
+
+  def self.generate payload
     if payload.respond_to?(:read)
       Streamed.new(payload)
 
@@ -21,7 +29,10 @@ module RestCore::Payload
       StreamedString.new(payload)
 
     elsif payload.kind_of?(Hash)
-      if Middleware.contain_binary?(payload)
+      if payload.empty?
+        nil
+
+      elsif Middleware.contain_binary?(payload)
         Multipart.new(payload)
 
       else
@@ -34,34 +45,30 @@ module RestCore::Payload
     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)
+  # Payload API
+  attr_reader  :io
+  alias_method :to_io, :io
+
+  def initialize payload; @io = payload          ; end
+  def read     bytes=nil; io.read(bytes)         ; end
+  def close             ; io.close unless closed?; end
+  def closed?           ; io.closed?             ; end
+  def headers           ; {}                     ; end
+
+  def size
+    if io.respond_to?(:size)
+      io.size
+    elsif io.respond_to?(:stat)
+      io.stat.size
+    else
+      0
     end
+  end
 
+  class Streamed < Payload
     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

data/lib/rest-core/version.rb

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

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "2.1.0"
+  s.version = "2.1.1"
 
   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-05-08"
+  s.date = "2013-05-21"
   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 = [
@@ -97,7 +97,7 @@ Gem::Specification.new do |s|
   "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.post_install_message = "# [rest-core] Since 2.1.0, 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.3"
   s.summary = "Modular Ruby clients interface for REST APIs."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Cardinal Blue
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -130,7 +130,7 @@ licenses:
 - Apache License 2.0
 metadata: {}
 post_install_message: |
-  # [rest-core] Incompatible changes for POST requests:
+  # [rest-core] Since 2.1.0, Incompatible changes for POST requests:
 
   * We no longer support Rails-like POST payload, like translating
     `{:foo => [1, 2]}` to `'foo[]=1&foo[]=2'`. It would now be translated to