swaggard 0.0.4

data/lib/swaggard/swagger/response.rb

@@ -0,0 +1,45 @@
+module Swaggard
+  module Swagger
+    class Response
+
+      attr_reader :status_code
+
+      def initialize(status_code, value)
+        @status_code = status_code
+        parse(value)
+      end
+
+      def to_doc
+        {
+          'schema' => response_model
+        }
+      end
+
+      private
+
+      def parse(value)
+        @is_array_response = value =~ /Array/
+        @response_class = if @is_array_response
+                            value.match(/^Array<(.*)>$/)[1]
+                          else
+                            value
+                          end
+      end
+
+      def response_model
+        if @is_array_response
+          {
+            'type'           => 'array',
+            'items'          => {
+              '$ref'        => "#/definitions/#@response_class"
+            }
+          }
+        else
+          { '$ref' => "#/definitions/#@response_class" }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/tag.rb

@@ -0,0 +1,28 @@
+module Swaggard
+  module Swagger
+    class Tag
+
+      attr_accessor :name, :description
+
+      attr_reader :controller_class
+
+      def initialize(yard_object)
+        @yard_name = yard_object.name
+        @controller_class = "#{yard_object.namespace}::#{yard_object.name}".constantize
+
+        tag = yard_object.tags.find { |tag| tag.tag_name == 'tag' }
+
+        @name =  tag ? tag.text : "#{@controller_class.controller_path}"
+        @description = yard_object.docstring || ''
+      end
+
+      def to_doc
+        {
+          'name'        => @name,
+          'description' => @description
+        }
+      end
+
+    end
+  end
+end

data/lib/swaggard/swagger/type.rb

@@ -0,0 +1,72 @@
+module Swaggard
+  module Swagger
+    class Type
+
+      attr_reader :name
+
+      def self.new(types)
+        type = super
+
+        all[type.name] = type
+
+        type
+      end
+
+      def self.all
+        @all ||= {}
+      end
+
+      def initialize(types)
+        parse(types)
+      end
+
+      def to_doc
+        doc = if @is_array
+                { 'type' => 'array' }
+              else
+                { type_tag => type_name }
+              end
+
+
+        doc.merge!({ 'items' => { type_tag => type_name } }) if @is_array
+
+        doc
+      end
+
+      private
+
+      def parse(types)
+        parts = types.first.split(/[<>]/)
+
+        @name = parts.last
+        @is_array = parts.grep(/array/i).any?
+      end
+
+      # TODO: have this look at resource listing?
+      def ref?
+        self.class.all[@name].present?
+      end
+
+      def model_name
+        ref? ? @name : nil
+      end
+
+      def type_tag
+        if ref?
+          '$ref'
+        else
+          'type'
+        end
+      end
+
+      def type_name
+        if ref?
+          "#/definitions/#{name}"
+        else
+          name
+        end
+      end
+
+    end
+  end
+end

data/lib/swaggard/version.rb

@@ -0,0 +1,5 @@
+module Swaggard
+
+  VERSION = '0.0.4'
+
+end

data/spec/fixtures/api.json

@@ -0,0 +1 @@
+{"swagger":"2.0","info":{"description":"","version":"0.1","title":"","termsOfService":"","contact":{"email":""},"license":{"name":"","url":""}},"host":"","basePath":null,"tags":[{"name":"pets","description":"This document describes the API for interacting with Pet resources"}],"schemes":["http"],"paths":{"/pets":{"get":{"tags":["pets"],"summary":"return a list of Pets","description":"","operationId":"index","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[],"responses":{}}},"/pets/{id}":{"get":{"tags":["pets"],"summary":"return a Pet","description":"","operationId":"show","consumes":["application/xml","application/json"],"produces":["application/xml","application/json"],"parameters":[{"in":"query","name":"id","description":"The ID for the Pet","required":false,"type":"integer"},{"in":"path","name":"id","description":"Scope response to id","required":true,"type":"string"}],"responses":{}}}},"definitions":{}}

data/spec/fixtures/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fixtures/dummy/app/controllers/pets_controller.rb

@@ -0,0 +1,15 @@
+# This document describes the API for interacting with Pet resources
+class PetsController < ApplicationController
+
+  # return a list of Pets
+  #
+  def index
+  end
+
+  # return a Pet
+  #
+  # @query_parameter [Integer] id The ID for the Pet
+  def show
+  end
+
+end

data/spec/fixtures/dummy/config/application.rb

@@ -0,0 +1,15 @@
+require 'action_controller/railtie'
+
+# Load Swaggard
+require File.expand_path('../../../../../lib/swaggard', __FILE__)
+
+module Dummy
+  class Application < Rails::Application
+    config.root = File.expand_path('../../', __FILE__)
+
+    # Disable the asset pipeline.
+    config.assets.enabled = false
+  end
+end
+
+Dummy::Application.initialize!

data/spec/fixtures/dummy/config/environments/development.rb

@@ -0,0 +1,5 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+  config.eager_load = true
+  config.cache_store = :null_store
+end

data/spec/fixtures/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Dummy::Application.routes.draw do
+
+  resources :pets, only: [:index, :show]
+
+end

data/spec/integration/swaggard_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Swaggard, '.get_doc' do
+
+  let(:controller_path) { File.expand_path('../../fixtures/dummy/app/controllers/pets_controller.rb', __FILE__) }
+  let(:api_json)        { File.read(File.expand_path('../../fixtures/api.json', __FILE__)) }
+
+  it 'generates swagger json' do
+    Swaggard.configure do |config|
+      config.controllers_path = controller_path
+      config.routes = Dummy::Application.routes.routes
+    end
+
+    swagger_json = JSON.dump(Swaggard.get_doc)
+
+    expect(swagger_json).to eq(api_json)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+SimpleCov.start
+
+ENV["RAILS_ENV"] = "development"
+
+require 'bundler/setup'
+
+require 'rspec'
+require 'mocha/api'
+require 'bourne'
+
+# Load Rails, which loads our swaggard
+require File.expand_path('../fixtures/dummy/config/application.rb', __FILE__)
+
+# require File.expand_path('../../lib/swaggard', __FILE__)
+
+# Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.mock_with :mocha
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: swaggard
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Adrian Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate swagger documentation for your Rails REST API using YARD
+email:
+- adrian.gomez@moove-it.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/fonts/swaggard/droid-sans-v6-latin-700.eot
+- app/assets/fonts/swaggard/droid-sans-v6-latin-700.svg
+- app/assets/fonts/swaggard/droid-sans-v6-latin-700.ttf
+- app/assets/fonts/swaggard/droid-sans-v6-latin-700.woff
+- app/assets/fonts/swaggard/droid-sans-v6-latin-700.woff2
+- app/assets/fonts/swaggard/droid-sans-v6-latin-regular.eot
+- app/assets/fonts/swaggard/droid-sans-v6-latin-regular.svg
+- app/assets/fonts/swaggard/droid-sans-v6-latin-regular.ttf
+- app/assets/fonts/swaggard/droid-sans-v6-latin-regular.woff
+- app/assets/fonts/swaggard/droid-sans-v6-latin-regular.woff2
+- app/assets/images/swaggard/logo_small.png
+- app/assets/images/swaggard/pet_store_api.png
+- app/assets/images/swaggard/throbber.gif
+- app/assets/images/swaggard/wordnik_api.png
+- app/assets/javascripts/swaggard/application.js
+- app/assets/javascripts/swaggard/lib/MD5.js
+- app/assets/javascripts/swaggard/lib/backbone-min.js
+- app/assets/javascripts/swaggard/lib/handlebars-1.0.rc.1.js
+- app/assets/javascripts/swaggard/lib/handlebars-2.0.0.js
+- app/assets/javascripts/swaggard/lib/highlight.7.3.pack.js
+- app/assets/javascripts/swaggard/lib/jquery-1.8.0.min.js
+- app/assets/javascripts/swaggard/lib/jquery.ba-bbq.min.js
+- app/assets/javascripts/swaggard/lib/jquery.slideto.min.js
+- app/assets/javascripts/swaggard/lib/jquery.wiggle.min.js
+- app/assets/javascripts/swaggard/lib/marked.js
+- app/assets/javascripts/swaggard/lib/shred.bundle.js
+- app/assets/javascripts/swaggard/lib/swagger-client.js
+- app/assets/javascripts/swaggard/lib/swagger.js
+- app/assets/javascripts/swaggard/lib/underscore-min.js
+- app/assets/javascripts/swaggard/swagger-ui.js
+- app/assets/javascripts/swaggard/swagger-ui_org.js
+- app/assets/stylesheets/swaggard/application.css
+- app/assets/stylesheets/swaggard/reset.css
+- app/assets/stylesheets/swaggard/screen.css.scss
+- app/assets/stylesheets/swaggard/typography.css.scss
+- app/controllers/swaggard/application_controller.rb
+- app/controllers/swaggard/swagger_controller.rb
+- app/views/swaggard/swagger/index.html.erb
+- config/routes.rb
+- lib/swaggard.rb
+- lib/swaggard/api_definition.rb
+- lib/swaggard/configuration.rb
+- lib/swaggard/engine.rb
+- lib/swaggard/parsers/controllers.rb
+- lib/swaggard/parsers/models.rb
+- lib/swaggard/parsers/routes.rb
+- lib/swaggard/swagger/definition.rb
+- lib/swaggard/swagger/operation.rb
+- lib/swaggard/swagger/parameters/base.rb
+- lib/swaggard/swagger/parameters/body.rb
+- lib/swaggard/swagger/parameters/form.rb
+- lib/swaggard/swagger/parameters/list.rb
+- lib/swaggard/swagger/parameters/path.rb
+- lib/swaggard/swagger/parameters/query.rb
+- lib/swaggard/swagger/path.rb
+- lib/swaggard/swagger/property.rb
+- lib/swaggard/swagger/response.rb
+- lib/swaggard/swagger/tag.rb
+- lib/swaggard/swagger/type.rb
+- lib/swaggard/version.rb
+- spec/fixtures/api.json
+- spec/fixtures/dummy/app/controllers/application_controller.rb
+- spec/fixtures/dummy/app/controllers/pets_controller.rb
+- spec/fixtures/dummy/config/application.rb
+- spec/fixtures/dummy/config/environments/development.rb
+- spec/fixtures/dummy/config/routes.rb
+- spec/fixtures/dummy/log/development.log
+- spec/integration/swaggard_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Moove-it/swaggard
+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.6
+signing_key: 
+specification_version: 4
+summary: 'Swaggard: Swagger Rails REST API doc using yard YARD'
+test_files:
+- spec/fixtures/api.json
+- spec/fixtures/dummy/app/controllers/application_controller.rb
+- spec/fixtures/dummy/app/controllers/pets_controller.rb
+- spec/fixtures/dummy/config/application.rb
+- spec/fixtures/dummy/config/environments/development.rb
+- spec/fixtures/dummy/config/routes.rb
+- spec/fixtures/dummy/log/development.log
+- spec/integration/swaggard_spec.rb
+- spec/spec_helper.rb
+has_rdoc: