api_bee 0.1.7 → 0.1.8

data/Gemfile

@@ -5,5 +5,6 @@ gemspec
 
 group :test do
   gem 'rspec' # dev, test
+  gem 'rake'
 end
 

data/README.mkd

@@ -179,6 +179,43 @@ api.get('/products').first[:title]
 api.post('/products', :title => 'Foo', :price => 100.0)
 ```
 
+## Wrapping nodes
+You can wrap nodes in collections in your custom classes. If your adapter defines a `#wrap` method, it will be passed each single node in your data.
+
+```ruby
+class ProductWrapper
+  def initialize(node)
+    @node = node
+  end
+  
+  def name
+    @node[:name]
+  end
+end
+
+class MyCustomAdapter
+  
+  def get(*args)
+    # ...
+  end
+  
+  # Wrap product objects
+  def wrap(node, name)
+    if name =~ /product/
+      ProductWrapper.new node
+    else
+      node
+    end
+  end
+  
+end
+
+api = ApiBee.setup(MyCustomAdapter)
+
+object = api.get('/products').first #=> an instance of ProductWrapper
+
+object.name # => delegates to ApiBee::Node::Single#[]
+````
 ## finding a single resource
 
 There's a special get_one method that you can call on lists. It delegates to the adapter and it's useful for finding a single resource in the context of a paginated list.

data/examples/catalog.yml

@@ -6,26 +6,38 @@
       :title: P1
       :id: p1
       :price: 100
+      :category:
+        :name: music players
     -
       :title: P2
       :id: p2
       :price: 200 
+      :category:
+        :name: ijdeiwejdneidjn
     -
       :title: P3
       :id: p3
       :price: 300
+      :category:
+        :name: music players
     -
       :title: P4
       :id: p4
       :price: 400
+      :category:
+        :name: music players
     -
       :title: P5
       :id: p5
       :price: 500
+      :category:
+        :name: music players
     -
       :title: P6
       :id: p6
       :price: 600
+      :category:
+        :name: music players
       
 :collections:
   :total_entries: 2

data/examples/github_api.rb

@@ -9,10 +9,32 @@ require 'json'
 #
 class GithubAdapter
   
+  class Owner
+    def initialize(node)
+      @node = node
+    end
+    
+    def login
+      @node[:login]
+    end
+    
+    def public_repos
+      @node[:public_repos]
+    end
+  end
+  
   def self.config_api_bee(config)
     config.uri_property_name = :url
   end
   
+  def wrap(node, name)
+    if name =~ /owner/
+      Owner.new(node)
+    else
+      node
+    end
+  end
+  
   def initialize
     @url = URI.parse('https://api.github.com')
     @http = Net::HTTP.new(@url.host, @url.port)
@@ -33,6 +55,7 @@ class GithubAdapter
       results = JSON.parse response.body
       if results.is_a?(Array)
         # decorate returned array so it complies with APiBee's pagination params
+        # p results
         paginate results, options, path, response
       else
         results
@@ -113,4 +136,4 @@ one = repos.get_one('https://api.github.com/repos/ismasan/websockets_examples')
 
 # one[:owner][:public_repos] will trigger a new request to the resource URL because that property is not available in the excerpt
 #
-puts "An owner is #{one[:owner][:login]}, who has #{one[:owner][:public_repos]} public repos"
+puts "An owner is #{one[:owner].login}, who has #{one[:owner].public_repos} public repos"

data/examples/yaml_catalog.rb

@@ -2,9 +2,59 @@ $LOAD_PATH.unshift '../lib'
 require 'yaml'
 require 'api_bee'
 
-api = ApiBee.setup(:hash, YAML.load_file('./catalog.yml'))
+require 'api_bee/adapters/hash'
+
+class Product
+  def initialize(node)
+    @node = node
+  end
+  
+  def title
+    @node[:title]
+  end
+  
+  def [](key)
+    @node[key.to_sym]
+  end
+end
+
+class Collection < Product
+  def collection_title
+    [title, @node[:id]].join('_')
+  end
+end
+
+class Category < Product
+  def name
+    @node[:name]
+  end
+end
+
+class Adapter < ApiBee::Adapters::Hash
+  
+  def wrap(node, name)
+    puts "NAME is #{name}"
+    case name
+    when /products/
+      Product.new node
+    when /collections/
+      Collection.new node
+    when /categor/
+      Category.new node
+    else
+      node
+    end
+  end
+end
+
+api = ApiBee.setup(Adapter, YAML.load_file(File.dirname(__FILE__)+'/catalog.yml'))
 
 collections = api.get('/collections')
+p collections.first.class.name
+
+collections.each do |c|
+  puts c.collection_title
+end
 
 #p collections
 
@@ -18,10 +68,13 @@ p collection[:id]
 
 products = collection[:products]
 
+p products.first.class.name
+
 puts "First page"
 
 products.each do |p|
-  p p[:title]
+  p p.title
+  p p[:category].name
 end
 
 puts "Second page"

data/lib/api_bee/adapters/hash.rb

@@ -15,7 +15,7 @@ module ApiBee
       
       def get(href, opts = {})
         segments = parse_href(href)
-        segments.inject(data) do |mem,i|
+        segments.inject(deep_clone_of(data)) do |mem,i|
           case mem
           when ::Hash
             handle_hash_data mem, i, opts
@@ -33,6 +33,13 @@ module ApiBee
       
       protected
       
+      # We don't want to modify the in-memory version of base data, and Ruby's Object.dup makes shallow copies only
+      # This is not the most efficient method, but the Hash adapter is for tests only anyway.
+      #
+      def deep_clone_of(hash)
+        Marshal::load(Marshal.dump(hash))
+      end
+      
       def parse_href(href)
         href.gsub(/^\//, '').split('/')
       end

data/lib/api_bee/node.rb

@@ -28,13 +28,15 @@ module ApiBee
     #   node = Node.resolve(an_adapter, config_object, {:name => 'Ismael', :bday => '11/29/77'})
     #   # node is a Node::Single because it doesn't represent a paginated list
     #
-    def self.resolve(adapter, config, attrs, href = nil)
+    def self.resolve(adapter, config, attrs, attribute_name = nil)
       attrs = simbolized(attrs)
       keys = attrs.keys.map{|k| k.to_sym}
       if keys.include?(config.total_entries_property_name) && keys.include?(config.uri_property_name.to_sym) # is a paginator
-        List.new adapter, config, attrs, href
+        List.new adapter, config, attrs, attribute_name
       else
-        Single.new adapter, config, attrs, href
+        node = Single.new adapter, config, attrs, attribute_name
+        node = adapter.wrap(node, attribute_name) if adapter.respond_to?(:wrap)
+        node      
       end
     end
     
@@ -72,7 +74,7 @@ module ApiBee
     #
     def [](attribute_name)
       if value = @attributes[attribute_name]
-        resolve_values_to_nodes value
+        resolve_values_to_nodes value, attribute_name
       elsif has_more? # check whether there's more info in API
         load_more!
         self[attribute_name] # recurse once
@@ -85,18 +87,24 @@ module ApiBee
       @attributes[key.to_sym] = value
     end
     
+    def has_key?(key)
+      return true if @attributes.has_key? key
+      load_more! if has_more?
+      @attributes.has_key? key
+    end
+    
     protected
     
     def update_attributes(attrs)
       @attributes.merge!(attrs)
     end
     
-    def resolve_values_to_nodes(value)
+    def resolve_values_to_nodes(value, attribute_name)
       case value
       when ::Hash
-        Node.resolve @adapter, @config, value
+        Node.resolve @adapter, @config, value, attribute_name
       when ::Array
-        value.map {|v| resolve_values_to_nodes(v)} # recurse
+        value.map {|v| resolve_values_to_nodes(v, attribute_name)} # recurse
       else
         value
       end
@@ -228,7 +236,11 @@ module ApiBee
       protected
       
       def __entries
-        @entries ||= (self[@config.entries_property_name] || [])
+        @entries ||= begin
+          (@attributes[@config.entries_property_name] || []).map do |entry|
+            resolve_values_to_nodes entry, @href
+          end
+        end
       end
 
     end

data/lib/api_bee/version.rb

@@ -1,3 +1,3 @@
 module ApiBee
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/hash_adapter_spec.rb

@@ -95,6 +95,7 @@ describe ApiBee::Adapters::Hash do
     end
     
     describe 'paginating' do
+      # Paginating twice in same case to make sure data is not being omdified
       it 'should paginate paginated collections' do
         products = @adapter.get('/collections/catalog/products', :page => 2, :per_page => 2)
         products[:page].should == 2
@@ -103,6 +104,13 @@ describe ApiBee::Adapters::Hash do
         products[:entries].size.should == 2
         products[:entries][0][:title].should == 'Foo 3'
         products[:entries][1][:title].should == 'Foo 4'
+
+        products = @adapter.get('/collections/catalog/products', :page => 3, :per_page => 2)
+        products[:page].should == 3
+        products[:total_entries].should == 5
+        products[:per_page].should == 2
+        products[:entries].size.should == 1
+        products[:entries][0][:title].should == 'Foo 5'
       end
       
       it 'should paginate last page correctly' do

data/spec/node_spec.rb

@@ -117,17 +117,40 @@ describe ApiBee do
     end
   end
   
-  describe '#[]=' do
+  context 'hash methods' do
     
     before do
       @adapter = mock('Adapter')
       @config = ApiBee.new_config
+      @node = ApiBee::Node.resolve(@adapter, @config, {:title => 'Blah', :href => '/products/1', :empty_field => nil})
     end
     
-    it 'should set attributes in nodes' do
-      node = ApiBee::Node.resolve(@adapter, @config, {:title => 'Blah', :total_entries => 4, :href => '/products'})    
-      node[:foo] = 11
-      node[:foo].should == 11
+    describe '#[]=' do
+      it 'should set attributes in nodes' do 
+        @node[:foo] = 11
+        @node[:foo].should == 11
+      end
+    end
+    
+    describe '#has_key?' do
+      it 'should delegate to local attributes' do
+        @adapter.should_not_receive(:get)
+        @node.has_key?(:title).should be_true
+      end
+      
+      it 'should fetch from :href if available' do
+        @adapter.should_receive(:get).with('/products/1').and_return(:age => 2)
+        @node.has_key?(:age).should be_true
+      end
+      
+      it 'should return true for nil value' do
+        @node.has_key?(:empty_field).should be_true
+      end
+      
+      it 'should return false for missing keys' do
+        @adapter.should_receive(:get).with('/products/1').and_return(:age => 2)
+        @node.has_key?(:missing_field).should be_false
+      end
     end
   end
   

data/spec/wrapper_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe ApiBee do
+  
+  before do
+    
+    class BookWrapper
+      attr_accessor :node
+      def initialize(node)
+        @node = node
+      end
+      
+      def title_and_isbn
+        [@node[:title], @node[:isbn]].join ' '
+      end
+      
+      def author
+        @node[:author]
+      end
+      
+      def genre
+        @node[:genre]
+      end
+    end
+    
+    class AuthorWrapper < BookWrapper
+      def name
+        @node[:name]
+      end
+    end
+    
+    @adapter = Class.new do
+      
+      def get(*args)
+        # will be mocked
+      end
+      
+      def wrap(node, name)
+        case name
+        when /book/
+          BookWrapper.new node
+        when /author/
+          AuthorWrapper.new node
+        else
+          node
+        end
+      end
+    end
+    
+    @data = {
+      :total_entries    => 5,
+      :page             => 1,
+      :per_page         => 2,
+      :href             => '/books',
+      :entries          => [
+        {
+          :title    => 'Heart of Darkness',
+          :isbn     => 123,
+          :author   => {
+            :name => 'J Conrad'
+          },
+          :genre => {
+            :name => 'fiction'
+          }
+        },
+        {
+          :title    => 'Rayuela',
+          :isbn     => 124,
+          :author   => {
+            :name => 'Julio Cortazar'
+          },
+          :genre => {
+            :name => 'fiction'
+          }
+        }
+      ]
+    }
+    
+    @adapter_instance = @adapter.new
+    
+    @adapter.stub!(:new).and_return @adapter_instance
+    
+    @adapter_instance.stub!(:get).with('/books', {}).and_return @data
+    
+    @adapter_instance.stub!(:get).with('/books/123', {}).and_return @data[:entries].first
+    
+    @api = ApiBee.setup(@adapter)
+  end
+  
+  it 'should return a proxy' do
+    @api.get('/books').should be_kind_of(ApiBee::Proxy)
+  end
+  
+  context 'iterating' do
+    it 'should wrap first level nodes' do
+      @api.get('/books').map do |book|
+        book.class
+      end.should == [BookWrapper, BookWrapper]
+    end
+    
+    it 'should initialize wrappers with node as argument' do
+      @api.get('/books').map do |book|
+        book.title_and_isbn
+      end.should == ["Heart of Darkness 123", "Rayuela 124"]
+    end
+    
+    it 'should wrap nested nodes' do
+      @api.get('/books').map do |book|
+        book.author.class
+      end.should == [AuthorWrapper, AuthorWrapper]
+    end
+    
+    it 'should initialize nested wrappers with node as argument' do
+      @api.get('/books').map do |book|
+        book.author.name
+      end.should == ['J Conrad', 'Julio Cortazar']
+    end
+    
+    it 'should NOT wrap nested nodes if no wrapper defined' do
+      @api.get('/books').map do |book|
+        book.genre.class
+      end.should == [ApiBee::Node::Single, ApiBee::Node::Single]
+    end
+  end
+  
+  context 'accesing single nodes' do
+    it 'should wrap them' do
+      @api.get('/books/123').title_and_isbn.should == 'Heart of Darkness 123'
+    end
+  end
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: api_bee
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Ismael Celis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-18 00:00:00 Z
+date: 2012-03-01 00:00:00 Z
 dependencies: []
 
 description: Small Ruby client for discoverable, lazily-loaded, paginated JSON APIs
@@ -41,6 +41,7 @@ files:
 - spec/node_spec.rb
 - spec/setup_spec.rb
 - spec/spec_helper.rb
+- spec/wrapper_spec.rb
 homepage: https://github.com/ismasan/ApiBee
 licenses: []
 
@@ -64,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: api_bee
-rubygems_version: 1.8.6
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: API Bee is a small client / spec for a particular style of JSON API. Use Hash adapter for local data access.
@@ -73,3 +74,4 @@ test_files:
 - spec/node_spec.rb
 - spec/setup_spec.rb
 - spec/spec_helper.rb
+- spec/wrapper_spec.rb