soar_transport_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 423f7a78f84a806469883367022491e9cbf44181
+  data.tar.gz: a93ed9eababf76596cc4289464426bba3aaf9be5
+SHA512:
+  metadata.gz: 7f21de49f6a5ed4cdbe9a3658f08f0cf6f00ebefca959ba52cf4823b20932b484a71157fdfcd1e9abc0b493a63f2c04fbba8788c732bcc3d8a024e88edeef6c8
+  data.tar.gz: d80bbe1a24b2f56e08f21d3f35e2d47982fe7a6b83e001e8919d93e536934dc6399484f06f730a8712947b3cbf7e2f875da898a34270faf7b32c8a1481a7e018

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.swp
+*.swo
+.byebug_history

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_transport_api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,129 @@
+# SoarTransportApi
+
+This gem specifies the API to be implemented by transport providers that want to communicate across soar_comms communication fabric. The API allows for message identification, sending and receiving, both synchronously and asynchronously. Messages are simple Hash objects with formatting to be dictated by the transport provider and consumer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_transport_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_transport_api
+
+## Usage
+
+### Building a provider
+
+Extend SoarTransportAPI::TransportAPI and override the methods of interest. For example, for a synchronous HTTP transport provider:
+
+```
+  class HttpTransportApi < SoarTransportApi::TransportAPI
+    attr_accessor :server
+    @received
+
+    def initialize(transport_identifier)
+      super(transport_identifier)
+      @@received = []
+    end
+
+    def send_message(uri, message)
+      uri = URI.parse(uri)
+      response = Net::HTTP.post_form(uri, {"message" => message})
+      @@received.push(response)
+      response
+    end
+
+    def receive_message
+      message = @@received.pop
+      message.body
+    end  
+  end
+```
+
+### Sending messages
+
+Use the API as below to send messages both in the synchronous and asynchronous cases:
+
+```
+  message = { 'body' => 'This is a message' }
+  provider = HttpTransportApi.new("http-example")
+  provider.send_message("http://localhost:9393/postbox", message)
+```
+
+### Receiving messages
+
+Use the API as below for receiving in the synchronous case while sending:
+
+```
+  response = provider.send_message("http://localhost:9393/postbox", message)
+```
+
+Alternatively after a send, in the synchronous case:
+```
+  response = provider.receive_message
+```
+
+Use the API as below for receiving in the asynchronous case. Provide the transport API registered
+back to the subscriber in order for it to know which transport (it may have multiple) pinged it
+with a message. We are using an AMQP transport provider for this example:
+
+```
+  class Subscriber
+    def receive(message)
+      puts "Received #{message}"
+    end
+  end
+
+  class RabbitTransportProvider < SoarTransportApi::TransportAPI
+    def receive_messages(callback, transport_provider_id)
+      t = Thread.new {
+        @conn.start
+        ch   = @conn.create_channel
+        q    = ch.queue(@transport_identifier)
+        begin
+          message = nil
+          q.subscribe(:block => true) do |delivery_info, properties, body|
+            puts " [x] Received message"
+            callback.receive(transport_provider_id, body)
+          end
+          @conn.close
+        rescue Interrupt => _
+          @conn.close
+        end
+      }
+      t.abort_on_exception = true    
+    end
+  end
+
+  provider = RabbitTransportProvider.new("bunnies")
+  subscriber = Subscriber.new
+  provider.receive_messages(suscriber, "bunnies")
+```
+
+### Exceptions
+
+The transport API raises the following exceptions:
+
+```
+  TransportIdentifierInvalidError - a transport identifier was not provided (nil) or was not a String or was an empty string
+  SubscriberCallbackInvalidError - the subscriber specified for callbacks of received messages was not provided (nil) or does not have a receive method
+  NoMessageError - No message was provided to send
+  InvalidURIError - An invalid URI or no URI was provided
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to ernst dot van dot graan at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## 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 "soar_transport_api"
+
+# 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/soar_transport_api.rb

@@ -0,0 +1,9 @@
+require "soar_transport_api/version"
+require "soar_transport_api/transport_api"
+require "soar_transport_api/transport_identifier_invalid_error"
+require "soar_transport_api/subscriber_callback_invalid_error"
+require "soar_transport_api/no_message_error"
+require "soar_transport_api/invalid_URI_error"
+
+module SoarTransportApi
+end

data/lib/soar_transport_api/invalid_URI_error.rb

@@ -0,0 +1,4 @@
+module SoarTransportApi
+  class InvalidURIError < StandardError
+  end
+end

data/lib/soar_transport_api/no_message_error.rb

@@ -0,0 +1,4 @@
+module SoarTransportApi
+  class NoMessageError < StandardError
+  end
+end

data/lib/soar_transport_api/subscriber_callback_invalid_error.rb

@@ -0,0 +1,4 @@
+module SoarTransportApi
+  class SubscriberCallbackInvalidError < StandardError
+  end
+end

data/lib/soar_transport_api/transport_api.rb

@@ -0,0 +1,48 @@
+module SoarTransportApi
+  class TransportAPI
+    DELIVERY_PENDING = "Delivery pending" unless defined? DELIVERY_PENDING; DELIVERY_PENDING.freeze
+    DELIVERY_REJECTED = "Rejected for delivery" unless defined? DELIVERY_REJECTED; DELIVERY_REJECTED.freeze
+    DELIVERY_FAILURE = "Delivery failure" unless defined? DELIVERY_FAILURE; DELIVERY_FAILURE.freeze
+    DELIVERY_SUCCESS = "Delivered successfull" unless defined? DELIVERY_SUCCESS; DELIVERY_SUCCESS.freeze
+    DELIVERY_TIMEOUT = "Delivery timeout" unless defined? DELIVERY_TIMEOUT; DELIVERY_TIMEOUT.freeze
+
+    attr_accessor :transport_identifier
+
+    def initialize(transport_identifier)
+      raise SoarTransportApi::TransportIdentifierInvalidError.new("Invalid transport identifier") if invalid_transport_identifier?(transport_identifier)
+      @transport_identifier = transport_identifier
+    end
+
+    def send_message(uri, message)
+      raise SoarTransportApi::NoMessageError.new("No message provided") if message.nil?
+      raise SoarTransportApi::InvalidURIError.new("Invalid URI") if invalid_uri?(uri)
+    end
+
+    def receive_messages(subscriber, transport_provider_id)
+      raise SoarTransportApi::TransportIdentifierInvalidError.new("Invalid transport identifier") if invalid_transport_identifier?(transport_provider_id)
+      raise SoarTransportApi::SubscriberCallbackInvalidError.new("Invalid subscriber") if invalid_subscriber?(subscriber)
+    end
+
+    def receive_message
+    end
+
+    private
+
+    def invalid_uri?(uri)
+      return true if uri.nil?
+      not (uri =~ URI::DEFAULT_PARSER.regexp[:UNSAFE]).nil? 
+    end
+
+    def invalid_transport_identifier?(transport_identifier)
+      transport_identifier.nil? or
+      (not transport_identifier.is_a?(String)) or
+      transport_identifier.strip == ""
+    end
+
+    def invalid_subscriber?(subscriber)
+      subscriber.nil? or
+      not subscriber.methods.include?(:receive)
+
+    end
+  end
+end

data/lib/soar_transport_api/transport_identifier_invalid_error.rb

@@ -0,0 +1,4 @@
+module SoarTransportApi
+  class TransportIdentifierInvalidError < StandardError
+  end
+end

data/lib/soar_transport_api/version.rb

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

data/soar_transport_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_transport_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_transport_api"
+  spec.version       = SoarTransportApi::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{API to be implemented by transport providers that want to communicate across soar_comms communication fabric}
+  spec.description   = %q{API to be implemented by transport providers that want to communicate across soar_comms communication fabric}
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: soar_transport_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-18 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: 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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API to be implemented by transport providers that want to communicate
+  across soar_comms communication fabric
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_transport_api.rb
+- lib/soar_transport_api/invalid_URI_error.rb
+- lib/soar_transport_api/no_message_error.rb
+- lib/soar_transport_api/subscriber_callback_invalid_error.rb
+- lib/soar_transport_api/transport_api.rb
+- lib/soar_transport_api/transport_identifier_invalid_error.rb
+- lib/soar_transport_api/version.rb
+- soar_transport_api.gemspec
+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.4.8
+signing_key: 
+specification_version: 4
+summary: API to be implemented by transport providers that want to communicate across
+  soar_comms communication fabric
+test_files: []