hyperclient 0.0.1 → 0.0.2

data/test/hyperclient/resource_test.rb

@@ -0,0 +1,80 @@
+require_relative '../test_helper'
+require 'hyperclient/resource'
+
+module Hyperclient
+  describe Resource do
+    let(:response) do
+      File.read('test/fixtures/element.json')
+    end
+
+    let(:parsed_response) do
+      JSON.parse(response)
+    end
+
+    before do
+      Resource.entry_point = 'http://api.example.org'
+    end
+
+    describe 'url' do
+      it 'merges the resource url with the entry point' do
+        resource = Resource.new('/path/to/resource')
+        resource.url.to_s.must_equal 'http://api.example.org/path/to/resource'
+      end
+
+      it 'returns the given url if it cannot merge it' do
+        resource = Resource.new('/search={terms}')
+        resource.url.to_s.must_equal '/search={terms}'
+      end
+    end
+
+    describe 'initialize' do
+      before do
+        stub_request(:get, 'http://api.example.org')
+      end
+
+      it 'initializes the response when one is given' do
+        resource = Resource.new('/', {response: JSON.parse(response)})
+
+        assert_not_requested(:get, 'http://api.example.org/')
+      end
+
+      it 'updates the resource URL if the response has one' do
+        resource = Resource.new('/', {response: JSON.parse(response)})
+
+        resource.url.must_include '/productions/1'
+      end
+
+      it 'does no update the resource URL if the response does not have one' do
+        resource = Resource.new('/', {})
+
+        resource.url.wont_include '/productions/1'
+      end
+
+      it 'sets the resource name' do
+        resource = Resource.new('/', {name: 'posts'})
+
+        resource.name.must_equal 'posts'
+      end
+    end
+
+    describe 'reload' do
+      before do
+        stub_request(:get, "http://api.example.org/productions/1").
+          to_return(:status => 200, :body => response, headers: {content_type: 'application/json'})
+      end
+
+      it 'retrives itself from the API' do
+        resource = Resource.new('/productions/1')
+        resource.reload
+
+        assert_requested(:get, 'http://api.example.org/productions/1', times: 1)
+      end
+
+      it 'returns itself' do
+        resource = Resource.new('/productions/1')
+
+        resource.reload.must_equal resource
+      end
+    end
+  end
+end

data/test/hyperclient/response_test.rb

@@ -0,0 +1,50 @@
+require_relative '../test_helper'
+require 'hyperclient/response'
+
+module Hyperclient
+  describe Response do
+    let (:response) do
+      Response.new JSON.parse(File.read('test/fixtures/element.json'))
+    end
+
+    describe 'attributes' do
+      it 'returns the resource attributes' do
+        response.attributes['title'].must_equal 'Real World ASP.NET MVC3'
+      end
+
+      it 'does not include _links as attributes' do
+        response.attributes.wont_include '_links'
+      end
+
+      it 'does not include _embedded as attributes' do
+        response.attributes.wont_include '_embedded'
+      end
+    end
+
+    describe 'links' do
+      it 'returns resources included in the _links section' do
+        response.links.filter.must_be_kind_of Resource
+      end
+    end
+
+    describe 'resources' do
+      it 'returns resources included in the _embedded section' do
+        response.resources.author.must_be_kind_of Resource
+        response.resources.episodes.first.must_be_kind_of Resource
+        response.resources.episodes.last.must_be_kind_of Resource
+      end
+    end
+
+    describe 'url' do
+      it 'returns the url of the resource grabbed from the response' do
+        response.url.must_equal '/productions/1'
+      end
+
+      it 'returns nil when the response does not include the resource url' do
+        response = Response.new({_links: {media: {href: '/media/1'}}})
+
+        response.url.must_equal nil
+      end
+    end
+  end
+end

data/test/hyperclient_test.rb

@@ -0,0 +1,63 @@
+require_relative 'test_helper'
+require 'hyperclient'
+
+describe Hyperclient do
+  let(:api) do
+    Class.new do
+      include Hyperclient
+    end
+  end
+
+  describe 'entry point' do
+    it 'sets the entry point for Hyperclient::Resource' do
+      api.entry_point 'http://my.api.org'
+
+      Hyperclient::Resource.new('/').url.must_include 'http://my.api.org'
+    end
+  end
+
+  describe 'entry' do
+    before do
+      api.entry_point 'http://my.api.org'
+    end
+
+    it 'initializes a Resource at the entry point' do
+      api.new.entry.url.must_equal 'http://my.api.org/'
+    end
+
+    it 'sets the Resource name' do
+      api.new.name.must_equal 'Entry point'
+    end
+  end
+
+  describe 'auth' do
+    it 'sets authentication type' do
+      api.auth(:digest, nil, nil)
+
+      api.http_options[:http][:auth][:type].must_equal :digest
+    end
+
+    it 'sets the authentication credentials' do
+      api.auth(:digest, 'user', 'secret')
+
+      api.http_options[:http][:auth][:credentials].must_include 'user'
+      api.http_options[:http][:auth][:credentials].must_include 'secret'
+    end
+  end
+
+  describe 'method missing' do
+    class Hyperclient::Resource
+      def foo
+        'foo'
+      end
+    end
+
+    it 'delegates undefined methods to the API when they exist' do
+      api.new.foo.must_equal 'foo'
+    end
+
+    it 'raises an error when the method does not exist in the API' do
+      lambda { api.new.this_method_does_not_exist }.must_raise(NoMethodError)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+gem 'minitest'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'turn'
+require 'webmock/minitest'
+require 'json'

