grape-slate 0.0.5 → 0.0.6

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 10faf662012762adfcb5d997d46eafa934a9ab00
4
+ data.tar.gz: 0419db39c050d34c4afa19a409685a6bd081a1db
5
+ SHA512:
6
+ metadata.gz: 72c688ad034d69d7670d3d464654da8286c03f10dc59db97d98e534bda9e98764ef49bc6dbd856e35f61bc5c3f0b954d0b9aec713fe350d2c41986ad646f4bbc
7
+ data.tar.gz: 615cc0784dfbf2a5ed5ab59648cc59203fbf0bbe550a35734b2e85ab649ef80bfa6c603b3860e14c35204909b69cc57ba738ed68556918cc2eee11e6b77010bd
@@ -1,8 +1,10 @@
1
1
  AllCops:
2
2
  Excludes:
3
+ - Guardfile
3
4
  - Rakefile
4
- - vendor/**
5
- - bin/**
5
+ - grape-slate.gemspec
6
+ - vendor/**/*
7
+ - bin/**/*
6
8
 
7
9
  Documentation:
8
10
  # don't require classes to be documented
@@ -16,3 +18,6 @@ LineLength:
16
18
  # just one more character please
17
19
  Max: 80
18
20
 
21
+ Style/FileName:
22
+ # ok to requre grape-markdown gem
23
+ Enabled: false
data/Rakefile CHANGED
@@ -11,7 +11,7 @@ end
11
11
 
12
12
  require 'rainbow/ext/string' unless String.respond_to?(:color)
13
13
  require 'rubocop/rake_task'
14
- Rubocop::RakeTask.new(:rubocop)
14
+ RuboCop::RakeTask.new(:rubocop)
15
15
 
16
16
  task default: [:rubocop, :spec]
17
17
 
@@ -1,58 +1,62 @@
1
- class GrapeSlate::ExampleGenerator::Shell
2
- attr_reader :route, :resource
1
+ module GrapeSlate
2
+ module ExampleGenerator
3
+ class Shell
4
+ attr_reader :route, :resource
3
5
 
4
- delegate :route_name, to: :route
5
- delegate :host, :request_headers, to: 'GrapeMarkdown::Configuration'
6
+ delegate :route_name, to: :route
7
+ delegate :host, :request_headers, to: 'GrapeMarkdown::Configuration'
6
8
 
7
- def initialize(route, resource)
8
- @route = route
9
- @resource = resource
10
- end
9
+ def initialize(route, resource)
10
+ @route = route
11
+ @resource = resource
12
+ end
11
13
 
12
- def lines
13
- @lines ||= [command, request, data, headers, verbose].flatten.compact
14
- end
14
+ def lines
15
+ @lines ||= [command, request, data, headers, verbose].flatten.compact
16
+ end
15
17
 
16
- def example_binding
17
- binding
18
- end
18
+ def example_binding
19
+ binding
20
+ end
19
21
 
20
- private
22
+ private
21
23
 
22
- def method
23
- route.route_method
24
- end
24
+ def method
25
+ route.route_method
26
+ end
25
27
 
26
- def route_path
27
- route.route_path_without_format
28
- end
28
+ def route_path
29
+ route.route_path_without_format
30
+ end
29
31
 
30
- def command
31
- path = route_path.split('/').reject!(&:empty?).join('/')
32
- "curl #{host}/#{path}"
33
- end
32
+ def command
33
+ path = route_path.split('/').reject!(&:empty?).join('/')
34
+ "curl #{host}/#{path}"
35
+ end
34
36
 
35
- def request_by_id?
36
- method == 'GET' && !route.list? || %w(PUT DELETE).include?(method)
37
- end
37
+ def request_by_id?
38
+ method == 'GET' && !route.list? || %w(PUT DELETE).include?(method)
39
+ end
38
40
 
39
- def request
40
- return unless %w(POST PUT DELETE).include?(method)
41
+ def request
42
+ return unless %w(POST PUT DELETE).include?(method)
41
43
 
42
- "--request #{method}"
43
- end
44
+ "--request #{method}"
45
+ end
44
46
 
45
- def data
46
- return unless %w(POST PUT).include?(method)
47
+ def data
48
+ return unless %w(POST PUT).include?(method)
47
49
 
48
- "--data '#{resource.sample_request(false)}'"
49
- end
50
+ "--data '#{resource.sample_request(false)}'"
51
+ end
50
52
 
51
- def headers
52
- request_headers.map { |header| "--header '#{header.first.join(': ')}'" }
53
- end
53
+ def headers
54
+ request_headers.map { |header| "--header '#{header.first.join(': ')}'" }
55
+ end
54
56
 
55
- def verbose
56
- '--verbose'
57
+ def verbose
58
+ '--verbose'
59
+ end
60
+ end
57
61
  end
58
62
  end
@@ -1,7 +1,7 @@
1
1
  ### URL Parameters
