hyperclient 0.1.0 → 0.2.0

data/.rvmrc

@@ -1 +1 @@
-rvm use --create 1.9.3@hyperclient
+rvm use --create 1.9.3-p125@hyperclient

data/Readme.md

@@ -1,5 +1,5 @@
-# Hyperclient 
-[![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient) 
+# Hyperclient
+[![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient)
 [![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/codegram/hyperclient)
 
@@ -30,7 +30,7 @@ Hyperclient only works with JSON HAL friendly APIs. [Learn about JSON HAL][hal].
 
 ## Resources
 
-Hyperclient will try to fetch and discover the resources from your API. 
+Hyperclient will try to fetch and discover the resources from your API.
 
 ### Links
 
@@ -111,6 +111,17 @@ posts = api.links.posts
 posts.post({title: "I'm a blogger!", body: 'Wohoo!!'})
 ````
 
+If you have a templated link you can expand it like so:
+
+````ruby
+api.links.post.expand(:id => 3).first
+# => #<Resource ...>
+````
+
+## Other
+
+There's also a PHP library named [HyperClient](https://github.com/FoxyCart/HyperClient), if that's what you were looking for :)
+
 ## TODO
 
 * Resource permissions: Using the `Allow` header Hyperclient should be able to
@@ -143,4 +154,4 @@ MIT License. Copyright 2012 [Codegram Technologies][codegram]
 [httparty]: http://github.com/jnunemaker/httparty
 [examples]: http://github.com/codegram/hyperclient/tree/master/examples
 [enumerable]: http://ruby-doc.org/core-1.9.3/Enumerable.html
-[rdoc]: http://rubydoc.org/github/codegram/hyperclient/master/frames
+[rdoc]: http://rubydoc.org/github/codegram/hyperclient/master/frames

data/hyperclient.gemspec

@@ -14,11 +14,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Hyperclient::VERSION
 
-  gem.add_dependency 'httparty'
+  gem.add_dependency 'faraday'
   gem.add_dependency 'uri_template'
+  gem.add_dependency 'net-http-digest_auth'
 
-  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest', '~> 3.4.0'
   gem.add_development_dependency 'turn'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'rack-test'
 end

data/lib/hyperclient/collection.rb

@@ -34,6 +34,13 @@ module Hyperclient
       @collection[name.to_s]
     end
 
+    # Public: Returns the wrapped collection as a hash.
+    #
+    # Returns a Hash.
+    def to_hash
+      @collection.to_hash
+    end
+
     # Public: Provides method access to the collection values.
     #
     # It allows accessing a value as `collection.name` instead of

data/lib/hyperclient/http.rb

@@ -1,18 +1,12 @@
-require 'httparty'
+require 'faraday'
 require 'json'
-
-# Public: A parser for HTTParty that understand the mime application/hal+json.
-class JSONHalParser < HTTParty::Parser
-  SupportedFormats.merge!({'application/hal+json' => :json})
-end
+require 'net/http/digest_auth'
 
 module Hyperclient
   # Internal: This class wrapps HTTParty and performs the HTTP requests for a
   # resource.
   class HTTP
-    include HTTParty
-    parser JSONHalParser
-
+    attr_writer :faraday
     # Public: Initializes the HTTP agent.
     #
     # url    - A String to send the HTTP requests.
@@ -24,16 +18,19 @@ module Hyperclient
     #            :user     - A String with the user.
     #            :password - A String with the user.
     #          :debug   - The flag (true/false) to debug the HTTP connections.
+    #          :faraday_options - A Hash that will be passed to Faraday.new (optional).
+    #                             Can additionally include a :block => <Proc> that is also
+    #                             passed to Faraday.
     #
     def initialize(url, config)
       @url      = url
       @config   = config
       @base_uri = config.fetch(:base_uri)
+      @faraday_options = (config[:faraday_options] || {}).dup
+      @faraday_block = @faraday_options.delete(:block)
 
       authenticate!
       toggle_debug! if @config[:debug]
-
-      self.class.headers(@config[:headers]) if @config.include?(:headers)
     end
 
     def url
@@ -48,7 +45,11 @@ module Hyperclient
     #
     # Returns: The parsed response.
     def get
-      JSON.parse(self.class.get(url).response.body)
+      response = process_request :get
+
+      if body = response.body
+        JSON.parse(body)
+      end
     end
 
     # Public: Sends a POST request the the resource url.
@@ -57,7 +58,7 @@ module Hyperclient
     #
     # Returns: A HTTParty::Response
     def post(params)
-      self.class.post(url, body: params)
+      wrap_response process_request(:post, params)
     end
 
     # Public: Sends a PUT request the the resource url.
@@ -66,31 +67,59 @@ module Hyperclient
     #
     # Returns: A HTTParty::Response
     def put(params)
-      self.class.put(url, body: params)
+      wrap_response process_request(:put, params)
     end
 
     # Public: Sends an OPTIONS request the the resource url.
     #
     # Returns: A HTTParty::Response
     def options
-      self.class.options(url)
+      wrap_response process_request(:options)
     end
 
     # Public: Sends a HEAD request the the resource url.
     #
     # Returns: A HTTParty::Response
     def head
-      self.class.head(url)
+      wrap_response process_request(:head)
     end
 
     # Public: Sends a DELETE request the the resource url.
     #
     # Returns: A HTTParty::Response
     def delete
-      self.class.delete(url)
+      wrap_response process_request(:delete)
     end
 
     private
+
+    def faraday
+      default_block = lambda do |faraday|
+          faraday.request  :url_encoded
+          faraday.adapter :net_http
+      end
+      @faraday ||= Faraday.new({:url => @base_uri, :headers => @config[:headers] || {}
+        }.merge(@faraday_options), &(@faraday_block || default_block))
+    end
+
+    def wrap_response(faraday_response)
+      def faraday_response.code
+        status
+      end
+      faraday_response
+    end
+
+    def process_request(method, params = nil)
+      response = faraday.run_request method, url, params, faraday.headers
+      if response.status == 401 && @digest_auth
+        response = faraday.run_request method, url, nil, faraday.headers do |request|
+          request.headers['Authorization'] = digest_auth_header(
+            url,  response.headers['www-authenticate'], method)
+        end
+      end
+      response
+    end
+
     # Internal: Sets the authentication method for HTTParty.
     #
     # options - An options Hash to set the authentication options.
@@ -98,21 +127,38 @@ module Hyperclient
     # Returns nothing.
     def authenticate!
       if (options = @config[:auth])
-        auth_method = options.delete(:type).to_s + '_auth'
-        self.class.send(auth_method, options[:user], options[:password])
+        auth_method = options.fetch(:type).to_s + '_auth'
+        send auth_method, options
       end
     end
 
+    def basic_auth(options)
+      faraday.basic_auth options[:user], options[:password]
+    end
+
+    def digest_auth(options)
+      @digest_auth = options
+    end
+
+    def digest_auth_header(url, realm, method)
+      uri = URI.parse(url)
+      uri.user = @digest_auth[:user]
+      uri.password = @digest_auth[:password]
+      digest_auth = Net::HTTP::DigestAuth.new
+      digest_auth.auth_header uri, realm, method.upcase
+    end
+
     # Internal: Enables HTTP debugging.
     #
-    # stream - An object to stream the HTTP out to or just a truthy value. 
+    # stream - An object to stream the HTTP out to or just a truthy value.
     def toggle_debug!
       stream = @config[:debug]
+      require 'logger'
 
       if stream.respond_to?(:<<)
-        self.class.debug_output(stream)
+        faraday.response :logger, ::Logger.new(stream)
       else
-        self.class.debug_output
+        faraday.response :logger, ::Logger.new($stderr)
       end
     end
   end

data/lib/hyperclient/version.rb

@@ -1,3 +1,3 @@
 module Hyperclient
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/test/hyperclient/collection_test.rb

@@ -34,6 +34,12 @@ module Hyperclient
 
       names.must_equal ['_links', 'title', 'description', 'permitted', '_embedded']
     end
+
+    describe '#to_hash' do
+      it 'returns the wrapped collection as a hash' do
+        collection.to_hash.must_be_kind_of Hash
+      end
+    end
   end
 end
 

data/test/hyperclient/http_test.rb

@@ -14,6 +14,48 @@ module Hyperclient
       HTTP.new(url, config)
     end
 
+    describe 'initialize' do
+      it 'passes options to faraday' do
+        Faraday.expects(:new).with(:headers => {}, :url => config[:base_uri],
+          :x => :y).returns(stub('faraday', :headers => {},
+            :run_request => stub(:body => '{}', :status => 200)))
+
+        HTTP.new(url, config.merge(:faraday_options => {:x => :y})).get
+      end
+
+      it 'passes the options to faraday again when initializing it again' do
+        Faraday.expects(:new).with(:headers => {}, :url => config[:base_uri],
+          :x => :y).returns(stub('faraday', :headers => {},
+            :run_request => stub(:body => '{}', :status => 200))).times(2)
+
+        full_config = config.merge(:faraday_options => {:x => :y})
+        2.times { HTTP.new(url, full_config).get }
+      end
+
+      it 'passes a block to faraday' do
+        app = stub('app')
+        http = HTTP.new(url, config.merge(
+          :faraday_options => {:block => lambda{|f| f.adapter :rack, app}}))
+
+        app.expects(:call).returns([200, {}, '{}'] )
+
+        http.get
+      end
+
+      it 'passes a block to faraday again when initializing again' do
+        app = stub('app')
+
+        app.expects(:call).returns([200, {}, '{}'] ).times(2)
+
+        full_config = config.merge(:faraday_options => {:block => lambda{|f|
+          f.adapter :rack, app}})
+        2.times {
+          http = HTTP.new(url, full_config)
+          http.get
+        }
+      end
+    end
+
     describe 'url' do
       it 'merges the resource url with the base uri' do
         http.url.to_s.must_equal 'http://api.example.org/productions/1'
@@ -27,7 +69,7 @@ module Hyperclient
     end
 
     describe 'authentication' do
-      it 'sets the authentication options' do
+      it 'sets the basic authentication options' do
         stub_request(:get, 'http://user:pass@api.example.org/productions/1').
           to_return(body: '{"resource": "This is the resource"}')
 
@@ -35,6 +77,19 @@ module Hyperclient
 
         http.get.must_equal({'resource' => 'This is the resource'})
       end
+
+      it 'sets the digest authentication options' do
+        stub_request(:get, 'http://api.example.org/productions/1').
+          to_return(status: 401, headers: {'www-authenticate' => 'private area'})
+        stub_request(:get, 'http://api.example.org/productions/1').
+          with(headers: {'Authorization' =>
+            %r{Digest username="user", realm="", algorithm=MD5, uri="/productions/1"}}).
+          to_return(body: '{"resource": "This is the resource"}')
+
+        config.update({auth: {type: :digest, user: 'user', password: 'pass'}})
+
+        http.get.must_equal({'resource' => 'This is the resource'})
+      end
     end
 
     describe 'headers' do
@@ -50,17 +105,32 @@ module Hyperclient
     end
 
     describe 'debug' do
+      before(:each) do
+        @stderr = $stderr
+        stub_request(:get, 'http://api.example.org/productions/1').
+          to_return(body: '{"resource": "This is the resource"}')
+      end
+
+      after(:each) do
+        $stderr = @stderr
+      end
+
       it 'enables debugging' do
+        $stderr = StringIO.new
         config.update({debug: true})
 
-        http.class.instance_variable_get(:@default_options)[:debug_output].must_equal $stderr
+        http.get
+
+        $stderr.string.must_include('get http://api.example.org/productions/1')
       end
 
       it 'uses a custom stream' do
         stream = StringIO.new
         config.update({debug: stream})
 
-        http.class.instance_variable_get(:@default_options)[:debug_output].must_equal stream
+        http.get
+
+        stream.string.must_include('get http://api.example.org/productions/1')
       end
     end
 
@@ -78,6 +148,13 @@ module Hyperclient
 
         http.get.must_equal({'some_json' => 12345})
       end
+
+      it 'returns nil if the response body is nil' do
+        stub_request(:get, 'http://api.example.org/productions/1').
+          to_return(body: nil)
+
+        http.get.must_equal(nil)
+      end
     end
 
     describe 'post' do

metadata

@@ -1,112 +1,144 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.1.0
   prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: uri_template
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: net-http-digest_auth
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+    none: false
+  prerelease: false
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: turn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  type: :development
 description: HyperClient is a Ruby Hypermedia API client.
 email:
 - oriol.gual@gmail.com
@@ -156,26 +188,26 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -1184667501328950554
-required_rubygems_version: !ruby/object:Gem::Requirement
+      hash: -3503842849478118704
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -1184667501328950554
+      hash: -3503842849478118704
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ''