easy_api_doc 0.2.1

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+#
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '18a1f49101bca5a4a99fad28daba98c284bac08d686d20b87c0ac6503d832b9d32475ef16135fee5a8dc23abd9d1ffdcae7ba1855e56ab083749b1e36b67cbb0'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount EasyApiDoc::Engine => "/api_doc"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/doc/api_doc.yml

@@ -0,0 +1,104 @@
+api:
+  v2:
+    private:
+      description: API For Mule
+      detail: Loyalty Mule Service API
+      formats: 'json'
+      defaults:
+        uri: /v1
+      resources:
+
+        #===============================================================
+        # transactions
+        #===============================================================
+
+        transactions:
+          authentication:
+            type: oauth_bearer
+            access_token:
+          description: Transaction resource
+          actions:
+            create:
+              http_method: POST
+              uri: /v1/private/transactions
+              description: Create a new transaction. Transaction data is provided as a JSON structure in the request body. See Col's Google doc for data structure.
+  v1:
+    defaults:
+      domain: localhost:3000
+      protocol: http
+    private:
+      description: Our private (internal) API
+      detail: blah blah blah - longer description
+      formats: 'json, xml'
+      defaults:
+        uri: /api/v1/private
+      authentication:
+        type: basic
+        user: admin
+        password: password
+      resources:
+        members:
+          description: 'List all the Harry members, and perform updates'
+          actions:
+            index:
+              http_method: GET
+              uri: /api/v1/private/members
+              description: List all the members
+              parameters:
+                page:
+                  type: integer
+                  default: 1
+                per_page:
+                  type: integer
+                  default: 20
+            show:
+              http_method: GET
+              uri: /api/v1/private/members/:id
+              description: Show the details for a single member
+              parameters:
+                id:
+                  type: integer
+                  example: 1
+            post_update:
+              http_method: POST
+              uri: /api/v1/private/members/:id
+              description: Update the member's attributes
+              post_data:
+                example: '{"key": "value"}'
+            update:
+              http_method: PUT
+              uri: /api/v1/private/members/:id
+              description: Update the member's attributes
+              parameters:
+                id:
+                  type: integer
+                  example: 1
+                member:
+                  email:
+                    type: string
+                  email_confirmation:
+                    type: string
+                  title:
+                    type: string
+                  first_name:
+                    type: string
+                  middle_names:
+                    type: string
+                  last_name:
+                    type: string
+                  date_of_birth:
+                    type: string
+                    info: 'YYYY-MM-DD'
+                  gender:
+                    type: string
+                    info: 'M|F'
+                  mobile_area:
+                    type: string
+                  mobile:
+                    type: string
+                  home_phone_area:
+                    type: string
+                  home_phone:
+                    type: string
+                  work_phone:
+                    type: string