zaikio-loom 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83b8f848c42ce893f17ea2fcc965f607cbb2582de13d2cb6a5082937f4035d66
-  data.tar.gz: dcc33304f16d8e5b223ddd62d4edb339fc087cfb8f25b61a464a76e2f2a03a0c
+  metadata.gz: a73006847e32a2ba98ff3c5cc9dfd1639b9d0e198d1886f59eabf699f6872a11
+  data.tar.gz: 1706ee24ba6b90be47c15fa00ce8e889892fc6457c1a86267dcad091567b2654
 SHA512:
-  metadata.gz: 3f123c3dd9b2356b118593d3de86f78b7ef9307c0118b174a84b44b77acff372660e39b9bbe218c19ca19f3602c98e0d9fc6159d54a50314d7688a2d12322ea0
-  data.tar.gz: c612160d9ff55ebd84d2bc75d3d42549dfe6b0510f6dc57f43706cc4f5f2a3750fe7bb210a90fe898a36a15bcbf85076ac12dad73723d6483341dbca8be8934f
+  metadata.gz: 57bc16d2760ae45ea9518f5485226d0a3de33e41d71b1865acad56bd7728ef18ecd237ed84f716c3acbdf8867a2523bb907753fa5cab17cb0657cc85445d5c1c
+  data.tar.gz: 348db1e985341b8ce6faf351490ff3532add06bea87db825881f3806c1b0aa5cf719cc10594070eee1892ca0f85a0be208aabe874d3d9195420e8c5f428b96fa

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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

data/Gemfile.lock

@@ -1,68 +1,68 @@
 PATH
   remote: .
   specs:
-    zaikio-loom (0.3.0)
+    zaikio-loom (1.0.1)
       oj
       rails (~> 6.0, >= 6.0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.2)
-      actionpack (= 6.0.2.2)
+    actioncable (6.0.3.1)
+      actionpack (= 6.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    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.2.2)
-      actionpack (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
+    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.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    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.2.2)
-      actionpack (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    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.2.2)
-      activesupport (= 6.0.2.2)
+    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.2.2)
-      activesupport (= 6.0.2.2)
+    activejob (6.0.3.1)
+      activesupport (= 6.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activestorage (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
+    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.2.2)
+    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)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
@@ -77,7 +77,6 @@ GEM
     hashdiff (1.0.1)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     loofah (2.5.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -86,60 +85,64 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.4)
+    mimemagic (0.3.5)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.14.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.1.1)
+    parser (2.7.1.3)
       ast (~> 2.4.0)
     public_suffix (4.0.4)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.2)
-      actioncable (= 6.0.2.2)
-      actionmailbox (= 6.0.2.2)
-      actionmailer (= 6.0.2.2)
-      actionpack (= 6.0.2.2)
-      actiontext (= 6.0.2.2)
-      actionview (= 6.0.2.2)
-      activejob (= 6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activerecord (= 6.0.2.2)
-      activestorage (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    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.2.2)
+      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.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    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)
+    regexp_parser (1.7.0)
     rexml (3.2.4)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    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, < 2.0)
-    rubocop-performance (1.5.2)
+    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)
@@ -159,9 +162,9 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.2)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
     zeitwerk (2.3.0)
 
 PLATFORMS

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:
@@ -60,6 +78,16 @@ Zaikio::Loom.fire_event(
 
 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:
 
   - to provide a specific unique UUID or timestamp in the past or

data/lib/zaikio/loom.rb

@@ -1,3 +1,4 @@
+require "zaikio/loom/app_configuration"
 require "zaikio/loom/configuration"
 require "zaikio/loom/event"
 require "zaikio/loom/event_serializer"

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

@@ -9,12 +9,13 @@ module Zaikio
         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,6 +26,11 @@ module Zaikio
         @environment = env.to_sym
         @host = HOSTS[environment]
       end
+
+      def application(name)
+        @apps[name.to_s] = AppConfiguration.new(name.to_s)
+        yield(@apps[name.to_s])
+      end
     end
   end
 end

data/lib/zaikio/loom/event.rb

@@ -7,8 +7,8 @@ module Zaikio
     class Event
       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,7 +17,7 @@ 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
@@ -25,7 +25,7 @@ module Zaikio
       def fire # rubocop:disable Metrics/AbcSize
         log_event
 
-        return false unless configuration.password && configuration.host
+        return false unless app_password && configuration.host
 
         uri = URI("#{configuration.host}/api/v1/events")
 
@@ -57,9 +57,17 @@ module Zaikio
 
       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

data/lib/zaikio/loom/event_serializer.rb

@@ -10,7 +10,7 @@ module Zaikio
       end
 
       def deserialize(hash)
-        name = hash.delete("name").split(".").last
+        name = hash.delete("name")
         timestamp = DateTime.parse(hash.delete("timestamp"))
         hash.delete("_aj_serialized")
         Event.new(name, **hash.symbolize_keys.merge(timestamp: timestamp))

data/lib/zaikio/loom/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-loom
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - crispymtn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -166,6 +166,7 @@ files:
 - 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