Merge pull request #8 from dblock/with-mongoid

Grape API with Roar and Mongoid.

Author: dblock

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-08-06 12:31:48 -0400 using RuboCop version 0.33.0.
+# on 2016-09-25 16:03:07 -0400 using RuboCop version 0.43.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,20 +10,24 @@
 Metrics/AbcSize:
   Max: 19
 
-# Offense count: 18
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 27
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
-  Max: 152
+  Max: 149
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 15
 
-# Offense count: 9
+# Offense count: 10
 Style/Documentation:
   Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
     - 'api/extensions/crud_extension.rb'
+    - 'api/extensions/scroll_extension.rb'
     - 'api/presenters/paginated_presenter.rb'
     - 'api/presenters/root_presenter.rb'
     - 'api/presenters/spline_presenter.rb'
@@ -32,8 +36,3 @@ Style/Documentation:
     - 'app/acme_app.rb'
     - 'app/models/spline.rb'
     - 'app/root_endpoint.rb'
-
-# Offense count: 1
-Style/DoubleNegation:
-  Exclude:
-    - 'app/models/spline.rb'

.travis.yml

@@ -1,8 +1,11 @@
 sudo: false
 
 rvm:
-  - 2.3.0
+  - 2.3.1
 
 language: ruby
 
 cache: bundler
+
+services:
+  - mongodb

Gemfile

@@ -5,9 +5,10 @@ gem 'grape-roar'
 gem 'rack-cors'
 gem 'grape-swagger'
 gem 'activemodel'
-gem 'kaminari', require: 'kaminari/grape'
 gem 'rack-rewrite'
 gem 'puma'
+gem 'mongoid', '~> 5.0'
+gem 'mongoid-scroll'
 
 group :development do
   gem 'rake'
@@ -18,4 +19,7 @@ group :test do
   gem 'rspec'
   gem 'rack-test'
   gem 'hyperclient'
+  gem 'database_cleaner'
+  gem 'fabrication'
+  gem 'faker'
 end

Gemfile.lock

@@ -1,41 +1,33 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (4.2.6)
-      actionview (= 4.2.6)
-      activesupport (= 4.2.6)
-      rack (~> 1.6)
-      rack-test (~> 0.6.2)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.6)
-      activesupport (= 4.2.6)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activesupport (4.2.6)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ast (2.2.0)
+    ast (2.3.0)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
+    bson (4.1.1)
     builder (3.2.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
+    database_cleaner (1.5.3)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
+    enumerable-lazy (0.0.1)
     equalizer (0.0.11)
-    erubis (2.7.0)
+    fabrication (2.15.2)
+    faker (1.6.6)
+      i18n (~> 0.5)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     faraday-digestauth (0.2.1)
@@ -46,26 +38,22 @@ GEM
     faraday_middleware (0.9.2)
       faraday (>= 0.7.4, < 0.10)
     futuroscope (0.1.11)
-    grape (0.15.0)
+    grape (0.17.0)
       activesupport
       builder
       hashie (>= 2.1.0)
       multi_json (>= 1.3.2)
       multi_xml (>= 0.5.2)
+      mustermann19 (~> 0.4.3)
       rack (>= 1.3.0)
       rack-accept
-      rack-mount
       virtus (>= 1.0.0)
-    grape-entity (0.4.8)
-      activesupport
-      multi_json (>= 1.3.2)
     grape-roar (0.3.0)
       grape
       roar (>= 1.0)
-    grape-swagger (0.10.4)
-      grape (>= 0.8.0)
-      grape-entity (< 0.5.0)
-    hashie (3.4.3)
+    grape-swagger (0.24.0)
+      grape (>= 0.12.0)
+    hashie (3.4.6)
     hyperclient (0.8.1)
       faraday
       faraday-digestauth
@@ -77,71 +65,70 @@ GEM
     i18n (0.7.0)
     ice_nine (0.11.2)
     json (1.8.3)
-    kaminari (0.16.3)
-      actionpack (>= 3.0.0)
-      activesupport (>= 3.0.0)
-    loofah (2.0.3)
-      nokogiri (>= 1.5.9)
-    mini_portile2 (2.0.0)
-    minitest (5.8.4)
-    multi_json (1.11.2)
+    minitest (5.9.0)
+    mongo (2.3.0)
+      bson (~> 4.1)
+    mongoid (5.1.4)
+      activemodel (~> 4.0)
+      mongo (~> 2.1)
+      origin (~> 2.2)
+      tzinfo (>= 0.3.37)
+    mongoid-compatibility (0.4.0)
+      activesupport
+      mongoid (>= 2.0)
+    mongoid-scroll (0.3.4)
+      i18n
+      mongoid (>= 3.0)
+      mongoid-compatibility
+    multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
+    mustermann19 (0.4.4)
+      enumerable-lazy
     net-http-digest_auth (1.4)
-    nokogiri (1.6.7.2)
-      mini_portile2 (~> 2.0.0.rc2)
-    parser (2.3.0.6)
+    origin (2.2.0)
+    parser (2.3.1.4)
       ast (~> 2.2)
     powerpack (0.1.1)
-    puma (3.1.0)
-    rack (1.6.4)
+    puma (3.6.0)
+    rack (2.0.1)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rack-cors (0.4.0)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
     rack-rewrite (1.5.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
     rainbow (2.1.0)
-    rake (11.1.1)
+    rake (11.3.0)
     representable (2.3.0)
       uber (~> 0.0.7)
     roar (1.0.4)
       representable (>= 2.0.1, < 2.4.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.38.0)
-      parser (>= 2.3.0.6, < 3.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.7.5)
+    ruby-progressbar (1.8.1)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     uber (0.0.15)
-    unicode-display_width (1.0.2)
+    unicode-display_width (1.1.1)
     uri_template (0.7.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
@@ -154,11 +141,15 @@ PLATFORMS
 
 DEPENDENCIES
   activemodel
+  database_cleaner
+  fabrication
+  faker
   grape
   grape-roar
   grape-swagger
   hyperclient
-  kaminari
+  mongoid (~> 5.0)
+  mongoid-scroll
   puma
   rack-cors
   rack-rewrite
@@ -168,4 +159,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.10.6
+   1.12.5

README.md

@@ -1,16 +1,11 @@
-Grape API with Roar
-===================
+Grape API with Roar & Mongoid
+=============================
 
-[![Build Status](https://travis-ci.org/ruby-grape/grape-with-roar.svg?branch=master)](https://travis-ci.org/ruby-grape/grape-with-roar)
-[![Dependency Status](https://gemnasium.com/ruby-grape/grape-with-roar.svg)](https://gemnasium.com/ruby-grape/grape-with-roar)
-[![Code Climate](https://codeclimate.com/github/ruby-grape/grape-with-roar.svg)](https://codeclimate.com/github/ruby-grape/grape-with-roar)
+[![Build Status](https://travis-ci.org/ruby-grape/grape-with-roar.svg?branch=with_mongoid)](https://travis-ci.org/ruby-grape/grape-with-roar?branch=with_mongoid)
+[![Dependency Status](https://gemnasium.com/ruby-grape/grape-with-roar.svg?branch=with_mongoid)](https://gemnasium.com/ruby-grape/grape-with-roar?branch=with_mongoid)
+[![Code Climate](https://codeclimate.com/github/ruby-grape/grape-with-roar.svg?branch=with_mongoid)](https://codeclimate.com/github/ruby-grape/grape-with-roar?branch=with_mongoid)
 
-A [Grape](http://github.com/ruby-grape/grape) API that uses [Roar](https://github.com/apotonick/roar).
-
-See
----
-
-Try me [here](http://grape-with-roar.herokuapp.com/). In Chrome, best viewed with the [JSONView Plugin](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc?hl=en).
+A [Grape](http://github.com/ruby-grape/grape) API that uses [Roar](https://github.com/apotonick/roar) and Mongoid with a MongoDB database.
 
 Run
 ---
@@ -36,7 +31,7 @@ This is a good demo to use with [Hyperclient](https://github.com/codegram/hyperc
 ActiveRecord
 ------------
 
-This project uses ActiveModel and defines a dummy [Spline](app/models/spline.rb) class. Check out the [with-activerecord branch](https://github.com/ruby-grape/grape-with-roar/tree/with-activerecord) for a complete example that uses ActiveRecord and a PostgreSQL database.
+This project uses Mongoid and defines a dummy [Spline](app/models/spline.rb) class. Check out the [master branch](https://github.com/ruby-grape/grape-with-roar) for a complete example that uses ActiveModel and [with-activerecord branch](https://github.com/ruby-grape/grape-with-roar/tree/with-activerecord) for a complete example that uses ActiveRecord and a PostgreSQL database.
 
 Copyright and License
 ---------------------

api/extensions/crud_extension.rb

@@ -2,24 +2,16 @@ module Grape
   module Extensions
     module CrudExtension
       def create(type, options = {})
-        instance = type.new
-        instance.extend options[:with]
-        instance.from_hash options[:from]
-        yield instance if block_given?
-        instance.save!
+        instance = type.create! options[:from].to_h
         present instance, with: options[:with]
       end
 
       def update(instance, options = {})
-        instance.extend options[:with]
-        instance.from_hash options[:from]
-        yield instance if block_given?
-        instance.save!
+        instance.update_attributes! options[:from].to_h
         present instance, with: options[:with]
       end
 
       def delete(instance, options = {})
-        yield instance if block_given?
         instance.destroy
         present instance, with: options[:with]
       end

api/extensions/scroll_extension.rb

@@ -0,0 +1,22 @@
+module Grape
+  module Extensions
+    module ScrollExtension
+      # apply cursor-based pagination to a collection
+      # returns a hash:
+      #   results: (paginated collection subset)
+      #   next: (cursor to the next page)
+      def paginate_by_cursor(coll, &_block)
+        results = { results: [], next: nil }
+        size = (params[:size] || 10).to_i
+        # some items may be skipped with a block
+        coll.limit(size).scroll(params[:cursor]) do |record, next_cursor|
+          results[:results] << record
+          results[:next] = next_cursor.to_s
+        end
+        results
+      end
+
+      Grape::Endpoint.send(:include, self)
+    end
+  end
+end