mongosteen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2c5e9a3b1fb54ca264fbc34e957dc6ca0b8a0d8
+  data.tar.gz: f2be921ba553aaf9ab72f9da5d62606ca48c7fc6
+SHA512:
+  metadata.gz: 80f24df9d54d67e47e1c0ec5fb0ac3bb8b4e7f2edf232870cca933c2028efdf657d5cd2930fa30c9717689faf2bc7271d72bcb04171e7ce4a68a04e1b0e533ba
+  data.tar.gz: 8b4a72708186e3f209acd208de62a5eba5df49f4059a996de049a43fa436eeb086d74b447cd69e50e1795f42522b13a575ead23a611e753cfe7070812dbdb59a

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+We love pull requests. Here’s a quick guide:
+
+1. Fork the repository.
+2. Make your changes in a topic branch.
+3. Squash your commits into a single one (more on that [here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)).
+4. Rebase against `origin/master`, push to your fork and submit a pull request.
+5. If you are writing a new feature please add documentation for it by making another pull request to the `gh-pages` branch.
+
+At this point you’re waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted:
+
+* Fix a bug, refactor code or expand an existing feature.
+* Use the right syntax and naming conventions.
+* Update parts of the documentation that are affected by your contribution.
+
+**Git Commit Messages**
+
+* Capitalize your commit messages.
+* Start your message with a verb.
+* Use present tense.
+* Refer to the issue/PR number in your squashed commit message.

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2015 [Slate Studio, LLC.](http://slatestudio.com)
+
+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,28 @@
+![Mongosteen](https://slate-git-images.s3-us-west-1.amazonaws.com/mongosteen.png)
+
+# Mongosteen
+
+## 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.
+
+- search
+- pagination
+- scopes
+- json config
+- history
+
+## 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
+
+## Credits
+
+[![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.
+
+## 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

@@ -0,0 +1,3 @@
+# encoding: utf-8
+require "rubygems"
+require "bundler"

data/lib/mongoid/fake_criteria.rb

@@ -0,0 +1,24 @@
+# NOTE: this is required by sorted_relations.rb
+module Mongoid
+  class FakeCriteria
+    def initialize(documents)
+      @documents = documents
+    end
+
+    def limit(quantity)
+      Mongoid::FakeCriteria.new(@documents[0..quantity-1])
+    end
+
+    def raw
+      @documents
+    end
+
+    def as_json(options={})
+      @documents.as_json(options)
+    end
+
+    def method_missing(*args, &block)
+      @documents.send(*args, &block)
+    end
+  end
+end

data/lib/mongoid/serializable_id.rb

@@ -0,0 +1,19 @@
+module Mongoid
+  module SerializableId
+    extend ActiveSupport::Concern
+
+    def serializable_hash(options={})
+      attrs = super(options)
+      attrs.each_pair do |k, v|
+        if k.end_with?('_id')
+          attrs[k] = v.to_s
+        end
+
+        if k.end_with?('_ids')
+          attrs[k] = attrs[k].collect { |id| id.to_s }
+        end
+      end
+      attrs
+    end
+  end
+end

data/lib/mongoid/sorted_relations.rb

@@ -0,0 +1,61 @@
+# NOTE: this is an updated version of mongoid-sorted-relations gem
+#       https://github.com/demarque/mongoid-sorted-relations
+
+# NOTE: the problem is that mongoid returnes object in random order
+#       for relation queries, this patch stores relations ids order
+#       and sort objects using cached order.
+
+module Mongoid
+  module SortedRelations
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :define_sorted_methods
+      after_initialize :cache_relations_ids_order
+      after_save       :cache_relations_ids_order
+    end
+
+    def define_sorted_methods
+      self.relations.each do |key, relation|
+        if [:has_many, :has_and_belongs_to_many].include? relation.macro
+          self.class.send(:define_method, "sorted_#{relation.name}") do
+            sorted_relation(relation)
+          end
+        end
+      end
+    end
+
+    def cache_relations_ids_order
+      @__sorted_relation_criterias = {}
+      @__sorted_relation_ids       = {}
+
+      self.relations.each do |key, relation|
+        if [:has_many, :has_and_belongs_to_many].include? relation.macro
+          relation_ids = self.send(relation.key)
+
+          @__sorted_relation_ids[relation.key] = [ relation_ids ].flatten.map do |rid|
+            rid.to_s
+          end
+        end
+      end
+    end
+
+    def sorted_relation(relation)
+      @__sorted_relation_criterias[relation.name] ||= sorted_related_criteria(relation)
+    end
+
+    def sorted_related_criteria(relation)
+      related_documents = self.send(relation.name)
+
+      sorted_documents = related_documents.sort_by do |x|
+        @__sorted_relation_ids[relation.key].index(x.id.to_s)
+      end
+
+      return Mongoid::FakeCriteria.new(sorted_documents)
+    end
+  end
+end
+
+
+
+

data/lib/mongosteen.rb

@@ -0,0 +1,48 @@
+# CodeKit needs relative paths
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
+
+require 'inherited_resources'
+require 'has_scope'
+require 'kaminari'
+
+module Mongosteen
+  autoload :Actions,         'mongosteen/actions'
+  autoload :ClassMethods,    'mongosteen/class_methods'
+  autoload :BaseHelpers,     'mongosteen/base_helpers'
+  autoload :PermittedParams, 'mongosteen/permitted_params'
+
+  class Engine < ::Rails::Engine
+    require 'mongosteen/engine'
+    require 'mongoid/fake_criteria'
+    require 'mongoid/sorted_relations'
+    require 'mongoid/serializable_id'
+  end
+end
+
+class ActionController::Base
+  # You can call reactor_resources in your controller to have
+  # all the required modules and funcionality included.
+  def self.reactor_resources
+    self.class_eval do
+      inherit_resources
+
+      respond_to :json
+      class_attribute :as_json_config
+
+      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]
+      define_method("#{ instance_name }_params") { params_all_permitted }
+      private "#{ instance_name }_params"
+    end
+  end
+end
+
+
+
+

data/lib/mongosteen/actions.rb

@@ -0,0 +1,37 @@
+module Mongosteen
+  module Actions
+    # GET /resources
+    def index(options={}, &block)
+      super do |success, failure|
+        success.json { render json: get_collection_ivar.as_json(as_json_config) }
+      end
+    end
+
+    # GET /resources/1
+    def show(options={}, &block)
+      super do |success, failure|
+        success.json { render json: get_resource_version.as_json(as_json_config) }
+      end
+    end
+
+    # POST /resources
+    def create(options={}, &block)
+      super do |success, failure|
+        success.json { render json: get_resource_ivar.as_json(as_json_config) }
+        failure.json { render json: get_resource_ivar.errors, status: :unprocessable_entity }
+      end
+    end
+
+    # PUT /resources/1
+    def update(options={}, &block)
+      super do |success, failure|
+        success.json { render json: get_resource_ivar.as_json(as_json_config) }
+        failure.json { render json: get_resource_ivar.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+end
+
+
+
+

data/lib/mongosteen/base_helpers.rb

@@ -0,0 +1,59 @@
+# List of dependencies:
+#  - inherited_resources
+#  - has_scope
+#  - mongoid_search
+#  - kaminari
+#  - mongoid-history
+
+module Mongosteen
+  module BaseHelpers
+    protected
+      # add support for scopes, search and pagination
+      def collection
+        get_collection_ivar || begin
+          chain = end_of_association_chain
+
+          # scopes
+          chain = apply_scopes(chain)
+
+          # search
+          if params[:search]
+            chain = chain.search(params[:search].to_s.downcase, match: :all)
+          end
+
+          # pagination
+          if params[:page]
+            per_page = params[:perPage] || 20
+            chain    = chain.page(params[:page]).per(per_page)
+          else
+            chain = chain.all
+          end
+
+          set_collection_ivar(chain)
+        end
+      end
+
+      # add support for history
+      def get_resource_version
+        resource = get_resource_ivar
+
+        version = params[:version].try(:to_i)
+
+        if version && version > 0 && version < resource.version
+          resource.undo(nil, from: version + 1, to: resource.version)
+          resource.version = version
+        end
+
+        return resource
+      end
+
+      # support for json resource configuration
+      def as_json_config
+        self.class.as_json_config
+      end
+  end
+end
+
+
+
+

data/lib/mongosteen/class_methods.rb

@@ -0,0 +1,7 @@
+module Mongosteen
+  module ClassMethods
+    def json_config(config_hash)
+      self.as_json_config = config_hash
+    end
+  end
+end

data/lib/mongosteen/engine.rb

@@ -0,0 +1,5 @@
+module Mongosteen
+  class Engine < Rails::Engine
+    # auto wire
+  end
+end

data/lib/mongosteen/permitted_params.rb

@@ -0,0 +1,46 @@
+module Mongosteen
+  module PermittedParams
+    # Permits all parameters that are sent, unless `project_params`
+    # (or `smth_else_params`) defined, which is a default Rails
+    # controller method for strong parameters definition.
+    def params_all_permitted
+      permit_fields = []
+
+      params[resource_request_name].each do |key, value|
+        permit_fields << attr_name_or_map(key, value)
+      end
+
+      return params.require(resource_request_name).permit(permit_fields)
+    end
+
+    # Allow all sent in params attributes to be written
+    def attr_name_or_map(attr_name, val)
+      # NOTE: RECURSION is used to map all hashes in params to update nested documents
+      if val.is_a?(Hash)
+        map = {} ; map[attr_name] = []
+
+        if val.first[0] == val.first[0].to_i.to_s # check if key is an integer which means we have an array of nested objects
+
+          #val.each do |nestedObjectKey, nestedObjectValue|
+          #  nestedObjectValue.each { |arr_value_key, arr_value_value| map[attr_name] << attr_name_or_map(arr_value_key, arr_value_value) }
+          #end
+
+          val.first[1].each { |arr_value_key, arr_value_value| map[attr_name] << attr_name_or_map(arr_value_key, arr_value_value) }
+
+        else
+          val.each { |hsh_key, hsh_value| map[attr_name] << attr_name_or_map(hsh_key, hsh_value) }
+        end
+
+        return map
+      elsif val.is_a?(Array)
+        map = {} ; map[attr_name] = []
+        return map
+      else
+        return attr_name
+      end
+    end
+  end
+end
+
+
+

data/lib/mongosteen/version.rb

@@ -0,0 +1,3 @@
+module Mongosteen
+  VERSION = "0.1.0"
+end

data/mongosteen.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'mongosteen/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mongosteen'
+  s.version     = Mongosteen::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Alexander Kravets']
+  s.email       = 'alex@slatestudio.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/slate-studio/mongosteen'
+  s.summary     = 'An easy way to add restful actions'
+  s.description = <<-DESC
+Mongosteen is a library that helps to easily add restful actions to
+mongoid models with support of search, pagination, scopes, history,
+json config.
+  DESC
+
+  s.rubyforge_project = 'mongosteen'
+
+  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
+end
+
+
+
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: mongosteen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Kravets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !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: |
+  Mongosteen is a library that helps to easily add restful actions to
+  mongoid models with support of search, pagination, scopes, history,
+  json config.
+email: alex@slatestudio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/mongoid/fake_criteria.rb
+- lib/mongoid/serializable_id.rb
+- lib/mongoid/sorted_relations.rb
+- lib/mongosteen.rb
+- lib/mongosteen/actions.rb
+- lib/mongosteen/base_helpers.rb
+- lib/mongosteen/class_methods.rb
+- lib/mongosteen/engine.rb
+- lib/mongosteen/permitted_params.rb
+- lib/mongosteen/version.rb
+- mongosteen.gemspec
+homepage: https://github.com/slate-studio/mongosteen
+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: mongosteen
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: An easy way to add restful actions
+test_files: []