RubyGems - openapi-rails - Versions diffs - 0.3.0 - Mend

openapi-rails 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

checksums.yaml +7 -0
data/.gitignore +2 -0
data/Gemfile +3 -0
data/Gemfile.lock +99 -0
data/LICENSE.md +21 -0
data/README.md +61 -0
data/Rakefile +1 -0
data/app/assets/fonts/openapi/DroidSans-Bold.ttf +0 -0
data/app/assets/fonts/openapi/DroidSans.ttf +0 -0
data/app/assets/images/openapi/collapse.gif +0 -0
data/app/assets/images/openapi/expand.gif +0 -0
data/app/assets/images/openapi/explorer_icons.png +0 -0
data/app/assets/images/openapi/favicon-16x16.png +0 -0
data/app/assets/images/openapi/favicon-32x32.png +0 -0
data/app/assets/images/openapi/favicon.ico +0 -0
data/app/assets/images/openapi/logo_small.png +0 -0
data/app/assets/images/openapi/pet_store_api.png +0 -0
data/app/assets/images/openapi/throbber.gif +0 -0
data/app/assets/images/openapi/wordnik_api.png +0 -0
data/app/assets/javascripts/openapi/application.coffee +58 -0
data/app/assets/javascripts/openapi/lib/backbone-min.js +15 -0
data/app/assets/javascripts/openapi/lib/es5-shim.js +2065 -0
data/app/assets/javascripts/openapi/lib/handlebars-4.0.5.js +4608 -0
data/app/assets/javascripts/openapi/lib/highlight.9.1.0.pack.js +2 -0
data/app/assets/javascripts/openapi/lib/highlight.9.1.0.pack_extended.js +34 -0
data/app/assets/javascripts/openapi/lib/jquery-1.8.0.min.js +2 -0
data/app/assets/javascripts/openapi/lib/jquery.ba-bbq.min.js +18 -0
data/app/assets/javascripts/openapi/lib/jquery.slideto.min.js +1 -0
data/app/assets/javascripts/openapi/lib/jquery.wiggle.min.js +8 -0
data/app/assets/javascripts/openapi/lib/js-yaml.min.js +3 -0
data/app/assets/javascripts/openapi/lib/jsoneditor.min.js +11 -0
data/app/assets/javascripts/openapi/lib/lodash.min.js +102 -0
data/app/assets/javascripts/openapi/lib/marked.js +1272 -0
data/app/assets/javascripts/openapi/lib/object-assign-pollyfill.js +23 -0
data/app/assets/javascripts/openapi/lib/swagger-oauth.js +347 -0
data/app/assets/javascripts/openapi/swagger-ui.js +24758 -0
data/app/assets/stylesheets/openapi/application.scss +4 -0
data/app/assets/stylesheets/openapi/print.scss +1367 -0
data/app/assets/stylesheets/openapi/reset.scss +125 -0
data/app/assets/stylesheets/openapi/screen.scss +1497 -0
data/app/assets/stylesheets/openapi/typography.scss +14 -0
data/app/controllers/openapi_controller.rb +24 -0
data/app/views/openapi/index.html.erb +56 -0
data/lib/generators/openapi/config_generator.rb +20 -0
data/lib/generators/openapi/templates/base_controller.rb +6 -0
data/lib/generators/openapi/templates/openapi.rb +21 -0
data/lib/openapi-rails.rb +1 -0
data/lib/openapi.rb +26 -0
data/lib/openapi/configuration.rb +17 -0
data/lib/openapi/engine.rb +32 -0
data/lib/openapi/mongoid/crud_actions.rb +235 -0
data/lib/openapi/mongoid/spec_builder.rb +451 -0
data/lib/openapi/routes_parser.rb +50 -0
data/lib/openapi/version.rb +3 -0
data/lib/rails/routes.rb +20 -0
data/lib/renderers/csv.rb +36 -0
data/lib/swagger/blocks/items_node.rb +7 -0
data/lib/swagger/blocks/property_node.rb +7 -0
data/lib/swagger/blocks/schema_builder.rb +89 -0
data/lib/swagger/blocks/schema_node.rb +7 -0
data/openapi-rails.gemspec +35 -0
metadata +204 -0

