urabbit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adcc16557fc9a39bb74252719281f9d5ba85cabe
+  data.tar.gz: d74ecf49a85e96b09b9926608ed3240983096616
+SHA512:
+  metadata.gz: bab9f320bbd2e39e5bc4276bf7a185dd93276c9cdef05f1b12a9a407e09c7233cde9d97427c9801713ad79510f0f4e4352f19db392df441b72ee467a69f43700
+  data.tar.gz: 3675a9c90aab6927d38200bba95ff7e5785cf003441e3530efa73ba47623869ddfd1b33aa34602e8a13c8ad5983a34685ac6baf84a5a16a54363d73938ab3aa4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jacek Becela
+
+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,34 @@
+# Urabbit
+
+A small microservices library for RabbitMQ.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urabbit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install urabbit
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ncr/urabbit.
+
+
+## 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,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "urabbit"
+
+# 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/lib/urabbit.rb

@@ -0,0 +1,24 @@
+require "bunny"
+require "logger"
+require "json"
+require "securerandom"
+
+require "urabbit/version"
+require "urabbit/rpc"
+require "urabbit/rpc/server"
+require "urabbit/rpc/client"
+require "urabbit/publisher"
+
+module Urabbit
+  def self.logger
+    @logger ||= if defined?(Rails)
+      Rails.logger
+    else
+      Logger.new(STDOUT)
+    end
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/urabbit/publisher.rb

@@ -0,0 +1,39 @@
+# Usage:
+# begin
+#   pubisher = Publisher.new(
+#     exchange_name: "courier_tracker",
+#     routing_key: "in.courier_statuses.created"
+#   )
+#   publisher.publish(message)
+# rescue Publisher::Error => exception
+#   puts exception.message
+#   puts exception.cause
+# end
+#
+# Message is usually a JSON.
+# Exception can contain a cause raised from Bunny.
+class Urabbit::Publisher
+  class Error < Exception; end
+
+  def initialize(opts)
+    cloudamqp_url = opts[:cloudamqp_url] || ENV["CLOUDAMQP_URL"]
+    exchange_type = opts[:exchange_type] || :topic
+    exchange_name = opts[:exchange_name] ||
+      raise(Error.new("Please provide an 'exchange_name'"))
+    @routing_key = opts[:routing_key] ||
+      raise(Error.new("Please provide a 'routing_key'"))
+
+    @connection = Bunny.new(cloudamqp_url, logger: Urabbit.logger)
+    @connection.start
+    @channel = @connection.create_channel
+    @exchange = Bunny::Exchange.new(@channel, exchange_type, exchange_name)
+  rescue Bunny::Exception
+    raise Error.new("Error connecting to queue")
+  end
+
+  def publish(message)
+    @exchange.publish(message, routing_key: @routing_key)
+  rescue Bunny::Exception
+    raise Error.new("Error communicating with queue")
+  end
+end

data/lib/urabbit/rpc.rb

@@ -0,0 +1 @@
+module Urabbit::RPC; end

data/lib/urabbit/rpc/client.rb

