routemaster-client 1.2.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27996eccbf1d6410595449c47e40fe2f07d3bb38
-  data.tar.gz: 40ca99661429c8b7718fb8d0f5df14d2eb98ac36
+  metadata.gz: 6bb45b1a23c8a5e90938bc4f7fb6d66593fd9dc3
+  data.tar.gz: e544d4fe87d288d07221d7d9822c853580a6ef31
 SHA512:
-  metadata.gz: bf5f31e3cd2b89270a197c25713faad9497bd005991b22b021c6ec933bdba4e2e4c96539f54733457b875c1691cb7f7f3228d1d1dc6fe9e78dad706fa7b8e078
-  data.tar.gz: b8d9a0003d7fb9f028be7a9fe21001b82e1f35e54be90ae3d7375dc43dd3f158190a77c17ae365378c08586edb67df01e5fc811a6583ef9e06eb5321561f2e25
+  metadata.gz: 2e10653bef8d65abbe10354a791dc27b444d0808ac789e24bda7cba5671f317e2fe2ba16c559b7e1335047651e6c17cddfcc08882a05072c16755be018d0d40e
+  data.tar.gz: 02af484562d4ab336398e83cdc5ee9843357d14b866f048cb23a457babbde5abd0e316f86795ab679cb2ac6e6b957b79009200bd60c7c02f71bc1628cf373dc0

data/.travis.yml

@@ -7,3 +7,6 @@ rvm:
   - 2.3.1
 script:
 - bundle exec rspec
+addons:
+  code_climate:
+    repo_token: b1d80c686f42ee5eb66895c4b0ac5c0d978e964d4700eae35aa0138f5a650c02

data/Gemfile

@@ -13,3 +13,5 @@ gem 'guard-rspec'
 gem 'webmock'
 gem 'pry-nav'
 gem 'rack-test'
+gem 'codeclimate-test-reporter', require: nil
+

data/Gemfile.lock

@@ -1,19 +1,25 @@
 PATH
   remote: .
   specs:
-    routemaster-client (1.2.3)
+    routemaster-client (1.3.1)
       faraday (>= 0.9.0)
-      net-http-persistent (~> 2.9.4)
-      wisper (>= 1.6.1)
+      oj (~> 2.17)
+      typhoeus (~> 1.1)
+      wisper (~> 1.6.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    ethon (0.9.1)
+      ffi (>= 1.3.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.12)
@@ -33,6 +39,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.0)
+    json (2.0.2)
     listen (3.0.8)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -41,10 +48,10 @@ GEM
     method_source (0.8.2)
     multipart-post (2.0.0)
     nenv (0.3.0)
-    net-http-persistent (2.9.4)
     notiffany (0.1.0)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    oj (2.17.4)
     pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -75,8 +82,15 @@ GEM
     ruby_dep (1.3.1)
     safe_yaml (1.0.4)
     shellany (0.0.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
     thor (0.19.1)
+    typhoeus (1.1.0)
+      ethon (>= 0.9.0)
     webmock (2.1.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -88,6 +102,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  codeclimate-test-reporter
   guard-rspec
   pry-nav
   psych
@@ -97,4 +112,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.13.2
+   1.12.5

data/README.md

@@ -1,13 +1,8 @@
-# routemaster-client
+## 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/mezis/routemaster) event
+A Ruby API for the [Routemaster](https://github.com/deliveroo/routemaster) event
 bus.
 
-[![Version](https://badge.fury.io/rb/routemaster-client.svg)](https://rubygems.org/gems/routemaster-client)
- 
-[![Build](https://travis-ci.org/mezis/routemaster-client.svg?branch=master)](https://travis-ci.org/mezis/routemaster-client)
- 
-[![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/mezis/routemaster-client/frames/file/README.md)
 
 
 ## Installation
@@ -55,8 +50,14 @@ There are methods for the four canonical event types: `created`, `updated`,
 the publisher floods with `noop`s for all existing entities so subscribers can
 refresh their view of the domain.
 
+A timestamp argument may be passed (it will be set by the bus automatically
+otherwise); it must be an integer number of milliseconds since the UNIX Epoch:
 
-**Register** to be notified about `widgets` and `kitten` at most 60 seconds after
+```ruby
+client.created('widgets', 'https://app.example.com/widgets/1', 1473080555409)
+```
+
+**Subscribe** to be notified about `widgets` and `kitten` at most 60 seconds after
 events, in batches of at most 500 events, to a given callback URL:
 
 ```ruby
@@ -93,6 +94,24 @@ use Routemaster::Receiver, {
 This relies on the excellent event bus from the [wisper
 gem](https://github.com/krisleech/wisper#wisper).
 
+**Unsubscribe** from a single topic:
+
+```ruby
+client.unsubscribe('widgets')
+```
+
+**Unsubscribe** from all topics:
+
+```ruby
+client.unsubscribe_all
+```
+
+**Delete** a topic (only possible if you're the emitter for this topic):
+
+```ruby
+client.delete_topic('widgets')
+```
+
 
 **Monitor** the status of topics and subscriptions:
 
@@ -111,7 +130,7 @@ client.monitor_subscriptions
 
 ## Contributing
 
-1. Fork it ( http://github.com/mezis/routemaster-client/fork )
+1. Fork it ( http://github.com/deliveroo/routemaster-client/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/routemaster-client.gemspec

@@ -9,14 +9,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Julien Letessier']
   spec.email         = ['julien.letessier@gmail.com']
   spec.summary       = %q{Client API for the Routemaster event bus}
-  spec.homepage      = 'http://github.com/mezis/routemaster-client'
+  spec.homepage      = 'http://github.com/deliveroo/routemaster-client'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = %w(.)
 
+  spec.add_runtime_dependency     'typhoeus', '~> 1.1'
   spec.add_runtime_dependency     'faraday', '>= 0.9.0'
-  spec.add_runtime_dependency     'net-http-persistent', '~> 2.9.4'
-  spec.add_runtime_dependency     'wisper', '>= 1.6.1'
+  spec.add_runtime_dependency     'wisper', '~> 1.6.1'
+  spec.add_runtime_dependency     'oj', '~> 2.17'
 end

data/routemaster/client.rb

@@ -1,16 +1,20 @@
 require 'routemaster/client/version'
-require 'routemaster/client/openssl'
 require 'routemaster/topic'
 require 'uri'
-require 'faraday'
 require 'json'
+require 'faraday'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'oj'
 
 module Routemaster
   class Client
+    
     def initialize(options = {})
       @_url = _assert_valid_url(options[:url])
       @_uuid = options[:uuid]
       @_timeout = options.fetch(:timeout, 1)
+      @_verify_ssl = options.fetch(:verify_ssl, true)
 
       _assert (options[:uuid] =~ /^[a-z0-9_-]{1,64}$/), 'uuid should be alpha'
       _assert_valid_timeout(@_timeout)
@@ -52,11 +56,41 @@ module Routemaster
 
       response = _post('/subscription') do |r|
         r.headers['Content-Type'] = 'application/json'
-        r.body = options.to_json
+        r.body = Oj.dump(_stringify_keys options)
       end
-      # $stderr.puts response.status
+
       unless response.success?
-        raise 'subscription rejected'
+        raise 'subscribe rejected'
+      end
+    end
+
+    def unsubscribe(*topics)
+      topics.each { |t| _assert_valid_topic(t) }
+
+      topics.each do |t|
+        response = _delete("/subscriber/topics/#{t}")
+
+        unless response.success?
+          raise 'unsubscribe rejected'
+        end
+      end
+    end
+
+    def unsubscribe_all
+      response = _delete('/subscriber')
+
+      unless response.success?
+        raise 'unsubscribe all rejected'
+      end
+    end
+
+    def delete_topic(topic)
+      _assert_valid_topic(topic)
+
+      response = _delete("/topics/#{topic}")
+
+      unless response.success?
+        raise 'failed to delete topic'
       end
     end
 
@@ -69,7 +103,7 @@ module Routemaster
         raise 'failed to connect to /topics'
       end
 
-      JSON(response.body).map do |raw_topic|
+      Oj.load(response.body).map do |raw_topic|
         Topic.new raw_topic
       end
     end
@@ -77,6 +111,14 @@ module Routemaster
 
     private
 
+    def _stringify_keys(hash)
+      hash.dup.tap do |h|
+        h.keys.each do |k|
+          h[k.to_s] = h.delete(k)
+        end
+      end
+    end
+
     def _assert_valid_timeout(timeout)
       _assert (0..3_600_000).include?(timeout), 'bad timeout'
     end
@@ -96,7 +138,7 @@ module Routemaster
     end
 
     def _assert_valid_timestamp(timestamp)
-      _assert timestamp.is_a?(Numeric), 'not a numeric number'
+      _assert timestamp.kind_of?(Integer), 'not an integer'
     end
 
     def _send_event(event, topic, callback, timestamp = nil)
@@ -108,7 +150,7 @@ module Routemaster
 
       response = _post("/topics/#{topic}") do |r|
         r.headers['Content-Type'] = 'application/json'
-        r.body = data.to_json
+        r.body = Oj.dump(_stringify_keys data)
       end
       fail "event rejected (#{response.status})" unless response.success?
     end
@@ -117,31 +159,27 @@ module Routemaster
       condition or raise ArgumentError.new(message)
     end
 
+    def _http(method, path, &block)
+      _conn.send(method, path, &block)
+    end
+
     def _post(path, &block)
-      retries ||= 5
-      _conn.post(path, &block)
-    rescue Net::HTTP::Persistent::Error => e
-      raise if (retries -= 1).zero?
-      puts "warning: retrying post to #{path} on #{e.class.name}: #{e.message} (#{retries})"
-      @_conn = nil
-      retry
+      _http(:post, path, &block)
     end
 
     def _get(path, &block)
-      retries ||= 5
-      _conn.get(path, &block)
-    rescue Net::HTTP::Persistent::Error => e
-      raise if (retries -= 1).zero?
-      puts "warning: retrying get to #{path} on #{e.class.name}: #{e.message} (#{retries})"
-      @_conn = nil
-      retry
+      _http(:get, path, &block)
+    end
+
+    def _delete(path, &block)
+      _http(:delete, path, &block)
     end
 
     def _conn
-      @_conn ||= Faraday.new(@_url) do |f|
+      @_conn ||= Faraday.new(@_url, ssl: { verify: @_verify_ssl }) do |f|
         f.request :retry, max: 2, interval: 100e-3, backoff_factor: 2
         f.request :basic_auth, @_uuid, 'x'
-        f.adapter :net_http_persistent
+        f.adapter :typhoeus
 
         f.options.timeout      = @_timeout
         f.options.open_timeout = @_timeout

data/routemaster/client/version.rb

@@ -1,5 +1,5 @@
 module Routemaster
   class Client
-    VERSION = '1.2.3'
+    VERSION = '1.3.1'
   end
 end

data/routemaster/receiver.rb

@@ -23,7 +23,8 @@ module Routemaster
         throw :forward unless _intercept_endpoint?(env)
         return [401, {}, []] unless _has_auth?(env)
         return [403, {}, []] unless _valid_auth?(env)
-        return [400, {}, []] unless payload = _extract_payload(env)
+        payload = _extract_payload(env)
+        return [400, {}, []] unless payload
 
         @handler.on_events(payload) if @handler
         publish(:events_received, payload)

data/spec/client_spec.rb

@@ -4,9 +4,11 @@ require 'routemaster/topic'
 require 'webmock/rspec'
 
 describe Routemaster::Client do
-  let(:options) do
-    { url:  'https://bus.example.com', uuid: 'john_doe' }
-  end
+  let(:options) {{
+    url:        'https://bus.example.com',
+    uuid:       'john_doe',
+    verify_ssl: false,
+  }}
   let(:pulse_response) { 204 }
 
   subject { described_class.new(options) }
@@ -130,7 +132,7 @@ describe Routemaster::Client do
     end
 
     context 'with explicit timestamp' do
-      let(:timestamp) { Time.now.to_f }
+      let(:timestamp) { (Time.now.to_f * 1e3).to_i }
       let(:perform)   { subject.send(event, topic, callback, timestamp) }
 
       before do
@@ -147,10 +149,18 @@ describe Routemaster::Client do
         expect(@stub).to have_been_requested
       end
 
-      context 'with bad timestamp' do
+      context 'with non-numeric timestamp' do
         let(:timestamp) { 'foo' }
 
-        it 'fails with non-numeric timestamp' do
+        it 'fails' do
+          expect { perform }.to raise_error(ArgumentError)
+        end
+      end
+
+      context 'with non-integer timestamp' do
+        let(:timestamp) { 123.45 }
+
+        it 'fails' do
           expect { perform }.to raise_error(ArgumentError)
         end
       end
@@ -231,6 +241,81 @@ describe Routemaster::Client do
     end
   end
 
+  describe '#unsubscribe' do
+    let(:perform) { subject.unsubscribe(*args) }
+    let(:args) {[
+      'widgets'
+    ]}
+
+    before do
+      @stub = stub_request(:delete, %r{https://bus.example.com/subscriber/topics/widgets}).
+      with(basic_auth: [options[:uuid], 'x'])
+    end
+
+    it 'passes with correct arguments' do
+      expect { perform }.not_to raise_error
+      expect(@stub).to have_been_requested
+    end
+
+    it 'fails with a bad topic' do
+      args.replace ['foo123%bar']
+      expect { perform }.to raise_error(ArgumentError)
+    end
+
+    it 'fails on HTTP error' do
+      @stub.to_return(status: 500)
+      expect { perform }.to raise_error(RuntimeError)
+    end
+  end
+
+
+  describe '#unsubscribe_all' do
+    let(:perform) { subject.unsubscribe_all }
+
+    before do
+      @stub = stub_request(:delete, %r{https://bus.example.com/subscriber}).
+      with(basic_auth: [options[:uuid], 'x'])
+    end
+
+    it 'passes with correct arguments' do
+      expect { perform }.not_to raise_error
+      expect(@stub).to have_been_requested
+    end
+
+    it 'fails on HTTP error' do
+      @stub.to_return(status: 500)
+      expect { perform }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe '#delete_topic' do
+    let(:perform) { subject.delete_topic(*args) }
+    let(:args) {[
+      'widgets'
+    ]}
+
+    before do
+      @stub = stub_request(:delete, %r{https://bus.example.com/topics/widgets}).
+      with(basic_auth: [options[:uuid], 'x'])
+    end
+
+    it 'passes with correct arguments' do
+      expect { perform }.not_to raise_error
+      expect(@stub).to have_been_requested
+    end
+
+    it 'fails with a bad topic' do
+      args.replace ['foo123%bar']
+      expect { perform }.to raise_error(ArgumentError)
+    end
+
+    it 'fails on HTTP error' do
+      @stub.to_return(status: 500)
+      expect { perform }.to raise_error(RuntimeError)
+    end
+  end
+
+
   describe '#monitor_topics' do
 
     let(:perform) { subject.monitor_topics }

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -13,4 +16,6 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  config.after(:suite) { WebMock.disable! }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-client
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.1
 platform: ruby
 authors:
 - Julien Letessier
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: net-http-persistent
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.4
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
-  name: wisper
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '2.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '2.17'
 description: 
 email:
 - julien.letessier@gmail.com
@@ -71,10 +85,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- core_ext/silence_stream.rb
 - routemaster-client.gemspec
 - routemaster/client.rb
-- routemaster/client/openssl.rb
 - routemaster/client/version.rb
 - routemaster/receiver.rb
 - routemaster/topic.rb
@@ -82,7 +94,7 @@ files:
 - spec/receiver_spec.rb
 - spec/spec_helper.rb
 - spec/topic_spec.rb
-homepage: http://github.com/mezis/routemaster-client
+homepage: http://github.com/deliveroo/routemaster-client
 licenses:
 - MIT
 metadata: {}

data/core_ext/silence_stream.rb

@@ -1,13 +0,0 @@
-# Adapted from
-# activesupport/lib/active_support/core_ext/kernel/reporting.rb, line 44
-class IO
-  def silence_stream(&block)
-    old_stream = dup
-    self.reopen('/dev/null')
-    self.sync = true
-    yield
-  ensure
-    reopen(old_stream)
-    old_stream.close
-  end
-end

data/routemaster/client/openssl.rb

@@ -1,21 +0,0 @@
-# In development environments, engineers will typically use self-signed
-# certificates as it it not realistic to have valid cert chains for localhost
-# or fake domains.
-#
-# This code disables SSL cert verification, and silences net-http-persistent's
-# unnecessary warning.
-#
-# Note that this does _not_ apply in production or staging.
-#
-# http://docs.seattlerb.org/net-http-persistent/History_txt.html#documentation
-# http://www.rubyinside.com/how-to-cure-nethttps-risky-default-https-behavior-4010.html
-if ENV.fetch('RACK_ENV', 'development') !~ /production|staging/
-  require 'openssl'
-  require 'core_ext/silence_stream'
-
-  I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG = nil
-
-  $stderr.silence_stream do
-    OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-  end
-end