zaikio-loom 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1726071bcfc562e515cb666886cd6c2f1115a8e45e936a0cba4f24369a61c7c
-  data.tar.gz: 221fac1ee2179ef715cb0c00dfd4600e018d7c501339c10bb1dcae44396bb5c4
+  metadata.gz: 4c40d59217b146b0a725bb2c1eff33cd3964654b0ff448912a8835f0f008d74d
+  data.tar.gz: 3d7efdbff7c06ebb2cc31f21b86dd601ada4729b053119537e7e3cd6cd649e73
 SHA512:
-  metadata.gz: c0913c9a4e144f94467f57ec49f30ee7fe9dde081c9cb67de2bc0fc89678c4f3632848806cb35b0f12237502f2ade6060a62a9f6f4b3113bf4b6b36d0a7f832f
-  data.tar.gz: 505627a9530b3b2f7dd299f886f674c81344ce2fef1fb11dce2dee0c3fe95220111e9e7b915fda1ec59eb4ffb410ba18e0ab6c507580eb7b39303e5af0a0f141
+  metadata.gz: 3b9b9956472ffe125ef01cfc90177ec7353e95e24cbe8f63917cd8701667b0b584af2c8ced74041b8c747aa1f13365e747d40be970379b0e9a3462bcddb73f6e
+  data.tar.gz: 4ce68659710a41f514651bfd491704012dd9ad826d9e9967c2415c1e48790d4c0195cdc79a9f42c16ad0940b3f96079fe995ac64cef4ca20e0000d7da4d87b38

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   Exclude:
     - test/**/*.rb
   NewCops: enable

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## 1.4.0 - 2023-01-26
+
+- Support `staging` environment to allow internal testing
+- Require ruby > 3.0.0
+
 ## 1.3.1 - 2022-01-07
 
 - Permit Rails 7

data/Gemfile

@@ -6,4 +6,3 @@ gemspec
 gem "actionpack"
 gem "actionview"
 gem "activemodel"
-gem "sprockets-rails"

data/README.md

@@ -1,72 +1,51 @@
-# Zaikio Loom Ruby Gem
+# Zaikio Loom ruby gem
 
