mongoid-openapi 0.1.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 129684a841b9fb21f50cf4aa28266990c8126d84
+  data.tar.gz: 65fc9692a3899fffcdc399e133209a8fb7354471
+SHA512:
+  metadata.gz: aa1f46c0515f44063d2825b44bd355f84f4fd9087fb9592b296fb4a0438816888e68f8a8cb8bd20cab599ae3a9c2774e452bc202dc696494f5599f1a03ed052a
+  data.tar.gz: 8974002b66c31436ce42deb3bb1f72751b075e00bdb9dfd34416bfb4b0621e19e5c34b142d9a133d3e29dadd5c35485d9b7c65fab2bf29768dab1151bb310293

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,5 @@
+# Mongoid OpenAPI
+
+Rails concern to implement CRUD API controllers for
+[Mongoid](https://github.com/mongodb/mongoid) models using Open API
+([Swagger](http://swagger.io/)) specification.

data/Rakefile

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

data/lib/mongoid-openapi/actions.rb

@@ -0,0 +1,54 @@
+# Holds all default actions for MongoidOpenApi.
+module MongoidOpenApi
+  module Actions
+    extend ActiveSupport::Concern
+    included do
+      def index
+        @chain = default_scope
+
+        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, status: 204
+        else
+          render json: object.errors, status: :unprocessable_entity
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-openapi/base_helpers.rb

@@ -0,0 +1,119 @@
+# Base helpers for MongoidOpenApi work. Some methods here can be overwritten and
+# you will need to do that to customize your controllers.
+module MongoidOpenApi
+  module BaseHelpers
+    extend ActiveSupport::Concern
+    included do
+      def default_scope
+        resource_class
+      end
+
+      def find_object
+        resource_class.find(params[:id])
+      end
+
+      def build_object
+        resource_class.new(resource_params)
+      end
+
+      def get_object_version(object)
+        version = params[:version]
+        if object.respond_to?(:undo, true)
+          if version && version.to_i != object.version
+            object.undo(nil, from: version.to_i + 1, to: object.version)
+            object.version = version
+          end
+        end
+        object
+      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] || false
+      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_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_ATTRIBUTES).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_ATTRIBUTES).uniq!
+          json_options
+        else
+          json_default_options
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-openapi/version.rb

@@ -0,0 +1,3 @@
+module MongoidOpenApi
+  VERSION = '0.1.10'.freeze
+end

data/lib/mongoid-openapi.rb

@@ -0,0 +1,79 @@
+# =============================================================================
+# MongoidOpenApi
+# 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)
+#               }
+# -----------------------------------------------------------------------------
+# Some more ideas for future improvements can be pulled from here:
+#  - https://github.com/jamesgolick/resource_controller
+# =============================================================================
+
+require 'kaminari'
+require 'csv'
+require 'action_controller/metal/renderers'
+require 'renderers/csv'
+require 'swagger/blocks'
+require 'swagger/generator'
+require 'mongoid-openapi/actions'
+require 'mongoid-openapi/base_helpers'
+require 'mongoid-openapi/version'
+
+module MongoidOpenApi
+  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
+
+    JSON_DEFAULT_ATTRIBUTES = [ :created_at,
+                                :updated_at,
+                                :slug,
+                                :_position,
+                                :_list_item_title,
+                                :_list_item_subtitle,
+                                :_list_item_thumbnail,
+                                :_document_versions ].freeze
+
+    include Actions
+    include BaseHelpers
+  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.per_page = 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/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/lib/swagger/generator.rb

