Merge pull request #4 from ZuzannaSt/0.0.5-version

0.0.5 version

Author: Zuzanna Stolińska

.gitignore

@@ -1,3 +1,9 @@
 .bundle/
 log/*.log
+test/dummy/tmp/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
 swagger_ui_engine-*.gem
+
+test/dummy/log/test.log

CHANGELOG.md

@@ -0,0 +1,19 @@
+# SwaggerUiEngine Changelog
+
+## master
+
+## 0.0.5
+
+* Support Swagger UI version 2.2.10
+* Add tests
+* Fix fonts not being loaded
+* Describe problem solved by this gem in README
+
+## 0.0.4
+
+* Improve configurable options
+* Fix assets errors
+
+## 0.0.1-0.0.3
+
+Initial releases supporting Swagger UI version 2.2.8

Gemfile.lock

@@ -1,11 +1,110 @@
 PATH
   remote: .
   specs:
-    swagger_ui_engine (0.0.3)
+    swagger_ui_engine (0.0.5)
+      rails
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubis (2.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
 
 PLATFORMS
   ruby

README.md

@@ -1,32 +1,44 @@
 # SwaggerUiEngine
 
-Include [swagger-ui](https://github.com/swagger-api/swagger-ui) as rails engine and document your API with simple JSON or YAML files.
+Include [swagger-ui](https://github.com/swagger-api/swagger-ui) as Rails engine and document your API with simple YAML files.
 
-## Swagger UI Version
+## Versions
 
-Swagger UI Version |
------------------- |
-2.2.8              |
+Swagger UI version | Rails version
+------------------ | -------------
+2.2.10             | >= 5.0.0
 
-## Swagger specifications
+## Problem
 
-https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md
+Working on a Rails API, I've wanted to document my endpoints in the clearest and easiest way possible. My goal was to have the documentation separated from the actual code base and to have a web UI version of Swagger for testing and reading it. Using Rails 5 default API, I didn't need to include Grape, so I took a look into some other existing solutions. Most of them were no longer supported (e.g. [swagger_engine](https://github.com/batdevis/swagger_engine) and [swagger-ui_rails](https://github.com/d4be4st/swagger-ui_rails)) or required adding some extra code for the actual documentation (e.g. [swagger-docs](https://github.com/richhollis/swagger-docs)). Also, none of them supported Swagger web UI configuration, so I decided to write and maintain a gem on my own that would allow others to include Swagger web UI as Rails engine and support writing simple documentation in YAML files.
 
-## Install
+## Installation
 
 Add to Gemfile
 
-```gem 'swagger_ui_engine'```
+```
+gem 'swagger_ui_engine'
+```
+
+And then run:
+
+```
+$ bundle
+```
+
+## Usage
+
+### Mount
 
 Add to your config/routes.rb
 
-```mount SwaggerUiEngine::Engine, at: "/api_docs"```
+```
+mount SwaggerUiEngine::Engine, at: "/api_docs"
+```
 
 You can place this route under `admin_constraint` or other restricted path.
 
-## Configure
-
-### Swagger URL
+### Initialize
 
 Set the path of your json/yaml files in a initializer:
 
@@ -38,21 +50,21 @@ SwaggerUiEngine.configure do |config|
 end
 ```
 
-It will look for you main doc file under `/public/api_docs` path.
+and place your main documentation file under `/public/api_docs` path.
 
-### Config options
+### Configure
 Config Name | Swagger parameter name | Description
 --- | --- | ---
-config.swagger_url | url | The url pointing to `swagger.json` (Swagger 2.0) or the resource listing (earlier versions) as per [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification/).
+config.swagger_url | url | The url pointing to `swagger.yaml` (Swagger 2.0) as per [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification/).
 config.doc_expansion | docExpansion | Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details).
-config.model_rendering | defaultModelRendering | Controls how models are shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Model Schema' links.) It can be set to 'model' or 'schema', and the default is 'schema'.
+config.model_rendering | defaultModelRendering | Controls how models are shown when the API is first rendered. It can be set to 'model' or 'schema', and the default is 'schema'.
 config.request_headers | showRequestHeaders | Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to `false`.
 config.json_editor | jsonEditor | Enables a graphical view for editing complex bodies.  Defaults to `false`.
 
 ### Edit your json/yaml files
 
-Use [Swagger editor](https://github.com/swagger-api/swagger-editor).
+You can use [Swagger editor](https://github.com/swagger-api/swagger-editor) to write and validate your Swagger docs.
 
 ## License
 
-This project rocks and uses MIT-LICENSE.
+This project is available under MIT-LICENSE. :sunny:

Rakefile

@@ -6,10 +6,23 @@ 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    = 'SwaggerUiEngine'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task default: :test