restify 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53afb4149e4a7cf9a74f1adefb033fddbff747b1
-  data.tar.gz: 08a921b2651ed0b7f1a4b7bfe9cc3902bbdcc025
+  metadata.gz: 056a4caf86fd6f8b72c420b0ecc705a74147c5a1
+  data.tar.gz: ce0ea38d4c1bdd4c9e0c08eac752eeb0669a16db
 SHA512:
-  metadata.gz: e36cddfca76ff7cb128eda9c4063fc1c331e9da02a386ee42fa3e2c294c6d6857ec2bc1eb9d4fae59d2bb6c4e5d2c34e26e8742190437d7196cfb61d16b39dc3
-  data.tar.gz: 2480565bdd848d2e6d4574fa664418b4bf387d91752d8e4f678673764a31e1cb4924b88901f1f04f28e5b40017454273024d683b97b1fb8cfafa196e7bf836b3
+  metadata.gz: 6a64dc7d022c4d6abc168886bcc3ef329abfee0279a47230c6457d9f9f41e6c30962ac8af0edd5211d82e5c4fcd8cb4571e0339362a53ae531a2b2eae569eb58
+  data.tar.gz: a551b3a408e99647ba3c0a12b452e7caf9fba94d6d49a94791d080c02ce0e26c6393c25a64b14f69b25e41bc4f37c83d3754c6c0b2429b3cee9c4c2789541b6b

data/README.md

@@ -34,7 +34,6 @@ Planned features:
 * API versions via header
 * Content-Type and Language negotiation
 * Processors for MessagePack, JSON-HAL, etc.
-* Eventmachine integration (see obligation library)
 
 ## Installation
 

data/lib/restify.rb

@@ -9,6 +9,8 @@ require 'addressable/template'
 module Restify
   require 'restify/error'
   require 'restify/promise'
+  require 'restify/registry'
+  require 'restify/global'
 
   require 'restify/context'
   require 'restify/resource'
@@ -25,20 +27,5 @@ module Restify
 
   PROCESSORS = [Processors::Json]
 
-  class << self
-    def new(uri, opts = {})
-      Relation.new Context.new(uri, opts), uri
-    end
-
-    def adapter
-      @adapter ||= begin
-        require 'restify/adapter/typhoeus'
-        Restify::Adapter::Typhoeus.new
-      end
-    end
-
-    def adapter=(adapter)
-      @adapter = adapter
-    end
-  end
+  extend Global
 end

data/lib/restify/adapter/typhoeus.rb

@@ -6,9 +6,10 @@ module Restify
     #
     class Typhoeus
 
-      def initialize
-        @queue = Queue.new
-        @hydra = ::Typhoeus::Hydra.new
+      def initialize(**options)
+        @queue   = Queue.new
+        @hydra   = ::Typhoeus::Hydra.new
+        @options = options
 
         Thread.new do
           begin
@@ -27,8 +28,17 @@ module Restify
         end
       end
 
+      def sync?
+        @options.fetch :sync, false
+      end
+
       def queue(request, writer)
-        @queue.push [request, writer]
+        if sync?
+          @hydra.queue convert request, writer
+          @hydra.run
+        else
+          @queue.push [request, writer]
+        end
       end
 
       def call(request)

data/lib/restify/context.rb

@@ -12,17 +12,28 @@ module Restify
     #
     attr_reader :uri
 
-    def initialize(uri, opts = {})
-      @uri  = uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri.to_s)
-      @opts = opts
+    # Options passed to this context.
+    #
+    # @return [Hash] Options.
+    #
+    attr_reader :options
+
+    def initialize(uri, **kwargs)
+      @uri     = uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri.to_s)
+      @options = kwargs
     end
 
     def join(uri)
       self.uri.join uri
     end
 
+    def inherit(uri, **kwargs)
+      uri = self.uri unless uri
+      Context.new uri, kwargs.merge(options)
+    end
+
     def process(response)
-      context   = Context.new response.uri, @opts
+      context   = inherit response.uri
       processor = Restify::PROCESSORS.find { |p| p.accept? response }
       processor ||= Restify::Processors::Base
 
@@ -34,9 +45,9 @@ module Restify
         method: method,
         uri: join(uri),
         data: data,
-        headers: @opts.fetch(:headers, {})
+        headers: options.fetch(:headers, {})
 
-      Restify.adapter.call(request).then do |response|
+      adapter.call(request).then do |response|
         if response.success?
           process response
         else
@@ -45,6 +56,12 @@ module Restify
       end
     end
 
+    private
+
+    def adapter
+      options[:adapter] || Restify.adapter
+    end
+
     class << self
       def raise_response_error(response)
         case response.code

data/lib/restify/global.rb

@@ -0,0 +1,32 @@
+module Restify
+  module Global
+    extend self
+
+    def new(uri, **opts)
+      context = resolve_context uri, **opts
+
+      Relation.new context, context.uri
+    end
+
+    def adapter
+      @adapter ||= begin
+        require 'restify/adapter/em'
+        Restify::Adapter::EM.new
+      end
+    end
+
+    def adapter=(adapter)
+      @adapter = adapter
+    end
+
+    private
+
+    def resolve_context(uri, **opts)
+      if uri.is_a? Symbol
+        Restify::Registry.fetch(uri).inherit(nil, opts)
+      else
+        Context.new uri, opts
+      end
+    end
+  end
+end

data/lib/restify/promise.rb

@@ -2,70 +2,66 @@ module Restify
   #
   class Promise < Concurrent::IVar
     def initialize(*dependencies, &task)
-      @task         = task || proc { |*args| args }
+      @task         = task
       @dependencies = dependencies.flatten
 
       super(&nil)
     end
 
     def wait(timeout = nil)
-      if @dependencies.any? && pending?
-        execute
-      end
-
-      super
+      execute if pending?
+
+      # if defined?(EventMachine)
+      #   if incomplete?
+      #     fiber = Fiber.current
+
+      #     self.add_observer do
+      #       EventMachine.next_tick { fiber.resume }
+      #     end
+
+      #     Fiber.yield
+      #   else
+      #     self
+      #   end
+      # else
+        super
+      # end
     end
 
     def then(&block)
       Promise.new([self], &block)
     end
 
-    def execute
-      synchronize { ns_execute }
+    def execute(timeout = nil)
+      synchronize { ns_execute timeout }
     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)
+    def ns_execute(timeout)
       if compare_and_set_state(:processing, :pending)
-        success, value, reason = Concurrent::SafeTaskExecutor.new(@task, rescue_exception: true).execute(*args)
+        return unless @task || @dependencies.any?
+
+        executor = Concurrent::SafeTaskExecutor.new \
+          method(:ns_exec), rescue_exception: true
 
-        while success && value.is_a?(Concurrent::IVar)
-          success, value, reason = value.wait, value.value, value.reason
-        end
+        success, value, reason = executor.execute
 
         complete success, value, reason
       end
     end
 
     # @!visibility private
-    def eval_dependencies(dependencies)
-      dependencies.map(&method(:eval_dependency))
-    end
+    def ns_exec
+      args  = @dependencies.any? ? @dependencies.map(&:value!) : []
+      value = @task ? @task.call(*args) : args
 
-    # @!visibility private
-    def eval_dependency(dependency)
-      if dependency.is_a? Concurrent::IVar
-        eval_dependency dependency.value!
-      else
-        dependency
+      while value.is_a? Restify::Promise
+        value = value.value!
       end
+
+      value
     end
 
     class << self

data/lib/restify/registry.rb

@@ -0,0 +1,26 @@
+module Restify
+  class Registry
+    def initialize
+      @registry = {}
+    end
+
+    def store(name, uri, **opts)
+      @registry[name] = Context.new uri, **opts
+    end
+
+    def fetch(name)
+      @registry.fetch name
+    end
+
+    class << self
+      extend Forwardable
+
+      def instance
+        @instance ||= new
+      end
+
+      delegate store: :instance
+      delegate fetch: :instance
+    end
+  end
+end

data/lib/restify/relation.rb

@@ -1,11 +1,28 @@
 module Restify
   #
   class Relation
+
+    # Relation context
+    #
+    # @return [Restify::Context] Context
+    #
+    attr_reader :context
+
+    # Relation URI template
+    #
+    # @return [Addressable::Template] URI template
+    #
+    attr_reader :template
+
     def initialize(context, template)
       @context  = context
       @template = Addressable::Template.new template
     end
 
+    def request(method, data, params)
+      context.request method, expand(params), data
+    end
+
     def get(params = {})
       request :get, nil, params
     end
@@ -27,25 +44,29 @@ module Restify
     end
 
     def ==(other)
-      super || (other.is_a?(String) && @template.pattern == other)
+      super || (other.is_a?(String) && template.pattern == other)
     end
 
     def expand(params)
       params    = convert params
       variables = extract! params
 
-      uri = @template.expand variables
+      uri = template.expand variables
       uri.query_values = (uri.query_values || {}).merge params if params.any?
 
-      @context.join uri
+      context.join uri
     end
 
-    private
+    def pattern
+      template.pattern
+    end
 
-    def request(method, data, params)
-      @context.request method, expand(params), data
+    def to_s
+      pattern
     end
 
+    private
+
     def convert(params)
       params.each_pair.each_with_object({}) do |param, hash|
         hash[param[0]] = convert_param param[1]

data/lib/restify/resource.rb

@@ -68,12 +68,24 @@ module Restify
 
     # Follow a LOCATION or CONTEXT-LOCATION header.
     #
-    # @return [Relation] Relation to follow resource.
-    # @raise RuntimeError If nothing to follow.
+    # @return [Relation] Relation to follow resource or nil.
     #
     def follow
       if relation? :_restify_follow
         relation :_restify_follow
+      else
+        nil
+      end
+    end
+
+    # Follow a LOCATION or CONTEXT-LOCATION header.
+    #
+    # @return [Relation] Relation to follow resource.
+    # @raise RuntimeError If nothing to follow.
+    #
+    def follow!
+      if (rel = follow)
+        rel
       else
         raise RuntimeError.new 'Nothing to follow'
       end

data/lib/restify/version.rb

@@ -1,7 +1,7 @@
 module Restify
   module VERSION
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze

data/restify.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
 
   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'
+  spec.add_runtime_dependency 'eventmachine', '>= 1.2'
+  spec.add_runtime_dependency 'em-http-request', '~> 1.1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
 

data/spec/restify/global_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Restify::Global do
+  let(:global) { Restify }
+
+  describe '#new' do
+    context 'with string URI' do
+      let(:uri)     { 'http://api.github.com/' }
+      let(:options) { {accept: 'application.vnd.github.v3+json'} }
+
+      subject { global.new uri, **options }
+
+      it 'returns relation for URI' do
+        expect(subject).to be_a Restify::Relation
+        expect(subject.pattern).to eq uri
+        expect(subject.context.uri.to_s).to eq uri
+        expect(subject.context.options).to eq options
+      end
+    end
+
+    context 'with registry symbol' do
+      let(:name)  { :registry_item_name }
+      let(:uri)     { 'http://api.github.com/' }
+      let(:options) { {accept: 'application.vnd.github.v3+json'} }
+      let(:context) { Restify::Context.new uri, **options }
+
+      subject { global.new name, options }
+
+      it 'returns relation for stored registry item' do
+        Restify::Registry.store name, uri, options
+
+        expect(subject).to be_a Restify::Relation
+        expect(subject.pattern).to eq uri
+        expect(subject.context.uri.to_s).to eq uri
+        expect(subject.context.options).to eq options
+      end
+    end
+  end
+end

