api_doc_server 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d153ce9988919aa20da7fead9e36657a14311387
+  data.tar.gz: 02bd746a5e8697e37abe58d217305ca2414d07df
+SHA512:
+  metadata.gz: 43a99eb1c040c5106afc36363183927b28c6254179bc3ec6be7de34d39077197774df6e18e41a1709de322f5a408f3a1350e88987ca3c1377be8b4f7123a43f5
+  data.tar.gz: c2122e5452de3df800716fb884c9443aff9944960e767159e200facf44c9fd631c9bb29b1a8d6ae2b07b0198c534563d04371c388c2fae14220685fe00d13cde

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+---
+engines:
+  brakeman:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  eslint:
+    enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.erb"
+  - "**.haml"
+  - "**.rb"
+  - "**.rhtml"
+  - "**.slim"
+  - "**.css"
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+exclude_paths:
+- config/
+- test/
+- app/assets

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+test/dummy/tmp/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+api_doc_server-*.gem
+Gemfile.lock
+test/dummy/log/test.log
+node_modules/

data/.rubocop.yml

@@ -0,0 +1,194 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - !ruby/regexp /(vendor|bundle|bin|db)\/.*/
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
+  TargetRailsVersion: 4.2
+  # https://github.com/bbatsov/rubocop/blob/master/manual/caching.md
+  # https://github.com/bbatsov/rubocop/blob/e8680418b351491e111a18cf5b453fc07a3c5239/config/default.yml#L60-L77
+  UseCache: true
+  CacheRootDirectory: tmp
+
+Rails:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+# Rubocop options don't align with code-style, which allows alias.
+# https://github.com/bbatsov/ruby-style-guide/pull/383
+# https://github.com/bbatsov/rubocop/issues/1460
+# see https://github.com/bbatsov/ruby-style-guide#alias-method-lexically
+# vs. https://github.com/bbatsov/ruby-style-guide#alias-method
+Style/Alias:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# SupportedStyles: line_count_based, semantic, braces_for_chaining
+Style/BlockDelimiters:
+  Enabled: true
+  EnforcedStyle: line_count_based
+
+Style/MissingElse:
+  Enabled: true
+  EnforcedStyle: case
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+Lint/BlockAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: either
+
+Lint/EndAlignment:
+  Enabled: true
+
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/StringLiterals:
+  # EnforcedStyle: single_quotes
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  # EnforcedStyle: single_quotes
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  # AllowSafeAssignment: true
+  # accepts = in condition surrounded with braces, e.g. if (test = 10)
+  # accepts []= in condition surrounded with braces, e.g. if (test[0] = 10)
+  Enabled: true
+
+Style/VariableNumber:
+  Enabled: false
+
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+Rails/Blank:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/SpaceInLambdaLiteral:
+  EnforcedStyle: require_no_space
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+  Enabled: true
+
+Layout/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/IndentationWidth:
+  Width: 2
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: special_for_inner_method_call_in_parentheses
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterNot:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  # EnforcedStyle: space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  # Space between { and |. Overrides EnforcedStyle if there is a conflict.
+  SpaceBeforeBlockParameters: true
+
+Layout/SpaceInsideBrackets:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.2.2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# ApiDocServer Changelog
+
+## master
+
+## 1.0
+
+- Use ReDoc 1.19.1 (not SwaggerUI)
+- Run tests in random order
+- Support Rails 4.2
+- Rename SwaggeUiEngine to ApiDocServer

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Zuzanna Stolińska
+
+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,96 @@
+# ApiDocServer
+
+Include [redoc](https://github.com/Rebilly/ReDoc) as Rails engine and document your API with simple YAML files. Supports API documentation versioning.
+
+## Installation
+
+Add to Gemfile
+
+```
+gem 'api_doc_server'
+```
+
+And then run:
+
+```
+$ bundle
+```
+
+## Usage
+
+### Mount
+
+Add to your `config/routes.rb`
+
+```
+mount ApiDocServer::Engine, at: "/api_docs"
+```
+
+You can place this route under `admin_constraint` or other restricted path, or configure basic HTTP authentication.
+
+#### Devise auth
+
+```
+authenticate :user, lambda { |u| u.admin? } do
+  mount ApiDocServer::Engine, at: "/api_docs"
+end
+```
+
+#### Basic HTTP auth
+
+Set admin username and password in an initializer:
+
+```
+# config/initializers/api_doc_server.rb
+
+ApiDocServer.configure do |config|
+  config.authentication_proc = proc do |controller|
+    authenticate_or_request_with_http_basic do |username, password|
+      User.find_by(name: username, password: password)
+    end
+  end
+end
+```
+
+### Initialize
+
+#### Versioned API documentations
+
+Set the path of your json/yaml versioned documentations in an initializer:
+
+```
+# config/initializers/api_doc_server.rb
+
+ApiDocServer.configure do |config|
+  config.swagger_urls = {
+    v1: 'api/v1/swagger.yaml',
+    v2: 'api/v2/swagger.yaml',
+  }
+end
+```
+
+and place your main documentation file under `/public/api` path.
+
+#### Single API documentation
+
+
+```
+# config/initializers/api_doc_server.rb
+
+ApiDocServer.configure do |config|
+  config.swagger_urls = { v1: 'api/v1/swagger.yaml' }
+end
+```
+
+
+### Configure
+Config Name | Swagger parameter name | Description
+--- | --- | ---
+config.swagger_url | Hash<version_key,url> | The url pointing `swagger.yaml` (Swagger 2.0) as per [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification/). This params requires hash value - pass your API doc version name as a key and it's main documentation url as a value.
+config.doc_config | Hash<config_attribute,value> | Any of the configs specified in https://github.com/Rebilly/ReDoc#redoc-tag-attributes, e.g. `{ 'scroll-y-offset': 50 }`
+config.authentication_proc = | proc | a proc that takes the current controller as an argument and halts rendering per custom strategy.
+
+
+## License
+
+This project is available under MIT-LICENSE. :sunny:

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ApiDocServer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task default: :test

data/api_doc_server.gemspec

@@ -0,0 +1,25 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'api_doc_server/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'api_doc_server'
+  s.version     = ApiDocServer::VERSION
+  s.authors     = ['Benjamin Fleischer']
+  s.email       = ['github@benjaminfleischer.com']
+  s.homepage    = 'https://github.com/bf4/api_doc_server'
+  s.summary     = 'Mountable Rails engine that serves API Docs for your Swagger/OpenAPI docs.'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.executables   = []
+
+  s.required_ruby_version = '>= 2.1'
+
+  s.add_runtime_dependency 'rails', ['>= 4.2', '< 6']
+
+  s.add_development_dependency 'rubocop'
+end