twingly-amqp 3.3.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b73b12f7ad3443cc1515288abad101ab00b0f987
-  data.tar.gz: b6394cd5f3b16025d196f4c67e579f59bf01867c
+  metadata.gz: 6219ee67359e165f827b9c944028390b4506a0e6
+  data.tar.gz: 83fedd73df0b32f0d9929001ca2bc431ab2149c3
 SHA512:
-  metadata.gz: a3a921f4a6a8f95184d00a08a33e7947aff1b9996619417f5f689553c7137026833b2a47ee301b1fd65ebe270582f3522f2c0c5aa498931276e2fe882952543b
-  data.tar.gz: 4221dee81f1da5e7237098506dbfeed96d5d5925908651c1becef5983ebada7d6e34d914df7234a579b4da19b0d672bb6d49b4ae629bc0979cb8790e95d8ad0b
+  metadata.gz: 2e923cc07303a09621892d0405093a247c4828c02060c585fa5a011b70321b14cd3adfa12560338d67c68d773cb214d2e2f876b9c0117fceb00a4d24979a76ef
+  data.tar.gz: ad3c376131f4309417d7d0292da8ca35347478469d390fc543ecbb72abcab06d78eddab1cc8a90d2daa6a0fa4dc1bbc16c3acca02faec34689fc991ad833c039

data/README.md

@@ -21,14 +21,14 @@ Or install it yourself as:
 
 Environment variables:
 
-* `RABBITMQ_N_HOST`
-* `AMQP_USERNAME`
-* `AMQP_PASSWORD`
-* `AMQP_TLS` # Use TLS connection if set
+* `RABBITMQ_N_HOST` - Defaults to `localhost`
+* `AMQP_USERNAME` - Defaults to `guest`
+* `AMQP_PASSWORD` - Defaults to `guest`
+* `AMQP_TLS` - Use TLS connection if set
 
 ### 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 `Ping`.
+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`.
 
 *Options set in `Connection.options=` take precedence over the options defined in `ENV`.*
 
@@ -59,9 +59,9 @@ subscription = Twingly::AMQP::Subscription.new(
 subscription.on_exception { |exception| puts "Oh noes! #{exception.message}" }
 subscription.before_handle_message { |raw_message_payload| puts raw_message }
 
-subscription.subscribe do |message| # An instance of Twingly::AMQP::Message
+subscription.each_message do |message| # An instance of Twingly::AMQP::Message
   begin
-    response = client.post(payload.fetch(:url))
+    response = client.post(message.payload.fetch(:url))
 
     case response.code
     when 200 then message.ack     # No error
@@ -78,29 +78,37 @@ end
 ### Ping urls
 
 ```ruby
-pinger = Twingly::AMQP::Ping.new(
-  provider_name: "a-provider-name",
+pinger = Twingly::AMQP::Pinger.new(
   queue_name:    "provider-ping",
-  priority:      1,
-  source_ip:     "?.?.?.?", # Optional, can be given to #ping
   url_cache:     url_cache, # Optional, see below
 )
 
+# Optional, options can also be given to #ping
+pinger.default_ping_options do |options|
+  options.provider_name = "TestProvider"
+  options.source_ip     = "?.?.?.?"
+  options.priority      = 1
+end
+
 urls = [
   "http://blog.twingly.com",
 ]
 
-pinger.ping(urls) do |pinged_url|
+# Optional, is merged with the default options above
+options = {
+  provider_name: "a-provider-name",
+  source_ip:     "?.?.?.?",
+  priority:      1,
+}
+
+pinger.ping(urls, options) do |pinged_url|
   # Optional block that gets called for each pinged url
 end
-
-# Send a ping using another source ip
-pinger.ping(urls, source_ip: "1.2.3.4")
 ```
 
 #### Url cache
 
-`Twingly::AMQP::Ping.new` can optionally take an url cache which caches the urls and only pings in the urls that isn't already cached. The cache needs to respond to the two following methods:
+`Twingly::AMQP::Pinger.new` can optionally take an url cache which caches the urls and only pings in the urls that isn't already cached. The cache needs to respond to the two following methods:
 
 ```ruby
 class UrlCache

data/lib/twingly/amqp.rb

@@ -1,8 +1,6 @@
 require "twingly/amqp/version"
-
-ENV["RUBY_ENV"] ||= "development"
-
 require "twingly/amqp/session"
 require "twingly/amqp/connection"
 require "twingly/amqp/subscription"
-require "twingly/amqp/ping"
+require "twingly/amqp/ping_options"
+require "twingly/amqp/pinger"

data/lib/twingly/amqp/connection.rb

@@ -1,5 +1,4 @@
 require "twingly/amqp/session"
-require "bunny"
 
 module Twingly
   module AMQP

data/lib/twingly/amqp/ping_options.rb

@@ -0,0 +1,39 @@
+module Twingly
+  module AMQP
+    class PingOptions
+      attr_accessor :provider_name, :source_ip, :priority
+
+      def initialize(provider_name: nil, source_ip: nil, priority: nil)
+        self.provider_name = provider_name
+        self.source_ip     = source_ip
+        self.priority      = priority
+
+        yield self if block_given?
+      end
+
+      def to_h
+        {
+          automatic_ping: false,
+          provider_name:  provider_name,
+          source_ip:      source_ip,
+          priority:       priority,
+        }
+      end
+
+      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}"
+        end
+      end
+
+      def merge(other)
+        PingOptions.new do |options|
+          options.provider_name = other.provider_name || provider_name
+          options.source_ip     = other.source_ip     || source_ip
+          options.priority      = other.priority      || priority
+        end
+      end
+    end
+  end
+end

data/lib/twingly/amqp/{ping.rb → pinger.rb}

@@ -1,22 +1,26 @@
 require "twingly/amqp/connection"
+require "twingly/amqp/ping_options"
 require "json"
 
 module Twingly
   module AMQP
-    class Ping
-      def initialize(provider_name:, queue_name:, priority:, source_ip: nil, url_cache: NullCache, connection: nil)
-        @url_cache = url_cache
-
-        @provider_name = provider_name
-        @queue_name    = queue_name
-        @source_ip     = source_ip
-        @priority      = priority
+    class Pinger
+      def initialize(queue_name:, url_cache: NullCache, connection: nil)
+        @queue_name = queue_name
+        @url_cache  = url_cache
 
         connection ||= Connection.instance
         @channel = connection.create_channel
+
+        @default_ping_options = PingOptions.new
       end
 
-      def ping(urls, options = {})
+      def ping(urls, options_hash = {})
+        options = PingOptions.new(options_hash)
+        options = @default_ping_options.merge(options)
+
+        options.validate
+
         Array(urls).each do |url|
           unless cached?(url)
             publish(url, options)
@@ -27,6 +31,10 @@ module Twingly
         end
       end
 
+      def default_ping_options
+        yield @default_ping_options
+      end
+
       private
 
       def publish(url, options)
@@ -43,16 +51,10 @@ module Twingly
       end
 
       def message(url, options)
-        source_ip = options.fetch(:source_ip) { @source_ip }
-        raise ArgumentError, ":source_ip not specified" unless source_ip
+        ping_message = options.to_h
+        ping_message[:url] = url
 
-        {
-          automatic_ping: false,
-          provider_name: @provider_name,
-          priority: @priority,
-          source_ip: source_ip,
-          url: url,
-        }
+        ping_message
       end
 
       def cached?(url)

data/lib/twingly/amqp/session.rb

@@ -1,8 +1,14 @@
+require "bunny"
+
 module Twingly
   module AMQP
     class Session
       attr_reader :connection, :options
 
+      DEFAULT_USER  = "guest"
+      DEFAULT_PASS  = "guest"
+      DEFAULT_HOSTS = ["localhost"]
+
       def initialize(options = {})
         @options    = options
         @connection = create_connection
@@ -11,11 +17,7 @@ module Twingly
       private
 
       def create_connection
-        if ruby_env == "development"
-          connection = Bunny.new
-        else
-          connection = Bunny.new(connection_options)
-        end
+        connection = Bunny.new(connection_options)
         connection.start
         connection
       end
@@ -34,26 +36,26 @@ module Twingly
         }
       end
 
-      def ruby_env
-        ENV.fetch("RUBY_ENV")
-      end
-
       def tls?
         ENV.has_key?("AMQP_TLS")
       end
 
       def user_from_env
-        ENV.fetch("AMQP_USERNAME")
+        ENV.fetch("AMQP_USERNAME") { DEFAULT_USER }
       end
 
       def password_from_env
-        ENV.fetch("AMQP_PASSWORD")
+        ENV.fetch("AMQP_PASSWORD") { DEFAULT_PASS }
       end
 
       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.map { |key| ENV[key] }
+        hosts = environment_keys_with_host.map { |key| ENV[key] }
+
+        return DEFAULT_HOSTS if hosts.empty?
+
+        hosts
       end
     end
   end

data/lib/twingly/amqp/subscription.rb

@@ -24,7 +24,7 @@ module Twingly
         @on_exception_callback          = Proc.new {}
       end
 
-      def subscribe(&block)
+      def each_message(&block)
         setup_traps
 
         consumer = @queue.subscribe(subscribe_options) do |delivery_info, metadata, payload|
@@ -45,7 +45,6 @@ module Twingly
           sleep 0.5
         end
 
-        puts "Shutting down" if development?
         consumer.cancel
       end
 
@@ -71,20 +70,11 @@ module Twingly
         channel = connection.create_channel(nil, @consumer_threads)
         channel.prefetch(@prefetch)
         channel.on_uncaught_exception do |exception, _|
-          puts exception.message, exception.backtrace if development?
           @on_exception_callback.call(exception)
         end
         channel
       end
 
-      def development?
-        ruby_env == "development"
-      end
-
-      def ruby_env
-        ENV.fetch("RUBY_ENV")
-      end
-
       def queue_options
         {
           durable: true,
@@ -99,7 +89,7 @@ module Twingly
       end
 
       def consumer_tag
-        tag_name = [Socket.gethostname, ruby_env].join('-')
+        tag_name = Socket.gethostname
         @channel.generate_consumer_tag(tag_name)
       end
 

data/lib/twingly/amqp/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   module Amqp
-    VERSION = "3.3.0"
+    VERSION = "4.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-amqp
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Twingly AB
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -63,7 +63,8 @@ files:
 - lib/twingly/amqp.rb
 - lib/twingly/amqp/connection.rb
 - lib/twingly/amqp/message.rb
-- lib/twingly/amqp/ping.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/version.rb
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Ruby library for talking to RabbitMQ