sawyer 0.0.1

data/lib/sawyer/response.rb

@@ -0,0 +1,42 @@
+require 'yajl'
+
+module Sawyer
+  class Response
+    attr_reader :agent,
+      :status,
+      :headers,
+      :data,
+      :rels
+
+    # Builds a Response after a completed request.
+    #
+    # agent - The Sawyer::Agent that is managing the API connection.
+    # res   - A Faraday::Response.
+    def initialize(agent, res)
+      @agent   = agent
+      @status  = res.status
+      @headers = res.headers
+      @data    = process_data(@agent.decode_body(res.body))
+    end
+
+    # Turns parsed contents from an API response into a Resource or
+    # collection of Resources.
+    #
+    # data - Either an Array or Hash parsed from JSON.
+    #
+    # Returns either a Resource or Array of Resources.
+    def process_data(data)
+      case data
+      when Hash  then Resource.new(agent, data)
+      when Array then data.map { |hash| process_data(hash) }
+      when nil   then nil
+      else
+        raise ArgumentError, "Unable to process #{data.inspect}.  Want a Hash or Array"
+      end
+    end
+
+    def inspect
+      %(#<#{self.class}: #{@status} @rels=#{@rels.inspect} @data=#{@data.inspect}>)
+    end
+  end
+end

data/sawyer.gemspec

@@ -0,0 +1,78 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'sawyer'
+  s.version           = '0.0.1'
+  s.date              = '2012-09-25'
+  s.rubyforge_project = 'sawyer'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Secret User Agent of HTTP"
+  s.description = "#{s.summary} built on Faraday"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@gmail.com'
+  s.homepage = 'https://github.com/technoweenie/sawyer'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency('faraday',      ['~> 0.8.4'])
+  s.add_dependency('uri_template', ['~> 0.5.0'])
+  s.add_dependency('yajl-ruby',    ['~> 1.1.0'])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE.md
+    README.md
+    Rakefile
+    SPEC.md
+    example/client.rb
+    example/nigiri.schema.json
+    example/server.rb
+    example/user.schema.json
+    lib/sawyer.rb
+    lib/sawyer/agent.rb
+    lib/sawyer/relation.rb
+    lib/sawyer/resource.rb
+    lib/sawyer/response.rb
+    sawyer.gemspec
+    test/agent_test.rb
+    test/helper.rb
+    test/relation_test.rb
+    test/resource_test.rb
+    test/response_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/.*_test\.rb/ }
+end
+

data/test/agent_test.rb

@@ -0,0 +1,60 @@
+require File.expand_path("../helper", __FILE__)
+
+module Sawyer
+  class AgentTest < TestCase
+    def setup
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
+        conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+        conn.adapter :test, @stubs
+      end
+    end
+
+    def test_starts_a_session
+      @stubs.get '/a/' do |env|
+        assert_equal 'foo.com', env[:url].host
+
+        [200, {}, Yajl.dump(
+          :_links => {
+            :users => {:href => '/users'}})]
+      end
+
+      res = @agent.start
+
+      assert_equal 200, res.status
+      assert_kind_of Sawyer::Resource, resource = res.data
+
+      assert_equal '/users', resource.rels[:users].href
+      assert_equal :get,     resource.rels[:users].method
+    end
+
+    def test_requests_with_body_and_options
+      @stubs.post '/a/b/c' do |env|
+        assert_equal '{"a":1}', env[:body]
+        assert_equal 'abc',     env[:request_headers]['x-test']
+        assert_equal 'foo=bar', env[:url].query
+        [200, {}, "{}"]
+      end
+
+      res = @agent.call :post, 'b/c' , {:a => 1},
+        :headers => {"X-Test" => "abc"},
+        :query   => {:foo => 'bar'}
+      assert_equal 200, res.status
+    end
+
+    def test_requests_with_body_and_options_to_get
+      @stubs.get '/a/b/c' do |env|
+        assert_nil env[:body]
+        assert_equal 'abc',     env[:request_headers]['x-test']
+        assert_equal 'foo=bar', env[:url].query
+        [200, {}, "{}"]
+      end
+
+      res = @agent.call :get, 'b/c' , {:a => 1},
+        :headers => {"X-Test" => "abc"},
+        :query   => {:foo => 'bar'}
+      assert_equal 200, res.status
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require File.expand_path('../../lib/sawyer', __FILE__)
+
+class Sawyer::TestCase < Test::Unit::TestCase
+  def default_test
+  end
+end

