session-validator-client 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13134a5a0a3928a83545942f1ea04e16fdecea4e0fe181e2706c775867cc537c
-  data.tar.gz: 6f4cd63ee8452f43e0668eb5d9f35de6f718c0e280f3c651eaa268f5814bed78
+  metadata.gz: f1816744639488cc1585a2086e282cc605336199ad25b15f37dbd9813c1eb2db
+  data.tar.gz: e6d8d97f3d41daa67723f0e052ec48cbdfe2f4add832f368085368f76d20e3b0
 SHA512:
-  metadata.gz: ac98bcd42df4d231fd93c2ad26144411afdbcf8f7f456e06130b8def140a9877f1636124b3409808736354aa60c925d58dd530cbcb3ec126edcfdb13dd11a7e6
-  data.tar.gz: d64be1fc130fb1ab0dce811d05aa54d5f6df53820547683dd222253366a4304f26403ae1c1e3136780cee08e197cae7c3eb1c53cd02b80e89044c20c689d0619
+  metadata.gz: b99f8eb8174d308b0aa05620bd7036ff8a693bf8ec37604a8ae69033e9ca27b9251276b6a5baa9d02e79b517ceba58f2f5b9a95895bb949417978a69af9633d0
+  data.tar.gz: 9c6363f1a4e1654f3b327f69d0a6dc294b0ef70dec3d81db8f29504c55716e767aa3b4f71bed858a6abad2e05fbd4a5325bb5176e9e7ca3f665049d66d2fd9b2

data/.env

@@ -0,0 +1,3 @@
+SESSION_VALIDATOR_KEYID=''
+SESSION_VALIDATOR_URL=''
+KEY_POOL='[{"keyId":"","secret":"","acceptOnly":0}]'

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.4.0
+script: "bundle exec rspec"
+deploy:
+  provider: rubygems
+  api_key: ${RUBYGEMS_API_KEY}
+  gem: session-validator-client
+  gemspec: session-validator-client.gemspec
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# session-validator-client-ruby ![Build status](https://travis-ci.org/emartech/session-validator-client-ruby.svg?branch=master)
+
+Ruby client for Emarsys session validator service.
+
+## Install
+
+```bash
+gem install session-validator-client
+```
+
+## Usage
+
+setup up the following environment variables:
+
+* `KEY_POOL`
+* `SESSION_VALIDATOR_KEYID`
+* `SESSION_VALIDATOR_URL`
+
+```ruby
+require "session_validator"
+
+client = SessionValidator::Client.new
+client.valid?("staging_int_5ad5f96f307cf9.61063404")
+```
+
+## Running tests
+
+```bash
+rspec
+```

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'session_validator'
+require 'dotenv'
+
+Dotenv.load
+
+require 'irb'
+IRB.start

data/lib/session_validator.rb

@@ -0,0 +1,9 @@
+module SessionValidator
+  autoload :Client, "session_validator/client"
+  autoload :CachedClient, "session_validator/cached_client"
+  autoload :InMemoryCache, "session_validator/in_memory_cache"
+
+  def self.base_url
+    ENV['SESSION_VALIDATOR_URL']
+  end
+end

data/lib/session_validator/cached_client.rb

@@ -0,0 +1,19 @@
+module SessionValidator
+  class CachedClient
+    def initialize(client, cache)
+      @client = client
+      @cache = cache
+    end
+
+    def valid?(msid)
+      @cache.cleanup
+
+      cached_result = @cache.get msid
+      return cached_result if cached_result
+
+      @client.valid?(msid).tap do |result|
+        @cache.set msid, result if result
+      end
+    end
+  end
+end

data/lib/session_validator/client.rb

@@ -0,0 +1,59 @@
+require "uri"
+require "escher-keypool"
+require "faraday"
+require "faraday_middleware"
+require "faraday_middleware/escher"
+
+class SessionValidator::Client
+  CREDENTIAL_SCOPE = "eu/session-validator/ems_request".freeze
+  ESCHER_AUTH_OPTIONS = {
+    algo_prefix: "EMS",
+    vendor_key: "EMS",
+    auth_header_name: "X-Ems-Auth",
+    date_header_name: "X-Ems-Date"
+  }.freeze
+  SERVICE_REQUEST_TIMEOUT = 2.freeze
+
+  def valid?(msid)
+    response_status = client.get("/sessions/#{msid}", nil, headers).status
+    (200..299).include?(response_status) || (500..599).include?(response_status)
+  rescue Faraday::TimeoutError
+    true
+  end
+
+  private
+
+  def client
+    Faraday.new(url) do |faraday|
+      faraday.options[:open_timeout] = SERVICE_REQUEST_TIMEOUT
+      faraday.options[:timeout] = SERVICE_REQUEST_TIMEOUT
+      faraday.use FaradayMiddleware::Escher::RequestSigner, escher_config
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  def url
+    uri.to_s
+  end
+
+  def host
+    uri.hostname
+  end
+
+  def uri
+    URI.parse(SessionValidator.base_url)
+  end
+
+  def escher_config
+    {
+      credential_scope: CREDENTIAL_SCOPE,
+      host: host,
+      options: ESCHER_AUTH_OPTIONS,
+      active_key: -> { ::Escher::Keypool.new.get_active_key("session_validator") }
+    }
+  end
+
+  def headers
+    { "content-type" => "application/json" }
+  end
+end

data/lib/session_validator/in_memory_cache.rb

@@ -0,0 +1,35 @@
+module SessionValidator
+  class InMemoryCache
+    def initialize(ttl)
+      @ttl = ttl
+      @cache = {}
+    end
+
+    def get(key)
+      return nil unless @cache.key? key
+
+      data = @cache[key]
+      return nil if expired? data
+
+      data[:value]
+    end
+
+    def set(key, value)
+      @cache[key] = { value: value, expiry: Time.now.to_i + @ttl }
+    end
+
+    def cleanup
+      @cache.delete_if { |_, data| expired? data }
+    end
+
+    def empty?
+      @cache.length == 0
+    end
+
+    private
+
+    def expired?(data)
+      Time.now.to_i >= data[:expiry]
+    end
+  end
+end

data/session-validator-client.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = "session-validator-client"
+  s.version     = "3.0.1"
+  s.summary     = "Ruby client for Emarsys session validator service"
+  s.authors     = ["Emarsys Technologies Ltd."]
+  s.email       = "security@emarsys.com"
+  s.homepage    = "https://github.com/emartech/session-validator-client-ruby"
+  s.licenses    = ["MIT"]
+
+  s.required_ruby_version = ">= 1.9"
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.require_paths = ['lib']
+
+  s.add_dependency "escher-keypool"
+  s.add_dependency "faraday"
+  s.add_dependency "faraday_middleware"
+  s.add_dependency "faraday_middleware-escher"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "dotenv"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: session-validator-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Emarsys Technologies Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escher-keypool
@@ -113,8 +113,20 @@ email: security@emarsys.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/emartech/session-validator-client-ruby/
+files:
+- ".env"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- bin/console
+- lib/session_validator.rb
+- lib/session_validator/cached_client.rb
+- lib/session_validator/client.rb
+- lib/session_validator/in_memory_cache.rb
+- session-validator-client.gemspec
+homepage: https://github.com/emartech/session-validator-client-ruby
 licenses:
 - MIT
 metadata: {}