routemaster-client 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd1e1f24e8d625dbdd9824f986e1c3fe57107575
-  data.tar.gz: ea838ffeb71a05fca351a41b00075bad143ec31f
+  metadata.gz: 5f38e0d37b7b2438fdc823e0df9d08ae2a45df05
+  data.tar.gz: 9ebb5aacf9ac9cf1e806f29b8908fb1f2b1c13a9
 SHA512:
-  metadata.gz: 8f08a91701b5d8984fe51fe40f0c9c659647f0648a9ef432422e471b821c5c4fd7092efe4db5a8cf5e2d030438ab4f67c92e89669d6a509ae47531d02254c6b6
-  data.tar.gz: bbc44b01fed6ecb14932da518d67bbff9c9b38823bc8a98cf77de6f124d9868c496eea1f4f7d26924e320544e793cebf61609846910eaf52a024467cdeb09ae7
+  metadata.gz: 6d9ae9d682feb8add9c4946e9fd2a8e1a2f803a6d6cd7802d255498df54f02ad763dd9f90f9a65ae6cbbaccc5f48efb2116ad05f9ba76348bdd7c036b36da74c
+  data.tar.gz: d02d9fd0b1cff7ccba425bc67efb38cd14e0a41cadea41c8d2ed28e3df0ffcd09b5e876148942f4a2fc8f4351859aad28c7e4868ae33937eb859214b94df34bb

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.1

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - ruby-head
 script:
   - bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,22 @@
-# v3.1.0 (2017-03-28) 
+## 3.1.1 (2017-08-15)
 
