ikibana 0.1.0 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 159f0b53cd7206dff8ab920b5c568a60a05c569278b8c2e0242b099196da4545
4
- data.tar.gz: 44c22b18228c278a12f5e1612f98d5d8274f4421a9daf6bb63b42a2f2779a206
3
+ metadata.gz: 45c1dc8b32754fa13088ad4cba0df313f31874f788fde1593bc061acaa240128
4
+ data.tar.gz: 5c1e8c20df29ba0ef594c4be82ceaf68a0b01b66a97277c70ad1ffcab6a396dd
5
5
  SHA512:
6
- metadata.gz: bf3822dad6c13583cc4acdd700f73cfc31e0bc3609f00829ab6e0121e6c0eb35997e14ee5611a95ca570048802792ff14395733e590e9d1bb0b5bb921848a1aa
7
- data.tar.gz: bae1f4c53108edda9554f63beb1a3d74333a50af08ccd2f3dc9671c56f5c9b9512de8abea1d5b0ece490aee8f106b966c62abe6955b80c85d1b246700d96dc4e
6
+ metadata.gz: 97f2ac89850a756abdc2e286f88a0238393798269e817098218841f9358fef1a8380acab16a063daeb154a028be5c7fb81b0e2f53847c9006b38d43dc0eec12a
7
+ data.tar.gz: 7f0084d50ebb8bcfdc79a71fa759dab29b197513eaa207031756255d8bcb5555312e5c3562a017b2a44448733eaf03f6d9d47ee4313f2b7365ef13fd13e04716
data/.rubocop.yml CHANGED
@@ -7,3 +7,6 @@ Style/StringLiterals:
7
7
 
8
8
  Style/StringLiteralsInInterpolation:
9
9
  EnforcedStyle: double_quotes
10
+
11
+ Style/Documentation:
12
+ Enabled: false # TODO: temp disable
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  ## [Unreleased]
2
2
 
3
+ ## [0.1.1] - 2024-11-26
4
+ - Documentation updates
5
+ - Added rails generator for consumers
6
+ - Added rails generator to bootstrap the application
7
+
3
8
  ## [0.1.0] - 2024-11-25
4
9
 
