grape-cherry 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f8fe7426b74dd2c839f8247cc614062d5947b12a
4
+ data.tar.gz: 7f7ac4e7e02bb44593b7e9274e840ef44455e57a
5
+ SHA512:
6
+ metadata.gz: e8d915f0e4b08ed163a77897d1547347d06b6c7a7c6b535dbbc9aa0faa0919f70b17538122f960db8d39d0f959eb45ea97508e57972257d8c2f0e12f264edbd9
7
+ data.tar.gz: f6a447c104e9fc1666238d2d6bb15aeeb90d31f45500b22f5852ee6c6653b104686654faaa371b7025a9d6053bd7a6f397713215d6650a24612e68feb7f2193d
@@ -0,0 +1,81 @@
1
+ .env
2
+ *.rbc
3
+ capybara-*.html
4
+ .rspec
5
+ /log
6
+ /tmp
7
+ /db/*.sqlite3
8
+ /public/system
9
+ /coverage/
10
+ /spec/tmp
11
+ **.orig
12
+ rerun.txt
13
+ pickle-email-*.html
14
+
15
+ /public/uploads
16
+
17
+ # TODO Comment out these rules if you are OK with secrets being uploaded to the repo
18
+ # config/initializers/secret_token.rb
19
+ # config/secrets.yml
20
+
21
+ ## Environment normalisation:
22
+ /.bundle
23
+ /vendor/bundle
24
+
25
+ # these should all be checked in to normalise the environment:
26
+ # Gemfile.lock, .ruby-version, .ruby-gemset
27
+
28
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
29
+ .rvmrc
30
+
31
+ # if using bower-rails ignore default bower_components path bower.json files
32
+ /vendor/assets/bower_components
33
+ *.bowerrc
34
+ bower.json
35
+
36
+ *.gem
37
+
38
+ # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
39
+
40
+ /*.iml
41
+
42
+ ## Directory-based project format:
43
+ .idea/
44
+ # if you remove the above rule, at least ignore the following:
45
+
46
+ # User-specific stuff:
47
+ # .idea/workspace.xml
48
+ # .idea/tasks.xml
49
+ # .idea/dictionaries
50
+
51
+ # Sensitive or high-churn files:
52
+ # .idea/dataSources.ids
53
+ # .idea/dataSources.xml
54
+ # .idea/sqlDataSources.xml
55
+ # .idea/dynamic.xml
56
+ # .idea/uiDesigner.xml
57
+
58
+ # Gradle:
59
+ # .idea/gradle.xml
60
+ # .idea/libraries
61
+
62
+ # Mongo Explorer plugin:
63
+ # .idea/mongoSettings.xml
64
+
65
+ ## File-based project format:
66
+ *.ipr
67
+ *.iws
68
+
69
+ ## Plugin-specific files:
70
+
71
+ # IntelliJ
72
+ out/
73
+
74
+ # mpeltonen/sbt-idea plugin
75
+ .idea_modules/
76
+
77
+ # JIRA plugin
78
+ atlassian-ide-plugin.xml
79
+
80
+ # Crashlytics plugin (for Android Studio and IntelliJ)
81
+ com_crashlytics_export_strings.xml
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in grape_cherry.gemspec
4
+ gemspec
@@ -0,0 +1,17 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ cherry (0.0.1)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ rake (10.1.0)
10
+
11
+ PLATFORMS
12
+ ruby
13
+
14
+ DEPENDENCIES
15
+ bundler (~> 1.7)
16
+ cherry!
17
+ rake (~> 10.0)
@@ -0,0 +1,339 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Lesser General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License along
307
+ with this program; if not, write to the Free Software Foundation, Inc.,
308
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309
+
310
+ Also add information on how to contact you by electronic and paper mail.
311
+
312
+ If the program is interactive, make it output a short notice like this
313
+ when it starts in an interactive mode:
314
+
315
+ Gnomovision version 69, Copyright (C) year name of author
316
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317
+ This is free software, and you are welcome to redistribute it
318
+ under certain conditions; type `show c' for details.
319
+
320
+ The hypothetical commands `show w' and `show c' should show the appropriate
321
+ parts of the General Public License. Of course, the commands you use may
322
+ be called something other than `show w' and `show c'; they could even be
323
+ mouse-clicks or menu items--whatever suits your program.
324
+
325
+ You should also get your employer (if you work as a programmer) or your
326
+ school, if any, to sign a "copyright disclaimer" for the program, if
327
+ necessary. Here is a sample; alter the names:
328
+
329
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
331
+
332
+ <signature of Ty Coon>, 1 April 1989
333
+ Ty Coon, President of Vice
334
+
335
+ This General Public License does not permit incorporating your program into
336
+ proprietary programs. If your program is a subroutine library, you may
337
+ consider it more useful to permit linking proprietary applications with the
338
+ library. If this is what you want to do, use the GNU Lesser General
339
+ Public License instead of this License.
@@ -0,0 +1,31 @@
1
+ # Cherry
2
+
3
+ Cherry is a flavor of RESTful API development which provides you with the ability to generate endpoints from model resources. Cherry requires the Grape API gem.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'cherry'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle install
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install cherry
20
+
21
+ ## Usage
22
+
23
+
24
+
25
+ ## Contributing
26
+
27
+ 1. Fork it ( https://github.com/[my-github-username]/cherry/fork )
28
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
29
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
30
+ 4. Push to the branch (`git push origin my-new-feature`)
31
+ 5. Create a new Pull Request
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'grape_cherry/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = 'grape-cherry'
8
+ spec.version = '0.0.3'
9
+ spec.authors = ['Joshua Tyree']
10
+ spec.email = ['joshuat@createthebridge.com']
11
+ spec.summary = %q{Cherry is a flavor of Grape API Development which is focused on rapid convention-based RESTful API development.}
12
+ spec.description = %q{Cherry is a flavor of Grape API Development which is focused on rapid convention-based RESTful API development.}
13
+ spec.homepage = 'https://github.com/CreateTheBridge/cherry'
14
+ spec.license = 'GNU GPL v2.0'
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ['lib']
20
+
21
+ spec.add_development_dependency 'bundler', '~> 1.7'
22
+ spec.add_development_dependency 'rake', '~> 10.0'
23
+ spec.add_development_dependency 'grape', '~> 0.10.0'
24
+ spec.add_development_dependency 'lumberjack'
25
+ end
@@ -0,0 +1,117 @@
1
+ module GrapeCherry
2
+ module Generators
3
+ class ApiGenerator < Rails::Generators::Base
4
+ source_root File.expand_path('../templates/api', __FILE__)
5
+
6
+ argument :resource_name, required: true
7
+
8
+ class_option :format, aliases: '-f', type: :string, desc: 'The format the API will use. Valid options include "XML" and "JSON"', default: 'json'
9
+ class_option :api_version, aliases: '-v', type: :string, desc: 'The version of API this endpoint is being generated for.', default: 'v1'
10
+ class_option :resource_class, aliases: '-c', type: :string, desc: 'The class of the resource if different than the name of the resource'
11
+
12
+ # def echo_constant
13
+ # puts "Type: #{type.to_s}"
14
+ # end
15
+
16
+
17
+ def generate_api_base
18
+ # if File.exist? 'app/controllers/api/base.rb'
19
+ #
20
+ # else
21
+ # template 'base.rb', 'app/controllers/api/base.rb'
22
+ # end
23
+ end
24
+
25
+ def generate_api_version
26
+
27
+ end
28
+
29
+ def generate_api_endpoint
30
+ template 'resource.rb', file_path
31
+ template 'helpers.rb', helpers_path
32
+ end
33
+
34
+
35
+ private
36
+ def valid_format
37
+ unless options.format.downcase == 'xml' or options.format.downcase == 'json'
38
+ options.format = 'json'
39
+ end
40
+ options.format.downcase
41
+ end
42
+
43
+ def content_type
44
+ "content_type :#{valid_format}, 'application/#{valid_format}'"
45
+ end
46
+
47
+ def version
48
+ options.api_version
49
+ end
50
+
51
+ def resource
52
+ resource_name.downcase.pluralize.camelize
53
+ end
54
+
55
+ def namespace
56
+ "API::#{version.upcase}::#{resource}"
57
+ end
58
+
59
+ def helpers_namespace
60
+ "API::#{version.upcase}::Helpers::#{resource_name.camelize}Helpers"
61
+ end
62
+
63
+ def file_path
64
+ "app/controllers/api/#{version}/#{resource.underscore}.rb"
65
+ end
66
+
67
+ def helpers_path
68
+ "app/controllers/api/#{version}/helpers/#{resource_name.underscore}_helpers.rb"
69
+ end
70
+
71
+ def type_name
72
+ if options.resource_class.present?
73
+ options.resource_class.camelize
74
+ else
75
+ resource_name.camelize
76
+ end
77
+ end
78
+
79
+ def type
80
+ if options.resource_class.present?
81
+ options.resource_class.constantize
82
+ else
83
+ resource_name.constantize
84
+ end
85
+ end
86
+
87
+ def type_hash
88
+ {
89
+ :string => String,
90
+ :decimal => BigDecimal,
91
+ :integer => Integer,
92
+ :datetime => DateTime,
93
+ :date => Date
94
+ }
95
+ end
96
+
97
+ def attribute_required?(attribute)
98
+ type.validators_on(attribute).map(&:class).include?(ActiveRecord::Validations::PresenceValidator)
99
+ end
100
+
101
+ def attribute_type(attribute)
102
+ attr_type = type.columns_hash[attribute.to_s].type
103
+ if type_hash.include? attr_type
104
+ type_hash[attr_type].to_s
105
+ else
106
+ String.to_s
107
+ end
108
+ end
109
+
110
+ def attributes
111
+ type.attribute_names.map {|attribute| attribute.downcase.to_sym }
112
+ end
113
+
114
+ end
115
+ end
116
+ end
117
+
@@ -0,0 +1,6 @@
1
+ module API
2
+ class Base < Grape::API
3
+ format :json
4
+
5
+ end
6
+ end
@@ -0,0 +1,23 @@
1
+ module <%= helpers_namespace %>
2
+ extend Grape::API::Helpers
3
+
4
+
5
+ params :<%= resource_name.underscore %>_params do
6
+ <% attributes.each do |attr| %>
7
+ <% if attribute_required? attr.to_sym %>requires :<%= attr %>, type: <%= attribute_type(attr) %><% else %>optional :<%= attr %>, type: <%= attribute_type(attr) %><% end %><% end %>
8
+
9
+ end
10
+
11
+ def <%= resource_name.underscore %>_params
12
+ params.require(:<%= resource_name.underscore %>).permit(
13
+ <% attributes.each do |e| %>
14
+ :<%= e %>, <% end %>
15
+
16
+ )
17
+ end
18
+
19
+ def logger
20
+ Grape::API.logger
21
+ end
22
+
23
+ end
@@ -0,0 +1,84 @@
1
+ class <%= namespace %> < Grape::API
2
+ <%= content_type %>
3
+ version '<%= version.downcase %>'
4
+ format :json
5
+ logger Lumberjack::Logger.new('logs/api/<%= version.downcase %>/<%= resource.underscore %>.log')
6
+ helpers <%= helpers_namespace %>
7
+
8
+ resource :<%= resource.underscore %> do
9
+ # GET: /<%= resource.underscore %>
10
+ get do
11
+ begin
12
+ <%= type_name %>.all
13
+ rescue => e
14
+ logger.error e
15
+ error! 'An unexpected server error has occurred', 500
16
+ end
17
+
18
+ end
19
+
20
+ # GET: /<%= resource.underscore %>/:id
21
+ get ':id', requirements: { id: /[0-9]*/ } do
22
+ begin
23
+ <%= type_name %>.find params[:id]
24
+ rescue ActiveRecord::RecordNotFound => e
25
+ logger.error e
26
+ error! 'Resource not found', 404
27
+ end
28
+ end
29
+
30
+ # POST /<%= resource.underscore %>
31
+ params do
32
+ use :<%= resource_name.underscore %>_params
33
+ end
34
+ post do
35
+ begin
36
+ <%= type_name %>.create!(<%= resource_name.underscore %>_params)
37
+ rescue ActiveRecord::RecordInvalid => e
38
+ logger.error e
39
+ error! e, 400
40
+ rescue => e
41
+ logger.error e
42
+ error! 'An unexpected server error has occurred', 500
43
+ end
44
+ end
45
+
46
+ # PUT /<%= resource.underscore %>/:id
47
+ params do
48
+ use :<%= resource_name.underscore %>_params
49
+ end
50
+ put ':id', requirements: { id: /[0-9]*/ } do
51
+ begin
52
+ @<%= resource_name.underscore %> = <%= type_name %>.find params[:id]
53
+ @<%= resource_name.underscore %>.update(<%= resource_name.underscore %>_params)
54
+ rescue ActiveRecord::RecordNotFound => e
55
+ logger.error e
56
+ error! 'Resource not found', 404
57
+ rescue ActiveRecord::RecordInvalid => e
58
+ logger.error e
59
+ error! e, 400
60
+ rescue => e
61
+ logger.error e
62
+ error! 'An unexpected server error has occurred', 500
63
+ end
64
+ end
65
+
66
+ # DELETE /<%= resource.underscore %>:id
67
+ delete ':id', requirements: { id: /[0-9]*/ } do
68
+ begin
69
+ @<%= resource_name.underscore %> = <%= type_name %>.find params[:id]
70
+ @<%= resource_name.underscore %>.destroy!
71
+ rescue ActiveRecord::RecordNotFound => e
72
+ logger.error e
73
+ error! 'Resource not found', 404
74
+ rescue ActiveRecord::RecordNotDestroyed => e
75
+ logger.error e
76
+ error! "Failed to destroy record: #{e.to_s}", 400
77
+ rescue => e
78
+ logger.error e
79
+ error! 'An unexpected server error has occurred', 500
80
+ end
81
+ end
82
+ end
83
+
84
+ end
@@ -0,0 +1,6 @@
1
+ require 'grape_cherry/version'
2
+
3
+
4
+ module GrapeCherry
5
+
6
+ end
@@ -0,0 +1 @@
1
+ VERSION = '0.0.3'
metadata ADDED
@@ -0,0 +1,115 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: grape-cherry
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.3
5
+ platform: ruby
6
+ authors:
7
+ - Joshua Tyree
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-12-22 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: grape
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 0.10.0
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 0.10.0
55
+ - !ruby/object:Gem::Dependency
56
+ name: lumberjack
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Cherry is a flavor of Grape API Development which is focused on rapid
70
+ convention-based RESTful API development.
71
+ email:
72
+ - joshuat@createthebridge.com
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - Gemfile
79
+ - Gemfile.lock
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - grape_cherry.gemspec
84
+ - lib/generators/grape_cherry/api_generator.rb
85
+ - lib/generators/grape_cherry/templates/api/base.rb
86
+ - lib/generators/grape_cherry/templates/api/helpers.rb
87
+ - lib/generators/grape_cherry/templates/api/resource.rb
88
+ - lib/grape_cherry.rb
89
+ - lib/grape_cherry/version.rb
90
+ homepage: https://github.com/CreateTheBridge/cherry
91
+ licenses:
92
+ - GNU GPL v2.0
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.2.2
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Cherry is a flavor of Grape API Development which is focused on rapid convention-based
114
+ RESTful API development.
115
+ test_files: []