swaggard 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc0127d02018fc6d808dd075a2efe9f2b384a258
-  data.tar.gz: 395c2b2d482e2c7b0167f0fc1f3a87b9295122a0
+  metadata.gz: ecc218894a718358cb55794cbe31c0506761fcca
+  data.tar.gz: b45ab232037649703f9b277be8104a2c9df607de
 SHA512:
-  metadata.gz: d3da1c11103fe8137f3db66f3b1453a4739b673965e44776f046f4e4413660ffc74971445fe2cce13e61d9cfe59fa060706f94bca5ce40f6b2ec1d37d47341a0
-  data.tar.gz: 7b4e5171883091484020d9adf44581e357635786eb3200c38bea1aa1f90bb96921fe1d8b359ce82e8fd2321d459fc2a745e7eb7f1ccb9a4dac6b491b87c855b4
+  metadata.gz: 0bdc966974f63e4b95560412522ba5fe587df415a673bc94214bb3188cea43d8439748bbd5604f7b60ccd4353e949b7d569e46fb28c9c44fd15060a6e57b2301
+  data.tar.gz: 9b3ec08e20ff8c589ec17fe6abc9f174791acb706648c4647133828313c8f2e0e54fe3ce5af416583ed51157bebd81aacbf2d7bec88e0c5c6494bb9b20ffdfbc

data/README.md

@@ -29,17 +29,13 @@ Install the gem with Bundler:
 
     bundle install
 
-
 ## Getting Started
 
-Place your configuration in a your rails initializers
+First generate a Swaggard configuration initializer file.
 
-    # config/initializers/swaggard.rb
+    rails g swaggard:install
 
-    Swaggard.configure do |config|
-      config.api_version = '0.1'
-      config.api_base_path = '/api' # The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/).
-    end
+This will install the file `swaggard.rb` to your Rails `config/initializers` directory which you can then alter the config.
 
 Mount your engine
 

data/lib/generators/swaggard/install_generator.rb

@@ -0,0 +1,13 @@
+module Swaggard
+  class InstallGenerator < Rails::Generators::Base
+
+    desc "Installs a Swaggard initializer config"
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer
+      dest = File.join("config/initializers", "swaggard.rb")
+      template "swaggard.rb", dest
+    end
+
+  end
+end

data/lib/generators/swaggard/templates/swaggard.rb

