maitredee 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61c90edbaf57c2a995ee3f92ee780235bb8af4421a446fa9bd10286101c80949
-  data.tar.gz: d118a9ee6cf0d03b22e46bdb8d271930ec444806a6aac071e27d496b1d952d22
+  metadata.gz: 52dd1ef33db5eadd01dc66f0c26f37a7ac8b5d19bfe865ec0cae03535900fedb
+  data.tar.gz: d0b9a43bb7eab1208fd2ff3ba5668a65d2fb870d755cbd61fb41d84274e53521
 SHA512:
-  metadata.gz: 024331eff27c916156ad6d878647e527a8fa50da23b451f8fe853b18e4b73b481bb6e65cf0dbd385dfd151b9b7d0f15c2d194a2c4ec16b36f6c3d59566b93334
-  data.tar.gz: 28b6af8d263162cb2ea0eff4bccb46671f5ccd173d7251fa2429c3d637aaec9ce643f993f1678d9c70738c71a78a6b20182327f879eb0d36c39d336a2c122185
+  metadata.gz: 24dd10b8944d88da64c2386e3660aa1cb1263523aa7e8ed0fa5ccfd430af698b787c49de230b8a8e9f402330a74e5de284bf5b9abb2fb5773e04a87f4136283d
+  data.tar.gz: 6e4ee09a3a305a2640bfb354031ae0000a121dba80c3bc303e7f8d68898ad234231757a3d7e1d6eb87afba2417e377e4547f66c5bc13de933f38aa1c76c4c15c

data/.circleci/config.yml

@@ -51,11 +51,23 @@ jobs:
       - run:
           name: run rspec tests
           command: |
-            bundle exec rspec --format progress
+            mkdir /tmp/test-results
+            bundle exec rspec \
+              --profile 10 \
+              --format progress
       - run:
           name: run sns/sqs tests
           command: |
             INTEGRATION_TEST=sns_sqs bundle exec rspec --format progress
+      - run:
+          name: run doctests
+          command: bundle exec goodread-rb README.md
+      # Collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
 workflows:
   version: 2
   build_and_test:

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maitredee (0.8.2)
+    maitredee (0.8.3)
       activesupport
       aws-sdk-sns
       aws-sdk-sqs
@@ -34,8 +34,8 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     aws-eventstream (1.0.1)
-    aws-partitions (1.122.0)
-    aws-sdk-core (3.44.0)
+    aws-partitions (1.127.0)
+    aws-sdk-core (3.44.1)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
@@ -50,6 +50,7 @@ GEM
     builder (3.2.3)
     byebug (10.0.2)
     coderay (1.1.2)
+    colorize (0.8.1)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
@@ -57,8 +58,12 @@ GEM
     ecma-re-validator (0.2.0)
       regexp_parser (~> 1.2)
     erubi (1.7.1)
+    gemoji (3.0.0)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    goodread (0.3.2)
+      colorize (~> 0.8)
+      gemoji (~> 3.0)
     hana (1.3.4)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
@@ -128,6 +133,7 @@ DEPENDENCIES
   activejob
   bundler (~> 1.17)
   dotenv
+  goodread
   maitredee!
   pry
   pry-byebug
@@ -137,4 +143,4 @@ DEPENDENCIES
   rspec-mocks (~> 3.0)
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/README.md

