bluecollar-client 0.0.4

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,54 @@
+# Bluecollar::Client
+
+The `Bluecollar::Client` is a ruby interface to [bluecollar.core](https://github.com/techwhizbang/bluecollar).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bluecollar-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bluecollar-client
+
+## Usage
+
+`Bluecollar::Client` is intended to act as a ruby interface to `bluecollar.core`. It basically pushes job messages to Redis that are picked up and processed by `bluecollar.core`.
+
+In order to start using `Bluecollar::Client`:
+
+```ruby
+require "bluecollar-client"
+
+# to configure client
+Bluecollar::Client.configure(redis_key_prefix: "optional_prefix",
+                             redis_hostname: "hostname",
+                             redis_port: 6379,
+                             redis_db: 6,
+                             redis_timeout: 5000)
+
+# create async job
+Bluecollar::Client.instance.async_job_for(worker_name, args_hash)
+```
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+Copyright (c) 2013 Denny Quesada
+
+Distributed under the Eclipse Public License.
+http://www.eclipse.org/legal/epl-v10.html
+

data/Rakefile

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

data/bluecollar-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bluecollar-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bluecollar-client"
+  spec.version       = Bluecollar::VERSION
+  spec.authors       = ["Denny Quesada"]
+  spec.email         = ["denny.quesada@bookrenter.com"]
+  spec.description   = %q{Bluecollar client written in Ruby}
+  spec.summary       = %q{Bluecollar client written in Ruby}
+  spec.homepage      = ""
+  spec.license       = "EPL"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "redis"
+  spec.add_runtime_dependency %q<json>
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency %q<rspec>, ["~> 2.11.0"]
+  spec.add_development_dependency %q<pry>
+  spec.add_development_dependency %q<faker>
+end

data/lib/bluecollar-client/client.rb

@@ -0,0 +1,63 @@
+module Bluecollar
+  class Client
+
+    attr_accessor :redis_key_prefix, :redis_hostname, :redis_port, :redis_db, :redis_timeout
+
+    class << self
+
+      attr_reader :configuration, :logger, :instance
+
+      def configure(options = {})
+        @instance = nil
+
+        @logger = options[:logger] || Logger.new("/dev/null")
+
+        @configuration = {}
+        @configuration[:redis_key_prefix] = options[:redis_key_prefix] || "bluecollar"
+        @configuration[:redis_hostname] = options[:redis_hostname] || "127.0.0.1"
+        @configuration[:redis_port] = (options[:redis_port] || 6379).to_i
+        @configuration[:redis_db] = options[:redis_db].to_i
+        @configuration[:redis_timeout] = (options[:redis_timeout] || 5000).to_i
+      end
+
+      def instance
+        @instance ||= new(@configuration)
+      end
+    end
+
+    def async_job_for(worker_name, args)
+      redis_connection.lpush processing_queue, redis_payload(worker_name, args)
+    rescue Redis::BaseError => e
+      Bluecollar::Client.logger.warn("Error while adding #{worker_name}: #{args.inspect} to queue.\n#{e}:#{e.message}\nBacktrace:\n\t#{e.backtrace.join("\n\t")}")
+      raise Bluecollar::ClientError.new("Error while adding #{worker_name}: #{args.inspect} to queue.\n#{e}:#{e.message}\nBacktrace:\n\t#{e.backtrace.join("\n\t")}")
+    end
+
+    private
+
+    def initialize(options)
+      options.each { |k,v| send("#{k}=".to_sym, v) }
+    end
+
+    def redis_payload(worker_name, args)
+      raise ArgumentError.new("args must be an Array.") unless args.is_a? Array
+
+      begin
+        payload = { worker: worker_name, args: args }
+        JSON.dump(payload)
+      rescue
+        raise Bluecollar::ClientError.new("Error while creating JSON payload for #{worker_name}: #{args.inpsect}.\n#{e}:#{e.message}\nBacktrace:\n\t#{e.backtrace.join("\n\t")}")
+      end
+    end
+
+    def processing_queue
+      @processing_queue ||= "#{redis_key_prefix}:queues:master"
+    end
+
+    def redis_connection
+      @redis_connection ||= Redis.new(host: redis_hostname,
+                                      port: redis_port,
+                                      db: redis_db,
+                                      timeout: redis_timeout)
+    end
+  end
+end

data/lib/bluecollar-client/client_error.rb

@@ -0,0 +1,5 @@
+module Bluecollar
+  class ClientError < StandardError
+
+  end
+end

data/lib/bluecollar-client/version.rb

@@ -0,0 +1,3 @@
+module Bluecollar
+  VERSION = "0.0.4"
+end

data/lib/bluecollar-client.rb

@@ -0,0 +1,5 @@
+require 'logger'
+require 'json'
+require File.expand_path(File.dirname(__FILE__) + "/bluecollar-client/version")
+require File.expand_path(File.dirname(__FILE__) + "/bluecollar-client/client_error")
+require File.expand_path(File.dirname(__FILE__) + "/bluecollar-client/client")

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rspec'
+require 'redis'
+require 'rake'
+require 'time'
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/bluecollar-client")

data/spec/units/client_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+describe Bluecollar::Client do
+
+  before(:each) do
+    Bluecollar::Client.configure
+  end
+
+  describe ".initialize" do
+    context "with configuration data" do
+      before do
+        Bluecollar::Client.configure
+      end
+
+      subject { Bluecollar::Client.instance }
+
+      its(:redis_key_prefix) { should == "bluecollar" }
+      its(:redis_hostname) { should == "127.0.0.1" }
+      its(:redis_port) { should == 6379 }
+      its(:redis_db) { should == 0 }
+      its(:redis_timeout) { should == 5000 }
+    end
+
+    context "with configuration data" do
+      before do
+        Bluecollar::Client.configure(redis_key_prefix: "test_prefix",
+                                     redis_hostname: "test_hostname",
+                                     redis_port: 4567,
+                                     redis_db: 99,
+                                     redis_timeout: 1000)
+      end
+
+      subject { Bluecollar::Client.instance }
+
+      its(:redis_key_prefix) { should == "test_prefix" }
+      its(:redis_hostname) { should == "test_hostname" }
+      its(:redis_port) { should == 4567 }
+      its(:redis_db) { should == 99 }
+      its(:redis_timeout) { should == 1000 }
+    end
+  end
+
+  describe "#processing_queue" do
+
+    subject { Bluecollar::Client.instance.send(:processing_queue) }
+
+    context "when redis_key_prefix is set" do
+      before do
+        Bluecollar::Client.configure(redis_key_prefix: "test_prefix")
+      end
+
+      it { should == "test_prefix:queues:master" }
+    end
+
+    context "when no prefix is provided" do
+      it { should == "bluecollar:queues:master" }
+    end
+  end
+
+  describe "#redis_connection" do
+    subject { Bluecollar::Client.instance.send(:redis_connection) }
+
+    it { should be_a Redis }
+  end
+
+  describe "#redis_payload" do
+    context "with valid arguments" do
+      subject { JSON.parse Bluecollar::Client.instance.send(:redis_payload, 'lazy_worker', [{arg1:"first"}]) }
+
+      it "should have the expected worker" do
+        subject['worker'].should eq("lazy_worker")
+      end
+
+      it "should have the expected args" do
+        subject['args'].first['arg1'].should eq("first")
+      end
+    end
+
+    context "with a args argument that is not an Array" do
+      subject { JSON.parse Bluecollar::Client.instance.send(:redis_payload, 'lazy_worker', {arg1:"first"}) }
+
+      it "should raise an error" do
+        expect { subject }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#async_job_for" do
+    subject {  Bluecollar::Client.instance }
+
+    it "should push the data to the right queue" do
+      payload = subject.send(:redis_payload, 'lazy_worker', [{arg1:"first"}])
+      queue = subject.send :processing_queue
+      mock = double('redis')
+      Bluecollar::Client.any_instance.stub(:redis_connection){ mock }
+      mock.should_receive(:lpush).with(queue, payload)
+      subject.async_job_for('lazy_worker', [{arg1:"first"}])
+    end
+
+    context "when a BaseError is raised" do
+      before do
+        mock = double('redis')
+        Bluecollar::Client.any_instance.stub(:redis_connection){ mock }
+        mock.should_receive(:lpush) { raise Redis::BaseError.new("BaseError") }
+      end
+
+      subject { Bluecollar::Client.instance.async_job_for('lazy_worker', [{arg1:"first"}]) }
+
+      it "should raise an error" do
+        expect { subject }.to raise_error(Bluecollar::ClientError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: bluecollar-client
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Denny Quesada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bluecollar client written in Ruby
+email:
+- denny.quesada@bookrenter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bluecollar-client.gemspec
+- lib/bluecollar-client.rb
+- lib/bluecollar-client/client.rb
+- lib/bluecollar-client/client_error.rb
+- lib/bluecollar-client/version.rb
+- spec/spec_helper.rb
+- spec/units/client_spec.rb
+homepage: ''
+licenses:
+- EPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3735982979290534258
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3735982979290534258
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Bluecollar client written in Ruby
+test_files:
+- spec/spec_helper.rb
+- spec/units/client_spec.rb