rspec_api_documentation 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/lib/rspec_api_documentation/configuration.rb +2 -2
  2. data/lib/rspec_api_documentation/dsl.rb +1 -1
  3. data/lib/rspec_api_documentation/dsl/resource.rb +4 -0
  4. metadata +21 -21
data/lib/rspec_api_documentation/configuration.rb CHANGED
@@ -36,9 +36,9 @@ module RspecApiDocumentation
36
36
 
37
37
  add_setting :docs_dir, :default => lambda { |config|
38
38
  if defined?(Rails)
39
- Rails.root.join("docs")
39
+ Rails.root.join("doc", "api")
40
40
  else
41
- Pathname.new("docs")
41
+ Pathname.new("doc/api")
42
42
  end
43
43
  }
44
44
 
data/lib/rspec_api_documentation/dsl.rb CHANGED
@@ -14,4 +14,4 @@ end
14
14
  RSpec.configuration.include RspecApiDocumentation::DSL::Resource, :api_doc_dsl => :resource
15
15
  RSpec.configuration.include RspecApiDocumentation::DSL::Endpoint, :api_doc_dsl => :endpoint
16
16
  RSpec.configuration.include RspecApiDocumentation::DSL::Callback, :api_doc_dsl => :callback
17
- RSpec.configuration.backtrace_clean_patterns << %r{lib/rspec_api_documentation/dsl\.rb}
17
+ RSpec.configuration.backtrace_exclusion_patterns << %r{lib/rspec_api_documentation/dsl\.rb}
data/lib/rspec_api_documentation/dsl/resource.rb CHANGED
@@ -42,6 +42,8 @@ module RspecApiDocumentation::DSL
42
42
  end
43
43
 
44
44
  def required_parameters(*names)
45
+ warn "required_parameters is no longer supported. Please use parameter :name, '', :required => true instead."
46
+
45
47
  names.each do |name|
46
48
  param = parameters.find { |param| param[:name] == name.to_s }
47
49
  raise "Undefined parameters can not be required." unless param
@@ -50,6 +52,8 @@ module RspecApiDocumentation::DSL
50
52
  end
51
53
 
52
54
  def scope_parameters(scope, keys)
55
+ warn "scope_paramters is no longer supported. Please use parameter :name, '', :scope => 'scope' instead."
56
+
53
57
  return unless metadata[:parameters]
54
58
 
55
59
  if keys == :all
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rspec_api_documentation
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -11,7 +11,7 @@ authors:
11
11
  autorequire:
12
12
  bindir: bin
13
13
  cert_chain: []
14
- date: 2013-06-24 00:00:00.000000000 Z
14
+ date: 2013-08-12 00:00:00.000000000 Z
15
15
  dependencies:
16
16
  - !ruby/object:Gem::Dependency
17
17
  name: rspec
@@ -20,7 +20,7 @@ dependencies:
20
20
  requirements:
21
21
  - - ! '>='
22
22
  - !ruby/object:Gem::Version
23
- version: 2.6.0
23
+ version: 2.14.0
24
24
  type: :runtime
25
25
  prerelease: false
26
26
  version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
28
28
  requirements:
29
29
  - - ! '>='
30
30
  - !ruby/object:Gem::Version
31
- version: 2.6.0
31
+ version: 2.14.0
32
32
  - !ruby/object:Gem::Dependency
33
33
  name: activesupport
34
34
  requirement: !ruby/object:Gem::Requirement
@@ -230,33 +230,33 @@ executables: []
230
230
  extensions: []
231
231
  extra_rdoc_files: []
232
232
  files:
233
- - lib/rspec_api_documentation.rb
234
- - lib/tasks/docs.rake
235
- - lib/rspec_api_documentation/rack_test_client.rb
233
+ - lib/rspec_api_documentation/api_documentation.rb
236
234
  - lib/rspec_api_documentation/api_formatter.rb
235
+ - lib/rspec_api_documentation/client_base.rb
236
+ - lib/rspec_api_documentation/configuration.rb
237
237
  - lib/rspec_api_documentation/curl.rb
238
- - lib/rspec_api_documentation/index.rb
239
- - lib/rspec_api_documentation/headers.rb
240
- - lib/rspec_api_documentation/oauth2_mac_client.rb
241
238
  - lib/rspec_api_documentation/dsl/callback.rb
242
239
  - lib/rspec_api_documentation/dsl/endpoint.rb
243
240
  - lib/rspec_api_documentation/dsl/resource.rb
244
241
  - lib/rspec_api_documentation/dsl.rb
245
- - lib/rspec_api_documentation/writers/html_writer.rb
246
- - lib/rspec_api_documentation/writers/json_iodocs_writer.rb
247
- - lib/rspec_api_documentation/writers/json_writer.rb
242
+ - lib/rspec_api_documentation/example.rb
243
+ - lib/rspec_api_documentation/headers.rb
244
+ - lib/rspec_api_documentation/index.rb
245
+ - lib/rspec_api_documentation/oauth2_mac_client.rb
246
+ - lib/rspec_api_documentation/rack_test_client.rb
247
+ - lib/rspec_api_documentation/railtie.rb
248
+ - lib/rspec_api_documentation/test_server.rb
248
249
  - lib/rspec_api_documentation/writers/combined_json_writer.rb
250
+ - lib/rspec_api_documentation/writers/combined_text_writer.rb
249
251
  - lib/rspec_api_documentation/writers/formatter.rb
252
+ - lib/rspec_api_documentation/writers/html_writer.rb
250
253
  - lib/rspec_api_documentation/writers/index_writer.rb
251
- - lib/rspec_api_documentation/writers/combined_text_writer.rb
252
- - lib/rspec_api_documentation/configuration.rb
253
- - lib/rspec_api_documentation/example.rb
254
- - lib/rspec_api_documentation/api_documentation.rb
255
- - lib/rspec_api_documentation/test_server.rb
256
- - lib/rspec_api_documentation/railtie.rb
257
- - lib/rspec_api_documentation/client_base.rb
258
- - templates/rspec_api_documentation/html_index.mustache
254
+ - lib/rspec_api_documentation/writers/json_iodocs_writer.rb
255
+ - lib/rspec_api_documentation/writers/json_writer.rb
256
+ - lib/rspec_api_documentation.rb
257
+ - lib/tasks/docs.rake
259
258
  - templates/rspec_api_documentation/html_example.mustache
259
+ - templates/rspec_api_documentation/html_index.mustache
260
260
  homepage: http://smartlogicsolutions.com
261
261
  licenses: []
262
262
  post_install_message: