totoro 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5eec7c12e6dde49a945a21c48be6db1a773b28e1a1cceb5bc1dd8f63c741d15
-  data.tar.gz: 44c24808e0603cecdf0883a9df55681487830d48aecbc38ac8c8db6fac93666d
+  metadata.gz: 74a844282fa52f395d79a90a5df63dbe574467dc173f7641a9ac1b870fc36e11
+  data.tar.gz: e9405fd1e77370f43cb2aae761986924cd772cbf5df5b7df6ca29e7d9260b647
 SHA512:
-  metadata.gz: c6c8e432b961bc807045d60587983aae53e663ec8e9b78d0e92f8c3c1aa09dc583574a06a3b14c220eb573971145010940bb90e521dacd0b17bd35004738f22d
-  data.tar.gz: 067b6429ee06870dc084f4671c7581c81223d9219b6e46359e68b11545329a78a154d6b62402db99ad1e8f2bf5f386736686a010c033244f0663404dbc35c28a
+  metadata.gz: faeafba0999a947e94861532c1e08cc296865b9ef163b258f91180de6b5f5c4b954eb3cbb9110b360b2924a2a5e7328e8020e3d5168810e62a887477ec9ee392
+  data.tar.gz: 3905b199f723493c9b3212482b84d804c74aed1dc769d863b2ee547aefeceffe97e75aa727d1d781de9b9bb0e3e2dc5e3eeb616bcf7e28da394dff240d54cb41

data/README.md

