rspec_api_documentation 1.0.0 → 1.1.0

data/lib/rspec_api_documentation/configuration.rb

@@ -36,9 +36,9 @@ module RspecApiDocumentation
 
     add_setting :docs_dir, :default => lambda { |config|
       if defined?(Rails)
-        Rails.root.join("docs")
+        Rails.root.join("doc", "api")
       else
-        Pathname.new("docs")
+        Pathname.new("doc/api")
       end
     }
 

data/lib/rspec_api_documentation/dsl.rb

@@ -14,4 +14,4 @@ end
 RSpec.configuration.include RspecApiDocumentation::DSL::Resource, :api_doc_dsl => :resource
 RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl => :endpoint
 RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback
-RSpec.configuration.backtrace_clean_patterns << %r{lib/rspec_api_documentation/dsl\.rb}
+RSpec.configuration.backtrace_exclusion_patterns << %r{lib/rspec_api_documentation/dsl\.rb}

data/lib/rspec_api_documentation/dsl/resource.rb

@@ -42,6 +42,8 @@ module RspecApiDocumentation::DSL
       end
 
       def required_parameters(*names)
+        warn "required_parameters is no longer supported. Please use parameter :name, '', :required => true instead."
+
         names.each do |name|
           param = parameters.find { |param| param[:name] == name.to_s }
           raise "Undefined parameters can not be required." unless param
@@ -50,6 +52,8 @@ module RspecApiDocumentation::DSL
       end
 
       def scope_parameters(scope, keys)
+        warn "scope_paramters is no longer supported. Please use parameter :name, '', :scope => 'scope' instead."
+
         return unless metadata[:parameters]
 
         if keys == :all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -20,7 +20,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -230,33 +230,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rspec_api_documentation.rb
-- lib/tasks/docs.rake
-- lib/rspec_api_documentation/rack_test_client.rb
+- lib/rspec_api_documentation/api_documentation.rb
 - lib/rspec_api_documentation/api_formatter.rb
+- lib/rspec_api_documentation/client_base.rb
+- lib/rspec_api_documentation/configuration.rb
 - lib/rspec_api_documentation/curl.rb
-- lib/rspec_api_documentation/index.rb
-- lib/rspec_api_documentation/headers.rb
-- lib/rspec_api_documentation/oauth2_mac_client.rb
 - lib/rspec_api_documentation/dsl/callback.rb
 - lib/rspec_api_documentation/dsl/endpoint.rb
 - lib/rspec_api_documentation/dsl/resource.rb
 - lib/rspec_api_documentation/dsl.rb
-- lib/rspec_api_documentation/writers/html_writer.rb
-- lib/rspec_api_documentation/writers/json_iodocs_writer.rb
-- lib/rspec_api_documentation/writers/json_writer.rb
+- lib/rspec_api_documentation/example.rb
+- lib/rspec_api_documentation/headers.rb
+- lib/rspec_api_documentation/index.rb
+- lib/rspec_api_documentation/oauth2_mac_client.rb
+- lib/rspec_api_documentation/rack_test_client.rb
+- lib/rspec_api_documentation/railtie.rb
+- lib/rspec_api_documentation/test_server.rb
 - lib/rspec_api_documentation/writers/combined_json_writer.rb
+- lib/rspec_api_documentation/writers/combined_text_writer.rb
 - lib/rspec_api_documentation/writers/formatter.rb
+- lib/rspec_api_documentation/writers/html_writer.rb
 - lib/rspec_api_documentation/writers/index_writer.rb
-- lib/rspec_api_documentation/writers/combined_text_writer.rb
-- lib/rspec_api_documentation/configuration.rb
-- lib/rspec_api_documentation/example.rb
-- lib/rspec_api_documentation/api_documentation.rb
-- lib/rspec_api_documentation/test_server.rb
-- lib/rspec_api_documentation/railtie.rb
-- lib/rspec_api_documentation/client_base.rb
-- templates/rspec_api_documentation/html_index.mustache
+- lib/rspec_api_documentation/writers/json_iodocs_writer.rb
+- lib/rspec_api_documentation/writers/json_writer.rb
+- lib/rspec_api_documentation.rb
+- lib/tasks/docs.rake
 - templates/rspec_api_documentation/html_example.mustache
+- templates/rspec_api_documentation/html_index.mustache
 homepage: http://smartlogicsolutions.com
 licenses: []
 post_install_message: