ubersicht-ruby-sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c517f3a08f30c20b2f5f3a219547519c797a91b2b8bc167dc838b24607a4d9f
-  data.tar.gz: dce099aceebd7d36c2dcac19ed007a2f8cf432db81d0ddbe5c5b14a3744327ad
+  metadata.gz: 4b8ecf09cd444b1b7a991f05714a5bc9b0c76013a916e9ab3d52671c5f97550f
+  data.tar.gz: d767066e3bdbe8d2781de2f47d05e685c467c2dfbd3a898e9646efbd7bb12384
 SHA512:
-  metadata.gz: 0f62f52d9d9ff24342861466cd4d2ebdefd193cb7940e051152b77d0a62f68d8b8f9df5658ed53db5bd6bb1d75b235c96d4764c7ebbd391618594e89866a9853
-  data.tar.gz: 833078838952d0a4fb62f656578f0d7c351a77e8869c2dbc920d7a6695de142926596d9bf0e11658bf8c9d0b7d69747c631d09aa504bcca983268295bd488fee
+  metadata.gz: b934e49a27e2edae6b96b3829610d47be0dd496ecb03e0b507d518acfa3cb03f528356b9f57ad12cccf02d4b2aa6cf09a0c50159c3d5678975241984f4d76920
+  data.tar.gz: 8c4fece1fd162df31c5ddbbdcb8201b3dc1012c6e0b41fbb0939b165d718fe9f552cfcc05f7eead8df25634e0ee2b8cb25209846cf8a839a8f55119d69665b0d

data/CHANGELOG.md

@@ -1,11 +1,23 @@
 ## Not released
+
+## 0.3.0
+
+Breaking changes:
+- [ingestion] replace basic auth with token based authentication
+- [ingestion] changed singnature from keywords to arguments in `ingest` method
+- [ingestion] removed username from client constructor
+- [ingestion] removed password from client constructor
+- [ingestion] removed account_id from client constructor
+- [ingestion] removed HMAC key from client constructor
+- [ingestion] removed provider key from client constructor
+
 ## 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:
+Breaking changes:
 
 - [ingestion] replaced `ingest` signature to keywords
 - [ingestion] renamed `event.type` with `event.transaction_type`

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    ubersicht-ruby-sdk (0.2.0)
-      dry-struct (~> 1.0)
+    ubersicht-ruby-sdk (0.3.0)
       faraday (>= 0.9.2, < 2)
 
 GEM
@@ -12,33 +11,10 @@ GEM
       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)
@@ -59,7 +35,6 @@ GEM
     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)

data/README.md

@@ -6,6 +6,12 @@ This is the officially supported Ruby library for using Ubersicht's APIs.
 
 Add this line to your application's Gemfile:
 
+```ruby
+gem 'ubersicht-ruby-sdk', '0.2.0', require: 'ubersicht'
+```
+
+The latest `main` branch:
+
 ```ruby
 gem 'ubersicht-ruby-sdk', git: 'https://github.com/starfish-codes/ubersicht-ruby-sdk.git',
                           branch: 'main', require: 'ubersicht'
@@ -27,39 +33,31 @@ Build client:
 
 ```sh
   client = Ubersicht::Ingestion::Client.new(
-    hmac_key: '44782DEF547AAA06C910C43932B1EB0C71FC68D9D0C057550C48EC2ACF6BA056',
-    account_id: '1001',
-    pass: 'password',
-    provider: 'DAuth',
+    token: '<ubersicht-plugin-token>',
     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
+* `token` - (required) authentication token for Ubersicth plugin.
 * `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
+  # required
+  transaction_type = 'DeviceBinding'
+  event_code = 'REQUESTED'
+
+  payload = {
     event_date: 2021-10-10 10:10:10,
     event_group_id: 'eb2bc8bb-f584-4801-b98c-361a0c2d38f8',
-    event_id: 'ed62d0c1-f2a5-41b7-ab58-24c033eec508',,
+    event_id: 'ed62d0c1-f2a5-41b7-ab58-24c033eec508',
   }
-  client.ingest(**event)
+  client.ingest(transaction_type, event_code, payload)
 ```
 
 Event attributes:

data/lib/ubersicht/ingestion/client.rb

@@ -2,54 +2,43 @@ module Ubersicht
   module Ingestion
     class Client
       def self.default(*args)
+        require 'logger'
+
         new(*args) do |faraday|
           faraday.request :url_encoded
           # faraday.response :raise_error
-          faraday.response :logger, Logger.new($stdout),
+          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])
+      def initialize(options = {}, &block)
+        raise ArgumentError, 'Token cannot be blank' if empty?(token = options[:token])
         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)
+        @conn = setup_conn(url, token, &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
+      def ingest(transaction_type, event_code, payload = {})
+        raise ArgumentError, 'Transaction type cannot be blank' if empty?(transaction_type)
+        raise ArgumentError, 'Event code cannot be blank' if empty?(event_code)
+
+        body = {
+          event: {
+            event_code: event_code,
+            transaction_type: transaction_type,
+            payload: payload
+          }
         }
-        ingest_events([event])
+        process { handle_response(@conn.post('api/v1/events', body.to_json)) }
       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
+      attr_reader :debug
 
       def process(&block)
         return yield if debug
@@ -71,14 +60,14 @@ module Ubersicht
         value.to_s.empty?
       end
 
-      def setup_conn(url, user, pass)
+      def setup_conn(url, token)
         headers = {
           'Content-Type' => 'application/json'
         }
-        Faraday.new(url: url, headers: headers) do |faraday|
-          faraday.request(:basic_auth, user, pass)
+        Faraday.new(url: url, headers: headers) do |conn|
+          conn.request :token_auth, token
 
-          yield(faraday) if block_given?
+          yield(conn) if block_given?
         end
       end
     end

data/lib/ubersicht/version.rb

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

data/lib/ubersicht.rb

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

data/ubersicht-ruby-sdk.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   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'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ubersicht-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Starfish Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-10-08 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
@@ -208,10 +194,7 @@ files:
 - 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

data/lib/ubersicht/ingestion/build_ingestion_event.rb

@@ -1,33 +0,0 @@
-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/event.rb

@@ -1,17 +0,0 @@
-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.rb

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