rest-core 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aa111679bf7c7b75c113cea9c30e4c52c709ed0
-  data.tar.gz: fe0dda1aea907ef4141f7125a7dfb9a881d42441
+  metadata.gz: b544b95ad58c9315600c3951222e0aea815d0418
+  data.tar.gz: 35eece46344f61ed05425d7572195b61a0b4f2b5
 SHA512:
-  metadata.gz: 4e634ba680b5cca9604ea54a5182e0afe161bf44e80b1f7748d8ffc922429023fb99fd009aea9a3c4b001b5531e9de315947de3db6229020de30c2bc88b8d9c7
-  data.tar.gz: 1a110e340a1f5e64e5ede750e6bca7a9ef38fa2137d27c53e900be9026b0d8d8f61664e7fc7032954bcb975ea45a6eea221e74ea7e01c9a62b3ca89c19f0b225
+  metadata.gz: 9f093b4836251cec01ecb5b467d6d51eefeebc4dd62a35b1a08b6d9ffbe30ad579007cbda0fb821554562012385fa94955abe4cf99450b1aa79001e73560da7b
+  data.tar.gz: 1de6772803cf5d8771b2ad32cc0ea80daae686ae53ed46516e9aabf526174199fa7dec7540d3b858c1789d1dba16ec61bbe9c233d3651ac47bc89fa6ff71eec7

data/CHANGES.md

@@ -1,5 +1,21 @@
 # CHANGES
 
+## rest-core 3.3.1 -- 2014-10-08
+
+* `RC::Oauth1Header` would now properly encode queries in oauth_callback.
+  rest-more#6 khoa nguyen (@khoan)
+
+* Made all literal regular expression UTF-8 encoded, fixing encoding issue
+  on JRuby. #10 Joe Chen (@joe1chen)
+
+* Now `RC::DefaultSite` would use `URI.join` to prepend the default site,
+  therefore eliminating duplicated / or missing /. #11 Man Vuong (@kidlab)
+
+* Fixed deprecation warnings from `URI.escape`. Lin Jen-Shin (@godfat)
+
+* Now we properly wait for the callback to be called to consider the request
+  is done. Lin Jen-Shin (@godfat)
+
 ## rest-core 3.3.0 -- 2014-08-25
 
 ### Incompatible changes

data/README.md

