ruby_nos 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTgwMGY2Yjk5N2M4ODExNTM5ODVhNTdjNmI0MGQ4Njg1YjIzZWY2YQ==
+  data.tar.gz: !binary |-
+    M2VhNmQ3MjEzNjY5MjQ5Yzk2NWQ5M2YwNjE5N2FhMWFmNGU0MmM0Mg==
+SHA512:
+  metadata.gz: !binary |-
+    NzA0ZGQyNTQwM2JmYTE0YTU1NmRkNmU5MzA1ZDY5OTY5YzFhZDM4NmU4NDFi
+    ZjkxZjE3YTI0ZDRmMDZhNmFlZWNlYWI0YTYyZmY2NTI2NzU1ZDE4MTRhYmVi
+    NGM2ZGM5ZDcwZDY5M2Y1NDdhYzk4ZGMzMGFmY2M4YjY5MjFmNzQ=
+  data.tar.gz: !binary |-
+    YTg2NzM3MzYwMWNhYzE4ODY0OTk0MzBhNjkzZDZjMGFmNzRiMmRhODA4YjM1
+    NGE4ODUwMTQ4NGYyOWI4ZTMyNzFiODQ2OTg5OTQzMzEyNmE0NWVhZGY0Nzc4
+    MGM0MzA3OTc5MDFlODNkMjM3YjU5Y2QzYjJhNThlNTU1ZWJjOWE=

data/.gitignore

