sneakers_packer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eb01e938f800fb40861378799200f937c6742da
+  data.tar.gz: 82a8e039d1e3e3da2302e12e03e2ca183113c1b7
+SHA512:
+  metadata.gz: 2039e09ee76c8823f97b0b3fef012c56d3c74d6870b3b3afeb3b8134de5c38c97e21b4793707abe3c6ed010ab19781e56594e6e73ea1835133cf6b7132ae73c9
+  data.tar.gz: 2953841eb9bfc66421b30290ae2012e1c171446dadd942154809a8150b5cfbe6e06d2337d12b438d349a3f0e283fac957657c469009fdbbc84e74afaefe9e8c4

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.3
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vincent@boohee.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,134 @@
+# SneakersPacker
+
+SneakersPacker is a gem for using sneakers to 3 message communication patterns job message, broadcast and RPC(remote procedure call).
+
+## Installation
+
+Intall the `sneakers' gem first. see [sneakers](https://github.com/jondot/sneakers)
+
+Then add this line to your application's Gemfile:
+
+```ruby
+gem 'sneakers_packer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sneakers_packer
+
+## Usage
+
+### Configuation
+
+SneakersPacker uses most of sneakers configuration for simpleness.
+There are `app_name` and `rpc_timeout` should be set for SneakersPacker.
+
+Append below to `config/initializers/sneakers.rb`.
+
+```
+SneakersPacker.configure do |conf|
+  conf.rpc_timeout = 3             # rpc client timeout. default is 5 seconds.
+  conf.app_name = "sneakers_test"  # rpc client or server app's name. default is 'unknown'
+end
+```
+
+### API usage examples
+
+- Job Message
+
+**Client**
+
+`SneakersPacker.publish("demo", "hello world")`
+
+**Server**
+
+```ruby
+  class DemoWorker
+    include SneakersPacker::CommonWorker
+    from_queue :demo
+
+    def call(data)
+      puts "data is #{data}"
+      # do something...
+    end
+  end
+```
+
+- Broadcast
+
+**Client**
+
+It is same with Job Message
+
+`SneakersPacker.publish("demo.suprise", "hello world")`
+
+**Server**
+
+It is almost same with Job Message except that one routing_key with multiple queues.
+
+```ruby
+  class OneWorker
+    include SneakersPacker::CommonWorker
+
+    from_queue :one_name, routing_key: "demo.suprise"
+
+    def call(data)
+      puts "one: #{data}"
+      # do something...
+    end
+  end
+```
+
+```
+  class OtherWorker
+    include SneakersPacker::CommonWorker
+
+    from_queue :other_name, routing_key: "demo.suprise"
+
+    def call(data)
+      puts "other: #{data}"
+    end
+  end
+```
+
+- RPC
+
+**Client**
+
+remote call with default timeouit. default is 5 seconds.
+`SneakersPacker.remote_call("rpc_server", 10)`
+
+remote call with custom timeouit.
+`SneakersPacker.remote_call("rpc_server", 12, timeout: 2)`
+
+**Server**
+
+```ruby
+  class RpcServerWorker
+    include SneakersPacker::RpcWorker
+
+    from_queue :rpc_server
+
+    # return value of call will be result of remote procedure call
+    def call(data)
+      data.to_i ** 3
+    end
+  end
+```
+
+**See the gem doc or source code for accurate detail**
+
+## 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/xiewenwei/sneakers_packer. 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.
+

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 => :spec

data/bin/console

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

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/sneakers_packer/common_worker.rb

@@ -0,0 +1,21 @@
+module SneakersPacker
+  module CommonWorker
+    def self.included(klass)
+      klass.class_eval do
+        include ::Sneakers::Worker
+      end
+    end
+
+    def packer
+      SneakersPacker.message_packer
+    end
+
+    def work(message)
+      #puts "get #{message}"
+      request_data, from = packer.unpack_request message
+      #puts "call from #{from}"
+      call request_data
+      ack!
+    end
+  end
+end

data/lib/sneakers_packer/configuration.rb

@@ -0,0 +1,21 @@
+module SneakersPacker
+  class Configuration
+    attr_accessor :app_name, :rpc_timeout
+
+    # default timeout for remote call. unit is seconds
+    DEFAULT_RPC_TIMEOUT = 5
+
+    def initialize
+      @app_name = 'unknown'
+      @rpc_timeout = DEFAULT_RPC_TIMEOUT
+    end
+  end
+
+  def self.conf
+    @conf ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    block.call self.conf
+  end
+end

