api_bee 0.1.4 → 0.1.7

data/README.mkd

@@ -9,33 +9,36 @@ These APIs must
 
 A single resource might look like:
 
+```javascript
+{
+  'name':        'Foo',
+  'description': 'foo resoruce',
+  'href':        'http://api.myservice.com/resources/foo'
+}
+```
+A resource collection looks like:
+
+```javascript
+{
+  'href': 'http://api.myservice.com/resources',
+  'total_entries': 100,
+  'page': 1,
+  'per_page': 10,
+  'entries': [
     {
       'name':        'Foo',
       'description': 'foo resoruce',
-      'href':        'http://api.myservice.com/resources/foo'
-    }
-    
-A resource collection looks like:
-
+      'href':         'http://api.myservice.com/resources/foo'
+    },
     {
-      'href': 'http://api.myservice.com/resources',
-      'total_entries': 100,
-      'page': 1,
-      'per_page': 10,
-      'entries': [
-        {
-          'name':        'Foo',
-          'description': 'foo resoruce',
-          'href':         'http://api.myservice.com/resources/foo'
-        },
-        {
-          'name':        'Bar',
-          'description': 'bar resoruce',
-          'href':        'http://api.myservice.com/resources/bar'
-        },
-        ...
-      ]
-    }
+      'name':        'Bar',
+      'description': 'bar resoruce',
+      'href':        'http://api.myservice.com/resources/bar'
+    },
+    ...
+  ]
+}
+```
     
 Collection resources must include the fields 'href', 'total_entries', 'page', 'per_page' and 'entries'. This allows clients to paginate and fetch more pages.
 
@@ -71,14 +74,16 @@ end
 
 If an object in a response has a 'href' attribute, it will be used to fetch more data if you ask for an attribute currently not in the object.
 
-    # JSON Dataset
-    {
-      'user': {
-        'name': 'Ismael',
-        'href': 'http://api.com/users/ismael'
-      }
-    }
-    
+```javascript
+/* JSON Dataset */
+{
+  'user': {
+    'name': 'Ismael',
+    'href': 'http://api.com/users/ismael'
+  }
+}
+```
+
 ```ruby
 # Instantiate object
 user = api.get('/user')
@@ -90,26 +95,27 @@ user[:last_name]
     
 This works for objects in collections too.
 
-    # JSON collection
-    {
-      'users': {
-        'total_entries': 100,
-        'page': 1,
-        'per_page': 2,
-        'href': 'http://api.com/users',
-        'entries': [
-          {
-            'name': 'Ismael',
-            'href': 'http://api.com/users/ismael'
-          },
-          {
-            'name': 'John',
-            'href': 'http://api.com/users/john'
-          }
-        ]
+```javascript
+/* JSON collection */
+{
+  'users': {
+    'total_entries': 100,
+    'page': 1,
+    'per_page': 2,
+    'href': 'http://api.com/users',
+    'entries': [
+      {
+        'name': 'Ismael',
+        'href': 'http://api.com/users/ismael'
+      },
+      {
+        'name': 'John',
+        'href': 'http://api.com/users/john'
       }
-    }
-
+    ]
+  }
+}
+```
  
 ```ruby
 # Instantiate collection
@@ -197,27 +203,42 @@ end
 
 ApiBee ships with an in-memory Hash adapter so it can be use with test/local data (for example a YAML file).
 
-
 ```ruby
-api = ApiBee.setup(:hash, YAML.load_file('./my_data.yml'))
-    
+api = ApiBee.setup(:hash, YAML.load_file('./my_data.yml'))    
+
 products = api.get('/products') # => ApiBee::Node::List
-    
-products.first # => ApiBee::Node::Single
-    
+
+products.first # => ApiBee::Node::Single    
 products.each() # iterate current page
-    
 products.current_page # => 1
-    
 products.paginate(:page => 2, :per_page => 4) # => ApiBee::Node::List # Next page
-    
 products.has_next_page? # => false
-    
 products.has_prev_page? # => true
-    
 products.prev_page # => 1
 ``` 
 
 ## Examples
 
 See [examples/github_api.rb](https://github.com/ismasan/ApiBee/blob/master/examples/github_api.rb) for an adapter that paginates Github's API by decorating it's results with ApiBee's required pagination properties
+
+# LICENSE
+
+Copyright (C) 2011 Ismael Celis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/api_bee/adapters/hash.rb

@@ -6,8 +6,11 @@ module ApiBee
       
       attr_reader :data
       
-      def initialize(*args)
-        @data = args.last
+      def initialize(data, args = {})
+        @data = data
+        @config = {
+          :uid_field => :id
+        }.merge(args)
       end
       
       def get(href, opts = {})
@@ -49,7 +52,7 @@ module ApiBee
       
       def handle_array_data(array, key)
         if array[0].kind_of?(::Hash)
-          array.find {|e| e[:id] == key}
+          array.find {|e| e[@config[:uid_field]].to_s == key}
         else
           array
         end

data/lib/api_bee/node.rb

@@ -81,6 +81,10 @@ module ApiBee
       end
     end
     
+    def []=(key, value)
+      @attributes[key.to_sym] = value
+    end
+    
     protected
     
     def update_attributes(attrs)

data/lib/api_bee/version.rb

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

data/spec/hash_adapter_spec.rb

@@ -56,6 +56,19 @@ describe ApiBee::Adapters::Hash do
     end
   end
   
+  context 'custom item identifier' do
+    before do
+      @data[:collections].first[:uid] = 'xxx123'
+      @uid_adapter        = ApiBee::Adapters::Hash.new(@data, :uid_field => :uid)
+    end
+    
+    it 'should find by custom field name' do
+      collection = @uid_adapter.get('/collections/xxx123')
+      collection[:title].should == 'Catalog'
+      collection[:id].should == 'catalog'
+    end
+  end
+  
   context 'accessing single nodes' do
     
     before do

data/spec/node_spec.rb

@@ -117,6 +117,20 @@ describe ApiBee do
     end
   end
   
+  describe '#[]=' do
+    
+    before do
+      @adapter = mock('Adapter')
+      @config = ApiBee.new_config
+    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
+    end
+  end
+  
   context 'lazy loading' do
     before do
       require 'api_bee/adapters/hash'

metadata

@@ -2,7 +2,7 @@
 name: api_bee
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors: 
 - Ismael Celis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-10 00:00:00 Z
+date: 2012-01-18 00:00:00 Z
 dependencies: []
 
 description: Small Ruby client for discoverable, lazily-loaded, paginated JSON APIs