5
- - Initial release
10
+ - Initial release
data/LICENSE ADDED
@@ -0,0 +1,224 @@
1
+ This project includes the following third-party libraries:
2
+
3
+ - nats-pure - Licensed under the Apache License, Version 2.0
4
+ https://github.com/nats-io/nats-pure.rb
5
+
6
+ - debug - Licensed under the BSD 2-Clause "Simplified" License
7
+ https://github.com/ruby/debug
8
+
9
+ - rails - Licensed under the MIT License
10
+ https://github.com/rails/rails
11
+
12
+ - rake - Licensed under the MIT License
13
+ https://github.com/ruby/rake
14
+
15
+ - rspec - Licensed under the MIT License
16
+ https://rubygems.org/gems/rspec
17
+
18
+ - rubocop - Licensed under the MIT License
19
+ https://github.com/rubocop/rubocop
20
+
21
+ - github_changelog_generator - Licensed under the MIT License
22
+ https://github.com/github-changelog-generator/github-changelog-generator
23
+
24
+ Apache License
25
+ Version 2.0, January 2004
26
+ http://www.apache.org/licenses/
27
+
28
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
29
+
30
+ 1. Definitions.
31
+
32
+ "License" shall mean the terms and conditions for use, reproduction,
33
+ and distribution as defined by Sections 1 through 9 of this document.
34
+
35
+ "Licensor" shall mean the copyright owner or entity authorized by
36
+ the copyright owner that is granting the License.
37
+
38
+ "Legal Entity" shall mean the union of the acting entity and all
39
+ other entities that control, are controlled by, or are under common
40
+ control with that entity. For the purposes of this definition,
41
+ "control" means (i) the power, direct or indirect, to cause the
42
+ direction or management of such entity, whether by contract or
43
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
44
+ outstanding shares, or (iii) beneficial ownership of such entity.
45
+
46
+ "You" (or "Your") shall mean an individual or Legal Entity
47
+ exercising permissions granted by this License.
48
+
49
+ "Source" form shall mean the preferred form for making modifications,
50
+ including but not limited to software source code, documentation
51
+ source, and configuration files.
52
+
53
+ "Object" form shall mean any form resulting from mechanical
54
+ transformation or translation of a Source form, including but
55
+ not limited to compiled object code, generated documentation,
56
+ and conversions to other media types.
57
+
58
+ "Work" shall mean the work of authorship, whether in Source or
59
+ Object form, made available under the License, as indicated by a
60
+ copyright notice that is included in or attached to the work
61
+ (an example is provided in the Appendix below).
62
+
63
+ "Derivative Works" shall mean any work, whether in Source or Object
64
+ form, that is based on (or derived from) the Work and for which the
65
+ editorial revisions, annotations, elaborations, or other modifications
66
+ represent, as a whole, an original work of authorship. For the purposes
67
+ of this License, Derivative Works shall not include works that remain
68
+ separable from, or merely link (or bind by name) to the interfaces of,
69
+ the Work and Derivative Works thereof.
70
+
71
+ "Contribution" shall mean any work of authorship, including
72
+ the original version of the Work and any modifications or additions
73
+ to that Work or Derivative Works thereof, that is intentionally
74
+ submitted to Licensor for inclusion in the Work by the copyright owner
75
+ or by an individual or Legal Entity authorized to submit on behalf of
76
+ the copyright owner. For the purposes of this definition, "submitted"
77
+ means any form of electronic, verbal, or written communication sent
78
+ to the Licensor or its representatives, including but not limited to
79
+ communication on electronic mailing lists, source code control systems,
80
+ and issue tracking systems that are managed by, or on behalf of, the
81
+ Licensor for the purpose of discussing and improving the Work, but
82
+ excluding communication that is conspicuously marked or otherwise
83
+ designated in writing by the copyright owner as "Not a Contribution."
84
+
85
+ "Contributor" shall mean Licensor and any individual or Legal Entity
86
+ on behalf of whom a Contribution has been received by Licensor and
87
+ subsequently incorporated within the Work.
88
+
89
+ 2. Grant of Copyright License. Subject to the terms and conditions of
90
+ this License, each Contributor hereby grants to You a perpetual,
91
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
92
+ copyright license to reproduce, prepare Derivative Works of,
93
+ publicly display, publicly perform, sublicense, and distribute the
94
+ Work and such Derivative Works in Source or Object form.
95
+
96
+ 3. Grant of Patent License. Subject to the terms and conditions of
97
+ this License, each Contributor hereby grants to You a perpetual,
98
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
99
+ (except as stated in this section) patent license to make, have made,
100
+ use, offer to sell, sell, import, and otherwise transfer the Work,
101
+ where such license applies only to those patent claims licensable
102
+ by such Contributor that are necessarily infringed by their
103
+ Contribution(s) alone or by combination of their Contribution(s)
104
+ with the Work to which such Contribution(s) was submitted. If You
105
+ institute patent litigation against any entity (including a
106
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
107
+ or a Contribution incorporated within the Work constitutes direct
108
+ or contributory patent infringement, then any patent licenses
109
+ granted to You under this License for that Work shall terminate
110
+ as of the date such litigation is filed.
111
+
112
+ 4. Redistribution. You may reproduce and distribute copies of the
113
+ Work or Derivative Works thereof in any medium, with or without
114
+ modifications, and in Source or Object form, provided that You
115
+ meet the following conditions:
116
+
117
+ (a) You must give any other recipients of the Work or
118
+ Derivative Works a copy of this License; and
119
+
120
+ (b) You must cause any modified files to carry prominent notices
121
+ stating that You changed the files; and
122
+
123
+ (c) You must retain, in the Source form of any Derivative Works
124
+ that You distribute, all copyright, patent, trademark, and
125
+ attribution notices from the Source form of the Work,
126
+ excluding those notices that do not pertain to any part of
127
+ the Derivative Works; and
128
+
129
+ (d) If the Work includes a "NOTICE" text file as part of its
130
+ distribution, then any Derivative Works that You distribute must
131
+ include a readable copy of the attribution notices contained
132
+ within such NOTICE file, excluding those notices that do not
133
+ pertain to any part of the Derivative Works, in at least one
134
+ of the following places: within a NOTICE text file distributed
135
+ as part of the Derivative Works; within the Source form or
136
+ documentation, if provided along with the Derivative Works; or,
137
+ within a display generated by the Derivative Works, if and
138
+ wherever such third-party notices normally appear. The contents
139
+ of the NOTICE file are for informational purposes only and
140
+ do not modify the License. You may add Your own attribution
141
+ notices within Derivative Works that You distribute, alongside
142
+ or as an addendum to the NOTICE text from the Work, provided
143
+ that such additional attribution notices cannot be construed
144
+ as modifying the License.
145
+
146
+ You may add Your own copyright statement to Your modifications and
147
+ may provide additional or different license terms and conditions
148
+ for use, reproduction, or distribution of Your modifications, or
149
+ for any such Derivative Works as a whole, provided Your use,
150
+ reproduction, and distribution of the Work otherwise complies with
151
+ the conditions stated in this License.
152
+
153
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
154
+ any Contribution intentionally submitted for inclusion in the Work
155
+ by You to the Licensor shall be under the terms and conditions of
156
+ this License, without any additional terms or conditions.
157
+ Notwithstanding the above, nothing herein shall supersede or modify
158
+ the terms of any separate license agreement you may have executed
159
+ with Licensor regarding such Contributions.
160
+
161
+ 6. Trademarks. This License does not grant permission to use the trade
162
+ names, trademarks, service marks, or product names of the Licensor,
163
+ except as required for reasonable and customary use in describing the
164
+ origin of the Work and reproducing the content of the NOTICE file.
165
+
166
+ 7. Disclaimer of Warranty. Unless required by applicable law or
167
+ agreed to in writing, Licensor provides the Work (and each
168
+ Contributor provides its Contributions) on an "AS IS" BASIS,
169
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
170
+ implied, including, without limitation, any warranties or conditions
171
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
172
+ PARTICULAR PURPOSE. You are solely responsible for determining the
173
+ appropriateness of using or redistributing the Work and assume any
174
+ risks associated with Your exercise of permissions under this License.
175
+
176
+ 8. Limitation of Liability. In no event and under no legal theory,
177
+ whether in tort (including negligence), contract, or otherwise,
178
+ unless required by applicable law (such as deliberate and grossly
179
+ negligent acts) or agreed to in writing, shall any Contributor be
180
+ liable to You for damages, including any direct, indirect, special,
181
+ incidental, or consequential damages of any character arising as a
182
+ result of this License or out of the use or inability to use the
183
+ Work (including but not limited to damages for loss of goodwill,
184
+ work stoppage, computer failure or malfunction, or any and all
185
+ other commercial damages or losses), even if such Contributor
186
+ has been advised of the possibility of such damages.
187
+
188
+ 9. Accepting Warranty or Additional Liability. While redistributing
189
+ the Work or Derivative Works thereof, You may choose to offer,
190
+ and charge a fee for, acceptance of support, warranty, indemnity,
191
+ or other liability obligations and/or rights consistent with this
192
+ License. However, in accepting such obligations, You may act only
193
+ on Your own behalf and on Your sole responsibility, not on behalf
194
+ of any other Contributor, and only if You agree to indemnify,
195
+ defend, and hold each Contributor harmless for any liability
196
+ incurred by, or claims asserted against, such Contributor by reason
197
+ of your accepting any such warranty or additional liability.
198
+
199
+ END OF TERMS AND CONDITIONS
200
+
201
+ APPENDIX: How to apply the Apache License to your work.
202
+
203
+ To apply the Apache License to your work, attach the following
204
+ boilerplate notice, with the fields enclosed by brackets "[]"
205
+ replaced with your own identifying information. (Don't include
206
+ the brackets!) The text should be enclosed in the appropriate
207
+ comment syntax for the file format. We also recommend that a
208
+ file or class name and description of purpose be included on the
209
+ same "printed page" as the copyright notice for easier
210
+ identification within third-party archives.
211
+
212
+ Copyright [yyyy] [name of copyright owner]
213
+
214
+ Licensed under the Apache License, Version 2.0 (the "License");
215
+ you may not use this file except in compliance with the License.
216
+ You may obtain a copy of the License at
217
+
218
+ http://www.apache.org/licenses/LICENSE-2.0
219
+
220
+ Unless required by applicable law or agreed to in writing, software
221
+ distributed under the License is distributed on an "AS IS" BASIS,
222
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
223
+ See the License for the specific language governing permissions and
224
+ limitations under the License.
data/README.md CHANGED
@@ -1,43 +1,74 @@
1
1
  # Ikibana
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ This is a work in progress.
4
4
 
5
- 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/ikibana`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ Ikibana is a simple and easy to use Rails background job runner that uses NATS JetStream as a message broker.
6
+ Just like `sidekiq` or `sneakers`, but allowing to create distributed applications or microservices with ease.
6
7
 
7
- ## Installation
8
-
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
8
+ ## Usage
10
9
 
11
- Install the gem and add to the application's Gemfile by executing:
10
+ To install:
12
11
 
13
12
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
13
+ gem install ikibana
15
14
  ```
16
15
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
16
+ Or add this line to your application's Gemfile:
18
17
 
19
- ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
18
+ ```ruby
19
+ gem 'ikibana'
21
20
  ```
22
21
 
23
- ## Usage
24
-
25
- TODO: Write usage instructions here
26
-
27
- ## Development
28
-
29
- After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
22
+ Then in a Rails application context execute
30
23
 
31
- To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
-
33
- ## Contributing
34
-
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ikibana. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ikibana/blob/main/CODE_OF_CONDUCT.md).
36
-
37
- ## License
38
-
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
-
41
- ## Code of Conduct
24
+ ```bash
25
+ bundle exec rails g ikibana:install
26
+ ```
42
27
 
