mongoid-api-base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23d0d53d8ecc497b0c2ba2f314e26a2e35685723
+  data.tar.gz: 2882a8c75adb182a8c9f773dfe2c2addda7bacad
+SHA512:
+  metadata.gz: 0c6c6cf1fa3960b32e46b6a1e5e87fcc8c8f2040349ca7f90ee79355db5bbce8fbc428d655b4b61d28af2294ab9d15619d07d8d19701023f7c96b1595c63c62f
+  data.tar.gz: d22e667ddc134a8a8259cae55df527fe61160c02080b94d71afcc9bbad732df1757f01c9ffbc37341d110b33f2c17e53478c6b5c230f8b5890199af46d57a765

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_store
+pkg

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2016 [Slate Studio](https://www.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,4 @@
+# Mongoid API Base
+
+Rails concern to implement API controllers for Mongoid models.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid-api-base.rb

@@ -0,0 +1,5 @@
+require "csv"
+require "action_controller/metal/renderers"
+require "renderers/csv"
+require "mongoid-api-base/version"
+require "mongoid-api-base/concern"

data/lib/mongoid-api-base/concern.rb

@@ -0,0 +1,212 @@
+# =============================================================================
+# MongoidApiBase
+# Rails concern to implement API controllers for Mongoid models.
+# -----------------------------------------------------------------------------
+# Usage Example:
+#
+#   include MongoidApiBase
+#
+#   defaults resource_class: Journal::JournalPost,
+#            per_page: 30
+#
+#   has_scope :by_category
+#   has_scope :hidden,     type: :boolean
+#   has_scope :not_hidden, type: :boolean
+#
+#   json_config methods: %w(hex slug sorted_categories opengraph_image_url meta_title meta_description),
+#               index: {
+#                 except:  %w(body_markdown body_html),
+#                 methods: %w(hex slug)
+#               }
+# =============================================================================
+module MongoidApiBase
+  extend ActiveSupport::Concern
+  included do
+    respond_to :json
+    respond_to :csv, only: %w(index)
+
+    class_attribute :resource_class
+    class_attribute :per_page
+    class_attribute :csv_options
+    class_attribute :json_options
+
+    def index
+      @chain = resource_class
+
+      apply_scopes_to_chain!
+      search_filter_chain!
+      paginate_chain!
+      set_total_count_header!
+
+      respond_to do |format|
+        format.json { render json: @chain.as_json(json_config(:index)) }
+        format.csv { render csv: @chain }
+      end
+    end
+
+    def show
+      object = find_object
+      object = get_object_version(object)
+      render json: object.as_json(json_config(:show))
+    end
+
+    def create
+      object = build_object
+      if object.save
+        render json: object.as_json(json_config(:create))
+      else
+        render json: object.errors, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      object = find_object
+      if object.update_attributes(resource_params)
+        render json: object.as_json(json_config(:update))
+      else
+        render json: object.errors, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      object = find_object
+      if object.destroy
+        render nothing: true
+      else
+        render json: object.errors, status: :unprocessable_entity
+      end
+    end
+
+    def find_object
+      resource_class.find(params[:id])
+    end
+
+    def get_object_version(object)
+      version = params[:version]
+      if version && object.respond_to?(:undo, true)
+        object.undo(nil, from: version.to_i + 1, to: resource.version)
+        object.version = version
+      end
+      object
+    end
+
+    def build_object
+      resource_class.new(resource_params)
+    end
+
+    def apply_scopes_to_chain!
+      if respond_to?(:apply_scopes, true)
+        @chain = apply_scopes(@chain)
+      end
+    end
+
+    def search_filter_chain!
+      query = params[:search]
+      if query
+        normalized_query = query.to_s.downcase
+        @chain = @chain.search(normalized_query, match: :all)
+      end
+    end
+
+    def page
+      @page ||= params[:page] || 1
+    end
+
+    def per_page
+      @per_page ||= params[:perPage] || self.class.per_page || 20
+    end
+
+    def paginate_chain!
+      @chain = begin
+        if page
+          @chain.page(page).per(per_page)
+        else
+          @chain.all
+        end
+      end
+    end
+
+    def set_total_count_header!
+      if page
+        response.headers['X-Total-Count'] = @chain.total_count
+      else
+        response.headers['X-Total-Count'] = @chain.size
+      end
+    end
+
+    def resource_class
+      @resource_class ||= self.class.resource_class
+      @resource_class ||= begin
+        namespaced_class = self.class.to_s.split("::").last.
+                                sub(/Controller$/, "").singularize
+        namespaced_class.constantize
+      end
+    end
+
+    def resource_request_name
+      resource_class.to_s.underscore.gsub("/", "_").gsub("::", "_")
+    end
+
+    def resource_params
+      permitted_params
+    end
+
+    def permitted_params
+      params.require(resource_request_name).permit!
+    end
+
+    def json_default_methods
+      [ :_list_item_title,
+        :_list_item_subtitle,
+        :_list_item_thumbnail,
+        :_document_versions ]
+    end
+
+    def json_default_options
+      @json_default_options ||= begin
+        default_options = {}
+        json_options = self.class.json_options || {}
+        [:only, :except, :methods].each do |name|
+          if json_options.key? name
+            default_options[name] = json_options[name]
+          end
+        end
+        default_options[:methods] ||= []
+        default_options[:methods].concat(json_default_methods).uniq!
+        default_options
+      end
+    end
+
+    def json_config(action)
+      json_options = self.class.json_options
+      if json_options && json_options.key?(action)
+        json_options = json_options[action]
+        json_options[:methods] ||= []
+        json_options[:methods].concat(json_default_methods).uniq!
+        json_options
+      else
+        json_default_options
+      end
+    end
+  end
+
+  class_methods do
+    def defaults(options)
+      if options.key?(:resource_class)
+        self.resource_class = options[:resource_class]
+      end
+
+      if options.key?(:per_page)
+        self.resource_class = options[:per_page]
+      end
+    end
+
+    def csv_config(options={})
+      self.csv_options = options
+    end
+
+    def json_config(options)
+      self.json_options = options
+    end
+  end
+end

data/lib/mongoid-api-base/version.rb

@@ -0,0 +1,4 @@
+module MongoidApiBase
+  RAILS_VERSION = "~> 4.2.5.1"
+  VERSION = "0.1.0"
+end

data/lib/renderers/csv.rb

@@ -0,0 +1,33 @@
+ActionController::Renderers.add :csv do |objects, options|
+  return "" unless objects.first
+
+  object_klass = objects.first.class
+
+  return "" unless object_klass.respond_to? :fields
+
+  columns = object_klass.fields.keys
+  csv_options = self.class.csv_options || {}
+
+  if csv_options
+    if csv_options.key?(:only)
+      columns &= csv_options[:only].map(&:to_s)
+    end
+
+    if csv_options.key?(:except)
+      columns -= csv_options[:except].map(&:to_s)
+    end
+
+    if csv_options.key?(:methods)
+      columns += csv_options[:methods].map(&:to_s)
+    end
+  end
+
+  str = CSV.generate do |row|
+    row << columns
+    objects.each do |obj|
+      row << columns.map { |c| obj.send(c) }
+    end
+  end
+
+  return str
+end

data/mongoid-api-base.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid-api-base/version"
+require "date"
+
+Gem::Specification.new do |s|
+  s.name             = "mongoid-api-base"
+  s.summary          = "Rails concern to implement API controllers for Mongoid models."
+  s.homepage         = "http://github.com/slate-studio/mongoid-api-base"
+  s.authors          = [ "Alexander Kravets" ]
+  s.email            = "alex@slatestudio.com"
+  s.date             = Date.today.strftime("%Y-%m-%d")
+  s.extra_rdoc_files = %w[ README.md ]
+  s.license          = "MIT"
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths    = [ "lib" ]
+  s.version          = MongoidApiBase::VERSION
+  s.platform         = Gem::Platform::RUBY
+
+  s.add_dependency "rails", MongoidApiBase::RAILS_VERSION
+  # Ruby ODM framework for MongoDB
+  s.add_dependency "mongoid", "~> 5.0"
+  # Clean, powerful, customizable and sophisticated paginator
+  s.add_dependency "kaminari"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-api-base
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Kravets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.5.1
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: alex@slatestudio.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/mongoid-api-base.rb
+- lib/mongoid-api-base/concern.rb
+- lib/mongoid-api-base/version.rb
+- lib/renderers/csv.rb
+- mongoid-api-base.gemspec
+homepage: http://github.com/slate-studio/mongoid-api-base
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails concern to implement API controllers for Mongoid models.
+test_files: []