haipa 0.0.2 → 0.0.3

data/README.md

@@ -18,7 +18,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Haipa.api creates a new Haipa::Api object. The initializer's parameters and block
+are passed straight through to Faraday's connection initializer so you have full
+access to all of Faraday's settings, including adapter and middlewares.
+
+At the moment the only additions Haipa makes to the Faraday default is to add
+the accepts header application/hal+json and the user agent header Haipa. This
+defaults are deep merged with the settings passed to the initializer so they can
+be overridden.
+
+Given a API root description
+
+    {
+      "_links" :
+      {
+        "self" :   { "href" : "/api/v1" },
+        "things" : { "href" : "/api/v1/things" }
+      }
+    }
+
+and a thing index resource
+
+    {
+      "_embedded" : {
+        "things" => [
+          {
+            "name" => "thing1",
+            "_links" : { "self" : { "href" : "/api/v1/things/thing1" } }
+          },
+          {
+            "name" => "thing2",
+            "_links" : { "self" : { "href" : "/api/v1/things/thing2" } }
+          }
+        ]
+      },
+      "_links" : {
+        "self" : { "href" : "/api/v1/things" }
+      }
+    }
+
+Then Haipa can consume this API with
+
+    api = Haipa.api(url:'http://localhost:3000/api/v1')
+    api.resource # the root as a Haipa::Resource
+    api.description # alias of api.resource
+    api.links # the root links as a Haipa::Links
+    api.href # the uri of the root
+    api.embedded # the embedded resource array Haipa::Embedded
+    api.resources # alias of api.embedded
+    api.to_hash # the api root as a hash
+
+    links = api.links
+    links.things # the things Haipa::Resource
+    links.to_hash # the links as a hash
+
+    things = links.things # things Haipa::Resource
+    things.links # the things index Haipa::Links
+    things.embedded # the things index Haipa::Embedded
+    things.to_hash # the things resource as a hash
+
+    embedded = things.embedded
+    embedded.things # array of Haipa::Resource
+    embedded.things.first # the first embedded thing Haipa::Resource
+    embedded.things.first.name # the first embedded thing Haipa::Resource name
+    embedded.things[1] # the second embedded thing Haipa::Resource
+    embedded.things.first.clear.other_attribute
+    embedded.to_hash # the embedded resources as a hash
 
 ## Contributing
 

data/haipa.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'faraday', '~> 0.8'
   spec.add_runtime_dependency 'hashie', '~> 2.0.0'
+  # spec.add_runtime_dependency 'uri_templates', '~> 0.2.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.13.0'

data/lib/haipa.rb

@@ -1,11 +1,13 @@
 require 'uri'
 require 'forwardable'
 require 'hashie'
+require 'faraday'
 
 require 'haipa/version'
 require 'haipa/api'
 require 'haipa/resource'
 require 'haipa/links'
+require 'haipa/embedded'
 
 module Haipa
   def self.api(params={})

data/lib/haipa/api.rb

@@ -3,13 +3,14 @@ module Haipa
     extend Forwardable
 
     attr_reader :conn, :resource, :uri
-    def_delegators :@conn, :get
-    def_delegators :@resource, :links, :embedded, :href
+    def_delegators :@conn, :get, :post, :put, :delete
+    def_delegators :@resource, :links, :embedded, :href, :resources, :to_hash
     alias :connection :conn
+    alias :description :resource
 
     def initialize(params={})
       @uri = URI(params[:url].to_s).path
-      @conn = Faraday.new(defaults.merge(params)) do |conn|
+      @conn = Faraday.new(defaults.deep_merge(params)) do |conn|
         yield conn if block_given?
       end
       @resource = Resource.new(self,'')
@@ -19,18 +20,16 @@ module Haipa
       {
         :headers =>
         {
-          :accept => 'application/hal+json',
-          :user_agent => 'Haipa'
+          'Accept' => 'application/hal+json',
+          'UserAgent' => 'Haipa',
+          'Content-Type' => 'application/hal+json'
         }
-      }
+      }.extend(Hashie::Extensions::DeepMerge)
     end
 
     def clear
-      @resource = nil
-    end
-
-    def description
-      resource.get
+      resource.clear
+      self
     end
   end
 end

data/lib/haipa/embedded.rb

@@ -0,0 +1,40 @@
+module Haipa
+  class Embedded
+    extend Forwardable
+
+    attr_reader :resource
+    def_delegators :@data, :empty?, :has_key?, :fetch
+
+    def initialize(resource, data)
+      @data = data
+      @resource = resource
+    end
+
+    def method_missing(name, *args, &block)
+      if @data.has_key?(name)
+        from_array(@data[name])
+      else
+        super
+      end
+    end
+
+    def to_hash
+      @data
+    end
+
+    private
+
+    def from_array(array_or_hash)
+      if array_or_hash.kind_of?(Array)
+        array_or_hash.map{ |e| from_hash(e) }
+      else
+        from_hash(array_or_hash)
+      end
+    end
+
+    def from_hash(hash)
+      uri = hash.fetch('_links',{}).fetch('self',{}).fetch('href',nil)
+      Resource.new(resource.api, uri, hash)
+    end
+  end
+end