@@ -33,6 +33,10 @@ This command will generate two files
 rails g delayed_job:active_record
 ```
 
+#### delayed job configuration
+
+https://github.com/collectiveidea/delayed_job
+
 #### Run DB migraion
 `rake db:migrate`
 
@@ -49,6 +53,7 @@ default: &default
     queue:
       normal_queue_for_both_enqueue_and_subscribe:
         name: default_exchange.queue.name
+        persistent: true
         durable: true
         clean_start: false
       exchange_queue_for_subscribe:
@@ -58,6 +63,7 @@ default: &default
     exchange:
       exchange_for_fanout_enqueue:
         name: fanout.exchange.name
+        persistent: false
 
   custom:
     connect:

data/lib/generators/totoro/templates/totoro.yml

@@ -8,9 +8,10 @@ default: &default
     example_queue:
       name: real.queue.name
       durable: true
+      persistent: true
       clean_start: false
-      manual_ack: true
-      force_ack: true
+      manual_ack: false
+      force_ack: false
 
   custom:
     connect:

data/lib/totoro/config.rb

@@ -23,6 +23,14 @@ module Totoro
       @data[:queue][queue_id][:exchange]
     end
 
+    def queue_persistent?(id)
+      !!@data[:queue][id][:persistent]
+    end
+
+    def exchange_persistent?(id)
+      !!@data[:exchange][id][:persistent]
+    end
+
     def clean_start?(id)
       !!@data[:queue][id][:clean_start]
     end

data/lib/totoro/services/broadcast_service.rb

@@ -11,7 +11,7 @@ module Totoro
       @connection.start unless @connection.connected?
       exchange = channel.fanout(@config.exchange(exchange_id))
       payload = JSON.dump payload
-      exchange.publish(payload)
+      exchange.publish(payload, options(attrs))
       Rails.logger.debug "send message to exchange #{@config.exchange(exchange_id)}"
       STDOUT.flush
       channel.close
@@ -26,6 +26,10 @@ module Totoro
 
     private
 
+    def options(exchange_id, attrs)
+      { persistent: @config.exchange_persistent?(exchange_id) }.merge(attrs)
+    end
+
     def channel
       @channel ||= @connection.create_channel
     end

data/lib/totoro/services/enqueue_service.rb

@@ -7,11 +7,11 @@ module Totoro
       @config = config
     end
 
-    def enqueue(id, payload)
+    def enqueue(id, payload, attrs = {})
       @connection.start unless @connection.connected?
       queue = channel.queue(*@config.queue(id))
       payload = JSON.dump payload
-      exchange.publish(payload, routing_key: queue.name)
+      exchange.publish(payload, options(id, queue.name, attrs))
       Rails.logger.debug "send message to #{queue.name}"
       STDOUT.flush
       channel.close
@@ -26,6 +26,10 @@ module Totoro
 
     private
 
+    def options(queue_id, queue_name, attrs)
+      { persistent: @config.queue_persistent?(queue_id), routing_key: queue_name }.merge(attrs)
+    end
+
     def channel
       @channel ||= @connection.create_channel
     end

data/lib/totoro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Totoro
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/pkg/totoro-1.0.5/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shu.hui@blockchaintech.net.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/pkg/totoro-1.0.5/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.5.0
+
+#Cache bundle install
+WORKDIR /tmp
+ADD . /totoro
+ADD ./test/totoro_test/Gemfile Gemfile
+ADD ./test/totoro_test/Gemfile.lock Gemfile.lock
+RUN bundle install
+
+RUN mkdir /app
+WORKDIR /app
+ADD ./test/totoro_test /app
+
+CMD ["rails", "c"]

data/pkg/totoro-1.0.5/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in totoro.gemspec
+gemspec

data/pkg/totoro-1.0.5/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    totoro (1.0.4)
+      bunny (~> 2.10)
+      delayed_job_active_record (~> 4.1.3)
+      delayed_job_recurring (~> 0.3.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    amq-protocol (2.3.0)
+    arel (9.0.0)
+    bunny (2.13.0)
+      amq-protocol (~> 2.3, >= 2.3.0)
+    concurrent-ruby (1.1.4)
+    delayed_job (4.1.5)
+      activesupport (>= 3.0, < 5.3)
+    delayed_job_active_record (4.1.3)
+      activerecord (>= 3.0, < 5.3)
+      delayed_job (>= 3.0, < 5)
+    delayed_job_recurring (0.3.8)
+      delayed_job (>= 3.0)
+      delayed_job_active_record
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  totoro!
+
+BUNDLED WITH
+   1.16.2

data/pkg/totoro-1.0.5/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ShuHui18
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/pkg/totoro-1.0.5/README.md

@@ -0,0 +1,169 @@
+# Totoro, a RabbitMQ Util
+
+Totoro is a RabbitMQ util that focuses on samplify queue operation. 
+## Dependencies
+Please install [Delayed Job active record](https://rubygems.org/gems/delayed_job_active_record) and [Delayed Job recurring](https://rubygems.org/gems/delayed_job_recurring) before use Totoro.
+Totoro basically use delayed job to cache and resend falied messages.
+## Installation
+
+### Install gem
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'totoro'
+```
+
+And then execute:
+
+    $ bundle
+
+#### Initialize Totoro for Rails app
+```
+rails g totoro:init
+```
+
+This command will generate two files
+
+1. `totoro.yml` (Rabbitmq configuration file)
+2. `initilizers/totoro.rb` (Rails initializer)
+3. `db/migrate/[tiemstamp]_create_totoro_failed_messages.rb` (DB migration to create messages caching table)
+
+#### if you havn't install gem delayed_jobs, then run initialization scripts
+```
+rails g delayed_job:active_record
+```
+
+#### Run DB migraion
+`rake db:migrate`
+
+## Sample configuration
+
+```yaml
+default: &default
+  default:
+    connect:
+      host: rabbitmq
+      port: 5672
+      user: app
+      pass: app
+    queue:
+      normal_queue_for_both_enqueue_and_subscribe:
+        name: default_exchange.queue.name
+        durable: true
+        clean_start: false
+      exchange_queue_for_subscribe:
+        name: fanout.exchange.queue
+        durable: true
+        exchange: fanout.exchange.name
+    exchange:
+      exchange_for_fanout_enqueue:
+        name: fanout.exchange.name
+
+  custom:
+    connect:
+      host: rabbitmq
+      port: 5672
+      user: app
+      pass: app
+    queue:
+      custom_queue:
+        name: custom.queue.name
+        durable: true
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default
+
+```
+## Quick Start
+
+### Resend Failed messages daemon
+
+Please run `rake totoro:resend_msg` before you start your app.
+
+### Default rabbitmq server
+
+#### Enqueue
+
+```
+Totoro::Queue.enqueue('queue_id', payload)
+```
+
+#### BroadCast (Enqueue to fanout exchange)
+
+```
+Totoro::Queue.broadcast('exchange_id', payload)
+```
+
+#### Dequeue
+To create a dequeue daemon, first you need to create a worker
+```
+rails g totoro:worker <worker_name> <queue_name>
+```
+after that, add business logic in the process method
+```
+module Worker
+  class WorkerClass < Totoro::BaseWorker
+    setup queue_name: <queue_name>
+    def process(payload, metadata, delivery_info)
+      # worker process
+    end
+  end
+end
+```
+finally, run the background deamon
+```
+bundle exec totoro worker_class
+```
+
+### Custom rabbitmq server
+
+When you have more than one rabbitmq server to connect, you need to add custom configuration.
+
+To use the custom rabbitmq server you need to add `ServerName` between `Totoro` and `Queue`
+
+For example:
+
+#### Enqueue
+
+```
+Totoro::<ServerName>::Queue.enqueue('queue', payload)
+```
+
+#### Dequeue
+To create a dequeue daemon, first you need to create a worker
+```
+rails g totoro:wroker <worker_name> <queue_name> <prefix>
+```
+after that, add business logic in the process method
+```
+module Worker
+  class WorkerClass < Totoro::BaseWorker
+    setup queue_name: <queue_name>, prefix: <prefix>
+    def process(payload, metadata, delivery_info)
+      # worker process
+    end
+  end
+end
+```
+finally, run the background deamon
+```
+bundle exec totoro worker_class
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/blockchaintech-au/totoro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Totoro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/totoro/blob/master/CODE_OF_CONDUCT.md).