mbus 1.0.0

data/lib/messagebus/custom_errors.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Messagebus
+  class InvalidAcknowledgementType < StandardError; end
+  class InvalidDestination < StandardError; end
+  class InvalidHost < StandardError; end
+  class MessageReceiveTimeout < RuntimeError; end
+  class ErrorFrameReceived < RuntimeError; end
+end

data/lib/messagebus/dottable_hash.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Messagebus
+  class DottableHash < Hash
+
+    def initialize(plain_old_hash={})
+      merge!(plain_old_hash)
+    end
+
+    def respond_to?(method)
+      true
+    end
+
+    def method_missing(method, *arguments, &block)
+      key = method.to_s
+      if key.match(/\=$/)
+        self[key.chop] = arguments.first
+      elsif self.has_key?(key)
+        self[key]
+      end
+    end
+
+    def [](key)
+      super(key.to_s)
+    end
+
+    def []=(key, value)
+      super(key.to_s, deep_stringify(value))
+    end
+
+    def merge!(hash)
+      super(stringify_keys(hash))
+    end
+
+    def replace(hash)
+      super(stringify_keys(hash))
+    end
+
+    def delete(key)
+      super(key.to_s)
+    end
+
+    def has_key?(key)
+      super(key.to_s)
+    end
+
+    def fetch(key)
+      super(key.to_s)
+    end
+
+    def assoc(key)
+      super(key.to_s)
+    end
+
+    def values_at(*args)
+      super(*args.collect(&:to_s))
+    end
+
+    alias :store :[]=
+    alias :update :merge!
+    alias :merge :merge!
+    alias :key? :has_key?
+    alias :include? :has_key?
+
+    private
+
+    def stringify_keys(hash)
+      hash.inject({}) do |acc, (key, value)|
+        acc[key.to_s] = deep_stringify(hash[key])
+        acc
+      end
+    end
+
+    def deep_stringify(element)
+      case element
+      when Array
+        element.collect {|value| deep_stringify(value)}
+      when Hash
+        self.class.new(stringify_keys(element))
+      else
+        element
+      end
+    end
+  end
+end

data/lib/messagebus/error_status.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Messagebus
+  class MessageStatus
+    CODES = {
+      "1000" => "Invalid Acknowledgement Type",
+      "1010" => "Invalid Host",
+      "1020" => "Invalid Destination"
+    }
+
+    def initialize(code, message, backtrace = nil)
+    end
+  end
+end

data/lib/messagebus/logger.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require 'logger'
+
+module Messagebus 
+  module Logging
+    class MyLogger < Logger      
+      def error(message, exception=nil)
+        if exception
+          message += "\n" + exception.message + "\n" + exception.backtrace.join("\n")
+        end
+        
+        super(message)
+      end
+    end
+  end
+end

data/lib/messagebus/message.rb

@@ -0,0 +1,168 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+require "json"
+require "thrift"
+require "digest/md5"
+
+module Messagebus
+  # Container class for frames, misnamed technically
+  class Message
+    attr_reader :raw_message 
+
+    @@serializer = ::Thrift::Serializer.new
+    @@deserializer = ::Thrift::Deserializer.new
+    @@serializer_lock = Mutex.new
+    @@deserializer_lock = Mutex.new
+
+    class << self
+      def create(payload, properties = nil, binary = false)
+        Messagebus::Message.create_message(define_thrift(payload, binary), properties)
+      end
+
+      # Creates message from base64 encoded thrift bytes.
+      # We use Stomp protocol for server communication which internally
+      # uses string (utf-8). Base64 encoding is needed to avoid corner
+      # cases with weird bytes etc.
+      def get_message_from_thrift_binary(body)
+        binary_string = Base64.decode64(body)
+        rmessage = nil
+        @@deserializer_lock.synchronize do
+          rmessage = @@deserializer.deserialize(Messagebus::Thrift::MessageInternal.new, binary_string)
+        end
+        Messagebus::Message.create_message_from_message_internal(rmessage)
+      end
+
+      def define_thrift(payload, binary = false)
+        options = {}
+        
+        if binary        
+	  if RUBY_VERSION.to_f >= 1.9 
+      	      payload.force_encoding('UTF-8')
+      	  end
+          options.merge!({
+            :messageFormat => Messagebus::Thrift::MessagePayloadType::BINARY,
+            :binaryPayload => payload
+          })
+        elsif payload.is_a?(Hash) || (payload.respond_to?(:to_json) && !payload.is_a?(String))
+          options.merge!({
+            :messageFormat => Messagebus::Thrift::MessagePayloadType::JSON,
+            :stringPayload => payload.to_json
+          })
+        elsif payload.is_a?(String)
+          #Only UTF-8 is supported by thrift. Should warn to use binary if not ascii or utf-8 but there's no logger
+          #I believe all users use utf8 or ascii.
+          if RUBY_VERSION.to_f >= 1.9 
+             payload.force_encoding('UTF-8')
+          end
+          options.merge!({
+            :messageFormat => Messagebus::Thrift::MessagePayloadType::STRING,
+            :stringPayload => payload
+          })
+        else
+          # TODO: Create specific error class
+          raise "Type not supported"
+        end
+
+        Messagebus::Thrift::MessagePayload.new(options)
+      end
+ 
+      # TODO: Why use this in utils when
+      # trying to follow a factory pattern?
+      def create_message_from_message_internal(raw_message)
+        Message.new(raw_message)
+      end
+    end
+
+    def message_id
+      @raw_message.messageId
+    end          
+    
+    def message_properties
+      @raw_message.properties
+    end 
+    
+    def message_properties=(hash)
+      @raw_message.properties = hash
+    end 
+    
+    def payload_type
+      @raw_message.payload.messageFormat
+    end
+    
+    def payload
+      payload = @raw_message.payload
+
+      if payload.binary?
+        @raw_message.payload.binaryPayload
+      elsif payload.json? || payload.string?
+        @raw_message.payload.stringPayload
+      else
+        raise "Payload is not an understandable type: #{payload.messageFormat}"
+      end
+    end
+
+    def to_thrift_binary
+      binary_string = nil
+      @@serializer_lock.synchronize do
+        binary_string = @@serializer.serialize(@raw_message)
+      end
+      Base64.encode64(binary_string);
+    end
+ 
+    private
+    
+    def initialize(raw_message)
+      @raw_message = raw_message
+    end
+
+        
+    class << self
+      # Returns the payload as a string salted with current milliseconds since epoch.
+      def get_salted_payload(payload)
+        t = Time.now
+        data = payload.binary? ? payload.binaryPayload : payload.stringPayload
+        data += t.to_i.to_s
+        data += t.tv_usec.to_s 
+        data
+      end
+      
+      def create_message(payload, properties = nil)
+        raw_message = Messagebus::Thrift::MessageInternal.new
+        raw_message.messageId = Digest::MD5.hexdigest(get_salted_payload(payload))
+        raw_message.payload = payload
+        raw_message.properties = properties if properties
+
+        Message.new(raw_message)
+      end
+    end
+  end
+end
+