2
2
 
3
- | Name | Type | Description |
4
- |:-----|:-----|:------------|
3
+ | Required | Name | Type | Description |
4
+ |:--------:|:-----|:-----|:------------|
5
5
  <% unique_params.each do |param| -%>
6
- | <%= param.full_name %> | <%= param.type %> | <%= param.desc %> |
7
- <% end -%>
6
+ | <%= "✓" if param.requirement == 'required' %> | <%= param.full_name %> | <%= param.type %> | <%= param.desc %> |
7
+ <% end -%>
@@ -1,3 +1,3 @@
1
1
  module GrapeSlate
2
- VERSION = '0.0.5'
2
+ VERSION = '0.0.6'
3
3
  end
@@ -1,7 +1,7 @@
1
1
  class SampleApi < Grape::API
2
2
  resource 'widgets' do
3
3
  desc 'widgets list'
4
- get '/' do
4
+ get '/' do
5
5
  end
6
6
 
7
7
  desc 'individual widget'
@@ -27,7 +27,7 @@ class SampleApi < Grape::API
27
27
  optional :name, type: 'string', desc: 'the widgets name'
28
28
  optional :description, type: 'string', desc: 'the widgets name'
29
29
  end
30
- put ':id' do
30
+ put ':id' do
31
31
  end
32
32
  end
33
33
 
metadata CHANGED
@@ -1,174 +1,153 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: grape-slate
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.5
5
- prerelease:
4
+ version: 0.0.6
6
5
  platform: ruby
7
6
  authors:
8
7
  - John Allen
9
8
  autorequire:
10
9
  bindir: bin
11
10
  cert_chain: []
12
- date: 2014-03-26 00:00:00.000000000 Z
11
+ date: 2015-02-27 00:00:00.000000000 Z
13
12
  dependencies:
14
13
  - !ruby/object:Gem::Dependency
15
14
  name: grape-markdown
16
15
  requirement: !ruby/object:Gem::Requirement
17
- none: false
18
16
  requirements:
19
- - - ~>
17
+ - - "~>"
20
18
  - !ruby/object:Gem::Version
21
19
  version: 0.0.5
22
20
  type: :runtime
23
21
  prerelease: false
24
22
  version_requirements: !ruby/object:Gem::Requirement
25
- none: false
26
23
  requirements:
27
- - - ~>
24
+ - - "~>"
28
25
  - !ruby/object:Gem::Version
29
26
  version: 0.0.5
30
27
  - !ruby/object:Gem::Dependency
31
28
  name: coveralls
32
29
  requirement: !ruby/object:Gem::Requirement
33
- none: false
34
30
  requirements:
35
- - - ~>
31
+ - - "~>"
36
32
  - !ruby/object:Gem::Version
37
33
  version: '0.7'
38
34
  type: :development
39
35
  prerelease: false
40
36
  version_requirements: !ruby/object:Gem::Requirement
41
- none: false
42
37
  requirements:
43
- - - ~>
38
+ - - "~>"
44
39
  - !ruby/object:Gem::Version
45
40
  version: '0.7'
46
41
  - !ruby/object:Gem::Dependency
47
42
  name: rspec
48
43
  requirement: !ruby/object:Gem::Requirement
49
- none: false
50
44
  requirements:
51
- - - ~>
45
+ - - "~>"
52
46
  - !ruby/object:Gem::Version
53
47
  version: '2.14'
54
48
  type: :development
55
49
  prerelease: false
56
50
  version_requirements: !ruby/object:Gem::Requirement
57
- none: false
58
51
  requirements:
59
- - - ~>
52
+ - - "~>"
60
53
  - !ruby/object:Gem::Version
61
54
  version: '2.14'
62
55
  - !ruby/object:Gem::Dependency
63
56
  name: bundler
64
57
  requirement: !ruby/object:Gem::Requirement
65
- none: false
66
58
  requirements:
67
- - - ~>
59
+ - - "~>"
68
60
  - !ruby/object:Gem::Version
69
61
  version: '1.5'
70
62
  type: :development
71
63
  prerelease: false
72
64
  version_requirements: !ruby/object:Gem::Requirement
73
- none: false
74
65
  requirements:
75
- - - ~>
66
+ - - "~>"
76
67
  - !ruby/object:Gem::Version
77
68
  version: '1.5'
78
69
  - !ruby/object:Gem::Dependency
79
70
  name: rake
80
71
  requirement: !ruby/object:Gem::Requirement
81
- none: false
82
72
  requirements:
83
- - - ~>
73
+ - - "~>"
84
74
  - !ruby/object:Gem::Version
85
75
  version: '10.0'
86
76
  type: :development
87
77
  prerelease: false
88
78
  version_requirements: !ruby/object:Gem::Requirement
89
- none: false
90
79
  requirements:
91
- - - ~>
80
+ - - "~>"
92
81
  - !ruby/object:Gem::Version
