delivery_boy 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd11867261e3297b893e7667d3f8d6e168d4aec6
-  data.tar.gz: 80c10735314ee3ff0b1c76de9d2e985cd695b4aa
+  metadata.gz: 10f4720cca90b30f0b80e5374d359d62ae97eef7
+  data.tar.gz: 443f2c3e7d0a1299115cf3dd8c49ebf1dd7c6cf3
 SHA512:
-  metadata.gz: 6ec6357a3d625fd8b5b393318e55285e05f0d4315385ca5734a422823ea13a261cc3a148c872cb69eb7fedb88085735acfdb3663c3f7271dca2b51d5dfe5a23e
-  data.tar.gz: 6d6f43c21d5c28bafe0b7c897084b74e11a75e41a9002d59d2c716ff3e868f95b55ad62d89a1961516176042d607017b30aff26e4b46838abef44c1be129755d
+  metadata.gz: 4f7e7d88d1f821f4aee82724852bf5218e335e8f46f8e8981ed8ed010deb40ed82cfab55c56eb3fc06099de9983f4e03c9279227745780c7ab1ef3bb1bfb7b44
+  data.tar.gz: e1d8ac3dfe2b11280ae372fc2cc5c1c36e03d2d0bf5a05458d86dd6752d5db3ff359826b25e909a86f9aee2a7c47321fb5e5639e2c6af3dd30ea792ae62292a4

data/README.md

@@ -59,9 +59,18 @@ end
 
 In addition to improving response time, delivering messages asynchronously also protects your application against Kafka availability issues -- if messages cannot be delivered, they'll be buffered for later and retried automatically.
 
+Both `deliver` and `deliver_async` take the following options:
+
+* `topic` – the Kafka topic that should be written to (required).
+* `key` – the key that should be set on the Kafka message (optional).
+* `partition` – a specific partition number that should be written to (optional).
+* `partition_key` – a string that can be used to deterministically select the partition that should be written to (optional).
+
+Regarding `partition` and `partition_key`: if none are specified, DeliveryBoy will pick a partition at random. If you want to ensure that e.g. all messages related to a user always get written to the same partition, you can pass the user id to `partition_key`. Don't use `partition` directly unless you know what you're doing, since it requires you to know exactly how many partitions each topic has, which can change and cause you pain and misery. Just use `partition_key` or let DeliveryBoy choose at random.
+
 ### Configuration
 
-You configure DeliveryBoy either through a config file or by setting environment variables.
+You configure DeliveryBoy in three different ways: in a YAML config file, in a Ruby config file, or by setting environment variables.
 
 If you're using Rails, the fastest way to get started is to execute the following in your terminal:
 
@@ -71,7 +80,16 @@ $ bundle exec rails generate delivery_boy:install
 
 This will create a config file at `config/delivery_boy.yml` with configurations for each of your Rails environments. Open that file in order to make changes.
 
-Note that for most configuration variables, you can pass in an environment variable. These environment variables all take the form `DELIVERY_BOY_X`, where `X` is the upper-case configuration variable name, e.g. `DELIVERY_BOY_CLIENT_ID`.
+Note that for all configuration variables, you can pass in an environment variable. These environment variables all take the form `DELIVERY_BOY_X`, where `X` is the upper-case configuration variable name, e.g. `DELIVERY_BOY_CLIENT_ID`.
+
+You can also configure DeliveryBoy in Ruby if you prefer that. By default, the file `config/delivery_boy.rb` is loaded if present, but you can do this from anywhere – just call `DeliveryBoy.configure` like so:
+
+```ruby
+DeliveryBoy.configure do |config|
+  config.client_id = "yolo"
+  # ...
+end
+```
 
 The following configuration variables can be set:
 

data/lib/delivery_boy.rb

@@ -74,6 +74,18 @@ module DeliveryBoy
       raise ConfigError, e.message
     end
 
+    # Configure DeliveryBoy in a block.
+    #
+    #     DeliveryBoy.configure do |config|
+    #       config.client_id = "yolo"
+    #     end
+    #
+    # @yield [DeliveryBoy::Config]
+    # @return [nil]
+    def configure
+      yield config
+    end
+
     def test_mode!
       @instance = testing
     end

data/lib/delivery_boy/railtie.rb

@@ -2,10 +2,13 @@ module DeliveryBoy
   class Railtie < Rails::Railtie
     initializer "delivery_boy.load_config" do
       config = DeliveryBoy.config
-      config_file = "config/delivery_boy.yml"
 
-      if File.exist?(config_file)
-        config.load_file(config_file, Rails.env)
+      if File.exist?("config/delivery_boy.yml")
+        config.load_file("config/delivery_boy.yml", Rails.env)
+      end
+
+      if File.exist?("config/delivery_boy.rb")
+        require "config/delivery_boy"
       end
 
       if config.datadog_enabled

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka