sevak 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 255061d49d7c114c2635cf303f0741b632001222
+  data.tar.gz: 72ed6a68f4979c751ff3116c091c397c6b3b7e79
+SHA512:
+  metadata.gz: 7572555dc028728c8460d1a3304124cfb548d45e171c9325bd080df76263ee186aaf01042eb22aeb7c4b85aa41680b5c0ea85e6d187d40fe0aaf8481a80c732d
+  data.tar.gz: 88fd6c8ece0a9c02216d19f561e87bd01b2726c112b78ee3955b125feff70bf565d480733f9b2bceeb785100e331a5ea96ad64081b081bddb8f5b9954d89594c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+/log/
+/.idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.4.0

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sevak.gemspec
+gemspec
+
+gem 'bunny'
+gem 'pry'
+gem 'guard'
+gem 'guard-minitest'
+gem 'mocha'
+gem 'highline'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    sevak (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.2.0)
+    bunny (2.7.0)
+      amq-protocol (>= 2.2.0)
+    coderay (1.1.2)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    highline (1.7.8)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.10.3)
+    mocha (1.3.0)
+      metaclass (~> 0.0.1)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+    rake (12.1.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bunny
+  guard
+  guard-minitest
+  highline
+  mocha
+  pry
+  rake
+  sevak!
+
+BUNDLED WITH
+   1.15.4

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyright (c) 2016 Backwater Technologies Pvt Ltd

data/README.md

@@ -0,0 +1,37 @@
+Sevak gem provides makes it easy to send and receive messages from rabbitmq queues. It is buit on top of the bunny gem.
+
+
+Usage:
+
+Install
+    
+    gem install sevak
+
+In your code to publish some message to a queue 'sms'.
+
+    
+    Sevak::Publisher.publish('sms', message = { name: 'Deepak', msisdn: '9078657543' })
+
+If the queue is not present already it will be created automatically.
+
+
+To receive message from this queue and process the message a create a consumer.
+
+
+    class SmsConsumer < Sevak::Consumer
+        
+        queue_name 'sms'
+        
+        def run(message)
+            status = process(message)
+            status
+        end
+        
+        ..
+    end
+
+The return status can have three values :ok, :error, :retry.
+
+Publishing to the queue
+
+    Publisher.publish('in.chillr.email', { name: 'Deepak Kumar', message: 'welcome', email: 'deepak@chillr.in' }) 

data/Rakefile

@@ -0,0 +1,85 @@
+require 'bundler/gem_tasks'
+require 'sevak'
+require 'highline'
+
+# run tests by running command `rake test`
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.verbose = true
+  t.test_files = FileList['test/**/*_spec.rb']
+  t.warning = false
+end
+
+# Load all rake tasks in the tasks folder
+
+tasks = FileList["tasks/*.rake"]
+
+tasks.each { |task| load(task) }
+
+namespace :consumer do
+
+  desc 'Interactively create a new consumer'
+  task :new do
+
+    cli = HighLine.new
+
+    consumer_name = cli.ask('Input consumer name(eg. push_alert) :') { |q| q.validate = /\A[a-z]+[a-z_]+[a-z]\z/}
+    queue_name    = cli.ask('Input queue name(eg. in.chillr.push.default)') { |q| q.validate = /\A[a-z]+[a-z.]+[a-z]\z/}
+
+    to_class_name = Proc.new do |name|
+      name.split('_').map(&:capitalize).join
+    end
+
+text1 = <<-CODE
+
+module ChillrSevak
+
+  class #{to_class_name.call(consumer_name)}Consumer < Consumer
+
+    queue_name "#{queue_name}"
+
+    def run(payload)
+      puts "Consumer running"
+    end
+  end
+
+end
+
+CODE
+
+    if File.exists?("lib/sevak/consumers/#{consumer_name}_consumer.rb")
+      puts "Already exists file: lib/sevak/consumers/#{consumer_name}_consumer.rb"
+      ans = cli.ask('Do you want to overwrite it ? (y/n)') { |q| q.validate = /Y|N|y|n/}
+      exit(-1) if ans.downcase == 'n'
+    end
+
+    file = File.open("lib/sevak/consumers/#{consumer_name}_consumer.rb", 'w+')
+    file.write(text1)
+    file.close
+
+text2 = <<-CODE
+namespace :sevak do
+
+  desc "Run the #{consumer_name} worker"
+  task :#{consumer_name} do
+    consumer = ChillrSevak::#{to_class_name.call(consumer_name)}Consumer.new
+    consumer.start
+  end
+end
+
+CODE
+
+    if File.exists?("tasks/#{consumer_name}.rake")
+      puts "Already exists file: tasks/#{consumer_name}.rake"
+      ans = cli.ask('Do you want to overwrite it ? (y/n)') { |q| q.validate = /Y|N|y|n/}
+      exit(-1) if ans.downcase == 'n'
+    end
+
+    file = File.open("tasks/#{consumer_name}.rake", 'w+')
+    file.write(text2)
+    file.close
+
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sevak'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chillr_sevak.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sevak/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sevak'
+  spec.version       = Sevak::VERSION
+  spec.authors       = ['Deepak Kumar']
+  spec.email         = ['deepakkumarnd@gmail.com']
+
+  spec.summary       = %q{Consumers for chillr api}
+  spec.description   = %q{Consumers for chillr api}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_development_dependency 'bundler', '~> 1.9'
+  # spec.add_development_dependency 'rake', '~> 10.0'
+end

data/config/default.yml.example

@@ -0,0 +1,5 @@
+host: 'localhost'
+port: '5672'
+user: 'guest'
+password: 'guest'
+prefetch_count: 10

data/lib/sevak.rb

@@ -0,0 +1,110 @@
+Bundler.require(:default)
+
+require 'yaml'
+require 'json'
+require 'logger'
+require 'fileutils'
+require 'sevak/version'
+
+module Sevak
+
+  # initialize configuration from the config/*.yml file
+  class Config
+
+    # allowed configurations
+    CONFIGURATION = %w(host port user password prefetch_count)
+
+    def initialize
+      load_configuration_from_yml
+    end
+
+    def method_missing(name, *args)
+      setter = false
+
+      name = name.to_s
+
+      if name =~ /=$/
+        name = name.to_s.chop
+        setter = true
+      end
+
+      super(name, args) unless CONFIGURATION.include?(name)
+
+      if setter
+        set(name, args.first)
+      else
+        get(name)
+      end
+    end
+
+    private
+
+    def load_configuration_from_yml
+      @config = YAML.load(File.read('config/default.yml'))
+    end
+
+    def set(key, val)
+      @config[key] = val
+    end
+
+    def get(key)
+      @config[key]
+    end
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield(config) if block_given?
+    config
+  end
+
+  def self.establish_connection
+    return @conn if @conn
+
+    @conn ||= Bunny.new(
+      host: config.host,
+      port: config.port,
+      username: config.user,
+      password: config.password)
+
+    @conn.start
+    @conn
+  end
+
+  def self.get_logger
+    if !Dir.exist? 'log'
+      FileUtils.mkdir('log')
+    end
+
+    logfile = if !testing?
+                File.open('log/sevak.log', 'a')
+              else
+                File.open('log/sevak_test.log', 'a')
+              end
+
+    # TODO make configurable
+    logfile.sync = true
+    @logger = Logger.new(logfile, 'weekly')
+  end
+
+  def self.log(data)
+    @logger ||= get_logger
+    @logger.info(data.inspect)
+  end
+
+  def self.testing?
+    defined?(SEVAK_ENV) && (SEVAK_ENV == 'test')
+  end
+
+  def self.root
+    File.expand_path(File.dirname(File.dirname(__FILE__)))
+  end
+
+end
+
+require 'sevak/core'
+require 'sevak/consumer'
+require 'sevak/publisher'

data/lib/sevak/consumer.rb

@@ -0,0 +1,98 @@
+module Sevak
+
+  # Base class for all queue consumers, all consumers should inherit from the base Sevak::Consumer and must implement a
+  # run method. The run method should implement the business logic.
+
+  class ConsumerBase
+
+    include Core
+
+    DEFAULT_PREFETCH_COUNT = 10
+
+    # class methods
+      def self.queue_name(name='default')
+        @queue_name ||= name
+      end
+    # end of class methods
+
+    def initialize
+      @queue_name = self.class.queue_name
+    end
+
+    def queue_name
+      @queue_name
+    end
+
+    def queue
+      @queue ||= channel.queue(queue_name)
+    end
+
+    def channel
+      @channel ||= connection.create_channel
+    end
+
+    def message_count
+      queue.message_count
+    end
+
+    def start
+      channel.prefetch(config.prefetch_count || DEFAULT_PREFETCH_COUNT)
+
+      queue.subscribe(manual_ack: true, exclusive: false) do |delivery_info, metadata, payload|
+        body = JSON.parse(payload)
+
+        # p delivery_info
+        # p metadata
+
+        begin
+          status = run(body)
+        rescue => ex
+          Sevak.log(exception_details(ex, payload))
+          status = :error
+        end
+
+        if status == :ok
+          channel.ack(delivery_info.delivery_tag)
+        elsif status == :retry
+          channel.reject(delivery_info.delivery_tag, true)
+        else # :error, nil etc
+          channel.reject(delivery_info.delivery_tag, false)
+        end
+      end
+
+      wait_for_threads
+    end
+
+    def wait_for_threads
+      sleep
+    end
+
+    def exception_details(e, payload = nil)
+      h = {
+        source: "#{self.class}",
+        type: "#{e.class}",
+        message: e.message,
+        payload: payload.inspect,
+        backtrace: (e.backtrace || []).take(3).join("\n")
+      }
+
+      msg = h.map { |k,v| "#{k.to_s.capitalize}: #{v.to_s}"}.join(' | ')
+
+      "Sevak Exception: #{msg}"
+    end
+
+  end
+
+  class Consumer < ConsumerBase
+
+    # Set the queue name for the consumer
+    queue_name 'sevak.default'
+
+    def run(payload)
+      # implement business logic in the corresponding consumer, the run method should respond with
+      # status :ok, :error, :retry after the processing is over
+      Sevak.log("Implement run method. Payload: #{payload.inspect} #{}")
+      :ok
+    end
+  end
+end

data/lib/sevak/core.rb

@@ -0,0 +1,11 @@
+module Sevak
+  module Core
+    def connection
+      ::Sevak.establish_connection
+    end
+
+    def config
+      ::Sevak.config
+    end
+  end
+end

data/lib/sevak/publisher.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+
+module Sevak
+  class Publisher
+    include Core
+    include Singleton
+
+    def self.publish(queue_name, message)
+      instance.channel.queue(queue_name).publish(message.to_json)
+    end
+
+    def channel
+      @channel ||= connection.create_channel
+    end
+  end
+end

data/lib/sevak/version.rb

@@ -0,0 +1,3 @@
+module Sevak
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: sevak
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Deepak Kumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies: []
+description: Consumers for chillr api
+email:
+- deepakkumarnd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chillr_sevak.gemspec
+- config/default.yml.example
+- lib/sevak.rb
+- lib/sevak/consumer.rb
+- lib/sevak/core.rb
+- lib/sevak/publisher.rb
+- lib/sevak/version.rb
+- tasks/.keep
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Consumers for chillr api
+test_files: []
+has_rdoc: