grape-swagger-rails 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f70ee5fb99887f9c43af71656d1c66077922cc5
-  data.tar.gz: e82ff7b00d8e820589319bc23b5f532b3765e2a3
+  metadata.gz: a7eef026c0532c248f2da7281450fd060139a6e9
+  data.tar.gz: 0d34cdbd5f00b4ee546f5cb98533991028d69bb7
 SHA512:
-  metadata.gz: 50ccf22315d6f4ff1a2c3928397340b5e0cdcf06997bcfd2e82ca00b8cded414e8a5217674f686bba78021ff906cf5a1237eb5210f40e4530f213a12e5583265
-  data.tar.gz: 71db67f88d81052c230fa42e89209a02bc8b27df9d573de2c068bf6abe83a137992e2d92030c3217b3acff4e9074cea73091fabce20072a1a4519f39750a5fd4
+  metadata.gz: a66a6f8bb1f9c3aef18acc79d7caf2536270a0cd4aaef985b745b590b27082b6998fd8f451eb84090d0933df98d14059e3543cdb2b2e0dcb17de176ee22890a6
+  data.tar.gz: fe6d7cd6dd4722d1afe4a431273086e4fc2530fc533ba52fb6e737cf2e5fef3ed8e56a37834f8c93ccb1cc3e9d074ea79368860842619fd6fd29997876cb666e

data/.travis.yml

@@ -1,3 +1,5 @@
+sudo: false
+
 before_install:
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
@@ -8,3 +10,12 @@ cache: bundler
 
 rvm:
   - 2.1.2
+
+env:
+  - GRAPE_SWAGGER_VERSION=0.7.2
+  - GRAPE_SWAGGER_VERSION=0.8.0
+  - GRAPE_SWAGGER_VERSION=HEAD
+
+matrix:
+  allow_failures:
+    - env: GRAPE_SWAGGER_VERSION=HEAD

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+### 0.1.0 (February 5, 2015)
+
+* [41](https://github.com/BrandyMint/grape-swagger-rails/pull/41): Compatibility with grape-swagger 0.8.0 and 0.9.0 - [@dblock](https://github.com/dblock).
+
+### 0.0.10 (September 30, 2014)
+
+* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: make the dummy app runnable - [@dblock](https://github.com/dblock).
+* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: headers default to nil - [@dblock](https://github.com/dblock).
+* [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Added support for GrapeSwaggerRails.options.headers - [@dblock](https://github.com/dblock).
+* [#31](https://github.com/BrandyMint/grape-swagger-rails/pull/31): Get Swagger-UI from dist - [@dblock](https://github.com/dblock).
+* [#29](https://github.com/BrandyMint/grape-swagger-rails/pull/29): Add Rails 4.1 support - [@aaronchi](https://github.com/aaronchi).
+* [#21](https://github.com/BrandyMint/grape-swagger-rails/pull/21): Corrected initializer paths - [@mrclmrvn](https://github.com/mrclmrvn).
+* [#23](https://github.com/BrandyMint/grape-swagger-rails/pull/23): Added auth bearer support - [@shinnyx](https://github.com/shinnyx).
+* [#14](https://github.com/BrandyMint/grape-swagger-rails/pull/14): Added app_name to configure title of the app - [@ghilead](https://github.com/ghilead).
+* [#12](https://github.com/BrandyMint/grape-swagger-rails/pull/12): Fix: SwaggerUI url is combined with appUrl - [@ghilead](https://github.com/ghilead).
+
+### 0.0.8 (February 6, 2014)
+
+* [#11](https://github.com/BrandyMint/grape-swagger-rails/pull/11): Fixed image loading - [@bitboxer](https://github.com/bitboxer).
+
+### 0.0.7 (February 5, 2014)
+
+* [#7](https://github.com/BrandyMint/grape-swagger-rails/pull/7): Updated to Swagger-UI 2.0.3 - [@joelvh](https://github.com/joelvh).
+* [#6](https://github.com/BrandyMint/grape-swagger-rails/pull/6): Added appName and appUrl configuration options - [@swistaczek](https://github.com/swistaczek).
+
+### 0.0.4 (July 16, 2013)
+
+* Configure discoveryUrl from Rails - [@dapi](https://github.com/dapi).
+* Added default support for all HTTP methods  - [@mtavaresOS](https://github.com/mtavaresOS).
+
+### 0.0.3 (May 24, 2013)
+
+* Converted to Rails Engine - [@unloved](https://github.com/unloved).
+
+### 0.0.1 (April 5, 2013)
+
+* Initial public release - [@radanisk](https://github.com/Radanisk).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Grape-Swagger-Rails
+
+This project is work of [many contributors](https://github.com/TinkerDev/grape-swagger-rails/graphs/contributors).
+You're encouraged to submit [pull requests](https://github.com/TinkerDev/grape-swagger-rails/pulls),
+[propose features and discuss issues](https://github.com/TinkerDev/grape-swagger-rails/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/TinkerDev/grape-swagger-rails) and check out your copy.
+
+```
+git clone https://github.com/contributor/grape-swagger.git
+cd grape-swagger
+git remote add upstream https://github.com/TinkerDev/grape-swagger-rails.git
+```
+
+## Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+Add to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Make sure that `bundle exec rake` completes without errors.
+
+You might find it useful to iterate on code by running the test project from spec/dummy.
+
+```
+spec/dummy$ GRAPE_SWAGGER_VERSION=HEAD bundle install
+
+Updating git://github.com/tim-vandecasteele/grape-swagger.git
+Fetching gem metadata from https://rubygems.org/.........
+Resolving dependencies...
+...
+
+spec/dummy$ GRAPE_SWAGGER_VERSION=HEAD rails s
+=> Booting WEBrick
+=> Rails 4.1.8 application starting in development on http://0.0.0.0:3000
+=> Run `rails server -h` for more startup options
+=> Notice: server is listening on all interfaces (0.0.0.0). Consider using 127.0.0.1 (--binding option)
+=> Ctrl-C to shutdown server
+...
+```
+
+Navigate to http://localhost:3000/swagger.
+
+## Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+## Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
+Make it look like every other line, including your name and link to your Github account.
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/grape and select your feature branch.
+Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/TinkerDev/grape-swagger-rails/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+## Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 
 gemspec
+
+case version = ENV['GRAPE_SWAGGER_VERSION'] || '~> 0.9.0'
+when 'HEAD'
+  gem 'grape-swagger', github: 'tim-vandecasteele/grape-swagger'
+else
+  gem 'grape-swagger', version
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Aleksandr B. Ivanov
+Copyright (c) 2013-2014 Aleksandr B. Ivanov & Contributors
 
 MIT License
 

data/README.md

@@ -1,8 +1,8 @@
 # GrapeSwaggerRails
 
-[![Build Status](https://travis-ci.org/BrandyMint/grape-swagger-rails.svg)](https://travis-ci.org/BrandyMint/grape-swagger-rails)
+[![Build Status](https://travis-ci.org/TinkerDev/grape-swagger-rails.svg)](https://travis-ci.org/TinkerDev/grape-swagger-rails)
 
-Swagger UI as Rails Engine for grape-swagger gem
+Swagger UI as Rails Engine for grape-swagger gem.
 
 ## Installation
 
@@ -92,20 +92,20 @@ end
 
 ### Updating Swagger UI from Dist
 
-To update Swagger UI from its [distribution](https://github.com/wordnik/swagger-ui), run 'bundle exec rake swagger_ui:dist:update'. Examine the changes carefully.
+To update Swagger UI from its [distribution](https://github.com/wordnik/swagger-ui), run `bundle exec rake swagger_ui:dist:update`. Examine the changes carefully.
 
-##Contributors
+## Contributors
 
-* unloved  (https://github.com/unloved)
-* dapi    (https://github.com/dapi)
-* joelvh  (https://github.com/joelvh)
-* dblock  (https://github.com/dblock)
+* [unloved](https://github.com/unloved)
+* [dapi](https://github.com/dapi)
+* [joelvh](https://github.com/joelvh)
+* [dblock](https://github.com/dblock)
+* ... and [more](https://github.com/TinkerDev/grape-swagger-rails/graphs/contributors) ...
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+See [CONTRIBUTING](CONTRIBUTING.md).
 
+## License
+
+MIT License, see [LICENSE](LICENSE.txt).

data/RELEASING.md

@@ -0,0 +1,65 @@
+# Releasing Grape-Swagger-Rails
+
+There're no particular rules about when to release grape-swagger-rails. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/TinkerDev/grape-swagger-rails) for all supported platforms.
+
+Increment the version, modify [lib/grape-swagger-rails/version.rb](lib/grape-swagger-rails/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.1.0` to `0.1.1`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.1.0` to `0.2.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.1.1 (February 5, 2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/grape-swagger-rails/version.rb
+git commit -m "Preparing for release, 0.1.1."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+grape-swagger-rails 0.1.1 built to pkg/grape-swagger-rails-0.1.1.gem.
+Tagged v0.1.1.
+Pushed git commits and tags.
+Pushed grape-swagger-rails 0.1.1 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Comit your changes.
+
+```
+git add CHANGELOG.md
+git commit -m "Preparing for next release."
+git push origin master
+```

data/app/views/grape_swagger_rails/application/index.html.erb

@@ -44,7 +44,7 @@
       } else {
         window.authorizations.add("key", null);
       }
-    })
+    });
 
     <% GrapeSwaggerRails.options.headers.each_pair do |key, value| %>
       <%=raw "window.authorizations.add('key', new ApiKeyAuthorization('#{CGI.escapeHTML(key)}', '#{CGI.escapeHTML(value)}', 'header'));" %>

data/grape-swagger-rails.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |spec|
   spec.email         = ['unlovedru@gmail.com']
   spec.description   = 'Swagger UI as Rails Engine for grape-swagger gem'
   spec.summary       = 'Swagger UI as Rails Engine for grape-swagger gem'
-  spec.homepage      = 'https://github.com/BrandyMint/grape-swagger-rails'
+  spec.homepage      = 'https://github.com/TinkerDev/grape-swagger-rails'
   spec.license       = 'MIT'
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = `git ls-files spec`.split($/)
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'railties', '>= 3.2.12'
-  spec.add_dependency 'grape-swagger', '~> 0.7.2'
+  spec.add_dependency 'grape-swagger', '>= 0.7.2'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/grape-swagger-rails.rb

@@ -15,7 +15,7 @@ module GrapeSwaggerRails
 
   self.options = Options.new(
 
-    url:                  '/swagger_doc.json',
+    url:                  '/swagger_doc',
     app_name:             'Swagger',
     app_url:              'http://swagger.wordnik.com',
 

data/lib/grape-swagger-rails/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwaggerRails
-  VERSION = "0.0.10"
-end
+  VERSION = "0.1.0"
+end

data/spec/dummy/app/api/api.rb

@@ -1,5 +1,4 @@
 class API < Grape::API
-  format :json
   prefix 'api'
 
   namespace :foos do

data/spec/dummy/config/initializers/swagger.rb

@@ -1,3 +1,3 @@
-GrapeSwaggerRails.options.url = '/api/swagger_doc.json'
+GrapeSwaggerRails.options.url = '/api/swagger_doc'
 GrapeSwaggerRails.options.app_name = 'Swagger'
 GrapeSwaggerRails.options.app_url  = 'http://localhost:3000'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexander Logunov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -28,14 +28,14 @@ dependencies:
   name: grape-swagger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.2
 - !ruby/object:Gem::Dependency
@@ -244,9 +244,12 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- RELEASING.md
 - Rakefile
 - app/assets/images/grape_swagger_rails/explorer_icons.png
 - app/assets/images/grape_swagger_rails/logo_small.png
@@ -322,7 +325,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/rails.rb
-homepage: https://github.com/BrandyMint/grape-swagger-rails
+homepage: https://github.com/TinkerDev/grape-swagger-rails
 licenses:
 - MIT
 metadata: {}