liebre 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cea30bec0897de16f0f5c622dfc40dd4918e10a4
+  data.tar.gz: 129b44949789081686fd1331701bca94c1a498b5
+SHA512:
+  metadata.gz: fb2469f49b0b8583ce5b73fb20c6396b4791d395d2ad2dfc7f8d9486d8bc675a7dc2b666fe16cd5950d709bc05cf7cc1f0d9da24b6fe2eced3ef92ad71227d4d
+  data.tar.gz: ec76d7163561e469037e61b12ab3f2c35968fec5217b756119729e51981692fe7dc691a2d80f0c7e4d0ab1da6f5c5d3668936226cd315e7644ec7b087b4588ae

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+/nbproject

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in liebre.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    liebre (0.1.2)
+      bunny (~> 2.5, >= 2.5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.0.1)
+    bunny (2.5.1)
+      amq-protocol (>= 2.0.1)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  liebre!
+  pry
+  rake
+  rspec
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 jcabotc
+
+MIT License
+
+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,268 @@
+# Liebre
+
+## Intro
+
+**Liebre stands for hare in spanish.**
+
+This is a gem that handles RabbitMQ consumers, publishers and RPCs, based on [bunny](https://github.com/ruby-amqp/bunny).
+
+* It allows to create classes that will be invoked everytime a message it's received in its subscribed queue. 
+* It handles RPCs as a special Consumer where a callback message is returned to the exchange.
+* You can use its Publisher to send message to an exchange.
+* There is also a Publisher RPC method to send a message and wait for its response.
+
+## Configuration
+It is based on 2 config files:
+
+* rabbitmq.yml: it contains RabbitMQ connection configurations and can be enviroment dependant (default path `config/rabbitmq.yml`), it must contain, at least the `default` connection
+  * without environment set:
+```
+default:
+  :host: localhost
+  :port: 5672
+  :user: guest
+  :pass: guest
+  :vhost: /
+  :threaded: true
+  :heartbeat: 2
+```
+  * with environment set:
+```
+development:
+  default:
+    :host: localhost
+    :port: 5672
+    :user: guest
+    :pass: guest
+    :vhost: /
+    :threaded: true
+    :heartbeat: 2
+  rpc:
+    :host: localhost
+    :port: 5672
+    :user: guest
+    :pass: guest
+    :vhost: rpc
+    :threaded: true
+    :heartbeat: 2
+test:
+  default:
+    :host: localhost
+    :port: 5672
+    :user: guest
+    :pass: guest
+    :vhost: /
+    :threaded: true
+    :heartbeat: 2
+  rpc:
+    :host: localhost
+    :port: 5672
+    :user: guest
+    :pass: guest
+    :vhost: rpc
+    :threaded: true
+    :heartbeat: 2
+
+production:
+  ...
+```
+
+* liebre.yml (default path `config/liebre.yml`)
+```
+rpc_request_timeout: 5
+
+consumers:
+  some_consumer:
+    class_name: MyConsumer
+    rpc: false
+    pool_size: 1
+    num_threads: 4
+    exchange:
+      name: "consumer_exchange"
+      type: "fanout"
+      opts:
+        durable: false
+    queue:
+      name: "consumer_queue"
+      opts:
+        durable: false
+    bind:
+      routing_key: #key a string or an array of strings
+        - key_1
+        - key_2
+        
+  some_rpc:
+    class_name: MyRPC
+    rpc: true
+    connection_name: rpc
+    pool_size: 1
+    exchange:
+      name: "rpc_exchange"
+      type: "fanout"
+      opts:
+        durable: false
+    queue:
+      name: "rpc_queue"
+      opts:
+        durable: false
+  
+publishers:
+  some_publisher:
+    exchange:
+      name: "consumer_exchange"
+      type: "fanout"
+      opts:
+        durable: false
+  rpc_publisher:
+    connection_name: rpc
+    exchange:
+      name: "rpc_exchange"
+      type: "fanout"
+      opts:
+        durable: false
+```
+
+### Consumers
+
+An entry for each consumer in your app, consumer options:
+* `class_name` (mandatory): The class that will be invoked everytime a message is received
+* `rpc` is a flag to specify the consumer behaviour (default false)
+* `connection_name`: the name of the connection to use (default `default`)
+* `pool_size` of the connection channel (default 1)
+* `num_threads`: number of consumers of the queue (default 1)
+* `exchange` a hash of options:
+  * `name`: the exchange name
+  * `type`: the exchange type (fanout, direct or topic)
+  * `opts`: options hash to pass to bunny exchange function
+* `queue` a hash of options:
+  * `name`: the queue name
+  * `opts`: options hash to pass to bunny queue function
+* `bind` a hash of options (optional):
+  * `routing_key`: the binding routing key, it can be a single string or an array of strings
+
+### Publishers
+
+An entry for each exchange you want to publish to, options:
+* `connection_name`: the name of the connection to use (default `default`)
+* `exchange` a hash of options:
+  * `name`: the exchange name
+  * `type`: the exchange type (fanout, direct or topic)
+  * `opts`: options hash to pass to bunny exchange function
+
+### Other configurations
+
+`rpc_request_timeout`: set the timeout for an RPC request
+
+### Change default paths and set env and Logger
+
+You can change these defaults in an initializer with something like:
+
+```
+Liebre::Config.config_path = "your/custom/path"
+Liebre::Config.connection_path = "your/custom/path"
+
+Liebre::Config.env = "production"
+Liebre::Config.logger = Logger.new(...)
+
+```
+
+## Usage
+
+There are 2 different consumer usages: `Consumer` and `RPC`.
+
+### Consumer
+
+You only need to create a class with this simple interface:
+
+```
+class MyConsumer
+    
+  def initialize payload, meta
+    @payload = payload #the content of the message
+    @meta = meta #the meta information (also called properties)
+  end
+
+  def call
+    #do your stuff here
+    #return :ack to anknowledge the message, 
+    #return :reject to requeue it 
+    #or return :error to send it to the dead-letter-exchange
+    :ack
+  end
+
+end
+```
+
+Every time a message is received, a new instance of this class will be created.
+
+### RPC
+
+You only need to create a class with this simple interface:
+
+```
+class MyRPC
+    
+  def initialize payload, meta, callback
+    @payload = payload #the content of the message
+    @meta = meta #the meta information (also called properties)
+    @callback = callback #a Proc that will publish an answer
+  end
+
+  def call
+    #do your stuff here
+    @callback.call("your response")
+  end
+
+end
+```
+
+Every time a message is received, a new instance of this class will be created.
+
+There are 2 ways to publish a message: `enqueue` and `enqueue_and_wait`.
+
+### `enqueue`
+
+```
+publisher = Liebre::Publisher.new("some_publisher_name")
+
+publisher.enqueue "hello", :routing_key => "consumer_queue"
+
+publisher.enqueue "bye", :routing_key => "consumer_queue"
+
+```
+
+### `enqueue_and_wait` (alias `rpc`)
+
+```
+rpc_publisher = Liebre::Publisher.new("rpc_publisher")
+
+response = publisher.enqueue_and_wait "hello", :routing_key => "consumer_queue"
+
+another_response = publisher.rpc "bye", :routing_key => "consumer_queue"
+
+```
+
+### Installation and Execution
+
+Add the following to your Gemfile:
+```
+gem "liebre", ">~ 0.1"
+```
+
+In your Raketask add:
+
+```
+require "liebre/tasks"
+```
+
+Then you just need to run:
+```
+rake liebre:run
+```
+
+Alternative way:
+```
+require 'liebre'
+
+Liebre::Runner.new.start
+```

data/lib/liebre.rb

@@ -0,0 +1,24 @@
+require "liebre/version"
+require "bunny"
+
+module Liebre
+  
+  autoload :Common,            'liebre/common'
+  autoload :Config,            'liebre/config'
+  autoload :ConnectionManager, 'liebre/connection_manager'
+  autoload :Publisher,         'liebre/publisher'
+  autoload :Runner,            'liebre/runner'
+  
+  def self.config
+    @config ||= Config.new
+  end
+  
+  def self.env
+    Config.env
+  end
+  
+  def self.logger
+    Config.logger
+  end
+  
+end

data/lib/liebre/common.rb

@@ -0,0 +1,7 @@
+module Liebre
+  module Common
+    
+    autoload :Utils, 'liebre/common/utils'
+
+  end
+end

data/lib/liebre/common/utils.rb

@@ -0,0 +1,24 @@
+module Liebre
+  module Common
+    module Utils
+      def self.create_exchange channel, config
+        exchange_name = config.fetch "name"
+        
+        type = config.fetch("type")
+        opts = config.fetch("opts", {})
+        exchange_opts = symbolize_keys(opts.merge("type" => type))
+        
+        channel.exchange exchange_name, exchange_opts
+      end
+      
+      def self.symbolize_keys hash
+        result = {}
+        hash.each do |k, v|
+          result[k.to_sym] = v.is_a?(Hash) ? symbolize_keys(v) : v
+        end
+        result
+      end
+    end
+
+  end
+end