data/app/assets/stylesheets/openapi/typography.scss ADDED Viewed

@@ -0,0 +1,14 @@
+/* Google Font's Droid Sans */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 400;
+  src: local('Droid Sans'), local('DroidSans'), font-url('openapi/DroidSans.ttf'), format('truetype');
+}
+/* Google Font's Droid Sans Bold */
+@font-face {
+  font-family: 'Droid Sans';
+  font-style: normal;
+  font-weight: 700;
+  src: local('Droid Sans Bold'), local('DroidSans-Bold'), font-url('openapi/DroidSans-Bold.ttf'), format('truetype');
+}

data/app/controllers/openapi_controller.rb ADDED Viewed

@@ -0,0 +1,24 @@
+class OpenapiController < ActionController::Base
+  respond_to :json
+  def index
+    @specs = Openapi.apis.map do |name, config|
+      title = config[:title]
+      spec_path = "#{config[:base_path]}/spec"
+      [title, spec_path]
+    end
+    @default_specification_path = @specs.first ? @specs.first[1] : ''
+    render 'index', layout: false
+  end
+  def spec
+    name = params[:name] || :default
+    config = Openapi.apis[name]
+    controllers = config[:controllers]
+    json_schema = Swagger::Blocks.build_root_json(controllers)
+    render json: json_schema
+  end
+end

data/app/views/openapi/index.html.erb ADDED Viewed

@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='UTF-8'>
+  <title>OpenAPI</title>
+  <%= favicon_link_tag 'openapi/favicon-32x32.png', rel: 'icon',
+                                                    type: 'image/png',
+                                                    sizes: '32x32' %>
+  <%= favicon_link_tag 'openapi/favicon-16x16.png', rel: 'icon',
+                                                    type: 'image/png',
+                                                    sizes: '16x16' %>
+  <%= stylesheet_link_tag 'openapi/application' %>
+  <%= stylesheet_link_tag 'openapi/reset', media: 'print' %>
+  <%= stylesheet_link_tag 'openapi/print', media: 'print' %>
+  <%= javascript_include_tag 'openapi/application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body class='swagger-section'>
+  <div id='header'>
+    <div class='swagger-ui-wrap'>
+      <%= link_to openapi_path, id: 'logo' do %>
+        <%= image_tag 'openapi/logo_small.png', alt: 'Swagger',
+                                                class: 'logo__img',
+                                                height: 30,
+                                                width: 30 %>
+        <span class='logo__title'>OpenAPI</span></a>
+      <% end %>
+      <form id='api_selector'>
+        <input id='input_baseUrl'
+               name='baseUrl'
+               type='hidden'
+               value='<%= @default_specification_path %>' />
+        <% if @specs.size > 1 %>
+          <div class='input'>
+            <select id='input_spec'>
+              <% @specs.each do |s| %>
+                  <option value='<%= s[1] %>'><%= s[0]%></option>
+              <% end %>
+            </select>
+          </div>
+        <% end %>
+      </form>
+    </div>
+  </div>
+  <div id='message-bar' class='swagger-ui-wrap' data-sw-translate>&nbsp;</div>
+  <div id='swagger-ui-container' class='swagger-ui-wrap'></div>
+</body>
+</html>

data/lib/generators/openapi/config_generator.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Openapi
+  class ConfigGenerator < Rails::Generators::Base
+    desc 'Creates OpenAPI initialization file and Api::BaseController'
+    def self.source_root
+      File.expand_path('../templates', __FILE__)
+    end
+    def create_config_file
+      dest = File.join('config/initializers', 'openapi.rb')
+      template 'openapi.rb', dest
+    end
+    def create_base_controller_file
+      dest = File.join('app/controllers/api', 'base_controller.rb')
+      template 'base_controller.rb', dest
+    end
+  end
+end

data/lib/generators/openapi/templates/base_controller.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module Api
+  class BaseController < ActionController::Base
+    include Openapi::Mongoid::CrudActions
+    include Openapi::Mongoid::SpecBuilder
+  end
+end

data/lib/generators/openapi/templates/openapi.rb ADDED Viewed

@@ -0,0 +1,21 @@
+Openapi.configure do |config|
+  config.apis = {
+    default: {
+      title: 'Default',
+      description: '',
+      version: '1.0',
+      base_path: '/api',
+      controllers: []
+    }
+  }
+end
+module BSON
+  class ObjectId
+    def as_json(*args)
+      to_s
+    end
+    alias :to_json :as_json
+  end
+end

data/lib/openapi-rails.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'openapi'

data/lib/openapi.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require 'bson'
+require 'yajl'
+require 'yajl/json_gem'
+require 'swagger/blocks'
+require 'rails/routes'
+require 'has_scope'
+require 'responders'
+require 'renderers/csv'
+require 'kaminari'
+require 'openapi/mongoid/crud_actions'
+require 'swagger/blocks/schema_builder'
+require 'swagger/blocks/schema_node'
+require 'swagger/blocks/property_node'
+require 'swagger/blocks/items_node'
+require 'openapi/mongoid/spec_builder'
+require 'openapi/configuration'
+require 'openapi/routes_parser'
+require 'openapi/engine'
+require 'openapi/version'
+module Openapi
+  extend Configuration
+end

data/lib/openapi/configuration.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module Openapi
+  module Configuration
+    attr_accessor :apis
+    def configure
+      yield self
+    end
+    def self.extended(base)
+      base.set_default_configuration
+    end
+    def set_default_configuration
+      self.apis = {}
+    end
+  end
+end

data/lib/openapi/engine.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module Openapi
+  class Engine < ::Rails::Engine
+    initializer 'openapi.assets.precompile', group: :all do |app|
+      app.config.assets.precompile += %w(openapi/print.css
+                                         openapi/reset.css
+                                         openapi/logo_small.png
+                                         openapi/favicon-32x32.png
+                                         openapi/favicon-16x16.png)
+    end
+  end
+  class Railtie < Rails::Railtie
+    initializer 'openapi.builders', after: :load_config_initializers do
+      Rails.application.reload_routes!
+      Openapi.apis.each do |name, config|
+        base_path = config[:base_path] || '/api'
+        config[:controllers].each do |controller|
+          controller.build_openapi_specification(base_path: base_path)
+        end
+        name = name.to_s.titleize.remove(' ')
+        root_klass_name = "#{name}SwaggerRootController"
+        klass = Object.const_set root_klass_name, Class.new(SwaggerRoot)
+        klass.build_specification(config, config[:controllers])
+        config[:controllers].push klass
+      end
+    end
+  end
+end

data/lib/openapi/mongoid/crud_actions.rb ADDED Viewed

