mongosteen 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea0fb5b1dedaf0933cf8e88b117d2ca83e71135e
-  data.tar.gz: a7dbe64751f052a5f01fcf789d48552befce044e
+  metadata.gz: a2ffeeae51d0306d1f73592a7625c8d7aedd5845
+  data.tar.gz: 01698c266ab659745f276d5f3d0c1b0e76fb3abf
 SHA512:
-  metadata.gz: 21db96d0630431de3c40bc326d175e07478ac0e507d7bbff7276b2850b3a9d176d8d722f605a55a3d384d4118f7dc3d073f114bcdaacf306739caf314c6e690b
-  data.tar.gz: 49adec9c612a8cdd5f3dee9a64c0f869241be56bfe71cb6bb1486bc896f0ff86a7cf242235bb297ae3360660dd3dfda9798212db3926bbf3605e8c8aec2b43cd
+  metadata.gz: e0bc8e85b29307e7da8c3525199e8e37165036b5d0eefb95fc50d521c4c1fe7e4a4dfc1fa55f21b3d9e3d454926f9bdc3842fcbd235b61a06108fce73a74636b
+  data.tar.gz: 75a9eeaf8caad1b54d849e2524466ff85fd8b693fc1235d0eb11af89a8b6b7e326d46a061e8b4a554ce739e13a057c77d0597c77ee07518222a1dd734214d279

data/.gitignore

@@ -0,0 +1,3 @@
+test/rails_app/tmp
+test/rails_app/log
+log

data/Gemfile

@@ -1,3 +1,11 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem 'rails', '4.2.0'
+gem 'coffee-rails', '~> 4.1.0'
+gem 'minitest-rails-capybara'
+gem 'capybara-webkit'
+gem 'mongoid'
+gem 'mongoid-history'
+gem 'kaminari'

data/Gemfile.lock

