acfs 0.34.0.1.b286 → 0.34.0.1.b287

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDM4N2M1ZWVjMjA0N2UwZmNjMDhlZDA4YmQ4YTBiODhkZDc3NTY0NA==
+    ZTA0YWNiNjAxMDkzZGNhNjRhYzAyMGM5MGI2NGYwNjMzMDY2OTY0Mg==
   data.tar.gz: !binary |-
-    NGQzZWRhNGI0Yjk4MzZjZjA2ZmY0YzFiNzI1ZTczZDI5NTA2ZTk1Mw==
+    OWIwMTgxYjg5NDc5NjMyZDY5YTc2MzVkY2JiMmRiOGYwZDZkZWMwNQ==
 SHA512:
   metadata.gz: !binary |-
-    YThiNjVlZjVjNTMzY2Y1NGQzNDdlZTcxYmFlNzYxMGUyZWZjNzVhNWJmMmQx
-    MzllN2YxOTc1NjNjZDM1ZmE3MjljODE0N2ZmZmVjNjcxOGYwZTFlMDc4NjJl
-    NmRlY2Y2MzRmOTU1OTVmNjFiNzRlYzZiZWFlZmZhYjkwNzc0NTA=
+    MzUwM2JjOWI3OTU0ZGZlZDJhOGYyMTY4N2UxNDA3MTU1Zjg3M2MyMjE3YTc5
+    ZTVjYzJlY2U0N2VmODU4MjQ0YzRiOGQ4ZmVmZmY0OWVjMTA1N2I0MjIzNDgz
+    OTRjMmM1MTA2OGMwMTY4YTNjZjNkMjU1NjgxZWU0YzBlMWI1MGQ=
   data.tar.gz: !binary |-
-    OTY5ZmY4YThjOTkxOGI3NDkzMWE1MzlmMGY3MDA4YzczNzk5MmZmYjFkZWMy
-    Y2M3NDU3ZGMzNTdmZmM3YTJiNTk4ZTM5NWY3MmM0NWY2ZjA1OTc3MzQ1NTQz
-    NmY3ZWZjMzgwOThkMzExN2NiNDA3YTE5MzVmZDAxMTUxZmEwMzQ=
+    ODQyY2FhMDMzMjZiODdiZTgwYTEyNjhmZjlkMjRhNGI4MGU5M2ZjYzU1MzAw
+    NWU2N2Q1MWZjOWE3N2NiMTUxOWRjMWZiZTE2YmYzZTA4MmE2NWQwMTg4NGEw
+    NGMyMDUxYjE3MzI2YTM3ZTcxY2MwNmE2N2NmYzhmMGZhYmNmYTI=

data/lib/acfs/collection.rb

@@ -10,8 +10,10 @@ module Acfs
     include Acfs::Util::Callbacks
     include Collections::Paginatable
 
-    def initialize
+    def initialize(resource_class)
       super([])
+
+      @resource_class = resource_class
     end
 
     def __getobj__

data/lib/acfs/collections/paginatable.rb

@@ -1,5 +1,13 @@
 module Acfs::Collections
   module Paginatable
+    extend ActiveSupport::Concern
+
+    included do
+      def self.operation(action, opts = {}, &block)
+        opts[:url]
+      end
+    end
+
     def total_pages
       @total_pages
     end
@@ -8,9 +16,56 @@ module Acfs::Collections
       @current_page
     end
 
-    def setup_pagination(params, header)
+    def process_response(response)
+      setup_params response.request.params if response.request
+      setup_headers response.headers
+    end
+
+    def next_page
+      page 'next'
+    end
+
+    def prev_page
+      page 'prev'
+    end
+
+    def first_page
+      page 'first'
+    end
+
+    def last_page
+      page 'last'
+    end
+
+    def page(rel)
+      if relations[rel]
+        @resource_class.all nil, url: relations[rel]
+      else
+        raise ArgumentError.new "No relative page `#{rel}'."
+      end
+    end
+
+    private
+    def relations
+      @relations ||= {}
+    end
+
+    def setup_headers(headers)
+      @total_pages  = Integer(headers['X-Total-Pages']) if headers['X-Total-Pages']
+
+      setup_links headers['Link'] if headers['Link']
+    end
+
+    def setup_links(links)
+      links.split(/,\s+/).each do |link|
+        if link =~ /^\s*<([^>]+)>.*\s+rel="([\w_-]+)".*$/
+          relations[$2] = $1
+        end
+      end
+    end
+
+    def setup_params(params)
       @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

@@ -71,15 +71,15 @@ module Acfs::Model
       #
       # @return [ Collection ] Collection of requested resources.
       #
-      def all(params = {}, &block)
-        collection = ::Acfs::Collection.new
+      def all(params = {}, opts = {}, &block)
+        collection = ::Acfs::Collection.new self
         collection.__callbacks__ << block if block
 
-        operation :list, params: params do |data, header|
+        operation :list, opts.merge(params: params) do |data, response|
           data.each do |obj|
             collection << create_resource(obj)
           end
-          collection.setup_pagination params, header
+          collection.process_response response
           collection.loaded!
           collection.__invoke__
         end
@@ -151,7 +151,7 @@ module Acfs::Model
       end
 
       def find_multiple(ids, opts, &block)
-        ::Acfs::Collection.new.tap do |collection|
+        ::Acfs::Collection.new(self).tap do |collection|
           collection.__callbacks__ << block unless block.nil?
 
           counter = 0

data/lib/acfs/operation.rb

@@ -19,8 +19,12 @@ module Acfs
       @params   = (opts[:params] || {}).dup
       @data     = (opts[:data]   || {}).dup
 
-      @location = resource.location(action: @action).extract_from(@params, @data)
-      @url      = location.str
+      if opts[:url]
+        @url      = opts[:url]
+      else
+        @location = resource.location(action: @action).extract_from(@params, @data)
+        @url      = location.str
+      end
 
       @callback = block
     end
@@ -39,7 +43,11 @@ module Acfs
     end
 
     def full_params
-      (id ? params.merge(id: id) : params).merge location.args
+      (id ? params.merge(id: id) : params).merge location_args
+    end
+
+    def location_args
+      location ? location.args : {}
     end
 
     def method
@@ -50,7 +58,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, response.headers
+        callback.call response.data, response
       end
       request
     end

data/lib/acfs/request.rb

@@ -18,8 +18,6 @@ module Acfs
         @headers = options.delete(:headers) || {}
         @params  = options.delete(:params) || {}
         @method  = options.delete(:method) || :get
-
-        url.query = nil # params.any? ? params.to_param : nil
       end.to_s
       on_complete &block if block_given?
     end

data/lib/acfs/stub.rb

@@ -5,7 +5,7 @@ module Acfs
   # Global handler for stubbing resources.
   #
   class Stub
-    ACTIONS = [ :read, :create, :update, :delete, :list ]
+    ACTIONS = [:read, :create, :update, :delete, :list]
 
     attr_reader :opts
 
@@ -26,8 +26,8 @@ module Acfs
       return true if opts[:with] == params || data == opts[:with]
       return true if (opts[:with].nil? && params.empty? && data.empty?)
 
-      return true if opts[:with].reject{|k,v|v.nil?} == params.reject{|k,v|v.nil?}
-      return true if opts[:with].reject{|k,v|v.nil?} == data.reject{|k,v|v.nil?}
+      return true if opts[:with].reject { |k, v| v.nil? } == params.reject { |k, v| v.nil? }
+      return true if opts[:with].reject { |k, v| v.nil? } == data.reject { |k, v| v.nil? }
 
       false
     end
@@ -44,11 +44,17 @@ module Acfs
     def call(op)
       calls << op
 
-      if (err = opts[:raise])
+      err  = opts[:raise]
+      data = opts[:return]
+
+      if err
         raise_error op, err, opts[:return]
-      elsif (data = opts[:return])
-        headers = opts[:headers] || {}
-        op.call data, headers
+      elsif data
+        response = Acfs::Response.new op.request,
+                                      headers: opts[:headers] || {},
+                                      status:  opts[:status] || 200,
+                                      data:    data || {}
+        op.call data, response
       else
         raise ArgumentError, 'Unsupported stub.'
       end
@@ -72,7 +78,7 @@ module Acfs
         raise ArgumentError, "Unknown action `#{action}`." unless ACTIONS.include? action
 
         Stub.new(opts).tap do |stub|
-          stubs[klass] ||= {}
+          stubs[klass]         ||= {}
           stubs[klass][action] ||= []
           stubs[klass][action] << stub
         end
@@ -90,8 +96,13 @@ module Acfs
         @enabled ||= false
       end
 
-      def enable; @enabled = true end
-      def disable; @enabled = false end
+      def enable;
+        @enabled = true
+      end
+
+      def disable;
+        @enabled = false
+      end
 
       # Clear all stubs.
       #

data/spec/acfs/collection_spec.rb

@@ -1,16 +1,19 @@
 require 'spec_helper'
 
 describe Acfs::Collection do
+  let(:model) { MyUser }
+
   describe 'Pagination' do
     let(:params) { Hash.new }
-    let!(:collection) { MyUser.all params }
+    let!(:collection) { model.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'})
+        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 }
@@ -20,8 +23,9 @@ describe Acfs::Collection do
     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'})
+        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 }
@@ -31,12 +35,109 @@ describe Acfs::Collection do
     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'})
+        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
+
+    describe '#next_page' 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',
+                                   'Link'          => '<http://users.example.org/users?page=2>; rel="next"'
+                               })
+      end
+      let!(:req) do
+        stub_request(:get, 'http://users.example.org/users?page=2').to_return response([])
+      end
+      let!(:collection) { model.all }
+      subject { Acfs.run; collection.next_page }
+
+      it { should be_a Acfs::Collection }
+
+      it 'should have fetched page 2' do
+        subject
+        Acfs.run
+        expect(req).to have_been_requested
+      end
+    end
+
+    describe '#prev_page' do
+      before do
+        stub_request(:get, 'http://users.example.org/users?page=2').
+            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+                               headers: {
+                                   'X-Total-Pages' => '2',
+                                   'Link'          => '<http://users.example.org/users>; rel="prev"'
+                               })
+      end
+      let!(:req) do
+        stub_request(:get, 'http://users.example.org/users').to_return response([])
+      end
+      let!(:collection) { model.all page: 2 }
+      subject { Acfs.run; collection.prev_page }
+
+      it { should be_a Acfs::Collection }
+
+      it 'should have fetched page 1' do
+        subject
+        Acfs.run
+        expect(req).to have_been_requested
+      end
+    end
+
+    describe '#first_page' do
+      before do
+        stub_request(:get, 'http://users.example.org/users?page=2').
+            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+                               headers: {
+                                   'X-Total-Pages' => '2',
+                                   'Link'          => '<http://users.example.org/users>; rel="first"'
+                               })
+      end
+      let!(:req) do
+        stub_request(:get, 'http://users.example.org/users').to_return response([])
+      end
+      let!(:collection) { model.all page: 2 }
+      subject { Acfs.run; collection.first_page }
+
+      it { should be_a Acfs::Collection }
+
+      it 'should have fetched page 1' do
+        subject
+        Acfs.run
+        expect(req).to have_been_requested
+      end
+    end
+
+    describe '#last_page' do
+      before do
+        stub_request(:get, 'http://users.example.org/users?page=2').
+            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+                               headers: {
+                                   'X-Total-Pages' => '2',
+                                   'Link'          => '<http://users.example.org/users?page=12>; rel="last"'
+                               })
+      end
+      let!(:req) do
+        stub_request(:get, 'http://users.example.org/users?page=12').to_return response([])
+      end
+      let!(:collection) { model.all page: 2 }
+      subject { Acfs.run; collection.last_page }
+
+      it { should be_a Acfs::Collection }
+
+      it 'should have fetched page 1' do
+        subject
+        Acfs.run
+        expect(req).to have_been_requested
+      end
+    end
   end
 end

data/spec/acfs/request_spec.rb

@@ -21,15 +21,6 @@ describe Acfs::Request do
         expect(request.url).to be == "#{url}"
       end
     end
-
-    context 'with parameters in URL' do
-      let(:url) { 'http://api.example.org/v1/examples?b=ac' }
-      let(:params) { { id: 10 }}
-
-      it 'should strip query from URL' do
-        expect(request.url).to be == 'http://api.example.org/v1/examples'
-      end
-    end
   end
 
   describe '#headers' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 0.34.0.1.b286
+  version: 0.34.0.1.b287
 platform: ruby
 authors:
 - Jan Graichen