totoro 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ce1f9b6e844375ba38c9bbb6cdd3f0f844854e076e2f67844d33f8c13ec73f
-  data.tar.gz: 297c15584c20d54012e67e1fa8fd564c969a76109ba9479ddb260508426a6f3f
+  metadata.gz: 30ebcadd2cabd53770744a87e313fdf0a2cddb74ab88b4942ab3e7edeb2a7195
+  data.tar.gz: 262090ee10a54d07f003d4af0778e7e04852a879c3e24f154cb1d6dc5fc3cdcb
 SHA512:
-  metadata.gz: f4c25c90c0e08e68af2a67b11035aeddfdfdad66cf291161adcb3734636c3dc76e16ce10b674a90a0d2b05531dcdc335b19e16223db6a8e2c83c7503f3ab3045
-  data.tar.gz: b7f891ebbba5a1bd1151cb93be5c73794908a54b16df68d3818bf0cab16f82682b0c239455f8541e1c9cd956d7d8ed2d25a076ce43195fd4f04910f063bf5d1c
+  metadata.gz: e09eabec608b85ce18e16540802a2f8a588e75771434e86b365a843e232c3cbccbe7daa0ebc43f982cc5c8ed2f9d6016c60cd831b774caeb469f8ef8408f9fd1
+  data.tar.gz: c052a7fec121be2a8afe402ccdbf02133e25b616cf68f7180ae2d643bf6116212bbfc7f3fca1bc0f663502d595d8894e2cfc0aafbc0b4786a3215cbedf7ec053

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    totoro (0.1.5)
+    totoro (0.1.6)
       bunny (~> 2.10)
 
 GEM

data/README.md

@@ -4,7 +4,7 @@ Totoro is a RabbitMQ util that focuses on samplify queue operation.
 
 ## Installation
 
-#### Install gem
+### Install gem
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -15,14 +15,22 @@ And then execute:
 
     $ bundle
 
-#### Generate configuration file
+#### Initialize Totoro for Rails app
 ```
-rails g totoro:config
+rails g totoro:init
 ```
 
+This command will generate two files
+
+1. `totoro.yml` (Rabbitmq configuration file)
+2. `initilizers/totoro.rb` (Rails initializer)
+
 ## Quick Start
 
+### Default rabbitmq server
+
 #### Enqueue
+
 ```
 Totoro::Queue.enqueue('queue', payload)
 ```
@@ -35,11 +43,16 @@ rails g totoro:wroker <worker_name> <queue_name>
 after that, add business logic in the process method
 ```
 module Worker
-  class WorkerClass
-    QUEUE = 'queue_name'
-    def process(payload, _metadata, _delivery_info)
+  class WorkerClass < Totoro::BaseWorker
+    def process(payload, metadata, delivery_info)
       # worker process
     end
+
+    private
+
+    def setup
+      @queue_name = <queue_name>
+    end
   end
 end
 ```
@@ -48,6 +61,40 @@ finally, run the background deamon
 bundle exec totoro worker_class
 ```
 
+### Custom rabbitmq server
+
+#### 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
+    def process(payload, metadata, delivery_info)
+      # worker process
+    end
+
+    private
+
+    def setup
+      @prefix = :<prefix>
+      @queue_name = <queue_name>
+    end
+  end
+end
+```
+finally, run the background deamon
+```
+bundle exec totoro worker_class
+```
 
 ## Contributing
 

data/bin/totoro

@@ -10,19 +10,7 @@ root = File.dirname(root) until File.exist?(File.join(root, 'config'))
 Dir.chdir(root)
 
 require File.join(root, 'config', 'environment')
-Rails.logger = logger = Logger.new STDOUT
-logger.level = Logger.const_get(Rails.configuration.log_level.to_s.upcase)
 
-worker_name = ARGV[0]
-queue_class = Totoro::Queue
-logger.info 'Start to subscribe to Rabbitmq'
-worker = queue_class.get_worker worker_name
-worker_queue = worker.class::QUEUE
-queue_class.subscribe(worker_queue) do |delivery_info, metadata, payload|
-  logger.info "#{worker_queue} Received: #{payload}"
-  payload_hash = JSON.parse(payload).with_indifferent_access
-  worker.process payload_hash, metadata, delivery_info
-end
+worker_class = ARGV[0]
 
-logger.info 'Listening to the Rabbitmq'
-queue_class.channel.work_pool.join
+::Worker.const_get(worker_class.to_s.camelize).new.execute

data/docker-compose.yml

@@ -25,7 +25,7 @@ services:
     ports:
       - '3000:3000'
     volumes:
-      - ./test/totoro_test:/app
+      # - ./test/totoro_test:/app
       - .:/totoro
     command: ./bin/rails c
     environment:

data/lib/generators/totoro/templates/worker.rb.erb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Worker
+  class <%= name.camelcase %> < Totoro::BaseWorker
+    def process(payload, metadata, delivery_info)
+      # worker process
+    end
+
+    private
+
+    def setup<% if prefix.present? %>
+      @prefix = :<%= prefix %><% end %>
+      @queue_name = '<%= queue || name.underscore %>'
+    end
+  end
+end

data/lib/generators/totoro/worker_generator.rb

@@ -7,9 +7,10 @@ module Totoro
     source_root File.expand_path('../templates', __FILE__)
     argument :name, type: :string
     argument :queue, type: :string, required: false
+    argument :prefix, type: :string, required: false
 
     def copy_config_file
-      template 'worker.rb',
+      template 'worker.rb.erb',
                File.join('app/models/worker', "#{name.underscore}.rb")
     end
   end

data/lib/totoro.rb

@@ -3,6 +3,7 @@
 require 'totoro/version'
 require 'totoro/config'
 require 'totoro/base_queue'
+require 'totoro/base_worker'
 require 'totoro/initializer'
 
 module Totoro

data/lib/totoro/base_queue.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'bunny'
+
 module Totoro
   class BaseQueue
     class <<self

data/lib/totoro/base_worker.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Totoro
+  class BaseWorker
+    def initialize
+      @prefix = :default
+      Rails.logger = @logger = Logger.new STDOUT
+      @logger.level = Logger.const_get(
+        Rails.configuration.log_level.to_s.upcase
+      )
+      setup
+      @queue_class = queue_class
+    end
+
+    def execute
+      @queue_class.subscribe(@queue_name) do |delivery_info, metadata, payload|
+        @logger.info "#{@queue_name} Received: #{payload}"
+        payload_hash = JSON.parse(payload).with_indifferent_access
+        process(payload_hash, metadata, delivery_info)
+      end
+      @logger.info 'Listening to the Rabbitmq'
+      @queue_class.channel.work_pool.join
+    end
+
+    def process; end
+
+    private
+
+    def setup
+      raise(Totoro::NeedQueueNameError, 'Need setup @queue_name')
+    end
+
+    def queue_class
+      if @prefix == :default
+        Totoro::Queue
+      else
+        "Totoro::#{@prefix.to_s.camelize}::Queue".constantize
+      end
+    end
+  end
+
+  class NeedQueueNameError < RuntimeError; end
+end

data/lib/totoro/config.rb

@@ -2,7 +2,7 @@
 
 module Totoro
   class Config
-    def initialize(prefix)
+    def initialize(prefix = nil)
       @data = Rails.application.config_for(:totoro).with_indifferent_access
       @data = @data[prefix] if prefix.present?
     end

data/lib/totoro/version.rb

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

data/test/totoro_test/Gemfile

@@ -5,7 +5,6 @@ git_source(:github) do |repo_name|
   "https://github.com/#{repo_name}.git"
 end
 
-gem 'bunny'
 gem 'totoro', path: '/totoro'
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.1.6'

data/test/totoro_test/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /totoro
   specs:
-    totoro (0.1.4)
+    totoro (0.1.5)
       bunny (~> 2.10)
 
 GEM
@@ -131,7 +131,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bunny
   byebug
   listen (>= 3.0.5, < 3.2)
   puma (~> 3.7)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: totoro
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - ShuHui18
@@ -89,10 +89,11 @@ files:
 - lib/generators/totoro/init_generator.rb
 - lib/generators/totoro/templates/initializer.rb
 - lib/generators/totoro/templates/totoro.yml
-- lib/generators/totoro/templates/worker.rb
+- lib/generators/totoro/templates/worker.rb.erb
 - lib/generators/totoro/worker_generator.rb
 - lib/totoro.rb
 - lib/totoro/base_queue.rb
+- lib/totoro/base_worker.rb
 - lib/totoro/config.rb
 - lib/totoro/initializer.rb
 - lib/totoro/version.rb
@@ -100,6 +101,7 @@ files:
 - pkg/totoro-0.1.2.gem
 - pkg/totoro-0.1.3.gem
 - pkg/totoro-0.1.4.gem
+- pkg/totoro-0.1.5.gem
 - spec/spec_helper.rb
 - spec/totoro_spec.rb
 - test/totoro_test/Gemfile
@@ -135,14 +137,12 @@ files:
 - test/totoro_test/config/initializers/filter_parameter_logging.rb
 - test/totoro_test/config/initializers/inflections.rb
 - test/totoro_test/config/initializers/mime_types.rb
-- test/totoro_test/config/initializers/totoro.rb
 - test/totoro_test/config/initializers/wrap_parameters.rb
 - test/totoro_test/config/locales/en.yml
 - test/totoro_test/config/puma.rb
 - test/totoro_test/config/routes.rb
 - test/totoro_test/config/secrets.yml
 - test/totoro_test/config/spring.rb
-- test/totoro_test/config/totoro.yml
 - test/totoro_test/db/seeds.rb
 - test/totoro_test/log/development.log
 - test/totoro_test/public/robots.txt

data/lib/generators/totoro/templates/worker.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Worker
-  class <%= name.camelcase %>
-    QUEUE = '<%= queue || name.underscore %>'.freeze
-    def process(payload, _metadata, _delivery_info)
-      # worker process
-    end
-  end
-end

data/test/totoro_test/config/initializers/totoro.rb

@@ -1 +0,0 @@
-Totoro::Initializer.new.execute

data/test/totoro_test/config/totoro.yml

@@ -1,31 +0,0 @@
-default: &default
-  default:
-    connect:
-      host: rabbitmq
-      port: 5672
-      user: app
-      pass: app
-    queue:
-      example_queue:
-        name: real.queue.name
-        durable: true
-
-  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