grape-swagger-rails 0.0.10 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 5f70ee5fb99887f9c43af71656d1c66077922cc5
4
- data.tar.gz: e82ff7b00d8e820589319bc23b5f532b3765e2a3
3
+ metadata.gz: a7eef026c0532c248f2da7281450fd060139a6e9
4
+ data.tar.gz: 0d34cdbd5f00b4ee546f5cb98533991028d69bb7
5
5
  SHA512:
6
- metadata.gz: 50ccf22315d6f4ff1a2c3928397340b5e0cdcf06997bcfd2e82ca00b8cded414e8a5217674f686bba78021ff906cf5a1237eb5210f40e4530f213a12e5583265
7
- data.tar.gz: 71db67f88d81052c230fa42e89209a02bc8b27df9d573de2c068bf6abe83a137992e2d92030c3217b3acff4e9074cea73091fabce20072a1a4519f39750a5fd4
6
+ metadata.gz: a66a6f8bb1f9c3aef18acc79d7caf2536270a0cd4aaef985b745b590b27082b6998fd8f451eb84090d0933df98d14059e3543cdb2b2e0dcb17de176ee22890a6
7
+ data.tar.gz: fe6d7cd6dd4722d1afe4a431273086e4fc2530fc533ba52fb6e737cf2e5fef3ed8e56a37834f8c93ccb1cc3e9d074ea79368860842619fd6fd29997876cb666e
@@ -1,3 +1,5 @@
1
+ sudo: false
2
+
1
3
  before_install:
2
4
  - "export DISPLAY=:99.0"
3
5
  - "sh -e /etc/init.d/xvfb start"
@@ -8,3 +10,12 @@ cache: bundler
8
10
 
9
11
  rvm:
10
12
  - 2.1.2