-The Zaikio Loom Ruby Gem simplifies publishing events on the Zaikio Loom event system.
+The Zaikio Loom ruby gem simplifies publishing events on the [Zaikio Loom event system](https://docs.zaikio.com/guide/loom/).
 
-Applications can only publish events to Zaikio Loom which have been configured in the Zaikio Directory. With a developer account in the Zaikio Directory you will find the list of provided events in your App's configuration in the Directory.
+Applications can only publish events to Loom which have been configured in the
+Zaikio Hub, on the "Provided events" tab under your App configuration.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem and add to the application's Gemfile by executing:
 
-```ruby
-gem 'zaikio-loom'
+```
+$ bundle add zaikio-loom
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+If bundler is not being used to manage dependencies, install the gem by executing:
 
     $ gem install zaikio-loom
 
 ## Usage
 
-### Configuration
-
-To configure the gem add an initializer to your application:
+To configure the gem, first add an initializer to your application:
 
 ```ruby
-# in config/initializers/zaikio_loom.rb
-Zaikio::Loom.configure do |config|
-  # Environment to which the gem should publish events to.
-  # Possible values: :sandbox (default), :production
-  config.environment = :sandbox
+# config/initializers/zaikio_loom.rb
 
-  # The name of your application like it is named in the directory of the
-  # choosen enviroment.
-  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'
 
+  # Loom instance to receive the events. Only `:sandbox` and `:production` will actually emit
+  # events, all other environments will merely log the output, this can be controlled by
+  # setting `config.logger`.
+  config.environment = Rails.env
+
+  # The name of your application, matches the "technical identifier" in the Hub
   config.application 'my_application' do |app|
+
+    # Your application's event password for the chosen environment
+    # Do not commit this password to version control.
     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
+  # The version of the event payload, format and structure
+  config.version = '1.0'
 end
 ```
 
-### Usage
-
-Firing events to Zaikio Loom:
+You can use multiple clients at once, just add a `config.application(name, &block)` for
+each one. Now, you can fire events at Zaikio Loom:
 
 ```ruby
 Zaikio::Loom.fire_event(
@@ -76,9 +55,9 @@ 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:
+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 include it as part of the event name:
 
 ```rb
 Zaikio::Loom.fire_event(
@@ -90,11 +69,11 @@ Zaikio::Loom.fire_event(
 
 If you need more control over the published event, for example:
 
-  - to provide a specific unique UUID or timestamp in the past or
-  - you want to override the version for this specific event or
-  - you want to check the Loom's response to this request
+  - to provide a specific unique UUID or timestamp in the past, or
+  - you want to override the version for this specific event, or
+  - you want to check Loom's response to this request
 
-then you can use the method:
+then you can use the underlying `Event` constructor and call `#fire` on it:
 
 ```ruby
 event = Zaikio::Loom::Event.new(
@@ -106,7 +85,7 @@ event = Zaikio::Loom::Event.new(
   version: '1.1.beta'
 )
 
-unless event.fire         # imaging the event_name does not exist
+unless event.fire         # imagine the event_name does not exist
   event.status_code       # => 422
   event.response_body     # => '{ "errors": { "name": ["excludes a valid event name"] } }'
 end
@@ -114,34 +93,47 @@ end
 
 ### Required arguments
 
-This gem is able to add some defaults or fallback values to the requests against the Loom API, for example
+This gem is able to add some defaults or fallback values to the requests against the Loom
+API, for example:
 
   - the app name,
   - an unique `id`,
   - the `version` or
   - the current `timestamp`.
 
-Nevertheless, the following arguments are required for every fired event and must follow the conventions described in the [Loom API Guide](https://docs.zaiku.com/guide/loom/posting-events.html#payload-requirements):
+Nevertheless, the following arguments are required for every fired event and must follow
+the conventions described in the
+[Loom API Guide](https://docs.zaikio.com/guide/loom/posting-events.html#payload-requirements):
 
   - the name of the event
   - a `subject` that triggered the event
 
-Furtheremore, the payload can be omitted, but must be a hash when present.
+Furthermore, the payload can be omitted, but must be set as a hash if given.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake
+spec` to run the tests.
 
-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).
+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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/zaikio/zaikio-loom-ruby. 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/zaikio/zaikio-loom-ruby. 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
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Zaikio Loom Ruby gem project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zaikio/zaikio-loom-ruby/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Zaikio Loom Ruby gem project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/zaikio/zaikio-loom-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/zaikio/loom/configuration.rb

@@ -5,6 +5,7 @@ module Zaikio
     class Configuration
       HOSTS = {
         test:       "http://loom.zaikio.test",
+        staging:    "https://loom.staging.zaikio.com",
         sandbox:    "https://loom.sandbox.zaikio.com",
         production: "https://loom.zaikio.com"
       }.freeze

data/lib/zaikio/loom/error.rb

@@ -2,10 +2,10 @@ module Zaikio
   module Loom
     class Error < StandardError
       attr_reader :body, :status_code
-      
+
       def initialize(message = nil, body:, status_code:)
         super(message)
-        
+
         @body = body
         @status_code = status_code
       end

data/lib/zaikio/loom/event.rb

@@ -22,7 +22,7 @@ module Zaikio
         configuration.logger.error("Zaikio::Loom is disabled – event password is missing")
       end
 
-      def fire # rubocop:disable Metrics/AbcSize
+      def fire # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
         log_event
 
         return false unless app_password && configuration.host
@@ -40,7 +40,7 @@ module Zaikio
         unless response.is_a?(Net::HTTPSuccess)
           raise Zaikio::Loom::Error.new(
             "Sending event failed (#{@status_code}): #{@response_body}",
-            body: @response_body,
+            body:        @response_body,
             status_code: @status_code
           )
         end

data/lib/zaikio/loom/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Loom
-    VERSION = "1.3.1".freeze
+    VERSION = "1.4.0".freeze
   end
 end

data/zaikio-loom.gemspec

@@ -24,10 +24,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activejob"
-  spec.add_dependency "nokogiri", ">= 1.11.0"
   spec.add_dependency "railties", ">= 6.0.2.3", "< 8"
   spec.add_runtime_dependency "oj"
-  spec.required_ruby_version = ">= 2.7.1"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-loom
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - crispymtn
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -25,20 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +197,7 @@ files:
 - ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -246,7 +233,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.1
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="