swaggerails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be5ba6d1a61e2a78cc9b5cf606fdbe52e524e141
+  data.tar.gz: c835e64214b0282435abbf6edcba7874db014757
+SHA512:
+  metadata.gz: b44ea3f9e97e31d50b1f83a3e22715bba1355ef504a1cc17ce822e9d71153244fa5dbc91607621f26529c79869ac358295e3df4f366ef751dbd14baaf648ecb5
+  data.tar.gz: 73694a0f8e6d26847d893691a0046d5ecec034b8162b544cf0e4276257bb9ce2be3a7df37860fccefca7ea8a63b84685cf69839e6032af53e298e5fbea8aa3c2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Stuart Chinery
+
+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,51 @@
+# Swaggerails
+
+A basic Swagger-UI Rails engine used to display docs generated with the [Swagger Docs gem](https://github.com/richhollis/swagger-docs).
+
+<!-- MarkdownTOC -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+<!-- /MarkdownTOC -->
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swaggerails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install swaggerails
+```
+
+## Usage
+
+TBC
+
+## Contributing
+
+* Check out the latest master and/or develop branches to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch off of develop (using Git Flow approach)
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally
+* When you are done generate a pull request
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Swaggerails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+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
+
+
+task default: :test

data/app/assets/config/swaggerails_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/swaggerails .js
+//= link_directory ../stylesheets/swaggerails .css

data/app/assets/javascripts/swaggerails/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/swaggerails/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/swaggerails/application_controller.rb

@@ -0,0 +1,7 @@
+module Swaggerails
+  class ApplicationController < ActionController::Base
+
+    protect_from_forgery with: :exception
+
+  end
+end

data/app/helpers/swaggerails/application_helper.rb

@@ -0,0 +1,4 @@
+module Swaggerails
+  module ApplicationHelper
+  end
+end

data/app/jobs/swaggerails/application_job.rb

@@ -0,0 +1,4 @@
+module Swaggerails
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/swaggerails/application_mailer.rb

@@ -0,0 +1,6 @@
+module Swaggerails
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/swaggerails/application_record.rb

@@ -0,0 +1,5 @@
+module Swaggerails
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/swaggerails/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Swagger ui rails</title>
+  <%= stylesheet_link_tag    "swaggerails/application", media: "all" %>
+  <%= javascript_include_tag "swaggerails/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Swaggerails::Engine.routes.draw do
+end

data/lib/swaggerails.rb

@@ -0,0 +1,5 @@
+require "swaggerails/engine"
+
+module Swaggerails
+  # Your code goes here...
+end

data/lib/swaggerails/engine.rb

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

data/lib/swaggerails/version.rb

@@ -0,0 +1,3 @@
+module Swaggerails
+  VERSION = File.read("VERSION").split("\n").first
+end

data/lib/tasks/swaggerails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :swaggerails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: swaggerails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Chinery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: swagger-docs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: minitest-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Swagger-UI Rails engine used to display docs generated with the Swagger
+  Docs gem
+email:
+- stuart.chinery@headlondon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/swaggerails_manifest.js
+- app/assets/javascripts/swaggerails/application.js
+- app/assets/stylesheets/swaggerails/application.css
+- app/controllers/swaggerails/application_controller.rb
+- app/helpers/swaggerails/application_helper.rb
+- app/jobs/swaggerails/application_job.rb
+- app/mailers/swaggerails/application_mailer.rb
+- app/models/swaggerails/application_record.rb
+- app/views/layouts/swaggerails/application.html.erb
+- config/routes.rb
+- lib/swaggerails.rb
+- lib/swaggerails/engine.rb
+- lib/swaggerails/version.rb
+- lib/tasks/swaggerails_tasks.rake
+homepage: https://github.com/sleepingstu/swaggerails
+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: A(nother) Swagger-UI Rails engine
+test_files: []