metadata

@@ -1,32 +1,115 @@
 --- !ruby/object:Gem::Specification
 name: hyperclient
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- Mike Subelsky
+- Oriol Gual
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000Z
-dependencies: []
-description: Proof of concept for interacting with a hypermedia API
+date: 2012-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HyperClient is a Ruby Hypermedia API client.
 email:
-- mike@subelsky.com
+- oriol.gual@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rvmrc
+- .travis.yml
+- .yardopts
 - Gemfile
+- Guardfile
 - LICENSE
-- README.md
+- MIT-LICENSE
 - Rakefile
+- Readme.md
+- examples/hal_shop.rb
 - hyperclient.gemspec
 - lib/hyperclient.rb
+- lib/hyperclient/discoverer.rb
+- lib/hyperclient/http.rb
+- lib/hyperclient/resource.rb
+- lib/hyperclient/response.rb
 - lib/hyperclient/version.rb
-homepage: https://github.com/subelsky/hyperclient
+- test/fixtures/collection.json
+- test/fixtures/element.json
+- test/fixtures/root.json
+- test/hyperclient/discoverer_test.rb
+- test/hyperclient/http_test.rb
+- test/hyperclient/resource_test.rb
+- test/hyperclient/response_test.rb
+- test/hyperclient_test.rb
+- test/test_helper.rb
+homepage: http://codegram.github.com/hyperclient/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -38,17 +121,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2437981689318086472
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2437981689318086472
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: This client is capable of interacting with hypermedia APIs as described in
-  http://www.subbu.org/blog/2008/09/on-linking-part-1 and elsewhere
-test_files: []
+summary: ''
+test_files:
+- test/fixtures/collection.json
+- test/fixtures/element.json
+- test/fixtures/root.json
+- test/hyperclient/discoverer_test.rb
+- test/hyperclient/http_test.rb
+- test/hyperclient/resource_test.rb
+- test/hyperclient/response_test.rb
+- test/hyperclient_test.rb
+- test/test_helper.rb
+has_rdoc: 

data/README.md

@@ -1,71 +0,0 @@
-# Hyperclient
-
-This gem aims to explore and demonstrate how to write a client for [hypermedia APIs](http://blog.steveklabnik.com/posts/2012-02-23-rest-is-over), formerly
-known as REST interfaces that respect the [HATEOAS constraint](http://roy.gbiv.com/untangled/2008/rest-apis-must-be-hypertext-driven).
-
-Many people have demonstrated how the server should respond. I'm investigating how the client should behave when interacting with a true hypermedia server.
-
-The gem is being developed against the [Hypertext Application Language](http://stateless.co/hal_specification.html) and [Atompub](http://bitworking.org/projects/atom/rfc5023.html) specifications.
-
-Contributors welcome!
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'hyperclient'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hyperclient
-
-## Usage
-
-```ruby
-require 'hyperclient'
-
-# NOTE this is the only URI you ever need to specify yourself. The server will provide all future links.
-resource = Hyperclient::Resource.new("http://api.example.com")
-
-resource.links.each { |l| puts(l.relation => l.uri) }
-# {:self => "https://api.example.com"}
-# {:orders => "https://api.example.com/orders"}
-# {:customers => "https://api.example.com/customers"}
-
-# since we're at the root level of this API we haven't drilled into any objects yet
-pp resource.objects
-# []
-
-orders_resource = resource[:orders].get
-pp orders_resource.links
-# {:self => "https://api.example.com/orders",
-#  :next => "https://api.example.com/orders/page/2"}
-
-# some servers may return embedded objects
-orders_resource.objects.each { |l| puts l.class => l.attributes }
-# [Hyperclient::Resource => {:id => 50, :item_name => "R2 Motivator", :created_at => "2012-02-03 12:15:02 -0400"},
-#  Hyperclient::Resource => {:id => 51, :item_name => "Hydrospanner", :created_at => "2012-02-04 13:18:12 -0500"}]
-
-order_resource = orders_resource.post({ item_name: "Droid Coolant" })
-pp order_resource.location
-# "https://api.example.com/orders/52"
-
-pp order_resource.attributes
-# {:id => 52, :item_name => "Droid Coolant", :created_at => "2012-03-05 21:31:04 -0500"}
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Questions?
-
-Contact me on [Twitter](https://twitter/subelsky) or [email](mike@subelsky.com).