mongoid-api-base 0.1.5 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e236b8693fb490d3c2475d1b58cb0405cde34d41
-  data.tar.gz: deb977f256953b5fc3ef07526face05d56cfdff7
+  metadata.gz: 1e92a91674850278d42ca43d2c4dec1425072229
+  data.tar.gz: 44814b2ad35b90e4eba9e709f23550c8906be74c
 SHA512:
-  metadata.gz: 93adb1043fc457cd86787928c7475b47732ee86c6a2ad5f197a5575c06016a61889bdb86bcd76eb522e0298e4ca8611f08c16a2000dff5c695dd169838a8a8b6
-  data.tar.gz: 1b9f5206aeb5e9702f50954a29917743d6dffdf1562a6a8cea8cb4be1b0a0fee890113798661ead3cceead0adaa5b871fa1ed7091beda26e924d3bce8cfa8c64
+  metadata.gz: 7abc8f9633476d5c8cc23e3fa937ddd5c14bdf48fd273599a5aaeba15fafaa45266bf99da3f0f09d3fa6fab072825798d1bd0dc0c461a1e1ad9eb6708f1a2d8e
+  data.tar.gz: e76fff77fbad9db30d6fd63e92eab0c91d637dc39d672d1016ce139b3d32e48d93131589e75b97ec2e8882a9793466c0fb900873b786528367a1d6be8b8193fe

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    mongoid-api-base (0.1.5)
+    mongoid-api-base (0.1.6)
       kaminari
       mongoid (~> 5.0)
+      swagger-blocks
 
 GEM
   remote: http://rubygems.org/
@@ -63,6 +64,7 @@ GEM
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
+    swagger-blocks (1.3.2)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/lib/mongoid-api-base.rb

@@ -1,5 +1,79 @@
-require "csv"
-require "action_controller/metal/renderers"
-require "renderers/csv"
-require "mongoid-api-base/version"
-require "mongoid-api-base/concern"
+# =============================================================================
+# 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)
+#               }
+# -----------------------------------------------------------------------------
+# 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-api-base/actions'
+require 'mongoid-api-base/base_helpers'
+require 'mongoid-api-base/version'
+
+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
+
+    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/mongoid-api-base/actions.rb

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

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

@@ -0,0 +1,115 @@
+# Base helpers for MongoidApiBase work. Some methods here can be overwritten and
+# you will need to do that to customize your controllers.
+module MongoidApiBase
+  module BaseHelpers
+    extend ActiveSupport::Concern
+    included do
+      def find_object
+        resource_class.find(params[:id])
+      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 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] || 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-api-base/version.rb

@@ -1,3 +1,3 @@
 module MongoidApiBase
-  VERSION = "0.1.5"
+  VERSION = '0.1.8'.freeze
 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-api-base.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
   s.platform         = Gem::Platform::RUBY
 
   # Ruby ODM framework for MongoDB
-  s.add_dependency "mongoid", "~> 5.0"
+  s.add_dependency 'mongoid', '~> 5.0'
   # Clean, powerful, customizable and sophisticated paginator
-  s.add_dependency "kaminari"
+  s.add_dependency 'kaminari'
+  # DSL for pure Ruby code blocks that can be turned into JSON
+  s.add_dependency 'swagger-blocks'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-api-base
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.8
 platform: ruby
 authors:
 - Alexander Kravets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !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: []
@@ -52,9 +66,11 @@ files:
 - README.md
 - Rakefile
 - lib/mongoid-api-base.rb
-- lib/mongoid-api-base/concern.rb
+- lib/mongoid-api-base/actions.rb
+- lib/mongoid-api-base/base_helpers.rb
 - lib/mongoid-api-base/version.rb
 - lib/renderers/csv.rb
+- lib/swagger/generator.rb
 - mongoid-api-base.gemspec
 homepage: http://github.com/slate-studio/mongoid-api-base
 licenses:

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

@@ -1,216 +0,0 @@
-# =============================================================================
-# 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: object.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] || 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_methods
-      [ :created_at,
-        :updated_at,
-        :slug,
-        :_position,
-        :_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