data/lib/haipa/links.rb

@@ -2,17 +2,21 @@ module Haipa
   class Links
     extend Forwardable
 
-    attr_reader :links, :parent
-    def_delegators :@links, :empty?
+    attr_reader :resource
+    def_delegators :@data, :empty?, :has_key?
 
-    def initialize(parent, links)
-      @links = links
-      @parent = parent
+    def initialize(resource, data)
+      @data = data
+      @resource = resource
+    end
+
+    def to_hash
+      @data
     end
 
     def method_missing(name, *args, &block)
-      if links.has_key?(name)
-        Resource.new(parent.api, links[name][:href])
+      if @data.has_key?(name)
+        Resource.new(resource.api, @data[name]['href'])
       else
         super
       end

data/lib/haipa/resource.rb

@@ -2,30 +2,55 @@ module Haipa
   class Resource
     attr_reader :api, :uri
 
-    def initialize(api, uri)
+    def initialize(api, uri, data=nil)
       @api = api
       @uri = uri
-      clear
+      @data = ::Hashie::Mash.new(data) if data
+    end
+
+    def to_hash
+      get
     end
 
     def clear
-      @get = nil
+      @data = nil
+      self
     end
 
     def get
-      @get ||= ::Hashie::Mash.new(JSON.parse(api.get(uri).body))
+      return {} unless uri
+      @data ||= ::Hashie::Mash.new(JSON.parse(api.get(uri).body))
+    end
+
+    def post(params={})
+      api.post(uri, params) do |req|
+        yield req if block_given?
+      end
+    end
+
+    def put(params={})
+      api.put(uri, params) do |req|
+        yield req if block_given?
+      end
+    end
+
+    def delete(params={})
+      api.delete(uri, params) do |req|
+        yield req if block_given?
+      end
     end
 
     def embedded
-      get.fetch('_embedded', {})
+      @embedded ||= Embedded.new(self, get.fetch('_embedded', {}))
     end
+    alias :resources :embedded
 
     def links
-      Links.new(self, get.fetch('_links', {}))
+      @links ||= Links.new(self, get.fetch('_links', {}))
     end
 
     def href
-      (links.self || {}).fetch('href', nil)
+      (links.to_hash.self || {}).fetch('href', nil)
     end
   end
 end

data/lib/haipa/version.rb

@@ -1,3 +1,3 @@
 module Haipa
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/haipa/api_spec.rb

@@ -8,10 +8,10 @@ describe Haipa::Api do
       stub.get('/') { [200, {}, description.to_json] }
     end
   end
-  subject { Haipa.api { |builder| builder.adapter :test, stubs } }
+  subject { Haipa.api { |conn| conn.adapter :test, stubs } }
 
-  its(:description) { should eq(description) }
-  its(:links) { should eq(description['_links']) }
-  its(:embedded) { should eq(description['_embedded']) }
-  its(:href) { should eq(description['_links']['self']['href']) }
+  specify { subject.description.to_hash.should == description }
+  specify { subject.links.to_hash.should == description['_links'] }
+  specify { subject.embedded.to_hash.should == description['_embedded'] }
+  specify { subject.href.should == description['_links']['self']['href'] }
 end

data/spec/haipa/resource_spec.rb

@@ -3,13 +3,37 @@ require_relative '../spec_helper'
 describe Haipa::Resource do
   let(:uri) { '/api/v1' }
   let(:response) { double('response', body:body.to_json) }
-  let(:api) { double('api', relative_get:response) }
+  let(:api) { double('api', get:response) }
   subject { Haipa::Resource.new(api, uri) }
 
   context "with minimum response" do
     let(:body) { {'_embedded' => {}, '_links' => {'self' => {'href' => uri}}} }
     its(:embedded) { should be_empty }
+    its(:resources) { should be_empty }
     its(:links) { should_not be_empty }
     specify { subject.links.self.should be }
   end
+
+  context "with embedded resources" do
+    let(:body) do
+      {
+        '_embedded' => {
+          'things' => [{
+            'name'=>'thing',
+            '_links' => {'self' => {'href' => uri+'/things/1'}}
+          }],
+          'thing'=>{
+            'name'=>'thing',
+            '_links' => {'self' => {'href' => uri+'/things/1'}}
+          }
+        },
+        '_links' => {'self' => {'href' => uri}}
+      }
+    end
+    specify { subject.embedded.should_not be_empty }
+    specify { subject.resources.thing.should be_a Haipa::Resource }
+    specify { subject.resources.things.first.should be_a Haipa::Resource }
+    specify { subject.resources.thing.get.name.should be == 'thing' }
+    specify { subject.resources.things.first.get.name.should be == 'thing' }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haipa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -107,6 +107,7 @@ files:
 - haipa.gemspec
 - lib/haipa.rb
 - lib/haipa/api.rb
+- lib/haipa/embedded.rb
 - lib/haipa/links.rb
 - lib/haipa/resource.rb
 - lib/haipa/version.rb
@@ -129,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2396805276847003605
+      hash: -2840839347400538447
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2396805276847003605
+      hash: -2840839347400538447
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23