columbo-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0434c660df5e43225a76ec249d66c10d68fe6240
+  data.tar.gz: 4b1dba18f46db3338fcc6995cb9a53460c99343e
+SHA512:
+  metadata.gz: 3cb900a4ab3f9681dd5e051c4e0aa70cdc26606f01e43d062c56fc5a9f86e8a15d2c2c76654b80a77852072480c28c6dae62731ecb12ad9117bee67ece3aa7d7
+  data.tar.gz: 9c78bc90e10bd00acb38d244a6fe87aeb995079d7b294740c74e565b3adf7122fb181d87cb510749b737701be570bb6bb6cd01ee9adab4a42d7f69942ff3534e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wifirst
+
+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,123 @@
+# Columbo Ruby Client
+
+This gem provides a ruby integration for Columbo. It provides:
+
+* HTTP client
+* AMQP client (RabbitMQ implementation only, due to [Bunny](https://github.com/ruby-amqp/bunny) gem dependance)
+
+For integration with Rails applications, see the [columbo-rails-client](https://git.wifirst.net/gems/columbo-rails-client) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'columbo-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install columbo-client
+
+## Configuration
+
+### Using HTTP
+
+```ruby
+Columbo.configure do |config|
+  config.system.uid = 'system_uid'
+  config.system.label = 'system_label'
+  config.system.type = 'system_type'
+
+  config.client = Columbo::Client::HTTP.new('http://example.com/push')
+end
+```
+
+### Using AMQP
+
+For the AMQP client, the exchange must be configurated through the
+`Columbo::Client::AMQP::exchange` method by giving a name and a block
+as seen in the example below. `durable`, `auto_delete` and `arguments`
+exchange options can also be set as explained in the Bunny gem
+[here](http://reference.rubybunny.info/Bunny/Exchange.html#initialize-instance_method).
+
+```ruby
+Columbo.configure do |config|
+  config.system.uid = 'system_uid'
+  config.system.label = 'system_label'
+  config.system.type = 'system_type'
+
+  config.client = Columbo::Client::AMQP.new("amqp://guest:guest@localhost:5672")
+
+  config.client.exchange 'exchange-name' do |exchange_options|
+    exchange_options.type = 'topic'
+    exchange_options.durable = true
+  end
+end
+```
+
+## Usage
+
+We show how to push an event to Columbo by sending the next crafted event:
+
+```ruby
+example_event = {
+  "system": {
+      "uid": "myCompany",
+      "type": "application",
+      "label": "MyCompany"
+  },
+  "action": "contact.created",
+  "actor": {
+      "uid": "john.smith@mycompany.com",
+      "type": "commercial",
+      "label": "John Smith"
+  },
+  "resource": {
+      "uid": "1",
+      "type": "contact",
+      "label": "Eric Martin",
+      "attributes": {
+          "first_name": "Eric",
+          "last_name": "Martin",
+          "email": "eric.martin@customer.com",
+          "phone": "11111111"
+      }
+  },
+  "context": {},
+  "related_resources": [],
+  "timestamp": "2016-12-29T10:00:00.000000+00:00"
+}
+```
+
+For each client (HTTP and AMQP), 2 methods are available:
+
+* `publish` will return `true` or `false` depending on the successfulness
+  of the publishing.
+* `publish!` will raise an error if the publishing fails.
+
+### Using HTTP
+
+The `publish` and `publish!` methods take an event `Hash` as parameter.
+
+```ruby
+Columbo.client.publish(example_event)
+```
+
+### Using AMQP
+
+The `publish` and `publish!` methods take an event `Hash` as first
+parameter and an optional `Hash` parameter. The possible values for
+the second parameter are available in Bunny documentation
+[here](http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method).
+
+
+```ruby
+options[:routing_key] = 'resource.action'
+
+Columbo.client.publish(example_event, options)
+```

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 "columbo-client"
+
+# 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/columbo-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'columbo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "columbo-client"
+  spec.version       = Columbo::VERSION
+  spec.authors       = ["Wifirst"]
+  spec.homepage      = 'https://github.com/wifirst-lab/columbo-ruby-client'
+
+  spec.summary       = "A simple Ruby client for the Columbo REST and AMQP API"
+  spec.description   = "A simple Ruby client for the Columbo REST and AMQP API"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bunny", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/columbo-client.rb

@@ -0,0 +1,26 @@
+require 'json'
+require 'logger'
+require 'columbo/version'
+require 'columbo/configuration'
+require 'columbo/clients/amqp'
+require 'columbo/clients/http'
+
+module Columbo
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def logger
+      @logger ||= configuration.logger
+    end
+
+    def configure
+      yield(configuration) if block_given?
+    end
+
+    def client
+      @client ||= configuration.client
+    end
+  end
+end

data/lib/columbo/clients/amqp.rb

@@ -0,0 +1,53 @@
+require 'bunny'
+
+module Columbo
+  module Client
+    class AMQP
+      def initialize(connection_uri)
+        @connection_uri = connection_uri
+      end
+
+      def publish(event, options = {})
+        begin
+          publish_event(event, options)
+          true
+        rescue Exception => e
+          Columbo.logger.warn(e.message)
+          false
+        end
+      end
+
+      def publish!(event, options = {})
+        publish_event(event, options)
+      end
+
+      def exchange(name)
+        raise ArgumentError, 'Please provide a name for the AMQP exchange' if name.nil?
+
+        @channel = connection.create_channel
+
+        if block_given?
+          exchange_options = OpenStruct.new(arguments: {})
+          yield exchange_options
+
+          type = exchange_options.delete_field(:type)
+          @exchange = @channel.send(type, name, exchange_options.to_h)
+        else
+          raise ArgumentError, 'Please provide a block to configure the exchange'
+        end
+      end
+
+      private
+
+      def publish_event(event, options = {})
+        raise 'No exchange has been configurated for the Columbo Client' if @exchange.nil?
+
+        @exchange.publish(event.to_json, options)
+      end
+
+      def connection
+        @connection ||= Bunny.new(@connection_uri).start
+      end
+    end
+  end
+end

data/lib/columbo/clients/http.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+
+module Columbo
+  module Client
+    class HTTP
+      DEFAULT_OPEN_TIMEOUT = 2
+      DEFAULT_READ_TIMEOUT = 2
+
+      def initialize(push_url, opts = {})
+        raise ArgumentError.new('Please provide a push url') if push_url.nil?
+
+        @push_url = push_url
+        @open_timeout = opts[:open_timeout] || DEFAULT_OPEN_TIMEOUT
+        @read_timeout = opts[:read_timeout] || DEFAULT_READ_TIMEOUT
+      end
+
+      def publish(event, options = nil)
+        begin
+          publish_event(event)
+        rescue Exception => e
+          Columbo.logger.warn(e.message)
+          false
+        end
+      end
+
+      def publish!(event, options = nil)
+        publish_event(event)
+      end
+
+      private
+
+      def publish_event(event)
+        post(@push_url, event.to_json)
+      end
+
+      def post(uri, body)
+        uri = URI(uri)
+        path = uri.path.empty? ? '/' : uri.path
+
+        proxy = URI.parse(ENV['HTTP_PROXY'] || ENV['http_proxy']) rescue nil
+        proxy_host = proxy.nil? ? nil : proxy.host
+        proxy_port = proxy.nil? ? nil : proxy.port
+        http = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port)
+        http.use_ssl = uri.instance_of?(URI::HTTPS)
+        http.open_timeout = @open_timeout
+        http.read_timeout = @read_timeout
+
+        headers = {
+          'Content-Type' => 'application/json',
+          'User-Agent' => "Columbo-Ruby-Client/#{Columbo::VERSION}"
+        }
+        response = http.post(path, body, headers)
+        response.kind_of?(Net::HTTPSuccess) ? true : response.error!
+      end
+    end
+  end
+end

data/lib/columbo/configuration.rb

@@ -0,0 +1,10 @@
+module Columbo
+  class Configuration
+    attr_accessor :amqp, :logger, :system, :client
+
+    def initialize
+      @system = OpenStruct.new
+      @logger = Logger.new(STDOUT)
+    end
+  end
+end

data/lib/columbo/error.rb

@@ -0,0 +1,4 @@
+module Columbo
+  class NoConfigurationFoundError < StandardError
+  end
+end

data/lib/columbo/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: columbo-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wifirst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: A simple Ruby client for the Columbo REST and AMQP API
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- columbo-client.gemspec
+- lib/columbo-client.rb
+- lib/columbo/clients/amqp.rb
+- lib/columbo/clients/http.rb
+- lib/columbo/configuration.rb
+- lib/columbo/error.rb
+- lib/columbo/version.rb
+homepage: https://github.com/wifirst-lab/columbo-ruby-client
+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 simple Ruby client for the Columbo REST and AMQP API
+test_files: []