twingly-amqp 4.1.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb13b028753ea6a081b6612e3789ce6cf0e11616
-  data.tar.gz: d608291e7ff250cb09bb8c2da98b54d1d59b6d9f
+  metadata.gz: 858c1c7b49f3bbd776a0aa0af9f070d1c40f31f9
+  data.tar.gz: ee5ee54beff37137f74fe60d0d4e60dc0db4e893
 SHA512:
-  metadata.gz: 816f2a4b903a88525fc607436dd90e0f7783ed613d6d555fc76f90028004d65d0ed32c136cf31023f4189fed8f4a35a397c98b5df0ffb5337da6247dcb206d99
-  data.tar.gz: 1b9c9972ebbdf224e8a77a3a4bfb3495344f0005fd100f60ef1490d66adcbe7dfc7b1601055256fb4ddbb9dcb442ea1b8bf3a7932f8fb88bb0b7ba150957540e
+  metadata.gz: ecc06c04e469767a9f9a521989f3ae8f85aec7b18da877f255bda9a12db90575e7d4b5f427624f6d5b7f3e7d94047a6e8ce30c007f14c82f0033341d00c2e12c
+  data.tar.gz: dcf7197d39bdff607daaa44957bb817a4a4f983a697949723051376ac4345595356b0c2b48d25081ae05942948ed8b408df0ee9645e00c7354301ad87af15c18

data/README.md

@@ -26,21 +26,26 @@ Environment variables:
 * `AMQP_PASSWORD` - Defaults to `guest`
 * `AMQP_TLS` - Use TLS connection if set
 
+There are some usage examples in [examples/](examples/).
+
 ### Customize options
 
-If you don't have the RabbitMQ hosts, user or password in your ENV you can set them with `Twingly::AMQP::Connection.options=` before you create an instance of `Subscription` or `Pinger`.
+If you don't have the RabbitMQ hosts, user or password in your ENV you can set them via the configuration block `Twingly::AMQP.configure`, see example below, before you create an instance of `Subscription` or `Pinger`. All options are sent to `Bunny.new`, see the [documentation][ruby-bunny] for all available options.
 
-*Options set in `Connection.options=` take precedence over the options defined in `ENV`.*
+*Options set via `configure.connection_options` take precedence over the options defined in `ENV`.*
 
-All options are sent to `Bunny.new`, see the [documentation][ruby-bunny] for all available options.
+In addition to `connection_options` you may also configure an error logger via `logger`:
 
 ```ruby
-Twingly::AMQP::Connection.options = {
-  hosts: %w(localhost),
-  user: "a-user",
-  pass: "1234",
-  # ...
-}
+Twingly::AMQP.configure do |config|
+  config.logger = Logger.new(STDOUT)
+  config.connection_options = {
+    hosts: %w(localhost),
+    user: "a-user",
+    pass: "1234",
+    # ...
+  }
+end
 ```
 
 [ruby-bunny]: http://rubybunny.info/articles/connecting.html
@@ -75,6 +80,45 @@ subscription.each_message do |message| # An instance of Twingly::AMQP::Message
 end
 ```
 
+### Publish to a queue on the default exchange
+
+```ruby
+publisher = Twingly::AMQP::DefaultExchangePublisher.new(queue_name: "my_queue")
+
+publisher.configure_publish_options do |options|
+  options.content_type = "application/json" # Default
+  options.persistent   = true               # Default
+  options.expiration   = 1000
+  options.priority     = 1
+end
+
+publisher.publish({ my: "data" })
+```
+
+### Publish to a topic exchange
+
+```ruby
+# passed to Bunny::Channel#topic
+exchange_options = {
+  durable: true,
+}
+
+publisher = Twingly::AMQP::TopicExchangePublisher.new(
+  exchange_name: "my_exchange",
+  routing_key:   "my_key",         # Optional
+  opts:          exchange_options, # Optional
+)
+
+publisher.configure_publish_options do |options|
+  options.content_type = "application/json" # Default
+  options.persistent   = true               # Default
+  options.expiration   = 1000
+  options.priority     = 1
+end
+
+publisher.publish({ my: "data" })
+```
+
 ### Ping urls
 
 ```ruby
@@ -124,9 +168,18 @@ class UrlCache
 end
 ```
 
+### Connection instance
+
+It's possible to get ahold of the current connection, or create a new if no session has been established yet, which may be useful when needing to do things currently not abstracted by the gem.
+
+```ruby
+connection = Twingly::AMQP::Connection.instance
+# connection is a Bunny::Session
+```
+
 ## Tests
 
-The tests require a local RabbitMQ server to run.
+The integration tests run by default and require a local RabbitMQ server to run.
 
 Run tests with
 
@@ -134,12 +187,33 @@ Run tests with
 bundle exec rake
 ```
 
+Run just the unit tests with
+
+```shell
+bundle exec rake spec:unit
+```
+
+### RuboCop
+
+To run static code analysis:
+
+  bundle exec rubocop
+
+  # optionally on single file(s)
+  bundle exec rubocop lib/twingly/amqp/*
+
 ## Release workflow
 
-**Note**: Make sure you are logged in as [twingly][twingly-rubygems] at RubyGems.org.
+* Bump the version in `lib/twingly/amqp/version.rb` in a commit, no need to push (the release task does that).
+
+* Build and [publish](http://guides.rubygems.org/publishing/) the gem. This will create the proper tag in git, push the commit and tag and upload to RubyGems.
+
+        bundle exec rake release
+
+    * If you are not logged in as [twingly][twingly-rubygems] with ruby gems, the rake task will fail and tell you to set credentials via `gem push`, do that and run the `release` task again. It will be okay.
 
-Build and [publish](http://guides.rubygems.org/publishing/) the gem.
+* Update the changelog with [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/) (`gem install github_changelog_generator` if you don't have it, set `CHANGELOG_GITHUB_TOKEN` to a personal access token to avoid rate limiting by GitHub). This command will update `CHANGELOG.md`, commit and push manually.
 
-    bundle exec rake release
+        github_changelog_generator -u twingly -p twingly-amqp
 
 [twingly-rubygems]: https://rubygems.org/profiles/twingly

data/lib/twingly/amqp/connection.rb

@@ -1,4 +1,4 @@
-require "twingly/amqp/session"
+require "twingly/amqp"
 
 module Twingly
   module AMQP
@@ -7,17 +7,22 @@ module Twingly
 
       @@lock     = Mutex.new
       @@instance = nil
-      @@options  = {}
 
       def self.options=(options)
-        @@options = options
+        warn "[DEPRECATION] `options=` is deprecated. " \
+          "Please use configuration block: `Twingly::AMQP.configure` instead."
+
+        Twingly::AMQP.configure do |config|
+          config.connection_options = options
+        end
       end
 
       def self.instance
         return @@instance if @@instance
         @@lock.synchronize do
           return @@instance if @@instance
-          @@instance = Session.new(@@options).connection
+          options = Twingly::AMQP.configuration.connection_options
+          @@instance = Session.new(options).connection
         end
       end
     end

data/lib/twingly/amqp/default_exchange_publisher.rb

@@ -0,0 +1,48 @@
+require "twingly/amqp/connection"
+require "json"
+require "ostruct"
+
+module Twingly
+  module AMQP
+    class DefaultExchangePublisher
+      def initialize(queue_name:, connection: nil)
+        options.routing_key = queue_name
+
+        connection ||= Connection.instance
+        @exchange = connection.create_channel.default_exchange
+      end
+
+      def publish(message)
+        raise ArgumentError unless message.respond_to?(:to_h)
+
+        payload = message.to_h.to_json
+        opts    = options.to_h
+        @exchange.publish(payload, opts)
+      end
+
+      # only used by tests to avoid sleeping
+      def publish_with_confirm(message)
+        channel = @exchange.channel
+        channel.confirm_select unless channel.using_publisher_confirmations?
+
+        publish(message)
+
+        @exchange.wait_for_confirms
+      end
+
+      def configure_publish_options
+        yield options
+      end
+
+      private
+
+      def options
+        @options ||=
+          OpenStruct.new(
+            content_type: "application/json",
+            persistent: true,
+          )
+      end
+    end
+  end
+end

data/lib/twingly/amqp/null_logger.rb

@@ -0,0 +1,15 @@
+module Twingly
+  module AMQP
+    class NullLogger
+      def debug(*); end
+
+      def info(*); end
+
+      def warn(*); end
+
+      def error(*); end
+
+      def fatal(*); end
+    end
+  end
+end

data/lib/twingly/amqp/ping_options.rb

@@ -23,7 +23,7 @@ module Twingly
       def validate
         missing_keys = to_h.select { |_, value| value.to_s.empty? }.keys
         if missing_keys.any?
-          fail ArgumentError, "Required options not set: #{missing_keys}"
+          raise ArgumentError, "Required options not set: #{missing_keys}"
         end
       end
 

data/lib/twingly/amqp/pinger.rb

@@ -1,19 +1,22 @@
 require "twingly/amqp/connection"
 require "twingly/amqp/ping_options"
+require "twingly/amqp/default_exchange_publisher"
 require "json"
 
 module Twingly
   module AMQP
     class Pinger
-      def initialize(queue_name:, ping_expiration: nil, url_cache: NullCache, connection: nil)
-        @queue_name = queue_name
-        @url_cache  = url_cache
-
+      def initialize(queue_name:, ping_expiration: nil, url_cache: NullCache, connection: nil, confirm_publish: false)
+        @url_cache = url_cache
         connection ||= Connection.instance
-        @channel = connection.create_channel
 
-        @ping_expiration      = ping_expiration
+        @publisher = DefaultExchangePublisher.new(queue_name: queue_name, connection: connection)
+        @publisher.configure_publish_options do |options|
+          options.expiration = ping_expiration
+        end
+
         @default_ping_options = PingOptions.new
+        @confirm_publish = confirm_publish
       end
 
       def ping(urls, options_hash = {})
@@ -39,17 +42,13 @@ module Twingly
       private
 
       def publish(url, options)
-        payload = message(url, options).to_json
-        @channel.default_exchange.publish(payload, amqp_publish_options)
-      end
+        payload = message(url, options)
 
-      def amqp_publish_options
-        {
-          key: @queue_name,
-          persistent: true,
-          content_type: "application/json",
-          expiration: @ping_expiration,
-        }
+        if @confirm_publish
+          @publisher.publish_with_confirm(payload)
+        else
+          @publisher.publish(payload)
+        end
       end
 
       def message(url, options)

data/lib/twingly/amqp/session.rb

@@ -5,9 +5,9 @@ module Twingly
     class Session
       attr_reader :connection, :options
 
-      DEFAULT_USER  = "guest"
-      DEFAULT_PASS  = "guest"
-      DEFAULT_HOSTS = ["localhost"]
+      DEFAULT_USER  = "guest".freeze
+      DEFAULT_PASS  = "guest".freeze
+      DEFAULT_HOSTS = ["localhost"].freeze
 
       def initialize(options = {})
         @options    = options
@@ -27,6 +27,10 @@ module Twingly
         options[:pass]  ||= password_from_env
         options[:hosts] ||= hosts_from_env
 
+        # Used as a workaround for
+        # https://github.com/ruby-amqp/bunny/issues/446
+        options[:hosts] = options.fetch(:hosts).dup
+
         default_connection_options.merge(options)
       end
 
@@ -37,7 +41,7 @@ module Twingly
       end
 
       def tls?
-        ENV.has_key?("AMQP_TLS")
+        ENV.key?("AMQP_TLS")
       end
 
       def user_from_env
@@ -50,7 +54,9 @@ module Twingly
 
       def hosts_from_env
         # Matches env keys like `RABBITMQ_01_HOST`
-        environment_keys_with_host = ENV.keys.select { |key| key =~ /^rabbitmq_\d+_host$/i }
+        environment_keys_with_host = ENV.keys.select do |key|
+          key =~ /^rabbitmq_\d+_host$/i
+        end
         hosts = environment_keys_with_host.map { |key| ENV[key] }
 
         return DEFAULT_HOSTS if hosts.empty?

data/lib/twingly/amqp/subscription.rb

@@ -20,8 +20,8 @@ module Twingly
           @queue.bind(exchange, routing_key: @routing_key)
         end
 
-        @before_handle_message_callback = Proc.new {}
-        @on_exception_callback          = Proc.new {}
+        @before_handle_message_callback = proc {}
+        @on_exception_callback          = proc {}
       end
 
       def each_message(&block)
@@ -41,9 +41,7 @@ module Twingly
         end
 
         # The consumer isn't blocking, so we wait here
-        until cancel? do
-          sleep 0.5
-        end
+        sleep 0.5 until cancel?
 
         consumer.cancel
       end
@@ -70,6 +68,7 @@ module Twingly
         channel = connection.create_channel(nil, @consumer_threads)
         channel.prefetch(@prefetch)
         channel.on_uncaught_exception do |exception, _|
+          Twingly::AMQP.configuration.logger.error(exception)
           @on_exception_callback.call(exception)
         end
         channel

data/lib/twingly/amqp/topic_exchange_publisher.rb

@@ -0,0 +1,48 @@
+require "twingly/amqp/connection"
+require "json"
+require "ostruct"
+
+module Twingly
+  module AMQP
+    class TopicExchangePublisher
+      def initialize(exchange_name:, routing_key: nil, connection: nil, opts: {})
+        options.routing_key = routing_key
+
+        connection ||= Connection.instance
+        @exchange = connection.create_channel.topic(exchange_name, opts)
+      end
+
+      def publish(message)
+        raise ArgumentError unless message.respond_to?(:to_h)
+
+        payload = message.to_h.to_json
+        opts    = options.to_h
+        @exchange.publish(payload, opts)
+      end
+
+      # only used by tests to avoid sleeping
+      def publish_with_confirm(message)
+        channel = @exchange.channel
+        channel.confirm_select unless channel.using_publisher_confirmations?
+
+        publish(message)
+
+        @exchange.wait_for_confirms
+      end
+
+      def configure_publish_options
+        yield options
+      end
+
+      private
+
+      def options
+        @options ||=
+          OpenStruct.new(
+            content_type: "application/json",
+            persistent: true,
+          )
+      end
+    end
+  end
+end

data/lib/twingly/amqp/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Amqp
-    VERSION = "4.1.0"
+    VERSION = "4.2.1".freeze
   end
 end

data/lib/twingly/amqp.rb

@@ -4,3 +4,28 @@ require "twingly/amqp/connection"
 require "twingly/amqp/subscription"
 require "twingly/amqp/ping_options"
 require "twingly/amqp/pinger"
+require "twingly/amqp/default_exchange_publisher"
+require "twingly/amqp/topic_exchange_publisher"
+require "twingly/amqp/null_logger"
+
+require "ostruct"
+
+module Twingly
+  module AMQP
+    class << self
+      attr_writer :configuration
+    end
+
+    def self.configuration
+      @configuration ||=
+        OpenStruct.new(
+          logger: NullLogger.new,
+          connection_options: {},
+        )
+    end
+
+    def self.configure
+      yield configuration
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-amqp
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Publish and subscribe to messages via RabbitMQ
 email:
 - support@twingly.com
@@ -62,11 +76,14 @@ files:
 - README.md
 - lib/twingly/amqp.rb
 - lib/twingly/amqp/connection.rb
+- lib/twingly/amqp/default_exchange_publisher.rb
 - lib/twingly/amqp/message.rb
+- lib/twingly/amqp/null_logger.rb
 - lib/twingly/amqp/ping_options.rb
 - lib/twingly/amqp/pinger.rb
 - lib/twingly/amqp/session.rb
 - lib/twingly/amqp/subscription.rb
+- lib/twingly/amqp/topic_exchange_publisher.rb
 - lib/twingly/amqp/version.rb
 homepage: https://github.com/twingly/twingly-amqp
 licenses: []
@@ -87,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby library for talking to RabbitMQ