rails_base_api_scaffold 0.1.0 → 0.1.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 (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -4
  3. data/lib/rails_base_api_scaffold/version.rb +1 -1
  4. data/rails_base_api_scaffold-0.1.0.gem +0 -0
  5. metadata +14 -13
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c38e6bc51f540f22efd5882a5fb4a95554da5413
4
- data.tar.gz: 29e0fd7eb9891501824db16ae222ac0b5ab8ff1b
3
+ metadata.gz: 0f90d8932dd2c491300c535a9e079620e8f5ac29
4
+ data.tar.gz: 52a3c2dd7a520c7f5ea152521356d8f7af555a34
5
5
  SHA512:
6
- metadata.gz: 4f2ee067976ae6d80a6a751da5a1a31fc433807356c9ce918e23960f61b34d35749cfe2de7423de888b5d034d429458d98d147a185f1857a2d36a1170b098a2b
7
- data.tar.gz: 878346c6ff445be1f3ee8abe7450e6cac5e587e8c9ad273eae1bf1946540f3ea1240e6185c09f1aae32b7c5ba2a79f61b31c2bba279b17854afd4cc1efec5332
6
+ metadata.gz: 8e8c6b6a862d30b895f57fa85ca2124128fe191ed0821aca199c047d0098346c8677a738222efc4c0fb89cb28729c7b095349fcbfaf45204d8a8b0f87beadb5d
7
+ data.tar.gz: 230e667334125a603e999dc3f204beeed9b3ac25d502418bf9b790ceee8f87ac401f89ef7298ec32c646b29ebd2246e54508470f8a13ff0d2f2efe39c8a3c83e
data/README.md CHANGED
@@ -1,8 +1,6 @@
1
1
  # RailsBaseApiScaffold
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_base_api_scaffold`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ Generate API controller scaffolds for E7System's Rails Base API. The generator will create a CRUD API controller, create the controller's spec, add its route to `routes.rb`, and create a serializer for its model. Note that a model must exist before the generator can be run. See Usage for more info.
6
4
 
7
5
  ## Installation
8
6
 
@@ -22,7 +20,19 @@ Or install it yourself as:
22
20
 
23
21
  ## Usage
24
22
 
25
- TODO: Write usage instructions here
23
+ Before generating the scaffold you must generate the model using the built-in rails model generator.
24
+
25
+ ```
26
+ rails g model friend name:string age:integer
27
+ ```
28
+
29
+ After the model has been created, you can run the generator.
30
+
31
+ ```
32
+ rails g rails_base_api_scaffold:controller friend
33
+ ```
34
+
35
+ That's it! You should now have an API controller, serializer, route, and API controller spec for your model.
26
36
 
27
37
  ## Development
28
38
 
data/lib/rails_base_api_scaffold/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module RailsBaseApiScaffold
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
data/rails_base_api_scaffold-0.1.0.gem ADDED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rails_base_api_scaffold
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Christian McCormick
@@ -14,42 +14,42 @@ dependencies:
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ~>
17
+ - - "~>"
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.15'
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - ~>
24
+ - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.15'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rake
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - ~>
31
+ - - "~>"
32
32
  - !ruby/object:Gem::Version
33
33
  version: '10.0'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - ~>
38
+ - - "~>"
39
39
  - !ruby/object:Gem::Version
40
40
  version: '10.0'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rspec
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - ~>
45
+ - - "~>"
46
46
  - !ruby/object:Gem::Version
47
47
  version: '3.0'
48
48
  type: :development
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
- - - ~>
52
+ - - "~>"
53
53
  - !ruby/object:Gem::Version
54
54
  version: '3.0'
55
55
  description:
@@ -59,9 +59,9 @@ executables: []
59
59
  extensions: []
60
60
  extra_rdoc_files: []
61
61
  files:
62
- - .gitignore
63
- - .rspec
64
- - .travis.yml
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
65
  - Gemfile
66
66
  - README.md
67
67
  - Rakefile
@@ -74,6 +74,7 @@ files:
74
74
  - lib/generators/rails_base_api_scaffold/templates/spec.rb
75
75
  - lib/rails_base_api_scaffold.rb
76
76
  - lib/rails_base_api_scaffold/version.rb
77
+ - rails_base_api_scaffold-0.1.0.gem
77
78
  - rails_base_api_scaffold.gemspec
78
79
  homepage: https://github.com/christianmccormick/rails_base_api_scaffold
79
80
  licenses: []
@@ -85,17 +86,17 @@ require_paths:
85
86
  - lib
86
87
  required_ruby_version: !ruby/object:Gem::Requirement
87
88
  requirements:
88
- - - '>='
89
+ - - ">="
89
90
  - !ruby/object:Gem::Version
90
91
  version: '0'
91
92
  required_rubygems_version: !ruby/object:Gem::Requirement
92
93
  requirements:
93
- - - '>='
94
+ - - ">="
94
95
  - !ruby/object:Gem::Version
95
96
  version: '0'
96
97
  requirements: []
97
98
  rubyforge_project:
98
- rubygems_version: 2.0.14.1
99
+ rubygems_version: 2.6.12
99
100
  signing_key:
100
101
  specification_version: 4
101
102
  summary: Scaffold for the E7Systems Rails Base API