@@ -0,0 +1,73 @@
+# RPC::Client is a low level RPC client for RabbitMQ.
+# It does not assume anything about message format.
+#
+# Usage:
+#
+# begin
+#   client = RPC::Client.new
+#   result = client.call(routing_key, message)
+# rescue RPC::Client::Error => exception
+#    puts exception.message
+#    puts excpetion.cause
+# end
+#
+# routing_key - a function name
+# message     - a String with function params as JSON
+# result      - a String with the result as JSON or nil in case of error
+# exception   - an Exception with message describing what went wrong,
+#               can be thrown during initialization and method calls.
+#               It can also contain a cause raised from Bunny itself.
+class Urabbit::RPC::Client
+  class Error < Exception; end
+
+  def initialize(cloudamqp_url = ENV["CLOUDAMQP_URL"])
+    @connection = Bunny.new(cloudamqp_url, logger: Urabbit.logger)
+    @connection.start
+
+    @channel = @connection.create_channel
+    @exchange = @channel.default_exchange
+    @reply_queue = @channel.queue("amq.rabbitmq.reply-to")
+
+    @lock = Mutex.new
+    @condition = ConditionVariable.new
+
+    @reply_queue.subscribe do |delivery_info, properties, payload|
+      if properties[:correlation_id] == @correlation_id
+        # Headers are only present if explicitly set.
+        if error = properties.to_hash.dig(:headers, 'error')
+          @error = error
+        else
+          @result = payload
+        end
+
+        @lock.synchronize{@condition.signal}
+      end
+    end
+  rescue Bunny::Exception
+    raise Error.new("Error connecting to queue")
+  end
+
+  def call(routing_key, message, timeout = 10)
+    @correlation_id = SecureRandom.uuid
+
+    @exchange.publish(message,
+      routing_key: routing_key,
+      correlation_id: @correlation_id,
+      reply_to: "amq.rabbitmq.reply-to"
+    )
+
+    @lock.synchronize{@condition.wait(@lock, timeout)}
+
+    if @error.nil? && @result.nil?
+      raise Error.new("Timed out waiting for reply")
+    end
+
+    if @error
+      raise Error.new(@error['message'])
+    else
+      @result
+    end
+  rescue Bunny::Exception
+    raise Error.new("Error communicating with queue")
+  end
+end

data/lib/urabbit/rpc/server.rb

@@ -0,0 +1,70 @@
+module Urabbit::RPC::Server
+  def initialize(cloudamqp_url = ENV["CLOUDAMQP_URL"])
+    @connection = Bunny.new(cloudamqp_url, logger: logger)
+    @connection.start
+
+    @channel = @connection.create_channel
+
+    # TODO: Test which setting is the best
+    # @channel.prefetch(1)
+  end
+
+  # TODO: Currently this is called directly, but it should
+  # be called using server_engine.
+  def start
+    logger.info("Starting RPC server for #{self.class.name}")
+
+    @queue = @channel.queue(self.class.queue_name)
+    @exchange = @channel.default_exchange
+
+    @queue.subscribe(block: true) do |delivery_info, properties, payload|
+      begin
+        result = work(payload)
+
+        @exchange.publish(result,
+          routing_key: properties.reply_to,
+          correlation_id: properties.correlation_id
+        )
+      rescue => exception
+        @exchange.publish("",
+          routing_key: properties.reply_to,
+          correlation_id: properties.correlation_id,
+          headers: {
+            error: {
+              code: 500,
+              message: exception.message
+            }
+          }
+        )
+      end
+    end
+
+    logger.info("Stopped responding to RPC calls for #{self.class.name}")
+  end
+
+  # TODO: Use this method when server_engine is implemented.
+  def stop
+    @channel.close
+    @connection.close
+
+    logger.info("Stopped RPC server for #{self.class.name}")
+  end
+
+  private
+
+  def logger
+    Urabbit.logger
+  end
+
+  def self.included(base)
+   base.extend ClassMethods
+  end
+
+  module ClassMethods
+    attr_reader :queue_name
+
+    def from_queue(queue_name)
+      @queue_name = queue_name
+    end
+  end
+end

data/lib/urabbit/version.rb

@@ -0,0 +1,3 @@
+module Urabbit
+  VERSION = "0.1.0"
+end

data/urabbit.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urabbit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "urabbit"
+  spec.version       = Urabbit::VERSION
+  spec.authors       = ["Jacek Becela"]
+  spec.email         = ["jacek.becela@gmail.com"]
+
+  spec.summary       = %q{A small microservices library using RabbitMQ}
+  spec.homepage      = "https://github.com/ncr/urabbit"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "bunny", "~> 2.6.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: urabbit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacek Becela
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+description: 
+email:
+- jacek.becela@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/urabbit.rb
+- lib/urabbit/publisher.rb
+- lib/urabbit/rpc.rb
+- lib/urabbit/rpc/client.rb
+- lib/urabbit/rpc/server.rb
+- lib/urabbit/version.rb
+- urabbit.gemspec
+homepage: https://github.com/ncr/urabbit
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A small microservices library using RabbitMQ
+test_files: []