queuel 0.1.0 → 0.2.0

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    queuel (0.1.0)
+    queuel (0.2.0)
       mono_logger
+      multi_json
       thread
 
 GEM
@@ -11,6 +12,13 @@ GEM
     cane (2.5.2)
       parallel
     coderay (1.0.9)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     diff-lcs (1.2.4)
     ethon (0.5.12)
       ffi (>= 1.3.0)
@@ -46,7 +54,7 @@ GEM
     lumberjack (1.0.3)
     method_source (0.8.1)
     mime-types (1.23)
-    mono_logger (1.0.1)
+    mono_logger (1.1.0)
     multi_json (1.7.3)
     parallel (0.6.5)
     pry (0.9.12.2)
@@ -97,6 +105,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   cane
+  coveralls
   guard-bundler
   guard-cane
   guard-rspec

data/README.md

@@ -1,6 +1,8 @@
 # Queuel
 [![Gem Version](https://badge.fury.io/rb/queuel.png)](http://badge.fury.io/rb/queuel)
 [![Build Status](https://travis-ci.org/sportngin/queuel.png?branch=master)](https://travis-ci.org/sportngin/queuel)
+[![Code Climate](https://codeclimate.com/github/sportngin/queuel.png)](https://codeclimate.com/github/sportngin/queuel)
+[![Coverage Status](https://coveralls.io/repos/sportngin/queuel/badge.png)](https://coveralls.io/r/sportngin/queuel)
 
 Queuel is a kewl, lite wrapper around Queue interfaces. Currently it implements:
 
@@ -52,6 +54,13 @@ Queuel.configure do
   logger Logger # default: MonoLogger.new(STDOUT)
 
   log_level MonoLogger::DEBUG # default: MonoLogger::ERROR # => 3
+
+  # Incoming messages can be automatically encoded/decoded
+  decode_by_default false # default: true
+  decoder ->(body) { MultiJson.load body } # default: Queuel::Serialization::Json::Decoder
+
+  encode_by_default false # default: true
+  encoder ->(body) { body.to_s } # default: Queuel::Serialization::Json::Encoder
 end
 ```
 
@@ -88,15 +97,40 @@ end
 
 ```ruby
 message.id        # => ID of the message
-message.body      # => Message body
+message.raw_body  # => Raw Message body
+message.body      # => Message body (parsed, if configured to do so)
 message.delete    # => Delete the message
 ```
 
-## TODO
+#### Parsing
+
+Queuel uses [MultiJson](https://github.com/intridea/multi_json) to provide
+some auto-message decoding/encodeing features. With MultiJson you may install your own engine
+(like [Oj](https://github.com/ohler55/oj)).
+
+Because of the parsing given, you will default to encoding and decoding JSON:
+
+```ruby
+Queuel.push username: "jon"
+Queuel.pop # => { username: "jon" }
+```
+
+You can configure your decoder/encoder on the fly:
+
+```ruby
+Queuel.push { username: "jon" }, encoder: ->(body) {  }
+Queuel.pop decoder: ->(raw) { }
+Queuel.receive decoder: ->(raw) { }
+```
+
+You can turn of encoding/decoding at calltime with:
+
+```ruby
+Queuel.push { username: "jon" }, encode: false
+Queuel.pop decode: false
+Queuel.receive decode: false
+```
 
-* Implement AMQP
-* Configureable exponential back-off on `receive`
-* Provide a Daemon
 
 ## Contributing
 

data/lib/queuel.rb

@@ -1,5 +1,7 @@
 require "queuel/version"
 require "forwardable"
+require "queuel/core_ext/hash"
+require "queuel/serialization/json"
 require "queuel/configurator"
 require "queuel/introspect"
 
@@ -24,8 +26,15 @@ module Queuel
   extend Introspect
   class << self
     extend Forwardable
-    def_delegators :client, :push, :pop, :receive, :with
-    def_delegators :config, :credentials, :default_queue, :receiver_threads
+    def_delegators :client, :peek, :push, :pop, :receive, :with
+    def_delegators :config,
+      :credentials,
+      :default_queue,
+      :receiver_threads,
+      :decode_by_default?,
+      :decoder,
+      :encode_by_default?,
+      :encoder
     alias << pop
   end
 

data/lib/queuel/base/message.rb

@@ -1,16 +1,41 @@
+require 'forwardable'
 module Queuel
   module Base
     class Message
-      def initialize(message_object)
+      extend Forwardable
+      private
+      def_delegators :Queuel,
+        :decode_by_default?,
+        :encode_by_default?
+      attr_accessor :message_object
+      attr_accessor :options
+      attr_writer :id
+      attr_writer :queue
+
+      public
+
+      attr_reader :id
+      attr_writer :body
+      attr_accessor :raw_body
+      attr_reader :queue
+
+      # @argument message_object
+      # @argument options hash
+      def initialize(message_object = nil, options = {})
         self.message_object = message_object
+        self.options = options
       end
 
       def delete
         raise NotImplementedError, "must define method #delete"
       end
 
+      def body
+        @body || decoded_raw_body
+      end
+
       def empty?
-        body.to_s.empty?
+        raw_body.to_s.empty?
       end
       alias blank? empty?
 
@@ -18,15 +43,39 @@ module Queuel
         !empty?
       end
 
-      attr_reader :id
-      attr_reader :body
-      attr_reader :queue
-
       private
-      attr_accessor :message_object
-      attr_writer :id
-      attr_writer :body
-      attr_writer :queue
+
+      def decoder
+        options[:decoder] || Queuel.decoder
+      end
+
+      def encoder
+        options[:encoder] || Queuel.encoder
+      end
+
+      def encode?
+        options.fetch(:encode) { encode_by_default? }
+      end
+
+      def decode?
+        options.fetch(:decode) { decode_by_default? }
+      end
+
+      def decoded_raw_body
+        decode_body? ? decoder.call(raw_body) : raw_body
+      end
+
+      def encoded_body
+        encode_body? ? encoder.call(body) : body
+      end
+
+      def encode_body?
+        !@body.to_s.empty? && !encoder.nil? && encode?
+      end
+
+      def decode_body?
+        !decoder.nil? && decode? && raw_body.is_a?(String)
+      end
     end
   end
 end

data/lib/queuel/base/queue.rb

@@ -12,14 +12,15 @@ module Queuel
         raise NotImplementedError, "must implement #peek"
       end
 
-      def push(message)
+      def push(message, options = {})
         raise NotImplementedError, "must implement #push"
       end
 
       def pop(options = {}, &block)
-        bare_message = pop_bare_message(options)
+        message_options, engine_options = Queuel::Hash.new(options).partition { |(k,_)| message_option_keys.include? k.to_s }
+        bare_message = pop_bare_message(engine_options)
         unless bare_message.nil?
-          build_new_message(bare_message).tap { |message|
+          build_new_message(bare_message, message_options).tap { |message|
             if block_given? && message.present?
               message.delete if yield(message)
             end
@@ -35,6 +36,16 @@ module Queuel
       attr_accessor :client
       attr_accessor :name
 
+      def message_option_keys
+        %w[encode encoder decode decoder]
+      end
+
+      def build_push_message(message, options = {})
+        message_klass.new(nil, options).tap { |m|
+          m.body = message
+        }.raw_body
+      end
+
       def thread_count
         Queuel.receiver_threads || 1
       end
@@ -43,8 +54,8 @@ module Queuel
         raise NotImplementedError, "must implement bare Message getter"
       end
 
-      def build_new_message(bare_message)
-        message_klass.new(bare_message)
+      def build_new_message(bare_message, options = {})
+        message_klass.new(bare_message, options)
       end
 
       def message_klass

data/lib/queuel/client.rb

@@ -7,7 +7,7 @@ module Queuel
       self.given_queue = init_queue
     end
 
-    [:push, :pop, :receive].each do |operation|
+    [:peek, :push, :pop, :receive].each do |operation|
       define_method(operation) do |*args, &block|
         with_queue { queue_connection.public_send(operation, *args, &block) }
       end

data/lib/queuel/configurator.rb

@@ -9,11 +9,12 @@ module Queuel
       @option_values ||= {}
     end
 
-    def self.define_param_accessors(param_name)
+    def self.define_param_accessors(param_name, boolean = false)
       define_method param_name do |*values|
         value = values.first
         value ? self.send("#{param_name}=", value) : retrieve(param_name)
       end
+      define_method("#{param_name}?") { !!retrieve(param_name) } if boolean
       define_method "#{param_name}=" do |value|
         validate!(param_name, value) &&
           instance_variable_set("@#{param_name}", value)
@@ -42,7 +43,7 @@ module Queuel
     def self.param(param_name, options = {})
       attr_accessor param_name
       self.option_values[param_name] = options
-      define_param_accessors param_name
+      define_param_accessors param_name, options[:boolean]
       public param_name
       public "#{param_name}="
     end
@@ -53,6 +54,17 @@ module Queuel
     param :engine
     param :default_queue
     param :receiver_threads, default: 1
+
+    param :decode_by_default, default: true, boolean: true
+    param :decoder, default: Queuel::Serialization::Json::Decoder, validate: {
+      validator: ->(encoder) { encoder.respond_to?(:call) }
+    }
+
+    param :encode_by_default, default: true, boolean: true
+    param :encoder, default: Queuel::Serialization::Json::Encoder, validate: {
+      validator: ->(encoder) { encoder.respond_to?(:call) }
+    }
+
     param :logger, default: MonoLogger.new(STDOUT), validate: {
       message: "Logger must respond to #{%w[info warn debug level level]}",
       validator: ->(logger) {

data/lib/queuel/core_ext/hash.rb

@@ -0,0 +1,20 @@
+module Queuel
+  class Hash < ::Hash
+    def self.new(*args, &block)
+      if args.first.is_a?(::Hash)
+        allocate.send(:initialize).replace(args.first)
+      else
+        super *args, &block
+      end
+    end
+
+    def partition(&block)
+      if block_given?
+        one, two = super &block
+        [Hash[one], Hash[two]]
+      else
+        super &block
+      end
+    end
+  end
+end

data/lib/queuel/iron_mq/message.rb

@@ -1,11 +1,10 @@
-require 'forwardable'
 module Queuel
   module IronMq
     class Message < Base::Message
-      extend Forwardable
-
-      def body
-        @body || message_object && message_object.body
+      def raw_body
+        @raw_body ||
+          (message_object && message_object.body) ||
+          encoded_body
       end
 
       def delete

data/lib/queuel/iron_mq/queue.rb

@@ -12,8 +12,8 @@ module Queuel
       end
 
       # For IronMQ it should just be (message)
-      def push(message)
-        queue_connection.post message
+      def push(message, options = {})
+        queue_connection.post build_push_message(message, options)
       end
 
       private

data/lib/queuel/null/queue.rb

@@ -6,7 +6,7 @@ module Queuel
         []
       end
 
-      def push(message)
+      def push(message, options = {})
       end
 
       # Nullify

data/lib/queuel/serialization/json.rb

@@ -0,0 +1,37 @@
+require 'multi_json'
+module Queuel
+  module Serialization
+    module Json
+      SerializationError = Class.new StandardError
+      class Decoder
+        def self.call(body)
+          new(body).decode
+        end
+
+        def initialize(body)
+          @body = body.to_s
+        end
+
+        def decode
+          MultiJson.load @body, symbolize_keys: true
+        rescue MultiJson::LoadError
+          raise SerializationError, "Error reading:\n#{@body}"
+        end
+      end
+
+      class Encoder
+        def self.call(body)
+          new(body).encode
+        end
+
+        def initialize(body)
+          @body = body
+        end
+
+        def encode
+          MultiJson.dump @body
+        end
+      end
+    end
+  end
+end

data/lib/queuel/version.rb

@@ -1,3 +1,3 @@
 module Queuel
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/queuel.gemspec

@@ -32,7 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rb-fchange"
   spec.add_development_dependency "cane"
   spec.add_development_dependency "json", "~> 1.7.7"
+  spec.add_development_dependency "coveralls"
 
   spec.add_dependency "thread"
   spec.add_dependency "mono_logger"
+  spec.add_dependency "multi_json"
 end

data/spec/lib/queuel/iron_mq/message_spec.rb

@@ -5,12 +5,70 @@ module Queuel
       it_should_behave_like "a message"
       describe "initialization with Iron Object" do
         let(:queue_double) { double "Queue" }
-        let(:message_object) { double "IronMessage", id: 1, body: "body", queue: queue_double }
+        let(:body) { "body" }
+        let(:message_object) { double "IronMessage", id: 1, body: body, queue: queue_double }
         subject { described_class.new(message_object) }
 
+        before do
+          subject.stub decode_body?: false
+        end
+
         its(:id) { should == 1 }
         its(:body) { should == "body" }
         its(:queue) { should == queue_double }
+
+        describe "with json" do
+          let(:body) { '{"username":"jon"}' }
+          before do
+            subject.stub decode_body?: true
+          end
+
+          its(:body) { should == { username: "jon" } }
+          its(:raw_body) { should == body }
+        end
+      end
+
+      describe "using message for encoding" do
+        subject { described_class.new }
+
+        describe "setting the body" do
+          let(:hash_json) { { username: "jon" } }
+          let(:string_json) { '{"username":"jon"}' }
+
+          before do
+            subject.body = body
+          end
+
+          describe "valid json hash" do
+            let(:body) { hash_json }
+
+            its(:body) { should == hash_json }
+            its(:raw_body) { should == string_json }
+          end
+        end
+
+        describe "setting the raw body" do
+          let(:hash_json) { { username: "jon" } }
+          let(:string_json) { '{"username":"jon"}' }
+
+          before do
+            subject.raw_body = raw_body
+          end
+
+          describe "valid json string" do
+            let(:raw_body) { string_json }
+
+            its(:body) { should == hash_json }
+            its(:raw_body) { should == raw_body }
+          end
+
+          describe "valid json hash" do
+            let(:raw_body) { hash_json }
+
+            its(:body) { should == hash_json }
+            its(:raw_body) { should == raw_body }
+          end
+        end
       end
     end
   end

data/spec/lib/queuel/serialization/json_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+module Queuel
+  module Serialization
+    module Json
+      describe Decoder do
+        let(:body) { '{"name":"jon"}' }
+        subject { described_class.new body }
+
+        it "can call from the class" do
+          described_class.call(body).should == { name: "jon" }
+        end
+
+        it "can decode from instance" do
+          subject.decode.should == { name: "jon" }
+        end
+
+        describe "with bad body" do
+          let(:body) { '{"name":"jon"' }
+
+          it "fails on bad body" do
+            expect { subject.decode }.to raise_error SerializationError
+          end
+        end
+      end
+
+      describe Encoder do
+        let(:encoded_body) { '{"name":"jon"}' }
+        let(:body) { { "name" => "jon" } }
+        subject { described_class.new body }
+
+        it "can call from the class" do
+          described_class.call(body).should == encoded_body
+        end
+
+        it "can decode from instance" do
+          subject.encode.should == encoded_body
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+Coveralls.wear!
 require 'simplecov'
 SimpleCov.start do
   add_filter '/spec/'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queuel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -235,6 +235,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: thread
   requirement: !ruby/object:Gem::Requirement
@@ -267,6 +283,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_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'
 description: Light Queue wrapper tool
 email:
 - j.phenow@gmail.com
@@ -275,6 +307,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .cane
+- .coveralls.yml
 - .gitignore
 - .irbrc
 - .rspec
@@ -295,6 +328,7 @@ files:
 - lib/queuel/base/queue.rb
 - lib/queuel/client.rb
 - lib/queuel/configurator.rb
+- lib/queuel/core_ext/hash.rb
 - lib/queuel/introspect.rb
 - lib/queuel/iron_mq/engine.rb
 - lib/queuel/iron_mq/message.rb
@@ -304,6 +338,7 @@ files:
 - lib/queuel/null/message.rb
 - lib/queuel/null/poller.rb
 - lib/queuel/null/queue.rb
+- lib/queuel/serialization/json.rb
 - lib/queuel/version.rb
 - queuel.gemspec
 - spec/lib/queuel/base/queue_spec.rb
@@ -317,6 +352,7 @@ files:
 - spec/lib/queuel/null/message_spec.rb
 - spec/lib/queuel/null/poller_spec.rb
 - spec/lib/queuel/null/queue_spec.rb
+- spec/lib/queuel/serialization/json_spec.rb
 - spec/lib/queuel_spec.rb
 - spec/spec_helper.rb
 - spec/support/engine_shared_example.rb
@@ -339,7 +375,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 666822157956022088
+      hash: 3833538676296984811
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -348,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 666822157956022088
+      hash: 3833538676296984811
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -367,6 +403,7 @@ test_files:
 - spec/lib/queuel/null/message_spec.rb
 - spec/lib/queuel/null/poller_spec.rb
 - spec/lib/queuel/null/queue_spec.rb
+- spec/lib/queuel/serialization/json_spec.rb
 - spec/lib/queuel_spec.rb
 - spec/spec_helper.rb
 - spec/support/engine_shared_example.rb