data/lib/sneakers_packer/message_packer.rb

@@ -0,0 +1,72 @@
+require 'socket'
+require 'multi_json'
+
+module SneakersPacker
+  class MessagePacker
+    attr_reader :app_name, :host_name
+
+    def initialize(app_name = nil)
+      @app_name = app_name || 'unknown'
+      @host_name = Socket.gethostname
+    end
+
+    # Pack request data with standart json format
+    # It should include from_info and data
+    #  @param data payload for request
+    #  @return [string] json string body
+    #  @example
+    #    param data = 12
+    #    return {"from" : "one boohee-tiger 6354", "data" : 12 }
+    #  @example
+    #    param data = ["ok", name: "vincent"]
+    #    return "{\"from\" : \"one boohee-tiger 6354\", \"data\" : [\"1\", {\"name\" : \"vincent\"}]}"
+
+    def pack_request(data)
+      MultiJson.dump "data" => data, "from" => from_info
+    end
+
+    # Unpack request data which is standart json format
+    # It should include status, message(optional) and data
+    # @param body response raw data
+    # @return hash
+    # @example
+    #   param message = "{\"from\":\"boohee\", \"data\":12}"
+    #   return array [12, "boohee"]
+
+    def unpack_request(message)
+      hash = unpack_message(message)
+      [hash["data"], hash["from"]]
+    end
+
+    def pack_response(data, status)
+      MultiJson.dump "data" => data, "from" => from_info, "status" => status
+    end
+
+    # Unpack response data which is standart json format
+    # It should include status, message(optional) and data
+    # @param body response raw data
+    # @return hash
+    # @example
+    #   param message = "{\"status\":200, \"data\":2}"
+    #   return array [2, 200]
+
+    def unpack_response(message)
+      hash = unpack_message(message)
+      [hash["data"], hash["from"], hash["status"]]
+    end
+
+    private
+
+    def from_info
+      "#{@app_name} #{@host_name} #{Process.pid}"
+    end
+
+    def pack_data(data)
+      MultiJson.dump data
+    end
+
+    def unpack_message(message)
+      MultiJson.load message
+    end
+  end
+end

data/lib/sneakers_packer/rpc_client.rb

@@ -0,0 +1,100 @@
+module SneakersPacker
+  class RpcClient
+
+    attr_reader :reply_queue
+    attr_accessor :response, :call_id
+    attr_reader :lock, :condition
+
+    def initialize(publisher)
+      @publisher = publisher
+      channel, exchange = fetch_channel_and_exchange
+      @consumer = build_reply_queue(channel, exchange)
+    end
+
+    # call remote service via rabbitmq rpc
+    # @param name route_key for service
+    # @param message
+    # @param options{timeout} [int] timeout. seconds.   optional
+    # @return result of service
+    # @raise RemoteCallTimeoutError if timeout
+    def call(name, message, options = {})
+      self.call_id = SecureRandom.uuid
+      self.response = nil
+
+      ensure_reply_queue!
+
+      @exchange.publish(message.to_s,
+                        routing_key:    name.to_s,
+                        correlation_id: call_id,
+                        reply_to:       @reply_queue.name)
+
+      timeout = (options[:timeout] || SneakersPacker.conf.rpc_timeout).to_i
+
+      lock.synchronize { condition.wait(lock, timeout) }
+
+      if response
+        response
+      else
+        raise RemoteCallTimeoutError.new("远程调用超时")
+      end
+    end
+
+    private
+
+    def ensure_reply_queue!
+      reconnected = false
+      channel = nil
+      exchange = nil
+
+      @publisher.instance_eval do
+        # ensure_connection connection first
+        @mutex.synchronize do
+          unless connected?
+            ensure_connection!
+            reconnected = true
+            channel = @channel
+            exchange = @exchange
+          end
+        end
+      end
+
+      # rebuid reply_queue when reconnecting occur
+      if reconnected
+        @consumer = build_reply_queue(channel, exchange)
+      end
+    end
+
+    def build_reply_queue(channel, exchange)
+      @channel, @exchange = channel, exchange
+
+      @reply_queue    = channel.queue("", exclusive: true)
+      @reply_queue.bind(exchange, routing_key: @reply_queue.name)
+
+      @lock      = Mutex.new
+      @condition = ConditionVariable.new
+      that       = self
+
+      @reply_queue.subscribe(manual_ack: false) do |delivery_info, properties, payload|
+        if properties[:correlation_id] == that.call_id
+          that.response = payload
+          that.lock.synchronize { that.condition.signal }
+        end
+      end
+    end
+
+    # hack seankers publisher to get channel and exchange
+    def fetch_channel_and_exchange
+      ret = nil
+
+      @publisher.instance_eval do
+        # ensure_connection connection first
+        @mutex.synchronize do
+          ensure_connection! unless connected?
+        end
+        ret = [@channel, @exchange]
+      end
+
+      ret
+    end
+  end
+end

