api_engine_base 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 (73) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +28 -0
  4. data/Rakefile +32 -0
  5. data/app/controllers/api_engine_base/application_controller.rb +47 -0
  6. data/app/controllers/api_engine_base/auth/plain_text_controller.rb +132 -0
  7. data/app/controllers/api_engine_base/username_controller.rb +26 -0
  8. data/app/controllers/concerns/api_engine_base/schematizable.rb +5 -0
  9. data/app/helpers/api_engine_base/application_helper.rb +4 -0
  10. data/app/helpers/api_engine_base/schema_helper.rb +29 -0
  11. data/app/jobs/api_engine_base/application_job.rb +4 -0
  12. data/app/mailers/api_engine_base/application_mailer.rb +8 -0
  13. data/app/mailers/api_engine_base/email_verification_mailer.rb +12 -0
  14. data/app/models/api_engine_base/application_record.rb +7 -0
  15. data/app/models/user.rb +50 -0
  16. data/app/models/user_secret.rb +72 -0
  17. data/app/services/api_engine_base/argument_validation/class_methods.rb +179 -0
  18. data/app/services/api_engine_base/argument_validation/instance_methods.rb +136 -0
  19. data/app/services/api_engine_base/argument_validation.rb +11 -0
  20. data/app/services/api_engine_base/jwt/authenticate_user.rb +71 -0
  21. data/app/services/api_engine_base/jwt/decode.rb +21 -0
  22. data/app/services/api_engine_base/jwt/encode.rb +15 -0
  23. data/app/services/api_engine_base/jwt/login_create.rb +21 -0
  24. data/app/services/api_engine_base/jwt/time_delay_token.rb +17 -0
  25. data/app/services/api_engine_base/login_strategy/plain_text/create.rb +42 -0
  26. data/app/services/api_engine_base/login_strategy/plain_text/email_verification/generate.rb +29 -0
  27. data/app/services/api_engine_base/login_strategy/plain_text/email_verification/required.rb +20 -0
  28. data/app/services/api_engine_base/login_strategy/plain_text/email_verification/send.rb +23 -0
  29. data/app/services/api_engine_base/login_strategy/plain_text/email_verification/verify.rb +24 -0
  30. data/app/services/api_engine_base/login_strategy/plain_text/login.rb +50 -0
  31. data/app/services/api_engine_base/secrets/cleanse.rb +14 -0
  32. data/app/services/api_engine_base/secrets/generate.rb +62 -0
  33. data/app/services/api_engine_base/secrets/verify.rb +27 -0
  34. data/app/services/api_engine_base/secrets.rb +15 -0
  35. data/app/services/api_engine_base/service_base.rb +90 -0
  36. data/app/services/api_engine_base/service_logging.rb +41 -0
  37. data/app/services/api_engine_base/username/available.rb +64 -0
  38. data/app/views/api_engine_base/email_verification_mailer/verify_email.html.erb +26 -0
  39. data/config/routes.rb +23 -0
  40. data/db/migrate/20241117043720_create_api_engine_base_users.rb +33 -0
  41. data/db/migrate/20241204065708_create_api_engine_base_user_secrets.rb +16 -0
  42. data/lib/api_engine_base/configuration/application/config.rb +40 -0
  43. data/lib/api_engine_base/configuration/base.rb +11 -0
  44. data/lib/api_engine_base/configuration/config.rb +59 -0
  45. data/lib/api_engine_base/configuration/email/config.rb +87 -0
  46. data/lib/api_engine_base/configuration/jwt/config.rb +22 -0
  47. data/lib/api_engine_base/configuration/login/config.rb +18 -0
  48. data/lib/api_engine_base/configuration/login/strategy/plain_text/config.rb +57 -0
  49. data/lib/api_engine_base/configuration/login/strategy/plain_text/email_verify.rb +50 -0
  50. data/lib/api_engine_base/configuration/login/strategy/plain_text/lockable.rb +27 -0
  51. data/lib/api_engine_base/configuration/otp/config.rb +54 -0
  52. data/lib/api_engine_base/configuration/username/check.rb +31 -0
  53. data/lib/api_engine_base/configuration/username/config.rb +41 -0
  54. data/lib/api_engine_base/engine.rb +21 -0
  55. data/lib/api_engine_base/schema/error/base.rb +15 -0
  56. data/lib/api_engine_base/schema/error/invalid_argument.rb +15 -0
  57. data/lib/api_engine_base/schema/error/invalid_argument_response.rb +17 -0
  58. data/lib/api_engine_base/schema/plain_text/create_user_request.rb +18 -0
  59. data/lib/api_engine_base/schema/plain_text/create_user_response.rb +17 -0
  60. data/lib/api_engine_base/schema/plain_text/email_verify_request.rb +11 -0
  61. data/lib/api_engine_base/schema/plain_text/email_verify_response.rb +11 -0
  62. data/lib/api_engine_base/schema/plain_text/email_verify_send_request.rb +9 -0
  63. data/lib/api_engine_base/schema/plain_text/email_verify_send_response.rb +11 -0
  64. data/lib/api_engine_base/schema/plain_text/login_request.rb +15 -0
  65. data/lib/api_engine_base/schema/plain_text/login_response.rb +13 -0
  66. data/lib/api_engine_base/schema.rb +25 -0
  67. data/lib/api_engine_base/spec_helper.rb +18 -0
  68. data/lib/api_engine_base/version.rb +5 -0
  69. data/lib/api_engine_base.rb +33 -0
  70. data/lib/generators/api_engine_base/configure/USAGE +8 -0
  71. data/lib/generators/api_engine_base/configure/configure_generator.rb +12 -0
  72. data/lib/tasks/auto_annotate_models.rake +60 -0
  73. metadata +216 -0
metadata ADDED
@@ -0,0 +1,216 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: api_engine_base
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - matt-taylor
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2025-01-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rotp
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: rails
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '7'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '7'
41
+ - !ruby/object:Gem::Dependency
42
+ name: jwt
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '2'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '2'
55
+ - !ruby/object:Gem::Dependency
56
+ name: bcrypt
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '3'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '3'
69
+ - !ruby/object:Gem::Dependency
70
+ name: interactor
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: class_composer
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '2'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '2'
97
+ - !ruby/object:Gem::Dependency
98
+ name: json_schematize
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0.10'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0.10'
111
+ description: ApiEngineBase is the Base API to handle all the things you don't want
112
+ to for a Rails API only backend serving a Dedicated frontend
113
+ email:
114
+ - ''
115
+ executables: []
116
+ extensions: []
117
+ extra_rdoc_files: []
118
+ files:
119
+ - MIT-LICENSE
120
+ - README.md
121
+ - Rakefile
122
+ - app/controllers/api_engine_base/application_controller.rb
123
+ - app/controllers/api_engine_base/auth/plain_text_controller.rb
124
+ - app/controllers/api_engine_base/username_controller.rb
125
+ - app/controllers/concerns/api_engine_base/schematizable.rb
126
+ - app/helpers/api_engine_base/application_helper.rb
127
+ - app/helpers/api_engine_base/schema_helper.rb
128
+ - app/jobs/api_engine_base/application_job.rb
129
+ - app/mailers/api_engine_base/application_mailer.rb
130
+ - app/mailers/api_engine_base/email_verification_mailer.rb
131
+ - app/models/api_engine_base/application_record.rb
132
+ - app/models/user.rb
133
+ - app/models/user_secret.rb
134
+ - app/services/api_engine_base/argument_validation.rb
135
+ - app/services/api_engine_base/argument_validation/class_methods.rb
136
+ - app/services/api_engine_base/argument_validation/instance_methods.rb
137
+ - app/services/api_engine_base/jwt/authenticate_user.rb
138
+ - app/services/api_engine_base/jwt/decode.rb
139
+ - app/services/api_engine_base/jwt/encode.rb
140
+ - app/services/api_engine_base/jwt/login_create.rb
141
+ - app/services/api_engine_base/jwt/time_delay_token.rb
142
+ - app/services/api_engine_base/login_strategy/plain_text/create.rb
143
+ - app/services/api_engine_base/login_strategy/plain_text/email_verification/generate.rb
144
+ - app/services/api_engine_base/login_strategy/plain_text/email_verification/required.rb
145
+ - app/services/api_engine_base/login_strategy/plain_text/email_verification/send.rb
146
+ - app/services/api_engine_base/login_strategy/plain_text/email_verification/verify.rb
147
+ - app/services/api_engine_base/login_strategy/plain_text/login.rb
148
+ - app/services/api_engine_base/secrets.rb
149
+ - app/services/api_engine_base/secrets/cleanse.rb
150
+ - app/services/api_engine_base/secrets/generate.rb
151
+ - app/services/api_engine_base/secrets/verify.rb
152
+ - app/services/api_engine_base/service_base.rb
153
+ - app/services/api_engine_base/service_logging.rb
154
+ - app/services/api_engine_base/username/available.rb
155
+ - app/views/api_engine_base/email_verification_mailer/verify_email.html.erb
156
+ - config/routes.rb
157
+ - db/migrate/20241117043720_create_api_engine_base_users.rb
158
+ - db/migrate/20241204065708_create_api_engine_base_user_secrets.rb
159
+ - lib/api_engine_base.rb
160
+ - lib/api_engine_base/configuration/application/config.rb
161
+ - lib/api_engine_base/configuration/base.rb
162
+ - lib/api_engine_base/configuration/config.rb
163
+ - lib/api_engine_base/configuration/email/config.rb
164
+ - lib/api_engine_base/configuration/jwt/config.rb
165
+ - lib/api_engine_base/configuration/login/config.rb
166
+ - lib/api_engine_base/configuration/login/strategy/plain_text/config.rb
167
+ - lib/api_engine_base/configuration/login/strategy/plain_text/email_verify.rb
168
+ - lib/api_engine_base/configuration/login/strategy/plain_text/lockable.rb
169
+ - lib/api_engine_base/configuration/otp/config.rb
170
+ - lib/api_engine_base/configuration/username/check.rb
171
+ - lib/api_engine_base/configuration/username/config.rb
172
+ - lib/api_engine_base/engine.rb
173
+ - lib/api_engine_base/schema.rb
174
+ - lib/api_engine_base/schema/error/base.rb
175
+ - lib/api_engine_base/schema/error/invalid_argument.rb
176
+ - lib/api_engine_base/schema/error/invalid_argument_response.rb
177
+ - lib/api_engine_base/schema/plain_text/create_user_request.rb
178
+ - lib/api_engine_base/schema/plain_text/create_user_response.rb
179
+ - lib/api_engine_base/schema/plain_text/email_verify_request.rb
180
+ - lib/api_engine_base/schema/plain_text/email_verify_response.rb
181
+ - lib/api_engine_base/schema/plain_text/email_verify_send_request.rb
182
+ - lib/api_engine_base/schema/plain_text/email_verify_send_response.rb
183
+ - lib/api_engine_base/schema/plain_text/login_request.rb
184
+ - lib/api_engine_base/schema/plain_text/login_response.rb
185
+ - lib/api_engine_base/spec_helper.rb
186
+ - lib/api_engine_base/version.rb
187
+ - lib/generators/api_engine_base/configure/USAGE
188
+ - lib/generators/api_engine_base/configure/configure_generator.rb
189
+ - lib/tasks/auto_annotate_models.rake
190
+ homepage: https://github.com/matt-taylor/api_engine_base
191
+ licenses:
192
+ - MIT
193
+ metadata:
194
+ homepage_uri: https://github.com/matt-taylor/api_engine_base
195
+ source_code_uri: https://github.com/matt-taylor/api_engine_base
196
+ post_install_message:
197
+ rdoc_options: []
198
+ require_paths:
199
+ - lib
200
+ required_ruby_version: !ruby/object:Gem::Requirement
201
+ requirements:
202
+ - - ">="
203
+ - !ruby/object:Gem::Version
204
+ version: '0'
205
+ required_rubygems_version: !ruby/object:Gem::Requirement
206
+ requirements:
207
+ - - ">="
208
+ - !ruby/object:Gem::Version
209
+ version: '0'
210
+ requirements: []
211
+ rubygems_version: 3.5.9
212
+ signing_key:
213
+ specification_version: 4
214
+ summary: ApiEngineBase is the Base API to handle all the things you don't want to
215
+ for a Rails API only backend serving a Dedicated frontend
216
+ test_files: []