gossiperl_client 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzE0MjE3NzNmNjg1MWJhYzQwNTE2MDE1N2FmNzExMDc3ZTA3MDdiZQ==
+  data.tar.gz: !binary |-
+    NTBjODRjMzU1YjcxNjcyZGEyMTRkYThkMDYzNTY2OTczOTc2ZTI1MQ==
+SHA512:
+  metadata.gz: !binary |-
+    Yzg0M2FhZGI4ODJmYjBiZDc2NzE0NzA3ZWYzODkzYzJlNDk2YzBiNDAzZmNm
+    MjI1YmFiZjQ3MTc5OTQ0NGEyZGYwY2Q0NjkxMGZiYTQzZTRiNTM1YmVkOTEw
+    NjljNzkzOTM1N2VlMThiZjdhYzYyZjFjM2JlMjFhZTY2Mjc4Yzg=
+  data.tar.gz: !binary |-
+    YmRiY2ZhOGU1MjExMTk3MzI3MzE1ZDc4MjQ3NjA2NGZmZmNiYzZmMjBmNDRl
+    NWQ5YWZkNzQzMTJhOGE1MzFhODAxYmE0YzY2NzBhOWIxZjQ4NTRhZjY4OTU2
+    ZjYzY2ZjODdlNjY1MDJkOTMxM2FmNzU5Y2Y2ZWMyYWZiYmZmZTA=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gem 'thrift'
+gem 'shindo'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Radoslaw Gruchalski <radek@gruchalski.com>
+
+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,151 @@
+# Ruby gossiperl client
+
+Ruby [gossiperl](https://github.com/radekg/gossiperl) client library.
+
+## Installation
+
+In your `Gemfile`:
+
+    gem 'gossiperl_client', :git => 'https://github.com/radekg/gossiperl-client-ruby.git'
+
+## Running
+
+    require 'gossiperl_client'
+    supervisor = ::Gossiperl::Client::Supervisor.new
+
+## Connecting to an overlay
+
+    supervisor.connect( :overlay_name  => :your_overlay_name
+                        :overlay_port  => 6666,
+                        :client_port   => 54321,
+                        :client_name   => :your_client_name,
+                        :client_secret => :your_client_secret,
+                        :symkey        => :symmetric_key )
+
+It's also possible to connect with a block:
+
+    supervisor.connect( ... ) do |event|
+      if event[:event] == :connected
+        self.logger.info "Connected to overlay #{event[:options][:overlay_name]}..."
+      elsif event[:event] == :disconnected
+        self.logger.info "Disconnected from overlay #{event[:options][:overlay_name]}..."
+      elsif event[:event] == :subscribed
+        self.logger.info "Received subscription confirmation for #{event[:details][:types]}"
+      elsif event[:event] == :unsubscribed
+        self.logger.info "Received unsubscription confirmation for #{event[:details][:types]}"
+      elsif event[:event] == :event
+        self.logger.info "Received member related event #{event[:details][:type]} for member #{event[:details][:member]}."
+      elsif event[:event] == :forwarded_ack
+        self.logger.info "Received confirmation of forwarded message. Message ID: #{event[:details][:reply_id]}"
+      elsif event[:event] == :forwarded
+        self.logger.info "Received forwarded digest #{event[:digest]} of type #{event[:digest_type]}"
+      elsif event[:event] == :failed
+        self.logger.info "Received an error from the client. Reason: #{event[:error]}."
+      end
+    end
+
+A client may be connected to multiple overlays.
+
+## Subscribing / unsubscribing
+
+Subscribing:
+
+    supervisor.subscribe( :overlay_name, [ :event_1, :event_2, ... ] )
+
+Unsubscribing:
+
+    supervisor.unsubscribe( :overlay_name, [ :event_1, :event_2, ... ] )
+
+Or in a block:
+
+    self.subscribe( [ :event_1, :event_2, ... ] )
+    self.unsubscribe( [ :event_1, :event_2, ... ] )
+
+## Disconnecting from an overlay:
+
+    supervisor.disconnect( :overlay_name )
+
+Or in a block:
+
+    self.stop
+
+This will attempt a graceful exit from an overlay.
+
+## Additional operations
+
+### Checking current client state
+
+    supervisor.state( :overlay_name )
+
+Or in a block:
+
+    self.current_state
+
+### Get the list of current subscriptions
+
+    supervisor.subscriptions( :overlay_name )
+
+Or in a block:
+
+    self.state.subscriptions
+
+### Sending arbitrary digests
+
+
+    supervisor.send( :overlay_name, :digestType, {
+      :property => { :value => <value>, :type => <thrift-type-as-string>, :field_id => <field-order> }
+    } )
+
+Or in a block:
+
+    self.send( :digestType, {
+      :property => { :value => <value>, :type => <thrift-type-as-string>, :field_id => <field-order> }
+    } )
+
+Where `:type` is one of the Thrift types:
+
+- `:stop`
+- `:void`
+- `:bool`
+- `:byte`
+- `:double`
+- `:i16`
+- `:i32`
+- `:i64`
+- `:string`
+- `:struct`
+- `:map`
+- `:set`
+- `:list`
+
+And `:field_id` is a Thrift field ID.
+
+## Running tests
+
+    shindont tests
+
+Tests assume an overlay with the details specified in the `tests/process_tests.rb` running.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Radoslaw Gruchalski <radek@gruchalski.com>
+
+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/gossiperl_client.gemspec

@@ -0,0 +1,44 @@
+# encoding: ascii-8bit
+$:.push File.expand_path("../lib", __FILE__)
+require "gossiperl_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gossiperl_client"
+  s.version       = Gossiperl::Client::Version::VERSION
+  s.has_rdoc      = false
+  s.summary       = "Gossiperl Ruby client"
+  s.description   = "Work with gossiperl from Ruby."
+  s.authors       = ["Rad Gruchalski"]
+  s.email         = ["radek@gruchalski.com"]
+  s.homepage      = "https://github.com/radekg/gossiperl-client-ruby"
+  s.require_paths = %w[lib]
+
+  s.add_dependency('thrift', '>=0.9.2.0')
+  s.add_development_dependency('shindo')
+  
+  s.files = %w[
+    Gemfile
+    README.md
+    LICENSE
+    lib/gossiperl_client.rb
+    lib/gossiperl_client/encryption/aes256.rb
+    lib/gossiperl_client/serialization/serializer.rb
+    lib/gossiperl_client/thrift/gossiperl_constants.rb
+    lib/gossiperl_client/thrift/gossiperl_types.rb
+    lib/gossiperl_client/transport/udp.rb
+    lib/gossiperl_client/util/validation.rb
+    lib/gossiperl_client/headers.rb
+    lib/gossiperl_client/messaging.rb
+    lib/gossiperl_client/overlay_worker.rb
+    lib/gossiperl_client/requirements.rb
+    lib/gossiperl_client/resolution.rb
+    lib/gossiperl_client/state.rb
+    lib/gossiperl_client/supervisor.rb
+    lib/gossiperl_client/version.rb
+    gossiperl_client.gemspec
+    tests/process_tests.rb
+    tests/thrift_tests.rb
+  ]
+  s.test_files    = s.files.select { |path| path =~ /^[tests]\/.*_[tests]\.rb/ }
+  
+end

data/lib/gossiperl_client.rb

@@ -0,0 +1,5 @@
+# encoding: ascii-8bit
+require 'thrift'
+require 'securerandom'
+require 'logger'
+require "#{File.expand_path(File.dirname(__FILE__))}/gossiperl_client/requirements.rb"

data/lib/gossiperl_client/encryption/aes256.rb

@@ -0,0 +1,44 @@
+# encoding: ascii-8bit
+module Gossiperl
+  module Client
+    module Encryption
+      class Aes256 < Gossiperl::Client::Resolution
+
+        field :key, Object
+
+        def initialize key_in
+          # setup key:
+          self.key = ::Digest::SHA256.digest(key_in)
+        end
+        
+        def algorithm
+          'AES-256-CBC'
+        end
+
+        def encrypt data
+          random_iv = OpenSSL::Cipher::Cipher.new(algorithm).random_iv
+          aes = ::OpenSSL::Cipher::Cipher.new(algorithm)
+          aes.encrypt
+          aes.key = self.key
+          aes.iv = random_iv
+          cipher = aes.update(data)
+          cipher << aes.final
+          random_iv + cipher
+        end
+
+        def decrypt cipher
+          iv = cipher[0...16]
+          cipher_data = cipher[16..-1]
+          decode_cipher = ::OpenSSL::Cipher::Cipher.new(algorithm)
+          decode_cipher.decrypt
+          decode_cipher.key = self.key
+          decode_cipher.padding = 0
+          decode_cipher.iv = iv
+          plain = decode_cipher.update(cipher_data)
+          plain << decode_cipher.final
+          plain
+        end
+      end
+    end
+  end
+end

data/lib/gossiperl_client/headers.rb

@@ -0,0 +1,46 @@
+# encoding: ascii-8bit
+module Gossiperl
+  module Client
+
+    class Resolution; end
+
+    module Encryption
+      class Aes256 < Gossiperl::Client::Resolution; end
+    end
+
+    module Serialization
+      class Serializer; end
+    end
+
+    module Thrift
+      class DigestEnvelope; end
+      class DigestForwardedAck; end
+      class DigestError; end
+      class DigestExit; end
+      class DigestMember; end
+      class DigestSubscription; end
+      class Digest; end
+      class DigestAck; end
+      class DigestSubscriptions; end
+      class DigestSubscribe; end
+      class DigestSubscribeAck; end
+      class DigestUnsubscribe; end
+      class DigestUnsubscribeAck; end
+      class DigestEvent; end
+    end
+
+    module Transport
+      class Udp < Gossiperl::Client::Resolution; end
+    end
+
+    module Util
+      class Validation; end
+    end
+
+    class Messaging < Gossiperl::Client::Resolution; end
+    class OverlayWorker < Gossiperl::Client::Resolution; end
+    class State < Gossiperl::Client::Resolution; end
+    class Supervisor < Gossiperl::Client::Resolution; end
+
+  end
+end

data/lib/gossiperl_client/messaging.rb

@@ -0,0 +1,120 @@
+# encoding: ascii-8bit
+module Gossiperl
+  module Client
+    class Messaging < Gossiperl::Client::Resolution
+
+      field :worker, Gossiperl::Client::OverlayWorker
+      field :transport, Gossiperl::Client::Transport::Udp
+
+      def initialize worker, &block
+        self.worker = worker
+        @callback_block = block
+      end
+
+      def get_callback_block
+        @callback_block
+      end
+
+      def start
+        self.transport = Gossiperl::Client::Transport::Udp.new( self.worker )
+        if self.worker.options.has_key?(:thrift_window)
+          self.transport.recv_buf_size = self.worker.options[:thrift_window]
+        end
+        Thread.new(self) do |msg|
+          msg.transport.handle do |data|
+            if data.kind_of? Hash
+              if data.has_key?(:error)
+                msg.worker.process_event( { :event => :failed,
+                                            :error => data[:error] } )
+              elsif data.has_key?(:forward)
+                msg.worker.process_event( { :event => :forwarded,
+                                            :digest => data[:envelope],
+                                            :digest_type => data[:type] } )
+                msg.digest_forwarded_ack data[:envelope].id
+              else
+                msg.worker.process_event( { :event => :failed,
+                                            :error => { :unsupported_hash_response => data } } )
+              end
+            else
+              if data.is_a?( Gossiperl::Client::Thrift::Digest )
+                msg.digest_ack data
+              elsif data.is_a?( Gossiperl::Client::Thrift::DigestAck )
+                msg.worker.state.receive data
+              elsif data.is_a?( Gossiperl::Client::Thrift::DigestEvent )
+                msg.worker.process_event( { :event => :event,
+                                            :details => { :type => data.event_type,
+                                                          :member => data.event_object,
+                                                          :heartbeat => data.heartbeat } } )
+              elsif data.is_a?( Gossiperl::Client::Thrift::DigestSubscribeAck )
+                msg.worker.process_event( { :event => :subscribed,
+                                            :details => { :types => data.event_types.map{|item| item.to_sym},
+                                                          :heartbeat => data.heartbeat } } )
+              elsif data.is_a?( Gossiperl::Client::Thrift::DigestUnsubscribeAck )
+                msg.worker.process_event( { :event => :unsubscribed,
+                                            :details => { :types => data.event_types.map{|item| item.to_sym},
+                                                          :heartbeat => data.heartbeat } } )
+              elsif data.is_a?( Gossiperl::Client::Thrift::DigestForwardedAck )
+                msg.worker.process_event( { :event => :forwarded_ack,
+                                            :details => { :reply_id => data.reply_id } } )
+              else
+                msg.worker.process_event( { :event => :failed,
+                                            :error => { :unsupported_digest => data } } )
+              end
+            end
+          end
+        end
+      end
+
+      def send digest
+        self.transport.send digest
+      end
+
+      def digest_ack digest
+        ack = ::Gossiperl::Client::Thrift::DigestAck.new
+        ack.name = self.worker.options[:client_name].to_s
+        ack.heartbeat = Time.now.to_i
+        ack.reply_id = digest.id
+        ack.membership = []
+        self.send ack
+      end
+
+      def digest_forwarded_ack digest_id
+        ack = ::Gossiperl::Client::Thrift::DigestForwardedAck.new
+        ack.name = self.worker.options[:client_name].to_s
+        ack.secret = self.worker.options[:client_secret].to_s
+        ack.reply_id = digest_id
+        self.send ack
+      end
+
+      def digest_subscribe event_types
+        digest = ::Gossiperl::Client::Thrift::DigestSubscribe.new
+        digest.name = self.worker.options[:client_name].to_s
+        digest.secret = self.worker.options[:client_secret].to_s
+        digest.id = SecureRandom.uuid.to_s
+        digest.heartbeat = Time.now.to_i
+        digest.event_types = event_types.map{|item| item.to_s}
+        self.send digest
+      end
+
+      def digest_unsubscribe event_types
+        digest = ::Gossiperl::Client::Thrift::DigestUnsubscribe.new
+        digest.name = self.worker.options[:client_name].to_s
+        digest.secret = self.worker.options[:client_secret].to_s
+        digest.id = SecureRandom.uuid.to_s
+        digest.heartbeat = Time.now.to_i
+        digest.event_types = event_types.map{|item| item.to_s}
+        self.send digest
+      end
+
+      def digest_exit
+        digest = ::Gossiperl::Client::Thrift::DigestExit.new
+        digest.name = self.worker.options[:client_name].to_s
+        digest.heartbeat = Time.now.to_i
+        digest.secret = self.worker.options[:client_secret].to_s
+        self.send digest
+        self.worker.working = false
+      end
+
+    end
+  end
+end