sawyer 0.0.4 → 0.0.7

data/Rakefile

@@ -1,47 +1,5 @@
 require 'rubygems'
 require 'rake'
-require 'date'
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
 
 task :default => :test
 
@@ -52,84 +10,3 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc "Validate #{gemspec_file}"
-task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
-  unless libfiles.empty?
-    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
-    exit!
-  end
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end
-

data/lib/sawyer.rb

@@ -1,5 +1,5 @@
 module Sawyer
-  VERSION = "0.0.4"
+  VERSION = "0.0.7"
 
   class Error < StandardError; end
 end
@@ -12,4 +12,5 @@ require 'set'
   response
   serializer
   agent
+  hal_rels_parser
 ).each { |f| require File.expand_path("../sawyer/#{f}", __FILE__) }

data/lib/sawyer/agent.rb

@@ -5,6 +5,9 @@ module Sawyer
   class Agent
     NO_BODY = Set.new([:get, :head])
 
+    attr_accessor :links_parser
+    attr_accessor :allow_undefined_methods
+
     class << self
       attr_writer :serializer
     end
@@ -33,8 +36,11 @@ module Sawyer
     # Yields the Faraday::Connection if a block is given.
     def initialize(endpoint, options = nil)
       @endpoint = endpoint
-      @conn = (options && options[:faraday]) || Faraday.new(endpoint)
+      @conn = (options && options[:faraday]) || Faraday.new
       @serializer = (options && options[:serializer]) || self.class.serializer
+      @links_parser = (options && options[:links_parser]) || HalLinksParser.new
+      @allow_undefined_methods = (options && options[:allow_undefined_methods])
+      @conn.url_prefix = @endpoint
       yield @conn if block_given?
     end
 
@@ -42,7 +48,7 @@ module Sawyer
     #
     # Returns a Sawyer::Relation::Map.
     def rels
-      @rels ||= root.data.rels
+      @rels ||= root.data._rels
     end
 
     # Public: Retains a reference to the root response of the API.
@@ -115,12 +121,20 @@ module Sawyer
       @serializer.decode(str)
     end
 
+    def parse_links(data)
+      @links_parser.parse(data)
+    end
+
     def expand_url(url, options = nil)
       tpl = url.respond_to?(:expand) ? url : URITemplate.new(url.to_s)
       expand = tpl.method(:expand)
       options ? expand.call(options) : expand.call
     end
 
