ubersicht-ruby-sdk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c517f3a08f30c20b2f5f3a219547519c797a91b2b8bc167dc838b24607a4d9f
+  data.tar.gz: dce099aceebd7d36c2dcac19ed007a2f8cf432db81d0ddbe5c5b14a3744327ad
+SHA512:
+  metadata.gz: 0f62f52d9d9ff24342861466cd4d2ebdefd193cb7940e051152b77d0a62f68d8b8f9df5658ed53db5bd6bb1d75b235c96d4764c7ebbd391618594e89866a9853
+  data.tar.gz: 833078838952d0a4fb62f656578f0d7c351a77e8869c2dbc920d7a6695de142926596d9bf0e11658bf8c9d0b7d69747c631d09aa504bcca983268295bd488fee

data/.github/workflows/test.yml

@@ -0,0 +1,63 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    strategy:
+      matrix:
+        ruby-version: ["3.0.2"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run rubocop
+        run: bundle exec rubocop
+  rspec:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    strategy:
+      matrix:
+        ruby-version: ["3.0.2"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run rspec
+        run: bundle exec rspec
+      - name: Simplecov Report
+        uses: aki77/simplecov-report-action@v1
+        with:
+          failedThreshold: 95
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload coverage results
+        uses: actions/upload-artifact@master
+        if: always()
+        with:
+          name: coverage-report
+          path: coverage

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,58 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_mode:
+  merge:
+    - Include
+
+AllCops:
+  Include:
+    - "**/*.gemspec"
+    - "**/*.rake"
+    - "**/Gemfile"
+    - "**/Rakefile"
+  Exclude:
+    - "bin/**/*"
+    - "config.ru"
+    - "vendor/bundle/**/*" # for CI
+  CacheRootDirectory: tmp/cache/rubocop_cache/
+  TargetRubyVersion: '2.6'
+  DefaultFormatter: fuubar
+  NewCops: enable
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 2
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/BlockLength:
+  Enabled: false
+
+Performance/MethodObjectAsBlock:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## Not released
+## 0.2.0
+
+- [ingestion] added `event.payload.event_id` to prevent events duplication on Ubersicht side
+- [ingestion] added `event.payload.event_id` to event signature
+- [ingestion] added `debug` option to ingestion client. If false then request will be ran in a new thread.
+
+Braking changes:
+
+- [ingestion] replaced `ingest` signature to keywords
+- [ingestion] renamed `event.type` with `event.transaction_type`
+- [ingestion] replaced `clien.ingest_events(events)` with `clien.ingest(event)`
+
+## 0.1.0
+
+- [ingestion] added Ubersicht::Ingestion::Client#ingest_events
+- [ingestion] added signature to event payload, `payload.signature`
+- [ingestion] added validaton of event type based on types allowed for provider

data/Dockerfile

@@ -0,0 +1,24 @@
+# Dockerfile
+# Use ruby image to build our own image
+FROM ruby:3.0.2
+
+ARG APP_ROOT=/app
+ARG BUILD_PACKAGES="\
+    vim \
+    "
+
+# token for fetching private gems https://www.surminus.com/blog/installing-private-gems-during-a-docker-build/
+ARG BUNDLE_GITHUB__COM
+
+# We specify everything will happen within the /app folder inside the container
+WORKDIR $APP_ROOT
+
+ENV PATH="${APP_ROOT}/bin:${PATH}"
+
+RUN apt-get update -qq && apt-get install -y --fix-missing --no-install-recommends $BUILD_PACKAGES && \
+    apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# We install all the dependencies
+# RUN bundle config set jobs "$(getconf _NPROCESSORS_ONLN)" && \
+#     bundle config set path /usr/local/bundle && \
+#     bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ubersicht-ruby-sdk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    ubersicht-ruby-sdk (0.2.0)
+      dry-struct (~> 1.0)
+      faraday (>= 0.9.2, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    faraday (1.7.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashdiff (1.0.1)
+    ice_nine (0.11.2)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.0)
+  rubocop-performance (~> 1.0)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.0)
+  simplecov (~> 0.1)
+  ubersicht-ruby-sdk!
+  webmock
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 starfish.codes
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vadim Lazebny
+
+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,90 @@
+# Ubersicht API library for Ruby
+
+This is the officially supported Ruby library for using Ubersicht's APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ubersicht-ruby-sdk', git: 'https://github.com/starfish-codes/ubersicht-ruby-sdk.git',
+                          branch: 'main', require: 'ubersicht'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ubersicht-ruby-sdk
+
+## Usage
+
+### Ingestion
+
+Build client:
+
+```sh
+  client = Ubersicht::Ingestion::Client.new(
+    hmac_key: '44782DEF547AAA06C910C43932B1EB0C71FC68D9D0C057550C48EC2ACF6BA056',
+    account_id: '1001',
+    pass: 'password',
+    provider: 'DAuth',
+    url: '<api-base-url>',
+    user: 'user',
+    debug: true
+  )
+```
+
+Parameters:
+
+* `hmac_key` - (required) used for signing notification on client side and validation on server side (Ubersicht plugin config)
+* `account_id` - (required) account which receives notification events
+* `pass` - (required) basic auth password (Ubersicht plugin config)
+* `user` - (required) basic auth username (Ubersicht plugin config)
+* `provider` - (required) plugin provider in Ubersicht platform, e.g. DAuth
+* `url` - (required) Ubersicht API root url. Different for production and testing environment.
+* `debug` - (optional) default=false. If true then request is performed in the current thread, if false then new thread is created.
+
+Send event:
+
+```sh
+  event = {
+    # required
+    transaction_type: 'DeviceBinding'
+    event_code: 'REQUESTED',
+    # optional
+    event_date: 2021-10-10 10:10:10,
+    event_group_id: 'eb2bc8bb-f584-4801-b98c-361a0c2d38f8',
+    event_id: 'ed62d0c1-f2a5-41b7-ab58-24c033eec508',,
+  }
+  client.ingest(**event)
+```
+
+Event attributes:
+
+* `transaction_type` (required) - a process or resource to which event belongs, e.g. DeviceBinding, Authentication
+* `event_code` (required) - string identifier of a transition
+* `event_date` - time when event was triggered
+* `event_group_id` - correlated transaction id (allows to link some events together)
+* `event_id` - unique event identifier (allows to silence duplicated events)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/[USERNAME]/ubersicht-ruby-sdk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ubersicht'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3.8"
+services:
+  gem:
+    container_name: ubersicht_ruby_sdk
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - ./:/app
+      - ~/.gitconfig:/etc/gitconfig # allows to create commits inside container
+      - bundle_path:/usr/local/bundle
+    stdin_open: true
+    tty: true
+volumes:
+  bundle_path:

data/lib/ubersicht/ingestion/build_ingestion_event.rb

@@ -0,0 +1,33 @@
+module Ubersicht
+  module Ingestion
+    class BuildIngestionEvent
+      def self.call(*args, &block)
+        new.call(*args, &block)
+      end
+
+      def initialize
+        @validate_hmac = ::Ubersicht::Ingestion::HmacValidator.with_ubersicht
+        @event_class = ::Ubersicht::Ingestion::Event
+      end
+
+      def call(event, hmac_key, provider)
+        validate_transaction_type(event[:transaction_type], provider)
+
+        attrs = @event_class.new(event).to_h
+        attrs[:payload][:hmac_signature] = @validate_hmac.calculate_notification_hmac(attrs, hmac_key)
+        attrs[:provider] = provider
+        attrs
+      rescue ::Dry::Struct::Error => e
+        raise ::Ubersicht::ValidationError, e.message
+      end
+
+      private
+
+      def validate_transaction_type(transaction_type, provider)
+        return if (types = ::Ubersicht::Ingestion::PROVIDER_TO_TYPES_MAP[provider]).include?(transaction_type)
+
+        raise Ubersicht::Error, "Unknown type '#{transaction_type}'. #{provider} supports only #{types.join(', ')}." \
+      end
+    end
+  end
+end

data/lib/ubersicht/ingestion/client.rb

@@ -0,0 +1,86 @@
+module Ubersicht
+  module Ingestion
+    class Client
+      def self.default(*args)
+        new(*args) do |faraday|
+          faraday.request :url_encoded
+          # faraday.response :raise_error
+          faraday.response :logger, Logger.new($stdout),
+                           headers: { request: false, response: false },
+                           bodies: { request: true, response: true }
+          faraday.adapter  Faraday.default_adapter # make requests with Net::HTTP
+        end
+      end
+
+      def initialize(options = {}, &block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+        raise ArgumentError, 'Account id cannot be blank' if empty?(account_id = options[:account_id])
+        raise ArgumentError, 'Hmac key cannot be blank' if empty?(hmac_key = options[:hmac_key])
+        raise ArgumentError, 'Password cannot be blank' if empty?(pass = options[:pass])
+        raise ArgumentError, 'Url cannot be blank' if empty?(url = options[:url])
+        raise ArgumentError, 'Username cannot be blank' if empty?(user = options[:user])
+        unless ::Ubersicht::Ingestion::PROVIDERS.include?(provider = options[:provider])
+          raise ArgumentError, "Not supported provider '#{provider}'"
+        end
+
+        @account_id = account_id
+        @debug = options[:debug] || false
+        @hmac_key = hmac_key
+        @provider = provider
+        @conn = setup_conn(url, user, pass, &block)
+      end
+
+      def ingest(transaction_type:, event_code:, event_date: Time.now, **payload)
+        event = {
+          event_code: event_code,
+          event_date: event_date.iso8601(3),
+          payload: payload,
+          transaction_type: transaction_type
+        }
+        ingest_events([event])
+      end
+
+      private
+
+      attr_reader :account_id, :debug, :hmac_key, :provider
+
+      def ingest_events(events)
+        body = {
+          events: events.map { |event| ::Ubersicht::Ingestion::BuildIngestionEvent.call(event, hmac_key, provider) }
+        }
+        url = "accounts/#{account_id}/plugins/#{provider.downcase}/notification_webhooks"
+        process { handle_response(@conn.post(url, body.to_json)) }
+      end
+
+      def process(&block)
+        return yield if debug
+
+        Thread.new(&block)
+        nil
+      end
+
+      def handle_response(response)
+        case response.status
+        when 200..299
+          response.body
+        when 300..599
+          raise ::Ubersicht::Error, response.body
+        end
+      end
+
+      def empty?(value)
+        value.to_s.empty?
+      end
+
+      def setup_conn(url, user, pass)
+        headers = {
+          'Content-Type' => 'application/json'
+        }
+        Faraday.new(url: url, headers: headers) do |faraday|
+          faraday.request(:basic_auth, user, pass)
+
+          yield(faraday) if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/ubersicht/ingestion/event.rb

@@ -0,0 +1,17 @@
+module Ubersicht
+  module Ingestion
+    module Types
+      include ::Dry.Types()
+    end
+
+    class Event < ::Dry::Struct
+      attribute :event_code, Types::String
+      attribute :event_date, Types::String
+      attribute :transaction_type, Types::String # DeviceBinding
+      attribute :payload, Types::Hash.optional.default({}.freeze)
+      # payload.event_date
+      # payload.event_group_id
+      # payload.event_id
+    end
+  end
+end

data/lib/ubersicht/ingestion/hmac_validator.rb

@@ -0,0 +1,83 @@
+module Ubersicht
+  module Ingestion
+    # source: https://github.com/Adyen/adyen-ruby-api-library/blob/92e3fc98de808375ad701ba459aec3425d49c43c/spec/utils/hmac_validator_spec.rb
+    class HmacValidator
+      DATA_SEPARATOR = ':'.freeze
+      HMAC_ALGORITHM = 'sha256'.freeze
+
+      ADYEN_HMAC_SIGNATURE_PATH = 'additionalData.hmacSignature'.freeze
+      ADYEN_VALIDATION_KEYS = %w[pspReference
+                                 originalReference
+                                 merchantAccountCode
+                                 merchantReference
+                                 amount.value
+                                 amount.currency
+                                 eventCode
+                                 success].freeze
+
+      UBERSICHT_HMAC_SIGNATURE_PATH = 'payload.hmac_signature'.freeze
+      UBERSICHT_VALIDATION_KEYS = %w[payload.event_group_id
+                                     payload.event_id
+                                     transaction_type
+                                     event_code
+                                     event_date].freeze
+
+      def self.with_adyen
+        new(ADYEN_HMAC_SIGNATURE_PATH, ADYEN_VALIDATION_KEYS)
+      end
+
+      def self.with_ubersicht
+        new(UBERSICHT_HMAC_SIGNATURE_PATH, UBERSICHT_VALIDATION_KEYS)
+      end
+
+      def initialize(hmac_signature_path, validation_keys)
+        @hmac_signature_path = hmac_signature_path
+        @validation_keys = validation_keys
+      end
+
+      def calculate_notification_hmac(notification_request_item, hmac_key)
+        data = data_to_sign(notification_request_item)
+
+        Base64.strict_encode64(OpenSSL::HMAC.digest(HMAC_ALGORITHM, [hmac_key].pack('H*'), data))
+      end
+
+      def data_to_sign(notification_request_item)
+        validation_keys
+          .map { |key| fetch(notification_request_item, key).to_s }
+          .map { |value| value.gsub('\\', '\\\\').gsub(':', '\\:') }
+          .join(DATA_SEPARATOR)
+      end
+
+      def valid_notification_hmac?(notification_request_item, hmac_key)
+        expected_sign = calculate_notification_hmac(notification_request_item, hmac_key)
+        merchant_sign = fetch(notification_request_item, hmac_signature_path)
+
+        expected_sign == merchant_sign
+      end
+
+      def valid_notifications?(notification_request_items, hmac_key)
+        notification_request_items.all? do |notification_request_item|
+          valid_notification_hmac?(notification_request_item, hmac_key)
+        end
+      end
+
+      private
+
+      attr_reader \
+        :hmac_signature_path,
+        :validation_keys
+
+      def fetch(hash, keys)
+        keys.to_s.split('.').reduce(hash) do |acc, key|
+          next acc if acc.nil?
+
+          if key.to_i.to_s == key
+            acc[key.to_i]
+          else
+            acc[key].nil? ? acc[key.to_sym] : acc[key]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ubersicht/ingestion.rb

@@ -0,0 +1,19 @@
+module Ubersicht
+  module Ingestion
+    ACCEPTED_RESPONSE = '[accepted]'.freeze
+    ACCEPTED_STATUS = 200
+    REJECTED_RESPONSE = '[rejected]'.freeze
+    REJECTED_STATUS = 400
+
+    PROVIDERS = [
+      DAUTH_PROVIDER = 'DAuth'.freeze
+    ].freeze
+
+    PROVIDER_TO_TYPES_MAP = {
+      DAUTH_PROVIDER => %w[
+        Authentication
+        DeviceBinding
+      ]
+    }.freeze
+  end
+end

data/lib/ubersicht/version.rb

@@ -0,0 +1,3 @@
+module Ubersicht
+  VERSION = '0.2.0'.freeze
+end

data/lib/ubersicht.rb

@@ -0,0 +1,14 @@
+require 'dry-struct'
+require 'faraday'
+
+require 'ubersicht/version'
+require 'ubersicht/ingestion'
+require 'ubersicht/ingestion/build_ingestion_event'
+require 'ubersicht/ingestion/client'
+require 'ubersicht/ingestion/event'
+require 'ubersicht/ingestion/hmac_validator'
+
+module Ubersicht
+  Error = Class.new(StandardError)
+  ValidationError = Class.new(Error)
+end

data/lib/ubersicht_ruby_sdk.rb

@@ -0,0 +1 @@
+require 'ubersicht'

data/ubersicht-ruby-sdk.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ubersicht/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ubersicht-ruby-sdk'
+  spec.version       = Ubersicht::VERSION
+  spec.authors       = ['Starfish Team']
+  spec.email         = ['support@starfish.codes']
+
+  spec.summary       = %(Official Ubersicht SDK)
+  spec.description   = %(Official Ubersicht SDK. Simplifies integration with Ubersicht API)
+  spec.homepage      = 'https://github.com/starfish-codes/ubersicht-ruby-sdk'
+  spec.license       = 'MIT'
+
+  # spec.metadata["allowed_push_host"] = "rubygems.org"
+
+  spec.required_ruby_version = '>= 2.6'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/starfish-codes/ubersicht-ruby-sdk/blob/main/CHANGELOG.md'
+
+  # 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_dependency 'dry-struct', '~> 1.0'
+  spec.add_dependency 'faraday', ['>= 0.9.2', '< 2']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.1'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: ubersicht-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Starfish Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: Official Ubersicht SDK. Simplifies integration with Ubersicht API
+email:
+- support@starfish.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/ubersicht.rb
+- lib/ubersicht/ingestion.rb
+- lib/ubersicht/ingestion/build_ingestion_event.rb
+- lib/ubersicht/ingestion/client.rb
+- lib/ubersicht/ingestion/event.rb
+- lib/ubersicht/ingestion/hmac_validator.rb
+- lib/ubersicht/version.rb
+- lib/ubersicht_ruby_sdk.rb
+- ubersicht-ruby-sdk.gemspec
+homepage: https://github.com/starfish-codes/ubersicht-ruby-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/starfish-codes/ubersicht-ruby-sdk
+  source_code_uri: https://github.com/starfish-codes/ubersicht-ruby-sdk
+  changelog_uri: https://github.com/starfish-codes/ubersicht-ruby-sdk/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Official Ubersicht SDK
+test_files: []