her-kaminari 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ffa99110a7233d0838f61953d48c94981debe48
+  data.tar.gz: d3bde921ef86247057bd5d1de920e58988d208f0
+SHA512:
+  metadata.gz: c74a8d242f69d2ce6f2662d05acc7f3b0a9211270353197ee2221a29ff60c07547a1fcf80cfecc36a96cf8399b34c14711619238aad05b94c5060e752edd81d9
+  data.tar.gz: 54867a070c7a429fee9a1a74135b7d5473b4cf178f523d96c69279d28c814fcaf83c4e4026915a9991d90160e15c230f1b3fb5ac95debf4589547aca444476f6

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in her-kaminari.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# Guardfile
+# More info at https://github.com/guard/guard#readme
+guard :minitest do
+  watch(%r{^test/test_helper\.rb}) { 'test' }
+  watch(%r{^test/.+_test\.rb})
+  watch(%r{^lib/(.+).rb$})         { |m| "test/lib/#{m[1]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daniel Blanco Rojas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Blanco Rojas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Her::Kaminari
+
+Makes [Her](https://github.com/remiprev/her "ORM that maps REST resources to Ruby objects") aware of APIs that return pagination headers like [grape-kaminari](https://github.com/monterail/grape-kaminari "kaminari paginator integration for grape API framework") gem.
+
+Her models can now query these APIs like any other kaminari model:
+
+```ruby
+  User.page(1).per(10)
+```
+
+**IMPORTANT:** Pagination is done by the API not by this gem, this gem just parses
+the response data and creates a Kaminari compatible collection that you can use in
+your views.
+
+## Gem Dependencies
+
+* [Her](https://github.com/remiprev/her "ORM that maps REST resources to Ruby objects")
+* [Kaminari](https://github.com/amatsuda/kaminari "Paginator for Rails")
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'her-kaminari'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install her-kaminari
+
+## Usage
+
+First include Her::Kaminari::HeaderParser in your Her setup like this:
+
+```ruby
+Her::API.setup url: 'https://api.example.com' do |c|
+  #...
+
+  # Response
+  c.use Her::Kaminari::HeaderParser
+
+  # ...
+end
+```
+
+HeaderParser expects that the API request returns the following headers:
+
+```
+X-Total: Total number of records.
+X-Page: Current page number.
+X-Per-Page: Number of records per page.
+X-Offset: (optional) the starting point for the return data.
+```
+
+
+Then include Her::Kaminari::Collection in your Her model like this:
+
+```ruby
+class User
+  include Her::Model
+  include Her::Kaminari::Collection
+end
+```
+
+Now you can use your Her model like any other Kaminari model.
+
+## History
+
+After reading [How to pass pagination headers with Kaminari, Her and Grape?](http://aenain.github.io/2014/05/27/how-to-pass-pagination-headers-with-kaminari-her-and-grape.html) post by [Artur Hebda](http://aenain.github.io) I decided that it was a good idea to create a gem with his code.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/her-kaminari/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+
+task :default => :test

data/her-kaminari.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'her/kaminari/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "her-kaminari"
+  spec.version       = Her::Kaminari::VERSION
+  spec.authors       = ["Daniel Blanco Rojas, Artur Hebda"]
+  spec.email         = ["daniel.blancorojas@gmail.com"]
+  spec.summary       = %q{Kaminari pagination for Her models.}
+  spec.description   = %q{Makes Her aware of APIs that return pagination headers.}
+  spec.homepage      = "https://github.com/DanielBlanco/her-kaminari"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'her', '~> 0.7', '>= 0.7.2'
+  spec.add_runtime_dependency 'kaminari', '~> 0.16.1', '>= 0.16.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1', '>= 0.10.1'
+  spec.add_development_dependency 'guard', '~> 2.6.1', '>= 2.6.1'
+  spec.add_development_dependency 'guard-minitest', '~> 2.3.2', '>= 2.3.2'
+  spec.add_development_dependency 'grape', '~> 0.9.0', '>= 0.9.0' # <= Just to shut up kaminari warning
+end

data/lib/her/kaminari.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+# lib/her/kaminari.rb
+
+require 'her'
+
+module Her
+  module Kaminari
+  end
+end
+
+require 'her/kaminari/collection'
+require 'her/kaminari/header_parser'
+require 'her/kaminari/version'

data/lib/her/kaminari/collection.rb

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+# lib/her/kaminari/collection.rb
+require 'kaminari'
+require 'kaminari/models/array_extension'
+
+module Her
+  module Kaminari
+    module Collection
+      def self.included(base)
+        base.class_eval do
+          # support for kaminari pagination methods
+          scope :page, ->(page) { where(page: page || 1) }
+          scope :per,  ->(per_page) { where(per_page:  per_page || 50) }
+        end
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        # Creates a new paginated collection from API data.
+        # This method makes the assumption the collection was already paginated
+        # by the API.
+        #
+        # @return [Kaminari::PaginatableArray] a paginated collection
+        def new_collection(parsed_data)
+          collection = super(parsed_data)
+          pagination = parsed_data[:pagination]
+          collection = ::Kaminari::PaginatableArray.new(
+            collection,
+            total_count: pagination[:total_count],
+            limit: pagination[:per_page]
+          ).tap do |array|
+            array.extend ::Kaminari::PageScopeMethods
+            array.singleton_class.class_eval do
+
+              # @return [Integer] our API page number
+              define_method :current_page do
+                pagination[:page]
+              end
+
+              # @return [Integer] our API offset number
+              define_method :offset_value do
+                pagination[:offset]
+              end
+
+            end
+          end
+          collection
+        end
+
+      end
+    end
+  end
+end

data/lib/her/kaminari/header_parser.rb

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+# lib/her/kaminari/header_parser.rb
+module Her
+  module Kaminari
+    class HeaderParser < Faraday::Response::Middleware
+
+      # @param [Hash] env environment
+      def on_complete(env)
+        @env = env
+
+        pagination = {
+          total_count: header("x-total").to_i,
+          per_page:    (header("x-per-page") || env.body[:data].count).to_i,
+          page:        header("x-page").to_i,
+          offset:      header('x-offset').to_i
+        }
+
+        env[:body].merge!(pagination: pagination)
+      end
+
+      private
+
+        # Returns a response header value.
+        #
+        # @param [String] name of the header attribute
+        # @return [String] the response header value
+        def header(name)
+          @env.response_headers[name]
+        end
+    end
+  end
+end

data/lib/her/kaminari/version.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+module Her
+  module Kaminari
+    VERSION = "0.0.1"
+  end
+end

data/test/lib/her/kaminari/collection_test.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+# test/lib/her/kaminari/collection_test.rb
+require 'test_helper'
+
+describe Her::Kaminari::Collection do
+  before do
+    class Champion
+      include Her::Model
+      include Her::Kaminari::Collection
+    end
+  end
+
+  it 'should query by kaminari methods' do
+    champions = Champion.page(2).per(2)
+    #binding.pry
+    champions.size.must_equal 2
+    champions.current_page.must_equal 2
+    champions.total_count.must_equal 9
+    champions.first.id.must_equal 3
+  end
+
+end
+

data/test/lib/her/kaminari/header_parser_test.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+# test/lib/her/kaminari_test.rb
+require 'test_helper'
+
+describe Her::Kaminari::HeaderParser do
+
+  subject { Her::Kaminari::HeaderParser.new }
+  let(:body) { { 'data' => [1,2,3,4,5] } }
+  let(:headers) { {'x-total'=>5, 'x-page'=> 1, 'x-per-page' => 3 } }
+
+  it 'parses pagination headers' do
+    env = OpenStruct.new(body: body, response_headers: headers)
+    subject.on_complete(env)
+    env[:body].tap do |json|
+      expected = {total_count: 5, per_page: 3, page: 1, offset: 0 }
+      json[:pagination].must_equal expected
+    end
+  end
+
+end
+

data/test/lib/her/kaminari_test.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+# test/lib/her/kaminari_test.rb
+require 'test_helper'
+
+describe Her::Kaminari do
+
+  it 'must be defined' do
+    Her::Kaminari::VERSION.wont_be_nil
+  end
+
+end

data/test/support/her_api.rb

@@ -0,0 +1,38 @@
+# -*- encoding : utf-8 -*-
+# support/her_api.rbj
+
+# Her setup
+Her::API.setup url: 'https://api.example.com' do |c|
+  # Request
+  c.use Faraday::Request::UrlEncoded
+
+  # Response
+  c.use Her::Kaminari::HeaderParser
+  c.use Her::Middleware::DefaultParseJSON
+
+  # Adapter
+  c.adapter :test do |stub|
+    stub.get("/champions") do |env|
+      champions = [
+        { id: 1, name: 'Aatrox'},
+        { id: 2, name: 'Ahri'},
+        { id: 3, name: 'Akali'},
+        { id: 4, name: 'Alistar' },
+        { id: 5, name: 'Amumu' },
+        { id: 6, name: 'Anivia' },
+        { id: 7, name: 'Annie' },
+        { id: 8, name: 'Ashe' },
+        { id: 9, name: 'Azir' }
+      ]
+      page = (env.params['page'] || 1).to_i
+      per_page = (env.params['per_page'] || 5).to_i
+      headers = {
+        'x-total' => champions.size,
+        'x-page' => page,
+        'x-per-page' => per_page
+      }
+      champions = ::Kaminari.paginate_array(champions).page(page).per(per_page)
+      [200, headers, champions.to_json]
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+# test/test_helper.rb
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'json'
+require 'rack/test'
+require 'pry'
+require 'grape'
+require 'her/kaminari'
+require 'support/her_api'
+

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: her-kaminari
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Blanco Rojas, Artur Hebda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+    - - ">="
+      - !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::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Makes Her aware of APIs that return pagination headers.
+email:
+- daniel.blancorojas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- her-kaminari.gemspec
+- lib/her/kaminari.rb
+- lib/her/kaminari/collection.rb
+- lib/her/kaminari/header_parser.rb
+- lib/her/kaminari/version.rb
+- test/lib/her/kaminari/collection_test.rb
+- test/lib/her/kaminari/header_parser_test.rb
+- test/lib/her/kaminari_test.rb
+- test/support/.keep
+- test/support/her_api.rb
+- test/test_helper.rb
+homepage: https://github.com/DanielBlanco/her-kaminari
+licenses:
+- MIT
+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 Her models.
+test_files:
+- test/lib/her/kaminari/collection_test.rb
+- test/lib/her/kaminari/header_parser_test.rb
+- test/lib/her/kaminari_test.rb
+- test/support/.keep
+- test/support/her_api.rb
+- test/test_helper.rb