routemaster-client 3.1.0 → 3.1.1

data/routemaster/client/errors.rb

@@ -8,5 +8,6 @@ module Routemaster
     class MissingAsyncBackendError   < Error; end
     class MissingAttributeError      < ConfigurationError; end
     class InvalidAttributeError      < ConfigurationError; end
+    class ConnectionError            < Error; end
   end
 end

data/routemaster/client/subscription.rb

@@ -0,0 +1,32 @@
+module Routemaster
+  module Client
+    class Subscription
+
+      attr_reader :subscriber, :callback, :topics, :events
+
+      def initialize(options)
+        @subscriber = options.fetch('subscriber')
+        @callback   = options.fetch('callback')
+        @topics     = options.fetch('topics')
+        @events     = _symbolize_keys options.fetch('events')
+      end
+
+      def attributes
+        {
+          subscriber: @subscriber,
+          callback:   @callback,
+          topics:     @topics,
+          events:     @events
+        }
+      end
+
+      private
+
+      def _symbolize_keys(h)
+        {}.tap do |res|
+          h.each { |k,v| res[k.to_sym] = v }
+        end
+      end
+    end
+  end
+end

data/routemaster/client/topic.rb

@@ -0,0 +1,22 @@
+module Routemaster
+  module Client
+    class Topic
+
+      attr_reader :name, :publisher, :events
+
+      def initialize(options)
+        @name      = options.fetch('name')
+        @publisher = options.fetch('publisher')
+        @events    = options.fetch('events')
+      end
+
+      def attributes
+        { name: @name, publisher: @publisher, events: @events }
+      end
+
+    end
+  end
+
+  # For backwards compatibility (TODO: remove in v4)
+  Topic = Client::Topic
+end

data/routemaster/client/version.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Client
-    VERSION = '3.1.0'
+    VERSION = '3.1.1'
   end
 end

data/spec/cli/pub_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'routemaster/cli/top_level'
+require 'webmock/rspec'
+
+describe Routemaster::CLI::Pub, type: :cli do
+  before { allow_bus_pulse 'bus.dev', 's3cr3t' }
+
+  context 'with too few arguments' do
+    let(:argv) { [] }
+    it { expect { perform }.to raise_error(Routemaster::CLI::Exit) }
+    it { expect { perform rescue nil }.to change { stderr.string }.to a_string_matching(/Usage/) }
+  end
+
+  context 'with correct arguments' do
+    let(:argv) { %w[pub created widgets https://example.com/widgets/1 -b bus.dev -t s3cr3t] }
+    it { 
+      expect(client).to receive(:created).with('widgets', 'https://example.com/widgets/1')
+      perform
+    }
+  end
+end

data/spec/cli/sub_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'routemaster/cli/top_level'
+require 'webmock/rspec'
+
+describe Routemaster::CLI::Sub, type: :cli do
+  before { allow_bus_pulse 'bus.dev', 's3cr3t' }
+
+  describe 'add' do
+    context 'with correct arguments' do
+      let(:argv) { %w[sub add https://my-service.dev cats dogs -b bus.dev -t s3cr3t] }
+
+      it { 
+        expect(client).to receive(:subscribe).with(topics: %w[cats dogs], callback: 'https://my-service.dev')
+        perform
+      }
+    end
+  end
+
+  describe 'del' do
+    context 'with a list of topics' do
+      let(:argv) { %w[sub del cats dogs -b bus.dev -t s3cr3t] }
+      it { 
+        expect(client).to receive(:unsubscribe).with('cats', 'dogs')
+        perform
+      }
+    end
+
+    context 'without arguments' do
+      let(:argv) { %w[sub del -b bus.dev -t s3cr3t] }
+      it { 
+        expect(client).to receive(:unsubscribe_all).with(no_args)
+        perform
+      }
+    end
+  end
+
+  describe 'list' do
+    context 'with correct arguments' do
+      let(:argv) { %w[sub list -b bus.dev -t s3cr3t] }
+      before {
+        allow(client).to receive(:monitor_subscriptions).and_return([
+          Routemaster::Client::Subscription.new(
+            'subscriber' => 'service--f000-b44r-b44r',
+            'callback' => 'https://serviced.dev',
+            'topics' => %w[cats dogs],
+            'events' => {
+              'queued' => 1234
+            })
+        ])
+      }
+
+      it { 
+        expect(client).to receive(:monitor_subscriptions).with(no_args)
+        perform
+      }
+      it {
+        expect { perform }.to change { stdout.string }.to a_string_matching(/service--f000-b44r-b44r/)
+      }
+    end
+  end
+end

data/spec/cli/token_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'routemaster/cli/top_level'
+require 'webmock/rspec'
+
+describe Routemaster::CLI::Token, type: :cli do
+  before { allow_bus_pulse 'bus.dev', 's3cr3t' }
+
+  describe 'add' do
+    context 'with correct arguments' do
+      let(:argv) { %w[token add my-service -b bus.dev -t s3cr3t] }
+
+      it { 
+        expect(client).to receive(:token_add).with(name: 'my-service', token: nil)
+        perform
+      }
+
+      it {
+        allow(client).to receive(:token_add).and_return('my-service--dead-0000-beef')
+        expect { perform }.to change { stdout.string }.to("my-service--dead-0000-beef\n")
+      }
+    end
+  end
+
+  describe 'del' do
+    context 'with correct arguments' do
+      let(:argv) { %w[token del my-service--dead-0000-beef -b bus.dev -t s3cr3t] }
+      it { 
+        expect(client).to receive(:token_del).with(token: 'my-service--dead-0000-beef')
+        perform
+      }
+    end
+  end
+
+  describe 'list' do
+    context 'with correct arguments' do
+      let(:argv) { %w[token list -b bus.dev -t s3cr3t] }
+      before {
+        allow(client).to receive(:token_list).and_return({ 'service--t0ken' => 'service' })
+      }
+
+      it { 
+        expect(client).to receive(:token_list).with(no_args)
+        perform
+      }
+      it {
+        expect { perform }.to change { stdout.string }.to "service--t0ken\tservice\n"
+      }
+    end
+  end
+end

data/spec/client/subscription_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'routemaster/client/subscription'
+
+describe Routemaster::Client::Subscription do
+  describe '#initialize' do
+    let(:options) {{ 
+      'subscriber' => 'alice', 
+      'callback'   => 'https://example.com/events',
+      'topics'     => %w[widgets],
+      'events'     => {},
+    }}
+
+    subject { described_class.new(options) }
+    
+    it 'passes' do
+      expect { subject }.not_to raise_error
+    end
+  end
+end

data/spec/{topic_spec.rb → client/topic_spec.rb}

@@ -1,6 +1,6 @@
-require 'routemaster/topic'
+require 'routemaster/client/topic'
 
-describe Routemaster::Topic do
+describe Routemaster::Client::Topic do
 
   let(:name)      { 'widgets' }
   let(:publisher) { 'demo' }

data/spec/client_spec.rb

@@ -2,9 +2,10 @@ require 'spec_helper'
 require 'spec/support/configuration_helper'
 require 'routemaster/client'
 require 'routemaster/client/backends/sidekiq'
-require 'routemaster/topic'
+require 'routemaster/client/topic'
 require 'webmock/rspec'
 require 'sidekiq/testing'
+require 'securerandom'
 
 describe Routemaster::Client do
 
@@ -69,10 +70,10 @@ describe Routemaster::Client do
     end
   end
 
-  shared_examples 'an event sender' do
+  shared_examples 'an event sender' do |spec_options|
     let(:callback) { 'https://app.example.com/widgets/123' }
     let(:topic)    { 'widgets' }
-    let(:perform)  { subject.send(event, topic, callback, **flags) }
+    let(:perform)  { subject.send(method, topic, callback, **flags) }
     let(:http_status) { nil }
 
     before do
@@ -97,6 +98,25 @@ describe Routemaster::Client do
         perform
       end
 
+      it 'sends the url and type' do
+        @stub.with do |req|
+          data = JSON.parse(req.body)
+          expect(data['type']).to eq event
+          expect(data['url']).to eq callback
+        end
+        perform
+      end
+
+      if spec_options && spec_options[:set_timestamp]
+        it 'sets a timestamp' do
+          @stub.with do |req|
+            data = JSON.parse(req.body)
+            expect(data['timestamp']).to be_a_kind_of(Integer)
+          end
+          perform
+        end
+      end
+
       it 'fails with a bad callback URL' do
         callback.replace 'http.foo.bar'
         expect { perform }.to raise_error(Routemaster::Client::InvalidArgumentError)
@@ -121,7 +141,7 @@ describe Routemaster::Client do
       let(:http_status) { 500 }
 
       it 'raises an exception' do
-        expect { perform }.to raise_error(RuntimeError)
+        expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'event rejected (status: 500)')
       end
     end
 
@@ -136,7 +156,7 @@ describe Routemaster::Client do
 
     context 'with explicit timestamp' do
       let(:timestamp) { (Time.now.to_f * 1e3).to_i }
-      let(:perform)   { subject.send(event, topic, callback, t: timestamp) }
+      let(:perform)   { subject.send(method, topic, callback, t: timestamp) }
 
       before do
         @stub = stub_request(:post, 'https://@bus.example.com/topics/widgets').
@@ -171,7 +191,7 @@ describe Routemaster::Client do
 
     context 'with a data payload' do
       let(:timestamp) { (Time.now.to_f * 1e3).to_i }
-      let(:perform)   { subject.send(event, topic, callback, data: data) }
+      let(:perform)   { subject.send(method, topic, callback, data: data) }
       let(:data) {{ 'foo' => 'bar' }}
 
       before do
@@ -202,7 +222,8 @@ describe Routemaster::Client do
     context 'with default flags' do
       %w[created updated deleted noop].each do |m|
         describe "##{m}" do
-          let(:event) { m.to_sym }
+          let(:method) { m.to_sym }
+          let(:event) { m.sub(/d$/, '') }
           let(:flags) { {} }
           it_behaves_like 'an event sender'
         end
@@ -232,46 +253,49 @@ describe Routemaster::Client do
 
   context 'with the sidekiq async back end configured' do
     reset_sidekiq_config_between_tests!
- 
+
     before do
       options[:async_backend] = Routemaster::Client::Backends::Sidekiq.configure do |config|
         config.queue = :realtime
         config.retry = true
       end
     end
- 
+
     around do |example|
       Sidekiq::Testing.inline! do
         example.run
       end
     end
- 
+
     context 'with default options' do
       let(:flags) { {} }
- 
+
       %w[created updated deleted noop].each do |m|
         describe "##{m}" do
-          let(:event) { m }
+          let(:method) { m }
+          let(:event) { m.sub(/d$/, '') }
           it_behaves_like 'an event sender'
         end
       end
     end
- 
+
     context 'with :async option' do
       let(:flags) { { async: true } }
- 
+
       %w[created updated deleted noop].each do |m|
         describe "##{m}" do
-          let(:event) { m }
-          it_behaves_like 'an event sender'
+          let(:method) { m }
+          let(:event) { m.sub(/d$/, '') }
+          it_behaves_like 'an event sender', set_timestamp: true
         end
       end
     end
- 
+
     describe 'deprecated *_async methods' do
       %w[created updated deleted noop].each do |m|
         describe "##{m}_async" do
-          let(:event) { "#{m}_async" }
+          let(:method) { "#{m}_async" }
+          let(:event) { m.sub(/d$/, '') }
           let(:flags) { {} }
           it_behaves_like 'an event sender'
         end
@@ -324,7 +348,7 @@ describe Routemaster::Client do
 
     it 'fails on HTTP error' do
       @stub.to_return(status: 500)
-      expect { perform }.to raise_error(RuntimeError, 'subscribe rejected')
+      expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'subscribe rejected (status: 500)')
     end
 
     it 'accepts a uuid' do
@@ -356,7 +380,7 @@ describe Routemaster::Client do
 
     it 'fails on HTTP error' do
       @stub.to_return(status: 500)
-      expect { perform }.to raise_error(RuntimeError)
+      expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'unsubscribe rejected (status: 500)')
     end
   end
 
@@ -376,7 +400,7 @@ describe Routemaster::Client do
 
     it 'fails on HTTP error' do
       @stub.to_return(status: 500)
-      expect { perform }.to raise_error(RuntimeError)
+      expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'unsubscribe all rejected (status: 500)')
     end
   end
 
@@ -403,58 +427,112 @@ describe Routemaster::Client do
 
     it 'fails on HTTP error' do
       @stub.to_return(status: 500)
-      expect { perform }.to raise_error(RuntimeError)
+      expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'failed to delete topic (status: 500)')
     end
   end
 
 
-  describe '#monitor_topics' do
+  context 'monitoring methods' do
+    let(:default_headers) {{}}
 
-    let(:perform) { subject.monitor_topics }
-    let(:expected_result) do
-      [
-        {
-          name: 'widgets',
-          publisher: 'demo',
-          events: 12589
-        }
-      ]
+    shared_context 'successful connection to bus' do
+      before do
+        @stub = stub_request(:get, url)
+          .with(basic_auth: [options[:uuid], 'x'], headers: default_headers)
+          .to_return(status: 200, body: expected_result.to_json)
+      end
     end
 
-    context 'the connection to the bus is successful' do
+    shared_context 'failing connection to bus' do
       before do
-        @stub = stub_request(:get, 'https://bus.example.com/topics').
-          with(basic_auth: [options[:uuid], 'x']).
-          with { |r|
-          r.headers['Content-Type'] == 'application/json'
-        }.to_return {
-          { status: 200, body: expected_result.to_json }
-        }
+        @stub = stub_request(:get, url)
+          .with(basic_auth: [options[:uuid], 'x'], headers: default_headers)
+          .to_return(status: 500)
       end