@@ -0,0 +1,182 @@
+# EXTRA LINKS:
+# - https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
+# - https://github.com/fotinakis/swagger-blocks
+# - https://github.com/westfieldlabs/apivore
+# - https://github.com/notonthehighstreet/svelte
+
+module SwaggerGenerator
+  extend ActiveSupport::Concern
+
+  included do
+    include Swagger::Blocks
+  end
+
+  class_methods do
+    REJECT_NAMES = %w(_id _keywords created_at updated_at).freeze
+    ALLOW_TYPES  = %w(Object String)
+
+    def generate_swagger
+      generate_swagger_schemas
+      generate_swagger_paths
+    end
+
+    def collection_name
+      @collection_name ||= to_s.split("::").last.sub(/Controller$/, '')
+    end
+
+    def resource_name
+      @resource_name ||= collection_name.singularize
+    end
+
+    def generate_swagger_schemas
+      name = resource_name
+
+      if resource_class
+        # TODO: add support for resource class option
+      else
+        resource_class = name.constantize
+      end
+
+      swagger_schema name do
+        # TODO: autogenerate list of required fields
+        # key :required, %w(name email)
+
+        resource_class.fields.each do |name, options|
+          type = options.type.to_s
+          if ALLOW_TYPES.include? type
+            unless REJECT_NAMES.include? name
+              property name do
+                key :type, :string
+                # TODO: autodetect property type
+                # key :format, 'date-time'
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def generate_swagger_paths
+      name   = resource_name
+      plural = collection_name
+      path   = plural.underscore
+      tags   = [ plural ]
+
+      swagger_path "/#{ path }" do
+        operation :get do
+          key :tags, tags
+          key :operationId, "index#{ plural }"
+          key :produces, %w(application/json text/csv)
+
+          parameter do
+            key :name,     :page
+            key :in,       :query
+            key :required, false
+            key :type,     :integer
+            key :format,   :int32
+          end
+
+          parameter do
+            key :name,     :perPage
+            key :in,       :query
+            key :required, false
+            key :type,     :integer
+            key :format,   :int32
+          end
+
+          parameter do
+            key :name,     :search
+            key :in,       :query
+            key :required, false
+            key :type,     :string
+          end
+
+          response 200 do
+            schema type: :array do
+              items do
+                key :'$ref', name
+              end
+            end
+          end
+        end
+
+        operation :post do
+          key :tags, tags
+          key :operationId, "create#{ plural }"
+          key :produces,    %w(application/json)
+          parameter do
+            key :name,     name.underscore.to_sym
+            key :in,       :form
+            key :required, true
+            schema do
+              key :'$ref', name # input
+            end
+          end
+          response 200 do
+            schema do
+              key :'$ref', name
+            end
+          end
+        end
+      end
+
+      swagger_path "/#{ path }/{id}" do
+        operation :get do
+          key :tags, tags
+          key :operationId, "show#{ name }ById"
+          key :produces,    %w(application/json)
+          parameter do
+            key :name,     :id
+            key :in,       :path
+            key :required, true
+            key :type,     :string
+          end
+          response 200 do
+            schema do
+              key :'$ref', name
+            end
+          end
+        end
+
+        operation :put do
+          key :tags, tags
+          key :operationId, "update#{ name }"
+          key :produces,    %w(application/json)
+          parameter do
+            key :name,     :id
+            key :in,       :path
+            key :required, true
+            key :type,     :string
+          end
+          parameter do
+            key :name,     name.underscore.to_sym
+            key :in,       :form
+            key :required, true
+            schema do
+              key :'$ref', name # input
+            end
+          end
+          response 200 do
+            schema do
+              key :'$ref', name
+            end
+          end
+        end
+
+        operation :delete do
+          key :tags, tags
+          key :operationId, "delete#{ name }"
+          parameter do
+            key :name,     :id
+            key :in,       :path
+            key :required, true
+            key :type,     :string
+          end
+          response 204 do
+            key :description, "#{ name } deleted"
+          end
+        end
+      end
+    end
+  end
+end

data/mongoid-openapi.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid-openapi/version"
+require "date"
+
+Gem::Specification.new do |s|
+  s.name             = "mongoid-openapi"
+  s.summary          = "Rails concern to implement API controllers for Mongoid models using Open API specification."
+  s.homepage         = "http://github.com/slate-studio/mongoid-openapi"
+  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          = MongoidOpenApi::VERSION
+  s.platform         = Gem::Platform::RUBY
+
+  # Ruby ODM framework for MongoDB
+  s.add_dependency 'mongoid', '~> 5.0'
+  # Clean, powerful, customizable and sophisticated paginator
+  s.add_dependency 'kaminari'
+  # DSL for pure Ruby code blocks that can be turned into JSON
+  s.add_dependency 'swagger-blocks'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-openapi
+version: !ruby/object:Gem::Version
+  version: 0.1.10
+platform: ruby
+authors:
+- Alexander Kravets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: swagger-blocks
+  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-openapi.rb
+- lib/mongoid-openapi/actions.rb
+- lib/mongoid-openapi/base_helpers.rb
+- lib/mongoid-openapi/version.rb
+- lib/renderers/csv.rb
+- lib/swagger/generator.rb
+- mongoid-openapi.gemspec
+homepage: http://github.com/slate-studio/mongoid-openapi
+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 using Open
+  API specification.
+test_files: []