@@ -0,0 +1,235 @@
+module Openapi
+  module Mongoid
+    module CrudActions
+      extend ActiveSupport::Concern
+      included do
+        respond_to :json
+        respond_to :csv, only: %w(index)
+        class_attribute :resource_class
+        class_attribute :per_page
+        ## Actions
+        def index
+          @chain = default_scope
+          apply_scopes_to_chain!
+          search_filter_chain!
+          paginate_chain!
+          set_index_headers!
+          respond_to do |format|
+            format.json { render json: @chain.as_json(json_config) }
+            format.csv  { render csv: @chain }
+          end
+        end
+        def show
+          @object = find_object
+          set_object_version!
+          render json: @object.as_json(json_config)
+        end
+        def create
+          @object = build_object
+          if @object.save
+            render json: @object.as_json(json_config), status: :created
+          else
+            log_errors @object.errors
+            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)
+          else
+            log_errors @object.errors
+            render json: @object.errors, status: :unprocessable_entity
+          end
+        end
+        def destroy
+          @object = find_object
+          if @object.destroy
+            render nothing: true, status: :no_content
+          else
+            log_errors @object.errors
+            render json: @object.errors, status: :unprocessable_entity
+          end
+        end
+        def response_config
+          config  = {}
+          fields  = params[:fields]
+          methods = params[:methods]
+          if fields
+            only_fields = fields.split(',').select do |field_name|
+              resource_class.fields.has_key?(field_name)
+            end
+            config[:only] = only_fields unless only_fields.empty?
+          end
+          if methods
+            include_methods = methods.split(',').select do |method_name|
+              method = method_name.to_sym
+              resource_class.instance_methods(false).include?(method)
+            end
+            config[:methods] = include_methods unless include_methods.empty?
+          end
+          config
+        end
+        alias csv_config response_config
+        alias json_config response_config
+        ## Helpers
+        def log_errors(errors)
+          if Rails.env.development?
+            logger.info "Errors:\n  #{errors.to_h}"
+          end
+        end
+        def resource_class
+          @resource_class ||= self.class.resource_class
+          @resource_class ||= self.class.
+                                   to_s.
+                                   split('::').
+                                   last.
+                                   sub(/Controller$/, '').
+                                   singularize.
+                                   constantize
+        end
+        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 support_version?
+          @object.respond_to?(:undo, true)
+        end
+        def set_object_version!
+          version = params[:version]
+          if version && support_version? && version.to_i != @object.version
+            @object.undo(nil, from: version.to_i + 1, to: @object.version)
+            @object.version = version
+          end
+        end
+        def apply_scopes_to_chain!
+          @chain = apply_scopes(@chain)
+        end
+        def support_search?
+          @chain.respond_to?(:search, true)
+        end
+        def search_filter_chain!
+          query = params[:search]
+          if query && support_search?
+            normalized_query = query.to_s.downcase
+            @chain = @chain.search(normalized_query, match: :all)
+          end
+        end
+        def page
+          @page ||= params[:page]
+        end
+        def per_page
+          @per_page ||= (params[:perPage] || self.class.per_page || 50)
+        end
+        def paginate_chain!
+          @chain = begin
+            if page
+              @chain.page(page).per(per_page)
+            else
+              @chain.all
+            end
+          end
+        end
+        def set_index_headers!
+          total_objects = page ? @chain.total_count : @chain.size
+          response.headers['X-Total-Count'] = total_objects
+          if page and !@chain.last_page?
+            url = request.url
+            url.gsub!("page=#{page}", "page=#{@chain.next_page}")
+            next_page = "<#{url}>; rel=\"next\""
+            response.headers['Link'] = next_page
+          end
+        end
+        def resource_params
+          permitted_params
+        end
+        # NOTE: here we permit all parameters for ease of development,
+        #       before release this method should be overriden to allow only
+        #       permitted parameters.
+        def permitted_params
+          logger.warn "#{self}: please override `permitted_params` method."
+          params.require(resource_request_name).permit!
+        end
+        def resource_request_name
+          resource_class.
+            to_s.
+            underscore.
+            gsub('/', '_').
+            gsub('::', '_')
+        end
+      end
+      class_methods do
+        def index_json_config(hash)
+          self.index_json_config = hash
+        end
+        def create_json_config(hash)
+          self.create_json_config = hash
+        end
+        def show_json_config(hash)
+          self.show_json_config = hash
+        end
+        def update_json_config(hash)
+          self.update_json_config = hash
+        end
+        def resource_class(name)
+          self.resource_class = name
+        end
+        def per_page(number)
+          self.per_page = number
+        end
+      end
+    end
+  end
+end