zaikio-loom 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bb7acebd728d686d9b6ca9d7db2906da8321f996f5c091413828edfc057aeb2
-  data.tar.gz: a27a74f63adcc90f63ee16209686c6224d5fe0ed136f52728547122e07ef75b8
+  metadata.gz: a73006847e32a2ba98ff3c5cc9dfd1639b9d0e198d1886f59eabf699f6872a11
+  data.tar.gz: 1706ee24ba6b90be47c15fa00ce8e889892fc6457c1a86267dcad091567b2654
 SHA512:
-  metadata.gz: cfb47c5ecafaf51967105805b79d8bf367420035d4cb0fc5c87c4c7755d19ba08ace93f9386a410d699a41b8834b81bd82e819d19f933a7c034fe48744f23c6a
-  data.tar.gz: 8394db45c7038a37f684a0839362604c3760402e4ba144b055631610f2173de0304b2afe7e70c42c193a04d1f041e2525dc5bcfc30f4be07eed0e621d6752173
+  metadata.gz: 57bc16d2760ae45ea9518f5485226d0a3de33e41d71b1865acad56bd7728ef18ecd237ed84f716c3acbdf8867a2523bb907753fa5cab17cb0657cc85445d5c1c
+  data.tar.gz: 348db1e985341b8ce6faf351490ff3532add06bea87db825881f3806c1b0aa5cf719cc10594070eee1892ca0f85a0be208aabe874d3d9195420e8c5f428b96fa

data/.circleci/config.yml

@@ -0,0 +1,33 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.5
+      - image: circleci/redis:3.2-alpine
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            gem install bundler:2.1.4 && bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            bundle exec rake test

data/.gitignore

@@ -6,3 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+.gem
+.DS_Store
+test/dummy/tmp
+test/dummy/log

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   TargetRubyVersion: 2.6
   Exclude:
     - test/**/*.rb
+  NewCops: enable
 
 require:
   - rubocop-performance

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Zaikio Loom Ruby Gem Changelog
 
+## 1.0.0 - 2020-06-03
+
+- Fix a bug in the event serializer
+
+## 1.0.0 - 2020-06-03
+
+- Add multi client support
+- Confguration format changed
+
+## 0.3.0 - 2020-04-22
+
+- Do not send events to Loom in development or staging environment
+
+## 0.2.1 - 2020-03-30
+
+- Fix bug with event serialization
+
+## 0.2.0 - 2020-03-30
+
+- Events are now fired in background with ActiveJob.
+
 ## 0.1.1 – 2020-01-29
 
 - Fixes an issue with URLS build on staging and in the sandbox

data/Gemfile.lock

@@ -1,43 +1,171 @@
 PATH
   remote: .
   specs:
-    zaikio-loom (0.1.0)
+    zaikio-loom (1.0.1)
       oj
+      rails (~> 6.0, >= 6.0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.1)
+      actionview (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.1)
+      activesupport (= 6.0.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activerecord (6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activestorage (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    hashdiff (1.0.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    oj (3.10.1)
+    crass (1.0.6)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hashdiff (1.0.1)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    mocha (1.11.2)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    oj (3.10.6)
     parallel (1.19.1)
-    parser (2.7.0.2)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.4)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.1)
+      actioncable (= 6.0.3.1)
+      actionmailbox (= 6.0.3.1)
+      actionmailer (= 6.0.3.1)
+      actionpack (= 6.0.3.1)
+      actiontext (= 6.0.3.1)
+      actionview (= 6.0.3.1)
+      activejob (= 6.0.3.1)
+      activemodel (= 6.0.3.1)
+      activerecord (= 6.0.3.1)
+      activestorage (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.1)
+      actionpack (= 6.0.3.1)
+      activesupport (= 6.0.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    rubocop (0.79.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rubocop (0.85.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.5.2)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.0)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    unicode-display_width (1.6.1)
-    webmock (3.8.0)
+    sprockets (4.0.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    websocket-driver (0.7.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -45,6 +173,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   minitest
+  mocha
   rake
   rubocop
   rubocop-performance
@@ -52,4 +181,4 @@ DEPENDENCIES
   zaikio-loom!
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -35,17 +35,35 @@ Zaikio::Loom.configure do |config|
 
   # The name of your application like it is named in the directory of the
   # choosen enviroment.
-  config.app_name = 'my_application'
-
-  # Your application's event password for the choosen environment
-  # Do not add this password into version control.
-  config.password = ENV.fetch('ZAIKIO_LOOM_PASSWORD')
+  config.application 'my_application' do |app|
+    # Your application's event password for the choosen environment
+    # Do not add this password into version control.
+    app.password = ENV.fetch('ZAIKIO_LOOM_PASSWORD')
+  end
 
   # The version of the event's payload format and structure
   config.version = '1.0'
 end
 ```
 
+#### Multiple Clients
+
+```ruby
+# in config/initializers/zaikio_loom.rb
+Zaikio::Loom.configure do |config|
+  config.environment = :sandbox
+  config.version = '1.0'
+
+  config.application 'my_application' do |app|
+    app.password = ENV.fetch('ZAIKIO_LOOM_PASSWORD')
+  end
+
+  config.application 'my_other_app' do |app|
+    app.password = ENV.fetch('ZAIKIO_LOOM_OTHER_APP_PASSWORD')
+  end
+end
+```
+
 ### Usage
 
 Firing events to Zaikio Loom:
@@ -58,7 +76,17 @@ Zaikio::Loom.fire_event(
 )
 ```
 
-This example would publish an event to Zaikio Loom with a random UUID and the current timestamp.
+This example would publish an event (in the background) to Zaikio Loom with a random UUID and the current timestamp.
+
+If you want to publish the event for a specific client, you have to add it as part of the event name:
+
+```rb
+Zaikio::Loom.fire_event(
+  'my_other_app.event_name',
+  subject: 'Org/3a242896-fa57-41ba-997e-8c212d7157f3',
+  payload: { foo: 'bar', baz: [1, 2, 3] }
+)
+```
 
 If you need more control over the published event, for example:
 

data/app/jobs/zaikio/loom/fire_event_job.rb

@@ -0,0 +1,9 @@
+module Zaikio
+  module Loom
+    class FireEventJob < ApplicationJob
+      def perform(event)
+        event.fire
+      end
+    end
+  end
+end

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/config/initializers/register_zaikio_loom_event_serializer.rb

@@ -0,0 +1 @@
+Rails.application.config.active_job.custom_serializers << Zaikio::Loom::EventSerializer

data/lib/zaikio/loom.rb

@@ -1,5 +1,9 @@
+require "zaikio/loom/app_configuration"
 require "zaikio/loom/configuration"
 require "zaikio/loom/event"
+require "zaikio/loom/event_serializer"
+require "zaikio/loom/railtie"
+require "zaikio/loom/engine"
 require "zaikio/loom/version"
 
 module Zaikio
@@ -15,7 +19,7 @@ module Zaikio
 
     def self.fire_event(name, **args)
       event = Event.new(name, **args)
-      event.fire
+      FireEventJob.perform_later(event)
     end
   end
 end

data/lib/zaikio/loom/app_configuration.rb

@@ -0,0 +1,11 @@
+module Zaikio
+  module Loom
+    class AppConfiguration
+      attr_accessor :app_name, :password
+
+      def initialize(app_name)
+        @app_name = app_name
+      end
+    end
+  end
+end

data/lib/zaikio/loom/configuration.rb

@@ -4,19 +4,18 @@ module Zaikio
   module Loom
     class Configuration
       HOSTS = {
-        development: "http://loom.zaikio.test",
-        test:        "http://loom.zaikio.test",
-        staging:     "https://loom.staging.zaikio.com",
-        sandbox:     "https://loom.sandbox.zaikio.com",
-        production:  "https://loom.zaikio.com"
+        test:       "http://loom.zaikio.test",
+        sandbox:    "https://loom.sandbox.zaikio.com",
+        production: "https://loom.zaikio.com"
       }.freeze
 
-      attr_accessor :app_name, :password, :version
-      attr_reader :environment, :host
+      attr_accessor :version
+      attr_reader :environment, :host, :apps
       attr_writer :logger
 
       def initialize
         @environment = :sandbox
+        @apps = {}
       end
 
       def logger
@@ -25,15 +24,12 @@ module Zaikio
 
       def environment=(env)
         @environment = env.to_sym
-        @host = host_for(environment)
+        @host = HOSTS[environment]
       end
 
-      private
-
-      def host_for(environment)
-        HOSTS.fetch(environment) do
-          raise StandardError.new, "Invalid Zaikio::Loom environment '#{environment}'"
-        end
+      def application(name)
+        @apps[name.to_s] = AppConfiguration.new(name.to_s)
+        yield(@apps[name.to_s])
       end
     end
   end

data/lib/zaikio/loom/engine.rb

@@ -0,0 +1,9 @@
+module Zaikio
+  module Loom
+    class Engine < ::Rails::Engine
+      isolate_namespace Zaikio::Loom
+      engine_name "zaikio_loom"
+      config.generators.api_only = true
+    end
+  end
+end

data/lib/zaikio/loom/event.rb

@@ -5,10 +5,10 @@ require "securerandom"
 module Zaikio
   module Loom
     class Event
-      attr_reader :status_code, :response_body
+      attr_reader :id, :status_code, :response_body
 
-      def initialize(name, subject:, id: nil, link: nil, payload: nil, receiver: nil, timestamp: nil, version: nil) # rubocop:disable Metrics/ParameterLists
-        @event_name = "#{configuration.app_name}.#{name}"
+      def initialize(name, subject:, id: nil, link: nil, payload: nil, receiver: nil, timestamp: nil, version: nil) # rubocop:disable Metrics/AbcSize, Metrics/ParameterLists
+        @event_name = name.to_s.count(".").zero? ? "#{configuration.apps.values.first.app_name}.#{name}" : name.to_s
         @id         = id || SecureRandom.uuid
         @link       = link
         @payload    = payload
@@ -17,13 +17,15 @@ module Zaikio
         @timestamp  = timestamp
         @version    = version || configuration.version
 
-        return if configuration.password
+        return if app_password
 
         configuration.logger.error("Zaikio::Loom is disabled – event password is missing")
       end
 
       def fire # rubocop:disable Metrics/AbcSize
-        return false unless configuration.password && configuration.host
+        log_event
+
+        return false unless app_password && configuration.host
 
         uri = URI("#{configuration.host}/api/v1/events")
 
@@ -38,11 +40,34 @@ module Zaikio
         response.is_a?(Net::HTTPSuccess)
       end
 
+      def to_h # rubocop:disable Metrics/MethodLength
+        timestamp = @timestamp || Time.now.getutc
+
+        {
+          id:        @id,
+          name:      @event_name,
+          subject:   @subject,
+          timestamp: timestamp.iso8601,
+          receiver:  @receiver,
+          version:   @version,
+          payload:   @payload,
+          link:      @link
+        }.compact
+      end
+
       private
 
+      def app_name
+        @event_name.split(".").first
+      end
+
+      def app_password
+        configuration.apps[app_name].password
+      end
+
       def build_request(uri)
         Net::HTTP::Post.new(uri, "User-Agent" => "zaikio-loom:#{Zaikio::Loom::VERSION}").tap do |request|
-          request.basic_auth(configuration.app_name, configuration.password)
+          request.basic_auth(app_name, app_password)
           request.body         = event_as_json
           request.content_type = "application/json"
         end
@@ -52,24 +77,12 @@ module Zaikio
         Zaikio::Loom.configuration
       end
 
-      def event_as_json # rubocop:disable Metrics/MethodLength
-        timestamp = @timestamp || Time.now.getutc
+      def event_as_json
+        @event_as_json ||= Oj.dump({ event: to_h }, mode: :compat)
+      end
 
-        Oj.dump(
-          {
-            event: {
-              id:        @id,
-              name:      @event_name,
-              subject:   @subject,
-              timestamp: timestamp.iso8601,
-              receiver:  @receiver,
-              version:   @version,
-              payload:   @payload,
-              link:      @link
-            }.compact
-          },
-          mode: :compat
-        )
+      def log_event
+        configuration.logger.info("Zaikio::Loom event\n#{event_as_json}")
       end
     end
   end

data/lib/zaikio/loom/event_serializer.rb

@@ -0,0 +1,20 @@
+module Zaikio
+  module Loom
+    class EventSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize?(argument)
+        argument.is_a? Event
+      end
+
+      def serialize(event)
+        super(event.to_h.stringify_keys)
+      end
+
+      def deserialize(hash)
+        name = hash.delete("name")
+        timestamp = DateTime.parse(hash.delete("timestamp"))
+        hash.delete("_aj_serialized")
+        Event.new(name, **hash.symbolize_keys.merge(timestamp: timestamp))
+      end
+    end
+  end
+end

data/lib/zaikio/loom/railtie.rb

@@ -0,0 +1,6 @@
+module Zaikio
+  module Loom
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/zaikio/loom/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Loom
-    VERSION = "0.1.1".freeze
+    VERSION = "1.0.1".freeze
   end
 end

data/zaikio-loom.gemspec

@@ -24,9 +24,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "oj"
+  spec.add_dependency "rails", "~> 6.0", ">= 6.0.2.2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-performance"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-loom
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors:
 - crispymtn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -25,6 +25,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +73,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,9 +151,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -127,10 +161,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/jobs/zaikio/loom/fire_event_job.rb
 - bin/setup
+- bin/test
+- config/initializers/register_zaikio_loom_event_serializer.rb
 - lib/zaikio/loom.rb
+- lib/zaikio/loom/app_configuration.rb
 - lib/zaikio/loom/configuration.rb
+- lib/zaikio/loom/engine.rb
 - lib/zaikio/loom/event.rb
+- lib/zaikio/loom/event_serializer.rb
+- lib/zaikio/loom/railtie.rb
 - lib/zaikio/loom/version.rb
 - zaikio-loom.gemspec
 homepage: https://github.com/crispymtn/zai-loom-ruby

data/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-  - 2.7.0
-
-before_install: gem install bundler -v 2.0.2
-
-script:
-  - bundle exec rspec
-  - bundle exec rubocop