bima-shark-sdk 2.4.4 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e003bacef5ad3777bebedc0d3cc6998774649c19f9d01feceaf3353491368c5e
-  data.tar.gz: 744acc3e2be82f620f064a8d01b9f858939ff0fc28ec35f2b5fd9ea6b86f8d06
+  metadata.gz: 8ab74483354f85310c09fe0f53a00143fbd8042e81b0ed8d7226d77909ff2e24
+  data.tar.gz: 4c2d6b001cd4dfbd451c59c2e27368b55ecca753fd0a63f4a4350216b790be91
 SHA512:
-  metadata.gz: 7bd2cbb0c39408763febc462074a670cf29a5afdcdaa9e8cf6c7407e7a6d3343829ce291a13361434764b29e9a7b30d7f94f9c09bd2101f73e38b802d77490b8
-  data.tar.gz: bce739bb923bc2aba6dba2095ba000781fe3e2fcc4b44324e328aba34662dbd147373d369cb29bf8929b5babdd1dc2f987a14029318726bde30e602a6ad68f9d
+  metadata.gz: 26060a07b63c8f2c37a5fe505a5e4aee3bb907ebe1a75340ae4676b05dbdc3377d2e6175ef12fe62e019d98f77680df720527b947f8ffd4e1e0ccb4066ce44fa
+  data.tar.gz: 13f5e6dd6a7b1b83c98f8e40232349e6d8eaa30f60058363d838491596eb06ee2f8a37cf08868ea71316bd77b5d08c90d5bbd7c151db5120fce8fcf2edb91e24

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-cache: bundler
+# cache: bundler
 rvm:
   - 2.7.6
   - 3.0.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+#### 2.5.0
+- Extend `with_service_token` with `with_auth_token` which allows to send custom `Authorization` header, not only `Bearer`
+- remove `Shark::Subscription`
+
 #### 2.4.4
 * lowest supported Ruby version is 2.7
 * add `recipient` to `Shark::DoubleOptIn::Execution`

data/README.md

@@ -42,6 +42,21 @@ Shark::MailingService.use_shark_mailer do |mailer|
 end
 ```
 
+To sign your requests with custom tokens, for instance with JWT:
+```ruby
+  def deliver
+    access_id = 'access_id'
+    secret_key = 'secret_key'
+
+    signature = JWT.encode({ exp: Time.now.to_i + (1 * 60) }, secret_key, 'HS256')
+
+    Shark.with_auth_token("JWT #{access_id}:#{signature}") do
+      super
+    end
+  end
+
+```
+
 ## Testing
 
 ```

data/lib/shark/client/connection.rb

@@ -38,9 +38,7 @@ module Shark
         request_headers = connection_options_headers.merge(headers || {})
         request_params = connection_options_params.merge(params || {})
 
-        if Shark.service_token.present?
-          request_headers['Authorization'] = "Bearer #{Shark.service_token}"
-        end
+        request_headers['Authorization'] = Shark.auth_token if Shark.auth_token.present?
 
         @connection.send(request_action) do |request|
           request.url(url)

data/lib/shark/configuration.rb

@@ -29,12 +29,6 @@ module Shark
     end
   end
 
-  module SubscriptionService
-    module Resource
-      mattr_accessor :site
-    end
-  end
-
   module SurveyService
     module Resource
       mattr_accessor :site
@@ -65,7 +59,6 @@ module Shark
     attr_reader :form_service
     attr_reader :survey_service
     attr_reader :notification_service
-    attr_reader :subscription_service
     attr_reader :asset_service
     attr_reader :mailing_service
 
@@ -76,7 +69,6 @@ module Shark
       @form_service = Service.new
       @mailing_service = Service.new
       @notification_service = NotificationService::Resource
-      @subscription_service = SubscriptionService::Resource
       @survey_service = SurveyService::Resource
     end
   end

data/lib/shark/rspec/helpers.rb

@@ -5,7 +5,6 @@ require_relative 'helpers/cache_helper'
 require_relative 'fake_asset_service'
 require_relative 'fake_contact_service'
 require_relative 'fake_notification_service'
-require_relative 'fake_subscription_service'
 require_relative 'fake_double_opt_in'
 require_relative 'fake_mailing_service'
 require_relative 'fake_survey_service'