data/lib/sneakers_packer/rpc_worker.rb

@@ -0,0 +1,32 @@
+module SneakersPacker
+  module RpcWorker
+    def self.included(klass)
+      klass.class_eval do
+        include ::Sneakers::Worker
+      end
+    end
+
+    def packer
+      SneakersPacker.message_packer
+    end
+
+    def work_with_params(message, delivery_info, metadata)
+      #puts "get #{message}"
+      request_data, from = packer.unpack_request message
+      #puts "call from #{from}"
+
+      #begin
+      response_data = call request_data
+      result = packer.pack_response response_data, 200
+      # rescue Exception => ex
+      #   # caught exeption
+      #   result = packer.pack_response nil, 500
+      # ensure
+      publish(result, to_queue: metadata.reply_to, correlation_id: metadata.correlation_id)
+
+      ack!
+      #end
+    end
+
+  end
+end

data/lib/sneakers_packer/version.rb

@@ -0,0 +1,3 @@
+module SneakersPacker
+  VERSION = "0.1.1"
+end

data/lib/sneakers_packer.rb

@@ -0,0 +1,44 @@
+require "sneakers"
+require "sneakers_packer/version"
+require "sneakers_packer/configuration"
+require "sneakers_packer/message_packer"
+require "sneakers_packer/common_worker"
+require "sneakers_packer/rpc_worker"
+require "sneakers_packer/rpc_client"
+
+module SneakersPacker
+  class RemoteCallTimeoutError < Exception; end
+
+  # sender message to sneaker exchange
+  # @param name route_key for message
+  # @param data
+  def self.publish(name, data)
+    message = message_packer.pack_request(data)
+
+    publisher.publish message, to_queue: name
+  end
+
+  # call remote service via rabbitmq rpc
+  # @param name route_key for service
+  # @param data
+  # @param options{timeout} [int] timeout. seconds.   optional
+  # @return result of service
+  # @raise RemoteCallTimeoutError if timeout
+  #
+  def self.remote_call(name, data, options = {})
+    @client ||= RpcClient.new(publisher)
+    message = message_packer.pack_request(data)
+    response = @client.call name, message, options
+    response_data, from, status = message_packer.unpack_response(response)
+    response_data
+  end
+
+  def self.publisher
+    @publisher ||= ::Sneakers::Publisher.new
+  end
+
+  # message_packer is a singleton object
+  def self.message_packer
+    @message_packer ||= MessagePacker.new(self.conf.app_name)
+  end
+end

data/sneakers_packer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sneakers_packer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sneakers_packer"
+  spec.version       = SneakersPacker::VERSION
+  spec.authors       = ["vincent"]
+  spec.email         = ["vincent@boohee.com"]
+
+  spec.summary       = %q{SneakersPacker is a gem for using sneakers to 3 message communication patterns job message, broadcast and RPC(remote procedure call).}
+  spec.description   = %q{SneakersPacker is a gem for using sneakers to 3 message communication patterns job message, broadcast and RPC(remote procedure call).}
+  spec.homepage      = "https://github.com/xiewenwei/sneakers_packer"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sneakers", "~> 2.3.5"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: sneakers_packer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- vincent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sneakers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: mocha
+  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'
+description: SneakersPacker is a gem for using sneakers to 3 message communication
+  patterns job message, broadcast and RPC(remote procedure call).
+email:
+- vincent@boohee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sneakers_packer.rb
+- lib/sneakers_packer/common_worker.rb
+- lib/sneakers_packer/configuration.rb
+- lib/sneakers_packer/message_packer.rb
+- lib/sneakers_packer/rpc_client.rb
+- lib/sneakers_packer/rpc_worker.rb
+- lib/sneakers_packer/version.rb
+- sneakers_packer.gemspec
+homepage: https://github.com/xiewenwei/sneakers_packer
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: SneakersPacker is a gem for using sneakers to 3 message communication patterns
+  job message, broadcast and RPC(remote procedure call).
+test_files: []