data/spec/restify/registry_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Restify::Registry do
+  let(:registry) { described_class.instance }
+
+  describe 'class' do
+    describe '#instance' do
+      subject { described_class.instance }
+
+      it 'returns singleton instance' do
+        expect(subject).to be_a described_class
+        expect(subject).to be described_class.instance
+      end
+    end
+
+    describe '#fetch' do
+      it 'delegates to singleton instance' do
+        args = Object.new
+        expect(described_class.instance).to receive(:fetch).with(args)
+
+        described_class.fetch args
+      end
+    end
+
+    describe '#store' do
+      it 'delegates to singleton instance' do
+        arg1 = Object.new
+        arg2 = Object.new
+        expect(described_class.instance).to receive(:store).with(arg1, arg2)
+
+        described_class.store arg1, arg2
+      end
+    end
+  end
+
+  describe '#store / #fetch' do
+    let(:name) { 'remote' }
+    let(:uri)  { 'http://remote/entry/point' }
+    let(:opts) { {accept: 'application/vnd.remote+json'} }
+
+    subject { registry.store name, uri, **opts }
+
+    it 'stores registry item' do
+      subject
+
+      item = registry.fetch name
+
+      expect(item.uri.to_s).to eq uri
+      expect(item.options).to eq opts
+    end
+  end
+end

data/spec/restify/resource_spec.rb

@@ -61,13 +61,40 @@ describe Restify::Resource do
       end
     end
 
-    context '#follow' do
+    describe '#follow' do
       let(:relations) { {_restify_follow: 'http://localhost/10'} }
 
       it 'returns follow relation' do
         expect(subject.follow).to be_a Restify::Relation
         expect(subject.follow).to eq 'http://localhost/10'
       end
+
+      context 'when nil' do
+        let(:relations) { {} }
+
+        it 'returns nil' do
+          expect(subject.follow).to be nil
+        end
+      end
+    end
+
+    context '#follow!' do
+      let(:relations) { {_restify_follow: 'http://localhost/10'} }
+
+      it 'returns follow relation' do
+        expect(subject.follow!).to be_a Restify::Relation
+        expect(subject.follow!).to eq 'http://localhost/10'
+      end
+
+      context 'when nil' do
+        let(:relations) { {} }
+
+        it 'raise runtime error' do
+          expect { subject.follow! }.to raise_error RuntimeError do |err|
+            expect(err.message).to eq 'Nothing to follow'
+          end
+        end
+      end
     end
   end
 

data/spec/restify_spec.rb

@@ -99,17 +99,17 @@ describe Restify do
       end
     end
 
-    let(:c) do
-      Restify.new('http://localhost/base').get.value
-    end
-
     context 'within threads' do
       it 'should consume the API' do
         # Let's get all users
 
+        # First request the entry resource usually the
+        # root using GET and wait for it.
+        root = Restify.new('http://localhost/base').get.value!
+
         # Therefore we need the `users` relations of our root
         # resource.
-        users_relation = c.rel(:users)
+        users_relation = root.rel(:users)
 
         # The relation is a `Restify::Relation` and provides
         # method to enqueue e.g. GET or POST requests with
@@ -142,7 +142,7 @@ describe Restify do
         end
 
         # Let's try again.
-        created_user = users_relation.post(name: 'John Smith').value
+        created_user = users_relation.post(name: 'John Smith').value!
 
         # The server returns a 201 Created response with the created
         # resource.
@@ -153,7 +153,7 @@ describe Restify do
         expect(created_user.name).to eq 'John Smith'
 
         # Let's follow the "Location" header.
-        followed_resource = created_user.follow.get.value
+        followed_resource = created_user.follow.get.value!
 
         expect(followed_resource.response.status).to eq :ok
         expect(followed_resource.response.code).to eq 200
@@ -162,7 +162,7 @@ describe Restify do
         expect(followed_resource.name).to eq 'John Smith'
 
         # Now we will fetch a list of all users.
-        users = users_relation.get.value
+        users = users_relation.get.value!
 
         # We get a collection back (Restify::Collection).
         expect(users).to have(2).items
@@ -178,7 +178,7 @@ describe Restify do
         expect(user).to have_relation :blurb
 
         # Let's get the blurb.
-        blurb = user.rel(:blurb).get.value
+        blurb = user.rel(:blurb).get.value!
 
         expect(blurb).to have_key :title
         expect(blurb).to have_key :image
@@ -187,5 +187,67 @@ describe Restify do
         expect(blurb[:image]).to eq 'http://example.org/avatar.png'
       end
     end
+
+    context 'within EM-synchrony' do
+      it 'should consume the API' do
+        skip 'Seems to be impossible to detect EM scheduled fibers from within'
+
+        EM.synchrony do
+          root = Restify.new('http://localhost/base').get.value!
+
+          users_relation = root.rel(:users)
+
+          expect(users_relation).to be_a Restify::Relation
+
+          create_user_promise = users_relation.post
+          expect(create_user_promise).to be_a Restify::Promise
+
+          expect { create_user_promise.value! }.to \
+            raise_error(Restify::ClientError) do |e|
+
+            expect(e.status).to eq :unprocessable_entity
+            expect(e.code).to eq 422
+            expect(e.errors).to eq 'name' => ["can't be blank"]
+          end
+
+          created_user = users_relation.post(name: 'John Smith').value!
+
+          expect(created_user.response.status).to eq :created
+          expect(created_user.response.code).to eq 201
+
+          expect(created_user).to have_key :name
+          expect(created_user.name).to eq 'John Smith'
+
+          followed_resource = created_user.follow.get.value!
+
+          expect(followed_resource.response.status).to eq :ok
+          expect(followed_resource.response.code).to eq 200
+
+          expect(followed_resource).to have_key :name
+          expect(followed_resource.name).to eq 'John Smith'
+
+          users = users_relation.get.value!
+
+          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
+
+          blurb = user.rel(:blurb).get.value!
+
+          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
+        end
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -17,11 +17,16 @@ case ENV['ADAPTER'].to_s.downcase
   when 'typhoeus'
     require 'restify/adapter/typhoeus'
     Restify.adapter = Restify::Adapter::Typhoeus.new
+  when 'typhoeus-sync'
+    require 'restify/adapter/typhoeus'
+    Restify.adapter = Restify::Adapter::Typhoeus.new sync: true
   else
     raise "Invalid adapter: #{ENV['ADAPTER']}"
 end if ENV['ADAPTER']
 
+require 'webmock/rspec'
 require 'rspec/collection_matchers'
+require 'em-synchrony'
 
 Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -39,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,18 +124,22 @@ files:
 - lib/restify/adapter/typhoeus.rb
 - lib/restify/context.rb
 - lib/restify/error.rb
+- lib/restify/global.rb
 - lib/restify/link.rb
 - lib/restify/processors/base.rb
 - lib/restify/processors/json.rb
 - lib/restify/promise.rb
+- lib/restify/registry.rb
 - lib/restify/relation.rb
 - lib/restify/request.rb
 - lib/restify/resource.rb
 - lib/restify/response.rb
 - lib/restify/version.rb
 - restify.gemspec
+- spec/restify/global_spec.rb
 - spec/restify/link_spec.rb
 - spec/restify/processors/json_spec.rb
+- spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb
 - spec/restify/resource_spec.rb
 - spec/restify_spec.rb
@@ -165,8 +169,10 @@ signing_key:
 specification_version: 4
 summary: An experimental hypermedia REST client.
 test_files:
+- spec/restify/global_spec.rb
 - spec/restify/link_spec.rb
 - spec/restify/processors/json_spec.rb
+- spec/restify/registry_spec.rb
 - spec/restify/relation_spec.rb
 - spec/restify/resource_spec.rb
 - spec/restify_spec.rb