data/lib/shark/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shark
-  VERSION = '2.4.4'
+  VERSION = '2.5.0'
 end

data/lib/shark.rb

@@ -32,28 +32,41 @@ module Shark
   # @param token [String] The service token for the authorization header
   # @param block [Block] The block where service token authorization will be set for
   # @api public
-  def self.with_service_token(token)
+  def self.with_service_token(token, &block)
     if token.is_a?(String)
-      self.service_token = token
+      auth_token = "Bearer #{token}"
     elsif token.respond_to?(:jwt)
-      self.service_token = token.jwt
+      auth_token = "Bearer #{token.jwt}"
     else
       raise ArgumentError, 'Parameter :token must be kind of String.'
     end
 
+    with_auth_token(auth_token, &block)
+  end
+
+  # Within the given block, add the authorization header token to all api requests.
+  #
+  # @param token [String] The token for the authorization header
+  # @param block [Block] The block where authorization token will be set for
+  # @api public
+  def self.with_auth_token(token)
+    raise ArgumentError, 'Parameter :token must be kind of String.' unless token.is_a?(String)
+
+    self.auth_token = token
+
     yield
   ensure
-    self.service_token = nil
+    self.auth_token = nil
   end
 
   # @api public
-  def self.service_token
-    Thread.current['shark-service-token']
+  def self.auth_token
+    Thread.current['shark-auth-token']
   end
 
   # @api private
-  def self.service_token=(value)
-    Thread.current['shark-service-token'] = value
+  def self.auth_token=(value)
+    Thread.current['shark-auth-token'] = value
   end
 
   #
@@ -82,7 +95,6 @@ require 'shark/membership'
 require 'shark/notification'
 require 'shark/package'
 require 'shark/permission'
-require 'shark/subscription'
 require 'shark/survey'
 require 'shark/survey_participant'
 require 'shark/contact_log'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bima-shark-sdk
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.0
 platform: ruby
 authors:
 - bima-team@justrelate.com
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -244,9 +244,6 @@ files:
 - lib/shark/rspec/fake_mailing_service/request.rb
 - lib/shark/rspec/fake_notification_service.rb
 - lib/shark/rspec/fake_notification_service/request.rb
-- lib/shark/rspec/fake_subscription_service.rb
-- lib/shark/rspec/fake_subscription_service/object_cache.rb
-- lib/shark/rspec/fake_subscription_service/request.rb
 - lib/shark/rspec/fake_survey_service.rb
 - lib/shark/rspec/fake_survey_service/object_cache.rb
 - lib/shark/rspec/fake_survey_service/request.rb
@@ -257,7 +254,6 @@ files:
 - lib/shark/rspec/helpers/fixtures.rb
 - lib/shark/rspec/helpers/form_service_helper.rb
 - lib/shark/rspec/helpers/response.rb
-- lib/shark/subscription.rb
 - lib/shark/survey.rb
 - lib/shark/survey_participant.rb
 - lib/shark/version.rb
@@ -279,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: ''

data/lib/shark/rspec/fake_subscription_service/object_cache.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Shark
-  module RSpec
-    module FakeSubscriptionService
-      class ObjectCache
-        include Singleton
-        attr_accessor :objects
-
-        def initialize
-          @objects = []
-        end
-
-        def self.clear
-          instance.objects = []
-        end
-
-        def add(payload_data)
-          id = payload_data.delete('id')
-
-          if id && !objects.find { |subscription| subscription['id'] == id }
-            object = {
-              id: id,
-              attributes: payload_data
-            }
-
-            objects << object
-          else
-            objects << {
-              id: SecureRandom.uuid,
-              attributes: payload_data
-            }
-          end
-          objects.last
-        end
-
-        def add_multiple(payload_data)
-          added = []
-          payload_data.each { |subscription| added << add(subscription) }
-          added.compact
-        end
-
-        def remove(id)
-          objects.delete_if { |subscription| subscription[:id] == id }
-        end
-
-        def remove_multiple(payload_data)
-          payload_data.each { |subscription| remove(subscription['id']) }
-          objects
-        end
-      end
-    end
-  end
-end

