megaphone-client 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c576c3f15678249216b1f429627540da6a460a7
-  data.tar.gz: 30d95da0710f722658bc57e1577b0134bbf3c546
+  metadata.gz: ea3788fe007c5771e476cbc5adfde59a540f4f43
+  data.tar.gz: c3e00fbf0225d7c439684c84da295af81f5ab51e
 SHA512:
-  metadata.gz: 503ccc117d9a16f0717db386ef47a02ab51fd44eaaca158d4f5d8cf7929c64926d715a07e4fb0562898d088d6178f1ed9452c5aba7059f70d435c8890e8dd5c2
-  data.tar.gz: 786ad699334f6222eb70a9efd1bf1fb350683812a07121d1ffc75286cd44ff72c496ba5de66aeb85896f9d13e2914f744facbbb083c4dadc56a2031d17c996dc
+  metadata.gz: 1ed95ea4cee223e4f658badb1f29e99f7ae82610359fba6489d5cdbe656cd2f52b1c82a019dd1f5d60f8bf08b088b3add9c38f9c36fef52c876f7a2d40e80e65
+  data.tar.gz: a2aaa416a658986540e7e1d6062c971101287c6913e91840bb0a8e735bc97779ed9094486cab054b7e3440d40035a88709ddb54762660a82ca805efceec7d770

data/CHANGELOG.md

@@ -3,10 +3,13 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and
-this project versions are for now mere release numbers. They don't have any particular meaning.
+this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## [1.0.0] - 2017-08-18
 
+### Changed
+
+- The `Megaphone::Client` API is now stable!
 
 ## [0.3.0] - 2017-08-17
 
@@ -38,5 +41,6 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 - Initial implementation of the `Megaphone::Client.publish!` method
 
+  [1.0.0]: https://github.com/redbubble/megaphone-client-ruby/compare/v0.1.2...v1.0.0
   [0.1.2]: https://github.com/redbubble/megaphone-client-ruby/compare/v0.1.1...v0.1.2
   [0.1.1]: https://github.com/redbubble/megaphone-client-ruby/compare/v0.1.0...v0.1.1

data/README.md

@@ -2,6 +2,7 @@ Megaphone::Client
 =================
 
 [![Build Status](https://badge.buildkite.com/9f4fdb370f5f295ee6bf3d68937b1be2d7cf9bf65b2c7b4213.svg?branch=master)](https://buildkite.com/redbubble/megaphone-client-ruby)
+[![Gem Version](https://badge.fury.io/rb/megaphone-client.svg)](https://badge.fury.io/rb/megaphone-client)
 
 Send events to Megaphone.
 
@@ -13,24 +14,45 @@ Add the gem to your `Gemfile`:
 ```ruby
 # Gemfile
 
-gem 'megaphone-client', '~> 0.3.0'
+gem 'megaphone-client', '~> 1.0' # see semver.org
 ```
 
 Usage
 -----
-The client will append events to local files unless the fluentd host and port values are passed as arguments to the client's constructor or the `MEGAPHONE_FLUENT_HOST` and `MEGAPHONE_FLUENT_PORT` environment variables are set.
 
-To publish an event on Megaphone
-```ruby
-event_bus = Megaphone::Client.new({ origin: 'my-awesome-service', host: 'localhost', port: '24224' })
+In order to be as unobstrusive as possible, this client will append events to local files (e.g. `./work-updates.stream`) unless:
+
+- the `MEGAPHONE_FLUENT_HOST` and `MEGAPHONE_FLUENT_PORT` environment variables are set.
+- **or** the Fluentd host and port values are passed as arguments to the client's constructor
+
+That behaviour ensures that unless you want to send events to the Megaphone [streams][stream], you do not need to [start Fluentd][megaphone-fluentd] at all.
+
+  [stream]: https://github.com/redbubble/com/megaphone#stream
+  [megaphone-fluentd]: https://github.com/redbubble/megaphone-fluentd-container
 
-topic = :page_changes
-subtopic = :product_pages
-schema = 'http://www.github.com/redbuble/megaphone-event-type-registry/topics/cats'
-partition_key = '1357924680'
-payload = { url: 'https://www.redbubble.com/people/wytrab8/works/26039653-toadally-rad?grid_pos=1&p=mens-graphic-t-shirt&rbs=29c497ad-a976-42b8-aa40-0e218903c558&ref=shop_grid&style=mens' }
+### Publishing events
 
-event_bus.publish!(topic, subtopic, schema, partition_key, payload)
+1. Start Fluentd, the easiest way to do so is using a [`redbubble/megaphone-fluentd`][megaphone-fluentd] container
+
+1. Create your event and publish it:
+
+```ruby
+# Configure a Megaphone client for your awesome service
+client = Megaphone::Client.new({
+  origin: 'my-awesome-service',
+  host: 'localhost',
+  port: '24224'
+})
+
+# Create an event
+topic = 'work-updates'
+subtopic = 'work-metadata-updated'
+schema = 'https://github.com/redbubble/megaphone-event-type-registry/blob/master/streams/work-updates-schema-1.0.0.json'
+partition_key = '1357924680' # the Work ID in this case
+payload = { url: 'https://www.redbubble.com/people/wytrab8/works/26039653-toadally-rad' }
+
+# Publish your event
+client.publish!(topic, subtopic, schema, partition_key, payload)
 ```
 
 Credits

data/lib/megaphone/client.rb

@@ -10,8 +10,9 @@ module Megaphone
 
     def initialize(config)
       @origin = config.fetch(:origin)
-      @logger = Megaphone::Client::Logger.create(config[:host],
-                                                 config[:port])
+      host = config.fetch(:host, ENV['MEGAPHONE_FLUENT_HOST'])
+      port = config.fetch(:port, ENV['MEGAPHONE_FLUENT_PORT'])
+      @logger = Megaphone::Client::Logger.create(host, port)
     end
 
     def publish!(topic, subtopic, schema, partition_key, payload)

data/lib/megaphone/client/logger.rb

@@ -5,13 +5,11 @@ module Megaphone
   class Client
     class Logger
       def self.create(host = nil, port = nil)
-        fluentd_host = host || ENV["MEGAPHONE_FLUENT_HOST"]
-        fluentd_port = port || ENV["MEGAPHONE_FLUENT_PORT"]
-        if !fluentd_port.nil? && !fluentd_port.empty? &&
-           !fluentd_host.nil? && !fluentd_host.empty?
-          return Megaphone::Client::FluentLogger.new(fluentd_host, fluentd_port)
+        if !port.nil? && !port.empty? &&
+           !host.nil? && !host.empty?
+          return FluentLogger.new(host, port)
         end
-        Megaphone::Client::FileLogger.new
+        FileLogger.new
       end
     end
   end

data/lib/megaphone/client/version.rb

@@ -1,5 +1,5 @@
 module Megaphone
   class Client
-    VERSION = "0.3.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: megaphone-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Redbubble
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Send events to Megaphone.