+    def allow_undefined_methods?
+      !!@allow_undefined_methods
+    end
+
     def inspect
       %(<#{self.class} #{@endpoint}>)
     end

data/lib/sawyer/hal_rels_parser.rb

@@ -0,0 +1,13 @@
+module Sawyer
+
+  class HalLinksParser
+
+    def parse(data)
+      links = data.delete(:_links)
+
+      return data, links
+    end
+
+  end
+
+end

data/lib/sawyer/relation.rb

@@ -13,7 +13,7 @@ module Sawyer
       #
       # Returns nothing.
       def <<(rel)
-        @map[rel.name] = rel
+        @map[rel.name] = rel if rel
       end
 
       # Gets the raw Relation by its name.
@@ -82,7 +82,12 @@ module Sawyer
     #
     # Returns a Relation.
     def self.from_link(agent, name, options)
-      new agent, name, options[:href], options[:method]
+      case options
+      when Hash
+        new agent, name, options[:href], options[:method]
+      when String
+        new agent, name, options
+      end
     end
 
     # A Relation represents an available next action for a resource.
@@ -94,7 +99,11 @@ module Sawyer
     def initialize(agent, name, href, method = nil)
       @agent = agent
       @name = name.to_sym
-      @href_template = URITemplate.new(href.to_s)
+      @href = href
+      begin
+        @href_template = URITemplate.new(href.to_s)
+      rescue URITemplate::RFC6570::Invalid => e
+      end
 
       methods = nil
 
@@ -225,6 +234,7 @@ module Sawyer
     end
 
     def href(options = nil)
+      return @href if @href_template.nil?
       method = @href_template.method(:expand)
       options ? method.call(options) : method.call
     end
@@ -243,7 +253,7 @@ module Sawyer
     # Returns a Sawyer::Response.
     def call(data = nil, options = nil)
       m = options && options[:method]
-      if m && !@available_methods.include?(m == :head ? :get : m)
+      if m && !@agent.allow_undefined_methods? && !@available_methods.include?(m == :head ? :get : m)
         raise ArgumentError, "method #{m.inspect} is not available: #{@available_methods.to_a.inspect}"
       end
 

data/lib/sawyer/resource.rb

@@ -1,20 +1,26 @@
 module Sawyer
   class Resource
-    SPECIAL_METHODS = Set.new %w(agent rels fields)
+    SPECIAL_METHODS = Set.new(%w(agent rels fields))
     attr_reader :_agent, :_rels, :_fields
+    attr_reader :attrs
+    alias to_hash attrs
 
     # Initializes a Resource with the given data.
     #
     # agent - The Sawyer::Agent that made the API request.
     # data  - Hash of key/value properties.
-    def initialize(agent, data)
+    def initialize(agent, data = {})
       @_agent  = agent
-      @_rels   = Relation.from_links(agent, data.delete(:_links))
-      @_fields = Set.new []
+      data, links = agent.parse_links(data)
+      @_rels = Relation.from_links(agent, links)
+      @_fields = Set.new
+      @_metaclass = (class << self; self; end)
+      @attrs = {}
       data.each do |key, value|
         @_fields << key
-        instance_variable_set "@#{key}", process_value(value)
+        @attrs[key.to_sym] = process_value(value) 
       end
+      @_metaclass.send(:attr_accessor, *data.keys)
     end
 
     # Processes an individual value of this resource.  Hashes get exploded
@@ -40,6 +46,29 @@ module Sawyer
       @_fields.include? key
     end
 
+    # Allow fields to be retrieved via Hash notation
+    #
+    # method - key name
+    #
+    # Returns the value from attrs if exists
+    def [](method)
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+    # Allow fields to be set via Hash notation
+    #
+    # method - key name
+    # value - value to set for the attr key
+    #
+    # Returns - value
+    def []=(method, value)
+      send("#{method}=", value)
+    rescue NoMethodError
+      nil
+    end
+
     ATTR_SETTER    = '='.freeze
     ATTR_PREDICATE = '?'.freeze
 
@@ -47,14 +76,14 @@ module Sawyer
     def method_missing(method, *args)
       attr_name, suffix = method.to_s.scan(/([a-z0-9\_]+)(\?|\=)?$/i).first
       if suffix == ATTR_SETTER
-        (class << self; self; end).send :attr_accessor, attr_name
+        @_metaclass.send(:attr_accessor, attr_name)
         @_fields << attr_name.to_sym
-        instance_variable_set "@#{attr_name}", args.first
-      elsif @_fields.include?(attr_name.to_sym)
-        value = instance_variable_get("@#{attr_name}")
+        send(method, args.first)
+      elsif attr_name && @_fields.include?(attr_name.to_sym)
+        value = @attrs[attr_name.to_sym]
         case suffix
         when nil
-          (class << self; self; end).send :attr_accessor, attr_name
+          @_metaclass.send(:attr_accessor, attr_name)
           value
         when ATTR_PREDICATE then !!value
         end
@@ -64,6 +93,25 @@ module Sawyer
         super
       end
     end
+
+    # Wire up accessor methods to pull from attrs
+    def self.attr_accessor(*attrs)
+      attrs.each do |attribute|
+        class_eval do
+          define_method attribute do
+            @attrs[attribute.to_sym]
+          end
+
+          define_method "#{attribute}=" do |value|
+            @attrs[attribute.to_sym] = value
+          end
+
+          define_method "#{attribute}?" do
+            !!@attrs[attribute.to_sym]
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/sawyer/response.rb

@@ -29,8 +29,7 @@ module Sawyer
       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"
+      else data
       end
     end
 

data/lib/sawyer/serializer.rb

@@ -49,6 +49,8 @@ module Sawyer
       @dump.call(encode_object(data))
     end
 
+    alias dump encode
+
     # Public: Decodes a String into an Object (usually a Hash or Array of
     # Hashes).
     #
@@ -60,10 +62,12 @@ module Sawyer
       decode_object(@load.call(data))
     end
 
+    alias load decode
+
     def encode_object(data)
       case data
       when Hash then encode_hash(data)
-      when Array then data.map { |o| encode_object(data) }
+      when Array then data.map { |o| encode_object(o) }
       else data
       end
     end
@@ -73,6 +77,7 @@ module Sawyer
         case value = hash[key]
         when Date then hash[key] = value.to_time.utc.xmlschema
         when Time then hash[key] = value.utc.xmlschema
+        when Hash then hash[key] = encode_hash(value)
         end
       end
       hash
@@ -81,7 +86,7 @@ module Sawyer
     def decode_object(data)
       case data
       when Hash then decode_hash(data)
-      when Array then data.map { |o| decode_object(data) }
+      when Array then data.map { |o| decode_object(o) }
       else data
       end
     end
@@ -94,13 +99,19 @@ module Sawyer
     end
 
     def decode_hash_value(key, value)
-      if key =~ /^_(at|on)$/
+      if time_field?(key, value)
         Time.parse(value)
       elsif value.is_a?(Hash)
         decode_hash(value)
+      elsif value.is_a?(Array)
+        value.map { |o| decode_hash_value(key, o) }
       else
         value
       end
     end
+
+    def time_field?(key, value)
+      value && key =~ /_(at|on)$/
+    end
   end
 end

data/sawyer.gemspec

@@ -1,78 +1,33 @@
-## 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'
+lib = "sawyer"
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
 
-  ## 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.4'
-  s.date              = '2012-09-27'
-  s.rubyforge_project = 'sawyer'
+Gem::Specification.new do |spec|
+  spec.specification_version = 2 if spec.respond_to? :specification_version=
+  spec.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if spec.respond_to? :required_rubygems_version=
 
-  ## 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"
+  spec.name    = lib
+  spec.version = version
 
-  ## 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'
+  spec.summary = "Secret User Agent of HTTP"
 
-  ## 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]
+  spec.authors  = ["Rick Olson"]
+  spec.email    = 'technoweenie@gmail.com'
+  spec.homepage = 'https://github.com/lostisland/sawyer'
+  spec.licenses = ['MIT']
 
-  ## 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'])
+  spec.add_dependency 'faraday',      ['~> 0.8.4']
+  spec.add_dependency 'uri_template', ['~> 0.5.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"])
+  spec.files = %w(Gemfile LICENSE.md README.md Rakefile)
+  spec.files << "#{lib}.gemspec"
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("test/**/*.rb")
+  spec.files += Dir.glob("script/*")
 
-  ## 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
-    lib/sawyer/serializer.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/ }
+  dev_null    = File.exist?('/dev/null') ? '/dev/null' : 'NUL'
+  git_files   = `git ls-files -z 2>#{dev_null}`
+  spec.files &= git_files.split("\0") if $?.success?
 end
 

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Usage: script/console
+# Starts an IRB console with this library loaded.
+
+gemspec="$(ls *.gemspec | head -1)"
+
+exec bundle exec irb -r "${gemspec%.*}"
+

data/script/package

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Usage: script/gem
+# Updates the gemspec and builds a new gem in the pkg directory.
+
+mkdir -p pkg
+gem build *.gemspec
+mv *.gem pkg
+

data/script/release

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+# Usage: script/release
+# Build the package, tag a commit, push it to origin, and then release the
+# package publicly.
+
+set -e
+
+version="$(script/package | grep Version: | awk '{print $2}')"
+[ -n "$version" ] || exit 1
+
+git commit --allow-empty -a -m "Release $version"
+git tag "v$version"
+git push origin
+git push origin "v$version"
+git push legacy
+git push legacy "v$version"
+gem push pkg/*-${version}.gem
+

data/script/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+# Usage: script/test
+# Runs the library's test suite.
+
+bundle exec rake test

data/test/agent_test.rb

@@ -2,6 +2,16 @@ require File.expand_path("../helper", __FILE__)
 
 module Sawyer
   class AgentTest < TestCase
+
+    class InlineRelsParser
+      def parse(data)
+        links = {}
+        data.keys.select {|k| k[/_url$/] }.each {|k| links[k.to_s.gsub(/_url$/, '')] = data.delete(k) }
+
+        return data, links
+      end
+    end
+
     def setup
       @stubs = Faraday::Adapter::Test::Stubs.new
       @agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
@@ -25,6 +35,31 @@ module Sawyer
       assert_equal :get,     @agent.rels[:users].method
     end
 
+    def test_allows_custom_rel_parsing
+      @stubs.get '/a/' do |env|
+        assert_equal 'foo.com', env[:url].host
+
+        [200, {}, Sawyer::Agent.encode(
+          :url => '/',
+          :users_url => '/users',
+          :repos_url => '/repos')]
+      end
+
+      agent = Sawyer::Agent.new "http://foo.com/a/" do |conn|
+        conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
+        conn.adapter :test, @stubs
+      end
+      agent.links_parser = InlineRelsParser.new
+
+      assert_equal 200, agent.root.status
+
+      assert_equal '/users', agent.rels[:users].href
+      assert_equal :get,     agent.rels[:users].method
+      assert_equal '/repos', agent.rels[:repos].href
+      assert_equal :get,     agent.rels[:repos].method
+
+    end
+
     def test_saves_root_endpoint
       @stubs.get '/a/' do |env|
         [200, {}, '{}']
@@ -79,6 +114,26 @@ module Sawyer
         :query   => {:foo => 'bar'}
       assert_equal 200, res.status
     end
+
+    def test_encodes_and_decodes_times
+      time = Time.at(Time.now.to_i)
+      data = {:a => 1, :b => true, :c => 'c', :created_at => time, :published_at => nil}
+      data = [data.merge(:foo => [data])]
+      encoded = Sawyer::Agent.encode(data)
+      decoded = Sawyer::Agent.decode(encoded)
+
+      2.times do
+        assert_equal 1, decoded.size
+        decoded = decoded.shift
+
+        assert_equal 1, decoded[:a]
+        assert_equal true, decoded[:b]
+        assert_equal 'c', decoded[:c]
+        assert_equal time, decoded[:created_at]
+        assert_nil decoded[:published_at]
+        decoded = decoded[:foo]
+      end
+    end
   end
 end
 

data/test/relation_test.rb

@@ -28,6 +28,23 @@ module Sawyer
       assert_kind_of URITemplate, rel.href_template
     end
 
+    def test_builds_rels_from_hash
+      index = {
+        'self' => '/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
+      assert_kind_of URITemplate, rel.href_template
+    end
+
     def test_builds_rels_from_hash_index
       index = {
         'self' => {:href => '/users/1'}
@@ -109,6 +126,41 @@ module Sawyer
       assert_equal 404, rel.get.status
       assert_equal 200, rel.get(:uri => {'user' => 'octocat', 'repo' => 'hello', 'a' => 1, 'b' => 2}).status
     end
+
+    def test_handles_invalid_uri
+      hash = {:href => '/this has spaces', :method => 'post'}
+      rel  = Sawyer::Relation.from_link(nil, :self, hash)
+
+      assert_equal :self,      rel.name
+      assert_equal '/this has spaces', rel.href
+    end
+
+    def test_allows_all_methods_when_not_in_strict_mode
+
+      agent = Sawyer::Agent.new "http://foo.com/a/", :allow_undefined_methods => true 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
+          stubs.post '/a/1' do
+            [200, {}, '{}']
+          end
+          stubs.put '/a/1' do
+            [204, {}, '{}']
+          end
+        end
+      end
+
+      rel = Sawyer::Relation.new agent, :self, "/a/1"
+      assert_equal 200, rel.get.status
+      assert_equal 200, rel.post.status
+      assert_equal 204, rel.put.status
+      assert_equal 204, rel.delete.status
+    end
   end
 end
 

data/test/resource_test.rb

@@ -2,19 +2,28 @@ require File.expand_path("../helper", __FILE__)
 
 module Sawyer
   class ResourceTest < 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_accessible_keys
-      res = Resource.new :agent, :a => 1,
+      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 @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,
+      res = Resource.new @agent, :agent => 1, :rels => 2, :fields => 3,
         :_links => {:self => {:href => '/'}}
 
       assert_equal 1, res.agent
@@ -22,7 +31,7 @@ module Sawyer
       assert_equal 3, res.fields
 
       assert res._rels[:self]
-      assert_equal :agent, res._agent
+      assert_equal @agent, res._agent
       assert_equal 3, res._fields.size
       [:agent, :rels, :fields].each do |f|
         assert res._fields.include?(f)
@@ -30,7 +39,7 @@ module Sawyer
     end
 
     def test_nested_object
-      res = Resource.new :agent,
+      res = Resource.new @agent,
         :user   => {:id => 1, :_links => {:self => {:href => '/users/1'}}},
         :_links => {:self => {:href => '/'}}
 
@@ -41,7 +50,7 @@ module Sawyer
     end
 
     def test_nested_collection
-      res = Resource.new :agent,
+      res = Resource.new @agent,
         :users  => [{:id => 1, :_links => {:self => {:href => '/users/1'}}}],
         :_links => {:self => {:href => '/'}}
 
@@ -55,7 +64,7 @@ module Sawyer
     end
 
     def test_attribute_predicates
-      res = Resource.new :agent, :a => 1, :b => true, :c => nil, :d => false
+      res = Resource.new @agent, :a => 1, :b => true, :c => nil, :d => false
 
       assert  res.a?
       assert  res.b?
@@ -64,7 +73,7 @@ module Sawyer
     end
 
     def test_attribute_setter
-      res = Resource.new :agent, :a => 1
+      res = Resource.new @agent, :a => 1
       assert_equal 1, res.a
       assert !res.key?(:b)
 
@@ -74,10 +83,10 @@ module Sawyer
     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=)
+      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)
@@ -85,7 +94,7 @@ module Sawyer
     end
 
     def test_dynamic_attribute_methods_from_setter
-      res = Resource.new :agent, :a => 1
+      res = Resource.new @agent, :a => 1
       assert !res.key?(:b)
       assert !res.respond_to?(:b)
       assert !res.respond_to?(:b=)
@@ -95,5 +104,19 @@ module Sawyer
       assert res.respond_to?(:b)
       assert res.respond_to?(:b=)
     end
+
+    def test_attrs
+      res = Resource.new @agent, :a => 1
+      hash = {:a => 1 }
+      assert_equal hash, res.attrs
+    end
+
+    def test_handle_hash_notation_with_string_key
+      res = Resource.new @agent, :a => 1
+      assert_equal 1, res['a']
+
+      res[:b] = 2
+      assert_equal 2, res.b
+    end
   end
 end

data/test/response_test.rb

@@ -16,6 +16,11 @@ module Sawyer
               }
             )]
           end
+
+          stub.get '/emails' do
+            emails = %w(rick@example.com technoweenie@example.com)
+            [200, {'Content-Type' => 'application/json'}, Sawyer::Agent.encode(emails)]
+          end
         end
       end
 
@@ -55,6 +60,11 @@ module Sawyer
       assert_equal 201, res.status
       assert_nil res.data
     end
+
+    def test_handles_arrays_of_strings
+      res = @agent.call(:get, '/emails')
+      assert_equal 'rick@example.com', res.data.first
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sawyer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -43,7 +43,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
-description: Secret User Agent of HTTP built on Faraday
+description: 
 email: technoweenie@gmail.com
 executables: []
 extensions: []
@@ -53,25 +53,26 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- SPEC.md
-- example/client.rb
-- example/nigiri.schema.json
-- example/server.rb
-- example/user.schema.json
-- lib/sawyer.rb
+- sawyer.gemspec
 - lib/sawyer/agent.rb
+- lib/sawyer/hal_rels_parser.rb
 - lib/sawyer/relation.rb
 - lib/sawyer/resource.rb
 - lib/sawyer/response.rb
 - lib/sawyer/serializer.rb
-- sawyer.gemspec
+- lib/sawyer.rb
 - test/agent_test.rb
 - test/helper.rb
 - test/relation_test.rb
 - test/resource_test.rb
 - test/response_test.rb
-homepage: https://github.com/technoweenie/sawyer
-licenses: []
+- script/console
+- script/package
+- script/release
+- script/test
+homepage: https://github.com/lostisland/sawyer
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -82,23 +83,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3466190819871303014
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.5
 requirements: []
-rubyforge_project: sawyer
+rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: Secret User Agent of HTTP
-test_files:
-- test/agent_test.rb
-- test/relation_test.rb
-- test/resource_test.rb
-- test/response_test.rb
+test_files: []
+has_rdoc: 

data/SPEC.md

@@ -1,71 +0,0 @@
-# Sawyer
-
-To use Sawyer, create a new Agent with a URL endpoint.
-
-```ruby
-endpoint = "http://my-api.com"
-agent    = Sawyer::Agent.new endpoint do |conn|
-  conn.headers['content-type'] = 'application/vnd.my-api+json'
-end
-```
-
-From here, we can access the root to get the initial actions.
-
-```ruby
-root = agent.start
-```
-
-Every request in Sawyer returns a Sawyer::Response.  It's very similar
-to a raw Faraday::Response, with a few extra methods.
-
-```ruby
-# HTTP Headers
-root.headers
-
-# HTTP status
-root.status
-
-# The JSON Schema
-root.schema
-
-# The link relations
-root.rels
-
-# The contents (probably empty from the root)
-root.data
-```
-
-Now, we can access a relation off the root resource.
-
-```ruby
-resource = root.data
-res = resource.rels[:users].call :query => {:sort => 'login'}
-
-# An array of users
-users = res.data
-```
-
-This call returns two types of relations: relations on the collection of
-users, and relations on each user.  You can access the collection
-resources from the response.
-
-```ruby
-# get the next page of users
-res2 = res.rels[:next].call
-
-# page 2 of the users collection
-res2.data
-```
-
-Each user has it's own relations too:
-
-```ruby
-# favorite the previous user
-users.each_with_index do |user, index|
-  res = user.rels[:favorite].call users[index-1]
-  if !res.success?
-    puts "#{user.name} could not favorite #{users[index-1].name}"
-  end
-end
-```
-

data/example/client.rb

@@ -1,50 +0,0 @@
-require File.expand_path("../../lib/sawyer", __FILE__)
-require 'faraday'
-require 'pp'
-
-endpoint = "http://localhost:9393/"
-agent    = Sawyer::Agent.new(endpoint) do |http|
-  http.headers['content-type'] = 'application/json'
-end
-puts agent.inspect
-puts
-
-root = agent.start
-puts root.inspect
-
-puts "LISTING USERS"
-users_rel = root.data.rels[:users]
-
-puts users_rel.inspect
-puts
-
-users_res = users_rel.get
-puts users_res.inspect
-
-users = users_res.data
-
-users.each do |user|
-  puts "#{user.login} favorites:"
-
-  fav_res = user.rels[:favorites].get
-
-  fav_res.data.each do |sushi|
-    puts "- #{sushi.inspect})"
-  end
-  puts
-end
-
-puts "CREATING USER"
-create_user_rel = root.data.rels[:users]
-
-puts create_user_rel.inspect
-
-created = create_user_rel.post(:login => 'booya')
-puts created.inspect
-puts
-
-puts "ADD A FAVORITE"
-created_user = created.data
-create_fav_res = created_user.rels[:favorites].post nil, :query => {:id => 1}
-puts create_fav_res.inspect
-

data/example/nigiri.schema.json

@@ -1,47 +0,0 @@
-{
-  "type": "object",
-  "relations": [
-    {"rel": "all", "href": "/nigiri"}
-  ],
-  "properties": {
-    "id": {
-      "type": "integer",
-      "minimum": 1,
-      "readonly": true
-    },
-    "name": {
-      "type": "string"
-    },
-    "fish": {
-      "type": "string"
-    },
-    "_links": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "rel": {
-            "type": "string"
-          },
-          "href": {
-            "type": "string",
-            "optional": true
-          },
-          "method": {
-            "type": "string",
-            "default": "get"
-          },
-          "schema": {
-            "type": "string",
-            "optional": true
-          }
-        },
-        "additionalProperties": false
-      },
-      "additionalProperties": false,
-      "readonly": true
-    }
-  }
-}
-
-

data/example/server.rb

@@ -1,114 +0,0 @@
-require 'sinatra'
-require 'yajl'
-
-get '/' do
-  app_type
-
-  Yajl.dump({
-    :_links => {
-      :users  => {:href => "/users", :method => 'get,post'},
-      :nigiri => {:href => "/nigiri"}
-    }
-  }, :pretty => true)
-end
-
-def app_type
-  content_type "application/vnd.sushihub+json"
-end
-
-users = [
-  {:id => 1, :login => 'sawyer',  :created_at => Time.utc(2004, 9, 22),
-   :_links => {
-     :self               => {:href => '/users/sawyer'},
-     :favorites          => {:href => '/users/sawyer/favorites', :method => 'get,post'}
-   }},
-  {:id => 2, :login => 'faraday', :created_at => Time.utc(2004, 12, 22),
-   :_links => {
-     :self               => {:href => '/users/faraday'},
-     :favorites          => {:href => '/users/faraday/favorites', :method => 'get,post'}
-   }}
-]
-
-nigiri = [
-  {:id => 1, :name => 'sake',  :fish => 'salmon',
-   :_links => {
-     :self => {:href => '/nigiri/sake'}
-   }},
-  {:id => 2, :name => 'unagi', :fish => 'eel',
-   :_links => {
-     :self => {:href => '/nigiri/unagi'}
-   }}
-]
-
-get '/users' do
-  app_type
-
-  Yajl.dump users, :pretty => true
-end
-
-new_users = {}
-post '/users' do
-  if env['CONTENT_TYPE'].to_s !~ /json/i
-    halt 400, "Needs JSON"
-  end
-
-  app_type
-
-  hash = Yajl.load request.body.read, :symbolize_keys => true
-  new_users[hash[:login]] = hash
-  
-  headers "Location" => "/users/#{hash[:login]}"
-  status 201
-  Yajl.dump hash.update(
-    :id => 3,
-    :created_at => Time.now.utc.xmlschema,
-    :_links => {
-      :self              => {:href => "/users/#{hash[:login]}"},
-      :favorites         => {:href => "/users/#{hash[:login]}/favorites", :method => 'get,post'}
-    }
-  ), :pretty => true
-end
-
-get '/users/:login' do
-  headers 'Content-Type' => app_type
-  if hash = users.detect { |u| u[:login] == params[:login] }
-    Yajl.dump hash, :pretty => true
-  else
-    halt 404
-  end
-end
-
-get '/users/:login/favorites' do
-  app_type
-
-  case params[:login]
-  when users[0][:login] then Yajl.dump([nigiri[0]], :pretty => true)
-  when users[1][:login] then Yajl.dump([], :pretty => true)
-  else halt 404
-  end
-end
-
-post '/users/:login/favorites' do
-  if params[:id].to_i > 0
-    halt 201
-  else
-    halt 422
-  end
-end
-
-get '/nigiri' do
-  app_type
-
-  Yajl.dump nigiri, :pretty => true
-end
-
-get '/nigiri/:name' do
-  app_type
-
-  if hash = nigiri.detect { |n| n[:name] == params[:name] }
-    Yajl.dump hash, :pretty => true
-  else
-    halt(404)
-  end
-end
-

data/example/user.schema.json

@@ -1,51 +0,0 @@
-{
-  "type": "object",
-  "relations": [
-    {"rel": "all", "href": "/users"},
-    {"rel": "create", "href": "/users", "method": "post"},
-    {"rel": "favorites", "schema": "/schema/nigiri"},
-    {"rel": "favorites/create", "method": "post"}
-  ],
-  "properties": {
-    "id": {
-      "type": "integer",
-      "minimum": 1,
-      "readonly": true
-    },
-    "login": {
-      "type": "string"
-    },
-    "created_at": {
-      "type": "string",
-      "pattern": "\\d{8}T\\d{6}Z",
-      "readonly": true
-    },
-    "_links": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "rel": {
-            "type": "string"
-          },
-          "href": {
-            "type": "string",
-            "optional": true
-          },
-          "method": {
-            "type": "string",
-            "default": "get"
-          },
-          "schema": {
-            "type": "string",
-            "optional": true
-          }
-        },
-        "additionalProperties": false
-      },
-      "additionalProperties": false,
-      "readonly": true
-    }
-  }
-}
-