rapids_rivers 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6113dcdee59279d74f0602e8f3df478df19bd2f9
+  data.tar.gz: e3309bf86ac3a1bcfd8f2a6257016082794fa37f
+SHA512:
+  metadata.gz: 5358b38231038648b3ed81e9c466da7e3749b9886c42b4ed5d4deea133c03c9d912fd942e19972cbfe3293989bf7a6266f3451e9abe8d5a5a57a39c44e89e938
+  data.tar.gz: d9597c6feae249acc74e7a1c81e083ab9d98389c61fd19b27574628497687891e2c3050680815fa4eb3a670b20ca847547b2c9eb6d29dfed85bd6b996342d589

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,41 @@
+# RapidsRivers
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rapids_rivers`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rapids_rivers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rapids_rivers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/rapids_rivers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+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']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rapids_rivers"
+
+# 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(__FILE__)

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/rapids_rivers/packet.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module RapidsRivers
+
+  # Understands a specifc message
+  class Packet
+    # The following keys are reserved for system usage:
+    VISIT_COUNT = 'system_read_count'
+    CONTRIBUTING_SERVICES = 'contributing_services'
+
+    attr_reader :contributing_services
+    protected :contributing_services
+
+    def initialize(json_hash)
+      @json_hash = json_hash
+      @system_read_count = (@json_hash[VISIT_COUNT] || -1) + 1
+      @contributing_services = @json_hash[CONTRIBUTING_SERVICES] || []
+      @used_keys = [VISIT_COUNT, CONTRIBUTING_SERVICES]
+    end
+
+    def used_key(key)
+      @used_keys << key.to_s
+    end
+
+    def clone_with_name(service_name)
+      self.clone.tap { |packet_copy| packet_copy.contributing_services << service_name }
+    end
+
+    def to_json
+      @used_keys.each { |key| @json_hash[key] = instance_variable_get("@#{key}".to_sym) if instance_variable_get("@#{key}".to_sym) }
+      @json_hash.to_json
+    end
+
+    def to_s
+      "Packet (in JSON): #{self.to_json}"
+    end
+
+  end
+
+end

data/lib/rapids_rivers/packet_problems.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module RapidsRivers
+
+  # Understands issues about a particular JSON-formatted Packet
+  class PacketProblems
+
+    def initialize(original_json)
+      @json_string = original_json
+      @informational_messages, @warnings, @errors, @severe_errors = [], [], [], []
+    end
+
+    def errors?
+      @errors.any? || @severe_errors.any?
+    end
+
+    def messages?
+      errors? || @warnings.any? || @informational_messages.any?
+    end
+
+    def information(explanation)
+      @informational_messages << explanation
+    end
+
+    def warning(explanation)
+      @warnings << explanation
+    end
+
+    def error(explanation)
+      @errors << explanation
+    end
+
+    def severe_error(explanation)
+      @severe_errors << explanation
+    end
+
+    def to_s
+      return("No errors detected in JSON:\n\t" + @json_string) if !messages?
+      results = "Errors and/or messages exist. Original JSON string is:\n\t"
+      results += @json_string
+      results += messages("Severe errors", @severe_errors)
+      results += messages("Errors", @errors)
+      results += messages("Warnings", @warnings)
+      results += messages("Information", @informational_messages)
+      results += "\n"
+    end
+
+    private
+
+      def messages(label, messages)
+        return "" if messages.empty?
+        results = "\n"
+        results += ' '*5
+        results += label
+        results += ": "
+        results += messages.size.to_s
+        results += "\n\t"
+        results += messages.join("\n\t")
+      end
+
+  end
+
+end

data/lib/rapids_rivers/rabbit_mq/rabbit_mq_rapids.rb

@@ -0,0 +1,50 @@
+require 'bunny'
+
+require_relative '../rapids_connection'
+require_relative './rabbit_mq_river'
+
+module RapidsRivers
+
+  # Understands an event bus based on RabbitMQ
+  class RabbitMqRapids
+    include RapidsRivers::RapidsConnection
+
+    RAPIDS = 'rapids'
+
+    def initialize(host_ip, port)
+      @connection = Bunny.new(
+        :host => host_ip,
+        :port => port.to_i,
+        :automatically_recover => false)
+    end
+
+    def publish(packet)
+      exchange.publish packet.to_json
+    end
+
+    def queue queue_name = ""
+      channel.queue(queue_name || "", exclusive: true, auto_delete: true).tap do |queue|
+        queue.bind exchange
+      end
+    end
+
+    def close
+      channel.close
+      @connection.close
+    end
+
+    private
+
+      def channel
+        return @channel if @channel
+        @connection.start
+        @channel = @connection.create_channel
+      end
+
+      def exchange
+        @exchange ||= channel.fanout(RAPIDS, durable: true, auto_delete: true)
+      end
+
+  end
+
+end

data/lib/rapids_rivers/rabbit_mq/rabbit_mq_river.rb

@@ -0,0 +1,29 @@
+require_relative '../river'
+
+module RapidsRivers
+
+  # Understands a filtered message stream based on RabbitMQ
+  class RabbitMqRiver < RapidsRivers::River
+
+    alias_method :parent_register, :register
+    def register service
+      super
+      begin
+        queue(service).subscribe(:block => true)  do |delivery_info, metadata, payload|
+          message @rapids_connection, payload
+        end
+      rescue Interrupt => _
+        @rapids_connection.close
+        exit(0)
+      end
+    end
+
+    private
+
+      def queue service
+        @queue ||= @rapids_connection.queue service.service_name
+      end
+
+  end
+
+end

data/lib/rapids_rivers/rapids_connection.rb

@@ -0,0 +1,26 @@
+module RapidsRivers
+
+  # Understands the protocol to an event bus
+  module RapidsConnection
+
+    def register(listener)
+      listeners << listener
+    end
+
+    def received_message(message)
+      listeners.each { |listener| listener.message(self, message) }
+    end
+
+    def publish(packet)
+      throw "No implementation to send packets: \n\t #{packet.to_s}"
+    end
+
+    private
+
+      def listeners
+        @listeners ||= []
+      end
+
+  end
+
+end

data/lib/rapids_rivers/river.rb

@@ -0,0 +1,145 @@
+require 'json'
+
+require_relative './rapids_connection'
+require_relative './packet'
+require_relative './packet_problems'
+
+module RapidsRivers
+
+  # Understands a filtered stream of JSON messages
+  class River
+    attr_reader :rapids_connection, :listening_services
+    protected :rapids_connection, :listening_services
+
+    def initialize rapids_connection
+      @rapids_connection = rapids_connection
+      @listening_services = []
+      @validations = []
+      rapids_connection.register(self);
+    end
+
+    def message send_port, message
+      packet_problems = RapidsRivers::PacketProblems.new message
+      packet = packet_from message, packet_problems
+      @listening_services.each do |ls|
+        next ls.on_error(send_port, packet_problems) if packet_problems.errors?
+        ls.packet send_port, packet.clone_with_name(ls.service_name), packet_problems
+      end
+    end
+
+    def register service
+      @listening_services << service
+    end
+
+    def require *keys
+      keys.each do |key|
+        @validations << lambda do |json_hash, packet, packet_problems|
+          validate_required key, json_hash, packet_problems
+          create_accessors key, json_hash, packet
+        end
+      end
+      self
+    end
+
+    def forbid *keys
+      keys.each do |key|
+        @validations << lambda do |json_hash, packet, packet_problems|
+          validate_missing key, json_hash, packet_problems
+          create_accessors key, json_hash, packet
+        end
+      end
+      self
+    end
+
+    def require_values(key_value_hashes)
+      key_value_hashes.each do |key, value|
+        @validations << lambda do |json_hash, packet, packet_problems|
+          validate_value key.to_s, value, json_hash, packet_problems
+          create_accessors key.to_s, json_hash, packet
+        end
+      end
+      self
+    end
+
+    def interested_in *keys
+      keys.each do |key|
+        @validations << lambda do |json_hash, packet, packet_problems|
+          create_accessors key, json_hash, packet
+        end
+      end
+      self
+    end
+
+    private
+
+      def packet_from message, packet_problems
+        begin
+          json_hash = JSON.parse(message)
+          packet = Packet.new json_hash
+          @validations.each { |v| v.call json_hash, packet, packet_problems }
+          packet
+        rescue JSON::ParserError
+          packet_problems.severe_error("Invalid JSON format. Please check syntax carefully.")
+        rescue Exception => e
+          packet_problems.severe_error("Packet creation issue:\n\t#{e}")
+        end
+      end
+
+      def validate_required key, json_hash, packet_problems
+        return packet_problems.error "Missing required key #{key}" unless json_hash[key]
+        return packet_problems.error "Empty required key #{key}" unless value?(json_hash[key])
+      end
+
+      def validate_missing key, json_hash, packet_problems
+        return unless json_hash.key? key
+        return unless value?(json_hash[key])
+        packet_problems.error "Forbidden key #{key} detected"
+      end
+
+      def validate_value key, value, json_hash, packet_problems
+        validate_required key, json_hash, packet_problems
+        return if json_hash[key] == value
+        packet_problems.error "Required value of key '#{key}' is '#{json_hash[key]}', not '#{value}'"
+      end
+
+      def create_accessors key, json_hash, packet
+        packet.used_key key
+        establish_variable key, json_hash[key], packet
+        define_getter key, packet
+        define_setter key, packet
+      end
+
+      def establish_variable key, value = nil, packet
+        variable = variable(key)
+        packet.instance_variable_set variable, value
+      end
+
+      def define_getter key, packet
+        variable = variable(key)
+        packet.define_singleton_method(key.to_sym) do
+          instance_variable_get variable
+        end
+      end
+
+      def define_setter key, packet
+        variable = variable(key)
+        packet.define_singleton_method((key + '=').to_sym) do |new_value|
+          instance_variable_set variable, new_value
+        end
+      end
+
+      def variable key
+        ('@' + key.to_s).to_sym
+      end
+
+      def value? value_under_test
+        return false if value_under_test.nil?
+        return true if value_under_test.kind_of?(Numeric)
+        return false if value_under_test == ''
+        return false if value_under_test == []
+        true
+      end
+
+  end
+
+end

data/lib/rapids_rivers/version.rb

@@ -0,0 +1,3 @@
+module RapidsRivers
+  VERSION = "0.1.7"
+end

data/lib/rapids_rivers.rb

@@ -0,0 +1,6 @@
+require "rapids_rivers/version"
+require_relative "rapids_rivers/rabbit_mq/rabbit_mq_rapids"
+
+module RapidsRivers
+  # Your code goes here...
+end

data/rapids_rivers.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rapids_rivers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rapids_rivers"
+  spec.version       = RapidsRivers::VERSION
+  spec.authors       = ["Fred George"]
+  spec.email         = ["fredgeorge@acm.org"]
+
+  spec.summary       = %q{Provides a Rapids/Rivers framework for asynchronous MicroServices}
+  spec.description   = %q{Provides a generic Rapids/Rivers framework, and a specific implementation useing RabbitMQ as the event bus.}
+  spec.homepage      = "https://github.com/fredgeorge/rapids_rivers"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bunny", "~> 2.6"
+  spec.add_development_dependency "json", "~> 2.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rapids_rivers
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Fred George
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Provides a generic Rapids/Rivers framework, and a specific implementation
+  useing RabbitMQ as the event bus.
+email:
+- fredgeorge@acm.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rapids_rivers.rb
+- lib/rapids_rivers/packet.rb
+- lib/rapids_rivers/packet_problems.rb
+- lib/rapids_rivers/rabbit_mq/rabbit_mq_rapids.rb
+- lib/rapids_rivers/rabbit_mq/rabbit_mq_river.rb
+- lib/rapids_rivers/rapids_connection.rb
+- lib/rapids_rivers/river.rb
+- lib/rapids_rivers/version.rb
+- rapids_rivers.gemspec
+- vendor/cache/amq-protocol-2.1.0.gem
+- vendor/cache/bunny-2.6.4.gem
+- vendor/cache/json-2.0.3.gem
+- vendor/cache/minitest-5.10.1.gem
+- vendor/cache/rake-12.0.0.gem
+homepage: https://github.com/fredgeorge/rapids_rivers
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Provides a Rapids/Rivers framework for asynchronous MicroServices
+test_files: []