13
+
14
+ env:
15
+ - GRAPE_SWAGGER_VERSION=0.7.2
16
+ - GRAPE_SWAGGER_VERSION=0.8.0
17
+ - GRAPE_SWAGGER_VERSION=HEAD
18
+
19
+ matrix:
20
+ allow_failures:
21
+ - env: GRAPE_SWAGGER_VERSION=HEAD
@@ -0,0 +1,37 @@
1
+ ### 0.1.0 (February 5, 2015)
2
+
3
+ * [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).
4
+
5
+ ### 0.0.10 (September 30, 2014)
6
+
7
+ * [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: make the dummy app runnable - [@dblock](https://github.com/dblock).
8
+ * [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Fix: headers default to nil - [@dblock](https://github.com/dblock).
9
+ * [33](https://github.com/BrandyMint/grape-swagger-rails/pull/33): Added support for GrapeSwaggerRails.options.headers - [@dblock](https://github.com/dblock).
10
+ * [#31](https://github.com/BrandyMint/grape-swagger-rails/pull/31): Get Swagger-UI from dist - [@dblock](https://github.com/dblock).
11
+ * [#29](https://github.com/BrandyMint/grape-swagger-rails/pull/29): Add Rails 4.1 support - [@aaronchi](https://github.com/aaronchi).
12
+ * [#21](https://github.com/BrandyMint/grape-swagger-rails/pull/21): Corrected initializer paths - [@mrclmrvn](https://github.com/mrclmrvn).
13
+ * [#23](https://github.com/BrandyMint/grape-swagger-rails/pull/23): Added auth bearer support - [@shinnyx](https://github.com/shinnyx).
14
+ * [#14](https://github.com/BrandyMint/grape-swagger-rails/pull/14): Added app_name to configure title of the app - [@ghilead](https://github.com/ghilead).
15
+ * [#12](https://github.com/BrandyMint/grape-swagger-rails/pull/12): Fix: SwaggerUI url is combined with appUrl - [@ghilead](https://github.com/ghilead).
16
+
17
+ ### 0.0.8 (February 6, 2014)
18
+
19
+ * [#11](https://github.com/BrandyMint/grape-swagger-rails/pull/11): Fixed image loading - [@bitboxer](https://github.com/bitboxer).
20
+
21
+ ### 0.0.7 (February 5, 2014)
22
+
23
+ * [#7](https://github.com/BrandyMint/grape-swagger-rails/pull/7): Updated to Swagger-UI 2.0.3 - [@joelvh](https://github.com/joelvh).
24
+ * [#6](https://github.com/BrandyMint/grape-swagger-rails/pull/6): Added appName and appUrl configuration options - [@swistaczek](https://github.com/swistaczek).
25
+
26
+ ### 0.0.4 (July 16, 2013)
27
+
28
+ * Configure discoveryUrl from Rails - [@dapi](https://github.com/dapi).
29
+ * Added default support for all HTTP methods - [@mtavaresOS](https://github.com/mtavaresOS).
30
+
31
+ ### 0.0.3 (May 24, 2013)
32
+
33
+ * Converted to Rails Engine - [@unloved](https://github.com/unloved).
34
+
35
+ ### 0.0.1 (April 5, 2013)
36
+
37
+ * Initial public release - [@radanisk](https://github.com/Radanisk).
@@ -0,0 +1,125 @@
1
+ # Contributing to Grape-Swagger-Rails
2
+
3
+ This project is work of [many contributors](https://github.com/TinkerDev/grape-swagger-rails/graphs/contributors).
4
+ You're encouraged to submit [pull requests](https://github.com/TinkerDev/grape-swagger-rails/pulls),
5
+ [propose features and discuss issues](https://github.com/TinkerDev/grape-swagger-rails/issues).
6
+
7
+ In the examples below, substitute your Github username for `contributor` in URLs.
8
+
9
+ ## Fork the Project
10
+
11
+ Fork the [project on Github](https://github.com/TinkerDev/grape-swagger-rails) and check out your copy.
12
+
13
+ ```
14
+ git clone https://github.com/contributor/grape-swagger.git
15
+ cd grape-swagger
16
+ git remote add upstream https://github.com/TinkerDev/grape-swagger-rails.git
17
+ ```
18
+
19
+ ## Create a Topic Branch
20
+
21
+ Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
22
+
23
+ ```
24
+ git checkout master
25
+ git pull upstream master
26
+ git checkout -b my-feature-branch
27
+ ```
28
+
29
+ ## Bundle Install and Test
30
+
31
+ Ensure that you can build the project and run tests.
32
+
33
+ ```
34
+ bundle install
35
+ bundle exec rake
36
+ ```
37
+
38
+ ## Write Tests
39
+
40
+ Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
41
+ Add to [spec](spec).
42
+
43
+ We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
44
+
45
+ ## Write Code
46
+
47
+ Implement your feature or bug fix.
48
+
49
+ Make sure that `bundle exec rake` completes without errors.
50
+
51
+ You might find it useful to iterate on code by running the test project from spec/dummy.
52
+
53
+ ```
54
+ spec/dummy$ GRAPE_SWAGGER_VERSION=HEAD bundle install
55
+
56
+ Updating git://github.com/tim-vandecasteele/grape-swagger.git
57
+ Fetching gem metadata from https://rubygems.org/.........
58
+ Resolving dependencies...
59
+ ...
60
+
61
+ spec/dummy$ GRAPE_SWAGGER_VERSION=HEAD rails s
62
+ => Booting WEBrick
63
+ => Rails 4.1.8 application starting in development on http://0.0.0.0:3000
64
+ => Run `rails server -h` for more startup options
65
+ => Notice: server is listening on all interfaces (0.0.0.0). Consider using 127.0.0.1 (--binding option)
66
+ => Ctrl-C to shutdown server
67
+ ...
68
+ ```
69
+
70
+ Navigate to http://localhost:3000/swagger.
71
+
72
+ ## Write Documentation
73
+
74
+ Document any external behavior in the [README](README.md).
75
+
76
+ ## Update Changelog
77
+
78
+ Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
79
+ Make it look like every other line, including your name and link to your Github account.
80
+
81
+ ## Push
82
+
83
+ ```
84
+ git push origin my-feature-branch
85
+ ```
86
+
87
+ ## Make a Pull Request
88
+
89
+ Go to https://github.com/contributor/grape and select your feature branch.
90
+ Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
91
+
92
+ ## Update CHANGELOG Again
93
+
94
+ Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
95
+
96
+ ```
97
+ * [#123](https://github.com/TinkerDev/grape-swagger-rails/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
98
+ ```
99
+
100
+ Amend your previous commit and force push the changes.
101
+
102
+ ```
103
+ git commit --amend
104
+ git push origin my-feature-branch -f
105
+ ## Rebase
106
+
107
+ If you've been working on a change for a while, rebase with upstream/master.
108
+
109
+ ```
110
+ git fetch upstream
111
+ git rebase upstream/master
112
+ git push origin my-feature-branch -f
113
+ ```
114
+
115
+ ## Check on Your Pull Request
116
+
117
+ 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.
118
+
119
+ ## Be Patient
120
+
121
+ 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!
122
+
123
+ ## Thank You
124
+
125
+ Please do know that we really appreciate and value your time and work. We love you, really.
data/Gemfile CHANGED
@@ -1,3 +1,10 @@
1
1
  source 'https://rubygems.org'
2
2
 
3
3
  gemspec
4
+
5
+ case version = ENV['GRAPE_SWAGGER_VERSION'] || '~> 0.9.0'
6
+ when 'HEAD'
7
+ gem 'grape-swagger', github: 'tim-vandecasteele/grape-swagger'
8
+ else
9
+ gem 'grape-swagger', version
10
+ end
@@ -1,4 +1,4 @@
1
- Copyright (c) 2013 Aleksandr B. Ivanov
1
+ Copyright (c) 2013-2014 Aleksandr B. Ivanov & Contributors
2
2
 
3
3
  MIT License
4
4
 
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # GrapeSwaggerRails
2
2
 
3
- [![Build Status](https://travis-ci.org/BrandyMint/grape-swagger-rails.svg)](https://travis-ci.org/BrandyMint/grape-swagger-rails)
3
+ [![Build Status](https://travis-ci.org/TinkerDev/grape-swagger-rails.svg)](https://travis-ci.org/TinkerDev/grape-swagger-rails)
4
4
 
5
- Swagger UI as Rails Engine for grape-swagger gem
5
+ Swagger UI as Rails Engine for grape-swagger gem.
6
6
 
7
7
  ## Installation
8
8
 
@@ -92,20 +92,20 @@ end
92
92
 
93
93
  ### Updating Swagger UI from Dist
94
94
 
95
- 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.
95
+ 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.
96
96
 
97
- ##Contributors
97
+ ## Contributors
98
98
 
99
- * unloved (https://github.com/unloved)
100
- * dapi (https://github.com/dapi)
101
- * joelvh (https://github.com/joelvh)
102
- * dblock (https://github.com/dblock)
99
+ * [unloved](https://github.com/unloved)
100
+ * [dapi](https://github.com/dapi)
101
+ * [joelvh](https://github.com/joelvh)
102
+ * [dblock](https://github.com/dblock)
103
+ * ... and [more](https://github.com/TinkerDev/grape-swagger-rails/graphs/contributors) ...
103
104
 
104
105
  ## Contributing
105
106
 
106
- 1. Fork it
107
- 2. Create your feature branch (`git checkout -b my-new-feature`)
108
- 3. Commit your changes (`git commit -am 'Add some feature'`)
109
- 4. Push to the branch (`git push origin my-new-feature`)
110
- 5. Create new Pull Request
107
+ See [CONTRIBUTING](CONTRIBUTING.md).
111
108
 
109
+ ## License
110
+
111
+ MIT License, see [LICENSE](LICENSE.txt).
@@ -0,0 +1,65 @@
1
+ # Releasing Grape-Swagger-Rails
2
+
3
+ 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.
4
+
5
+ ### Release
6
+
7
+ Run tests, check that all tests succeed locally.
8
+
9
+ ```
10
+ bundle install
11
+ rake
12
+ ```
13
+
14
+ Check that the last build succeeded in [Travis CI](https://travis-ci.org/TinkerDev/grape-swagger-rails) for all supported platforms.
15
+
16
+ Increment the version, modify [lib/grape-swagger-rails/version.rb](lib/grape-swagger-rails/version.rb).
17
+
18
+ * 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`).
19
+ * Increment the second number if the release contains major features or breaking API changes (eg. change `0.1.0` to `0.2.0`).
20
+
21
+ Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
22
+
23
+ ```
24
+ ### 0.1.1 (February 5, 2015)
25
+ ```
26
+
27
+ Remove the line with "Your contribution here.", since there will be no more contributions to this release.
28
+
29
+ Commit your changes.
30
+
31
+ ```
32
+ git add CHANGELOG.md lib/grape-swagger-rails/version.rb
33
+ git commit -m "Preparing for release, 0.1.1."
34
+ git push origin master
35
+ ```
36
+
37
+ Release.
38
+
39
+ ```
40
+ $ rake release
41
+
42
+ grape-swagger-rails 0.1.1 built to pkg/grape-swagger-rails-0.1.1.gem.
43
+ Tagged v0.1.1.
44
+ Pushed git commits and tags.
45
+ Pushed grape-swagger-rails 0.1.1 to rubygems.org.
46
+ ```
47
+
48
+ ### Prepare for the Next Version
49
+
50
+ Add the next release to [CHANGELOG.md](CHANGELOG.md).
51
+
52
+ ```
53
+ Next Release
54
+ ============
55
+
56
+ * Your contribution here.
57
+ ```
58
+
59
+ Comit your changes.
60
+
61
+ ```
62
+ git add CHANGELOG.md
63
+ git commit -m "Preparing for next release."
64
+ git push origin master
65
+ ```
@@ -44,7 +44,7 @@
44
44
  } else {
45
45
  window.authorizations.add("key", null);
46
46
  }
47
- })
47
+ });
48
48
 
49
49
  <% GrapeSwaggerRails.options.headers.each_pair do |key, value| %>
50
50
  <%=raw "window.authorizations.add('key', new ApiKeyAuthorization('#{CGI.escapeHTML(key)}', '#{CGI.escapeHTML(value)}', 'header'));" %>
@@ -10,14 +10,14 @@ Gem::Specification.new do |spec|
10
10
  spec.email = ['unlovedru@gmail.com']
11
11
  spec.description = 'Swagger UI as Rails Engine for grape-swagger gem'
12
12
  spec.summary = 'Swagger UI as Rails Engine for grape-swagger gem'
13
- spec.homepage = 'https://github.com/BrandyMint/grape-swagger-rails'
13
+ spec.homepage = 'https://github.com/TinkerDev/grape-swagger-rails'
14
14
  spec.license = 'MIT'
15
15
  spec.files = `git ls-files`.split($/)
16
16
  spec.test_files = `git ls-files spec`.split($/)
17
17
  spec.require_paths = %w(lib)
18
18
 
19
19
  spec.add_dependency 'railties', '>= 3.2.12'
20
- spec.add_dependency 'grape-swagger', '~> 0.7.2'
20
+ spec.add_dependency 'grape-swagger', '>= 0.7.2'
21
21
 
22
22
  spec.add_development_dependency 'bundler', '~> 1.3'
23
23
  spec.add_development_dependency 'rake'
@@ -15,7 +15,7 @@ module GrapeSwaggerRails
15
15
 
16
16
  self.options = Options.new(
17
17
 
18
- url: '/swagger_doc.json',
18
+ url: '/swagger_doc',
19
19
  app_name: 'Swagger',
20
20
  app_url: 'http://swagger.wordnik.com',
21
21
 
@@ -1,3 +1,3 @@
1
1
  module GrapeSwaggerRails
2
- VERSION = "0.0.10"
3
- end
2
+ VERSION = "0.1.0"
3
+ end
@@ -1,5 +1,4 @@
1
1
  class API < Grape::API
2
- format :json
3
2
  prefix 'api'
4
3
 
5
4
  namespace :foos do
@@ -1,3 +1,3 @@
1
- GrapeSwaggerRails.options.url = '/api/swagger_doc.json'
1
+ GrapeSwaggerRails.options.url = '/api/swagger_doc'
2
2
  GrapeSwaggerRails.options.app_name = 'Swagger'
3
3
  GrapeSwaggerRails.options.app_url = 'http://localhost:3000'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: grape-swagger-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.10
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Alexander Logunov
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-09-30 00:00:00.000000000 Z
11
+ date: 2015-02-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: railties
@@ -28,14 +28,14 @@ dependencies:
28
28
  name: grape-swagger
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
33
  version: 0.7.2
34
34
  type: :runtime
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: 0.7.2
41
41
  - !ruby/object:Gem::Dependency
@@ -244,9 +244,12 @@ files:
244
244
  - ".gitignore"
245
245
  - ".rspec"
246
246
  - ".travis.yml"
247
+ - CHANGELOG.md
248
+ - CONTRIBUTING.md
247
249
  - Gemfile
248
250
  - LICENSE.txt
249
251
  - README.md
252
+ - RELEASING.md
250
253
  - Rakefile
251
254
  - app/assets/images/grape_swagger_rails/explorer_icons.png
252
255
  - app/assets/images/grape_swagger_rails/logo_small.png
@@ -322,7 +325,7 @@ files:
322
325
  - spec/spec_helper.rb
323
326
  - spec/support/capybara.rb
324
327
  - spec/support/rails.rb
325
- homepage: https://github.com/BrandyMint/grape-swagger-rails
328
+ homepage: https://github.com/TinkerDev/grape-swagger-rails
326
329
  licenses:
327
330
  - MIT
328
331
  metadata: {}