kaminari-api-meta-data 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d42adddaf528dbe79396b537d685d14c9445b31
+  data.tar.gz: 90a1a861da4fd94acd6f488d6e7681f3601d7c6b
+SHA512:
+  metadata.gz: 472ef4e95fef8ae7619300373502efedbf7c516df9fce02960331ff8f7e969d2115a3e405cc77e556b456ad043c909d03421cb6a8f6dbc58a1322a163d3abb09
+  data.tar.gz: 3c6d660c34da94cbf726129298eefcfb6323175ba8aad923812c36459450f116f2377755190017a83e93190bddcc0b6819b71f337354004b0330b0bb210d75cf

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Stuart Chinery
+
+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,101 @@
+# Kaminari API Meta Data
+
+A gem for adding [Kaminari](https://github.com/kaminari/kaminari) collection meta data to your API responses that matches the format that works with the Kaminari [`paginate`](https://github.com/kaminari/kaminari#the-paginate-helper-method) helper method.
+
+[![Gem Version](https://badge.fury.io/rb/kaminari-api-meta-data.svg)](https://badge.fury.io/rb/kaminari-api-meta-data)
+[![Build Status](https://travis-ci.org/sleepingstu/kaminari-api-meta-data.svg?branch=master)](https://travis-ci.org/sleepingstu/kaminari-api-meta-data)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "kaminari-api-meta-data", require: "kaminari_api_meta_data"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install kaminari-api-meta-data
+```
+
+and then add `require "kaminari_api_meta_data"` to your Ruby file(s)
+
+## Usage
+
+Add the include to your class, in this example using the `ApplicationController` from a Rails API project.
+
+```ruby
+class ApplicationController < ActionController::API
+
+  include ::KaminariApiMetaData
+
+  # ...
+end
+```
+
+Then in a controller method use something like:
+
+```ruby
+def index
+  @things = Thing.unscoped.page(params[:page]).per(20)
+
+  render json: @things, root: :things, meta: meta_data(@things)
+end
+```
+
+This will return JSON like so:
+
+```json
+{
+  "things": [],
+  "meta": {
+    "current_page": 1,
+    "next_page": 2,
+    "per_page": 20,
+    "prev_page": null,
+    "total_pages": 5,
+    "total_count": 91
+  }
+}
+```
+
+### Additional Meta Data
+
+It is possible to extend the meta data returned by providing an optional Hash of properties to the `meta_data` method.
+
+```ruby
+meta = meta_data(@things, foo: "bar")
+puts meta
+# {
+#   current_page: 1,
+#   next_page: 2,
+#   per_page: 20,
+#   prev_page: nil,
+#   total_pages: 5,
+#   total_count: 91,
+#   foo: "bar"
+# }
+```
+
+## Contributing
+
+* Check out the latest master and/or develop branches to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch off of develop (using Git Flow approach)
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally
+* When you are done generate a pull request
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/kaminari_api_meta_data.rb

@@ -0,0 +1,16 @@
+require "kaminari_api_meta_data/version"
+
+module KaminariApiMetaData
+
+  def meta_data(collection, extra_meta = {})
+    {
+      current_page: collection.current_page,
+      next_page: collection.next_page,
+      per_page: collection.limit_value,
+      prev_page: collection.prev_page,
+      total_pages: collection.total_pages,
+      total_count: collection.total_count
+    }.merge(extra_meta)
+  end
+
+end

data/lib/kaminari_api_meta_data/version.rb

@@ -0,0 +1,3 @@
+module KaminariApiMetaData
+  VERSION = File.read("VERSION").split("\n").first
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-api-meta-data
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Chinery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+description: A gem for adding Kaminari collection meta data to your API responses
+  that matches the format that works with Kaminari paginate method.
+email:
+- stuart.chinery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/kaminari_api_meta_data.rb
+- lib/kaminari_api_meta_data/version.rb
+homepage: https://github.com/sleepingstu/kaminari-api-meta-data
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A gem for adding Kaminari collection meta data to your API responses
+test_files: []