osbourne 0.1.3 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94cc1a3817307ef19a415268a6a00f8a68240191259e3f26f8a1576741d57378
-  data.tar.gz: fa5ed1ced8f45f6aa568aaaf66c59bb670e7df2952b55322d989175776c89a42
+  metadata.gz: 699bb698e3dae6272c3038bdc052597e0a6677e8f380bc1f64c12ae1c18c63a0
+  data.tar.gz: ca0bf27de44bff4a2e96755d0c041a73bbb75bc941c7166c44dfdd144630d3e1
 SHA512:
-  metadata.gz: '009ae71c9cd7c3d9e37920fe48ac5a5f66b9fb2f4b96e86ad4681d33358a2b8bad7d4dab5b165ac1313f866d86b449440a14b4095e7d27ae8d0d1303b5e27e42'
-  data.tar.gz: 825664fc5c5f5fca4b72e7757dbc47e7faae7aa67794260497c52c370ce8b51cdbf86e97e9c86d7cb0617294f16d6848259dc8af40df96263339905641e9610a
+  metadata.gz: b464098af275a72c4aa7a2ba600b1bdb709485f4ddaac98462f6513b8c2ae6930c9e8b8bdb478cf58618e39f1d224070957af61fa4633a4032e53ea0e10c3c9e
+  data.tar.gz: 32b5e08de9d525e95408525e0d9c0723383a33d3ac8aa688e323af9c49db1bbb15023e2fde9de099750e10a166770d58e3aba8826392702f61355bfd715bb308

data/README.md

@@ -1,5 +1,18 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/295897ee565c04ad1aa5/maintainability)](https://codeclimate.com/github/stevenallen05/osbourne/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/295897ee565c04ad1aa5/test_coverage)](https://codeclimate.com/github/stevenallen05/osbourne/test_coverage)
 
+- [Osbourne](#osbourne)
+    + [Features](#features)
+  * [Installation](#installation)
+    + [AWS credentials](#aws-credentials)
+    + [Production AWS](#production-aws)
+    + [Mock AWS for local devlopment](#mock-aws-for-local-devlopment)
+    + [RSpec](#rspec)
+  * [Usage](#usage)
+    + [Publishing a message](#publishing-a-message)
+    + [Generating a worker](#generating-a-worker)
+    + [Running workers](#running-workers)
+  * [License](#license)
+
 # Osbourne
 
 A fan-out pubsub message implementation for Rails 5. Named after the world's most famous plumber, Ozzy Osbourne.
@@ -11,6 +24,7 @@ A fan-out pubsub message implementation for Rails 5. Named after the world's mos
 * Worker generator via `rails g osbourne:worker worker_name topic`
 * Auto-provisioning of SQS queues, SNS topics, and subscriptions between them
 * Built-in support for locking to prevent accidental duplicate message delivery 
+* Test helpers
 
 Inspired heavily by the excellent Shoryuken & Circuitry gems
 
@@ -71,6 +85,51 @@ AWS_REGION=us-east-1
 
 There must be a region set. Use whichever is appropriate for your situation.
 
+### RSpec
+
+To turn on test mode, in your spec helper:
+
+```ruby
+  require 'osbourne/test'
+```
+
+This will enable test mode for provisioning and publishing. Example:
+
+```ruby
+  class TestWorker < Osbourne::WorkerBase
+    worker_config topics: %w[test_topic]
+
+    def process(message)
+      # Do stuff here...
+    end
+  end
+
+  RSpec.describe TestWorker do
+    subject(:worker) { described_class.new }
+
+    before do
+      # This will call `#publish` on `TestWorker`
+      Osbourne.publish('test_topic', 'message')
+    end
+  end
+
+```
+
+There is also a test `Message` object you can use and pass directly into your workers. It stubs out the message validation, and creates a mock `message` as if it had been broadcast from SNS.
+
+Example:
+
+```ruby
+
+let(:test_worker) { TestWorker.new }
+let(:message) { Osbourne::Test::Message.new(topic: "test", body: "thing") }
+
+# Now you can use `test_worker.process(message)` in your specs
+
+```
+
+
+
 ## Usage
 
 ### Publishing a message

data/lib/generators/osbourne/worker/templates/worker_template.template

@@ -5,7 +5,6 @@ class <%= name.singularize.camelcase %>Worker < Osbourne::WorkerBase
   worker_config topics: %w[<%= topic.join(" ") %>] #, max_batch_size: 10, max_wait: 10
 
   def process(message)
-    puts message.raw_body    # This will always be a string, representing the entirety of the message
     puts message.parsed_body # If the message came from a SNS broadcast,
                              #   as opposed to a direct SQS message, it will come from here 
     puts message.topic       # The topic this message was published to.

data/lib/osbourne.rb

@@ -25,10 +25,14 @@ module Osbourne
     attr_writer :sns_client, :sqs_client
 
     def sns_client
+      return if Osbourne.test_mode?
+
       @sns_client ||= Aws::SNS::Client.new(Osbourne.config.sns_config)
     end
 
     def sqs_client
+      return if Osbourne.test_mode?
+
       @sqs_client ||= Aws::SQS::Client.new(Osbourne.config.sqs_config)
     end
 

data/lib/osbourne/config/file_loader.rb

@@ -8,7 +8,7 @@ module Osbourne
   module Config
     module FileLoader
       def self.load(cfile, environment="development")
-        return nil unless File.exist?(cfile)
+        return false unless should_run?(cfile)
 
         base_opts = YAML.safe_load(ERB.new(IO.read(cfile)).result) || {}
         env_opts = base_opts[environment] || {}
@@ -17,6 +17,10 @@ module Osbourne
         Osbourne.config.sqs_config = env_opts["subscriber"].symbolize_keys || {}
         true
       end
+
+      def self.should_run?(cfile)
+        File.exist?(cfile) && !Osbourne.test_mode?
+      end
     end
   end
 end

data/lib/osbourne/config/shared_configs.rb

@@ -13,6 +13,18 @@ module Osbourne
         config.cache ||= ActiveSupport::Cache::NullStore.new
       end
 
+      def test_mode?
+        false
+      end
+
+      def test_mode!
+        @test_mode = true
+      end
+
+      def test_mode=(test_mode)
+        @test_mode = test_mode
+      end
+
       def dead_letter
         config.dead_letter ||= true
       end

data/lib/osbourne/launcher.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "osbourne"
-require "byebug"
 
 module Osbourne
   class Launcher

data/lib/osbourne/railtie.rb

@@ -13,8 +13,6 @@ module Osbourne
       %w[config/osbourne.yml.erb config/osbourne.yml].find do |filename|
         Osbourne::Config::FileLoader.load(filename, env)
       end
-
-      Osbourne.provision_worker_queues
     end
   end
 end

data/lib/osbourne/runner.rb

@@ -29,6 +29,7 @@ module Osbourne
       @launcher = Osbourne::Launcher.new
 
       begin
+        Osbourne.provision_worker_queues
         @launcher.start!
 
         while readable_io = IO.select([self_read]) # rubocop:disable Lint/AssignmentInCondition

data/lib/osbourne/services/queue_provisioner.rb

@@ -4,6 +4,8 @@ module Osbourne
   module Services
     module QueueProvisioner
       def provision_worker_queues
+        return if Osbourne.test_mode?
+
         Osbourne.logger.info "Workers found: #{Osbourne::WorkerBase.descendants.map(&:name).join(', ')}"
         Osbourne.logger.info "Provisioning queues for all workers"
 

data/lib/osbourne/test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "osbourne/test/mock_pubsub"
+require "osbourne/test/message"
+
+module Osbourne
+  class << self
+    def test_mode?
+      true
+    end
+
+    def publish(topic, message)
+      Osbourne::Test::MockPubsub.mock_publish(topic, message)
+    end
+  end
+end

data/lib/osbourne/test/message.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Osbourne
+  module Test
+    class Message
+      attr_reader :topic, :parsed_body
+      def initialize(topic:, body:)
+        @topic = topic
+        @parsed_body = body
+      end
+
+      def id
+        @id ||= SecureRandom.uuid
+      end
+
+      def valid?
+        true
+      end
+    end
+  end
+end

data/lib/osbourne/test/mock_pubsub.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "osbourne/test/message"
+module Osbourne
+  module Test
+    class MockPubsub
+      class << self
+        def mock_publish(topic, message)
+          Osbourne::WorkerBase.descendants.each do |worker|
+            msg = Osbourne::Test::Message.new(topic: topic, body: message)
+            worker.new.process(msg) if worker.config[:topic_names].include? topic
+          end
+        end
+      end
+    end
+  end
+end

data/lib/osbourne/topic.rb

@@ -14,6 +14,8 @@ module Osbourne
     end
 
     def publish(message)
+      return if Osbourne.test_mode?
+
       Osbourne.logger.info "[PUB] TOPIC: `#{name}` MESSAGE: `#{message}`"
       sns.publish(topic_arn: arn, message: message.is_a?(String) ? message : message.to_json)
     end
@@ -21,6 +23,8 @@ module Osbourne
     private
 
     def ensure_topic
+      return if Osbourne.test_mode?
+
       Osbourne.logger.debug "Ensuring topic `#{name}` exists"
       Osbourne.cache.fetch("osbourne_existing_topic_arn_for_#{name}") do
         sns.create_topic(name: name).topic_arn

data/lib/osbourne/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Osbourne
-  VERSION = "0.1.3"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,85 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: osbourne
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.2
 platform: ruby
 authors:
 - Steve Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sns
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,30 +136,30 @@ dependencies:
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -154,86 +178,98 @@ dependencies:
   name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -316,6 +352,9 @@ files:
 - lib/osbourne/services/sns.rb
 - lib/osbourne/services/sqs.rb
 - lib/osbourne/subscription.rb
+- lib/osbourne/test.rb
+- lib/osbourne/test/message.rb
+- lib/osbourne/test/mock_pubsub.rb
 - lib/osbourne/topic.rb
 - lib/osbourne/version.rb
 - lib/osbourne/worker_base.rb