data/lib/shark/rspec/fake_subscription_service/request.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require 'webmock/rspec'
-
-module Shark
-  module RSpec
-    module FakeSubscriptionService
-      class Request
-        include Singleton
-
-        ALLOWED_FILTERS = %w[name subscriberId].freeze
-
-        def self.setup
-          instance = self.instance
-          instance.stub_requests
-        end
-
-        def stub_requests
-          WebMock.stub_request(:post, %r{^#{host}/subscriptions}).to_return do |request|
-            log_info "Faking POST request with body: #{request.body}"
-
-            payload_data = JSON.parse(request.body)['data']['attributes']
-
-            object_data = ObjectCache.instance.add(payload_data)
-
-            SharkSpec.fake_response(201, data: object_data)
-          end
-
-          WebMock.stub_request(
-            :post,
-            %r{^#{host}/subscriptions/bulk_creation}
-          ).to_return do |request|
-            log_info "Faking POST request with body: #{request.body}"
-
-            payload_data = JSON.parse(request.body)['data']['attributes']['subscriptions']
-
-            objects_data = ObjectCache.instance.add_multiple(payload_data)
-
-            SharkSpec.fake_response(201, data: objects_data)
-          end
-
-          WebMock.stub_request(
-            :post,
-            %r{^#{host}/subscriptions/bulk_deletion}
-          ).to_return do |request|
-            log_info "Faking POST request with body: #{request.body}"
-
-            payload_data = JSON.parse(request.body)['data']['attributes']['subscriptions']
-            ObjectCache.instance.remove_multiple(payload_data)
-
-            SharkSpec.fake_response(204, nil)
-          end
-
-          WebMock.stub_request(:delete, %r{^#{host}/subscriptions/.+}).to_return do |request|
-            log_info "Faking DELETE request with body: #{request.body}"
-
-            id = request.uri.path.split('/')[2]
-
-            ObjectCache.instance.remove(id)
-
-            SharkSpec.fake_response(204, nil)
-          end
-
-          WebMock.stub_request(:get, %r{^#{host}/subscriptions}).to_return do |request|
-            log_info 'Faking GET request'
-
-            query_parameters = request.uri.query_values
-
-            objects_data = if query_parameters
-                             params = {}
-                             query_parameters.each do |key, value|
-                               parsed_key = key.match(/filter\[(.*)\]/)[1].camelize(:lower)
-                               params[parsed_key] = value if ALLOWED_FILTERS.include?(parsed_key)
-                             end
-
-                             ObjectCache.instance.objects.select do |subscription|
-                               conditions = params.map do |param, value|
-                                 subscription[:attributes][param] == value
-                               end
-                               conditions.all?
-                             end
-                           else
-                             ObjectCache.instance.objects
-                           end
-
-            SharkSpec.fake_response(200, data: objects_data)
-          end
-        end
-
-        def host
-          Shark.configuration.subscription_service.site
-        end
-
-        def log_info(message)
-          Shark.logger.info "[Shark::SubscriptionService] #{message}"
-        end
-      end
-    end
-  end
-end

data/lib/shark/rspec/fake_subscription_service.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'fake_subscription_service/object_cache'
-require_relative 'fake_subscription_service/request'
-
-module Shark
-  module RSpec
-    module FakeSubscriptionService
-      def self.setup
-        ObjectCache.clear
-        Request.setup
-      end
-
-      def self.reset
-        ObjectCache.clear
-      end
-    end
-  end
-end

data/lib/shark/subscription.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Shark
-  class Subscription < Base
-    extend SubscriptionService::Resource
-
-    custom_endpoint :bulk_creation, on: :collection, request_method: :post
-    custom_endpoint :bulk_deletion, on: :collection, request_method: :post
-
-    def self.create_multiple(attributes)
-      bulk_creation(subscriptions_attributes(attributes))
-    end
-
-    def self.destroy_multiple(attributes)
-      bulk_deletion(subscriptions_attributes(attributes))
-    end
-
-    def save
-      if self['id'].present?
-        raise Shark::ActionNotSupportedError,
-              'Shark::Subscription#save is not supported for persisted subscriptions'
-      else
-        super
-      end
-    end
-
-    def update_attributes(_attributes = {})
-      raise Shark::ActionNotSupportedError,
-            'Shark::Subscription#update_attributes is not supported'
-    end
-
-    def self.subscriptions_attributes(attributes)
-      {
-        data: {
-          type: 'bulk-subscriptions',
-          attributes: {
-            subscriptions: attributes
-          }
-        }
-      }
-    end
-  end
-end