apipierails3 0.0.1

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,52 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  # config.serve_static_assets = true
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+
+  # Eager load code on boot (Rails 5)
+  config.eager_load = true
+end

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

@@ -0,0 +1,38 @@
+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
+
+  # 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
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+
+  # Do not eager load code on boot. (Rails 5)
+  config.eager_load = false
+end

data/spec/dummy/config/initializers/apipie.rb

@@ -0,0 +1,110 @@
+Apipie.configure do |config|
+  config.app_name = "Test app"
+  config.copyright = "© 2012 Pavel Pokorny"
+  config.languages = ['en']
+  config.default_locale = 'en'
+
+  # set default API version
+  # can be overriden in resource_description
+  # by default is it 1.0 if not specified anywhere
+  # this must be defined before api_base_url and app_info
+  config.default_version = "development".freeze
+
+  config.doc_base_url = "/apidoc"
+
+  # default version base url
+  # to define base url for specifid version use
+  # config.api_base_url[version] = url
+  # or define it in your base controller
+  config.api_base_url = "/api"
+
+  # set to true to turn on/off the cache. To generate the cache use:
+  #
+  #     rake apipie:cache
+  #
+  config.use_cache = Rails.env.production?
+  # config.cache_dir = File.join(Rails.root, "public", "apipie-cache") # optional
+
+  # set to enable/disable reloading controllers (and the documentation with it),
+  # by default enabled in development
+  # config.reload_controllers = false
+
+  # for reloading to work properly you need to specify where your api controllers are (like in Dir.glob):
+  config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
+
+  # specify routes if your application uses router differ from Rails default one
+  config.api_routes = Rails.application.routes
+
+  # config.markup = choose one of:
+  #   Apipie::Markup::RDoc.new [default]
+  #   Apipie::Markup::Markdown.new
+  #   Apipie::Markup::Textile.new
+  # or provide another class with to_html(text) instance method
+  # to disable markup, use
+  # config.markup = nil
+
+  config.validate = false
+
+  # set all parameters as required by default
+  # if enabled, use param :name, val, :required => false for optional params
+  config.required_by_default = false
+
+  # set default version info, to describe specific version use
+  # config.app_info[version] = description
+  # or put this in your base or application controller
+  config.app_info = "Dummy app for testing"
+
+  # show debug informations
+  config.debug = false
+
+  # set all parameters as required by default
+  # if enabled, use param :name, val, :required => false for optional params
+  config.required_by_default = false
+
+  # use custom layout
+  # use Apipie.include_stylesheets and Apipie.include_javascripts
+  # to include apipies css and js
+  config.layout = "application"
+
+  # specify disqus site shortname to show discusion on each page
+  # to show it in custom layout, use `render 'disqus' if Apipie.configuration.use_disqus?`
+  # config.disqus_shortname = 'paveltest'
+
+  # Hide '.html' extensions.  Note that '.html' extensions are forced
+  # when generating static documentation
+  # config.link_extension = ""
+end
+
+# integer validator
+class Apipie::Validator::IntegerValidator < Apipie::Validator::BaseValidator
+
+  def initialize(param_description, argument)
+    super(param_description)
+    @type = argument
+  end
+
+  def validate(value)
+    return false if value.nil?
+    !!(value.to_s =~ /^[-+]?[0-9]+$/)
+  end
+
+  def self.build(param_description, argument, options, block)
+    if argument == Integer || argument == Fixnum
+      self.new(param_description, argument)
+    end
+  end
+
+  def error
+    # Newer style is to return an instance of ParamInvalid.  Keeping this
+    # to test backwards compatibility.
+    "Parameter #{param_name} expecting to be #{@type.name}, got: #{@error_value.class.name}"
+  end
+
+  def description
+    "Parameter has to be #{@type}."
+  end
+
+  def expected_type
+    'numeric'
+  end
+end

data/spec/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/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# 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

data/spec/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/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,8 @@
+# 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 = '431a859f504c40942b0caa3a740492b8bfd87c7898db4b1c39557f440f1cdda99c54810ad81f6ba7e1cece75bc079caa52a5cb54dbd085effd038ba283b837ce'
+Dummy::Application.config.secret_key_base = '431a859f504c40942b0caa3a740492b8bfd87c7898db4b1c39557f440f1cdda99c54810ad81f6ba7e1cece75bc079caa52a5cb54dbd085effd038ba283b837ce'

data/spec/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/spec/dummy/config/locales/en.yml

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

