omniauth-polaris 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 782f2fe5ef9e563de8acb9bc4bc40514d868fa06
-  data.tar.gz: 72d665983d951640d341aa4328a3213829237d98
+SHA256:
+  metadata.gz: cdc6774680ba017d52076ea0e48f91c64c639398d68a6efc378e15f176cf7c41
+  data.tar.gz: ac1c47675fb06db77a9e889aaa905fe8dbc5b8ff493b95e7a2ce58fbe3c2b471
 SHA512:
-  metadata.gz: fcf55973229e7642569371ca24ddc023263998d274a41bdd905823d130d5ae10d528f8718651e5358e82ec4ba6366b777805d68bd643d23f8ba701a03042bf87
-  data.tar.gz: bb794c07c75c09ad7461c1959dfffbb14776b54bbe059ddf2a751edb6cb9e52a9fa45bbc97ca10e32906721ea6a63df5b58cf58e5a0451428dff1ae1418b1349
+  metadata.gz: 90668f491c693ed44cba53bb920e36f05b394d96e103b1f54dd1a55ef1dff87d090af930c01910a78d705083777613190e64542800c1f4a942290b4933b3d1e7
+  data.tar.gz: 02a9cf3dc5b6ab29db564ed28c63ac616b93572ea2ba4df72c388b5b9937bf535d1aebfe6d169154d563ac917121efb8cae87594bd89a7ed04a285a1e69b5540

data/.gitignore

@@ -42,6 +42,7 @@ role_map_test.yml
 
 # Specific Files to ignore #
 ############################
+Gemfile.lock
 Thumbs.db
 Icon?
 .DS_Store?
