kanpachi 0.0.1

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 (83) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +18 -0
  3. data/.travis.yml +13 -0
  4. data/CHANGELOG.md +5 -0
  5. data/Gemfile +6 -0
  6. data/Guardfile +14 -0
  7. data/LICENSE.txt +22 -0
  8. data/README.md +131 -0
  9. data/Rakefile +10 -0
  10. data/bin/kanpachi +17 -0
  11. data/examples/twitter.rb +122 -0
  12. data/kanpachi.gemspec +45 -0
  13. data/lib/base_hash.rb +41 -0
  14. data/lib/kanpachi/api.rb +22 -0
  15. data/lib/kanpachi/api_list.rb +61 -0
  16. data/lib/kanpachi/cli/doc.rb +62 -0
  17. data/lib/kanpachi/cli.rb +32 -0
  18. data/lib/kanpachi/commands/new.rb +26 -0
  19. data/lib/kanpachi/documentation/config.rb +84 -0
  20. data/lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.eot +0 -0
  21. data/lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.svg +228 -0
  22. data/lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.ttf +0 -0
  23. data/lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.woff +0 -0
  24. data/lib/kanpachi/documentation/source/images/background.png +0 -0
  25. data/lib/kanpachi/documentation/source/images/middleman.png +0 -0
  26. data/lib/kanpachi/documentation/source/index.html.slim +25 -0
  27. data/lib/kanpachi/documentation/source/javascripts/all.js +1 -0
  28. data/lib/kanpachi/documentation/source/javascripts/bootstrap.js +1999 -0
  29. data/lib/kanpachi/documentation/source/javascripts/bootstrap.min.js +6 -0
  30. data/lib/kanpachi/documentation/source/javascripts/html5shiv.js +9 -0
  31. data/lib/kanpachi/documentation/source/javascripts/jquery-1.10.2.min.js +6 -0
  32. data/lib/kanpachi/documentation/source/javascripts/respond.min.js +7 -0
  33. data/lib/kanpachi/documentation/source/layouts/layout.slim +55 -0
  34. data/lib/kanpachi/documentation/source/resource.html.slim +61 -0
  35. data/lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.css +384 -0
  36. data/lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.min.css +1 -0
  37. data/lib/kanpachi/documentation/source/stylesheets/bootstrap.css +6805 -0
  38. data/lib/kanpachi/documentation/source/stylesheets/bootstrap.min.css +9 -0
  39. data/lib/kanpachi/documentation/source/stylesheets/jumbotron.css +5 -0
  40. data/lib/kanpachi/dsl/api.rb +90 -0
  41. data/lib/kanpachi/dsl/error.rb +37 -0
  42. data/lib/kanpachi/dsl/resource.rb +110 -0
  43. data/lib/kanpachi/dsl/response.rb +21 -0
  44. data/lib/kanpachi/dsl/section.rb +29 -0
  45. data/lib/kanpachi/dsl.rb +24 -0
  46. data/lib/kanpachi/error.rb +14 -0
  47. data/lib/kanpachi/error_list.rb +51 -0
  48. data/lib/kanpachi/markdown.rb +11 -0
  49. data/lib/kanpachi/resource/params.rb +9 -0
  50. data/lib/kanpachi/resource.rb +56 -0
  51. data/lib/kanpachi/resource_list.rb +71 -0
  52. data/lib/kanpachi/response.rb +68 -0
  53. data/lib/kanpachi/response_list.rb +51 -0
  54. data/lib/kanpachi/section.rb +15 -0
  55. data/lib/kanpachi/section_list.rb +46 -0
  56. data/lib/kanpachi/templates/.gitignore +19 -0
  57. data/lib/kanpachi/templates/Gemfile +4 -0
  58. data/lib/kanpachi/templates/api/api.rb +17 -0
  59. data/lib/kanpachi/templates/api/errors.rb +13 -0
  60. data/lib/kanpachi/templates/api/posts.rb +32 -0
  61. data/lib/kanpachi/templates/api/users.rb +38 -0
  62. data/lib/kanpachi/version.rb +3 -0
  63. data/lib/kanpachi.rb +7 -0
  64. data/spec/api_list_spec.rb +55 -0
  65. data/spec/api_spec.rb +56 -0
  66. data/spec/dsl/api_spec.rb +74 -0
  67. data/spec/dsl/error_spec.rb +38 -0
  68. data/spec/dsl/resource_spec.rb +77 -0
  69. data/spec/dsl/response_spec.rb +31 -0
  70. data/spec/dsl/section_spec.rb +49 -0
  71. data/spec/dsl_spec.rb +46 -0
  72. data/spec/error_list_spec.rb +43 -0
  73. data/spec/error_spec.rb +34 -0
  74. data/spec/full_api_spec.rb +130 -0
  75. data/spec/markdown_spec.rb +12 -0
  76. data/spec/resource/params_spec.rb +11 -0
  77. data/spec/resource_list_spec.rb +53 -0
  78. data/spec/resource_spec.rb +144 -0
  79. data/spec/response_spec.rb +57 -0
  80. data/spec/section_list_spec.rb +39 -0
  81. data/spec/section_spec.rb +20 -0
  82. data/spec/spec_helper.rb +4 -0
  83. metadata +384 -0
@@ -0,0 +1,39 @@
1
+ require_relative 'spec_helper'
2
+
3
+ describe Kanpachi::SectionList do
4
+ subject do
5
+ Kanpachi::SectionList.new
6
+ end
7
+
8
+ let(:users_section) do
9
+ Kanpachi::Section.new('Users')
10
+ end
11
+
12
+ let(:populated_section_list) do
13
+ list = Kanpachi::SectionList.new
14
+ list.add(users_section)
15
+ list
16
+ end
17
+
18
+ it 'initializes empty' do
19
+ subject.all.must_be_empty
20
+ end
21
+
22
+ it 'returns a hash of the internal list, with section names as the key and a Section object as the value' do
23
+ populated_section_list.to_hash.keys.must_include 'Users'
24
+ populated_section_list.to_hash['Users'].must_equal users_section
25
+ end
26
+
27
+ it 'returns an array of Section objects' do
28
+ populated_section_list.all.must_include users_section
29
+ end
30
+
31
+ it 'adds a section' do
32
+ subject.add(users_section)
33
+ subject.all.must_include users_section
34
+ end
35
+
36
+ it 'finds a section by name' do
37
+ populated_section_list.find('Users').must_equal users_section
38
+ end
39
+ end
@@ -0,0 +1,20 @@
1
+ require_relative 'spec_helper'
2
+
3
+ describe Kanpachi::Section do
4
+ subject do
5
+ Kanpachi::Section.new('Posts')
6
+ end
7
+
8
+ it 'initialized with the name' do
9
+ subject.name.must_equal 'Posts'
10
+ end
11
+
12
+ it 'initialized with a routes array' do
13
+ subject.routes.must_equal []
14
+ end
15
+
16
+ it 'has a description accessor' do
17
+ subject.description = 'List all the posts'
18
+ subject.description.must_equal 'List all the posts'
19
+ end
20
+ end
@@ -0,0 +1,4 @@
1
+ require 'minitest/autorun'
2
+ require 'pry'
3
+
4
+ require_relative '../lib/kanpachi'
metadata ADDED
@@ -0,0 +1,384 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: kanpachi
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jack Chu
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-09-28 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: thor
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: slim
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: roar
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: representable
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: mutations
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: virtus
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: 1.0.0.beta7
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: 1.0.0.beta7
97
+ - !ruby/object:Gem::Dependency
98
+ name: coercible
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: kramdown
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :runtime
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: inflecto
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :runtime
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: middleman
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: 3.1.5
146
+ type: :runtime
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: 3.1.5
153
+ - !ruby/object:Gem::Dependency
154
+ name: slim
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - ">="
158
+ - !ruby/object:Gem::Version
159
+ version: 1.3.6
160
+ type: :runtime
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: 1.3.6
167
+ - !ruby/object:Gem::Dependency
168
+ name: middleman-livereload
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - ">="
172
+ - !ruby/object:Gem::Version
173
+ version: 3.1.0
174
+ type: :runtime
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - ">="
179
+ - !ruby/object:Gem::Version
180
+ version: 3.1.0
181
+ - !ruby/object:Gem::Dependency
182
+ name: bundler
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - ">="
193
+ - !ruby/object:Gem::Version
194
+ version: '0'
195
+ - !ruby/object:Gem::Dependency
196
+ name: rake
197
+ requirement: !ruby/object:Gem::Requirement
198
+ requirements:
199
+ - - ">="
200
+ - !ruby/object:Gem::Version
201
+ version: '0'
202
+ type: :development
203
+ prerelease: false
204
+ version_requirements: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: '0'
209
+ - !ruby/object:Gem::Dependency
210
+ name: minitest
211
+ requirement: !ruby/object:Gem::Requirement
212
+ requirements:
213
+ - - ">="
214
+ - !ruby/object:Gem::Version
215
+ version: '0'
216
+ type: :development
217
+ prerelease: false
218
+ version_requirements: !ruby/object:Gem::Requirement
219
+ requirements:
220
+ - - ">="
221
+ - !ruby/object:Gem::Version
222
+ version: '0'
223
+ - !ruby/object:Gem::Dependency
224
+ name: guard
225
+ requirement: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - ">="
228
+ - !ruby/object:Gem::Version
229
+ version: 2.0.0.beta.3
230
+ type: :development
231
+ prerelease: false
232
+ version_requirements: !ruby/object:Gem::Requirement
233
+ requirements:
234
+ - - ">="
235
+ - !ruby/object:Gem::Version
236
+ version: 2.0.0.beta.3
237
+ - !ruby/object:Gem::Dependency
238
+ name: guard-minitest
239
+ requirement: !ruby/object:Gem::Requirement
240
+ requirements:
241
+ - - ">="
242
+ - !ruby/object:Gem::Version
243
+ version: '0'
244
+ type: :development
245
+ prerelease: false
246
+ version_requirements: !ruby/object:Gem::Requirement
247
+ requirements:
248
+ - - ">="
249
+ - !ruby/object:Gem::Version
250
+ version: '0'
251
+ description: Web API DSL
252
+ email:
253
+ - kamuigt@gmail.com
254
+ executables:
255
+ - kanpachi
256
+ extensions: []
257
+ extra_rdoc_files: []
258
+ files:
259
+ - ".gitignore"
260
+ - ".travis.yml"
261
+ - CHANGELOG.md
262
+ - Gemfile
263
+ - Guardfile
264
+ - LICENSE.txt
265
+ - README.md
266
+ - Rakefile
267
+ - bin/kanpachi
268
+ - examples/twitter.rb
269
+ - kanpachi.gemspec
270
+ - lib/base_hash.rb
271
+ - lib/kanpachi.rb
272
+ - lib/kanpachi/api.rb
273
+ - lib/kanpachi/api_list.rb
274
+ - lib/kanpachi/cli.rb
275
+ - lib/kanpachi/cli/doc.rb
276
+ - lib/kanpachi/commands/new.rb
277
+ - lib/kanpachi/documentation/config.rb
278
+ - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.eot
279
+ - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.svg
280
+ - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.ttf
281
+ - lib/kanpachi/documentation/source/fonts/glyphicons-halflings-regular.woff
282
+ - lib/kanpachi/documentation/source/images/background.png
283
+ - lib/kanpachi/documentation/source/images/middleman.png
284
+ - lib/kanpachi/documentation/source/index.html.slim
285
+ - lib/kanpachi/documentation/source/javascripts/all.js
286
+ - lib/kanpachi/documentation/source/javascripts/bootstrap.js
287
+ - lib/kanpachi/documentation/source/javascripts/bootstrap.min.js
288
+ - lib/kanpachi/documentation/source/javascripts/html5shiv.js
289
+ - lib/kanpachi/documentation/source/javascripts/jquery-1.10.2.min.js
290
+ - lib/kanpachi/documentation/source/javascripts/respond.min.js
291
+ - lib/kanpachi/documentation/source/layouts/layout.slim
292
+ - lib/kanpachi/documentation/source/resource.html.slim
293
+ - lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.css
294
+ - lib/kanpachi/documentation/source/stylesheets/bootstrap-theme.min.css
295
+ - lib/kanpachi/documentation/source/stylesheets/bootstrap.css
296
+ - lib/kanpachi/documentation/source/stylesheets/bootstrap.min.css
297
+ - lib/kanpachi/documentation/source/stylesheets/jumbotron.css
298
+ - lib/kanpachi/dsl.rb
299
+ - lib/kanpachi/dsl/api.rb
300
+ - lib/kanpachi/dsl/error.rb
301
+ - lib/kanpachi/dsl/resource.rb
302
+ - lib/kanpachi/dsl/response.rb
303
+ - lib/kanpachi/dsl/section.rb
304
+ - lib/kanpachi/error.rb
305
+ - lib/kanpachi/error_list.rb
306
+ - lib/kanpachi/markdown.rb
307
+ - lib/kanpachi/resource.rb
308
+ - lib/kanpachi/resource/params.rb
309
+ - lib/kanpachi/resource_list.rb
310
+ - lib/kanpachi/response.rb
311
+ - lib/kanpachi/response_list.rb
312
+ - lib/kanpachi/section.rb
313
+ - lib/kanpachi/section_list.rb
314
+ - lib/kanpachi/templates/.gitignore
315
+ - lib/kanpachi/templates/Gemfile
316
+ - lib/kanpachi/templates/api/api.rb
317
+ - lib/kanpachi/templates/api/errors.rb
318
+ - lib/kanpachi/templates/api/posts.rb
319
+ - lib/kanpachi/templates/api/users.rb
320
+ - lib/kanpachi/version.rb
321
+ - spec/api_list_spec.rb
322
+ - spec/api_spec.rb
323
+ - spec/dsl/api_spec.rb
324
+ - spec/dsl/error_spec.rb
325
+ - spec/dsl/resource_spec.rb
326
+ - spec/dsl/response_spec.rb
327
+ - spec/dsl/section_spec.rb
328
+ - spec/dsl_spec.rb
329
+ - spec/error_list_spec.rb
330
+ - spec/error_spec.rb
331
+ - spec/full_api_spec.rb
332
+ - spec/markdown_spec.rb
333
+ - spec/resource/params_spec.rb
334
+ - spec/resource_list_spec.rb
335
+ - spec/resource_spec.rb
336
+ - spec/response_spec.rb
337
+ - spec/section_list_spec.rb
338
+ - spec/section_spec.rb
339
+ - spec/spec_helper.rb
340
+ homepage: https://github.com/kamui/kanpachi
341
+ licenses:
342
+ - MIT
343
+ metadata: {}
344
+ post_install_message:
345
+ rdoc_options: []
346
+ require_paths:
347
+ - lib
348
+ required_ruby_version: !ruby/object:Gem::Requirement
349
+ requirements:
350
+ - - ">="
351
+ - !ruby/object:Gem::Version
352
+ version: '0'
353
+ required_rubygems_version: !ruby/object:Gem::Requirement
354
+ requirements:
355
+ - - ">="
356
+ - !ruby/object:Gem::Version
357
+ version: '0'
358
+ requirements: []
359
+ rubyforge_project:
360
+ rubygems_version: 2.1.4
361
+ signing_key:
362
+ specification_version: 4
363
+ summary: DSL for describing Web APIs
364
+ test_files:
365
+ - spec/api_list_spec.rb
366
+ - spec/api_spec.rb
367
+ - spec/dsl/api_spec.rb
368
+ - spec/dsl/error_spec.rb
369
+ - spec/dsl/resource_spec.rb
370
+ - spec/dsl/response_spec.rb
371
+ - spec/dsl/section_spec.rb
372
+ - spec/dsl_spec.rb
373
+ - spec/error_list_spec.rb
374
+ - spec/error_spec.rb
375
+ - spec/full_api_spec.rb
376
+ - spec/markdown_spec.rb
377
+ - spec/resource/params_spec.rb
378
+ - spec/resource_list_spec.rb
379
+ - spec/resource_spec.rb
380
+ - spec/response_spec.rb
381
+ - spec/section_list_spec.rb
382
+ - spec/section_spec.rb
383
+ - spec/spec_helper.rb
384
+ has_rdoc: