megaphone-client 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15b75d53f469b5b1eb81174951801eb6b131957d
-  data.tar.gz: 72d170f64c4a6eb00f009411e21700ce238eee82
+SHA256:
+  metadata.gz: 2d48043a0df8afb5fba26820a9a09e32c57c6c2658795ae38869c979062b5d67
+  data.tar.gz: ebababb0d2f28825df5587fba9a792864360836fe40a1a0843be3837acbd779d
 SHA512:
-  metadata.gz: 5510da93aa27aaa55aa0bfb6b4ea68cb11678f9c7424d89cd309cad42e87e220dc62b4a0bd2ba7d5925fe233a34f8fe07c8c2cfd427c8e97645b4f9508fdffcd
-  data.tar.gz: 2e6f71ac8caa1f13ab0bbf81351d6baf4056322d4e5cd4ffb85e8e3ca86a56d5ab8ba9a901eecc27a22a38d525d2b94bc3d7d219f9308285ae370d81059d7eba
+  metadata.gz: f9e5512231b6bcb86b8180851fe0091e3fcc9c03caf87c445121cf7cef2f05abdef37582d97bdc184c9c1cf8c14dfb42114a59859e3fc7296c27762592d20505
+  data.tar.gz: 181405d9073d0616d7a2a91db1f852d9c852f63801877f12575f7a9eea5a6f6b34b564cb60d918b2d4bc128064e9d15362d95a5b2e15bab4ea0c4f6d4378f1eb

data/CHANGELOG.md

@@ -5,6 +5,19 @@ 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 adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.1.1] - 2018-02-09
+
+### Added
+
+* A [code of conduct][coc] and [contributing guidelines][contributing].
+
+### Fixed
+
+* Validation of events to ensure that Kinesis will accept them.
+
+  [coc]: ./CODE_OF_CONDUCT.md
+  [contributing]: ./CONTRIBUTING.md
+
 ## [1.1.0] - 2018-01-30
 
 ### Added
@@ -62,6 +75,7 @@ this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 * Initial implementation of the `Megaphone::Client.publish!` method
 
+  [1.1.1]: https://github.com/redbubble/megaphone-client-ruby/compare/v1.1.0...v1.1.1
   [1.1.0]: https://github.com/redbubble/megaphone-client-ruby/compare/v1.0.1...v1.1.0
   [1.0.1]: https://github.com/redbubble/megaphone-client-ruby/compare/v1.0.0...v1.0.1
   [1.0.0]: https://github.com/redbubble/megaphone-client-ruby/compare/v0.3.0...v1.0.0

data/README.md

@@ -1,10 +1,28 @@
 # Megaphone::Client
 