@@ -1,8 +1,26 @@
 # Maitredee
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/maitredee`. To experiment with that code, run `bin/console` for an interactive prompt.
+An opinionated pub/sub framework.
 
-TODO: Delete this and the text above, and describe your gem
+## Table of Contents
+- [Overview](#overview)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Publisher](#publisher)
+- [Subscriber](#subscriber)
+- [Validation schema](#validation-schema)
+- [Misc](#misc)
+    - [Development](#development)
+    - [Contributing](#contributing)
+    - [License](#license)
+    - [Code of Conduct](#code-of-conduct)
+
+## Overview
+We made maitredee to simplify publishing and subscribing to events for our junior developers. We tried using kafka but ordered eventing was too complicated.
+
+We tried to have zero setup required to get this up and running and make it work as simply as sidekiq.
+
+We hope in the future to add more adapters beyond sns/sqs.
 
 ## Installation
 
@@ -20,30 +38,169 @@ Or install it yourself as:
 
     $ gem install maitredee
 
-## Usage
+## Configuration
+
+Required Configuration
+```ruby
+Maitredee.namespace = "plated-production"
+Maitredee.schema_path = Rails.root.join("your/path").to_s
+Maitredee.client = :sns_sqs
+```
+
+These namespace can also be set with the environment variable `MAITREDEE_NAMESPACE`
+
+### Available clients
+
+Maitredee currently supports the following clients:
+
+#### SNS/SQS :sns_sqs
+You can set the AWS parameters in a variety of ways.
+Either environment variables or explicitly.
+Supported environment variables are `MAITREDEE_AWS_ACCESS_KEY_ID`, `MAITREDEE_AWS_SECRET_ACCESS_KEY`, `MAITREDEE_AWS_REGION` and then falls back to default AWS keys.
+
+if you wish to set it explicitly:
+```ruby
+Maitredee.set_client(
+  :sns_sqs,
+  access_key_id: "",
+  secret_access_key: "",
+  region: ""
+)
+```
+
+#### Test :test
+
+This is used for testing.
+
+```ruby
+Maitredee.client = :test
+```
+
+When you pubish anything through Maitredee it will be logged in the test client for test verification.
+
+You should reset the client at the beginning of every test with `Maitredee.client.reset`
+
+## Publisher
+
+Create a publisher class for your topic and inherit from `Maitredee::Publisher`
+Optionally define the default topic, event_name, or validation schema with `publish_defaults`
+Maitredee will call `process` on your publisher when it is called. Define a method `process` that calls `publish` with the parameters of your choosing.  `Publish` will default the `topic`, `event_name`, and `schema_name` from your publish_defaults if not given.
+
+```ruby goodread
+require "maitredee"
+
+class MyPublisher < Maitredee::Publisher
+  publish_defaults(
+    topic_name: :your_default_topic,
+    event_name: :your_default_event_name,
+    schema_name: :your_default_schema
+  )
+
+  attr_reader :model
+
+  def initialize(model)
+    @model = model
+  end
+
+  def process
+    publish(
+      topic_name: :my_topic,
+      event_name: :event_name_is_optional,
+      schema_name: :schema_name,
+      primary_key: "optionalKey",
+      body: {
+        id: model.id,
+        name: model.name
+      }
+    )
+  end
+end
+```
+
+
+### Publishing a message
+To publish a message, simply call `call` on your publisher:
+```ruby
+MyPublisher.call(model)
+```
+
+Publish will first validate your schema before publishing the message.
+
+If you have ActiveJob you can also `#call_later` and it will be called asyncronously
+
+## Subscriber
+
+```ruby
+class RecipeSubscriber < Maitredee::Subscriber
+  # this is the topic name
+  subscribe_to :recipes do
 
-TODO: Write usage instructions here
+    # this is the event name optionally say which method to use to process
+    event(:create, to: create)
 
-## Todo
+    # event_name will be used as the method name if it is a valid method name, otherwise to: must be set
+    event(:delete)
+
+    # for empty event name just use nil
+    event(nil, to: :process)
+
+    # you can specify a catch all route
+    default_event to: :process
+  end
+
+  def create
+    Recipe.create!(message.body)
+  end
+
+  def process
+    Recipe.find(message.body[:id]).update(message.body)
+  end
+
+  def delete
+    Recipe.find(message.body[:id]).destroy
+  end
+end
+```
+
+## Validating Schemas
+Maitredee validates your message body schemas using JSON schema ([JSON-schemer] (https://github.com/davishmcclurg/json_schemer)) for both publishing and consuming messages.  [Configure] (#configuration) the location of your schemas and provide a JSON file for each of your schemas.
+
+Example `recipe_v1.json`:
+```json
+{
+  "type": "object",
+  "required": ["id", "name", "servings"],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "type": "string"
+    },
+    "servings": {
+      "type": "number"
+    }
+  }
+}
+
+```
 
-* split into publisher/subscriber sub gems with monorepo
-* subscriber schema validation
-* maitredee/test helper methods for subscribers
+## Misc
 
-## Development
+### Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+### Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/maitredee. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/plated/maitredee. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## License
+### License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+### Code of Conduct
 
-Everyone interacting in the Maitredee project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/maitredee/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Maitredee project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/plated/maitredee/blob/master/CODE_OF_CONDUCT.md).

data/lib/maitredee.rb

@@ -9,15 +9,34 @@ require "pathname"
 require "maitredee/publisher"
 require "maitredee/subscriber"
 require "maitredee/version"
+require "maitredee/adapters/base_adapter"
 require "maitredee/adapters/sns_sqs_adapter"
 require "maitredee/railtie" if defined? ::Rails::Railtie
 
 module Maitredee
   class << self
-    attr_accessor :resource_name_suffix, :schema_path
+
+    # allows you to add a suffix to all your resource names, mostly used for testing but could be useful in other occassions.
+    # @return [String] string appended to all resource names
+    attr_accessor :resource_name_suffix
+
+    # this is the path of the folder in which validation_schema will try to do a lookup. This folder should contain json schemas.
+    # @return [String] path to folder
+    attr_accessor :schema_path
+
+    # the client we use for publishing and setting up workers
+    # @return [Maitredee::Adapters::AbstractAdapter]
     attr_reader :client
-    attr_writer :app_name, :namespace
 
+    # publishes messages using configured adapter
+    #
+    # @param topic [String] topic name
+    # @param body [Hash, Array, String] Any valid json data that can be validated by json-schema
+    # @param schema_name [String] A valid schema name for publishing data
+    # @param event_name [String, nil] Event name for subscriber routing
+    # @param primary_key [#to_s, nil] Key to be used for resource identification
+    #
+    # @return [PublisherMessage] published message
     def publish(
       topic_name:,
       body:,
@@ -44,15 +63,26 @@ module Maitredee
       message
     end
 
+    # configure the adapter, must be executed before loading subscribers
+    #
+    # @param slug [#to_s] name of adapter
+    # @param args [] options to send to the adapter
     def set_client(slug, *args)
       raise "No client set for Maitredee" if slug.nil?
       @client = "::Maitredee::Adapters::#{slug.to_s.camelize}Adapter".constantize.new(*args)
     end
 
+    # set a client without parameters
+    #
+    # @param slug [#to_s] name of adapter
     def client=(slug)
       set_client(slug)
     end
 
+    # build topic resource name from topic name
+    #
+    # @param topic_name [#to_s] topic name
+    # @return [String]
     def topic_resource_name(topic_name)
       [
         namespace,
@@ -61,6 +91,11 @@ module Maitredee
       ].compact.join("--")
     end
 
+    # build queue resource name from queue name and topic name
+    #
+    # @param topic_name [#to_s] topic name
+    # @param queue_name [#to_s] queue name
+    # @return [String]
     def queue_resource_name(topic_name, queue_name)
       [
         namespace,
@@ -75,6 +110,13 @@ module Maitredee
       end
     end
 
+    # validate a body given a schema name
+    #
+    # @param body [Array, Hash, String] data to send with message
+    # @param schema [String] string key to look up schema to validate against
+    #
+    # @raise [ValidationError] if validation fails
+    # @return [nil]
     def validate!(body, schema)
       errors = schemas[schema].validate(body.as_json)
       properties = errors.map do |error|
@@ -86,6 +128,9 @@ module Maitredee
       end
     end
 
+    # hash to look up schema based of schema_path
+    #
+    # @return Hash[JSONSchemer::Schema::Draft7]
     def schemas
       @schemas ||= Hash.new do |hash, key|
         path = Pathname.new(schema_path).join("#{key}.json")
@@ -93,6 +138,10 @@ module Maitredee
       end
     end
 
+    # fetch configured app name or automatically fetch from Rails or from ENV["MAITREDEE_APP_NAME"]
+    # used for generating queue_resource_name
+    #
+    # @return [String]
     def app_name
       @app_name ||=
         begin
@@ -106,11 +155,24 @@ module Maitredee
         end
     end
 
+    # set app_name instead of using default
+    # @param [String]
+    attr_writer :app_name
+
+
+    # fetch configured namespace or automatically fetch from ENV["MAITREDEE_NAMESPACE"]
+    # @return [String]
     def namespace
       @namespace ||=
         ENV["MAITREDEE_NAMESPACE"] || raise("must set namespace for maitredee")
     end
 
+    # set namespace instead of using default
+    # @param [String]
+    attr_writer :namespace
+
+    # idempotently configures broker to create topics, queues and subscribe queues to topics
+    # nothing will eveer be deleted or cleaned up
     def configure_broker
       hash_array = Hash.new { |hash, key| hash[key] = [] }
       topics_and_queues =
@@ -121,11 +183,13 @@ module Maitredee
       client.configure_broker(topics_and_queues)
     end
 
+    # @api private
     def register_subscriber(klass)
       client.add_worker(klass)
       subscriber_registry.add(klass)
     end
 
+    # @api private
     def subscriber_registry
       @subscriber_registry ||= Set.new
     end

data/lib/maitredee/active_job.rb

@@ -14,6 +14,16 @@ module Maitredee
       subclass::PublisherJob.service_class = subclass
     end
 
+    # Uses ActieJob to async the publishing
+    # @example To configure the specific async job open PublisherJob
+    #   class RecipePublisher < Maitredee::Publisher
+    #     class PublisherJob
+    #       queue_as :low
+    #     end
+    #   end
+    #
+    #   RecipePublisher.call_later(Recipe.find(1))
+    #
     def call_later(*args)
       self::PublisherJob.perform_later(*args)
     end

data/lib/maitredee/adapters/base_adapter.rb

@@ -0,0 +1,18 @@
+module Maitredee
+  module Adapters
+    class BaseAdapter
+      def publish(message)
+        raise NotImplementedError
+      end
+
+      def add_worker(subscriber_class)
+        raise NotImplementedError
+      end
+
+      def reset
+        raise NotImplementedError
+      end
+    end
+  end
+end
+

data/lib/maitredee/adapters/sns_sqs_adapter.rb

@@ -3,9 +3,15 @@ require "aws-sdk-sqs"
 
 module Maitredee
   module Adapters
-    class SnsSqsAdapter
+    class SnsSqsAdapter < BaseAdapter
       attr_reader :access_key_id, :secret_access_key, :region
 
+      # @param access_key_id [String] if `nil` will look in `ENV["MAITREDEE_AWS_ACCESS_KEY_ID"]`
+      # @param secret_access_key [String] if `nil` will look in `ENV["MAITREDEE_AWS_SECRET_ACCESS_KEY"]`
+      # @param region [String] if `nil` will look in `ENV["MAITREDEE_AWS_REGION"]`
+      # @param default_shoryuken_options [Hash] default options of the shoryuken job listening to the queues
+      #   defaults to `{ body_parser: :json, auto_delete: true }`
+
       def initialize(access_key_id: nil, secret_access_key: nil, region: nil, default_shoryuken_options: nil)
         @access_key_id = access_key_id || ENV["MAITREDEE_AWS_ACCESS_KEY_ID"]
         @secret_access_key = secret_access_key || ENV["MAITREDEE_AWS_SECRET_ACCESS_KEY"]
@@ -15,6 +21,8 @@ module Maitredee
         Shoryuken.sqs_client = sqs_client
       end
 
+      # publishes message to SNS
+      # @param message [PublisherMessage]
       def publish(message)
         message_attributes = {
           message_id: message.message_id,
@@ -32,6 +40,8 @@ module Maitredee
         )
       end
 
+      # creates topics from keys and queues from values, and subscribes queues to topics
+      # @param config [Hash{String => Array<String>}]
       def configure_broker(config)
         config.each do |topic_resource_name, queue_resource_names|
           queue_resource_names.each do |queue_resource_name|
@@ -43,6 +53,7 @@ module Maitredee
         end
       end
 
+      # @api private
       def topics
         @topics ||= Hash.new do |hash, key|
           topic = sns_client.create_topic(
@@ -52,6 +63,7 @@ module Maitredee
         end
       end
 
+      # @api private
       def queues
         @queues ||= Hash.new do |hash, key|
           queue_url = sqs_client.create_queue(queue_name: key).queue_url
@@ -59,10 +71,14 @@ module Maitredee
         end
       end
 
+      # @api private
       def subscriptions
         @subscriptions ||= {}
       end
 
+      # subscribes a queue to a topic
+      # @param queue_resource_name [String]
+      # @param topic_resource_name [String]
       def subscribe(queue_resource_name:, topic_resource_name:)
         topic = topics[topic_resource_name]
         queue = queues[queue_resource_name]
@@ -102,6 +118,7 @@ module Maitredee
         worker_class
       end
 
+      # @api private
       def default_shoryuken_options
         @default_shoryuken_options ||= {
           body_parser: :json,
@@ -109,6 +126,8 @@ module Maitredee
         }
       end
 
+      # deletes all topics, queues, and subscriptions
+      # @api private
       def reset
         [topics, queues, subscriptions].each do |resource|
           resource.values.each(&:delete)

data/lib/maitredee/adapters/test_adapter.rb

@@ -1,17 +1,21 @@
 module Maitredee
   module Adapters
-    class TestAdapter
+    class TestAdapter < BaseAdapter
+      # logs message published
       def publish(message)
         messages << message
       end
 
+      # returns all messages that have been published since last #reset
       def messages
         @messages ||= []
       end
 
+      # no-op
       def add_worker(subscriber_class)
       end
 
+      # resets messages logged
       def reset
         messages.clear
       end

data/lib/maitredee/publisher.rb

@@ -1,12 +1,37 @@
 module Maitredee
+  ##
+  # Inherit from this class to easily publish messages:
+  #
+  #   class RecipePublisher < Maitredee::Publisher
+  #
+  #     def initialize(recipe)
+  #       @recipe = recipe
+  #     end
+  #
+  #     def process
+  #       # do some work
+  #     end
+  #   end
+  #
+  # Then in your Rails app, you can do this:
+  #
+  #   RecipePublisher.call(1, 2, 3)
+  #
+  # Note that `call` is a class method, `process` is an instance method.
   class Publisher
     class << self
+      # call #process and return publishes messages
+      # @param args [] arguments passed to #initialize
       def call(*args)
         publisher = new(*args)
         publisher.process
         publisher.published_messages
       end
 
+      # set publish defaults
+      # @param topic_name [#to_s, nil]
+      # @param event_name [#to_s, nil]
+      # @param schema_name [#to_s, nil]
       def publish_defaults(topic_name: nil, event_name: nil, schema_name: nil)
         @publish_defaults = {
           topic_name: topic_name,
@@ -20,10 +45,18 @@ module Maitredee
       end
     end
 
+    # array of messages published in this instance
+    # @return [Array<PublisherMessage>]
     def published_messages
       @published_messages ||= []
     end
 
+    # publish a message with defaults
+    # @param topic_name [#to_s, nil]
+    # @param event_name [#to_s, nil]
+    # @param schema_name [#to_s, nil]
+    # @param primary_key [#to_s, nil]
+    # @param body [#to_json]
     def publish(topic_name: nil, event_name: nil, schema_name: nil, primary_key: nil, body:)
       defaults = self.class.get_publish_defaults
       published_messages << Maitredee.publish(

data/lib/maitredee/subscriber.rb

@@ -1,11 +1,28 @@
 require "shoryuken"
 
 module Maitredee
+  ##
+  # Inherit from this class to easily subscrive to messages:
+  #
+  #   class RecipeSubscriber < Maitredee::Subscriber
+  #     subscribe_to :recipes do
+  #       event(:update) # by default this calls the event_name, #delete
+  #     end
+  #
+  #     def update
+  #       # do some work
+  #     end
+  #   end
+  #
+  # If you want to process a message manually
+  #
+  #   RecipePublisher.process()
+  #
+  # Note that `call` is a class method, `process` is an instance method.
   class Subscriber
     EventConfig = Struct.new(
       :action,
       :event_name,
-      :minimum_schema,
       keyword_init: true
     )
 
@@ -16,25 +33,33 @@ module Maitredee
         @subscriber = subscriber
       end
 
-      def event(event_name, to: nil, minimum_schema: nil)
+      # configure subscriber to listen to event_name
+      # @param event_name [nil, #to_s]
+      # @param to [#to_s] must be valid method name
+      def event(event_name, to: nil)
         if event_name.nil? && to.nil?
           raise ArgumentError, "event_name and to: cannot both be nil"
         end
 
+        if event_name.present? && /[@$"]/ =~ event_name.to_sym.inspect && to.nil?
+          raise ArgumentError, "'#{event_name}' is not a valid method name, you must set the 'to' parameter"
+        end
+
         event_config = EventConfig.new(
           event_name: event_name.to_s,
-          action: (to || event_name).to_s,
-          minimum_schema: minimum_schema
+          action: (to || event_name).to_s
         )
 
         subscriber.event_configs[event_config.event_name] = event_config
       end
 
-      def default_event(to:, minimum_schema: nil)
+      # configure a default method to be called if not specifically configured to be listened to
+      # @param event_name [#to_s]
+      # @param to [#to_sym] must be valid method name
+      def default_event(to:)
         subscriber.event_configs.default = EventConfig.new(
           event_name: nil,
-          action: to.to_s,
-          minimum_schema: minimum_schema
+          action: to.to_s
         )
       end
     end
@@ -42,6 +67,30 @@ module Maitredee
     class << self
       attr_reader :topic_name
 
+      # configures Subscriber to which topic it should listen to and lets you configure events in the block
+      # @example subscribe to a topic
+      #   class RecipeSubscriber < Maitredee::Subscriber
+      #     subscribe_to :recipes do
+      #       event(:delete) # by default this calls the event_name, #delete
+      #       event(:update, to: :process) # events can be routed to different methods though
+      #       event(nil, to: :process) # subscribe without event names
+      #
+      #       default_event(to: :process) # this will default a catch all route
+      #     end
+      #
+      #     def delete
+      #       # do some work
+      #     end
+      #
+      #     def process
+      #       # do some work
+      #     end
+      #   end
+      #
+      # @see SubscriberProxy
+      # @param topic_name [#to_s]
+      # @param queue_name [#to_s] overide default generation from class name
+      # @param queue_resource_name [#to_s] overide default generation from queue_name and topic_name
       def subscribe_to(topic_name, queue_name: nil, queue_resource_name: nil, &block)
         @topic_name = topic_name
         @queue_name = queue_name if queue_name
@@ -57,18 +106,24 @@ module Maitredee
         Maitredee.register_subscriber(self)
       end
 
+      # @api private
       def event_configs
         @event_configs ||= {}
       end
 
+      # returns the queue_name set in .subscribe_to or is generated off the class name without `Subscriber`
       def queue_name
         @queue_name ||= name.chomp(Subscriber.name.demodulize).underscore.dasherize
       end
 
+      # Returns the resource name of the queue depending on the adapter
+      # @return [String]
       def queue_resource_name
         @queue_resource_name ||= Maitredee.queue_resource_name(topic_name, queue_name)
       end
 
+      # takes message and routes it based off SubscriberMessage#event_name
+      # @param message [SubscriberMessage]
       def process(message)
         event_config = event_configs[message.event_name.to_s]
         if event_config
@@ -77,8 +132,10 @@ module Maitredee
       end
     end
 
+    # @return [SubscriberMessage]
     attr_reader :message
 
+    # @param message [SubscriberMessage]
     def initialize(message)
       @message = message
     end

data/lib/maitredee/version.rb

@@ -1,3 +1,3 @@
 module Maitredee
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end

data/maitredee.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "goodread"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maitredee
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Plated Devs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: goodread
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +246,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -243,6 +258,7 @@ files:
 - exe/maitredee
 - lib/maitredee.rb
 - lib/maitredee/active_job.rb
+- lib/maitredee/adapters/base_adapter.rb
 - lib/maitredee/adapters/sns_sqs_adapter.rb
 - lib/maitredee/adapters/test_adapter.rb
 - lib/maitredee/cli/runner.rb
@@ -271,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Opinionated pub/sub framework