@@ -0,0 +1,204 @@
+PATH
+  remote: .
+  specs:
+    mongosteen (0.1.6)
+      has_scope (> 0.5)
+      inherited_resources (>= 1.6)
+      kaminari (>= 0.16)
+      mongoid (>= 4.0)
+      mongoid-history (>= 0.4.5)
+      mongoid_search (>= 0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    arel (6.0.0)
+    bson (2.3.0)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-webkit (1.4.1)
+      capybara (>= 2.3.0, < 2.5.0)
+      json
+    coffee-rails (4.1.0)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1.1)
+    connection_pool (2.2.0)
+    database_cleaner (1.4.1)
+    easy_diff (0.0.4)
+    erubis (2.7.0)
+    execjs (2.5.2)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    fast-stemmer (1.0.2)
+    globalid (0.3.5)
+      activesupport (>= 4.1.0)
+    has_scope (0.6.0)
+      actionpack (>= 3.2, < 5)
+      activesupport (>= 3.2, < 5)
+    i18n (0.7.0)
+    inherited_resources (1.6.0)
+      actionpack (>= 3.2, < 5)
+      has_scope (~> 0.6.0.rc)
+      railties (>= 3.2, < 5)
+      responders
+    json (1.8.3)
+    kaminari (0.16.3)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loofah (2.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    minitest-capybara (0.7.1)
+      capybara (~> 2.2)
+      minitest (~> 5.0)
+      rake
+    minitest-focus (1.1.1)
+      minitest (>= 4, < 6)
+    minitest-metadata (0.5.3)
+      minitest (>= 4.7, < 6.0)
+    minitest-rails (2.2.0)
+      minitest (~> 5.7)
+      railties (~> 4.1)
+    minitest-rails-capybara (2.1.1)
+      capybara (~> 2.0)
+      minitest-capybara (~> 0.7.0)
+      minitest-metadata (~> 0.5.0)
+      minitest-rails (~> 2.1)
+    minitest-reporters (1.0.16)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-history (0.4.7)
+      activesupport
+      easy_diff
+      mongoid (>= 3.0)
+    mongoid_search (0.3.2)
+      fast-stemmer (~> 1.0.0)
+      mongoid (>= 3.0.0)
+    moped (2.0.4)
+      bson (~> 2.2)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    optionable (0.2.0)
+    origin (2.1.1)
+    rack (1.6.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
+    ruby-progressbar (1.7.5)
+    sprockets (3.2.0)
+      rack (~> 1.0)
+    sprockets-rails (2.3.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara-webkit
+  coffee-rails (~> 4.1.0)
+  database_cleaner
+  factory_girl_rails
+  kaminari
+  minitest-focus
+  minitest-rails-capybara
+  minitest-reporters
+  mongoid
+  mongoid-history
+  mongosteen!
+  rails (= 4.2.0)
+  rake (>= 0.8.7)

data/README.md

@@ -2,11 +2,13 @@
 
 # Mongosteen
 
-## An easy way to add restful actions
 
-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.
+## An easy way to add RESTful actions
+
+Mongosteen is a library that helps to easily add RESTful actions to mongoid models, providing support for search, pagination, scopes, json configuration and history.
+
+Mongosteen is based on [inherited_resources](https://github.com/josevalim/inherited_resources) gem, get yourself familiar with how it works and what you can do with this great tool.
 
-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
 
@@ -30,9 +32,10 @@ Mongosteen is based on [inherited_resources](https://github.com/josevalim/inheri
   resources :posts
   ```
 
+
 ## Mongosteen API
 
-#### Index
+### Index
 
 Index supports **search**, **page**, **perPage** and **scope** parameters:
 
@@ -45,7 +48,8 @@ Check out external gems documentation to see what options they provide:
 - **[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
+
+### Versions
 
 Get specific resource **version**:
 
@@ -57,9 +61,10 @@ 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:
+### JSON configuration for models
+
+Sometimes there is a need to configure json output for the model, for example to add model method to output or exclude some internal fields. Mongosteen provides an easy and isolated way to do that in model controller using ```json_config``` method:
 
   ```ruby
   class PostsController < ApplicationController
@@ -68,73 +73,45 @@ Some times there is a need to configure json output for the model, for example t
   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
+```json_config``` accepts configuration hash and passes it to [as_json](http://apidock.com/rails/ActiveResource/Base/as_json) method while rendering document json.
 
-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).
+### Permitted Parameters
 
-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.:
+For rapid prototyping, Mongosteen allows all input parameters for ```create``` and ```update``` methods. This default behaviour can be overriden by using ```permitted_params``` method in controller, e.g:
 
   ```ruby
   class Admin::PostsController < Admin::BaseController
     mongosteen
 
-    protected
+    private
 
-    def permitted_params
-      params.permit(:post => [:title, :body])
-    end
+      def post_params
+        params.require(:post).permit(: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:
+## Mongosteen family
 
-  ```ruby
-  class Post
-    include Mongoid::Document
-    include Mongoid::SortedRelations
-    include Mongoid::SerializedId
-  end
-  ```
+- [Character](https://github.com/slate-studio/chr): Powerful responsive javascript CMS for apps
+- [Mongosteen](https://github.com/slate-studio/mongosteen): An easy way to add RESTful actions for Mongoid models
+- [Inverter](https://github.com/slate-studio/inverter): An easy way to connect Rails templates content to Character CMS
+- [Loft](https://github.com/slate-studio/loft): Media assets manager for Character CMS
 
-## The Mongosteen family
 
-- [Character](https://github.com/slate-studio/chr): A simple and lightweight javascript library for building data management web apps
+## License
+
+Copyright © 2015 [Slate Studio, LLC](http://slatestudio.com). Mongoosteen is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).
+
 
-## Credits
+## About Slate Studio
 
 [![Slate Studio](https://slate-git-images.s3-us-west-1.amazonaws.com/slate.png)](http://slatestudio.com)
 
-Mongosteen is maintained and funded by [Slate Studio, LLC](http://slatestudio.com). Tweet your questions or suggestions to [@slatestudio](https://twitter.com/slatestudio) and while you’re at it follow us too.
+Mongoosteen is maintained and funded by [Slate Studio, LLC](http://slatestudio.com). Tweet your questions or suggestions to [@slatestudio](https://twitter.com/slatestudio) and while you’re at it follow us too.
+
+
 
-## License
 
-Copyright © 2015 [Slate Studio, LLC](http://slatestudio.com). Mongosteen is free software, and may be redistributed under the terms specified in the [license](LICENSE.md).

data/Rakefile

@@ -1,3 +1,17 @@
 # encoding: utf-8
-require "rubygems"
-require "bundler"
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run tests for all ORMs.'
+task default: :test
+
+desc 'Run Mongosteen unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.warning = false
+end

data/lib/mongosteen.rb

@@ -1,10 +1,12 @@
-# CodeKit needs relative paths
-dir = File.dirname(__FILE__)
-$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+# @TODO: take a look at http://jsonapi.org/implementations/
+
 
 require 'inherited_resources'
-require 'has_scope'
+require 'mongoid_search'
+require 'mongoid-history'
 require 'kaminari'
+require 'has_scope'
+
 
 module Mongosteen
   autoload :Actions,         'mongosteen/actions'
@@ -13,36 +15,45 @@ module Mongosteen
   autoload :PermittedParams, 'mongosteen/permitted_params'
 
   class Engine < ::Rails::Engine
-    require 'mongosteen/engine'
-    require 'mongoid/fake_criteria'
-    require 'mongoid/sorted_relations'
-    require 'mongoid/serializable_id'
+    # auto wire
   end
 end
 
+
 class ActionController::Base
-  # You can call mongosteen in your controller to have
-  # all the required modules and funcionality included.
+
+  # Call mongosteen in your controller to have all the
+  # required modules and funcionality included.
   def self.mongosteen
     self.class_eval do
+
       inherit_resources
 
       respond_to :json
+
       class_attribute :as_json_config
+      class_attribute :json_default_methods
 
       extend  Mongosteen::ClassMethods
       include Mongosteen::BaseHelpers
       include Mongosteen::Actions
       include Mongosteen::PermittedParams
 
-      # configure permitted_params to accept all attributes
       instance_name = self.resources_configuration[:self][:instance_name]
+
+      # configure permitted_params to accept all attributes
       define_method("#{ instance_name }_params") { params_all_permitted }
       private "#{ instance_name }_params"
+
+      # support for character default list item attributes
+      chr_default_methods = %w( _list_item_title _list_item_subtitle _list_item_thumbnail )
+      self.json_default_methods = chr_default_methods.select { |m| self.resource_class.method_defined? m }
+
+      json_config()
+
     end
   end
-end
-
 
+end