mongosteen 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58c107f06312ff1f07feabb191063cea3047227d
-  data.tar.gz: a2b1c65c96d00e8f43b69747bc5d9cadf1a48d87
+  metadata.gz: a013b059d3c8a07bd717e0854201d996170ca260
+  data.tar.gz: 1bd552aa8dc317812f20cafb1030dbd479a991ee
 SHA512:
-  metadata.gz: a1e2917a9d1951be2b69845aeb406f364fd0497279575145746826a2c48a089e804d383e94dded309c504831624bb0fb4fd16cbf7ab29a6d6bdc373d1656ea86
-  data.tar.gz: a9bc84519076715864111128e966a890b4534ad7258598606d3e56b9bbf753fb59ea4b8e14ec8b4b697b7741c36dd4cd012e27bd6a795a8312a2856c59b467e0
+  metadata.gz: 553239594c50ef0bb14ec4f519a68f6a1be3b2eb1815f8f395772068c06922cfaeb10820fa5f7b2673d0aac341c803d1769008fd00d0c5c65ef956aa72092f3d
+  data.tar.gz: fe7381bc817c95a95402970a53f85d3e82b293cd7ed4fd435b026e9625b959549b4f2bc6bc5376767efd015ac671dd5cae83830ff15b421b455490965d719618

data/README.md

@@ -4,18 +4,130 @@
 
 ## An easy way to add restful actions
 
-Mongosteen is a library that helps to easily add restful actions to mongoid models with support of search, pagination, scopes, history, json config.
+Mongosteen is a library that helps to easily add restful actions to mongoid models and adds support of search, pagination, scopes, json config and history.
 
-- search
-- pagination
-- scopes
-- json config
-- history
+Mongosteen is based on [inherited_resources](https://github.com/josevalim/inherited_resources) gem, get yourself familiar on how it works and setup using it's documentation.
+
+## Installation
+
+1. Add Mongosteen to your Gemfile:
+
+  ```ruby
+  gem 'mongosteen'
+  ```
+
+2. Create controller for the model (e.g. ```Post```):
+
+  ```ruby
+  class PostsController < ApplicationController
+    mongosteen
+  end
+  ```
+
+3. Connect new controller in ```routes.rb```:
+
+  ```ruby
+  resources :posts
+  ```
+
+## Mongosteen API
+
+#### Index
+
+Index supports **search**, **page**, **perPage** and **scope** parameters:
+
+  ```
+  /posts.json?search=Mongosteen&perPage=10&page=2&scope=gems
+  ```
+Check out external gems documentation to see what options they provide:
+
+- **[mongoid_search](https://github.com/mauriciozaffari/mongoid_search)** — search for mongoid models;
+- **[kaminari](https://github.com/amatsuda/kaminari)** — generic Rails pagination solution;
+- **[has_scope](https://github.com/plataformatec/has_scope)** — easy way to access mongoid model scopes via controller;
+
+#### Versions
+
+Get specific resource **version**:
+
+  ```
+  /posts/54f4216f4f6c65e414000000.json?version=2
+  ```
+
+No how to add history support for mongoid model, check out:
+
+- **[mongoid-history](https://github.com/aq1018/mongoid-history)** — track changes to mongoid document;
+
+#### JSON config for model
+
+Some times there is a need to configure json output for the model, for example to add model method to output or to exclude some internal fields. Mongosteen provides an easy and isolated way to do that in models controller using ```json_config``` method:
+
+  ```ruby
+  class PostsController < ApplicationController
+    mongosteen
+    json_config({ methods: [ :published_at ] })
+  end
+  ```
+
+```json_config``` accepts configuration hash and passes it to [as_json](http://apidock.com/rails/ActiveResource/Base/as_json) method when render output.
+
+#### Sorted Relations
+
+In Mongoid, the HABTM relations return docs in the wrong order. This workaround gives your document the ability to retrieve it's relations in the same order it was placed in. This is refactored version of an original [mongoid-sorted-relations](https://github.com/demarque/mongoid-sorted-relations) gem.
+
+For more details about this issue, see [#1548](https://github.com/mongoid/mongoid/issues/1548).
+
+Usage example:
+
+  ```ruby
+  class Post
+    include Mongoid::Document
+    include Mongoid::SortedRelations
+
+    has_and_belongs_to_many :authors
+  end
+
+  post = Book.new title: 'Restful actions with Mongosteen'
+  post.authors << Author.create name: "Alexander Kravets"
+  post.authors << Author.create name: "Roman Brazhnyk"
+  post.authors << Author.create name: "Maxim Melnyk"
+
+  post.sorted_authors.map(&:name)
+  #=> ['Alexander Kravets', 'Roman Brazhnyk', 'Maxim Melnyk']
+  ```
+
+Check out orignal gem [documentation](https://github.com/demarque/mongoid-sorted-relations) for more usage examples.
+
+#### Permitted Parameters
+
+For easiness of prototyping, Mongosteen has a workaround that allows all input parameters for ```create``` and ```update``` methods. This default behaviour can be overriden by using ```permitted_params``` method inside of models controller, e.g.:
+
+  ```ruby
+  class Admin::PostsController < Admin::BaseController
+    mongosteen
+
+    protected
+
+    def permitted_params
+      params.permit(:post => [:title, :body])
+    end
+  end
+  ```
+
+#### Serializable Model Id
+
+By default mongoid model serializes document id into hash, to override that add ```Mongoid::SerializedId``` to model class:
+
+  ```ruby
+  class Post
+    include Mongoid::Document
+    include Mongoid::SortedRelations
+    include Mongoid::SerializedId
+  end
+  ```
 
 ## The Mongosteen family
 
-- [Character](https://github.com/slate-studio/chr): A simple and lightweight library for building data management web apps
-- [Character Admin](https://github.com/slate-studio/chr-admin): Flexible javascript admin solution for Rails applications
+- [Character](https://github.com/slate-studio/chr): A simple and lightweight javascript library for building data management web apps
 
 ## Credits
 

data/lib/mongosteen/version.rb

@@ -1,3 +1,3 @@
 module Mongosteen
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/mongosteen.gemspec

@@ -22,12 +22,12 @@ json config.
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 
-  s.add_dependency('mongoid',             '~> 4.0')  # orm
-  s.add_dependency('inherited_resources', '~> 1.6')  # base actions
-  s.add_dependency('kaminari',            '~> 0.16') # pagination
-  s.add_dependency('mongoid_search',      '~> 0.3')  # search
-  s.add_dependency('has_scope',           '~> 0.6')  # scopes
-  s.add_dependency('mongoid-history',     '~> 0.4')  # history
+  s.add_dependency('mongoid',             '>= 4.0')  # orm
+  s.add_dependency('inherited_resources', '>= 1.6')  # base actions
+  s.add_dependency('kaminari',            '>= 0.16') # pagination
+  s.add_dependency('mongoid_search',      '>= 0.3')  # search
+  s.add_dependency('has_scope',           '>  0.5')  # scopes
+  s.add_dependency('mongoid-history',     '>= 0.4')  # history
 end
 
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: mongosteen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexander Kravets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: inherited_resources
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
   name: mongoid_search
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: has_scope
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: mongoid-history
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
 description: |