la_gear 1.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d34135664854b75f8889357557d68ad4b482515
+  data.tar.gz: 802e22ef6a102736e54b244fa5eb38d74028fd96
+SHA512:
+  metadata.gz: a229175adb0a558e1acf8d5f9864a2e0e73a39ce51f8764dfffb8293ff561a5d23b9bd011b015a03b84a279eb3abf4de9f4b6f7d8251843f002b0d92978e4e53
+  data.tar.gz: 429397c8f840c1a0f1e84f32c4fdaa7483a301d558f663415ab7069b7e27dcc6f5c4b406873bc2b8409c923eec3e661208c332c2240b4b369b08ff728df6427e

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/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Include:
+  Exclude:
+
+LineLength:
+  Max: 99
+
+Documentation:
+  Enabled: false
+
+GlobalVars:
+  AllowedVariables: [$publisher]

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gabriel Chaney
+
+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,84 @@
+# L.A. Gear
+
+This gem has two primary purposes:
+* Allowing you to define one worker class that has your [`sneakers`](https://github.com/jondot/sneakers) worker queue configuration and the [`sidekiq`](https://github.com/mperham/sidekiq) `perform` method that actually processes the message.
+* DRYing up your `sneakers` configuration by using a conventions.
+
+Here are some other features:
+* Messages are deserialized as JSON by default and the properties are passed to Sidekiq's `perform_async` method
+* Out-of-the-box configuration of `sneakers` for multiple RabbitMQ subscribers
+* An alternative to the `Sneakers::Publisher#publish` method that allows you to pass in more options when publishing to a RabbitMQ exchange
+* Helper methods for configuring `sneakers`
+* Support for configuring `sneakers` with [BigWig](http://bigwig.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'la_gear'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install la_gear
+
+## Usage
+
+Instead of `include Sneakers::Worker` in your workers, use `include LaGear::Worker`. Then all of your queues and routing key bindings will automatically use an `Sneakers::Config[:app_name]` plus the class name of your worker as your queue name and the class name of your worker as the routing key. For example,
+```
+Sneakers.configure app_name: 'pogs_are_awesome'
+
+class BoKnows
+  include LaGear::Worker
+  
+  def perform(baseball, football)
+    # ... message processing code ...
+  end
+end
+```
+would by default result in the following 2 queue names: `pogs_are_awesome.bo_knows` and `pogs_are_awesome.bo_knows.retry`. The default routing key would be: `bo_knows`. This allows for multiple consumer queue bindings for a direct exchange (see the Multiple Bindings section of https://www.rabbitmq.com/tutorials/tutorial-four-ruby.html). The `.retry` is for if you are using [dead letter exchanges](https://www.rabbitmq.com/dlx.html) and [message expirations](https://www.rabbitmq.com/ttl.html) to perform retries (which you should). Just call the `Sneakers::Worker#from_queue` method to override the convention-based defaults.
+
+Also, notice in the example above that we don't define a `work` method for `Sneakers::Worker`. That's because `LaGear::Worker` defines it for you. All the method does deserialize your RabbitMQ message (defaults to JSON) and pass each of the properties as a parameters to Sidekiq's `perform_async` method to process the message. Put your message processing code in a `perform` method instead. That's the method that Sidekiq invokes when it actual processes the message that `LaGear::Worker#work` sent to it.
+
+### The Bus
+
+There is also a `LaGear::Bus` class which is an alternative to the `Sneakers::Publisher`. It adds an `opts` parameter to the `publish` method, allowing you to pass the options you would pass to the `bunny` exchange publish [method](http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method) (see http://reference.rubybunny.info/Bunny/Exchange.html#publish-instance_method for the list of options).
+
+`LaGear::Bus` also has support for BigWig's [bi-endpoint]((https://devcenter.heroku.com/articles/rabbitmq-bigwig#provisioning-the-add-on)) configuration where they use one RabbitMQ endpoint for receiving and one for transmitting. Configure Sneaker with an `amqp` and `amqp_publish` to get this working. Or you can just use the `LaGear::SneakersConfigurer.configure_bi_amqp_endpoints` convience method. Here's an example for a Heroku app:
+```
+if ENV['RABBITMQ_BIGWIG_RX_URL'] && ENV['RABBITMQ_BIGWIG_TX_URL']
+  LaGear::SneakersConfigurer.configure_bi_amqp_endpoints(
+    ENV['RABBITMQ_BIGWIG_RX_URL'],
+    ENV['RABBITMQ_BIGWIG_TX_URL']
+  )
+end
+# else Sneakers/Bunny just uses the default RabbitMQ endpoint (amqp://localhost:15672)
+```
+
+The reason I call it a "bus" is because I want to end up adding bus-style semantic methods to it besides publish similar to the methods in NServiceBus's [`IBus`](https://github.com/Particular/NServiceBus/blob/develop/src/NServiceBus.Core/IBus.cs) (see also [`ISendOnlyBus`](https://github.com/Particular/NServiceBus/blob/develop/src/NServiceBus.Core/ISendOnlyBus.cs)).
+
+## Known Issues
+
+* For workers in a Rails 3.2 app I have, I had to explicilty include `Sneakers::Worker` and `Sidekiq::Worker` before `LaGear::Worker` because of an issue with it complaing that the `include` method was private in the Rails environment (see [here](https://github.com/gabrieljoelc/la_gear/blob/master/lib/la_gear/worker.rb#L6) for the current workaround). Here's what your workers should look like if this is happening to you:
+```
+class BoKnows
+  include Sneakers::Worker unless LaGear::Worker.sidekiq_proc?
+  include Sidekiq::Worker
+  include LaGear::Worker
+  
+  def perform(baseball, football)
+    # ... your worker code ...
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/la_gear/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/la_gear.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'la_gear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'la_gear'
+  spec.version       = LaGear::VERSION
+  spec.authors       = ['Gabriel Chaney']
+  spec.email         = ['gabriel.chaney@gmail.com']
+  spec.summary       = %q{A thin abstraction on-top-of [sneakers](https://github.com/jondot/sneakers) to DRY your workers. Pump it up!}
+  #spec.description   = %q{This gem allows you to DRY up your [sneakers](https://github.com/jondot/sneakers) workers by using a conventions-based configuration. It also includes a `LaGear::Bus` class that allows you to pass in more options when publishing to an exchange.}
+  spec.homepage      = 'https://github.com/giftcardzen/la_gear'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/).reject{|f| f == 'Gemfile.lock'}
+  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_dependency 'json', '~> 1.8'
+  spec.add_dependency 'bunny', '~> 1.6.3'
+  spec.add_dependency 'sneakers', '~> 1.0'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'sidekiq', '~> 3.3'
+  spec.add_dependency 'connection_pool', '~> 2.1'
+
+  spec.add_development_dependency 'rake', '~> 10.4'
+end

data/lib/la_gear/active_record/publish_triggerable.rb

@@ -0,0 +1,23 @@
+module LaGear
+  module ActiveRecord
+    module PublishTriggerable
+      def publish_after_commit(routing_key, opts)
+        publish_method = "publish_#{routing_key}"
+        define_method publish_method do
+          message = block_given? ? yield(self) : {}
+          Bus.publish(routing_key.to_s, message)
+        end
+        after_commit publish_method, opts
+      end
+
+      def send_after_commit(routing_key, opts)
+        publish_method = "publish_#{routing_key}"
+        define_method publish_method do
+          message = block_given? ? yield(self) : {}
+          Bus.publish_local(routing_key.to_s, message)
+        end
+        after_commit publish_method, opts
+      end
+    end
+  end
+end

data/lib/la_gear/active_record.rb

@@ -0,0 +1 @@
+require 'la_gear/active_record/publish_triggerable'

data/lib/la_gear/bus.rb

@@ -0,0 +1,50 @@
+module LaGear
+  module Bus
+    def init_pool(size = ::Sidekiq.options[:concurrency],
+                       timeout = 3)
+      $publisher = ConnectionPool.new(
+        size: size,
+        timeout: timeout
+      ) { ::LaGear::Publisher.new }
+
+      $publisher.with do |bus|
+        puts "Has the bus arrived? #{bus.send(:serialize, ❨╯°□°❩╯︵┻━┻: 'Calm down, bro')}"
+      end
+    end
+    module_function :init_pool
+
+    def publish(routing_key, msg, bunny_opts = {}, sidekiq_opts = {})
+      DelayablePublisher.sidekiq_delay(sidekiq_opts).publish(routing_key, msg, bunny_opts)
+    end
+    module_function :publish
+
+    def publish_in(interval, routing_key, msg, bunny_opts = {}, sidekiq_opts = {})
+      DelayablePublisher.sidekiq_delay_for(interval, sidekiq_opts).publish(routing_key, msg, bunny_opts)
+    end
+    module_function :publish_in
+
+    def publish_at(timestamp, routing_key, msg, bunny_opts = {}, sidekiq_opts = {})
+      DelayablePublisher.sidekiq_delay_until(timestamp, sidekiq_opts).publish(routing_key, msg, bunny_opts)
+    end
+    module_function :publish_at
+
+    def publish_local(routing_key, msg)
+      routing_key.classify.constantize.perform_async(*msg.values)
+    end
+    module_function :publish_local
+
+    private
+
+    class DelayablePublisher
+      def self.publish(routing_key, msg, opts = {})
+        if $publisher
+          $publisher.with do |publisher|
+            publisher.publish(routing_key, msg, opts)
+          end
+        else # this is what integration tests might use
+          LaGear::Publisher.new.publish(routing_key, msg, opts)
+        end
+      end
+    end
+  end
+end

data/lib/la_gear/engine.rb

@@ -0,0 +1,4 @@
+module LaGear
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/la_gear/publisher.rb

@@ -0,0 +1,39 @@
+module LaGear
+  class Publisher < ::Sneakers::Publisher
+    attr_accessor :exchange
+
+    def publish(routing_key, msg, opts = {})
+      @mutex.synchronize do
+        ensure_connection! unless connected?
+      end
+      opts.merge! routing_key: routing_key
+      serialized_msg = serialize(msg)
+      @exchange.publish(serialized_msg, opts)
+    end
+
+    protected
+
+    def serialize(msg)
+      JSON.generate(msg)
+    end
+
+    private
+
+    def ensure_connection!
+      opts = { heartbeat: @opts[:heartbeat] }
+      opts.merge!(vhost: @opts[:vhost]) if @opts[:vhost]
+      @bunny = Bunny.new(@opts[:amqp_publish] || @opts[:amqp], opts)
+      @bunny.start
+      @channel = @bunny.create_channel
+      @exchange = @channel.exchange(
+        @opts[:exchange],
+        type: @opts[:exchange_type],
+        durable: @opts[:durable]
+      )
+    end
+
+    def connected?
+      @bunny && @bunny.connected?
+    end
+  end
+end

data/lib/la_gear/sneakers_configurer.rb

@@ -0,0 +1,18 @@
+module LaGear
+  class SneakersConfigurer
+    class << self
+      def configure_bi_amqp_endpoints(rx_uri_str, tx_uri_str)
+        parser = UriParser.new(rx_uri_str)
+        Sneakers.configure(
+          amqp: parser.amqp,
+          vhost: parser.vhost
+        )
+        parser = UriParser.new(tx_uri_str)
+        Sneakers.configure(
+          amqp_publish: parser.amqp,
+          vhost_publish: parser.vhost
+        )
+      end
+    end
+  end
+end

data/lib/la_gear/uri_parser.rb

@@ -0,0 +1,15 @@
+module LaGear
+  class UriParser
+    def initialize(uri_str)
+      @uri = URI(uri_str)
+    end
+
+    def amqp
+      "#{@uri.scheme}://#{@uri.userinfo}@#{@uri.host}:#{@uri.port}"
+    end
+
+    def vhost
+      @uri.path.gsub!(/^\//, '')
+    end
+  end
+end

data/lib/la_gear/version.rb

@@ -0,0 +1,3 @@
+module LaGear
+  VERSION = '1.0.0-alpha.1'
+end

data/lib/la_gear/worker.rb

@@ -0,0 +1,69 @@
+module LaGear
+  module Worker
+    def self.included(base)
+      # for some reason, Rails is complaining about include being private so this
+      # include isn't working. Add include Sneakers::Worker to Rails workers for now...
+
+      if sidekiq_proc?
+        base.extend(DefaultClassMethods)
+      else
+        base.include(Sneakers::Worker) if base.respond_to?(:include)
+        base.extend(SneakersClassMethods)
+        Sneakers.logger.debug "#{}"
+        base.from_queue base.default_queue_name, base.default_queue_opts
+      end
+      base.include(::Sidekiq::Worker) if base.respond_to?(:include)
+    end
+
+    class << self
+      def sidekiq_proc?
+        $0.ends_with?('sidekiq')
+      end
+    end
+
+    module SneakersClassMethods
+      def default_queue_name
+        "#{Sneakers::Config.fetch(:app_name, 'sneakers_app').underscore}.#{routing_key}"
+      end
+
+      def default_queue_opts
+        {
+          routing_key: [routing_key, retry_routing_key],
+          arguments: default_queue_args,
+          handler_opts: {
+            routing_key: retry_routing_key
+          }
+        }
+      end
+
+      def routing_key
+        # TODO: the splitting is a semantic smell...
+        name.split('::').last.underscore
+      end
+
+      def retry_routing_key
+        "#{default_queue_name}.retry"
+      end
+
+      def default_queue_args
+        { 'x-dead-letter-exchange' => "#{Sneakers::Config.fetch(:exchange, 'sneakers').underscore}.retry" }
+      end
+    end
+
+    module DefaultClassMethods
+      def from_queue(_dummy_name, _dummy_opts); end
+
+      SneakersClassMethods.instance_methods(false).each { |m| define_method(m) { {} } }
+    end
+
+    def work(msg)
+      msg = deserialize(msg)
+      self.class.perform_async(*msg.values)
+      ack!
+    end
+
+    def deserialize(msg)
+      JSON.parse(msg)
+    end
+  end
+end

data/lib/la_gear.rb

@@ -0,0 +1,21 @@
+require 'la_gear/version'
+
+require 'json'
+require 'active_support/inflector'
+require 'bunny'
+
+require 'sneakers'
+require 'sneakers/worker'
+require 'la_gear/worker'
+require 'la_gear/publisher'
+require 'la_gear/bus'
+require 'la_gear/uri_parser'
+require 'la_gear/sneakers_configurer'
+
+module LaGear
+  module Rails
+    if defined? ::Rails::Engine
+      require 'la_gear/engine'
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: la_gear
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha.1
+platform: ruby
+authors:
+- Gabriel Chaney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: sneakers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: 
+email:
+- gabriel.chaney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- la_gear.gemspec
+- lib/la_gear.rb
+- lib/la_gear/active_record.rb
+- lib/la_gear/active_record/publish_triggerable.rb
+- lib/la_gear/bus.rb
+- lib/la_gear/engine.rb
+- lib/la_gear/publisher.rb
+- lib/la_gear/sneakers_configurer.rb
+- lib/la_gear/uri_parser.rb
+- lib/la_gear/version.rb
+- lib/la_gear/worker.rb
+homepage: https://github.com/giftcardzen/la_gear
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: A thin abstraction on-top-of [sneakers](https://github.com/jondot/sneakers)
+  to DRY your workers. Pump it up!
+test_files: []
+has_rdoc: