spyke-kaminari 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c2b893be4e3c8e97b6381f646202cbcb0a8e9ab
+  data.tar.gz: 4c984f8cfbc6067a2bb63aac2efd1c7e692890fd
+SHA512:
+  metadata.gz: c709df12964400ca5c022d997d28e962a46eebc7c2dfbacccd00ef6ff1fcb85b98df23d19d0cc9336689952645c1181f77c5b5b6d35faadf51e100be25548dc2
+  data.tar.gz: e37f2c451194f7d8e8e5ed1c006fe6135b3a3f951a279e59d088f1623f9ce63d023aa9baaf15328b5e53ffac428cd47de18f3422d727748daa5a80e1287fe5cc

data/lib/spyke/kaminari/header_parser.rb

@@ -0,0 +1,21 @@
+module Spyke::Kaminari
+  class HeaderParser < Faraday::Response::Middleware
+    def on_complete(env)
+      @env = env
+
+      metadata = Spyke::Kaminari::HEADERS.each_with_object({}) do |(symbol, key), hash|
+        hash[symbol] = header(key)
+      end
+
+      @env.body[:metadata] ||= {}
+      @env.body[:metadata][Spyke::Kaminari::METADATA_KEY] = metadata
+    end
+
+    private
+
+    def header(key)
+      value = @env.response_headers[key]
+      value.try(:to_i)
+    end
+  end
+end

data/lib/spyke/kaminari/relation.rb

@@ -0,0 +1,54 @@
+module Spyke::Kaminari
+  # A Spyke relation extended with pagination metadata and helpers, similar
+  # Kaminari's PaginatableArray.
+  class Relation < Spyke::Relation
+    Spyke::Kaminari::HEADERS.keys.each do |symbol|
+      define_method(symbol) do
+        find_some.metadata[Spyke::Kaminari::METADATA_KEY][symbol]
+      end
+    end
+
+    def first_page?
+      current_page == 1
+    end
+
+    def last_page?
+      current_page == total_pages
+    end
+
+    def out_of_range?
+      current_page > total_pages
+    end
+
+    # Iterates through each page.
+    #
+    # Useful for stitching together an array of all records, across every page.
+    # For example:
+    #
+    #   users = User.all.each_page.flat_map(&:to_a)
+    #
+    # If there are 3 total pages, it would result in these HTTP requests:
+    #
+    #   GET /v1/users
+    #   GET /v1/users?page=2
+    #   GET /v1/users?page=3
+    #
+    # ...and this array of users (25 records per page):
+    #
+    #   users.count
+    #   # => 75
+    #
+    # With the exception of the first one, pages are lazily fetched.
+    def each_page
+      return to_enum(:each_page) unless block_given?
+
+      relation = clone
+      yield relation
+      return if relation.last_page? || relation.out_of_range?
+
+      (relation.next_page..relation.total_pages).each do |number|
+        yield clone.page(number)
+      end
+    end
+  end
+end

data/lib/spyke/kaminari/scopes.rb

@@ -0,0 +1,19 @@
+module Spyke::Kaminari
+  module Scopes
+    extend ActiveSupport::Concern
+
+    included do
+      %i{page per_page offset}.each do |symbol|
+        scope symbol, ->(value) { where(symbol => value) }
+      end
+    end
+
+    module ClassMethods
+      # Overrides the method included by Spyke::Scoping to return paginated
+      # relations.
+      def all
+        current_scope || Spyke::Kaminari::Relation.new(self, uri: uri)
+      end
+    end
+  end
+end

data/lib/spyke/kaminari.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext'
+
+module Spyke::Kaminari
+  HEADERS = {
+    total_count:  'X-Total',
+    total_pages:  'X-Total-Pages',
+    limit_value:  'X-Per-Page',
+    current_page: 'X-Page',
+    next_page:    'X-Next-Page',
+    prev_page:    'X-Prev-Page',
+    offset_value: 'X-Offset'
+  }
+
+  METADATA_KEY = :kaminari
+end
+
+require 'spyke/kaminari/header_parser'
+require 'spyke/kaminari/relation'
+require 'spyke/kaminari/scopes'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: spyke-kaminari
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Todd Mazierski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spyke
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: 
+email:
+- todd@generalassemb.ly
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spyke/kaminari.rb
+- lib/spyke/kaminari/header_parser.rb
+- lib/spyke/kaminari/relation.rb
+- lib/spyke/kaminari/scopes.rb
+homepage: https://github.com/generalassembly/spyke-kaminari
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Kaminari pagination for Spyke models
+test_files: []
+has_rdoc: