openapi-rails 0.3.0

data/lib/openapi/version.rb

@@ -0,0 +1,3 @@
+module Openapi
+  VERSION = '0.3.0'.freeze
+end

data/lib/rails/routes.rb

@@ -0,0 +1,20 @@
+module ActionDispatch
+  module Routing
+    class Mapper
+      def crud(*options, &block)
+        options << { except: %w(new edit), defaults: { format: :json } }
+        resources(*options, &block)
+      end
+
+      def mount_openapi_documentation
+        get :openapi, to: 'openapi#index'
+      end
+
+      def mount_openapi_specification(options={})
+        name = options[:name] || :default
+        get :spec, to: '/openapi#spec',
+                   defaults: { format: :json, name: name }
+      end
+    end
+  end
+end

data/lib/renderers/csv.rb

@@ -0,0 +1,36 @@
+require 'csv'
+require 'action_controller/metal/renderers'
+
+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.csv_config || {}
+
+  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/blocks/items_node.rb

@@ -0,0 +1,7 @@
+module Swagger
+  module Blocks
+    class ItemsNode
+      include SchemaBuilder
+    end
+  end
+end

data/lib/swagger/blocks/property_node.rb

@@ -0,0 +1,7 @@
+module Swagger
+  module Blocks
+    class PropertyNode
+      include SchemaBuilder
+    end
+  end
+end

data/lib/swagger/blocks/schema_builder.rb

@@ -0,0 +1,89 @@
+module Swagger
+  module Blocks
+    module SchemaBuilder
+      extend ActiveSupport::Concern
+
+      SUPPORTED_TYPES = %w(Mongoid::Boolean
+                           BSON::ObjectId
+                           Object
+                           Time
+                           String
+                           Integer
+                           Array
+                           Date
+                           Symbol).freeze
+
+      def get_required_fields(model_class)
+        presence_validators = model_class.
+          validators.
+          select { |v| v.class == Mongoid::Validatable::PresenceValidator }
+
+        required_fields = presence_validators.map { |v| v.attributes.first }
+        required_fields << '_id'
+        required_fields
+      end
+
+      def build_model_schema(model_class, include_only_required_fields=false)
+        required_fields = get_required_fields(model_class)
+
+        key :required, required_fields
+
+        model_class.fields.each do |name, options|
+          type = options.type.to_s
+          defaul_value = options.options[:default]
+
+          next unless SUPPORTED_TYPES.include?(type)
+
+          if include_only_required_fields
+            next if name == '_id'
+            next unless required_fields.include?(name.to_sym)
+          end
+
+          property name do
+            case type
+            when 'Symbol'
+              klass = options.options[:klass].to_s
+              constant = name.sub('_', '').upcase
+              values = "#{klass}::#{constant}".constantize
+
+              key :type, :string
+              key :enum, values
+
+            when 'Array'
+              key :type, :array
+              # TODO: autodetect type of Array Item
+              items do
+                key :type, :string
+              end
+
+            when 'BSON::ObjectId'
+              key :type, :string
+              key :format, :uuid
+
+            when 'Date'
+              key :type, :string
+              key :format, :date
+
+            when 'Time'
+              key :type, :string
+              key :format, 'date-time'
+
+            when 'Mongoid::Boolean'
+              key :type, :boolean
+              key :default, defaul_value
+
+            when 'Integer'
+              key :type, :integer
+              key :default, defaul_value.to_i
+
+            else
+              key :type, :string
+              key :default, defaul_value.to_s
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/blocks/schema_node.rb

@@ -0,0 +1,7 @@
+module Swagger
+  module Blocks
+    class SchemaNode
+      include SchemaBuilder
+    end
+  end
+end

data/openapi-rails.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'openapi/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name             = 'openapi-rails'
+  s.summary          = 'CRUD interface for Rails models with OpenAPI (Swagger) specification support and Swagger UI integration.'
+  s.homepage         = 'http://github.com/slate-studio/openapi-rails'
+  s.authors          = [ 'Alexander Kravets', 'Denis Popov' ]
+  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          = Openapi::VERSION
+  s.platform         = Gem::Platform::RUBY
+
+  # DSL for pure Ruby code blocks that can be turned into JSON
+  s.add_dependency 'swagger-blocks'
+  # A set of Rails responders to dry up application controllers
+  s.add_dependency 'responders', '~> 2.3'
+  # Clean, powerful, customizable and sophisticated paginator
+  s.add_dependency 'kaminari'
+  # C extensions to accelerate the Ruby BSON serialization
+  s.add_dependency 'bson_ext'
+  # Fast streaming JSON parsing and encoding library for Ruby
+  s.add_dependency 'yajl-ruby'
+  # Ruby ODM framework for MongoDB
+  s.add_dependency 'mongoid'
+  # Map incoming controller parameters to named scopes in resources
+  s.add_dependency 'has_scope'
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: openapi-rails
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Alexander Kravets
+- Denis Popov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-30 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !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: bson_ext
+  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: yajl-ruby
+  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: mongoid
+  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: has_scope
+  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
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/fonts/openapi/DroidSans-Bold.ttf
+- app/assets/fonts/openapi/DroidSans.ttf
+- app/assets/images/openapi/collapse.gif
+- app/assets/images/openapi/expand.gif
+- app/assets/images/openapi/explorer_icons.png
+- app/assets/images/openapi/favicon-16x16.png
+- app/assets/images/openapi/favicon-32x32.png
+- app/assets/images/openapi/favicon.ico
+- app/assets/images/openapi/logo_small.png
+- app/assets/images/openapi/pet_store_api.png
+- app/assets/images/openapi/throbber.gif
+- app/assets/images/openapi/wordnik_api.png
+- app/assets/javascripts/openapi/application.coffee
+- app/assets/javascripts/openapi/lib/backbone-min.js
+- app/assets/javascripts/openapi/lib/es5-shim.js
+- app/assets/javascripts/openapi/lib/handlebars-4.0.5.js
+- app/assets/javascripts/openapi/lib/highlight.9.1.0.pack.js
+- app/assets/javascripts/openapi/lib/highlight.9.1.0.pack_extended.js
+- app/assets/javascripts/openapi/lib/jquery-1.8.0.min.js
+- app/assets/javascripts/openapi/lib/jquery.ba-bbq.min.js
+- app/assets/javascripts/openapi/lib/jquery.slideto.min.js
+- app/assets/javascripts/openapi/lib/jquery.wiggle.min.js
+- app/assets/javascripts/openapi/lib/js-yaml.min.js
+- app/assets/javascripts/openapi/lib/jsoneditor.min.js
+- app/assets/javascripts/openapi/lib/lodash.min.js
+- app/assets/javascripts/openapi/lib/marked.js
+- app/assets/javascripts/openapi/lib/object-assign-pollyfill.js
+- app/assets/javascripts/openapi/lib/swagger-oauth.js
+- app/assets/javascripts/openapi/swagger-ui.js
+- app/assets/stylesheets/openapi/application.scss
+- app/assets/stylesheets/openapi/print.scss
+- app/assets/stylesheets/openapi/reset.scss
+- app/assets/stylesheets/openapi/screen.scss
+- app/assets/stylesheets/openapi/typography.scss
+- app/controllers/openapi_controller.rb
+- app/views/openapi/index.html.erb
+- lib/generators/openapi/config_generator.rb
+- lib/generators/openapi/templates/base_controller.rb
+- lib/generators/openapi/templates/openapi.rb
+- lib/openapi-rails.rb
+- lib/openapi.rb
+- lib/openapi/configuration.rb
+- lib/openapi/engine.rb
+- lib/openapi/mongoid/crud_actions.rb
+- lib/openapi/mongoid/spec_builder.rb
+- lib/openapi/routes_parser.rb
+- lib/openapi/version.rb
+- lib/rails/routes.rb
+- lib/renderers/csv.rb
+- lib/swagger/blocks/items_node.rb
+- lib/swagger/blocks/property_node.rb
+- lib/swagger/blocks/schema_builder.rb
+- lib/swagger/blocks/schema_node.rb
+- openapi-rails.gemspec
+homepage: http://github.com/slate-studio/openapi-rails
+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: CRUD interface for Rails models with OpenAPI (Swagger) specification support
+  and Swagger UI integration.
+test_files: []