paginated_her 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +32 -0
- data/Rakefile +1 -0
- data/lib/her/collection.rb +32 -0
- data/lib/paginated_her.rb +2 -0
- data/lib/paginated_her/version.rb +3 -0
- data/paginated_her.gemspec +25 -0
- metadata +95 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b8759527b3677a05abbfa8e3cf0b64a133fa9b87
|
4
|
+
data.tar.gz: c183d0cd953f9dbdc586789950d1108937bb270a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4be2d16720933680dd621aef2baf2e3e26c9b6c6a782227bfa38b3754fa5f8a0d213641639a7a9f2e59db7062a5bb021800d917b84d825eb7c5ed533db4356bc
|
7
|
+
data.tar.gz: fef7d3c4fd167fd91d6262ec3d01ad0d5c16098da7ec28ae8c17a2e88399207dfd8b755e2d88e56f07fbd8ecaca991ee411c71fe5498beb3b5926c93377000b9
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 William Ross
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# PaginatedHer
|
2
|
+
|
3
|
+
This is a bit of extra stuff for the useful but annoyingly unfindable [Her](https://github.com/remiprev/her).
|
4
|
+
In this newly simplified version all we do is extract pagination metadata in response to the calls that kaminari will make.
|
5
|
+
We do this quite crudely, by monkey-patching Her::Collection. No changes are required in your code.
|
6
|
+
|
7
|
+
Your api must return something like this:
|
8
|
+
|
9
|
+
meta: {
|
10
|
+
pagination:
|
11
|
+
current_page: 1,
|
12
|
+
per_page: 20,
|
13
|
+
next_page: 2,
|
14
|
+
prev_page: null,
|
15
|
+
total_pages: 28
|
16
|
+
total_count: 556
|
17
|
+
}
|
18
|
+
}
|
19
|
+
|
20
|
+
This gem only exists to avoid duplication in our API client libraries.
|
21
|
+
|
22
|
+
## Requirements
|
23
|
+
|
24
|
+
Her.
|
25
|
+
|
26
|
+
## Contributing
|
27
|
+
|
28
|
+
1. Fork it
|
29
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
30
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
31
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
32
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,32 @@
|
|
1
|
+
module Her
|
2
|
+
class Collection < Collection
|
3
|
+
|
4
|
+
def _pagination_data
|
5
|
+
metadata[:pagination].presence || {}
|
6
|
+
end
|
7
|
+
|
8
|
+
def current_page
|
9
|
+
_pagination_data[:current_page]
|
10
|
+
end
|
11
|
+
|
12
|
+
def per_page
|
13
|
+
_pagination_data[:per_page]
|
14
|
+
end
|
15
|
+
|
16
|
+
def next_page
|
17
|
+
_pagination_data[:next_page]
|
18
|
+
end
|
19
|
+
|
20
|
+
def prev_page
|
21
|
+
_pagination_data[:prev_page]
|
22
|
+
end
|
23
|
+
|
24
|
+
def total_pages
|
25
|
+
_pagination_data[:total_pages]
|
26
|
+
end
|
27
|
+
|
28
|
+
def total_count
|
29
|
+
_pagination_data[:total_count]
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'paginated_her/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "paginated_her"
|
8
|
+
spec.version = PaginatedHer::VERSION
|
9
|
+
spec.authors = ["William Ross"]
|
10
|
+
spec.email = ["will@spanner.org"]
|
11
|
+
spec.description = %q{Adds metadata pagination to Her}
|
12
|
+
spec.summary = %q{Adds metadata pagination to Her}
|
13
|
+
spec.homepage = "https://github.com/spanner/paginated_her"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency 'her'
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
end
|
metadata
ADDED
@@ -0,0 +1,95 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: paginated_her
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- William Ross
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-08-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: her
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '>='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ~>
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.3'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ~>
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.3'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Adds metadata pagination to Her
|
56
|
+
email:
|
57
|
+
- will@spanner.org
|
58
|
+
executables: []
|
59
|
+
extensions: []
|
60
|
+
extra_rdoc_files: []
|
61
|
+
files:
|
62
|
+
- .gitignore
|
63
|
+
- Gemfile
|
64
|
+
- LICENSE.txt
|
65
|
+
- README.md
|
66
|
+
- Rakefile
|
67
|
+
- lib/her/collection.rb
|
68
|
+
- lib/paginated_her.rb
|
69
|
+
- lib/paginated_her/version.rb
|
70
|
+
- paginated_her.gemspec
|
71
|
+
homepage: https://github.com/spanner/paginated_her
|
72
|
+
licenses:
|
73
|
+
- MIT
|
74
|
+
metadata: {}
|
75
|
+
post_install_message:
|
76
|
+
rdoc_options: []
|
77
|
+
require_paths:
|
78
|
+
- lib
|
79
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
80
|
+
requirements:
|
81
|
+
- - '>='
|
82
|
+
- !ruby/object:Gem::Version
|
83
|
+
version: '0'
|
84
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - '>='
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '0'
|
89
|
+
requirements: []
|
90
|
+
rubyforge_project:
|
91
|
+
rubygems_version: 2.4.4
|
92
|
+
signing_key:
|
93
|
+
specification_version: 4
|
94
|
+
summary: Adds metadata pagination to Her
|
95
|
+
test_files: []
|