43
- Everyone interacting in the Ikibana project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ikibana/blob/main/CODE_OF_CONDUCT.md).
28
+ This will create a `config/initializers/ikibana.rb` file alongside with `config/nats.yaml` file with the default
29
+ configuration.
30
+ At the moment there are only two options available for configuration:
31
+
32
+ * logger: The logger to use. Defaults to `Logger.new`.
33
+ *
34
+ * this can be replaced with any logger that responds to `info`, `warn`, `error` and `debug` methods.
35
+ * cache: The cache to use. Defaults to none.
36
+ *
37
+ * there is a class that can be inherited for implementing your own cache `Ikibana::ICache`.
38
+ *
39
+ * the cache at the moment has to respond to `write` and `read` methods
40
+ *
41
+ *
42
+ * can be replaced with `Rails.cache` at the moment
43
+
44
+ ## Features
45
+
46
+ * Generation of consumers: `rails g ikibana:consumer <name>` where name can be any ruby constant identifier.
47
+ *
48
+ * for example `rails g ikibana:consumer A::B::C` will generate a consumer `A::B::CConsumer` that will listen to the
49
+ `a.b.c` subject.
50
+ *
51
+ * The consumer has one private method `perform(msg)` that will be called when a message is received. This is where
52
+ you will implement your application logic.
53
+ * Producer: At the moment the only way to produce messages would be
54
+ `Ikibana::Config.instance.js.publish(subject, payload)`
55
+ *
56
+ * This will be replaced with a more user-friendly and idiomatic way of producing messages in the future.
57
+
58
+ ## Roadmap
59
+
60
+ | Feature Name | Status |
61
+ |----------------------------------------|---------------------------------------------------------|
62
+ | Generation of consumers | Implemented |
63
+ | Logger configuration | Implemented |
64
+ | Cache configuration | To be improved(NATS k/v storage instead of Rails cache) |
65
+ | Consumer placement mechanism | To be implemented |
66
+ | Consumer type(sync/async/at_most_once) | To be implemented |
67
+ | CLI to start all the consumers | To be implemented |
68
+ | Producer DSL | To be implemented |
69
+ | Producer configuration | To be implemented |
70
+ | Test coverage | To be implemented |
71
+ | Documentation | To be improved |
72
+ | Examples | To be implemented |
73
+ | Complete Rails integration | To be implemented |
74
+ | Stand alone mode | To be implemented |
@@ -5,6 +5,7 @@ require_relative "consumer"
5
5
  module Ikibana
