restify 0.3.2.1.b74 → 0.4.0.b1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzIwYWY3ZGYxMGQ0OGNkMGQ0ODNkYzY2NzRhMjdiZTMyMDhmN2Y1Yg==
-  data.tar.gz: !binary |-
-    YjU2NmZiYWM3MWFkY2RhY2YzMDhlYjFiZDQ2OTBkYzhmYmZjNGMzOQ==
+SHA1:
+  metadata.gz: eaa7426d42906e309c899eb7b59b1d3f4b98284a
+  data.tar.gz: 494b9841c5a3424157c7d75771cd6fa177277e25
 SHA512:
-  metadata.gz: !binary |-
-    NTVmNDdiNWUyNmI4ZmUzMTMwNzU4MDQ2YzZkNDVlZmUwNWRiYWIxZDhhNzBm
-    ZjlhODIzN2ZhOGYyNWNiNWJlMmNlYWY2MjAxYzFiOTE4NDY0NjYzZjMyOTVl
-    NjY0OGM5Y2ZhYTAyYWYyNGM0YTc3NDI5ZjQzYWExMDMyZmY2NDE=
-  data.tar.gz: !binary |-
-    ZjZiOWQ3M2JmZTU3ZWFhOTU1NDdjYmJkNWNhNWNmOWE4YjFiZTNiZWJkZTEw
-    Mjk1YTc3MzY4NzFiMTBmMTEzMThhOTQ4YWZmMGM1ODQ3Yzg2MjNhNWE5NjYz
-    MDA4NWQxMjEzOWFmYmRkNDVhMzk4MDM2OGY3Yjk0MzMzZjJiODc=
+  metadata.gz: 627086929d8b537b952e4f498c98e62c1609f635e7b7049b70ba0d4a0a9f05da6dacf699c4e290a527688fb12fd79128cac084abf77fd4a3aba2274d904923e7
+  data.tar.gz: 36f9848d1585898e5a6ab343c053fb62958c6b701d4ac3e5e43de9be6d097bd6cf32b7e2c1d801495ab2df7eea0a2b01a3f85f7960f2a59187d9220d8d940497

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## master
+
+* Drop obligation in favor of simple Concurrent::IVar based promise class.
+  Notable changes:
+    - Returned object us of type `Restify::Promise` now.
+    - `value` will not raise exception but return `nil` in case of failure. Use `value!` for old behavior.

data/README.md

@@ -8,16 +8,14 @@ Restify can be used to consume hypermedia REST APIs (like GitHubs), to build a s
 
 Restify is build upon the following libraries:
 
-* [obligation](https://github.com/jgraichen/obligation)
 * [addressable](https://github.com/sporkmonger/addressable)
+* [typhoeus](https://github.com/typhoeus/typhoeus)
 
-It provides HTTP adapters to use with:
+It has optional HTTP adapters using:
 
 * [em-http-request](https://github.com/igrigorik/em-http-request)
-* [celluloid-io](https://github.com/celluloid/celluloid-io) / [http](https://github.com/httprb/http) (experimental)
-* [typhoeus](https://github.com/typhoeus/typhoeus) (not widely tested)
 
-They are mostly run in a background thread and may not survive mid-application forks.
+The HTTP adapters are mostly run in a background thread and may not survive mid-application forks.
 
 Included processors can handle:
 
@@ -44,21 +42,55 @@ Add it to your Gemfile or install it manually: `$ gem install restify`
 
 ## Usage
 
-Create new Restify object (actually returns '/' resource):
+Create new Restify object. It essentially means to request some start-resource usually the "root" resource:
 
 ```ruby
-client = Restify.new('http://api.github.com').value
+client = Restify.new('https://api.github.com').get.value
+# => {"current_user_url"=>"https://api.github.com/user",
+#     "current_user_authorizations_html_url"=>"https://github.com/settings/connections/applications{/client_id}",
+# ...
+#     "repository_url"=>"https://api.github.com/repos/{owner}/{repo}",
+# ...
 ```
 
-The `value` call resolves the returned `Obligation` (like a Future object) by blocking the thread until the resource is there.
+We are essentially requesting `'http://api.github.com'` via HTTP `get`. `get` is returning an `Promise`, similar to Java's `Future`. The `value` call resolves the returned `Promise` by blocking the thread until the resource is actually there. `value!` will additionally raise errors instead of returning `nil`. You can chain handlers using the `then` method. This allows you to be build a dependency chain that will be executed when the last promise is needed.
 
-Get a relation described by the root resource. Restify supports Link headers as well as JSON encoded relations (`*_url` fields).
+As we can see GitHub returns us a field `repository_url` with a URI template. Restify automatically scans for `*_url` fields in the JSON response and exposes these as relations. It additionally scans the HTTP Header field `Link` for relations like pagination.
+
+We can now use the relations to navigate from resource to resource like a browser from one web page to another page.
 
 ```ruby
 repositories = client.rel(:repository)
+# => #<Restify::Relation:0x00000005548968 @context=#<Restify::Context:0x007f6024066ae0 @uri=#<Addressable::URI:0x29d8684 URI:https://api.github.com>>, @template=#<Addressable::Template:0x2aa44a0 PATTERN:https://api.github.com/repos/{owner}/{repo}>>
+```
+
+This gets us the relation named `repository` that we can request now. The usual HTTP methods are available on a relation:
+
+```ruby
+    def get(params = {})
+      request :get, nil, params
+    end
+
+    def delete(params = {})
+      request :delete, nil, params
+    end
+
+    def post(data = {}, params = {})
+      request :post, data, params
+    end
+
+    def put(data = {}, params = {})
+      request :put, data, params
+    end
+
+    def patch(data = {}, params = {})
+      request :patch, data, params
+    end
 ```
 
-Send a GET request for a specific repository using given parameters. They will be used to expand the URI template behind the `repositories` relation.
+URL templates can define some parameters such as `{owner}` or `{repo}`. They will be expanded from the `params` given to the HTTP method method.
+
+Now send a GET request with some parameters to request a specific repository:
 
 ```ruby
 repo = repositories.get(owner: 'jgraichen', repo: 'restify').value

data/lib/restify.rb

@@ -1,13 +1,14 @@
 require 'restify/version'
 
 require 'hashie'
-require 'obligation'
+require 'concurrent'
 require 'addressable/uri'
 require 'addressable/template'
 
 #
 module Restify
   require 'restify/error'
+  require 'restify/promise'
 
   require 'restify/context'
   require 'restify/resource'
@@ -26,7 +27,7 @@ module Restify
 
   class << self
     def new(uri, opts = {})
-      Relation.new Context.new(uri), uri
+      Relation.new Context.new(uri, opts), uri
     end
 
     def adapter

data/lib/restify/adapter/em.rb

@@ -106,7 +106,7 @@ module Restify
       end
 
       def call(request)
-        Obligation.create do |writer|
+        Promise.create do |writer|
           next_tick do
             Connection.open(request.uri).call(request, writer)
           end

data/lib/restify/adapter/typhoeus.rb

@@ -32,7 +32,7 @@ module Restify
       end
 
       def call(request)
-        Obligation.create do |writer|
+        Promise.create do |writer|
           queue request, writer
         end
       end

data/lib/restify/context.rb

@@ -12,8 +12,9 @@ module Restify
     #
     attr_reader :uri
 
-    def initialize(uri)
+    def initialize(uri, opts = {})
       @uri  = uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri.to_s)
+      @opts = opts
     end
 
     def join(uri)
@@ -21,7 +22,7 @@ module Restify
     end
 
     def process(response)
-      context   = Context.new response.uri
+      context   = Context.new response.uri, @opts
       processor = Restify::PROCESSORS.find { |p| p.accept? response }
       processor ||= Restify::Processors::Base
 
@@ -29,7 +30,11 @@ module Restify
     end
 
     def request(method, uri, data = nil, opts = {})
-      request = Request.new method: method, uri: join(uri), data: data
+      request = Request.new \
+        method: method,
+        uri: join(uri),
+        data: data,
+        headers: @opts.fetch(:headers, {})
 
       Restify.adapter.call(request).then do |response|
         if response.success?

data/lib/restify/promise.rb

@@ -0,0 +1,93 @@
+module Restify
+  #
+  class Promise < Concurrent::IVar
+    def initialize(*dependencies, &task)
+      @task         = task || proc { |*args| args }
+      @dependencies = dependencies.flatten
+
+      super(&nil)
+    end
+
+    def wait(timeout = nil)
+      if @dependencies.any? && pending?
+        execute
+      end
+
+      super
+    end
+
+    def then(&block)
+      Promise.new([self], &block)
+    end
+
+    def execute
+      synchronize { ns_execute }
+    end
+
+    protected
+
+    # @!visibility private
+    def ns_execute
+      return unless pending?
+
+      executor = Concurrent::SafeTaskExecutor.new \
+        method(:eval_dependencies), rescue_exception: true
+      success, value, reason = executor.execute(@dependencies)
+
+      if success
+        ns_execute_task(*value)
+      else
+        complete false, nil, reason
+      end
+    end
+
+    # @!visibility private
+    def ns_execute_task(*args)
+      if compare_and_set_state(:processing, :pending)
+        success, value, reason = Concurrent::SafeTaskExecutor.new(@task, rescue_exception: true).execute(*args)
+
+        while success && value.is_a?(Concurrent::IVar)
+          success, value, reason = value.wait, value.value, value.reason
+        end
+
+        complete success, value, reason
+      end
+    end
+
+    # @!visibility private
+    def eval_dependencies(dependencies)
+      dependencies.map(&method(:eval_dependency))
+    end
+
+    # @!visibility private
+    def eval_dependency(dependency)
+      if dependency.is_a? Concurrent::IVar
+        eval_dependency dependency.value!
+      else
+        dependency
+      end
+    end
+
+    class << self
+      def create
+        promise = Promise.new
+        yield Writer.new(promise)
+        promise
+      end
+    end
+
+    class Writer
+      def initialize(promise)
+        @promise = promise
+      end
+
+      def fulfill(value)
+        @promise.send :complete, true, value, nil
+      end
+
+      def reject(reason)
+        @promise.send :complete, false, nil, reason
+      end
+    end
+  end
+end

data/lib/restify/request.rb

@@ -18,10 +18,16 @@ module Restify
     #
     attr_reader :data
 
+    # Request headers
+    #
+    attr_reader :headers
+
     def initialize(opts = {})
-      @method = opts.fetch(:method, :get).downcase
-      @uri    = opts.fetch(:uri) { raise ArgumentError.new ':uri required.' }
-      @data   = opts.fetch(:data, nil)
+      @method  = opts.fetch(:method, :get).downcase
+      @uri     = opts.fetch(:uri) { raise ArgumentError.new ':uri required.' }
+      @data    = opts.fetch(:data, nil)
+      @headers = opts.fetch(:headers, {}).merge \
+        'Content-Type' => 'application/json'
     end
 
     def body
@@ -29,11 +35,5 @@ module Restify
         JSON.dump(data) unless data.nil?
       end
     end
-
-    def headers
-      {
-        'Content-Type' => 'application/json'
-      }
-    end
   end
 end

data/lib/restify/version.rb

@@ -1,9 +1,9 @@
 module Restify
   module VERSION
     MAJOR = 0
-    MINOR = 3
-    PATCH = 2
-    STAGE = nil
+    MINOR = 4
+    PATCH = 0
+    STAGE = 'b1'.freeze
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze
 
     def self.to_s

data/restify.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'obligation', '~> 0.1'
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 0.9.0'
   spec.add_runtime_dependency 'addressable', '~> 2.3'
   spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'net-http-persistent'
   spec.add_runtime_dependency 'hashie', '~> 3.3'
   spec.add_runtime_dependency 'rack'
 

data/spec/restify_spec.rb

@@ -117,22 +117,22 @@ describe Restify do
         expect(users_relation).to be_a Restify::Relation
 
         # Let's create a user first.
-        # This method returns instantly and returns an `Obligation`.
-        # This `Obligation` represents the future value.
+        # This method returns instantly and returns a `Promise`.
+        # This `Promise` represents the future value.
         # We can pass parameters to a request. They will be used
         # to expand the URI template behind the relation. Additional
         # fields will be encoding in e.g. JSON and send if not a GET
         # request.
         create_user_promise = users_relation.post
-        expect(create_user_promise).to be_a Obligation
+        expect(create_user_promise).to be_a Restify::Promise
 
         # We can do other things while the request is processed in
         # the background. When we need the response with can call
         # {#value} on the promise that will block the thread until
         # the result is here.
-        begin
-          create_user_promise.value
-        rescue Restify::ClientError => e
+        expect { create_user_promise.value! }.to \
+          raise_error(Restify::ClientError) do |e|
+
           # Because we forgot to send a "name" the server complains
           # with an error code that will lead to a raised error.
 
@@ -187,37 +187,5 @@ describe Restify do
         expect(blurb[:image]).to eq 'http://example.org/avatar.png'
       end
     end
-
-    context 'within eventmachine' do
-      it 'should consume the API' do
-        skip
-
-        EventMachine.run do
-          users_promise = c.rel(:users).get
-          users_promise.then do |users|
-            expect(users).to have(2).items
-
-            user = users.first
-            expect(user).to have_key :name
-            expect(user[:name]).to eq 'John Smith'
-            expect(user).to have_relation :self
-            expect(user).to have_relation :blurb
-
-            user.rel(:blurb).get
-          end.then do |blurb|
-            expect(blurb).to have_key :title
-            expect(blurb).to have_key :image
-
-            expect(blurb[:title]).to eq 'Prof. Dr. John Smith'
-            expect(blurb[:image]).to eq 'http://example.org/avatar.png'
-
-            EventMachine.stop
-            @done = true
-          end
-        end
-
-        expect(@done).to be true
-      end
-    end
   end
 end

data/spec/spec_helper.rb

@@ -17,9 +17,6 @@ case ENV['ADAPTER'].to_s.downcase
   when 'typhoeus'
     require 'restify/adapter/typhoeus'
     Restify.adapter = Restify::Adapter::Typhoeus.new
-  when 'celluloid'
-    require 'restify/adapter/celluloid'
-    Restify.adapter = Restify::Adapter::Celluloid.new
   else
     raise "Invalid adapter: #{ENV['ADAPTER']}"
 end if ENV['ADAPTER']

metadata

@@ -1,97 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 0.3.2.1.b74
+  version: 0.4.0.b1
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: obligation
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   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: net-http-persistent
+  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: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rack
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 description: An experimental hypermedia REST client that uses parallel, keep-alive
@@ -102,10 +116,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/restify.rb
-- lib/restify/adapter/celluloid.rb
 - lib/restify/adapter/em.rb
 - lib/restify/adapter/typhoeus.rb
 - lib/restify/context.rb
@@ -113,6 +127,7 @@ files:
 - lib/restify/link.rb
 - lib/restify/processors/base.rb
 - lib/restify/processors/json.rb
+- lib/restify/promise.rb
 - lib/restify/relation.rb
 - lib/restify/request.rb
 - lib/restify/resource.rb
@@ -125,7 +140,6 @@ files:
 - spec/restify/resource_spec.rb
 - spec/restify_spec.rb
 - spec/spec_helper.rb
-- spec/support/hack_causes.rb
 homepage: https://github.com/jgraichen/restify
 licenses:
 - LGPLv3
@@ -136,17 +150,17 @@ 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: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: An experimental hypermedia REST client.
@@ -157,4 +171,4 @@ test_files:
 - spec/restify/resource_spec.rb
 - spec/restify_spec.rb
 - spec/spec_helper.rb
-- spec/support/hack_causes.rb
+has_rdoc: 

data/lib/restify/adapter/celluloid.rb

@@ -1,36 +0,0 @@
-require 'celluloid/io'
-require 'http'
-
-module Restify
-  #
-  module Adapter
-    #
-    class Celluloid
-      include ::Celluloid::IO
-
-      def process(request, writer)
-        response = ::HTTP
-          .headers(request.headers)
-          .send request.method.downcase,
-            request.uri.to_s,
-            body: request.body,
-            socket_class: ::Celluloid::IO::TCPSocket
-
-        uri     = response.uri
-        status  = response.status.code
-        body    = response.body.to_s
-        headers = response.headers.to_h.each_with_object({}) do |header, hash|
-          hash[header[0].upcase.tr('-', '_')] = header[1]
-        end
-
-        writer.fulfill Response.new request, uri, status, headers, body
-      end
-
-      def call(request)
-        Obligation.create do |writer|
-          async.process request, writer
-        end
-      end
-    end
-  end
-end

data/spec/support/hack_causes.rb

@@ -1,14 +0,0 @@
-
-class Obligation::RejectedError
-  def backtrace
-    if cause
-      if (sup = super).nil?
-        sup
-      else
-        super + ["==== caused by #{cause.class}: #{cause}"] + cause.backtrace
-      end
-    else
-      super
-    end
-  end
-end