session-validator-client 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d091acd762f22b286f6c92cde9e72642b8ff3919cbbc0df99e48a159c111d65a
-  data.tar.gz: af944e85aa7a0199f1ec0d115582046826f838124e04440e4106550512cde3c3
+  metadata.gz: 2498a668e8f669382a1a88f6555356823e7115d6978d8c9331bf84d1395190cc
+  data.tar.gz: 2ea169bd1b520056db1b7cc8fd65c0bac5aa206c8e7899e533267c104bec45e4
 SHA512:
-  metadata.gz: 2bb739c2ae71f993ed3e7ed6a1309b8be0e25163afd858d09960071ba737e9ea380e2ab720ae7cd5993cc37307497f9311c8291761226dcc9ce46940300df310
-  data.tar.gz: 44cfd9d65bd547f96895971d5f796568a30a3e42115eb457a0a28b18e8ba717d573601bee8fa85428e85ad45c08b61d42758820bf771038b1149e17ec883c320
+  metadata.gz: 2e0884a245a05850cc5412fe3f710ca875467093431f4514d591bcfcc9a8c8fc4373cede425204ccf80268e52c7f2ac9f3440fcb66bf32ab37fa4dba63833575
+  data.tar.gz: 023273a70c9d99daa8768ba44b1e50abc8cb8e76f39991e3def548f4bcebecf2771c704f9ffbb9e142cedb16c5cdee995ba1037b17a1ba39e276bb9ef2453e56

data/.github/workflows/ruby.yml

@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-versions: ['2.6', '2.7', '3.0']
+        ruby-versions: ['3.2', '3.3', '3.4']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-versions }}
@@ -19,7 +19,7 @@ jobs:
     - name: Run tests
       run: bundle exec rspec
     - name: Deploy
-      if : github.event_name == 'push' && startsWith(github.ref, 'refs/tags') && matrix.ruby-versions == '3.0'
+      if : github.event_name == 'push' && startsWith(github.ref, 'refs/tags') && matrix.ruby-versions == '3.2'
       run: |
           mkdir -p $HOME/.gem
           touch $HOME/.gem/credentials
@@ -28,4 +28,4 @@ jobs:
           gem build *.gemspec
           gem push *.gem
       env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -1,3 +1,5 @@
 *.gem
 Gemfile.lock
 .ruby-version
+.env
+.bundle

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:3.2-alpine
+
+RUN addgroup -g 1000 ruby && \
+    adduser -u 1000 -G ruby -s /bin/sh -D ruby && \
+    mkdir /app && \
+    chown ruby:ruby /app
+
+RUN apk update && \
+    apk upgrade
+RUN apk add --virtual .build-deps build-base git
+
+RUN gem update --system && \
+    gem update && \
+    gem cleanup && \
+    gem install bundler
+
+USER ruby
+WORKDIR /app
+
+RUN bundle config --local path .bundle

data/Makefile

@@ -0,0 +1,6 @@
+.PHONY: build install test sh
+
+build: ; docker compose build
+install: ; docker compose run --rm app bundle install
+test: ; docker compose run --rm app bundle exec rspec
+sh: ; docker compose run --rm app sh

data/README.md

@@ -1,4 +1,4 @@
-# session-validator-client-ruby ![Build status](https://travis-ci.org/emartech/session-validator-client-ruby.svg?branch=master)
+# Session Validator Client Ruby ![Build Status](https://github.com/emartech/session-validator-client-ruby/actions/workflows/ruby.yml/badge.svg)
 
 Ruby client for Emarsys session validator service.
 
@@ -10,35 +10,38 @@ gem install session-validator-client
 
 ## Usage
 
-Setup the following environment variables:
-
-* `KEY_POOL`
-* `SESSION_VALIDATOR_KEYID`
-* `SESSION_VALIDATOR_URL`
-
-### Validating a single Msid
-`valid?(msid)` returns `true` if `msid` is valid
+Copy `.env.example` to `.env` and set the necessary values for usage in your service.
 
+### Create client
 ```ruby
 require "session_validator"
 
 client = SessionValidator::Client.new
-client.valid?("staging_int_5ad5f96f307cf9.61063404")
 ```
 
-### Batch validating multiple MSIDS
-`filter_invalid(msids)` returns an array of the invalid MSIDS.
+### Requests without Escher
+For mTLS on GAP.
 
 ```ruby
 require "session_validator"
 
-client = SessionValidator::Client.new
+client = SessionValidator::Client.new(use_escher: false)
+```
+
+### Validating a single MSID
+```ruby
+client.valid?("staging_int_5ad5f96f307cf9.61063404")
+```
+
+### Batch validating multiple MSIDs
+Returns an array of the invalid MSIDs.
+```ruby
 client.filter_invalid(["staging_int_5ad5f96f307cf9.61063404", "staging_int_5ad5f96f307cf9.61063405"])
 ```
 
-## Running tests
+## Local development
 
+### Running tests
 ```bash
-$ bundle install
-$ rspec
+make test
 ```

data/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app

data/lib/session_validator/client.rb

@@ -5,6 +5,7 @@ require "faraday/retry"
 require "faraday_middleware/escher"
 
 class SessionValidator::Client
+  MSID_PATTERN = /^[a-z0-9._]+_[0-9a-f]{14}\.[0-9]{8}$/.freeze
   CREDENTIAL_SCOPE = "eu/session-validator/ems_request".freeze
   ESCHER_AUTH_OPTIONS = {
     algo_prefix: "EMS",
@@ -19,13 +20,26 @@ class SessionValidator::Client
     @use_escher = use_escher
   end
 
-  def valid?(msid)
-    response_status = client.get("/sessions/#{msid}", nil, headers).status
-    (200..299).include?(response_status) || (500..599).include?(response_status)
+  def valid?(id)
+    if id.match(MSID_PATTERN)
+      valid_by_msid? id
+    else
+      valid_by_session_data_token? id
+    end
+  end
+
+  def session_data(token)
+    response = client.get("/sessions", nil, headers.merge(authorization_header token))
+    case response.status
+      when 200 then JSON.parse(response.body)
+      when 400..499 then raise SessionValidator::SessionDataNotFound
+      when 500.. then raise SessionValidator::SessionDataError, "Service unreachable"
+    end
   rescue *NETWORK_ERRORS
-    true
+    raise SessionValidator::SessionDataError, "Service unreachable"
   end
 
+  # @deprecated
   def filter_invalid(msids)
     response = client.post("/sessions/filter", JSON.generate({ msids: msids }), headers)
     if response.status == 200
@@ -39,11 +53,29 @@ class SessionValidator::Client
 
   private
 
+  def valid_by_msid?(msid)
+    response_status = client.get("/sessions/#{msid}", nil, headers).status
+    (200..299).include?(response_status) || (500..599).include?(response_status)
+  rescue *NETWORK_ERRORS
+    true
+  end
+
+  def valid_by_session_data_token?(token)
+    response_status = client.head("/sessions", nil, headers.merge(authorization_header token)).status
+    case response_status
+      when 200 then true
+      when 400..499 then false
+      when 500.. then raise SessionValidator::SessionDataError, "Service unreachable"
+    end
+  rescue *NETWORK_ERRORS
+    raise SessionValidator::SessionDataError, "Service unreachable"
+  end
+
   def client
     Faraday.new(url) do |faraday|
       faraday.options[:open_timeout] = SERVICE_REQUEST_TIMEOUT
       faraday.options[:timeout] = SERVICE_REQUEST_TIMEOUT
-      faraday.request :retry, interval: 0.05, interval_randomness: 0.5, backoff_factor: 2, methods: [:get, :post], exceptions: NETWORK_ERRORS
+      faraday.request :retry, interval: 0.05, interval_randomness: 0.5, backoff_factor: 2, methods: [:head, :get, :post], exceptions: NETWORK_ERRORS
       faraday.use(Faraday::Middleware::Escher::RequestSigner, escher_config) if @use_escher
       faraday.adapter Faraday.default_adapter
     end
@@ -73,4 +105,8 @@ class SessionValidator::Client
   def headers
     { "content-type" => "application/json" }
   end
+
+  def authorization_header(token)
+    { "Authorization" =>  "Bearer #{token}" }
+  end
 end

data/lib/session_validator.rb

@@ -3,6 +3,10 @@ module SessionValidator
   autoload :CachedClient, "session_validator/cached_client"
   autoload :InMemoryCache, "session_validator/in_memory_cache"
 
+  class SessionDataError < StandardError; end
+
+  class SessionDataNotFound < SessionDataError; end
+
   def self.base_url
     ENV['SESSION_VALIDATOR_URL']
   end

data/session-validator-client.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "session-validator-client"
-  s.version     = "5.1.0"
+  s.version     = "6.0.0"
   s.summary     = "Ruby client for Emarsys session validator service"
   s.authors     = ["Emarsys Technologies Ltd."]
   s.email       = "security@emarsys.com"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: session-validator-client
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Emarsys Technologies Ltd.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 2025-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escher-keypool
@@ -128,20 +128,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: security@emarsys.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
+- ".env.example"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- Dockerfile
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - bin/console
+- docker-compose.yml
 - lib/session_validator.rb
 - lib/session_validator/cached_client.rb
 - lib/session_validator/client.rb
@@ -152,7 +155,7 @@ homepage: https://github.com/emartech/session-validator-client-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Ruby client for Emarsys session validator service
 test_files: []