easy_swagger_ui 0.1.0

data/config/initializers/assets.rb

@@ -0,0 +1,7 @@
+Rails.application.config.assets.precompile += %w(
+  easy_swagger_ui/*.png
+  easy_swagger_ui/*.gif
+  easy_swagger_ui/*.jpg
+  easy_swagger_ui/print.css
+  easy_swagger_ui/lang/*.js
+)

data/config/initializers/easy_swagger_ui.rb

@@ -0,0 +1,7 @@
+EasySwaggerUi.configure do |config|
+  config.base_path = Rails.root.join('doc')
+  config.cache_enabled = !Rails.env.development?
+  config.cache_timeout = 30.minutes
+  config.cache_store = ActiveSupport::Cache::MemoryStore.new
+  config.validator_enabled = false
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+EasySwaggerUi::Engine.routes.draw do
+  get 'oauth2', to: 'swagger#oauth2', format: false
+
+  constraints(EasySwaggerUi::RouteMatcher) do
+    get '*doc_path', to: 'swagger#view', format: false, as: 'view'
+    get '*doc_path.json', to: 'swagger#spec', format: false, as: 'spec'
+  end
+end

data/lib/easy_swagger_ui.rb

@@ -0,0 +1,19 @@
+require 'easy_swagger_ui/engine'
+require 'easy_swagger_ui/version'
+require 'easy_swagger_ui/configuration'
+require 'easy_swagger_ui/route_matcher'
+
+module EasySwaggerUi
+  class << self
+    # Get configuration easily
+    delegate(*Configuration::OPTIONS, to: :configuration)
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/easy_swagger_ui/configuration.rb

@@ -0,0 +1,34 @@
+module EasySwaggerUi
+  class Configuration
+    # Configurable options
+    OPTIONS = [
+      :base_path,
+      :cache_enabled,
+      :cache_timeout,
+      :cache_store,
+      :validator_enabled,
+    ].freeze
+
+    attr_accessor(*OPTIONS)
+
+    # Avoid method redefined warning
+    remove_method :base_path=, :cache_store=
+    # remove_method :cache_store=
+
+    # Make sure it's an absolute path
+    def base_path=(path)
+      @base_path = File.absolute_path(path, Rails.root)
+    end
+
+    # Evaluate lambda when needed
+    def cache_store=(store)
+      @cache_store = store.respond_to?(:call) ? store.call : store
+    end
+
+    def to_h
+      OPTIONS.each_with_object({}) do |key, config|
+        config[key] = send(key)
+      end
+    end
+  end
+end

data/lib/easy_swagger_ui/engine.rb

@@ -0,0 +1,5 @@
+module EasySwaggerUi
+  class Engine < ::Rails::Engine
+    isolate_namespace EasySwaggerUi
+  end
+end

data/lib/easy_swagger_ui/route_matcher.rb

@@ -0,0 +1,13 @@
+module EasySwaggerUi
+  module RouteMatcher
+    def self.matches?(request)
+      return false unless request.params[:doc_path] =~ %r{\A[\w\-/]*\z}
+      filepath = File.join(
+        EasySwaggerUi.base_path,
+        request.params[:doc_path],
+        'swagger.yml'
+      )
+      File.file?(filepath)
+    end
+  end
+end

data/lib/easy_swagger_ui/version.rb

@@ -0,0 +1,4 @@
+module EasySwaggerUi
+  VERSION = '0.1.0'.freeze
+  SWAGGER_UI_VERSION = '2.2.10'.freeze
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: easy_swagger_ui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bian Jiaping
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: activesupport
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: Manage swagger API documentation in YAML file, and separate them into
+  multiple files for ease of management. Automatically parse and serve via Swagger
+  UI.
+email:
+- ssbianjp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/easy_swagger_ui_manifest.js
+- app/assets/fonts/easy_swagger_ui/DroidSans-Bold.ttf
+- app/assets/fonts/easy_swagger_ui/DroidSans.ttf
+- app/assets/images/easy_swagger_ui/collapse.gif
+- app/assets/images/easy_swagger_ui/expand.gif
+- app/assets/images/easy_swagger_ui/explorer_icons.png
+- app/assets/images/easy_swagger_ui/favicon-16x16.png
+- app/assets/images/easy_swagger_ui/favicon-32x32.png
+- app/assets/images/easy_swagger_ui/logo_small.png
+- app/assets/images/easy_swagger_ui/pet_store_api.png
+- app/assets/images/easy_swagger_ui/throbber.gif
+- app/assets/images/easy_swagger_ui/wordnik_api.png
+- app/assets/javascripts/easy_swagger_ui/application.js
+- app/assets/javascripts/easy_swagger_ui/lang/ca.js
+- app/assets/javascripts/easy_swagger_ui/lang/el.js
+- app/assets/javascripts/easy_swagger_ui/lang/en.js
+- app/assets/javascripts/easy_swagger_ui/lang/es.js
+- app/assets/javascripts/easy_swagger_ui/lang/fr.js
+- app/assets/javascripts/easy_swagger_ui/lang/geo.js
+- app/assets/javascripts/easy_swagger_ui/lang/it.js
+- app/assets/javascripts/easy_swagger_ui/lang/ja.js
+- app/assets/javascripts/easy_swagger_ui/lang/ko-kr.js
+- app/assets/javascripts/easy_swagger_ui/lang/pl.js
+- app/assets/javascripts/easy_swagger_ui/lang/pt.js
+- app/assets/javascripts/easy_swagger_ui/lang/ru.js
+- app/assets/javascripts/easy_swagger_ui/lang/tr.js
+- app/assets/javascripts/easy_swagger_ui/lang/translator.js
+- app/assets/javascripts/easy_swagger_ui/lang/zh-cn.js
+- app/assets/javascripts/easy_swagger_ui/lib/backbone-min.js
+- app/assets/javascripts/easy_swagger_ui/lib/handlebars-4.0.5.js
+- app/assets/javascripts/easy_swagger_ui/lib/highlight.9.1.0.pack.js
+- app/assets/javascripts/easy_swagger_ui/lib/highlight.9.1.0.pack_extended.js
+- app/assets/javascripts/easy_swagger_ui/lib/jquery-1.8.0.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/jquery.ba-bbq.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/jquery.slideto.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/jquery.wiggle.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/js-yaml.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/jsoneditor.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/lodash.min.js
+- app/assets/javascripts/easy_swagger_ui/lib/marked.js
+- app/assets/javascripts/easy_swagger_ui/lib/object-assign-pollyfill.js
+- app/assets/javascripts/easy_swagger_ui/lib/swagger-oauth.js
+- app/assets/javascripts/easy_swagger_ui/swagger-ui.js
+- app/assets/stylesheets/easy_swagger_ui/application.css
+- app/assets/stylesheets/easy_swagger_ui/lib/print.css.erb
+- app/assets/stylesheets/easy_swagger_ui/lib/reset.css
+- app/assets/stylesheets/easy_swagger_ui/lib/screen.css.erb
+- app/assets/stylesheets/easy_swagger_ui/lib/style.css
+- app/assets/stylesheets/easy_swagger_ui/lib/typography.css.erb
+- app/assets/stylesheets/easy_swagger_ui/print.css
+- app/controllers/easy_swagger_ui/application_controller.rb
+- app/controllers/easy_swagger_ui/swagger_controller.rb
+- app/helpers/easy_swagger_ui/application_helper.rb
+- app/views/easy_swagger_ui/swagger/oauth2.html.erb
+- app/views/easy_swagger_ui/swagger/view.html.erb
+- config/initializers/assets.rb
+- config/initializers/easy_swagger_ui.rb
+- config/routes.rb
+- lib/easy_swagger_ui.rb
+- lib/easy_swagger_ui/configuration.rb
+- lib/easy_swagger_ui/engine.rb
+- lib/easy_swagger_ui/route_matcher.rb
+- lib/easy_swagger_ui/version.rb
+homepage: https://github.com/bianjp/easy_swagger_ui
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Mountable Rails plugin that serve your API documentation written in YAML
+  files via Swagger UI
+test_files: []