6
6
  class ApplicationConsumer
7
7
  private_class_method def self.inherited(subclass)
8
+ super
8
9
  subclass.include Ikibana::Consumer
9
10
  end
10
11
 
@@ -7,8 +7,13 @@ require "nats/client"
7
7
 
8
8
  module Ikibana
9
9
  class ICache
10
- def write(...) = raise NotImplementedError, "Subclasses must implement a `write` method"
11
- def read(...) = raise NotImplementedError, "Subclasses must implement a `read` method"
10
+ def write(...)
11
+ raise NotImplementedError, "Subclasses must implement a `write` method"
12
+ end
13
+
14
+ def read(...)
15
+ raise NotImplementedError, "Subclasses must implement a `read` method"
16
+ end
12
17
  end
13
18
 
14
19
  # Configuration class for NATS
@@ -30,7 +35,7 @@ module Ikibana
30
35
  @logger.error("#{e.class}: Error connecting to NATS server: #{e.message}")
31
36
  end
32
37
 
33
- def self.configure(config_file = "config/nats.yaml")
38
+ def self.configure(_config_file = "config/nats.yaml")
34
39
  yield instance if block_given?
35
40
  end
36
41
 
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Ikibana
4
- VERSION = "0.1.0"
4
+ VERSION = "0.1.2"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ikibana
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Aram
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-11-25 00:00:00.000000000 Z
11
+ date: 2024-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: nats-pure
@@ -38,7 +38,7 @@ files:
38
38
  - ".rubocop.yml"
39
39
  - CHANGELOG.md
40
40
  - CODE_OF_CONDUCT.md
41
- - LICENSE.txt
41
+ - LICENSE
42
42
  - README.md
43
43
  - Rakefile
44
44
  - exe/ikibana
data/LICENSE.txt DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2024 Aram
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.