zanoxrb 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dd9f08ace2ce5f98f28b96a2d844abb3e2f152f
-  data.tar.gz: b3ceb6ac205b0d431bc9f0eb504e6a3700812891
+  metadata.gz: e259a4e6312026b1c4660963c4173c44a90b328c
+  data.tar.gz: 997286ec7075c92a64c4c84b59059fd4c981f4b7
 SHA512:
-  metadata.gz: 2db51f310649d9a5881ed495879d8eb074bb1bc5dcebb15356d24062c7d1330ee69ac04a6a73ccabadeffc34fe606d5d54026b79945011785312882f2f207140
-  data.tar.gz: fe6900a5666f4ea39bf4957297c7d9045f19712e22cded574e3bef974676e81c550f8e9d4f529cf0519572b6aad705c4345577e358f44be3e8d315d9470d6b7f
+  metadata.gz: 661fdb1f33a9de6f8a5105673c5dac3efb30e4ba44dddb277394d3837b6fd9f6fc38891b8b2b3968b9eee412fa2553dc66104cd19be94be1325609b7df843c2e
+  data.tar.gz: 9889e8f69ec3b9c081487ece8fb8fad05fd9b41cb487ff5c12dbd33ebbcbd0d6ea680ee5fafbb5fe06053b0db7497348acc37b869f86db8cc072dd82a0e3b23d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zanoxrb (0.2)
+    zanoxrb (0.3)
       httparty (~> 0.13)
 
 GEM

data/README.md

@@ -19,4 +19,7 @@ To make requests to the APIs, call `Zanox::API#request` passing the endpoint of
 
 Every call will return a native Ruby hash or an array reflecting the original documentation provided by Zanox (I plan to also wrap every response inside a class that allows to get every value following the Ruby-way, btw).
 
+Note also that the pagination in Zanox APIs is 0-indexed. For example, if you want to get the second page of the requested products list you have to pass `page: 1` to the optional params, otherwise you'll get, of course, the first page that actually is referrable as `page: 0`.
+Consider using `Zanox::Response#next_page` and `Zanox::Response#previous_page` to navigate through the pages.
+
 For debugging purpose, consider also to enable info logs by executing `Zanox::API.debug!`.

data/lib/zanox/api.rb

@@ -58,8 +58,7 @@ module Zanox
         logger.info "Params:  #{options.inspect}"
         logger.info "Headers: #{headers.inspect}"
         response = get("/json/2011-03-01/#{method}", query: options, headers: headers)
-        Response.new(response)
-      end
+        Response.new(response, [method, options, headers]) end
     end
   end
 end

data/lib/zanox/response.rb

@@ -26,8 +26,9 @@ module Zanox
   class Response
     attr_reader :response
 
-    def initialize(response)
-      @response = response
+    def initialize(response, original_params = [])
+      @response        = response
+      @original_params = original_params
 
       status_code = @response.parsed_response['code']
       if status_code
@@ -39,8 +40,18 @@ module Zanox
       end
     end
 
-    def response
-      @response.parsed_response
+    def previous_page
+      if @original_params.length == 3
+        @original_params[1].merge!({ page: page - 1 })
+        API.request(*@original_params)
+      end
+    end
+
+    def next_page
+      if @original_params.length == 3
+        @original_params[1].merge!({ page: page + 1 })
+        API.request(*@original_params)
+      end
     end
 
     def inspect

data/lib/zanox/version.rb

@@ -23,5 +23,5 @@
 #++
 
 module Zanox
-  VERSION = '0.2'
+  VERSION = '0.3'
 end

data/specs/products_spec.rb

@@ -1,11 +1,11 @@
 describe Zanox::API do
   describe '#request' do
-    context 'products' do
-      let(:products) { Zanox::API.request('products', q: 'nike', programs: 7408) }
+    before :each do
+      Zanox::API::Session.connect_id = '43EEF0445509C7205827'
+    end
 
-      before :each do
-        Zanox::API::Session.connect_id = '43EEF0445509C7205827'
-      end
+    context 'products with given keyword and programID' do
+      let(:products) { Zanox::API.request('products', q: 'nike', programs: 7408) }
 
       it 'returns pagination infos' do
         expect(products.page).to  be   0
@@ -14,7 +14,7 @@ describe Zanox::API do
         expect(products.query).to eq('nike')
       end
 
-      it 'returns a list of products with given keyword and program' do
+      it 'returns a list of products' do
         items = products.product_items
 
         expect(items).to be_an(Array)
@@ -24,5 +24,42 @@ describe Zanox::API do
         expect(items.all? { |i| i['program']['@id'].to_i == 7408 }).to be_truthy
       end
     end
+
+    context 'products with given keyword and number of requested items per page' do
+      let(:products) { Zanox::API.request('products', q: 'nike', items: 50) }
+
+      it 'returns pagination infos' do
+        expect(products.page).to  be   0
+        expect(products.items).to be   50
+        expect(products.total).to be > 100
+        expect(products.query).to eq('nike')
+      end
+    end
+
+    # context 'products#next_page!' do
+    #   let(:products) { Zanox::API.request('products', q: 'iPod', items: 50) }
+    #
+    #   it 'move the paginator to the second page of the products list' do
+    #     expect { products.next_page! }.to change { products.page }.from(0).to(1)
+    #   end
+    # end
+
+    context 'products#next_page' do
+      let(:products) { Zanox::API.request('products', q: 'iPod', items: 50) }
+
+      it 'returns a new response containing the second page of the products list' do
+        expect(products.page).to           be 0
+        expect(products.next_page.page).to be 1
+      end
+    end
+
+    context 'products#previous_page' do
+      let(:products) { Zanox::API.request('products', q: 'nike', page: 3) }
+
+      it 'returns a new response containing the second page of the products list' do
+        expect(products.page).to               be 3
+        expect(products.previous_page.page).to be 2
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zanoxrb
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Giovanni Capuano