bootic_client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e21ff6db54eead797a8ca1206880db8f32fd7bb2
-  data.tar.gz: 6cd1e6710e2a4b19edf284c749094217242c53ff
+  metadata.gz: 44cb025e788fcf5db4f335c6714b051a970e9647
+  data.tar.gz: 6871584b9fc940f4117e8c841f4ac1b85588121a
 SHA512:
-  metadata.gz: ee764305af03d550c8f6263df35b5ad0c656053dd7dffe57bfbc11713af78869e20eaf57d5cbc05574c00df947c7bf533cfc8a2276cf80a9f97106d14541ee19
-  data.tar.gz: 9faa674657d2ad7f08155366cce46fd8af5d7c740cfcb607d43c2d9b3f0e1877c0e4c917691c95bdec8996151271dba0ed9db9765fb623a1ea5fe3974caa4e57
+  metadata.gz: 8d2f579c6dca54966104b03b8518a5e9b32910b4195e62c2d84fa01ead10a5c16ae5465f4ea00349e8679c30b0beb0077a8f1392c0cf0e7adb47500b2f3b73dd
+  data.tar.gz: f03e36499a5275ae7a999f2be58ce05ce76d54eccb79a57fdf3388fec72b2d11f38c1e1eaa5412d5277f4bafaa485cdccba3a5dceeb25895d3daa4347787b185

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'byebug'
+  gem 'byebug' if RUBY_VERSION.to_i >= 2
   gem 'vcr', '~> 2.4'
-  gem 'webmock', '>= 1.9'
-end
+  gem 'webmock', '>= 1.20'
+end

data/README.md