-Features: 
+Features:
+
+- Adds the `rtm` command-line API wrapper (#24)
+- Adds the `#monitor_subscriptions` API (#17)
+
+Changes:
+
+- The `Routemaster::Topic` value object class is not namespaced as
+  `Routemaster::Client::Topic` (#17)
+
+Bug fixes:
+
+- Always send a timestamp when sending asynchronously (#20)
+- Sidekiq 5 compatibility (#22)
+
+## 3.1.0 (2017-03-28)
+
+Features:
 
 - Adds support for event payloads (#16)

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    routemaster-client (3.1.0)
+    routemaster-client (3.1.1)
       faraday (>= 0.9.0)
+      hashie
       oj (~> 2.17)
       typhoeus (~> 1.1)
       wisper (~> 1.6.1)
@@ -10,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     byebug (9.0.6)
     codeclimate-test-reporter (1.0.8)
@@ -24,7 +25,7 @@ GEM
     docile (1.1.5)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.18)
     formatador (0.2.5)
@@ -42,20 +43,21 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.3.2)
-    json (2.0.3)
+    hashdiff (0.3.4)
+    hashie (3.5.6)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.11)
+    lumberjack (1.0.12)
     method_source (0.8.2)
     multipart-post (2.0.0)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    oj (2.18.3)
+    oj (2.18.5)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -65,47 +67,47 @@ GEM
       pry (~> 0.10)
     psych (2.2.4)
     public_suffix (2.0.5)
-    rack (2.0.1)
-    rack-protection (1.5.3)
+    rack (2.0.3)
+    rack-protection (2.0.0)
       rack
-    rack-test (0.6.3)
-      rack (>= 1.0)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
     rake (12.0.0)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.9.8)
-      ffi (>= 0.5.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
     redis (3.3.3)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sidekiq (4.2.10)
+    sidekiq (5.0.4)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
-      redis (~> 3.2, >= 3.2.1)
+      redis (~> 3.3, >= 3.3.3)
     simplecov (0.13.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+    simplecov-html (0.10.1)
     slop (3.6.0)
     thor (0.19.4)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
-    webmock (2.3.2)
+    webmock (3.0.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -128,4 +130,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.5
+   1.15.3

data/README.md

@@ -1,25 +1,20 @@
 ## routemaster-client [![Version](https://badge.fury.io/rb/routemaster-client.svg)](https://rubygems.org/gems/routemaster-client) [![Build](https://travis-ci.org/deliveroo/routemaster-client.svg?branch=master)](https://travis-ci.org/deliveroo/routemaster-client) [![Code Climate](https://codeclimate.com/github/deliveroo/routemaster-client/badges/gpa.svg)](https://codeclimate.com/github/deliveroo/routemaster-client) [![Test Coverage](https://codeclimate.com/github/deliveroo/routemaster-client/badges/coverage.svg)](https://codeclimate.com/github/deliveroo/routemaster-client/coverage) [![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/deliveroo/routemaster-client/frames/file/README.md)
 
-A Ruby API for the [Routemaster](https://github.com/deliveroo/routemaster) event
-bus.
+A Ruby API and CLI for the
+[Routemaster](https://github.com/deliveroo/routemaster) event bus.
 
+[Installation](#installation) | [Library usage](#library-usage) | [CLI usage](#cli-usage)
 
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'routemaster-client'
-
-And then execute:
+    gem install routemaster-client
 
-    $ bundle
+## Library usage
 
-Or install it yourself as:
-
-    $ gem install routemaster-client
+Add this line to your application's Gemfile:
 
-## Usage
+    gem 'routemaster-client'
 
 **Configure** your client:
 
@@ -128,6 +123,102 @@ Routemaster::Client.monitor_subscriptions
 #  } ... ]
 ```
 
+## CLI usage
+
+This gem includes the `rtm` binary, which can be used to interact with a
+Routemaster bus.
+
+### Commands
+
+```
+rtm token add [options] SERVICE TOKEN
+```
+
+Adds `TOKEN` to the list of API tokens permitted to use the bus API. `SERVICE`
+is a human-readable name for this token.
+
+```
+rtm token del [options] TOKEN
+```
+
+Removes `TOKEN` from permitted tokens if it exists.
+
+```
+rtm token list [options]
+```
+
+Lists currently permitted API tokens.
+
+```
+rtm sub add [options] URL TOPICS... [--latency MS] [--batch-size COUNT]
+```
+
+Adds (or updates) a subscription. Note that the `TOKEN` passed in `option` must be
+that of the subscriber, not a root token.
+
+- `URL` must be HTTPS and include an authentication username (used by the bus
+  when delivering events).
+- `TOPICS` is a list of topic names.
+- `MS`, if specified, is the target delivery latency for this subscriber (ie.
+  how long to buffer events). 
+- `COUNT`, if specified, is the maximum number of events in a delivered batch.
+
+```
+rtm sub del [options] [TOPICS]
+```
+
+Updates or removes a subscription. Note that the `TOKEN` passed in `option` must
+be that of the subscriber, not a root token.  If no `TOPICS` are specified, the
+subscription is entirely removed.
+
+```
+rtm sub list [options]
+```
+
+List existing subscriptions.
+
+```
+rtm pub [options] EVENT TOPIC URL
+```
+
+Publishes an event to the bus.  Note that the `TOKEN` passed in `option` must
+be that of the subscriber, not a root token. `EVENT` must be one of `created`,
+`updated`, `deleted`, or `noop`. `TOPIC` must be a valid topic name. `URL` must
+be a valid HTTPS URL.
+
+
+### Global options
+
+```
+-b|--bus DOMAIN|@NAME
+```
+
+The domain names of the bus to interact with, or a reference (`NAME`) to global
+configuration.
+
+Note that `DOMAIN` is _not_ a URL.
+
+```
+-t|--token TOKEN
+```
+
+An API token to use when querying the bus.
+
+
+`rtm` will load a configuration file in Yaml format (`.rtmrc` or `~/.rtmrc`).
+Example:
+
+```
+# .rtmrc
+production:
+  bus:    prod.bus.example.com
+  token:  2bf959d1-04fb-4912-8450-ab646888d476
+```
+
+With this configuration, `rtm token list -b @production` will list API tokens
+for the bus at the domain specified in the config.
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/deliveroo/routemaster-client/fork )

data/exe/rtm

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'routemaster/cli/top_level'
+
+begin
+  Routemaster::CLI::Toplevel.new.run(ARGV)
+rescue Routemaster::CLI::Exit => e
+  exit e.message.to_i
+end
+

data/routemaster-client.gemspec

@@ -16,8 +16,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = %w(.)
 
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
   spec.add_runtime_dependency     'typhoeus', '~> 1.1'
   spec.add_runtime_dependency     'faraday', '>= 0.9.0'
   spec.add_runtime_dependency     'wisper', '~> 1.6.1'
   spec.add_runtime_dependency     'oj', '~> 2.17'
+
+  spec.add_runtime_dependency     'hashie'
 end

data/routemaster/cli/base.rb

@@ -0,0 +1,134 @@
+require 'routemaster/cli/helper'
+require 'optparse'
+require 'hashie'
+
+module Routemaster
+  module CLI
+    class Base
+      def self.inherited(by)
+        by.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def prefix(ary = nil)
+          @prefix ||= ary
+        end
+
+        def syntax(string = nil)
+          string ? (@syntax = string) : ['rtm', *@prefix, @syntax, '[options]'].compact.join(' ')
+        end
+
+        def descr(string = nil)
+          string ? (@descr = string) : @descr
+        end
+
+        def defaults(hash = nil)
+          hash ? (@defaults = hash) : (@defaults || {})
+        end
+
+        def options(&block)
+          block_given? ? (@options = block) : @options
+        end
+
+        def action(&block)
+          block_given? ? (@action = block) : @action || lambda { |*| }
+        end
+      end
+
+      def initialize(stderr:, stdout:)
+        @stderr = stderr
+        @stdout = stdout
+      end
+
+      def run(argv)
+        @argv = argv
+        _parser.parse!(@argv)
+        instance_eval(&self.class.action)
+      rescue Exit
+        raise
+      rescue StandardError => e
+        log "#{e.class.name}: #{e.message}"
+        if config.verbose
+          e.backtrace.each { |l| log "\t#{l}" }
+        end
+        raise Exit, 2
+      end
+
+      protected
+
+      def argv
+        @argv || []
+      end
+
+      def config
+        @config ||= Hashie::Mash.new(_default_options).merge(self.class.defaults)
+      end
+
+      def helper
+        Helper.new(config)
+      end
+
+      def log(message)
+        @stderr.puts(message)
+      end
+
+      def puts(message)
+        @stdout.puts(message)
+      end
+
+      def usage!
+        log "Usage:"
+        log _parser
+        raise Exit, 1
+      end
+
+      def bad_argc!
+        log "Wrong number of arguments."
+        usage!
+      end
+
+      private
+
+      def _default_options
+        { verbose: false }
+      end
+
+      def _parser
+        @parser ||= OptionParser.new do |p|
+          p.banner = self.class.syntax
+          p.separator self.class.descr
+
+          if self.class.options
+            p.separator 'Options:'
+            self.class.options.call(p)
+          end
+
+          p.separator 'Common options:'
+
+          p.on('-b', '--bus DOMAIN|@NAME', %{
+            The domain name of the bus to interact with, or a reference (`NAME`)
+            to global configuration.
+          }) do |v|
+            config.bus = v
+          end
+
+          p.on('-t', '--token TOKEN', %{
+            An API token to use when querying the bus.
+          }) do |v|
+            config.token = v
+          end
+
+          p.on('-v', '--verbose', %{
+            Increase logging verbosity
+          }) do
+            config.verbose = true
+          end
+        end
+      end
+
+      def _description
+        self.class.descr.split(/\n/).map(&:strip).reject(&:empty?).join("\n")
+      end
+    end
+  end
+end