maitredee 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52dd1ef33db5eadd01dc66f0c26f37a7ac8b5d19bfe865ec0cae03535900fedb
-  data.tar.gz: d0b9a43bb7eab1208fd2ff3ba5668a65d2fb870d755cbd61fb41d84274e53521
+  metadata.gz: d1707193034f7c326212f91d003ce1fab80587ede4f5cc0c19bffbe3cf856d19
+  data.tar.gz: 226103487e3a17348f9e89d2a82b195e55cd07d5f3a404a8598da71dbcb15417
 SHA512:
-  metadata.gz: 24dd10b8944d88da64c2386e3660aa1cb1263523aa7e8ed0fa5ccfd430af698b787c49de230b8a8e9f402330a74e5de284bf5b9abb2fb5773e04a87f4136283d
-  data.tar.gz: 6e4ee09a3a305a2640bfb354031ae0000a121dba80c3bc303e7f8d68898ad234231757a3d7e1d6eb87afba2417e377e4547f66c5bc13de933f38aa1c76c4c15c
+  metadata.gz: f07e5f444fb7bd2869a20793fc5e06afd7d43a378a17ece9a0a5940ac8f88927e75b839992d3a13d1094b7b62c8022fedae4c70ef3260382a69095cfe5bb938a
+  data.tar.gz: 16e90e3d7fa22cd31f12ecd84212bb365efd397f793a1b5ed4b254448f67df5fc7fed8e89d7e784292b068ecc59e842d0dd6a7fd403e877e054ca5dd64efcb32

data/.circleci/config.yml

@@ -26,7 +26,7 @@ jobs:
   rspec:
     working_directory: ~/maitredee
     docker:
-      - image: circleci/ruby:2.5.1
+      - image: circleci/ruby:2.6.0
         environment: &docker_ruby_env
           RACK_ENV: test
           RAILS_ENV: test

data/.ruby-version

@@ -1 +1 @@
-2.5.3
+2.6.0

data/.yardopts

@@ -1 +1,3 @@
 --markup=markdown
+--hide-api private
+--no-private

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in maitredee.gemspec
 gemspec
+
+gem "yard"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    maitredee (0.8.3)
+    maitredee (0.8.4)
       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.127.0)
-    aws-sdk-core (3.44.1)
+    aws-partitions (1.129.0)
+    aws-sdk-core (3.44.2)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
@@ -68,7 +68,7 @@ GEM
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
-    json_schemer (0.1.9)
+    json_schemer (0.1.10)
       ecma-re-validator (~> 0.2.0)
       hana (~> 1.3.3)
       regexp_parser (~> 1.2.0)
@@ -116,7 +116,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    shoryuken (4.0.2)
+    shoryuken (4.0.3)
       aws-sdk-core (>= 2)
       concurrent-ruby
       thor
@@ -125,6 +125,7 @@ GEM
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     uri_template (0.7.0)
+    yard (0.9.16)
 
 PLATFORMS
   ruby
@@ -141,6 +142,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-mocks (~> 3.0)
+  yard
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -8,6 +8,7 @@ An opinionated pub/sub framework.
 - [Configuration](#configuration)
 - [Publisher](#publisher)
 - [Subscriber](#subscriber)
+- [Listening to messages](#listening-to-messages)
 - [Validation schema](#validation-schema)
 - [Misc](#misc)
     - [Development](#development)
@@ -22,6 +23,8 @@ We tried to have zero setup required to get this up and running and make it work
 
 We hope in the future to add more adapters beyond sns/sqs.
 
+For API docks visit https://www.rubydoc.info/gems/maitredee
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -84,49 +87,51 @@ You should reset the client at the beginning of every test with `Maitredee.clien
 
 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.
+Define an `#initialize` and `#process`. `#process` will get called when you execute the publisher.
+Call `#publish` from `#process` to publish messages. `#publish` will default the parameters `topic`, `event_name`, and `schema_name` from your `.publish_defaults` if not given.
 
 ```ruby goodread
 require "maitredee"
 
-class MyPublisher < Maitredee::Publisher
+class RecipePublisher < Maitredee::Publisher
   publish_defaults(
-    topic_name: :your_default_topic,
-    event_name: :your_default_event_name,
-    schema_name: :your_default_schema
+    topic_name: :default_topic,
+    event_name: :optional_default_event_name,
+    schema_name: :default_schema
   )
 
-  attr_reader :model
+  attr_reader :recipe
 
-  def initialize(model)
-    @model = model
+  def initialize(recipe)
+    @recipe = recipe
   end
 
   def process
     publish(
-      topic_name: :my_topic,
+      topic_name: :my_topic_override,
       event_name: :event_name_is_optional,
       schema_name: :schema_name,
       primary_key: "optionalKey",
       body: {
-        id: model.id,
-        name: model.name
+        id: recipe.id,
+        name: recipe.name
       }
     )
   end
 end
 ```
 
-
 ### Publishing a message
-To publish a message, simply call `call` on your publisher:
+To publish a message, simply call `.call` on your publisher:
 ```ruby
-MyPublisher.call(model)
+RecipePublisher.call(model)
 ```
 
-Publish will first validate your schema before publishing the message.
+By default `.call` delegate the arguments to `.new` then call `#process` and return `#published_messages` which is an array of published messages.
+
+`#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
+If you have ActiveJob configured you can also `#call_later` and it will be called asyncronously
 
 ## Subscriber
 
@@ -148,6 +153,12 @@ class RecipeSubscriber < Maitredee::Subscriber
     default_event to: :process
   end
 
+  # optional initializer to do message pre processing
+  # def initialize(message)
+  #   super
+  #   # do business here
+  # end
+
   def create
     Recipe.create!(message.body)
   end
@@ -162,6 +173,20 @@ class RecipeSubscriber < Maitredee::Subscriber
 end
 ```
 
+## Listening to messages
+We use shoryuken as our worker backend. Maitredee supports all shoryuken options except queues which is replace with subscribers.
+
+https://github.com/phstc/shoryuken/wiki/Shoryuken-options
+
+```yaml
+subscribers:
+  - RecipeSubscriber
+```
+
+```sh
+maitredee -s RecipeSubscriber 
+```
+
 ## 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.
 

data/lib/maitredee.rb

@@ -138,7 +138,7 @@ module Maitredee
       end
     end
 
-    # fetch configured app name or automatically fetch from Rails or from ENV["MAITREDEE_APP_NAME"]
+    # fetch configured app name or automatically fetch from Rails or from `ENV["MAITREDEE_APP_NAME"]`
     # used for generating queue_resource_name
     #
     # @return [String]
@@ -160,7 +160,7 @@ module Maitredee
     attr_writer :app_name
 
 
-    # fetch configured namespace or automatically fetch from ENV["MAITREDEE_NAMESPACE"]
+    # fetch configured namespace or automatically fetch from `ENV["MAITREDEE_NAMESPACE"]`
     # @return [String]
     def namespace
       @namespace ||=

data/lib/maitredee/active_job.rb

@@ -9,6 +9,7 @@ module Maitredee
       end
     end
 
+    # @api private
     def self.create_publisher_job(subclass)
       subclass.const_set("PublisherJob", Class.new(BasePublisherJob))
       subclass::PublisherJob.service_class = subclass
@@ -39,6 +40,7 @@ module Maitredee
       Maitredee::ActiveJob.create_publisher_job(subclass)
     end
 
+    # @private
     class BasePublisherJob < ::ActiveJob::Base
       class << self
         attr_accessor :service_class

data/lib/maitredee/adapters/sns_sqs_adapter.rb

@@ -194,6 +194,7 @@ module Maitredee
         POLICY
       end
 
+      # @private
       class Worker
         include Shoryuken::Worker
 

data/lib/maitredee/adapters/test_adapter.rb

@@ -21,4 +21,29 @@ module Maitredee
       end
     end
   end
+
+  class Subscriber
+    def self.test(
+      body:,
+      event_name: nil,
+      message_id: SecureRandom.uuid,
+      sent_at: Time.now,
+      primary_key: nil
+    )
+      message = SubscriberMessage.new(
+        topic_name: topic_name,
+        body: body,
+        event_name: event_name,
+        message_id: message_id,
+        sent_at: sent_at.to_i,
+        primary_key: primary_key,
+        schema_name: nil,
+        broker_message_id: message_id,
+        maitredee_version: Maitredee::VERSION,
+        raw_message: nil,
+        adapter_message: nil
+      )
+      process(message)
+    end
+  end
 end

data/lib/maitredee/cli/runner.rb

@@ -2,6 +2,7 @@ require "thor"
 require "shoryuken/runner"
 
 # ensures server configurations are executed
+# @private
 module Shoryuken
   module CLI
   end

data/lib/maitredee/publisher.rb

@@ -2,22 +2,36 @@ module Maitredee
   ##
   # Inherit from this class to easily publish messages:
   #
-  #   class RecipePublisher < Maitredee::Publisher
+  #     class RecipePublisher < Maitredee::Publisher
+  #       publish_defaults(
+  #         topic_name: :default_topic,
+  #         event_name: :optional_default_event_name,
+  #         schema_name: :default_schema
+  #       )
   #
-  #     def initialize(recipe)
-  #       @recipe = recipe
-  #     end
+  #       attr_reader :recipe
+  #
+  #       def initialize(recipe)
+  #         @recipe = recipe
+  #       end
   #
-  #     def process
-  #       # do some work
+  #       def process
+  #         publish(
+  #           topic_name: :my_topic_override,
+  #           event_name: :event_name_is_optional,
+  #           schema_name: :schema_name,
+  #           primary_key: "optionalKey",
+  #           body: {
+  #             id: recipe.id,
+  #             name: recipe.name
+  #           }
+  #         )
+  #       end
   #     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.
+  #     RecipePublisher.call(1, 2, 3)
   class Publisher
     class << self
       # call #process and return publishes messages

data/lib/maitredee/railtie.rb

@@ -1,6 +1,7 @@
 require "rails"
 
 module Maitredee
+  # @private
   class Railtie < Rails::Railtie
     initializer "maitredee.initialization" do |app|
       if defined? ActiveJob

data/lib/maitredee/subscriber.rb

@@ -4,21 +4,41 @@ 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
+  #     class RecipeSubscriber < Maitredee::Subscriber
+  #       # this is the topic name
+  #       subscribe_to :recipes do
   #
-  #     def update
-  #       # do some work
-  #     end
-  #   end
+  #         # this is the event name optionally say which method to use to process
+  #         event(:create, to: create)
+  #
+  #         # 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)
   #
-  # If you want to process a message manually
+  #         # you can specify a catch all route
+  #         default_event to: :process
+  #       end
   #
-  #   RecipePublisher.process()
+  #       # optional initializer to do message pre processing
+  #       # def initialize(message)
+  #       #   super
+  #       #   # do business here
+  #       # end
   #
-  # Note that `call` is a class method, `process` is an instance method.
+  #       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
   class Subscriber
     EventConfig = Struct.new(
       :action,

data/lib/maitredee/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: maitredee
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Plated Devs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -286,8 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Opinionated pub/sub framework