@@ -1,7 +1,6 @@
 [![Build Status](https://travis-ci.org/bootic/bootic_client.rb.svg?branch=master)](https://travis-ci.org/bootic/bootic_client.rb)
 [![Gem Version](https://badge.fury.io/rb/bootic_client.svg)](http://badge.fury.io/rb/bootic_client)
 
-## WORK IN PROGRESS
 
 # BooticClient
 
@@ -53,13 +52,41 @@ if root.has?(:all_products)
     puts product.price
   end
 
-  if all_product.has?(:next)
+  # Iterate through pages of products
+  # See "iterating" section below for a more elegant option
+  if all_products.has?(:next)
     next_page = all_products.next
     next_page.each{...}
   end
 end
 ```
 
+### Iterating
+
+Entities representing lists of things ([products](https://developers.bootic.net/rels/products/), [orders](https://developers.bootic.net/rels/orders/), etc) are fully [enumerable](http://ruby-doc.org/core-2.2.0/Enumerable.html).
+
+```ruby
+# These will only iterate this page's worth of products
+all_products.each{|pr| puts pr.title}
+all_products.map(&:title)
+all_products.reduce(0){|sum, pr| sum + pr.price}
+```
+
+These lists might be part of a paginated data set. If you want to iterate items across pages and make sure you consume the full set, use `#full_set`.
+
+```ruby
+# These will iterate all necessary pages
+all_products.full_set.each{|pr| puts pr.title }
+all_products.full_set.map(&:title)
+all_products.full_set.first(500)
+```
+
+You can check whether an entity is iterable with:
+
+```ruby
+all_products.respond_to?(:each)
+```
+
 ## Strategies
 
 The Bootic Client supports different authentication strategies depending on the use case.
@@ -106,7 +133,6 @@ if shop.can?(:create_product)
     title: 'A shiny new product',
     price: 122332,
     status: "visible",
-    collecton_names: ["Featured products", "Homepage"],
     variants: [
       {
         title: 'First variant',
@@ -114,6 +140,10 @@ if shop.can?(:create_product)
         available_if_no_stock: 1,
         stock: 12
       }
+    ],
+    collections: [
+      {title: "A new collection"},
+      {id: 1234}
     ]
   )
 

data/bootic_client.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday", '~> 0.9'
   spec.add_dependency "uri_template", '~> 0.7'
   spec.add_dependency "faraday_middleware", '~> 0.9'
-  spec.add_dependency "faraday-http-cache", '~> 0.4'
+  spec.add_dependency "faraday-http-cache", '0.4.2'
   spec.add_dependency "net-http-persistent", '~> 2.9'
-  spec.add_dependency "oauth2"
+  spec.add_dependency "oauth2", "~> 1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/bootic_client/entity.rb

@@ -2,6 +2,26 @@ require "bootic_client/relation"
 require 'ostruct'
 
 module BooticClient
+  module EnumerableEntity
+    include Enumerable
+
+    def each(&block)
+      self[:items].each &block
+    end
+
+    def full_set
+      page = self
+
+      Enumerator.new do |yielder|
+        loop do
+          page.each{|item| yielder.yield item }
+          raise StopIteration unless page.has_rel?(:next)
+          page = page.next
+        end
+      end
+    end
+  end
+
   class Entity
 
     CURIE_EXP = /(.+):(.+)/.freeze
@@ -13,10 +33,15 @@ module BooticClient
     def initialize(attrs, client, top = self)
       @attrs, @client, @top = attrs, client, top
       build!
+      self.extend EnumerableEntity if iterable?
+    end
+
+    def to_hash
+      @attrs
     end
 
     def [](key)
-      properties[key.to_sym]
+      properties[key.to_sym] || entities[key.to_sym]
     end
 
     def has?(prop_name)
@@ -84,10 +109,6 @@ module BooticClient
       rels.has_key? prop_name.to_sym
     end
 
-    def each(&block)
-      iterable? ? entities[:items].each(&block) : [self].each(&block)
-    end
-
     def rels
       @rels ||= (
         links = attrs.fetch('_links', {})
@@ -126,4 +147,4 @@ module BooticClient
       end
     end
   end
-end
+end

data/lib/bootic_client/strategies/strategy.rb

@@ -19,6 +19,10 @@ module BooticClient
         request_and_wrap :get, config.api_root, Entity
       end
 
+      def from_hash(hash, wrapper_class = Entity)
+        wrapper_class.new hash, self
+      end
+
       def request_and_wrap(request_method, href, wrapper_class, payload = {})
         begin
           wrapper_class.new client.send(request_method, href, payload).body, self

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/authorized_strategy_spec.rb

@@ -144,5 +144,14 @@ describe 'BooticClient::Strategies::Authorized' do
         expect(shops.title).to eql('All shops')
       end
     end
+
+    describe '#from_hash' do
+      it 'builds and returns an entity' do
+        entity = client.from_hash('name' =>  'foo', '_links' => {'delete' => {'href' => '/foo/bar'}}) 
+        expect(entity).to be_kind_of(BooticClient::Entity)
+        expect(entity.name).to eql('foo')
+        expect(entity.can?(:delete)).to be true
+      end
+    end
   end
 end

data/spec/client_spec.rb

@@ -11,7 +11,12 @@ describe BooticClient::Client do
       {'Accept' => 'application/json', 'Authorization' => "Bearer xxx"}
     }
     let(:response_headers) {
-      {'Content-Type' => 'application/json', 'Last-Modified' => 'Sat, 07 Jun 2014 12:10:33 GMT'}
+      {
+        'Content-Type' => 'application/json', 
+        'Last-Modified' => 'Sat, 07 Jun 2014 12:10:33 GMT',
+        'ETag' => '0937dafce10db7b7d405667f9576d26d',
+        'Cache-Control' => 'max-age=0, private, must-revalidate'
+      }
     }
     let(:root_data) {
       {
@@ -57,6 +62,24 @@ describe BooticClient::Client do
             end
           end
         end
+
+        context 'and then cached by ETag' do
+          before do
+            @cached_request = stub_request(:get, root_url)
+              .with(headers: {'If-None-Match' => response_headers['ETag']})
+              .to_return(status: 304, body: '', headers: response_headers)
+          end
+
+          it 'returns cached response' do
+            r = client.get(root_url)
+            expect(@cached_request).to have_been_requested
+
+            expect(r.status).to eql(200)
+            r.body.tap do |b|
+              expect(b['_links']['shops']).to eql({'href' => 'https://api.bootic.net/v1/products'})
+            end
+          end
+        end
       end
 
       context 'errors' do

data/spec/entity_spec.rb

@@ -67,6 +67,10 @@ describe BooticClient::Entity do
       expect(entity.page).to eql(1)
     end
 
+    it 'has hash access to properties' do
+      expect(entity[:total_items]).to eql(10)
+    end
+
     it 'wraps object properties as entities' do
       expect(entity.an_object.name).to eql('Foobar')
       expect(entity.an_object.age).to eql(22)
@@ -82,6 +86,12 @@ describe BooticClient::Entity do
       expect(entity.has?(:foobar)).to eql(false)
     end
 
+    describe '#to_hash' do
+      it 'returns original data' do
+        expect(entity.to_hash).to eql(list_payload)
+      end
+    end
+
     describe 'embedded entities' do
 
       it 'has a #entities object' do
@@ -97,6 +107,10 @@ describe BooticClient::Entity do
         end
       end
 
+      it 'has hash access to properties' do
+        expect(entity[:total_items]).to eql(10)
+      end
+
       it 'recursively builds embedded entities' do
         product = entity.items.first
         product.shop.tap do |shop|
@@ -158,17 +172,48 @@ describe BooticClient::Entity do
     end
 
     describe 'iterating' do
-      it 'iterates items if it is a list' do
+      it 'is an enumerable if it is a list' do
         prods = []
         entity.each{|pr| prods << pr}
         expect(prods).to match_array(entity.items)
+        expect(entity.map{|pr| pr}).to match_array(entity.items)
+        expect(entity.reduce(0){|sum,e| sum + e.price.to_i}).to eql(24687)
+        expect(entity.each).to be_kind_of(Enumerator)
       end
 
-      it 'iterates itself if not a list' do
+      it 'is not treated as an array if not a list' do
         ent = BooticClient::Entity.new({'foo' => 'bar'}, client)
-        ents = []
-        ent.each{|e| ents << e}
-        expect(ents).to match_array([ent])
+        expect(ent).not_to respond_to(:each)
+      end
+    end
+
+    describe '#full_set' do
+      let(:page_2_data) {
+        {
+          'total_items' => 10,
+          'per_page' => 3,
+          'page' => 2,
+          '_links' => {
+            'self' => {'href' => '/foo?page=2'},
+            'next' => { 'href' => '/foo?page=3'}
+          },
+          "_embedded" => {
+            'items' => [
+              {"title" => "Item 3"},
+              {"title" => "Item 4"},
+              {"title" => "Item 5"}
+            ]
+          }
+        }
+      }
+      let(:page_2) { BooticClient::Entity.new(page_2_data, client) }
+
+      it 'lazily enumerates entries across pages, making as little requests as possible' do
+        expect(client).to receive(:request_and_wrap).with(:get, '/foo?page=2', BooticClient::Entity, {}).and_return page_2
+        expect(client).to_not receive(:request_and_wrap).with(:get, '/foo?page=3', BooticClient::Entity, {})
+        results = entity.full_set.first(4)
+        titles = results.map(&:title)
+        expect(titles).to match_array(['iPhone 4', 'iPhone 5', 'Item 3', 'Item 4'])
       end
     end
   end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2015-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: uri_template
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Official Ruby client for the Bootic API
@@ -171,9 +171,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -207,17 +207,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Official Ruby client for the Bootic API