swagger_yard-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f557fd9df6b77513d27bd07bf19a7916347c4d1
+  data.tar.gz: c3b1447dc6cd7466acaaa223f087ad30e122521f
+SHA512:
+  metadata.gz: d539556a94a932b14b3a3f6878480084ff141d21d11270c2026471fa03600d648ea2607d63f60fe8be8135c054c257ed4a4869c9ea0c4b5f69cfcdd3d96fa559
+  data.tar.gz: 025eba31f3fc8815fa3e4d3e8ae4983d94360ccb3e1ba37451d35deefb327c8e6988ca931841f73c57a8a5321dd0925ae85dcf9f7b893518d24c736c22e313f6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/fixtures/dummy/log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## SwaggerYard 0.1.0 -- 15-10-2015 ##
+
+* Add Engine from SwaggerYard
+* Update specs to make requests of rails app
+
+    *Tony Pitale <@tpitale>*

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swagger_yard-rails.gemspec
+gemspec
+
+# jquery-rails is used by the dummy application
+# gem "jquery-rails"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tony Pitale
+
+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 @@
+# SwaggerYard::Rails
+
+The SwaggerYard::Rails gem is a Rails Engine designed to parse your Yardocs API controllers using SwaggerYard. It'll create a Swagger-UI complaint JSON to be served out through where you mount SwaggerYard::Rails::Engine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger_yard-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Mount your engine ###
+
+```ruby
+# add to config/routes.rb
+mount SwaggerYard::Rails::Engine, at: "/swagger"
+```
+
+### Configure SwaggerYard ###
+
+```ruby
+# config/initializers/swagger_yard.rb
+SwaggerYard.configure do |config|
+  # the rest of your configuration here
+
+  # where your swagger spec json will show up
+  config.swagger_spec_base_path = "http://localhost:3000/swagger/api"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger_yard-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger_yard/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+SwaggerYard::Rails::Engine.routes.draw do
+   get '/api', to: 'swagger#index'
+   get '/api/*resource', to: 'swagger#show'
+end

data/lib/swagger_yard/rails.rb

@@ -0,0 +1,11 @@
+require "swagger_yard"
+require "swagger_yard/rails/version"
+
+module SwaggerYard
+  module Rails
+  end
+end
+
+require "swagger_yard/rails/engine"
+require "swagger_yard/rails/application_controller"
+require "swagger_yard/rails/swagger_controller"

data/lib/swagger_yard/rails/application_controller.rb

@@ -0,0 +1,6 @@
+module SwaggerYard
+  module Rails
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/lib/swagger_yard/rails/engine.rb

@@ -0,0 +1,10 @@
+module SwaggerYard
+  module Rails
+    class Engine < ::Rails::Engine
+      isolate_namespace SwaggerYard::Rails
+      initializer "swagger_yard-rails.finisher_hook" do |app|
+        SwaggerYard.register_custom_yard_tags!
+      end
+    end
+  end
+end

data/lib/swagger_yard/rails/swagger_controller.rb

@@ -0,0 +1,25 @@
+module SwaggerYard
+  module Rails
+    class SwaggerController < ApplicationController
+      layout false
+
+      def index
+        listing = resource_listing.to_h
+        listing.merge!("basePath" => request.url) if listing["basePath"].blank?
+        render :json => listing
+      end
+
+      def show
+        declaration = resource_listing.declaration_for("/#{params[:resource]}").to_h
+
+        declaration.merge!("basePath" => request.base_url + SwaggerYard.config.api_path) if declaration["basePath"].blank?
+        render :json => declaration
+      end
+
+      private
+      def resource_listing
+        SwaggerYard::ResourceListing.new(::Rails.root+'app/controllers/**/*.rb', ::Rails.root+'app/models/**/*.rb')
+      end
+    end
+  end
+end

data/lib/swagger_yard/rails/version.rb

@@ -0,0 +1,5 @@
+module SwaggerYard
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/swagger_yard-rails.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_yard/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger_yard-rails"
+  spec.version       = SwaggerYard::Rails::VERSION
+  spec.authors       = ["Tony Pitale"]
+  spec.email         = ["tony.pitale@livingsocial.com"]
+
+  spec.summary       = %q{Rails engine to parse and render json for Swagger UI}
+  spec.description   = %q{Rails engine to parse and render json for Swagger UI}
+  spec.homepage      = "https://github.com/tpitale/swagger_yard-rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 3.2.8"
+  spec.add_dependency "swagger_yard", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bourne"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: swagger_yard-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Pitale
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: swagger_yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  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: Rails engine to parse and render json for Swagger UI
+email:
+- tony.pitale@livingsocial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/swagger_yard/rails.rb
+- lib/swagger_yard/rails/application_controller.rb
+- lib/swagger_yard/rails/engine.rb
+- lib/swagger_yard/rails/swagger_controller.rb
+- lib/swagger_yard/rails/version.rb
+- swagger_yard-rails.gemspec
+homepage: https://github.com/tpitale/swagger_yard-rails
+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: Rails engine to parse and render json for Swagger UI
+test_files: []
+has_rdoc: