thrift-amqp-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47b60f6d88a19c39352bd0173213c238299e01c6
+  data.tar.gz: 96733bf92ae83b43a9da73b7a449f6c33c7e6aff
+SHA512:
+  metadata.gz: 6b76ebc19ab8fe491c572f6d95fca291ea1f7592474c596ae7e3dcbf58b74b378ff766a0a7d9fa8fb8eace1fe6389a46ce75b8bf47b761a6ce191475b5241742
+  data.tar.gz: 651f7479ecc599907ded1610d25c8087281552ab747cb72601a637128c88f037b861eb83876e55d334e8fd582fe194869fc1a2ea4f2855bbd816f7a59ec84536

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alexis Montagne
+
+MIT License
+
+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,29 @@
+# Thrift::Amqp::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thrift-amqp-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thrift-amqp-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/thrift-amqp-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/thrift/amqp/amqp_rpc_client.rb

@@ -0,0 +1,165 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'thrift'
+require 'bunny'
+require 'stringio'
+require 'timeout'
+require 'uuidtools'
+
+module Thrift
+
+  class ResponseTimeout < Timeout::Error; end
+
+  class AmqpRpcClientTransport < BaseTransport
+
+    def initialize(service_queue_name, opts={})
+      @service_queue_name = service_queue_name
+      @outbuf = Bytes.empty_byte_buffer
+
+      if opts[:connection].nil?
+        if opts[:host].nil?
+          raise ArgumentError, ":host key not provided in opts dict to make connection"
+        end
+
+        if opts[:port].nil?
+          raise ArgumentError, ":port key not provided in opts dict to make connection"
+        end
+
+        vhost = opts[:vhost] || "/"
+        user = opts[:user] || "guest"
+        password = opts[:password] || "guest"
+        ssl = opts[:ssl] || false
+
+        @conn = Bunny.new(:host => opts[:host], :port => opts[:port], :vhost => vhost, :user => user, :password => password, :ssl=> ssl)
+
+        @conn.start
+        @connection_started = true
+      else
+        @conn = opts[:connection]
+        @connection_started = false
+      end
+
+      @from_name                 = opts[:from_name].nil? ? "Unknown Client" : opts[:from_name]
+      @exchange                  = opts[:exchange] || nil
+
+      @ch                        = @conn.create_channel
+      @service_exchange          = @exchange.nil? ? @ch.default_exchange : @ch.direct(@exchange, :durable => true)
+      @service_response_exchange = @ch.default_exchange
+      @reply_queue               = @ch.queue("", :exclusive => true)
+      @is_opened                 = true
+
+    end
+
+    def close
+      if @is_opened
+        @reply_queue.delete
+        @ch.close
+
+        if @connection_started
+          @conn.close
+          @connection_started = false
+        end
+
+        @is_opened = false
+      end
+    end
+
+    def open?; @is_opened end
+    def read(sz); @inbuf.read sz end
+    def write(buf); @outbuf << Bytes.force_binary_encoding(buf) end
+
+    #If blocking is set to true then wait for a response message in the reply_to queue, otherwise
+    #just send and go!
+    def flush(options={})
+
+      operation = options.has_key?(:operation) ? options[:operation] : ""
+      blocking = options.has_key?(:blocking) ? options[:blocking] : true
+      msg_timeout = options.has_key?(:msg_timeout) ? options[:msg_timeout] : 10
+      log_messages = options.has_key?(:log_messages) ? options[:log_messages] : false
+
+      correlation_id = self.generate_uuid
+
+      headers = {:service_name      => @service_queue_name,
+                 :operation         => operation,
+                 :response_required => blocking,   #Tell the receiver if a response is required
+                 :from_name         => @from_name
+      }
+
+      #Publish the message
+      print_log "Publishing message reply-to: #{@reply_queue.name} - headers: #{headers}", correlation_id if log_messages
+      start_time = Time.now
+      @service_exchange.publish(@outbuf,
+                                :routing_key    => @service_queue_name,
+                                :correlation_id => correlation_id,
+                                :expiration     => msg_timeout,
+                                :reply_to       => @reply_queue.name,
+                                :headers        => headers)
+
+      #If this is a standard RPC blocking call, then wait for there to be a response from the
+      #service provider or timeout and log the timeout
+      if blocking
+        @response = ""
+        begin
+          #Adding 1sec to timeout to account for clock differences
+          Timeout.timeout(msg_timeout + 1, ResponseTimeout) do
+            @reply_queue.subscribe(:block => true) do |delivery_info, properties, payload|
+
+              if log_messages
+                response_time = Time.now - start_time
+                print_log "---- Response Message received in #{response_time}sec for #{@reply_queue.name}", correlation_id
+                print_log "HEADERS: #{properties}", correlation_id
+              end
+
+              if properties[:correlation_id] == correlation_id
+                @response = payload
+
+                #once the return message has been received, no need to continue a subscription
+                delivery_info.consumer.cancel
+              end
+            end
+          end
+        rescue ResponseTimeout => ex
+          #Trying to work around weirdness being seen in a multi threaded workflow environment
+          if @response == ""
+            msg = "A timeout has occurred (#{msg_timeout}sec) trying to call #{@service_queue_name}.#{operation}"
+            print_log msg, correlation_id
+            raise ex, msg
+          else
+            print_log "Ignoring timeout - #{@response}", correlation_id
+          end
+        end
+        @inbuf = StringIO.new Bytes.force_binary_encoding(@response)
+      end
+      @outbuf = Bytes.empty_byte_buffer
+    end
+
+    protected
+
+    def generate_uuid
+      UUIDTools::UUID.timestamp_create.to_s
+    end
+
+    def print_log(message="", correlation_id="")
+      puts "#{Time.now.utc} C Thread: #{Thread.current.object_id} CID:#{correlation_id} - #{message}"
+    end
+  end
+end
+
+

data/lib/thrift/amqp/amqp_rpc_service.rb

@@ -0,0 +1,165 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'bunny'
+require 'thrift'
+
+module Thrift
+  class AmqpRpcServer < BaseServer
+
+    class ProcessingTimeout < Timeout::Error; end
+
+    def initialize(processor, opts={})
+
+      @processor = processor
+
+      if opts[:connection].nil?
+
+        if opts[:host].nil?
+          raise ArgumentError, ":host key not provided in opts dict to make connection"
+        end
+
+        if opts[:port].nil?
+          raise ArgumentError, ":port key not provided in opts dict to make connection"
+        end
+
+        vhost = opts[:vhost] || "/"
+        user = opts[:user] || "guest"
+        password = opts[:password] || "guest"
+        ssl = opts[:ssl] || false
+
+        @conn = Bunny.new(:host => opts[:host], :port => opts[:port], :vhost => vhost, :user => user, :password => password, :ssl=> ssl)
+        @conn.start
+      else
+        @conn = opts[:connection]
+      end
+
+      #print "service:", @conn, "\n"
+
+      if not opts.has_key?(:queue_name)
+        raise ArgumentError, "A service queue name has not been specified"
+      end
+
+      @queue_name = opts[:queue_name]
+      @protocol_factory = opts[:protocol_factory] || BinaryProtocolFactory
+      @exchange = opts[:exchange] || nil
+
+    end
+
+    def close
+
+      if not @request_channel.nil? and @request_channel.respond_to?('close')
+        @request_channel.close
+      end
+
+      #Always close the broker connection when closing the server
+      @conn.close
+
+    end
+
+
+
+    def serve(options={})
+      log_messages = options[:log_messages] || false
+      max_messages = options[:max_messages].nil? ? 10 : options[:max_messages]
+      response_timeout = options[:response_timeout] || 10
+
+      #Create a channel to the service queue
+      @request_channel = @conn.create_channel(nil, max_messages )
+
+      if @exchange.nil?
+        @service_exchange = @request_channel.default_exchange
+        @request_queue = @request_channel.queue(@queue_name, :auto_delete => true)
+      else
+        @service_exchange = @request_channel.direct(@exchange,:durable => true)
+        @request_queue = @request_channel.queue(@queue_name, :auto_delete => true).bind(@service_exchange, :routing_key => @queue_name)
+      end
+
+      @request_queue.subscribe(:block => true) do |delivery_info, properties, payload|
+
+        if log_messages
+          Thread.current["correlation_id"] = properties.correlation_id
+          print_log "---- Message received ----"
+          print_log "HEADERS: #{properties}"
+        end
+
+        Thread.current["correlation_id"] = properties.correlation_id
+
+        response_channel = @conn.create_channel
+        response_exchange = response_channel.default_exchange
+
+        response_required = properties.headers.has_key?('response_required') ? properties.headers['response_required'] : true
+        process_timeout = response_timeout.to_i > properties.expiration.to_i ? response_timeout.to_i : properties.expiration.to_i
+
+        #Binary content will imply thrift based message payload
+        if properties.content_type == 'application/octet-stream'
+
+          print_log "Request to process #{@queue_name}.#{properties.headers['operation']} in #{process_timeout}sec" if log_messages
+
+          input = StringIO.new payload
+          out = StringIO.new
+          transport = IOStreamTransport.new input, out
+          protocol = @protocol_factory.new.get_protocol transport
+
+          begin
+            start_time = Time.now
+            Timeout.timeout(process_timeout, ProcessingTimeout) do
+              @processor.process protocol, protocol
+            end
+            processing_time = Time.now - start_time
+
+            #rewind the buffer for reading
+            if out.length > 0
+              out.rewind
+
+              print_log "Time to process request: #{processing_time}sec  Response length: #{out.length}"   if log_messages
+
+              if response_required
+                response_exchange.publish(out.read(out.length),
+                                          :routing_key => properties.reply_to,
+                                          :correlation_id => properties.correlation_id,
+                                          :content_type => 'application/octet-stream' )
+              end
+            end
+
+          rescue ProcessingTimeout => ex
+            print_log "A timeout has occurred (#{process_timeout}sec) trying to call #{@queue_name}.#{properties.headers['operation']}"
+          end
+
+        else
+
+          print_log "Unable to process message content of type #{properties.content_type}. The message will be rejected"
+          @request_channel.reject(delivery_info.delivery_tag, false)
+
+        end
+
+        response_channel.close
+
+
+      end
+    end
+
+    private
+
+    def print_log(message="")
+      puts "#{Time.now.utc} S Thread: #{Thread.current.object_id} CID:#{Thread.current["correlation_id"]} - #{message}"
+
+    end
+  end
+end

data/lib/thrift/amqp/ruby/version.rb

@@ -0,0 +1,7 @@
+module Thrift
+  module Amqp
+    module Ruby
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/thrift/amqp/ruby.rb

@@ -0,0 +1,10 @@
+require "thrift/amqp/ruby/version"
+require "thrift/amqp/amqp_rpc_client"
+require "thrift/amqp/amqp_rpc_service"
+
+module Thrift
+  module Amqp
+    module Ruby
+    end
+  end
+end

data/thrift-amqp-ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thrift/amqp/ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "thrift-amqp-ruby"
+  spec.version       = Thrift::Amqp::Ruby::VERSION
+  spec.authors       = ["Alexis Montagne"]
+  spec.email         = ["alexis.montagne@gmail.com"]
+  spec.summary       = %q{Thrift transport layer over AMQP}
+  spec.description   = %q{Thrift transport layer over AMQP}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "bunny"
+  spec.add_dependency "thrift"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: thrift-amqp-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexis Montagne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Thrift transport layer over AMQP
+email:
+- alexis.montagne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thrift/amqp/amqp_rpc_client.rb
+- lib/thrift/amqp/amqp_rpc_service.rb
+- lib/thrift/amqp/ruby.rb
+- lib/thrift/amqp/ruby/version.rb
+- thrift-amqp-ruby.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.2.2
+signing_key: 
+specification_version: 4
+summary: Thrift transport layer over AMQP
+test_files: []