data/test/relation_test.rb

@@ -0,0 +1,109 @@
+require File.expand_path("../helper", __FILE__)
+
+module Sawyer
+  class RelationTest < TestCase
+    def test_builds_relation_from_hash
+      hash = {:href => '/users/1', :method => 'post'}
+      rel  = Sawyer::Relation.from_link(nil, :self, hash)
+
+      assert_equal :self,      rel.name
+      assert_equal '/users/1', rel.href
+      assert_equal :post,      rel.method
+      assert_equal [:post],    rel.available_methods.to_a
+    end
+
+    def test_builds_multiple_rels_from_multiple_methods
+      index = {
+        'comments' => {:href => '/comments', :method => 'get,post'}
+      }
+
+      rels = Sawyer::Relation.from_links(nil, index)
+      assert_equal 1, rels.size
+      assert_equal [:comments], rels.keys
+
+      assert rel = rels[:comments]
+      assert_equal '/comments',   rel.href
+      assert_equal :get,          rel.method
+      assert_equal [:get, :post], rel.available_methods.to_a
+    end
+
+    def test_builds_rels_from_hash_index
+      index = {
+        'self' => {:href => '/users/1'}
+      }
+
+      rels = Sawyer::Relation.from_links(nil, index)
+
+      assert_equal 1, rels.size
+      assert_equal [:self], rels.keys
+      assert rel = rels[:self]
+      assert_equal :self,      rel.name
+      assert_equal '/users/1', rel.href
+      assert_equal :get,       rel.method
+      assert_equal [:get],     rel.available_methods.to_a
+    end
+
+    def test_builds_rels_from_nil
+      rels = Sawyer::Relation.from_links nil, nil
+      assert_equal 0,  rels.size
+      assert_equal [], rels.keys
+    end
+
+    def test_relation_api_calls
+      agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
+        conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+        conn.adapter :test do |stubs|
+          stubs.get '/a/1' do
+            [200, {}, '{}']
+          end
+          stubs.delete '/a/1' do
+            [204, {}, '{}']
+          end
+        end
+      end
+
+      rel = Sawyer::Relation.new agent, :self, "/a/1", "get,put,delete"
+      assert_equal :get, rel.method
+      [:get, :put, :delete].each do |m|
+        assert rel.available_methods.include?(m), "#{m.inspect} is not available: #{rel.available_methods.inspect}"
+      end
+
+      assert_equal 200, rel.call.status
+      assert_equal 200, rel.call(:method => :head).status
+      assert_equal 204, rel.call(nil, :method => :delete).status
+      assert_raises ArgumentError do
+        rel.call nil, :method => :post
+      end
+
+      assert_equal 200, rel.head.status
+      assert_equal 200, rel.get.status
+      assert_equal 204, rel.delete.status
+
+      assert_raises ArgumentError do
+        rel.post
+      end
+    end
+
+    def test_relation_api_calls_with_uri_tempate
+      agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
+        conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+        conn.adapter :test do |stubs|
+          stubs.get '/octocat/hello' do |env|
+            assert_equal "a=1&b=2", env[:url].query
+            [200, {}, '{}']
+          end
+
+          stubs.get '/a' do
+            [404, {}, '{}']
+          end
+        end
+      end
+
+      rel = Sawyer::Relation.new agent, :repo, "{/user,repo}{?a,b}"
+
+      assert_equal 404, rel.get.status
+      assert_equal 200, rel.get(:uri => {'user' => 'octocat', 'repo' => 'hello', 'a' => 1, 'b' => 2}).status
+    end
+  end
+end
+

data/test/resource_test.rb