+    end
 
-      it 'expects a collection of topics' do
-        expect(perform.map(&:attributes)).to eql(expected_result)
+    describe '#monitor_topics' do
+      let(:url) { 'https://bus.example.com/topics' }
+      let(:perform) { subject.monitor_topics }
+      let(:expected_result) do
+        [
+          {
+            name: 'widgets',
+            publisher: 'demo',
+            events: 12589
+          }
+        ]
+      end
+
+      context 'the connection to the bus is successful' do
+          include_context 'successful connection to bus'
+
+        it 'expects a collection of topics' do
+          expect(perform.map(&:attributes)).to eql(expected_result)
+        end
+      end
+
+      context 'the connection to the bus errors' do
+          include_context 'failing connection to bus'
+
+        it 'expects a collection of topics' do
+          expect { perform }.to raise_error(Routemaster::Client::ConnectionError, 'failed to connect to /topics (status: 500)')
+        end
       end
     end
 
-    context 'the connection to the bus errors' do
-      before do
-        @stub = stub_request(:get, 'https://bus.example.com/topics').
-          with(basic_auth: [options[:uuid], 'x']).
-          with { |r|
-          r.headers['Content-Type'] == 'application/json'
-        }.to_return(status: 500)
+    describe '#monitor_subscriptions' do
+      let(:url) { 'https://bus.example.com/subscriptions' }
+      let(:perform) { subject.monitor_subscriptions }
+      let(:expected_result) do
+        [{
+          subscriber: 'bob',
+          callback:   'https://app.example.com/events',
+          topics:     ['widgets', 'kitten'],
+          events:     { sent: 1, queued: 100, oldest: 10_000 }
+        }]
       end
 
-      it 'expects a collection of topics' do
-        expect { perform }.to raise_error(RuntimeError)
+      context 'the connection to the bus is successful' do
+        include_context 'successful connection to bus'
+
+        it 'expects a collection of subscriptions' do
+          expect(perform.map(&:attributes)).to eql(expected_result)
+      end
+      end
+
+      context 'the connection to the bus errors' do
+        include_context 'failing connection to bus'
+
+        it 'expects a collection of topics' do
+          expect { perform }.to raise_error(Routemaster::Client::ConnectionError)
+        end
       end
     end
   end
-
-  describe '#monitor_subscriptions' do
-    it 'passes'
+  
+  describe '#reset_connection' do
+    context 'can reset class vars to change params' do
+      let(:instance_uuid) { SecureRandom.uuid }
+      let(:options) {{
+          url:        'https://@bus.example.com',
+          uuid:       instance_uuid,
+          verify_ssl: false,
+          lazy: true
+      }}
+      
+      before do
+          Routemaster::Client::Connection.reset_connection
+          @stub = stub_request(:get, 'https://@bus.example.com/topics').with({basic_auth: [instance_uuid, 'x']})
+          .to_return(status: 200, body: [{ name: "topic.name", publisher: "topic.publisher", events: "topic.get_count" }].to_json)
+      end
+      
+      after { Routemaster::Client::Connection.reset_connection }
+      
+      it 'connects with new params' do
+          subject.monitor_topics
+          expect(@stub).to have_been_requested
+      end
+    end
   end
-
 end
-