rswag-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f6ee076c91f10f2f2153af5909894942120f584
+  data.tar.gz: 9ec6137c51c1ead2a770b829c35abf9e811d0a3f
+SHA512:
+  metadata.gz: 6639e7eb987de21234bf298b6b08d46767f32775d8352027ed29ea109a1675968baaea207cb90078c9a1fbba00773623f080f01467d6d6c2ceea30d3bd0d2c4e
+  data.tar.gz: 08b49778960052d1e36de9e82de3ad0068a1c828aeaede45e88048a071aa66a202af96b07bc1739be883dc0faf88064d9bd0a7550411ccfc39764c9f9b4849cb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 domaindrivendev
+
+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/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rswag-specs'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/rswag/api/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Adds rswag-api initializer for configuration
+
+Example:
+    rails generate rswag:api:install
+
+    This will create:
+        config/initializers/rswag-api.rb

data/lib/generators/rswag/api/install/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Rswag
+  module Api
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def add_initializer
+        template('rswag-api.rb', 'config/initializers/rswag-api.rb')
+      end
+
+      def add_routes
+        route("mount Rswag::Api::Engine => '/api-docs'")
+      end
+    end
+  end
+end

data/lib/generators/rswag/api/install/templates/rswag-api.rb

@@ -0,0 +1,14 @@
+Rswag::Api.configure do |c|
+
+  # Specify a root folder where Swagger JSON files are located
+  # This is used by the Swagger middleware to serve requests for API descriptions
+  # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
+  # that it's configured to generate files in the same folder
+  c.swagger_root = Rails.root.to_s + '/swagger'
+
+  # Inject a lamda function to alter the returned Swagger prior to serialization
+  # The function will have access to the rack env for the current request
+  # For example, you could leverage this to dynamically assign the "host" property
+  #
+  #c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+end

data/lib/rswag/api.rb

@@ -0,0 +1,15 @@
+require 'rswag/api/version'
+require 'rswag/api/configuration'
+require 'rswag/api/engine'
+
+module Rswag
+  module Api
+    def self.configure
+      yield(config)
+    end
+
+    def self.config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/rswag/api/configuration.rb

@@ -0,0 +1,12 @@
+module Rswag
+  module Api
+    class Configuration
+      attr_accessor :swagger_root, :swagger_filter
+
+      def resolve_swagger_root(env)
+        path_params = env['action_dispatch.request.path_parameters'] || {}
+        path_params[:swagger_root] || swagger_root
+      end
+    end
+  end
+end

data/lib/rswag/api/engine.rb

@@ -0,0 +1,13 @@
+require 'rswag/api/middleware'
+
+module Rswag
+  module Api
+    class Engine < ::Rails::Engine
+      isolate_namespace Rswag::Api
+
+      initializer 'rswag-api.initialize' do |app|
+        middleware.use Rswag::Api::Middleware, Rswag::Api.config
+      end
+    end
+  end
+end

data/lib/rswag/api/middleware.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+module Rswag
+  module Api
+    class Middleware 
+
+      def initialize(app, config)
+        @app = app
+        @config = config
+      end
+
+      def call(env)
+        path = env['PATH_INFO']
+        filename = "#{@config.resolve_swagger_root(env)}/#{path}"
+
+        if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
+          swagger = load_json(filename)
+          @config.swagger_filter.call(swagger, env) unless @config.swagger_filter.nil?
+
+          return [
+            '200',
+            { 'Content-Type' => 'application/json' },
+            [ JSON.dump(swagger) ]
+          ]
+        end
+          
+        return @app.call(env)
+      end
+
+      private
+
+      def load_json(filename)
+        JSON.parse(File.read(filename))
+      end
+    end
+  end
+end

data/lib/rswag/api/version.rb

@@ -0,0 +1,5 @@
+module Rswag
+  module Api
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rswag-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Richie Morris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Open up your API to the phenomenal Swagger ecosystem by exposing Swagger
+  files, that describe your service, as JSON endpoints
+email:
+- domaindrivendev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/rswag/api/install/USAGE
+- lib/generators/rswag/api/install/install_generator.rb
+- lib/generators/rswag/api/install/templates/rswag-api.rb
+- lib/rswag/api.rb
+- lib/rswag/api/configuration.rb
+- lib/rswag/api/engine.rb
+- lib/rswag/api/middleware.rb
+- lib/rswag/api/version.rb
+homepage: https://github.com/domaindrivendev/rswag
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Rails Engine that exposes Swagger files as JSON endpoints
+test_files: []