acfs 0.33.1.1.b281 → 0.33.1.1.b285

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTNiNTcyZmU5MTRmY2Y0NjA2ODgwNmE2ZWJhNjZjOWY1ZTBiMGE2MA==
+    ZTc2ZGE4MDNiNjgwNWMzNTBkYzJjNzU1YmEzMjRhOGFkMjE0ZDQ4MQ==
   data.tar.gz: !binary |-
-    YzEzYjY4NDk0NGFkMWFkMDg0N2QyYjExNGNjNzEyMTIwMjhiMjA4Mw==
+    NjM5MzYwYTAwMmIzZDVjY2IyZDk5NmVkZDA0MGZiZjg2NjdjNTRlNg==
 SHA512:
   metadata.gz: !binary |-
-    ZGEyZWYxMTFiZGMzMjQ4N2ZiMWQyNDVjYmFkZGViNGEzM2VmZTI2OGU5YTlh
-    ZmRmNDUzZDE0N2FjNjNmNzlmZDk5YjJkNDA1ZDFiNDk5OTMyNzA2Y2M4M2Yz
-    MWU1YmJmNzQ3NWIxYTZhYzM5YmRiY2FmMzQzOGZkODU0MTYxMDA=
+    ZmFlMzIwMDg0NGRmZjAwZDM0YmZjYTEzMTc4MzYxYTdiYjc1NTc4M2I1NGMy
+    ZWVmYzc0YmNkNGM4OGZmMTBiYTFkOGQ5ODc4NDdlMDM0MjU1MTNhMTFkNTFk
+    NTQxNGRlMDgyMGUwNzcxNmRlMmRkOGRlOGEwYjI5NmVlNWYyZTc=
   data.tar.gz: !binary |-
-    MzZmZWJjNGRiOTZkMWIzMDMxNWFkNGViODc2OGM1MDM0YTljMjBhMzFiN2Zk
-    MTEwNjg0NjM5YTQyODJjZDJlNzkwM2RlMzBiZGQwNDUyYmI5YjA5OTk1Yzc1
-    NGI1ZTMyYzUwYjkyMzYxNDllZjZiMGUzZGQ3NTA5MGVkZmU0NWE=
+    ZTg2ZTRmZDQyOTg0MmI2MDRmNmNiMTRjY2MyYTlhNjdkMzdjNmViYjMwNzk3
+    MmYxZGI3YjY5YmM2ZTU0NTg5YjAxODZhN2U5MzAyMTc4MjY1YWE5MTljM2I3
+    OTA0ZWI1MmJiNmU1YzE5MDkxYjM2ODkwMWQ2ZDZlZTJlMjRjMTg=

data/lib/acfs/collection.rb

@@ -1,12 +1,14 @@
 require 'delegate'
 
 require 'acfs/model/loadable'
+require 'acfs/collections/paginatable'
 
 module Acfs
 
   class Collection < ::Delegator
     include Model::Loadable
     include Acfs::Util::Callbacks
+    include Collections::Paginatable
 
     def initialize
       super([])

data/lib/acfs/collections/paginatable.rb

@@ -0,0 +1,16 @@
+module Acfs::Collections
+  module Paginatable
+    def total_pages
+      @total_pages
+    end
+
+    def current_page
+      @current_page
+    end
+
+    def setup_pagination(params, header)
+      @current_page = Integer(params.fetch(:page, 1)) rescue params[:page]
+      @total_pages  = Integer(header['X-Total-Pages']) if header['X-Total-Pages']
+    end
+  end
+end

data/lib/acfs/model/query_methods.rb

@@ -75,10 +75,11 @@ module Acfs::Model
         collection = ::Acfs::Collection.new
         collection.__callbacks__ << block if block
 
-        operation :list, params: params do |data|
+        operation :list, params: params do |data, header|
           data.each do |obj|
             collection << create_resource(obj)
           end
+          collection.setup_pagination params, header
           collection.loaded!
           collection.__invoke__
         end

data/lib/acfs/operation.rb

@@ -50,7 +50,7 @@ module Acfs
       request = ::Acfs::Request.new url, method: method, params: params, data: data
       request.on_complete do |response|
         handle_failure response unless response.success?
-        callback.call response.data
+        callback.call response.data, response.headers
       end
       request
     end

data/lib/acfs/stub.rb

@@ -47,7 +47,8 @@ module Acfs
       if (err = opts[:raise])
         raise_error op, err, opts[:return]
       elsif (data = opts[:return])
-        op.call data
+        headers = opts[:headers] || {}
+        op.call data, headers
       else
         raise ArgumentError, 'Unsupported stub.'
       end

data/spec/acfs/collection_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Acfs::Collection do
+  describe 'Pagination' do
+    let(:params) { Hash.new }
+    let!(:collection) { MyUser.all params }
+
+    subject { Acfs.run; collection }
+
+    context 'without explicit page parameter' do
+      before do
+        stub_request(:get, 'http://users.example.org/users').to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+                                                                                headers: {'X-Total-Pages' => '2'})
+      end
+
+      its(:total_pages) { should eq 2 }
+      its(:current_page) { should eq 1 }
+    end
+
+    context 'with page parameter' do
+      let(:params) { {page: 2} }
+      before do
+        stub_request(:get, 'http://users.example.org/users?page=2').to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+                                                                                       headers: {'X-Total-Pages' => '2'})
+      end
+
+      its(:total_pages) { should eq 2 }
+      its(:current_page) { should eq 2 }
+    end
+
+    context 'with non-numerical page parameter' do
+      let(:params) { {page: 'e546f5'} }
+      before do
+        stub_request(:get, 'http://users.example.org/users?page=e546f5').to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+                                                                                       headers: {'X-Total-Pages' => '2'})
+      end
+
+      its(:total_pages) { should eq 2 }
+      its(:current_page) { should eq 'e546f5' }
+    end
+  end
+end

data/spec/acfs/stub_spec.rb

@@ -154,6 +154,20 @@ describe Acfs::Stub do
           expect(computers.last).to be_a Mac
         end
       end
+
+      context 'with header' do
+        before do
+          Acfs::Stub.resource Comment, :list,
+          return: [{ id: 1, text: 'Foo' }, { id: 2, text: 'Bar' }],
+          headers: headers
+        end
+
+        let!(:comments) { Comment.all }
+        let(:headers) { {'X-Total-Pages' => '2'} }
+        subject { Acfs.run; comments }
+
+        its(:total_pages) { should eq 2 }
+      end
     end
 
     context 'with update action' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.33.1.1.b281
+  version: 0.33.1.1.b285
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,6 +123,7 @@ files:
 - lib/acfs/adapter/base.rb
 - lib/acfs/adapter/typhoeus.rb
 - lib/acfs/collection.rb
+- lib/acfs/collections/paginatable.rb
 - lib/acfs/configuration.rb
 - lib/acfs/errors.rb
 - lib/acfs/global.rb
@@ -170,6 +171,7 @@ files:
 - lib/acfs/util.rb
 - lib/acfs/version.rb
 - lib/acfs/yard.rb
+- spec/acfs/collection_spec.rb
 - spec/acfs/configuration_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb
@@ -225,6 +227,7 @@ signing_key:
 specification_version: 4
 summary: An abstract API base client for service oriented application.
 test_files:
+- spec/acfs/collection_spec.rb
 - spec/acfs/configuration_spec.rb
 - spec/acfs/middleware/json_decoder_spec.rb
 - spec/acfs/middleware/msgpack_decoder_spec.rb