@@ -0,0 +1,99 @@
+require File.expand_path("../helper", __FILE__)
+
+module Sawyer
+  class ResourceTest < TestCase
+    def test_accessible_keys
+      res = Resource.new :agent, :a => 1,
+        :_links => {:self => {:href => '/'}}
+
+      assert_equal 1, res.a
+      assert res.rels[:self]
+      assert_equal :agent, res.agent
+      assert_equal 1, res.fields.size
+      assert res.fields.include?(:a)
+    end
+
+    def test_clashing_keys
+      res = Resource.new :agent, :agent => 1, :rels => 2, :fields => 3,
+        :_links => {:self => {:href => '/'}}
+
+      assert_equal 1, res.agent
+      assert_equal 2, res.rels
+      assert_equal 3, res.fields
+
+      assert res._rels[:self]
+      assert_equal :agent, res._agent
+      assert_equal 3, res._fields.size
+      [:agent, :rels, :fields].each do |f|
+        assert res._fields.include?(f)
+      end
+    end
+
+    def test_nested_object
+      res = Resource.new :agent,
+        :user   => {:id => 1, :_links => {:self => {:href => '/users/1'}}},
+        :_links => {:self => {:href => '/'}}
+
+      assert_equal '/', res.rels[:self].href
+      assert_kind_of Resource, res.user
+      assert_equal 1, res.user.id
+      assert_equal '/users/1', res.user.rels[:self].href
+    end
+
+    def test_nested_collection
+      res = Resource.new :agent,
+        :users  => [{:id => 1, :_links => {:self => {:href => '/users/1'}}}],
+        :_links => {:self => {:href => '/'}}
+
+      assert_equal '/', res.rels[:self].href
+      assert_kind_of Array, res.users
+
+      assert user = res.users.first
+      assert_kind_of Resource, user
+      assert_equal 1, user.id
+      assert_equal '/users/1', user.rels[:self].href
+    end
+
+    def test_attribute_predicates
+      res = Resource.new :agent, :a => 1, :b => true, :c => nil, :d => false
+
+      assert  res.a?
+      assert  res.b?
+      assert !res.c?
+      assert !res.d?
+    end
+
+    def test_attribute_setter
+      res = Resource.new :agent, :a => 1
+      assert_equal 1, res.a
+      assert !res.key?(:b)
+
+      res.b = 2
+      assert_equal 2, res.b
+      assert res.key?(:b)
+    end
+
+    def test_dynamic_attribute_methods_from_getter
+      res = Resource.new :agent, :a => 1
+      assert  res.key?(:a)
+      assert !res.respond_to?(:a)
+      assert !res.respond_to?(:a=)
+
+      assert_equal 1, res.a
+      assert res.respond_to?(:a)
+      assert res.respond_to?(:a=)
+    end
+
+    def test_dynamic_attribute_methods_from_setter
+      res = Resource.new :agent, :a => 1
+      assert !res.key?(:b)
+      assert !res.respond_to?(:b)
+      assert !res.respond_to?(:b=)
+
+      res.b = 1
+      assert res.key?(:b)
+      assert res.respond_to?(:b)
+      assert res.respond_to?(:b=)
+    end
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,54 @@
+require File.expand_path("../helper", __FILE__)
+
+module Sawyer
+  class ResponseTest < TestCase
+    def setup
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @agent = Sawyer::Agent.new "http://foo.com" do |conn|
+        conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+        conn.adapter :test, @stubs do |stub|
+          stub.get '/' do
+            [200, {'Content-Type' => 'application/json'}, Yajl.dump(
+              :a => 1,
+              :_links => {
+                :self => {:href => '/a', :method => 'POST'}
+              }
+            )]
+          end
+        end
+      end
+      
+      @res = @agent.start
+      assert_kind_of Sawyer::Response, @res
+    end
+
+    def test_gets_status
+      assert_equal 200, @res.status
+    end
+
+    def test_gets_headers
+      assert_equal 'application/json', @res.headers['content-type']
+    end
+
+    def test_gets_body
+      assert_equal 1, @res.data.a
+      assert_equal [:a], @res.data.fields.to_a
+    end
+
+    def test_gets_rels
+      assert_equal '/a',  @res.data.rels[:self].href
+      assert_equal :post, @res.data.rels[:self].method
+    end
+
+    def test_makes_request_from_relation
+      @stubs.post '/a' do
+        [201, {}, ""]
+      end
+
+      res = @res.data.rels[:self].call
+      assert_equal 201, res.status
+      assert_nil res.data
+    end
+  end
+end
+