data/lib/messagebus/messagebus_types.rb

@@ -0,0 +1,107 @@
+# Copyright (c) 2012, Groupon, Inc.
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+# Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 
+# Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 
+# Neither the name of GROUPON nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#
+# Autogenerated by Thrift
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+
+module Messagebus
+  module Thrift
+        module MessagePayloadType
+          JSON = 1
+          BINARY = 2
+          STRING = 3
+          VALUE_MAP = {1 => "JSON", 2 => "BINARY", 3 => "STRING"}
+          VALID_VALUES = Set.new([JSON, BINARY, STRING]).freeze
+        end
+
+        class MessagePayload
+          include ::Thrift::Struct, ::Thrift::Struct_Union
+          MESSAGEFORMAT = 1
+          STRINGPAYLOAD = 2
+          BINARYPAYLOAD = 3
+
+          FIELDS = {
+            MESSAGEFORMAT => {:type => ::Thrift::Types::I32, :name => 'messageFormat', :enum_class => Messagebus::Thrift::MessagePayloadType},
+            STRINGPAYLOAD => {:type => ::Thrift::Types::STRING, :name => 'stringPayload', :optional => true},
+            BINARYPAYLOAD => {:type => ::Thrift::Types::STRING, :name => 'binaryPayload', :binary => true, :optional => true}
+          }
+
+          def struct_fields; FIELDS; end
+
+          def binary?
+            @messageFormat == Messagebus::Thrift::MessagePayloadType::BINARY
+          end
+
+          def json?
+            @messageFormat == Messagebus::Thrift::MessagePayloadType::JSON
+          end
+
+          def string?
+            @messageFormat == Messagebus::Thrift::MessagePayloadType::STRING
+          end
+
+          def validate
+            raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field messageFormat is unset!') unless @messageFormat
+            unless @messageFormat.nil? || Messagebus::Thrift::MessagePayloadType::VALID_VALUES.include?(@messageFormat)
+              raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field messageFormat!')
+            end
+          end
+
+          ::Thrift::Struct.generate_accessors self
+        end
+
+        class MessageInternal
+          include ::Thrift::Struct, ::Thrift::Struct_Union
+          MESSAGEID = 1
+          PAYLOAD = 2
+          PROPERTIES = 3
+
+          FIELDS = {
+            MESSAGEID => {:type => ::Thrift::Types::STRING, :name => 'messageId'},
+            PAYLOAD => {:type => ::Thrift::Types::STRUCT, :name => 'payload', :class => Messagebus::Thrift::MessagePayload},
+            PROPERTIES => {:type => ::Thrift::Types::MAP, :name => 'properties', :key => {:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRING}, :optional => true}
+          }
+
+          def struct_fields; FIELDS; end
+
+          def validate
+            raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field messageId is unset!') unless @messageId
+            raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field payload is unset!') unless @payload
+          end
+
+          ::Thrift::Struct.generate_accessors self
+        end
+
+      end
+    end