@@ -14,7 +14,6 @@ talk is in Mandarin.
 * [github](https://github.com/godfat/rest-core)
 * [rubygems](https://rubygems.org/gems/rest-core)
 * [rdoc](http://rdoc.info/projects/godfat/rest-core)
-* [mailing list](http://groups.google.com/group/rest-core/topics)
 
 ## DESCRIPTION:
 
@@ -714,10 +713,12 @@ and complete.
 * Ethan Czahor (@ethanz5)
 * Florent Vaucelle (@florent)
 * Jaime Cham (@jcham)
+* Joe Chen (@joe1chen)
 * John Fan (@johnfan)
 * khoa nguyen (@khoan)
 * Lin Jen-Shin (@godfat)
 * lulalala (@lulalala)
+* Man Vuong (@kidlab)
 * Mariusz Pruszynski (@snicky)
 * Mr. Big Cat (@miaout17)
 * Nicolas Fouché (@nfo)

data/Rakefile

@@ -12,5 +12,5 @@ Gemgem.init(dir) do |s|
   s.version  = RestCore::VERSION
   s.homepage = 'https://github.com/godfat/rest-core'
   %w[httpclient mime-types].each{ |g| s.add_runtime_dependency(g) }
-  s.add_runtime_dependency('timers', '<4')
+  s.add_runtime_dependency('timers', '>=4.0.1')
 end

data/lib/rest-core.rb

@@ -90,7 +90,7 @@ module RestCore
         c = const.const_get(n)
       rescue LoadError, NameError => e
         warn "RestCore: WARN: #{e} for #{const}\n" \
-             "  from #{e.backtrace.grep(/top.+required/).first}"
+             "  from #{e.backtrace.grep(/top.+required/u).first}"
       end
       eagerload(c, loaded) if c.respond_to?(:constants) && !loaded[n]
     }

data/lib/rest-core/builder.rb

@@ -37,13 +37,8 @@ class RestCore::Builder
   end
 
   def members
-    middles.map{ |(middle, args, block)|
-      if middle.public_method_defined?(:wrapped)
-        # TODO: this is hacky... try to avoid calling new!
-        middle.members + middle.new(Dry.new, *args, &block).members
-      else
-        middle.members
-      end if middle.respond_to?(:members)
+    middles.map{ |(middle, _, _)|
+      middle.members if middle.respond_to?(:members)
     }.flatten.compact
   end
 

data/lib/rest-core/client.rb

@@ -25,9 +25,6 @@ module RestCore::Client
             self.class.default_#{name}      # old class default style
           elsif app.respond_to?(:#{name})
             app.#{name}({})                 # middleware instance value
-          elsif app.respond_to?(:wrapped)
-            default_#{name}(app.wrapped) || # wrapper value
-            default_#{name}(app.app)        # walk into it
           elsif app.respond_to?(:app)
             default_#{name}(app.app)        # walk into next app
           else
@@ -60,7 +57,7 @@ module RestCore::Client
   def inspect
     fields = if size > 0
                ' ' + attributes.map{ |k, v|
-                 "#{k}=#{v.inspect.sub(/(?<=.{12}).{4,}/, '...')}"
+                 "#{k}=#{v.inspect.sub(/(?<=.{12}).{4,}/u, '...')}"
                }.join(', ')
              else
                ''
@@ -249,14 +246,7 @@ module RestCore::Client
               end
 
     if app.respond_to?(:app) && app.app
-      wrapped = if app.respond_to?(:wrapped) && app.wrapped
-                  lighten_app(app.wrapped)
-                else
-                  nil
-                end
-      app.class.new(lighten_app(app.app), *members){
-        @wrapped = wrapped if wrapped
-      }
+      app.class.new(lighten_app(app.app), *members)
     else
       app.class.new(*members)
     end

data/lib/rest-core/event.rb

@@ -5,7 +5,7 @@ module RestCore
 
   class Event < EventStruct
     # self.class.name[/(?<=::)\w+$/] if RUBY_VERSION >= '1.9.2'
-    def name; self.class.name[/::(\w+)$/, 1]        ; end
+    def name; self.class.name[/::(\w+)$/u, 1]        ; end
     def to_s; "spent #{duration} #{name} #{message}"; end
   end
   class Event::MultiDone    < Event; end

data/lib/rest-core/middleware.rb

@@ -64,7 +64,7 @@ module RestCore::Middleware
     if (query = (env[REQUEST_QUERY] || {}).select{ |k, v| v }).empty?
       env[REQUEST_PATH].to_s
     else
-      q = if env[REQUEST_PATH] =~ /\?/ then '&' else '?' end
+      q = if env[REQUEST_PATH] =~ /\?/u then '&' else '?' end
       "#{env[REQUEST_PATH]}#{q}#{percent_encode(query)}"
     end
   end
@@ -81,9 +81,11 @@ module RestCore::Middleware
   end
   public :percent_encode
 
-  UNRESERVED = /[^a-zA-Z0-9\-\.\_\~]/
+  UNRESERVED = /[^a-zA-Z0-9\-\.\_\~]+/u
   def escape string
-    URI.escape(string, UNRESERVED)
+    string.gsub(UNRESERVED) do |s|
+      "%#{s.unpack('H2' * s.bytesize).join('%')}".upcase
+    end
   end
   public :escape
 

data/lib/rest-core/middleware/cache.rb

@@ -99,10 +99,10 @@ class RestCore::Cache
 
   def data_extract data, env, k
     _, status, headers, body =
-      data.match(/\A(\d+)\n((?:[^\n]+\n)*)\n\n(.*)\Z/m).to_a
+      data.match(/\A(\d+)\n((?:[^\n]+\n)*)\n\n(.*)\Z/um).to_a
 
     Promise.claim(env, k, body,status.to_i,
-      Hash[(headers||'').scan(/([^:]+): ([^\n]+)\n/)]).future_response
+      Hash[(headers||'').scan(/([^:]+): ([^\n]+)\n/u)]).future_response
   end
 
   def cache_for? env

data/lib/rest-core/middleware/default_site.rb

@@ -6,8 +6,10 @@ class RestCore::DefaultSite
   include RestCore::Middleware
 
   def call env, &k
-    path = if env[REQUEST_PATH].to_s.start_with?('http')
+    path = if env[REQUEST_PATH].to_s.include?('://')
              env[REQUEST_PATH]
+           elsif site(env).to_s.include?('://')
+             URI.join(site(env), env[REQUEST_PATH]).to_s
            else
              "#{site(env)}#{env[REQUEST_PATH]}"
            end

data/lib/rest-core/middleware/json_response.rb

@@ -30,7 +30,7 @@ class RestCore::JsonResponse
   def process response
     # StackExchange returns the problematic BOM! in UTF-8, so we need to
     # strip it or it would break JSON parsers (i.e. yajl-ruby and json)
-    body = response[RESPONSE_BODY].to_s.sub(/\A\xEF\xBB\xBF/, '')
+    body = response[RESPONSE_BODY].to_s.sub(/\A\xEF\xBB\xBF/u, '')
     response.merge(RESPONSE_BODY => Json.decode("[#{body}]").first)
     # [this].first is not needed for yajl-ruby
   rescue Json.const_get(:ParseError) => error

data/lib/rest-core/middleware/oauth1_header.rb

@@ -26,7 +26,7 @@ class RestCore::Oauth1Header
   end
 
   def oauth_header env
-    header = attach_signature(env,
+    oauth = attach_signature(env,
       'oauth_consumer_key'     => consumer_key(env),
       'oauth_signature_method' => 'HMAC-SHA1',
       'oauth_timestamp'        => Time.now.to_i.to_s,
@@ -34,14 +34,15 @@ class RestCore::Oauth1Header
       'oauth_version'          => '1.0',
       'oauth_callback'         => oauth_callback(env),
       'oauth_verifier'         => oauth_verifier(env),
-      'oauth_token'            => oauth_token(env))
+      'oauth_token'            => oauth_token(env)).
+      map{ |(k, v)| "#{k}=\"#{escape(v)}\"" }.join(', ')
 
-    "OAuth #{header.map{ |(k, v)| "#{k}=\"#{v}\"" }.join(', ')}"
+    "OAuth #{oauth}"
   end
 
   def attach_signature env, oauth_params
     params = reject_blank(oauth_params)
-    params.merge('oauth_signature' => escape(signature(env, params)))
+    params.merge('oauth_signature' => signature(env, params))
   end
 
   def signature env, params

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

@@ -9,7 +9,7 @@ module RestClient
     # Follow a redirection
     def follow_redirection request = nil, result = nil, & block
       url = headers[:location]
-      if url !~ /^http/
+      if url !~ /^http/u
         url = URI.parse(args[:url]).merge(url).to_s
       end
       args[:url] = url

data/lib/rest-core/promise.rb

@@ -26,8 +26,8 @@ class RestCore::Promise
     self.k         = [k]
     self.immediate = immediate
 
-    self.body, self.status, self.headers,
-      self.socket, self.response, self.error, = nil
+    self.body, self.status, self.headers, self.socket,
+      self.response, self.error, self.called = nil
 
     self.condv     = ConditionVariable.new
     self.mutex     = Mutex.new
@@ -70,7 +70,7 @@ class RestCore::Promise
   # called in client thread (client.wait)
   def wait
     # it might be awaken by some other futures!
-    mutex.synchronize{ condv.wait(mutex) until !!status } unless !!status
+    mutex.synchronize{ condv.wait(mutex) until done? } unless done?
   end
 
   # called in client thread (from the future (e.g. body))
@@ -107,9 +107,18 @@ class RestCore::Promise
     self
   end
 
+  # It's considered done only if the HTTP request is done, and we're not
+  # in asynchronous mode otherwise the callback should be called first.
+  # For synchronous mode, since we're waiting for the callback anyway,
+  # we don't really have to check if it's called.
+  def done?
+    !!status && !(immediate && !called)
+  end
+
   protected
   attr_accessor :env, :k, :immediate,
-                :response, :body, :status, :headers, :socket, :error,
+                :body, :status, :headers, :socket,
+                :response, :error, :called,
                 :condv, :mutex, :task
 
   private
@@ -127,13 +136,16 @@ class RestCore::Promise
 
   # called in client thread, when yield is called
   def callback
-    self.response ||= k.inject(
+    return response if called
+    self.response = k.inject(
       env.merge(RESPONSE_BODY    => body  ,
                 RESPONSE_STATUS  => status,
                 RESPONSE_HEADERS => headers,
                 RESPONSE_SOCKET  => socket,
                 FAIL             => ((env[FAIL]||[]) + [error]).compact,
                 LOG              =>   env[LOG] ||[])){ |r, i| i.call(r) }
+    self.called = true
+    response
   end
 
   # called in requesting thread, whenever the request is done

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

@@ -4,12 +4,12 @@ module RestCore::ParseLink
   module_function
   # http://tools.ietf.org/html/rfc5988
   parname = '"?([^"]+)"?'
-  LINKPARAM = /#{parname}=#{parname}/
+  LINKPARAM = /#{parname}=#{parname}/u
   def parse_link link
     link.split(',').inject({}) do |r, value|
       uri, *pairs = value.split(';')
       params = Hash[pairs.map{ |p| p.strip.match(LINKPARAM)[1..2] }]
-      r[params['rel']] = params.merge('uri' => uri[/<([^>]+)>/, 1])
+      r[params['rel']] = params.merge('uri' => uri[/<([^>]+)>/u, 1])
       r
     end
   end

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

@@ -12,7 +12,7 @@ module RestCore::ParseQuery
     def parse_query(qs, d = nil)
       params = {}
 
-      (qs || '').split(d ? /[#{d}] */n : /[&;] */n).each do |p|
+      (qs || '').split(d ? /[#{d}] */un : /[&;] */un).each do |p|
         k, v = p.split('=', 2).map { |x| URI.decode_www_form_component(x) }
         if cur = params[k]
           if cur.class == Array

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 end

data/rest-core.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rest-core 3.3.0 ruby lib
+# stub: rest-core 3.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "3.3.0"
+  s.version = "3.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-08-25"
+  s.date = "2014-10-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/godfat/rest-more"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -91,6 +91,7 @@ Gem::Specification.new do |s|
   "test/test_default_headers.rb",
   "test/test_default_payload.rb",
   "test/test_default_query.rb",
+  "test/test_default_site.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
   "test/test_error_handler.rb",
@@ -114,7 +115,7 @@ Gem::Specification.new do |s|
   "test/test_universal.rb"]
   s.homepage = "https://github.com/godfat/rest-core"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.4.1"
+  s.rubygems_version = "2.4.2"
   s.summary = "Modular Ruby clients interface for REST APIs."
   s.test_files = [
   "test/test_auth_basic.rb",
@@ -128,6 +129,7 @@ Gem::Specification.new do |s|
   "test/test_default_headers.rb",
   "test/test_default_payload.rb",
   "test/test_default_query.rb",
+  "test/test_default_site.rb",
   "test/test_error_detector.rb",
   "test/test_error_detector_http.rb",
   "test/test_error_handler.rb",
@@ -156,15 +158,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httpclient>, [">= 0"])
       s.add_runtime_dependency(%q<mime-types>, [">= 0"])
-      s.add_runtime_dependency(%q<timers>, ["< 4"])
+      s.add_runtime_dependency(%q<timers>, [">= 4.0.1"])
     else
       s.add_dependency(%q<httpclient>, [">= 0"])
       s.add_dependency(%q<mime-types>, [">= 0"])
-      s.add_dependency(%q<timers>, ["< 4"])
+      s.add_dependency(%q<timers>, [">= 4.0.1"])
     end
   else
     s.add_dependency(%q<httpclient>, [">= 0"])
     s.add_dependency(%q<mime-types>, [">= 0"])
-    s.add_dependency(%q<timers>, ["< 4"])
+    s.add_dependency(%q<timers>, [">= 4.0.1"])
   end
 end

data/test/test_cache.rb

@@ -130,7 +130,7 @@ describe RC::Cache do
 
   would 'preserve promise and preserve wrapped call' do
     c = json_client
-    stub_request(:get, 'http://me').to_return(:body => body = '{"a":"b"}')
+    stub_request(:get, 'http://me').to_return(:body => '{"a":"b"}')
     args = ['http://me', {}, {RC::RESPONSE_KEY => RC::PROMISE}]
     2.times do
       c.get(*args).then{ |r| r[RC::RESPONSE_BODY].should.eq 'a' => 'b' }.yield

data/test/test_client.rb

@@ -58,6 +58,26 @@ describe RC::Simple do
     i.should.eq t
   end
 
+  would 'wait for callback' do
+    rd, wr = IO.pipe
+    called = false
+    stub_request(:get, url).to_return(:body => 'nnf')
+    client = RC::Builder.client.new.get(url) do |nnf|
+      wr.puts
+      sleep 0.001 # make sure our callback is slow enough,
+                  # so that if `wait` is not waiting for the callback,
+                  # it would leave before the callback is completely done.
+                  # without sleeping, the callback is very likely to be
+                  # done first than `wait` anyway. raising the sleeping time
+                  # would make this test more reliable...
+      called = true
+      nil # test against returning nil, so that Promise#response is not set
+    end
+    rd.gets
+    client.wait
+    called.should.eq true
+  end
+
   would 'cleanup promises' do
     stub_request(:get, url)
     client = RC::Builder.client

data/test/test_default_site.rb

@@ -0,0 +1,24 @@
+
+require 'rest-core/test'
+
+describe RC::DefaultSite do
+  app = RC::DefaultSite.new(RC::Dry.new, 'http://example.com/')
+
+  would 'leave site along if it already has a protocol' do
+    app.call(RC::REQUEST_PATH => 'http://nnf.tw') do |res|
+      res[RC::REQUEST_PATH].should.eq 'http://nnf.tw'
+    end
+  end
+
+  would 'prepend the site if there is no protocol' do
+    app.call(RC::REQUEST_PATH => 'nnf.tw') do |res|
+      res[RC::REQUEST_PATH].should.eq 'http://example.com/nnf.tw'
+    end
+  end
+
+  would 'not prepend duplicated /' do
+    app.call(RC::REQUEST_PATH => '/nnf.tw') do |res|
+      res[RC::REQUEST_PATH].should.eq 'http://example.com/nnf.tw'
+    end
+  end
+end

data/test/test_oauth1_header.rb

@@ -24,9 +24,28 @@ describe RC::Oauth1Header do
     'GDdmIQH6jhtmLUypg82g',
     'MCD8BKwGdgPHvAuvgvz4EQpqDAtx89grbuNMRd7Eh98')
 
+  sig = '8wUi7m5HFQy76nowoCThusfgB+Q='
+
+  after do
+    Muack.verify
+  end
+
   would 'have correct signature' do
-    auth.signature(env, oauth_params).should.eq(
-      '8wUi7m5HFQy76nowoCThusfgB+Q=')
+    auth.signature(env, oauth_params).should.eq(sig)
+  end
+
+  would 'escape keys and values' do
+    mock(Time).now{
+      mock.to_i{
+        mock.to_s{
+          oauth_params['oauth_timestamp'] }.object }.object }
+    mock(auth).nonce{ oauth_params['oauth_nonce'] }
+
+    oauth = auth.oauth_header(env.merge(oauth_params))
+    oauth.should.
+      include?("oauth_callback=\"#{RC::Middleware.escape(callback)}\"")
+    oauth.should.
+      include?("oauth_signature=\"#{RC::Middleware.escape(sig)}\"")
   end
 
   describe 'base_string' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -42,16 +42,16 @@ dependencies:
   name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.0.1
 description: |-
   Modular Ruby clients interface for REST APIs.
 
@@ -148,6 +148,7 @@ files:
 - test/test_default_headers.rb
 - test/test_default_payload.rb
 - test/test_default_query.rb
+- test/test_default_site.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
 - test/test_error_handler.rb
@@ -189,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Modular Ruby clients interface for REST APIs.
@@ -205,6 +206,7 @@ test_files:
 - test/test_default_headers.rb
 - test/test_default_payload.rb
 - test/test_default_query.rb
+- test/test_default_site.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
 - test/test_error_handler.rb