rails_api_documentation 0.1.0

data/lib/rails_api_doc/controller/response_factory.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+# :nodoc:
+class RailsApiDoc::Controller::Response
+
+  class << self
+
+    # TODO: add more options later depending on app settings
+    def repo
+      ::RailsApiDoc::Controller::Response::Rabl.new(controllers)
+    end
+
+    def controllers
+      RailsApiDoc::Controller::Parameter::Repository.registered_controllers
+    end
+
+  end
+
+end

data/lib/rails_api_doc/controller/strong_params.rb

@@ -0,0 +1,46 @@
+# author: Vadim Shaveiko <@vshaveyko>
+# frozen_string_literal: true
+module RailsApiDoc::Controller::StrongParams
+
+  def resource_params
+    # accepted_params for permit
+    accepted_params = [{}]
+    loop_params(params, permitted_params, accepted_params)
+    params.permit(accepted_params)
+  end
+
+  private
+
+  # loop through current level of params and add to permit level if
+  # all requirements met
+  # requirements are: 1) if required is set - param must be present and not empty
+  #                   2) if enum is set - param must equal predefined value
+  #                   3) if config.check_params_type is set - param must be of required type
+  # @accepted_params = [{}] - array with last member hash for nesting
+  # @level_params - current nesting level params
+  # @level_permitted_params - data for params permission
+  def loop_params(nested_controller_params, level_permitted_params, accepted_params)
+    level_permitted_params.each do |param_name, api_param_data|
+      controller_param = nested_controller_params[param_name]
+
+      next unless RailsApiDoc::Config::Validator.valid_param?(controller_param, api_param_data)
+
+      if api_param_data.nested?
+        level_accepted_params = accepted_params.last[param_name] = [{}]
+        next loop_params(controller_param, api_param_data, level_accepted_params)
+      else
+        accepted_params.unshift(param_name)
+      end
+    end
+  end
+
+  def permitted_params
+    Parameter::Repository[self]
+  end
+
+  def check_required_ok?(param_data, param_config)
+    return true unless param_config.required?
+    !param_data.blank?
+  end
+
+end

data/lib/rails_api_doc/controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+module RailsApiDoc
+  module Controller
+  end
+end

data/lib/rails_api_doc/engine.rb

@@ -0,0 +1,40 @@
+# author: Vadism Shaveiko <@vshaveyko>
+# frozen_string_literal: true
+require 'action_controller'
+require 'action_view'
+require 'jquery-rails'
+require 'slim'
+
+require_relative 'types'
+require_relative 'controller'
+require_relative 'controller/strong_params'
+require_relative 'controller/attribute_parser'
+require_relative 'controller/parameter'
+require_relative 'controller/parameter/repository'
+require_relative 'controller/parameter/repository/param'
+
+require_relative 'controller/response_factory'
+
+# add rabl support
+begin
+  require 'rabl'
+  require_relative 'controller/response/rabl'
+  require_relative 'controller/response/rabl_compiler'
+  RailsApiDoc::Controller::Response::Rabl.renderer = Rabl::Renderer
+rescue LoadError
+end
+
+class RailsApiDoc::Engine < ::Rails::Engine
+
+  isolate_namespace RailsApiDoc
+
+  initializer 'rails_api_doc.assets.precompile' do |app|
+    app.config.assets.precompile += %w(application.css application.js api_doc.js rails_api_doc/api_doc.js)
+  end
+
+  ActionController::Base.class_eval do
+    include RailsApiDoc::Controller::StrongParams
+    extend RailsApiDoc::Controller::Parameter
+  end
+
+end

data/lib/rails_api_doc/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+class RailsApiDoc::Types
+
+  ACCEPTED_TYPES = [String, Integer, Object, Array, :enum].freeze
+
+end

data/lib/rails_api_doc/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+module RailsApiDoc
+  VERSION = '0.1.0'
+end

data/lib/rails_api_doc.rb

@@ -0,0 +1,26 @@
+# author: Vadim Shaveiko <@vshaveyko>
+# frozen_string_literal: true
+require 'rails_api_doc/engine'
+module RailsApiDoc
+
+  extend ActiveSupport::Autoload
+
+  class << self
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+
+    def reset_configuration
+      @_configuration = nil
+    end
+
+  end
+
+  autoload :Controller
+
+end

data/lib/tasks/rails_api_doc_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_api_doc do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_documentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: jquery-rails
+  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: sass-rails
+  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: coffee-rails
+  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: slim
+  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: Document and view nice API docs.
+email:
+- vshaveyko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/assets/config/rails_api_doc_manifest.js
+- app/assets/javascripts/api_doc.js
+- app/assets/javascripts/components.js
+- app/assets/javascripts/rails_api_doc/application.js
+- app/assets/javascripts/table.js.coffee
+- app/assets/stylesheets/rails_api_doc/application.css
+- app/assets/stylesheets/rails_api_doc/table.sass
+- app/controllers/rails_api_doc/api_docs_controller.rb
+- app/controllers/rails_api_doc/application_controller.rb
+- app/helpers/rails_api_doc/application_helper.rb
+- app/models/rails_api_doc/application_record.rb
+- app/views/layouts/rails_api_doc/application.slim
+- app/views/rails_api_doc/api_docs/_edit_field.slim
+- app/views/rails_api_doc/api_docs/_request_api_table.slim
+- app/views/rails_api_doc/api_docs/_response_api_table.slim
+- app/views/rails_api_doc/api_docs/_side_menu.slim
+- app/views/rails_api_doc/api_docs/_title.slim
+- app/views/rails_api_doc/api_docs/edit.js.erb
+- app/views/rails_api_doc/api_docs/example.html.erb
+- app/views/rails_api_doc/api_docs/index.slim
+- app/views/rails_api_doc/api_docs/new.js.erb
+- app/views/shared/_response_table.slim
+- app/views/shared/_table.slim
+- config/routes.rb
+- lib/rails_api_doc.rb
+- lib/rails_api_doc/config/validator.rb
+- lib/rails_api_doc/configuration.rb
+- lib/rails_api_doc/controller.rb
+- lib/rails_api_doc/controller/attribute_parser.rb
+- lib/rails_api_doc/controller/parameter.rb
+- lib/rails_api_doc/controller/parameter/repository.rb
+- lib/rails_api_doc/controller/parameter/repository/param.rb
+- lib/rails_api_doc/controller/response/rabl.rb
+- lib/rails_api_doc/controller/response/rabl_compiler.rb
+- lib/rails_api_doc/controller/response_factory.rb
+- lib/rails_api_doc/controller/strong_params.rb
+- lib/rails_api_doc/engine.rb
+- lib/rails_api_doc/types.rb
+- lib/rails_api_doc/version.rb
+- lib/tasks/rails_api_doc_tasks.rake
+homepage: https://github.com/vshaveyko/rails_api_doc
+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: Nice API doc.
+test_files: []