rest-core 2.1.2 → 3.0.0

data/test/test_client.rb

@@ -4,23 +4,27 @@ require 'rest-core/test'
 describe RC::Simple do
   after do
     WebMock.reset!
-    RR.verify
+    Muack.verify
   end
 
   should 'do simple request' do
+    c = RC::Simple.new
     url = 'http://localhost/'
-    [:get, :post, :delete, :put, :patch, :options].each do |method|
+    [:get, :post, :delete, :put, :patch].each do |method|
       stub_request(method, url).to_return(:body => '[]')
-      RC::Simple.new.send(method, url).should.eq '[]'
+      c.send(method, url).should.eq '[]'
     end
 
-    stub_request(:head, url).to_return(:headers => {'A' => 'B'})
-    RC::Simple.new.head(url).should.eq({'A' => 'B'})
+    stub_request(:head   , url).to_return(:headers => {'A' => 'B'})
+    c.   head(url).should.eq('A' => 'B')
+
+    stub_request(:options, url).to_return(:headers => {'A' => 'B'})
+    c.options(url).should.eq('A' => 'B')
   end
 
   should 'call the callback' do
     url = 'http://localhost/'
-    [:get, :post, :delete, :put, :patch, :options].each do |method|
+    [:get, :post, :delete, :put, :patch].each do |method|
       stub_request(method, url).to_return(:body => '123')
       (client = RC::Simple.new).send(method, url){ |res|
         res.should.eq '123' }.should.eq client
@@ -32,6 +36,12 @@ describe RC::Simple do
       res.should.eq({'A' => 'B'})
     }.should.eq client
     client.wait
+
+    stub_request(:options, url).to_return(:headers => {'A' => 'B'})
+    (client = RC::Simple.new).options(url){ |res|
+      res.should.eq('A' => 'B')
+    }.should.eq client
+    client.wait
   end
 
   should 'have correct to_i' do

data/test/test_client_oauth1.rb

@@ -4,7 +4,7 @@ require 'rest-core/test'
 describe RC::ClientOauth1 do
   after do
     WebMock.reset!
-    RR.verify
+    Muack.verify
   end
 
   client = RC::Builder.client do

data/test/test_event_source.rb

@@ -0,0 +1,77 @@
+
+require 'socket'
+require 'rest-core/test'
+
+describe RC::EventSource do
+  client = RC::Builder.client.new
+  server = lambda do |close=true|
+    serv = TCPServer.new(0)
+    port = serv.addr[1]
+    path = "http://localhost:#{port}/"
+    payload = <<-SSE
+event: put
+data: {}
+
+event: keep-alive
+data: null
+SSE
+    m = [{'event' => 'put'       , 'data' => '{}'},
+         {'event' => 'keep-alive', 'data' => 'null'}]
+
+    t = Thread.new do
+      sock = serv.accept
+      sock.readline("\r\n\r\n")
+      sock.puts("HTTP/1.1 200 OK\r")
+      sock.puts("Content-Type: text/event-stream\r")
+      sock.puts
+      sock.puts(payload)
+      sock.close if close
+    end
+
+    [client.event_source(path, :a => 'b'), m, t]
+  end
+
+  should 'work regularly' do
+    es, m, t = server.call
+    flag = 0
+
+    es.onopen do |sock|
+      sock.should.kind_of IO
+      flag.should.eq 0
+      flag += 1
+    end
+
+    es.onmessage do |event, sock|
+      event.should.eq(m.shift)
+      sock.should.kind_of IO
+      sock.should.not.closed?
+      flag += 1
+    end
+
+    es.onerror do |error, sock|
+      error.should.kind_of EOFError
+      m.should.eq []
+      sock.should.closed?
+      flag.should.eq 3
+      flag += 1
+    end
+
+    es.start
+    es.wait
+    flag.should.eq 4
+    t.join
+  end
+
+  should 'close' do
+    es, _, t = server.call(false)
+    flag = 0
+    es.onmessage do
+      es.close
+      flag += 1
+    end
+    es.start
+    es.wait
+    flag.should.eq 1
+    t.join
+  end
+end

data/test/test_follow_redirect.rb

@@ -12,7 +12,7 @@ describe RC::FollowRedirect do
   app = RC::FollowRedirect.new(dry, 1)
 
   after do
-    RR.verify
+    Muack.verify
   end
 
   [301, 302, 303, 307].each do |status|

data/test/test_future.rb

@@ -0,0 +1,16 @@
+
+require 'stringio'
+require 'rest-core/test'
+
+describe RC::Promise::Future do
+  should 'fulfill the future' do
+    promise = RC::Promise.new(RC::FAIL => [])
+    promise.fulfill('body', 200, {'A' => 'B'}, StringIO.new)
+
+    promise.future_body    .should.eq 'body'
+    promise.future_status  .should.eq 200
+    promise.future_headers .should.eq('A' => 'B')
+    promise.future_socket  .should.kind_of(StringIO)
+    promise.future_failures.should.eq []
+  end
+end

data/test/test_oauth2_header.rb

@@ -0,0 +1,28 @@
+
+require 'rest-core/test'
+
+describe RC::Oauth2Header do
+  env  = {RC::REQUEST_HEADERS => {}}
+  auth = RC::Oauth2Header.new(RC::Dry.new)
+
+  should 'do nothing if no access token' do
+    auth.call(env){ |res| res.should.eq(env) }
+  end
+
+  should 'Bearer token' do
+    auth.call(env.merge('access_token_type' => 'Bearer',
+                        'access_token'      => 'token')){ |res|
+      res[RC::REQUEST_HEADERS].should.eq 'Authorization' => 'Bearer token'
+    }
+  end
+
+  should 'MAC token' do # http://tools.ietf.org/html/rfc6749#section-7.1
+    auth.call(env.merge('access_token_type' => 'MAC',
+                        'access_token'      =>
+                          {'id'  => 'h480djs93hd8',
+                           'mac' => 'kDZvddkndxv='})){ |res|
+      res[RC::REQUEST_HEADERS].should.eq \
+        'Authorization' => 'MAC id="h480djs93hd8", mac="kDZvddkndxv="'
+    }
+  end
+end

data/test/test_promise.rb

@@ -0,0 +1,89 @@
+
+require 'rest-core/test'
+
+describe RC::Promise do
+  def new_promise
+    RC::Promise.new(RC::CLIENT => @client.new)
+  end
+
+  before do
+    @client  = RC::Builder.client
+    @promise = new_promise
+  end
+
+  after do
+    @client.thread_pool.shutdown
+    Muack.verify
+  end
+
+  should 'work, reject, yield' do
+    @client.pool_size = 1
+    flag = 0
+    @promise.defer do
+      flag.should.eq 0
+      flag += 1
+      @promise.reject(nil)
+    end
+    @promise.yield
+    flag.should.eq 1
+    @promise.send(:error).should.kind_of RC::Error
+  end
+
+  should 'work, fulfill, yield' do
+    @client.pool_size = 2
+    flag = 0
+    @promise.defer do
+      flag.should.eq 0
+      flag += 1
+      @promise.fulfill('body', 1, {'K' => 'V'})
+    end
+    @promise.yield
+    flag.should.eq 1
+    @promise.send(:body)   .should.eq 'body'
+    @promise.send(:status) .should.eq 1
+    @promise.send(:headers).should.eq('K' => 'V')
+  end
+
+  should 'call inline if pool_size < 0' do
+    @client.pool_size = -1
+    current_thread = Thread.current
+    @promise.defer do
+      Thread.current.should.eq current_thread
+    end
+  end
+
+  should 'call in a new thread if pool_size == 0' do
+    @client.pool_size = 0
+    thread = nil
+    mock(Thread).new.with_any_args.peek_return do |t|
+      thread = t
+    end
+    @promise.defer do
+      Thread.current.should.eq thread
+      @promise.reject(nil)
+    end
+    @promise.yield
+  end
+
+  should 'call in thread pool if pool_size > 0' do
+    @client.pool_size = 1
+    flag = 0
+    rd, wr = IO.pipe
+    @promise.defer do
+      rd.gets
+      flag.should.eq 0
+      flag += 1
+      @promise.reject(nil)
+    end
+    p1 = new_promise
+    p1.defer do # block until promise #0 is done because pool_size == 1
+      flag.should.eq 1
+      flag += 1
+      p1.reject(nil)
+    end
+    wr.puts  # start promise #0
+    @promise.yield
+    p1.yield # block until promise #1 is done
+    flag.should.eq 2
+  end
+end

data/test/test_rest-client.rb

@@ -36,5 +36,26 @@ describe RC::RestClient do
       wr.close
       post[rd, 'socket']
     end
+
+    should 'not kill the thread if error was coming from the task' do
+      mock(RestClient::Request).execute{ raise 'boom' }.with_any_args
+      c.request({}, RC::FAIL).first.message.should.eq 'boom'
+      Muack.verify
+    end
+
+    should 'cancel the task if timing out' do
+      timer = Object.new.instance_eval do
+        def on_timeout; yield ; end
+        def error     ; 'boom'; end
+        def cancel    ;       ; end
+        self
+      end
+      stub(c.class).pool_size{ 1 }
+      stub(c.class.thread_pool).queue{ [] } # don't queue the task
+      mock(RC::ThreadPool::Task).new.with_any_args.
+        peek_return{ |t| mock(t).cancel; t } # the task should be cancelled
+      c.request({RC::TIMER => timer}, RC::FAIL).first.message.should.eq 'boom'
+      Muack.verify
+    end
   end
 end

data/test/test_thread_pool.rb

@@ -0,0 +1,10 @@
+
+require 'rest-core/test'
+
+describe RC::ThreadPool do
+  should 'have the same pool for the same client' do
+    client = RC::Builder.client
+    pool   = RC::ThreadPool[client]
+    RC::ThreadPool[client].object_id.should.eq pool.object_id
+  end
+end

data/test/test_timeout.rb

@@ -2,23 +2,28 @@
 require 'rest-core/test'
 
 describe RC::Timeout do
-  before do
-    @app = RC::Timeout.new(RC::Dry.new, 0)
-  end
+  app = RC::Timeout.new(RC::Dry.new, 0)
 
   after do
     WebMock.reset!
-    RR.verify
+    Muack.verify
   end
 
   should 'bypass timeout if timeout is 0' do
-    mock(@app).monitor.times(0)
-    @app.call({}){ |e| e.should.eq({}) }
+    mock(app).monitor.times(0)
+    app.call({}){ |e| e.should.eq({}) }
   end
 
   should 'run the monitor to setup timeout' do
     env = {'timeout' => 2}
-    mock.proxy(@app).monitor(env).times(1)
-    @app.call(env){|e| e[RC::TIMER].should.kind_of?(RC::Timeout::TimerThread)}
+    mock(app).monitor(env)
+    app.call(env){|e| e[RC::TIMER].should.kind_of?(RC::Timer)}
+  end
+
+  should "not raise timeout error if there's already an error" do
+    env = {'timeout' => 0.01}
+    mock(app.app).call(hash_including(env)){ raise "error" }
+    lambda{ app.call(env){} }.should    .raise(RuntimeError)
+    lambda{ sleep 0.01      }.should.not.raise(Timeout::Error)
   end
 end

metadata

@@ -1,28 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
-- Cardinal Blue
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: timers
+  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: |-
@@ -35,16 +62,16 @@ description: |-
   common APIs such as Facebook, Github, and Twitter, you can simply use the
   dedicated clients provided by [rest-more][].
 
-  [rest-more]: https://github.com/cardinalblue/rest-more
+  [rest-more]: https://github.com/godfat/rest-more
 email:
-- dev (XD) cardinalblue.com
+- godfat (XD) godfat.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .gitmodules
-- .travis.yml
+- ".gitignore"
+- ".gitmodules"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -52,7 +79,6 @@ files:
 - README.md
 - Rakefile
 - TODO.md
-- example/multi.rb
 - example/simple.rb
 - example/use-cases.rb
 - lib/rest-core.rb
@@ -61,15 +87,14 @@ files:
 - lib/rest-core/client/simple.rb
 - lib/rest-core/client/universal.rb
 - lib/rest-core/client_oauth1.rb
-- lib/rest-core/engine/auto.rb
+- lib/rest-core/engine.rb
 - lib/rest-core/engine/dry.rb
-- lib/rest-core/engine/em-http-request.rb
-- lib/rest-core/engine/future/future.rb
-- lib/rest-core/engine/future/future_fiber.rb
-- lib/rest-core/engine/future/future_thread.rb
+- lib/rest-core/engine/http-client.rb
+- lib/rest-core/engine/net-http-persistent.rb
 - lib/rest-core/engine/rest-client.rb
 - lib/rest-core/error.rb
 - lib/rest-core/event.rb
+- lib/rest-core/event_source.rb
 - lib/rest-core/middleware.rb
 - lib/rest-core/middleware/auth_basic.rb
 - lib/rest-core/middleware/bypass.rb
@@ -90,11 +115,12 @@ files:
 - lib/rest-core/middleware/oauth2_header.rb
 - lib/rest-core/middleware/oauth2_query.rb
 - lib/rest-core/middleware/timeout.rb
-- lib/rest-core/middleware/timeout/timer_em.rb
-- lib/rest-core/middleware/timeout/timer_thread.rb
 - lib/rest-core/patch/multi_json.rb
 - lib/rest-core/patch/rest-client.rb
+- lib/rest-core/promise.rb
 - lib/rest-core/test.rb
+- lib/rest-core/thread_pool.rb
+- lib/rest-core/timer.rb
 - lib/rest-core/util/hmac.rb
 - lib/rest-core/util/json.rb
 - lib/rest-core/util/parse_query.rb
@@ -102,7 +128,7 @@ files:
 - lib/rest-core/version.rb
 - lib/rest-core/wrapper.rb
 - rest-core.gemspec
-- task/.gitignore
+- task/README.md
 - task/gemgem.rb
 - test/test_auth_basic.rb
 - test/test_builder.rb
@@ -111,51 +137,45 @@ files:
 - test/test_client_oauth1.rb
 - test/test_default_payload.rb
 - test/test_default_query.rb
-- test/test_em-http-request.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
 - test/test_error_handler.rb
+- test/test_event_source.rb
 - test/test_follow_redirect.rb
+- test/test_future.rb
 - test/test_json_request.rb
 - test/test_json_response.rb
 - test/test_oauth1_header.rb
+- test/test_oauth2_header.rb
 - test/test_payload.rb
+- test/test_promise.rb
 - test/test_rest-client.rb
 - test/test_simple.rb
+- test/test_thread_pool.rb
 - test/test_timeout.rb
 - test/test_universal.rb
 - test/test_wrapper.rb
-homepage: https://github.com/cardinalblue/rest-core
+homepage: https://github.com/godfat/rest-core
 licenses:
 - Apache License 2.0
 metadata: {}
-post_install_message: |
-  # [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
-    `'foo=1&foo=2'`. If you like `'foo[]'` as the key, simply pass it as
-    `{'foo[]' => [1, 2]}`.
-
-  * This also applies to nested hashes like `{:foo => {:bar => 1}`. If you
-    want that behaviour, just pass `{'foo[bar]' => 1}` which would then be
-    translated to `'foo[bar]=1'`.
+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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Modular Ruby clients interface for REST APIs.
@@ -167,17 +187,21 @@ test_files:
 - test/test_client_oauth1.rb
 - test/test_default_payload.rb
 - test/test_default_query.rb
-- test/test_em-http-request.rb
 - test/test_error_detector.rb
 - test/test_error_detector_http.rb
 - test/test_error_handler.rb
+- test/test_event_source.rb
 - test/test_follow_redirect.rb
+- test/test_future.rb
 - test/test_json_request.rb
 - test/test_json_response.rb
 - test/test_oauth1_header.rb
+- test/test_oauth2_header.rb
 - test/test_payload.rb
+- test/test_promise.rb
 - test/test_rest-client.rb
 - test/test_simple.rb
+- test/test_thread_pool.rb
 - test/test_timeout.rb
 - test/test_universal.rb
 - test/test_wrapper.rb