bima-shark-sdk 3.0.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3d5438f91e3e0715d520cae493446b62571f4f63baa1dcf4b4ff1ce9a97380
-  data.tar.gz: 7d321474ad227eabb72a5c9f64806e2219a606ce9b804b1c36bf78b8e6176b48
+  metadata.gz: d78520920a648b39f4efce4f0f09cf03ae7c1b9ae65022311dfc8d6f7e557f82
+  data.tar.gz: 10d37b688c20efe9010f33e0734cbb0fbe5c45eef667c037e4614fb5e132bcd9
 SHA512:
-  metadata.gz: '078265caf5dd06022b0ae91356fd4bd9f8093a879c1191a55297280786be708950652563cf1d5ccb9df8a51c5b9bec7a66f7f8b534eb865ad6142b757310a216'
-  data.tar.gz: ae7031d4aee957a60d2791122b650a713c77b75fa0c661b84444830cc463c5f40ac69dda0f19ed296cf22d7acee21f76346973e523ccb8316bf16ce4ed178ab6
+  metadata.gz: 79cba1cf92c07d7f73a2344b7de0c6c70d8fe03e0722c7331adcece266d348f4976ac980ad12e3c09d3fcb47f20bbb573bb48b7ac1218353e1de031ebdd8ca63
+  data.tar.gz: 9f6242f47a12c9f7a9761f2eeae415d930546c76346c01390482c024afbf42cb70eb92fd8132855589d3b604bebb0936e9190555bb86e40f6dafd60e7a53b095

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,11 @@
 ## Changelog
 
+#### 3.1.1
+- Extend Shark::Configuration with `access_id` and `secret_key`
+
+#### 3.1.0
+- Extend `with_service_token` with `with_auth_token` which allows to send custom `Authorization` header, not only `Bearer`
+
 #### 3.0.0
 - new minimum requirements are `Ruby 3.0` and `faraday 2.0`
 - remove `Shark::Subscription`

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/bin/console

@@ -7,17 +7,11 @@ require 'shark'
 # 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
-
-# TODO
 Shark.configure do |config|
   config.contact_service.site = 'https://contactservice-development.bundesimmo.de/api/'
   config.survey_service.site = 'https://milacrm-development.bundesimmo.de/api/v1/'
   config.form_service.site = 'https://formservice-development.bundesimmo.de/api/v1/'
   config.notification_service.site = 'https://api-development.bundesimmo.de/notification-service/'
-  config.subscription_service.site = 'https://api-development.bundesimmo.de/subscription-service/'
 end
 
 require 'irb'

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

@@ -53,6 +53,7 @@ module Shark
     # Shark Configuration
     #
     attr_accessor :cache, :logger
+    attr_accessor :access_id, :secret_key
     attr_reader :contact_service
     attr_reader :consent_service
     attr_reader :double_opt_in

data/lib/shark/version.rb

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

data/lib/shark.rb

@@ -34,26 +34,39 @@ module Shark
   # @api public
   def self.with_service_token(token)
     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)
+  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
 
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bima-shark-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.1
 platform: ruby
 authors:
 - bima-team@justrelate.com
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: ''