data/spec/dummy/config/routes.rb

@@ -0,0 +1,51 @@
+Dummy::Application.routes.draw do
+
+  scope ENV['RAILS_RELATIVE_URL_ROOT'] || '/' do
+
+    scope '/api' do
+      resources :users do
+        collection do
+          post :create_route
+        end
+      end
+      resources :concerns, :only => [:index, :show]
+      namespace :files do
+        get '/*file_path', format: false, :action => 'download'
+      end
+
+      # This is not directly used in the specs.
+      # It is only there to tests apipies tolerance regarding
+      # missing controllers.
+      resources :dangeling_stuff
+      resources :twitter_example do
+        collection do
+          get :lookup
+          get 'profile_image/:screen_name' => 'twitter_example#profile_image'
+          get :search
+          get :search
+          get :contributors
+        end
+      end
+
+      get "/pets/return_and_validate_expected_response" => "pets#return_and_validate_expected_response"
+      get "/pets/return_and_validate_expected_array_response" => "pets#return_and_validate_expected_array_response"
+      get "/pets/return_and_validate_type_mismatch" => "pets#return_and_validate_type_mismatch"
+      get "/pets/return_and_validate_missing_field" => "pets#return_and_validate_missing_field"
+      get "/pets/return_and_validate_extra_property" => "pets#return_and_validate_extra_property"
+      get "/pets/return_and_validate_allowed_extra_property" => "pets#return_and_validate_allowed_extra_property"
+      get "/pets/sub_object_invalid_extra_property" => "pets#sub_object_invalid_extra_property"
+      get "/pets/sub_object_allowed_extra_property" => "pets#sub_object_allowed_extra_property"
+      get "/pets/return_and_validate_unexpected_array_response" => "pets#return_and_validate_unexpected_array_response"
+      get "/pets/return_and_validate_expected_response_with_null" => "pets#return_and_validate_expected_response_with_null"
+      get "/pets/return_and_validate_expected_response_with_null_object" => "pets#return_and_validate_expected_response_with_null_object"
+
+      get "/pets/returns_response_with_valid_array" => "pets#returns_response_with_valid_array"
+      get "/pets/returns_response_with_invalid_array" => "pets#returns_response_with_invalid_array"
+      get "/pets/undocumented_method" => "pets#undocumented_method"
+    end
+
+    apipie
+  end
+  root :to => 'apipie/apipies#index'
+  match '(/)*path' => redirect('http://www.example.com'), :via => :all
+end

data/spec/dummy/doc/apipie_examples.json

@@ -0,0 +1 @@
+{"users#show":[{"verb":"GET","path":"/users/15","query":null,"request_data":null,"response_data":null,"code":"404","show_in_doc":2,"recorded":true},{"verb":"GET","path":"/users/14","query":"verbose=true","request_data":null,"response_data":"{\n  \"name\": \"Test User\"\n}","code":"200","show_in_doc":1,"recorded":true},{"verb":"GET","path":"/users/15","query":"verbose=true","request_data":null,"response_data":"{\n  \"name\": \"Test User\"\n}","code":"200","show_in_doc":0,"recorded":true}]}

data/spec/dummy/doc/users/desc_from_file.md

@@ -0,0 +1 @@
+description from document

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/lib/application_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Apipie::Application do
+
+  describe "api_controllers_paths" do
+    before { Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"), File.join(Rails.root, "lib", "**","*.rb")] }
+
+    it "should support receiving array as parameter" do
+      expect { Apipie.api_controllers_paths}.
+        not_to raise_error
+    end
+
+
+  end
+
+  describe "get_resource_name" do
+    subject {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
+
+    context "with namespaced_resources enabled" do
+      before { Apipie.configuration.namespaced_resources = true }
+      context "with a defined base url" do
+        
+        it "should not overwrite the parent resource" do
+          is_expected.not_to eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+        end
+        
+      end
+
+      context "with an undefined base url" do
+        before {allow(Apipie.app).to receive(:get_base_url) { nil }}
+
+        it "should not raise an error" do
+          expect { Apipie.get_resource_name(Api::V2::ArchitecturesController) }.
+            not_to raise_error
+        end
+      end
+
+      after { Apipie.configuration.namespaced_resources = false }
+    end
+
+    context "with namespaced_resources enabled" do
+      before { Apipie.configuration.namespaced_resources = false }
+
+      it "should overwrite the the parent" do
+        is_expected.to eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+      end
+    end
+  end
+end