@@ -49,14 +50,14 @@ Icon?
 ehthumbs.db
 .idea # Rubymine config files
 /.idea/*
-
+.ruby-version
 # Directories to ignore #
 #########################
 /public/data/*
 /jetty/*
 /solr_conf/*
 /fedora_conf/*
-
+scratch.rb
 # Ignore edited Linux files #
 #############################
 

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - 'scratch.rb'
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: true
+  Max: 5

data/.rubocop_todo.yml

@@ -0,0 +1,300 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-01-11 17:46:34 UTC using RuboCop version 1.32.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/OrderedGems:
+  Enabled: true
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Enabled: true
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'omniauth-polaris.gemspec'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLines:
+  Enabled: true
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Enabled: true
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/FirstHashElementIndentation:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Enabled: true
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/LeadingEmptyLines:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/SpaceAfterComma:
+  Enabled: true
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
+# SupportedStylesForExponentOperator: space, no_space
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, compact, no_space
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Offense count: 1
+Lint/RescueException:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Lint/ScriptPermission:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: ContextCreatingMethods, MethodCreatingMethods.
+Lint/UselessAccessModifier:
+  Enabled: true
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Enabled: true
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 63
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/omniauth-polaris.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/omniauth/polaris/adaptor.rb'
+    - 'lib/omniauth/strategies/polaris.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, expanded
+Style/EmptyMethod:
+  Enabled: true
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/Encoding:
+  Enabled: true
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/ExpandPathArguments:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: format, sprintf, percent
+Style/FormatString:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+# Offense count: 23
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+# SupportedShorthandSyntax: always, never, either
+Style/HashSyntax:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: both, prefix, postfix
+Style/NegatedIf:
+  Enabled: true
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: true
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowedCompactTypes.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  Enabled: true
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/RedundantInterpolation:
+  Enabled: true
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Enabled: true
+# Offense count: 5
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: true
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: RequireEnglish.
+# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_perl_names
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/StderrPuts:
+  Enabled: true
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Enabled: true
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: true
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: .
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: percent
+  MinSize: 3
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowMethodsWithArguments, IgnoredMethods, AllowComments.
+# IgnoredMethods: respond_to, define_method
+Style/SymbolProc:
+  Enabled: true
+
+# Offense count: 16
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 256

data/Gemfile

@@ -1,38 +1,14 @@
-source 'https://rubygems.org'
-
-gem 'rails', '3.2.9'
-
-# Bundle edge Rails instead:
-# gem 'rails', :git => 'git://github.com/rails/rails.git'
-
-gem 'sqlite3'
+# frozen_string_literal: true
 
+source 'https://rubygems.org'
 
-# Gems used only for assets and not required
-# in production environments by default.
-group :assets do
-  gem 'sass-rails',   '~> 3.2.3'
-  gem 'coffee-rails', '~> 3.2.1'
+gem 'rubocop', '~> 1.31', require: false
+gem 'rubocop-performance', '~> 1.15', require: false
+gem 'rubocop-rspec', '~> 2.12', require: false
 
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  # gem 'therubyracer', :platforms => :ruby
+gemspec
 
-  gem 'uglifier', '>= 1.0.3'
+group :test do
+  gem 'rack-test'
+  gem 'simplecov', require: false
 end
-
-gem 'jquery-rails'
-
-# To use ActiveModel has_secure_password
-# gem 'bcrypt-ruby', '~> 3.0.0'
-
-# To use Jbuilder templates for JSON
-# gem 'jbuilder'
-
-# Use unicorn as the app server
-# gem 'unicorn'
-
-# Deploy with Capistrano
-# gem 'capistrano'
-
-# To use debugger
-# gem 'debugger'

data/Rakefile

@@ -1,7 +1,21 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+# frozen_string_literal: true
 
-require File.expand_path('../config/application', __FILE__)
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-OmniauthPolaris::Application.load_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.requires << 'rubocop-rspec'
+    task.requires << 'rubocop-performance'
+    task.fail_on_error = true
+  end
+rescue LoadError
+  task :rubocop do
+    warn 'Rubocop is disabled'
+  end
+end
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'pry'
+require 'omniauth-polaris'
+
+Pry.start

data/lib/omniauth/polaris/adaptor.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Polaris
+    class Adaptor
+      REQUIRED_ADAPTER_CONFIG_KEYS = %i[access_id access_key method http_uri].freeze
+      BASIC_USER_DATA_KEYS = %w[NameFirst NameLast NameMiddle PhoneNumber EmailAddress].freeze
+      METHOD = { POST: :GET }.freeze
+
+      attr_reader :config
+
+      def self.validate!(configuration = {})
+        message = REQUIRED_ADAPTER_CONFIG_KEYS.each_with_object([]) do |name, msg|
+          next msg if configuration[name].present?
+
+          msg << name
+        end
+
+        raise Polaris::ConfigurationError, "#{message.join(' ,')} MUST be provided" unless message.blank?
+      end
+
+      def initialize(configuration = {})
+        self.class.validate!(configuration)
+
+        @configuration = configuration.dup
+
+        @logger = @configuration.delete(:logger)
+
+        REQUIRED_ADAPTER_CONFIG_KEYS.each do |name|
+          instance_variable_set("@#{name}", @configuration[name])
+        end
+
+        @config = {
+          http_uri: @http_uri,
+          method: @method,
+          access_key: @access_key,
+          access_id: @access_id
+        }
+
+        ensure_method!(@method)
+        @polaris_method = METHOD[@method]
+      end
+
+      def authenticate_patron(pin:, barcode:)
+        # According to the polaris api docs "Date must be within +/- 30 minutes of current time or request will fail"
+        http_date = 15.minutes.from_now.in_time_zone('GMT').strftime('%a, %d %b %Y %H:%M:%S %Z')
+
+        # Authorization hash component
+        authorization_hash = authorization_response(pin, barcode, http_date)
+
+        return if authorization_hash.blank?
+
+        # Details hash component
+        details_hash = details_response(pin, barcode, http_date)
+
+        return if details_hash.blank? || details_hash.dig('PatronBasicDataGetResult', 'PatronBasicData').blank?
+
+        patron_user_hash = authorization_hash['PatronValidateResult'].dup
+
+        patron_user_hash.merge(details_hash.dig('PatronBasicDataGetResult', 'PatronBasicData').slice(*BASIC_USER_DATA_KEYS))
+      end
+
+      protected
+
+      def authorization_response(pin, barcode, request_date)
+        patron_validate_uri = "#{@http_uri}/patron/#{barcode}"
+        validation_concated_string = "#{@polaris_method}#{patron_validate_uri}#{request_date}#{pin}"
+        polaris_get_xml_response(patron_validate_uri, request_date, validation_concated_string)
+      end
+
+      def details_response(pin, barcode, request_date)
+        patron_basic_data_uri = "#{@http_uri}#{barcode}/basicdata"
+        details_concated_string = "#{@polaris_method}#{http_basic_data_uri}#{request_date}#{pin}"
+        polaris_get_xml_response(patron_basic_data_uri, request_date, details_concated_string)
+      end
+
+      private
+
+      def polaris_request_headers(request_date, concated_string)
+        { 'Date' => request_date, 'Authorization' => "PWS #{@access_id}:#{sha1_sig(concated_string)}" }
+      end
+
+      def polaris_get_xml_response(uri, request_date, concated_string)
+        xml_response = HTTP.get(uri, headers: polaris_request_headers(request_date, concated_string))
+
+        return {} unless xml_response.status.success?
+
+        Hash.from_xml(xml_response.body.to_s)
+      rescue HTTP::Error, OpenSSL::SSL::SSLError => e
+        raise Polaris::ConnectionError, "Could not connect to polaris due to the following error\n #{e.class.name}: #{e.message}"
+      end
+
+      def sha1_sig(concated_string)
+        Base64.strict_encode64(OpenSSL::HMAC.digest('sha1', @access_key, concated_string).to_s)
+      end
+
+      def ensure_method!(method = 'post')
+        normalized_method = method.to_s.upcase.to_sym
+
+        return normalized_method if METHOD.key?(normalized_method)
+
+        available_methods = METHOD.keys.collect(&:inspect).join(', ')
+
+        raise Polaris::ConfigurationError, "#{method} is not one of the available connect methods: #{available_methods}"
+      end
+    end
+  end
+end

data/lib/omniauth/polaris/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Polaris
+    VERSION = '1.1.0'
+  end
+end

data/lib/omniauth/polaris.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/time'
+require 'active_support/core_ext/integer/time'
+require 'active_support/core_ext/hash/conversions'
+require 'base64'
+require 'cgi'
+require 'openssl'
+require 'http'
+require 'omniauth'
+require 'omniauth/strategies/polaris'
+
+module OmniAuth
+  module Polaris
+    class PolarisError < StandardError; end
+    class ConfigurationError < StandardError; end
+    class AuthenticationError < StandardError; end
+    class ConnectionError < StandardError; end
+  end
+end
+
+require 'omniauth/polaris/adaptor'