@@ -0,0 +1,96 @@
+# Swaggard configuration settings and their current default values... override
+# as you see fit.
+#
+# For more info on configuration settings see http://swagger.io/specification/
+
+Swaggard.configure do |config|
+  # Set an access password.
+  # See https://github.com/adrian-gomez/swaggard#access-authorization for more info
+  # config.access_password = ""
+
+  # Set an access username. If you don't set an access_username, everyone will
+  # have access to Swagger documentation.
+  # See https://github.com/adrian-gomez/swaggard#access-authorization for more info
+  # config.access_username = ""
+
+  # Swaggard supports additional parameters to be sent on every request,
+  # either as a header or as part of the query.
+  # See https://github.com/adrian-gomez/swaggard#additional-parameters for more info
+  # config.additional_parameters = []
+
+  # The base path on which the API is served, which is relative to the host.
+  # If it is not included, the API is served directly under the host.
+  # The value MUST start with a leading slash (/).
+  # config.api_base_path = "/"
+
+  # Specify the API formats.
+  # config.api_formats = [:xml, :json]
+
+  #  The version of the application API.
+  # config.api_version = "0.1"
+
+  # Set an API authentication key
+  # See https://github.com/adrian-gomez/swaggard#authentication for more details
+  # config.authentication_key = "api_key"
+
+  # Set the API authentication type, either header or query
+  # See https://github.com/adrian-gomez/swaggard#authentication for more details
+  # config.authentication_type = "query"
+
+  # Set the API authentication value
+  # See https://github.com/adrian-gomez/swaggard#authentication for more details
+  # config.authentication_value = ""
+
+  # The contact email for the API.
+  # config.contact_email = ""
+
+  # The contact email for the API.
+  # config.contact_name = ""
+
+  # The contact url for the API.
+  # config.contact_url = ""
+
+  # Specify where to look for your controllers
+  # config.controllers_path = "#{Rails.root}/app/controllers/**/*.rb"
+
+  # Specify a default content type for requests to use in SwaggerUI.
+  # See https://github.com/adrian-gomez/swaggard#default-content-type for more info
+  # config.default_content_type = ""
+
+  # A short description of the application.
+  # config.description = ""
+
+  # The host (name or ip) serving the API.
+  # This MUST be the host only and does not include the scheme nor sub-paths.
+  # config.host = ""
+
+  # The language to display SwaggerUI in.
+  # See https://github.com/adrian-gomez/swaggard#language for more info
+  # config.language = "en"
+
+  # The name of the Licence eg. MIT
+  # config.license_name = ""
+
+  # The URL of the Licence info
+  # config.license_url = ""
+
+  # Specify one or more paths to look for your model documentation
+  # config.models_paths = ["#{app.root}/app/serializers/**/*.rb"]
+
+  # The transfer protocol of the API.
+  # Values MUST be from the list: "http", "https", "ws", "wss"
+  # config.schemes = [:https, :http]
+
+  # Specifies the Swagger Specification version being used.
+  # config.swagger_version = "2.0"
+
+  # The title of the application/API.
+  # config.title = ""
+
+  # The Terms of Service for the API.
+  # config.tos = ""
+
+  # Specify whether to cache the Swagger docs or not.
+  # See https://github.com/adrian-gomez/swaggard#caching for more info
+  # config.use_cache = false
+end

data/lib/swaggard/configuration.rb

@@ -14,10 +14,10 @@ module Swaggard
 
     attr_accessor :controllers_path, :models_paths, :routes
 
-    attr_writer :swagger_version, :api_base_path, :api_version, :api_path, :api_formats, :title,
+    attr_writer :swagger_version, :api_base_path, :api_version, :api_formats, :title,
                 :description, :tos, :contact_email, :contact_name, :contact_url, :host,
                 :authentication_type, :authentication_key, :authentication_value,
-                :access_username, :access_password, :default_content_type, :use_cache, :module_name,
+                :access_username, :access_password, :default_content_type, :use_cache,
                 :language, :additional_parameters, :schemes
 
     def swagger_version
@@ -28,10 +28,6 @@ module Swaggard
       @api_version ||= '0.1'
     end
 
-    def api_path
-      @api_path ||= ''
-    end
-
     def api_base_path
       @api_base_path ||= '/'
     end
@@ -116,9 +112,5 @@ module Swaggard
       @use_cache ||= false
     end
 
-    def module_name
-      @module_name ||= ''
-    end
-
   end
 end

data/lib/swaggard/swagger/tag.rb

@@ -7,11 +7,9 @@ module Swaggard
       attr_reader :controller_class
 
       def initialize(yard_object)
-        @yard_name = yard_object.name
-
         controller_name = "#{yard_object.namespace}::#{yard_object.name}"
-        controller_name.prepend("#{Swaggard.configuration.module_name}::") unless Swaggard.configuration.module_name.blank?
 
+        @yard_name = yard_object.name
         @controller_class = controller_name.constantize
 
         tag = yard_object.tags.find { |tag| tag.tag_name == 'tag' }
@@ -29,4 +27,4 @@ module Swaggard
 
     end
   end
-end
+end

data/lib/swaggard/version.rb

@@ -1,5 +1,5 @@
 module Swaggard
 
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Adrian Gomez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,6 +160,8 @@ files:
 - app/views/swaggard/swagger/index.html.erb
 - config/initializers/assets.rb
 - config/routes.rb
+- lib/generators/swaggard/install_generator.rb
+- lib/generators/swaggard/templates/swaggard.rb
 - lib/swaggard.rb
 - lib/swaggard/api_definition.rb
 - lib/swaggard/configuration.rb