zaikio-loom 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bb7acebd728d686d9b6ca9d7db2906da8321f996f5c091413828edfc057aeb2
+  data.tar.gz: a27a74f63adcc90f63ee16209686c6224d5fe0ed136f52728547122e07ef75b8
+SHA512:
+  metadata.gz: cfb47c5ecafaf51967105805b79d8bf367420035d4cb0fc5c87c4c7755d19ba08ace93f9386a410d699a41b8834b81bd82e819d19f933a7c034fe48744f23c6a
+  data.tar.gz: 8394db45c7038a37f684a0839362604c3760402e4ba144b055631610f2173de0304b2afe7e70c42c193a04d1f041e2525dc5bcfc30f4be07eed0e621d6752173

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - test/**/*.rb
+
+require:
+  - rubocop-performance
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+
+Layout/LineLength:
+  Max: 119 # line length on GitHub's PR pages
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - test/**/*.rb
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,12 @@
+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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Zaikio Loom Ruby Gem Changelog
+
+## 0.1.1 – 2020-01-29
+
+- Fixes an issue with URLS build on staging and in the sandbox
+
+## 0.1.0 (yanked)
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at op@crispymtn.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in zaikio-loom.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    zaikio-loom (0.1.0)
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    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)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    unicode-display_width (1.6.1)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  rubocop
+  rubocop-performance
+  webmock
+  zaikio-loom!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Crispy Mountain GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Zaikio Loom Ruby Gem
+
+The Zaikio Loom Ruby Gem simplifies publishing events on the Zaikio Loom event system.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zaikio-loom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zaikio-loom
+
+## Usage
+
+### Configuration
+
+To configure the gem 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
+
+  # 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')
+
+  # The version of the event's payload format and structure
+  config.version = '1.0'
+end
+```
+
+### Usage
+
+Firing events to Zaikio Loom:
+
+```ruby
+Zaikio::Loom.fire_event(
+  :event_name,
+  subject: 'Org/3a242896-fa57-41ba-997e-8c212d7157f3',
+  payload: { foo: 'bar', baz: [1, 2, 3] }
+)
+```
+
+This example would publish an event to Zaikio Loom with a random UUID and the current timestamp.
+
+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
+
+then you can use the method:
+
+```ruby
+event = Zaikio::Loom::Event.new(
+  :event_name,
+  subject: 'Org/3a242896-fa57-41ba-997e-8c212d7157f3',
+  id: 'f5cecfce-eda7-4eae-a0b2-62da7d51e8a2',
+  payload: { foo: 'bar', baz: [1, 2, 3] },
+  timestamp: Time.current,
+  version: '1.1.beta'
+)
+
+unless event.fire         # imaging the event_name does not exist
+  event.status_code       # => 422
+  event.response_body     # => '{ "errors": { "name": ["excludes a valid event name"] } }'
+end
+```
+
+### Required arguments
+
+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):
+
+  - the name of the event
+  - a `subject` that triggered the event
+
+Furtheremore, the payload can be omitted, but must be a hash when present.
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crispymtn/zai-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).
+
+## 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/crispymtn/zai-loom-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %w[test rubocop]

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zaikio/loom/configuration.rb

@@ -0,0 +1,40 @@
+require "logger"
+
+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"
+      }.freeze
+
+      attr_accessor :app_name, :password, :version
+      attr_reader :environment, :host
+      attr_writer :logger
+
+      def initialize
+        @environment = :sandbox
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def environment=(env)
+        @environment = env.to_sym
+        @host = host_for(environment)
+      end
+
+      private
+
+      def host_for(environment)
+        HOSTS.fetch(environment) do
+          raise StandardError.new, "Invalid Zaikio::Loom environment '#{environment}'"
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/loom/event.rb

@@ -0,0 +1,76 @@
+require "net/http"
+require "oj"
+require "securerandom"
+
+module Zaikio
+  module Loom
+    class Event
+      attr_reader :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}"
+        @id         = id || SecureRandom.uuid
+        @link       = link
+        @payload    = payload
+        @receiver   = receiver
+        @subject    = subject
+        @timestamp  = timestamp
+        @version    = version || configuration.version
+
+        return if configuration.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
+
+        uri = URI("#{configuration.host}/api/v1/events")
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+
+        response = http.request(build_request(uri))
+
+        @status_code   = response.code.to_i
+        @response_body = response.body
+
+        response.is_a?(Net::HTTPSuccess)
+      end
+
+      private
+
+      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.body         = event_as_json
+          request.content_type = "application/json"
+        end
+      end
+
+      def configuration
+        Zaikio::Loom.configuration
+      end
+
+      def event_as_json # rubocop:disable Metrics/MethodLength
+        timestamp = @timestamp || Time.now.getutc
+
+        Oj.dump(
+          {
+            event: {
+              id:        @id,
+              name:      @event_name,
+              subject:   @subject,
+              timestamp: timestamp.iso8601,
+              receiver:  @receiver,
+              version:   @version,
+              payload:   @payload,
+              link:      @link
+            }.compact
+          },
+          mode: :compat
+        )
+      end
+    end
+  end
+end

data/lib/zaikio/loom/version.rb

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

data/lib/zaikio/loom.rb

@@ -0,0 +1,21 @@
+require "zaikio/loom/configuration"
+require "zaikio/loom/event"
+require "zaikio/loom/version"
+
+module Zaikio
+  module Loom
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def self.fire_event(name, **args)
+      event = Event.new(name, **args)
+      event.fire
+    end
+  end
+end

data/zaikio-loom.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zaikio/loom/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "zaikio-loom"
+  spec.version  = Zaikio::Loom::VERSION
+
+  spec.authors  = ["crispymtn", "Martin Spickermann"]
+  spec.email    = ["op@crispymtn.com", "spickermann@gmail.com"]
+  spec.homepage = "https://github.com/crispymtn/zai-loom-ruby"
+  spec.license  = "MIT"
+  spec.summary  = "The Zaikio Loom Ruby Gem simplifies publishing events on the Zaikio Loom event system."
+
+  spec.metadata["changelog_uri"] = "https://github.com/crispymtn/zai-loom-ruby/blob/master/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "oj"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-loom
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- crispymtn
+- Martin Spickermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  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
+    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: rubocop
+  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: rubocop-performance
+  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: webmock
+  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'
+description: 
+email:
+- op@crispymtn.com
+- spickermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/zaikio/loom.rb
+- lib/zaikio/loom/configuration.rb
+- lib/zaikio/loom/event.rb
+- lib/zaikio/loom/version.rb
+- zaikio-loom.gemspec
+homepage: https://github.com/crispymtn/zai-loom-ruby
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/crispymtn/zai-loom-ruby/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/crispymtn/zai-loom-ruby
+  source_code_uri: https://github.com/crispymtn/zai-loom-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The Zaikio Loom Ruby Gem simplifies publishing events on the Zaikio Loom
+  event system.
+test_files: []