93
82
  version: '10.0'
94
83
  - !ruby/object:Gem::Dependency
95
84
  name: rubocop
96
85
  requirement: !ruby/object:Gem::Requirement
97
- none: false
98
86
  requirements:
99
- - - ~>
87
+ - - "~>"
100
88
  - !ruby/object:Gem::Version
101
89
  version: '0.18'
102
90
  type: :development
103
91
  prerelease: false
104
92
  version_requirements: !ruby/object:Gem::Requirement
105
- none: false
106
93
  requirements:
107
- - - ~>
94
+ - - "~>"
108
95
  - !ruby/object:Gem::Version
109
96
  version: '0.18'
110
97
  - !ruby/object:Gem::Dependency
111
98
  name: pry
112
99
  requirement: !ruby/object:Gem::Requirement
113
- none: false
114
100
  requirements:
115
- - - ~>
101
+ - - "~>"
116
102
  - !ruby/object:Gem::Version
117
103
  version: '0.9'
118
104
  type: :development
119
105
  prerelease: false
120
106
  version_requirements: !ruby/object:Gem::Requirement
121
- none: false
122
107
  requirements:
123
- - - ~>
108
+ - - "~>"
124
109
  - !ruby/object:Gem::Version
125
110
  version: '0.9'
126
111
  - !ruby/object:Gem::Dependency
127
112
  name: guard
128
113
  requirement: !ruby/object:Gem::Requirement
129
- none: false
130
114
  requirements:
131
- - - ~>
115
+ - - "~>"
132
116
  - !ruby/object:Gem::Version
133
117
  version: '2.4'
134
118
  type: :development
135
119
  prerelease: false
136
120
  version_requirements: !ruby/object:Gem::Requirement
137
- none: false
138
121
  requirements:
139
- - - ~>
122
+ - - "~>"
140
123
  - !ruby/object:Gem::Version
141
124
  version: '2.4'
142
125
  - !ruby/object:Gem::Dependency
143
126
  name: guard-rspec
144
127
  requirement: !ruby/object:Gem::Requirement
145
- none: false
146
128
  requirements:
147
- - - ~>
129
+ - - "~>"
148
130
  - !ruby/object:Gem::Version
149
131
  version: '4.2'
150
132
  type: :development
151
133
  prerelease: false
152
134
  version_requirements: !ruby/object:Gem::Requirement
153
- none: false
154
135
  requirements:
155
- - - ~>
136
+ - - "~>"
156
137
  - !ruby/object:Gem::Version
157
138
  version: '4.2'
158
139
  - !ruby/object:Gem::Dependency
159
140
  name: guard-bundler
160
141
  requirement: !ruby/object:Gem::Requirement
161
- none: false
162
142
  requirements:
163
- - - ~>
143
+ - - "~>"
164
144
  - !ruby/object:Gem::Version
165
145
  version: '2.0'
166
146
  type: :development
167
147
  prerelease: false
168
148
  version_requirements: !ruby/object:Gem::Requirement
169
- none: false
170
149
  requirements:
171
- - - ~>
150
+ - - "~>"
172
151
  - !ruby/object:Gem::Version
173
152
  version: '2.0'
174
153
  description: Auto generates a Slate (https://github.com/tripit/slate) document from
@@ -179,10 +158,10 @@ executables: []
179
158
  extensions: []
180
159
  extra_rdoc_files: []
181
160
  files:
182
- - .gitignore
183
- - .rspec
184
- - .rubocop.yml
185
- - .travis.yml
161
+ - ".gitignore"
162
+ - ".rspec"
163
+ - ".rubocop.yml"
164
+ - ".travis.yml"
186
165
  - Gemfile
187
166
  - Guardfile
188
167
  - LICENSE.txt
@@ -207,27 +186,26 @@ files:
207
186
  homepage: https://github.com/connexio-labs/grape-slate
208
187
  licenses:
209
188
  - MIT
189
+ metadata: {}
210
190
  post_install_message:
211
191
  rdoc_options: []
212
192
  require_paths:
213
193
  - lib
214
194
  required_ruby_version: !ruby/object:Gem::Requirement
215
- none: false
216
195
  requirements:
217
- - - ! '>='
196
+ - - ">="
218
197
  - !ruby/object:Gem::Version
219
198
  version: '0'
220
199
  required_rubygems_version: !ruby/object:Gem::Requirement
221
- none: false
222
200
  requirements:
223
- - - ! '>='
201
+ - - ">="
224
202
  - !ruby/object:Gem::Version
225
203
  version: '0'
226
204
  requirements: []
227
205
  rubyforge_project:
228
- rubygems_version: 1.8.23
206
+ rubygems_version: 2.4.5
229
207
  signing_key:
230
- specification_version: 3
208
+ specification_version: 4
231
209
  summary: Allows for generating a Slate document for your Grape API
232
210
  test_files:
233
211
  - spec/grape-slate/document_spec.rb