@@ -0,0 +1,8 @@
+# Files to ignore
+
+*.DS_Store
+log/*
+Guardfile
+*~
+.idea/*
+projectFilesBackup/*

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+cache: bundler
+addons:
+  code_climate:
+    repo_token: cfa24207fbf4926805264ce2b1d04ea090543297f74ad06648346567ead2c839

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  gem 'pry',           require: false
+  gem 'activesupport', require: false
+end
+
+group :test do
+  gem "codeclimate-test-reporter"
+  gem 'rspec',         require: false
+end

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    ruby_nos (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.6.11)
+    json (1.8.1)
+    method_source (0.8.2)
+    minitest (5.4.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler
+  codeclimate-test-reporter
+  pry
+  rake
+  rspec
+  ruby_nos!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Workshare
+
+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,64 @@
+#RubyNos
+[![Build Status](https://travis-ci.org/mariaclrd/ruby-nos.svg?branch=master)](https://travis-ci.org/mariaclrd/ruby-nos)
+[![Code Climate](https://codeclimate.com/github/mariaclrd/ruby-nos/badges/gpa.svg)](https://codeclimate.com/github/mariaclrd/ruby-nos)
+
+A gem to provide microservices autodiscovery to Ruby microservices. This gem allows a microservice to publish its
+existence on a cloud, store other microservices information and public its API.
+
+#Configuration
+
+You can configure the following characteristics of the gem:
+
+###Agent characteristics
+
+Every microservice will have an Agent object that will be the responsible of sending the messages to the cloud. You can
+configure these characteristics:
+
+ * **Cloud_uuid:** The identifier of the cloud where all the microservices will be exchanging messages.
+ * **Port:** UDP port where the Agent will be listening to other microservices messages.
+ * **Group_address:** The IP group where all the microservices will be listening to the messages.
+ * **Time_between_messages:** Allows to specify how much time will pass between the keep alive messages.
+ * **Hops:** Number of hops for the messages.
+
+An example of configuration would be:
+
+  ```ruby
+    config = load_file('ruby_nos')
+    RubyNos.configure do |c|
+      c.cloud_uuid = config['cloud']
+      c.port = config['port']
+      c.group_address = config['group_address']
+      c.time_between_messages = config['time_between_messages']
+    end
+  ```
+
+To make the agent start sending and listening to messages you will have to add the following line to your code:
+
+  ```ruby
+      RubyNos::Agent.new.start!
+  ```
+
+###Publish an API
+
+To publish the API of a microservice you will have to create a RestAPI agent and associate it to the Agent.
+
+  ```ruby
+      ruby_nos_api = RubyNos::RestApi.new
+      ruby_nos_agent.rest_api = ruby_nos_api
+   ```
+
+To publish an endpoint you have to add to the rest_api object.
+
+
+  ```ruby
+      ruby_nos_api.add_endpoint(path: <endpoint path> , type: <"PUB", "HCK", "INT">, port: <application port>)
+  ```
+
+You will have to specify the type of the endpoint, there are three types supported right now:
+
+ * **PUBLIC(PUB):** If the endpoint belongs to a public API.
+ * **INTERNAL(INT):** If the endpoint belongs to an internal API.
+ * **HEALTHCHECK(HCK):** For a healthcheck endpoint.
+
+
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+$stderr.puts e.message
+$stderr.puts "Run `bundle install` to install missing gems"
+exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core/rake_task'
+task :default => :spec
+task :test => :spec
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec') do |spec|
+spec.rspec_opts = %w{}
+end

data/config/environment.rb

@@ -0,0 +1,17 @@
+root_path = File.join(File.dirname(__FILE__),'..')
+lib_path = File.join(root_path,'lib')
+app_name = 'ruby_nos'
+# Add all files to Load path
+$LOAD_PATH << root_path
+$LOAD_PATH << lib_path
+$LOAD_PATH << File.join(lib_path, app_name)
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require app_name

data/lib/initializable.rb

@@ -0,0 +1,14 @@
+module Initializable
+
+  def initialize args = {}
+    set_attributes(args)
+  end
+
+  private
+
+  def set_attributes args
+    args.each do |k,v|
+      send("#{k}=",v)
+    end
+  end
+end

data/lib/ruby_nos.rb

@@ -0,0 +1,64 @@
+require "ruby_nos/version"
+require "logger"
+
+module RubyNos
+  autoload :Agent,               "ruby_nos/agent"
+  autoload :Aliasing,            "ruby_nos/aliasing"
+  autoload :Cloud,               "ruby_nos/cloud"
+  autoload :Endpoint,            "ruby_nos/endpoint"
+  autoload :Formatter,           "ruby_nos/formatter"
+  autoload :Initializable,       "initializable"
+  autoload :List,                "ruby_nos/list"
+  autoload :Message,             "ruby_nos/message"
+  autoload :Processor,           "ruby_nos/processor"
+  autoload :RemoteAgent,         "ruby_nos/remote_agent"
+  autoload :RestApi,             "ruby_nos/rest_api"
+  autoload :SignatureGenerator,  "ruby_nos/signature_generator"
+  autoload :UDPReceptor,         "ruby_nos/udp_receptor"
+  autoload :UDPSender,           "ruby_nos/udp_sender"
+  autoload :VERSION,             "ruby_nos/version"
+
+  class << self
+
+    attr_accessor :signature_key, :logger, :port, :cloud_uuid, :group_address, :time_between_messages, :keep_alive_time, :hops
+
+    def configure
+      if block_given?
+        yield self
+        true
+      end
+    end
+
+    def signature_key
+      @signature_key ||= "key"
+    end
+
+    def logger
+      @logger ||= Logger.new './log/application.log'
+    end
+
+    def port
+      @port ||= 3784
+    end
+
+    def cloud_uuid
+      @cloud_uuid ||= SecureRandom.uuid
+    end
+
+    def group_address
+      @group_address ||= "230.31.32.33"
+    end
+
+    def time_between_messages
+      @time_between_message ||= 30
+    end
+
+    def keep_alive_time
+      @keep_alive_time ||= 60*1000
+    end
+
+    def hops
+      @hops ||= 10
+    end
+  end
+end

data/lib/ruby_nos/agent.rb

@@ -0,0 +1,127 @@
+module RubyNos
+  class Agent
+    include Initializable
+    attr_accessor :uuid, :cloud, :udp_tx, :udp_rx,:processor, :rest_api
+
+    def uuid
+      @uuid ||= SecureRandom.uuid
+    end
+
+    def udp_tx
+      @udp_tx ||= UDPSender.new
+    end
+
+    def udp_rx
+      @udp_rx ||= UDPReceptor.new
+    end
+
+    def cloud
+      @cloud  ||= Cloud.new
+    end
+
+    def processor
+      @processor ||= Processor.new(self)
+    end
+
+    def rest_api
+      @rest_api ||= RestApi.new
+    end
+
+    def start!
+       at_exit {
+         send_desconnection_message
+       }
+      listen
+      join_cloud
+      maintain_cloud
+    end
+
+    def listen
+      udp_rx.listen(processor)
+    end
+
+    def send_message args={}
+      message = build_message(args)
+      udp_tx.send({host: args[:host], port: args[:port], message: message})
+      message
+    end
+
+    def maintain_cloud
+      begin
+        thread = Thread.new do
+          i = 0
+          loop do
+            i = i+1
+            RubyNos.logger.send(:info, "Iteration number #{i}")
+            RubyNos.logger.send(:info, "Agents on the cloud #{cloud.list.list_of_keys.count}")
+            send_discovery_messages
+            send_connection_messages
+            sleep RubyNos.time_between_messages
+          end
+        end
+        thread
+      rescue StandardError => e
+        RubyNos.logger.send(:info, "Error executing the thread #{e.message}")
+      end
+    end
+
+    def send_connection_messages
+      cloud.list.list_of_keys.each do |agent_uuid|
+        last_message_exists?(agent_uuid) ?  send_message({to: "AGT:#{uuid_for_message(agent_uuid)}", type: "PIN"}) : cloud.list.eliminate(agent_uuid)
+      end
+    end
+
+    def send_discovery_messages
+      send_message({type: 'DSC'})
+      send_message({type: 'ENQ'})
+    end
+
+    def join_cloud
+      send_message({type: 'PRS'})
+      send_message({type: 'QNE'}) unless rest_api.endpoints.empty?
+    end
+
+    def send_desconnection_message
+      send_message({type: "PRS", data: {present: 0}})
+    end
+
+    private
+
+    def last_message_exists?(agent_uuid)
+      remote_agent = cloud.list.info_for(agent_uuid)
+      (Formatter.timestamp - remote_agent.timestamp) < RubyNos.keep_alive_time
+    end
+
+    def build_message args
+      if args[:data]
+        data = args[:data]
+      elsif args[:type] == "PRS"
+        data = receptor_info
+      elsif args[:type] == "QNE"
+        data = rest_api.to_hash if rest_api
+      end
+
+      message_hash = {from: "AGT:#{uuid_for_message(uuid)}", to: args[:to] || "CLD:#{uuid_for_message(cloud.uuid)}", type: args[:type]}
+      message_hash.merge!({data: data}) if data
+
+      Message.new(message_hash).serialize
+    end
+
+
+    def receptor_info
+      {present: 1, endpoints: ["UDP,#{udp_rx.socket.connect_address.ip_port},#{udp_rx.socket.connect_address.ip_address}"]}
+    end
+
+    def formatter
+      @formatter ||= Formatter.new
+    end
+
+    def uuid_for_message uuid
+      if formatter.uuid_format?(uuid)
+        formatter.uuid_to_string(uuid)
+      else
+        uuid
+      end
+    end
+  end
+end