-[![Build Status](https://badge.buildkite.com/9f4fdb370f5f295ee6bf3d68937b1be2d7cf9bf65b2c7b4213.svg?branch=master)](https://buildkite.com/redbubble/megaphone-client-ruby)
+[![Build Status](https://travis-ci.org/redbubble/megaphone-client-ruby.svg?branch=master)](https://travis-ci.org/redbubble/megaphone-client-ruby)
 [![Gem Version](https://badge.fury.io/rb/megaphone-client.svg)](https://badge.fury.io/rb/megaphone-client)
 ![Megaphone](https://img.shields.io/badge/Megaphone-2.0.0-blue.svg)
+![This is the reference implementation fro Megaphone clients.](https://img.shields.io/badge/megaphone--client-reference%20implementation-blue.svg)
 
-Send events to [Megaphone](https://github.com/redbubble/Megaphone).
+Send events to [Megaphone (private)](https://github.com/redbubble/Megaphone).
+
+> **DISCLAIMER**: This is part of a currently private event broadcasting system called Megaphone. Please be aware that some links may lead to private repositories. Questions are welcome, though, and we're happy to help if you find a use for this gem, or get inspired by it!
+>
+> More of Megaphone could become public in the future, but there is currently no clear roadmap for it. -- [GB](https://github.com/gonzalo-bulnes)
+
+## Table of contents
+
+1. [**Getting started**](#getting-started)
+1. [**Usage**](#usage)
+   1. [Publishing events](#publishing-events)
+1. [**Error handling**](#error-handling)
+   1. [Exceptions the client will raise](#exceptions-the-client-will-raise)
+   1. [Internal buffering upon error](#internal-buffering-upon-error)
+   1. [Buffer overflow callback handler](#buffer-overflow-callback-handler)
+   1. [Handling time-sensitive events and errors](#handling-time-sensitive-events-and-errors)
+1. [**Development**](#development)
+   1. [Testing](#testing)
 
 ## Getting Started
 
@@ -61,17 +79,23 @@ client.publish!(topic, subtopic, schema, partition_key, payload)
 
 ### Exceptions the client will raise
 
-`publish!` can raise two exceptions if the underlying Fluentd
-client library throws an error.
+#### `MegaphoneInvalidEventError`
+
+Raised when the message is invalid by Kinesis's standards.
+
+#### `MegaphoneMessageDelayWarning`
 
-The most common is `MegaphoneMessageDelayWarning` which indicates
-a transient failure occurred, but the message will probably be resent
-later. See section on _[Internal buffering](#internal-buffering-upon-error)_ below for more details.
+This indicates a transient failure occurred, but the message will
+probably be re-sent later. See the section on
+_[Internal buffering](#internal-buffering-upon-error)_ below for more
+details.
 
-The second exception is `MegaphoneUnavailableError`, which is thrown
-for all other errors. Note that these _may or may not_ also buffer
-the message for later transmission. Unfortunately the underlying
-client library does not make the distinction.
+#### `MegaphoneUnavailableError`
+
+This is raised for all other errors. Note that
+these _may or may not_ also buffer the message for later
+transmission. Unfortunately the underlying client library does not
+make the distinction.
 
 ### Internal buffering upon error
 
@@ -149,6 +173,13 @@ Unfortunately there is no means to do this with the underlying Ruby client
 for Fluentd. It would require patches to the upstream code to expose a flush
 method.
 
+## Contributing
+
+Want to contribute? Amazing! Our [contributing guidelines][contributing], and [code of conduct][coc] are here to get you started and make you feel welcome!
+
+[coc]: ./CODE_OF_CONDUCT.md
+[contributing]: ./CONTRIBUTING.md
+
 ## Credits
 
 [![](doc/redbubble.png)][redbubble]

data/lib/megaphone/client.rb

@@ -22,11 +22,12 @@ module Megaphone
 
     def publish!(topic, subtopic, schema, partition_key, payload)
       event = Event.new(topic, subtopic, origin, schema, partition_key, payload)
+      raise MegaphoneInvalidEventError.new(event.errors.join(', ')) unless event.valid?
       unless logger.post(topic, event.to_hash)
         if transient_error?(logger.last_error)
-          raise MegaphoneMessageDelayWarning.new(logger.last_error.message, event)
+          raise MegaphoneMessageDelayWarning.new(logger.last_error.message, event.stream_id)
         else
-          raise MegaphoneUnavailableError.new(logger.last_error.message, event)
+          raise MegaphoneUnavailableError.new(logger.last_error.message, event.stream_id)
         end
       end
     end

data/lib/megaphone/client/errors.rb

@@ -2,27 +2,23 @@ module Megaphone
   class Client
     class MegaphoneUnavailableError < StandardError
 
-      def initialize(msg, event)
-        super(msg)
-        @msg = msg
-        @event = event
-      end
-
-      def to_s
-        "#{@msg} - An event could not be immediately published, but may be retried: #{@event.stream_id}"
+      def initialize(msg, stream_id)
+        super("#{msg} - An event could not be immediately published, but may be retried: #{stream_id}")
       end
     end
 
     class MegaphoneMessageDelayWarning < StandardError
 
-      def initialize(msg, event)
-        super(msg)
-        @msg = msg
-        @event = event
+      def initialize(msg, stream_id)
+        super("#{msg} - Event delayed and will be reattempted: #{stream_id}")
       end
+    end
+
+    class MegaphoneInvalidEventError < StandardError
 
-      def to_s
-        "#{@msg} - Event delayed and will be reattempted: #{@event.stream_id}"
+      def initialize(msg)
+        super("Invalid Megaphone event was not sent: #{msg}")
+        @msg = msg
       end
     end
   end

data/lib/megaphone/client/event.rb

@@ -30,6 +30,26 @@ module Megaphone
       def to_s
         JSON.dump(to_hash)
       end
+
+      def errors
+        errors = []
+        errors << 'partition_key must not be empty' if missing?(@partition_key)
+        errors << 'topic must not be empty' if missing?(@topic)
+        errors << 'subtopic must not be empty' if missing?(@subtopic)
+        errors << 'payload must not be empty' if missing?(@payload)
+        errors << 'origin must not be empty' if missing?(@origin)
+        errors
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      private
+
+      def missing?(field)
+        not (field && field.to_s.length > 0)
+      end
     end
   end
 end

data/lib/megaphone/client/version.rb

@@ -1,5 +1,5 @@
 module Megaphone
   class Client
-    VERSION = "1.1.0"
+    VERSION = "1.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: megaphone-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Redbubble
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-30 00:00:00.000000000 Z
+date: 2018-02-09 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.7.5
 signing_key: 
 specification_version: 4
 summary: Send events to Megaphone.