gorg_service 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc37bb278653aa7e8ba4d3f121a49859bbf0160c
+  data.tar.gz: c2dcce39d7c97c510cf012bd3f20a0a2351562fc
+SHA512:
+  metadata.gz: 3c8fec6cf54bc2a14bfab458a97a22c90bf60ddb4b60959a8d4b324cbf8c145e83c506b86b4e9959ce22d52679d6b927f500407cef1e54779a20fdf1a631dcfb
+  data.tar.gz: 2e0f7391a8298dea96bc0b370b0d9e29272ffddf03a93a93649c4667ec01a0eb2a0840c27e6cb9dd01a7b40f78c9290258bd27041c8a8c1abad3c349651e4294

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/build/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2
+addons:
+    code_climate:
+        repo_token: d01c5d7da4ec77cd04397e7fa442db957c5b8028a7a68604a4abcb6c6fe42e45

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexandre Narbonne
+
+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/README.md

@@ -0,0 +1,74 @@
+# GorgService
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gorg_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gorg_service
+
+## Setup
+  
+  Before being used GramV1Client must be configured. In Rails app, put it in an Initializer.
+
+```ruby
+GorgService.configure do |c|
+  # application name for display usage
+  c.application_name="My Application Name"
+  # application id used to find message from this producer
+  c.application_id="my_app_id"
+
+  ## RabbitMQ configuration
+  # 
+  ### Authentification
+  # If your RabbitMQ server is password protected put it here
+  #
+  # c.rabbitmq_user = nil
+  # c.rabbitmq_password = nil
+  #  
+  ### Network configuration :
+  #
+  # c.rabbitmq_host = "localhost"
+  # c.rabbitmq_port = 5672
+  #
+  #
+  # c.rabbitmq_queue_name = c.application_name
+  # c.rabbitmq_exchange_name = "exchange"
+  #
+  # time before trying again on softfail (temporary error)
+  # c.rabbitmq_deferred_time = 1800000 # 30min
+  # 
+  # maximum number of try before discard a message
+  # c.rabbitmq_max_attempts = 48 # 24h with default deferring delay
+
+ end
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Zooip/gorg_service.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gorg_service"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gorg_service.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gorg_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gorg_service"
+  spec.version       = GorgService::VERSION
+  spec.authors       = ["Alexandre Narbonne"]
+  spec.email         = ["alexandre.narbonne@gadz.org"]
+
+  spec.summary       = "Standard RabbitMQ bot used in Gadz.org SOA"
+  spec.homepage      = "https://github.com/Zooip/gorg_service"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_dependency 'bunny', '~> 2.2', '>= 2.2.2'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gorg_service/configuration.rb

@@ -0,0 +1,44 @@
+class GorgService
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :application_name,
+                  :application_id,
+                  :rabbitmq_host,
+                  :rabbitmq_port,
+                  :rabbitmq_queue_name,
+                  :rabbitmq_exchange_name,
+                  :rabbitmq_deferred_time,
+                  :rabbitmq_max_attempts,
+                  :rabbitmq_user,
+                  :rabbitmq_password,
+                  :message_handler_map,
+
+
+    def initialize
+
+      @application_name        = "GorgService"
+      @application_id          = "gs" 
+      @message_handler_map     = {}
+      @rabbitmq_host           = "localhost"
+      @rabbitmq_port           = 5672
+      @rabbitmq_queue_name     = @application_id
+      @rabbitmq_deferred_time  = 1800000    #30 minutes
+      @rabbitmq_exchange_name  = "exchange"
+      @rabbitmq_user           = nil
+      @rabbitmq_password       = nil
+      @rabbitmq_max_attempts   = 48         #24h with default timeout
+    end
+  end
+end

data/lib/gorg_service/errors.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+class GorgService
+  class FailError < StandardError
+    attr_reader :error_raised
+
+    def initialize(error_raised)
+      @error_raised = error_raised
+    end
+  end
+
+  class SoftfailError < FailError
+  end
+
+  class HardfailError < FailError
+  end
+end

data/lib/gorg_service/listener.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require "bunny"
+
+class GorgService
+  class Listener
+
+    def initialize(host: "localhost", port: 5672, queue_name: "gapps", rabbitmq_user: nil, rabbitmq_password: nil, exchange_name: nil, message_handler_map: {default: DefaultMessageHandler}, deferred_time: 1800000)
+      @host=host
+      @port=port
+      @queue_name=queue_name
+      @exchange_name=exchange_name
+      @rabbitmq_user=rabbitmq_user
+      @rabbitmq_password=rabbitmq_password
+      @message_handler_map=message_handler_map
+      @deferred_time=deferred_time
+
+    end
+
+    def listen
+
+      conn = rmq_connection
+      ch   = conn.create_channel
+      x    = ch.topic(@exchange_name, :durable => true)
+      q    = ch.queue(@queue_name, :durable => true)
+
+      @message_handler_map.keys.each do |routing_key|
+        q.bind(@exchange_name, :routing_key => routing_key)
+      end
+
+      q.bind(@exchange_name, :routing_key => '#')
+
+      puts " [*] Waiting for messages in #{q.name}. To exit press CTRL+C"
+      ch.prefetch(1)
+
+      begin
+        q.subscribe(:manual_ack => true, :block => true) do |delivery_info, properties, body|
+          routing_key=delivery_info[:routing_key]
+          puts " [#] Received message with routing key #{routing_key} containing : #{body}"
+          message_handler=message_handler_for routing_key
+          message=Message.parse_body(body)
+          begin
+            if message_handler
+              message_handler.new(message)
+            else
+              raise HardfailError.new(), "Unknown routing_key"
+            end
+          rescue SoftfailError => e
+            message.log_error(e)
+            if message.errors.count > 5
+
+            else
+              send_to_deferred_queue(message)
+            end
+          rescue HardfailError => e          
+          end
+
+          ch.ack(delivery_info.delivery_tag)
+        end
+      rescue Interrupt => _
+        conn.close
+      end
+    end
+
+    def rmq_connection
+        if @rmq_connection
+          @rmq_connection
+        else
+          @rmq_connection=Bunny.new(:hostname => @host, :user => @rabbitmq_user, :pass => @rabbitmq_password)
+          @rmq_connection.start
+          @rmq_connection
+        end
+    end
+
+    def send_to_deferred_queue(msg)
+      conn=rmq_connection
+      @delayed_chan||=conn.create_channel
+      q=@delayed_chan.queue("#{@queue_name}_deferred",
+        durable: true,
+        arguments: {
+            'x-message-ttl' => @deferred_time,
+            'x-dead-letter-exchange' => @exchange_name,
+            'x-dead-letter-routing-key' => msg.event,
+          }
+        )
+      q.publish(msg.to_str, :routing_key => msg.event)
+    end
+
+    def message_handler_for routing_key
+      @message_handler_map[routing_key]
+    end
+
+  end
+end

data/lib/gorg_service/message.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+require 'json'
+require 'time'
+
+class GorgService
+  class Message
+
+    attr_accessor :event
+    attr_accessor :id
+    attr_accessor :data
+    attr_accessor :errors
+
+
+    def initialize(id: nil, data: nil, event: nil, errors: [])
+      @id=id || generate_id
+      @event=event
+      @data=data
+      @errors=errors
+    end
+
+    # Generate new id
+    #
+    # TODO
+    #  Avoid using AppConfig
+    def generate_id 
+      "#{GorgService.configuration.application_id}_#{Time.now.to_i}"
+    end
+
+    # Generate RabbitMQ message body
+    def to_str
+      body={
+        id: @id,
+        event: @event,
+        data: @data,
+      }
+      if errors.any?
+        body[:errors_count]=@errors.count
+        body[:errors]=@errors
+      end
+      body.to_json
+    end
+
+    # Log FailError in message body
+    def log_error error
+      @errors<<{
+            type: error.class.to_s.downcase,
+            message: error.message,
+            timestamp: Time.now.utc.iso8601,
+            extra: error.error_raised.inspect,
+          }
+    end
+
+    ### Class methods
+
+    # Parse RabbitMQ message body
+    # @return Message
+    #   parsed message
+    # Errors
+    #   Hardfail if un-parsable JSON body
+    def self.parse_body(body)
+      begin
+        json_body=JSON.parse(body)
+
+        self.new(
+            id: json_body["id"],
+            event: json_body["event"],
+            data: convert_keys_to_sym(json_body["data"]),
+            errors: convert_keys_to_sym(json_body["errors"]),
+          )
+
+      rescue JSON::ParserError => e
+        raise HardfailError(e), "Unprocessable message : Unable to parse JSON message body"
+      end
+    end
+
+
+    def self.convert_keys_to_sym input_hash
+      s2s = 
+      lambda do |h| 
+        Hash === h ? 
+          Hash[
+            h.map do |k, v| 
+              [k.respond_to?(:to_sym) ? k.to_sym : k, s2s[v]] 
+            end 
+          ] : h 
+      end
+      s2s[input_hash]
+    end
+   
+
+  end
+end

data/lib/gorg_service/message_handler.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+class GorgService
+  class MessageHandler
+
+    def initialize(message)
+      puts "WARNING : Defined your MessageHandler behavior in its 'initialize' method"
+    end
+
+    def raise_hardfail(message, error:nil)
+      raise HardfailError.new(error), message
+    end
+
+    def raise_softfail(message, error:nil)
+      raise HardfailError.new(error), message
+    end
+
+  end
+end

data/lib/gorg_service/version.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+class GorgService
+  VERSION = "0.1.1"
+end

data/lib/gorg_service.rb

@@ -0,0 +1,25 @@
+require "gorg_service/configuration"
+require "gorg_service/version"
+require "gorg_service/errors"
+require "gorg_service/listener"
+require "gorg_service/message"
+require "gorg_service/message_handler"
+
+class GorgService
+  def initialize()
+    @listener=Listener.new(
+      message_handler_map:GorgService.configuration.message_handler_map,
+      host: GorgService.configuration.rabbitmq_host,
+      port: GorgService.configuration.rabbitmq_port,
+      queue_name: GorgService.configuration.rabbitmq_queue_name,
+      exchange_name: GorgService.configuration.rabbitmq_exchange_name,
+      rabbitmq_user: GorgService.configuration.rabbitmq_user,
+      rabbitmq_password: GorgService.configuration.rabbitmq_password,
+      deferred_time: GorgService.configuration.rabbitmq_deferred_time,
+      )
+  end
+
+  def run
+    @listener.listen
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: gorg_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexandre Narbonne
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- alexandre.narbonne@gadz.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gorg_service.gemspec
+- lib/gorg_service.rb
+- lib/gorg_service/configuration.rb
+- lib/gorg_service/errors.rb
+- lib/gorg_service/listener.rb
+- lib/gorg_service/message.rb
+- lib/gorg_service/message_handler.rb
+- lib/gorg_service/version.rb
+homepage: https://github.com/Zooip/gorg_service
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Standard RabbitMQ bot used in Gadz.org SOA
+test_files: []
+has_rdoc: