identikey 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a041647bdeb7baf1d5eee22d75c1c19039f7f2a95ed2f72919ce1a62a3c27e
-  data.tar.gz: 36b979cf4c32041377b4ab0b881afcca1fd880f8153ac1060447069c47658169
+  metadata.gz: 1710a5f6fbcfc83e269476074afdedb5be773bc9d90e296fa87bda8799c09a6e
+  data.tar.gz: 23db861c5791fdac119b75ec14aeedf48701a8c7080cf423ca4197bbce355d06
 SHA512:
-  metadata.gz: 1bf5928570adb64247b63c0fd9b61cd02711db99c6591fdbedea4d013693dbf8d6cd13edfe06e1c9a77680f20ac95303e4870472e55026a28daff24e2a5f36d6
-  data.tar.gz: 7bcea676a24e5ddecbce9895796f5525f4b1ec2f96c27ef993718e7fcc8f1879acad082f88dca88fb154199283d01d87f253760fa1f970b0bca06a4c06d3bdec
+  metadata.gz: 525ef84c5dfbba3f8f9dba1a412961df59c2e59f1d28010fc067cf4aed0f4b52327772a4b525a446b35b9dbfd9dbc6d5bb18372fa3e9a3dd1c3faf17764afb3b
+  data.tar.gz: 595dc7ba66db94432d0961c91588bb5051d690683ca89afc5b3606c8cbbae00ae4a1791845c42935a9d7f0be09f5bc3b5e6fb667ff18cfed6512e97f73fb48d4

data/README.md

@@ -1,6 +1,6 @@
 # Identikey
 
-This library is a thin and incomplete wrapper of the VASCO Identikey SOAP API.
+This library is a thin yet incomplete wrapper of the VASCO Identikey SOAP API.
 
 Vasco Identikey has been recently re-branded as OneSpan Authentication Server.
 
@@ -18,7 +18,7 @@ port 8888/TCP the SOAP protocol over HTTPS.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'identikey', github: 'ifad/identikey'
+gem 'identikey'
 ```
 
 And then execute:
@@ -64,7 +64,7 @@ By default, all SOAP requests and responses are logged to `log/identikey.log`.
 
 If you want to reduce the logging level please use:
 
-```
+```ruby
 Identikey::Authentication.configure do
   log_level :info # or one of [:debug, :warn, :error, :fatal]
 end
@@ -72,7 +72,7 @@ end
 
 Or to disable it altogether (not recommended):
 
-```
+```ruby
 Identikey::Authentication.configure do
   log false
 end
@@ -84,15 +84,15 @@ amend it to suit your needs.
 
 The only option whose semantics differ from the default is `filters`, as
 it adds handling the faulty parameter passing design in Identikey, where
-the same elements are used to transmit different business informatios.
+the same elements are used to transmit different business informations.
 
 By default, sensitive values attribute are filtered out from the logs.
 Other attributes to filter out can be specified by prefixing them with
-`identikey:`. Example, filter out `CREDFLD_PASSWORD` and `CREDFLD_USERID`:
+`identikey:`.
 
 Example, filter out `CREDFLD_PASSWORD` and `CREDFLD_USERID`:
 
-```
+```ruby
 Identikey::Authentication.configure do
   filters [ 'identikey:CREDFLD_PASSWORD', 'identikey:CREDFLD_USERID' ]
 end
@@ -100,9 +100,9 @@ end
 
 Please note that the following attributes are filtered out by default:
 
-* CREDFLD_PASSWORD
-* CREDFLD_STATIC_PASSWORD
-* CREDFLD_SESSION_ID
+* `CREDFLD_PASSWORD`
+* `CREDFLD_STATIC_PASSWORD`
+* `CREDFLD_SESSION_ID`
 
 Please note that if you set your custom filters, these will override the
 defaults and you should also take care of filtering the above parameters

data/lib/identikey/administration/digipass.rb

@@ -45,7 +45,7 @@ module Identikey
           :digipass_execute_VIEW, serial_no: serial_no)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Find digipass failed: #{stat} - #{error}"
+          raise Identikey::NotFound, "Find digipass failed: #{stat} - #{error}"
         end
 
         replace(digipass)
@@ -60,7 +60,7 @@ module Identikey
           :digipass_execute_UNASSIGN, serial_no: self.serial)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Assign digipass failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "Assign digipass failed: #{stat} - #{error}"
         end
 
         replace(digipass)
@@ -71,7 +71,7 @@ module Identikey
           :digipass_execute_ASSIGN, serial_no: self.serial, username: username, domain: domain)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Unassign digipass failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "Unassign digipass failed: #{stat} - #{error}"
         end
 
         replace(digipass)
@@ -84,7 +84,7 @@ module Identikey
         # Stat is useless here - it reports whether the call or not has
         # succeeded, not whether the OTP is valid
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Test OTP failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "Test OTP failed: #{stat} - #{error}"
         end
 
         appl['DIGIPASSAPPLFLD_RESULT_CODE'] == '0'

data/lib/identikey/administration/session.rb

@@ -26,7 +26,7 @@ module Identikey
         stat, sess, error = @client.logon(username: @username, password: @password, domain: @domain)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "logon failed: #{stat} - #{error}"
+          raise Identikey::LogonFailed, "logon failed: #{stat} - #{error}"
         end
 
         @privileges = parse_privileges sess['CREDFLD_LOGICAL_ADMIN_PRIVILEGES']
@@ -47,7 +47,7 @@ module Identikey
         stat, _, error = @client.logoff session_id: @session_id
 
         unless stat == 'STAT_ADMIN_SESSION_STOPPED' || stat == 'STAT_SUCCESS'
-          raise Identikey::Error, "logoff failed: #{stat} - #{error}"
+          raise Identikey::LogonFailed, "logoff failed: #{stat} - #{error}"
         end
 
         @privileges = nil
@@ -103,7 +103,7 @@ module Identikey
 
       def require_logged_on!
         unless logged_on?
-          raise Identikey::Error, "Session is not logged on at the moment"
+          raise Identikey::UsageError, "Session is not logged on at the moment"
         end
       end
 

data/lib/identikey/administration/session_query.rb

@@ -6,7 +6,7 @@ module Identikey
         stat, sessions, error = session.execute(:admin_session_query)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "query failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "query failed: #{stat} - #{error}"
         end
 
         sessions.map do |sess|

data/lib/identikey/administration/user.rb

@@ -37,7 +37,7 @@ module Identikey
           :user_execute_VIEW, username: username, domain: domain)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Find user failed: #{stat} - #{error}"
+          raise Identikey::NotFound, "Find user failed: #{stat} - #{error}"
         end
 
         replace(user, persisted: true)
@@ -68,7 +68,7 @@ module Identikey
         })
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Save user failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "Save user failed: #{stat} - #{error}"
         end
 
         replace(user, persisted: true)
@@ -76,18 +76,18 @@ module Identikey
 
       def destroy!
         unless self.persisted?
-          raise Identikey::Error, "User #{self.username} is not persisted"
+          raise Identikey::UsageError, "User #{self.username} is not persisted"
         end
 
         unless self.username && self.domain
-          raise Identikey::Error, "User #{self} is missing username and/or domain"
+          raise Identikey::UsageError, "User #{self} is missing username and/or domain"
         end
 
         stat, _, error = @session.execute(
           :user_execute_DELETE, username: username, domain: domain)
 
         if stat != 'STAT_SUCCESS'
-          raise Identikey::Error, "Delete user failed: #{stat} - #{error}"
+          raise Identikey::OperationFailed, "Delete user failed: #{stat} - #{error}"
         end
 
         @persisted = false

data/lib/identikey/authentication.rb

@@ -34,7 +34,7 @@ module Identikey
         return true
       else
         error_message = result['CREDFLD_STATUS_MESSAGE']
-        raise Identikey::Error, "OTP Validation error (#{status}): #{error_message}"
+        raise Identikey::OperationFailed, "OTP Validation error (#{status}): #{error_message}"
       end
     end
 

data/lib/identikey/base.rb

@@ -134,11 +134,11 @@ module Identikey
         body = resp.body
 
         if body.size.zero?
-          raise Identikey::Error, "Empty response received"
+          raise Identikey::ParseError, "Empty response received"
         end
 
         unless body.key?(root_element)
-          raise Identikey::Error, "Expected response to have #{root_element}, found #{body.keys.join(', ')}"
+          raise Identikey::ParseError, "Expected response to have #{root_element}, found #{body.keys.join(', ')}"
         end
 
         # The root results element
@@ -155,7 +155,7 @@ module Identikey
         # The results element
         #
         unless root.key?(:results)
-          raise Identikey::Error, "Results element not found below #{root_element}"
+          raise Identikey::ParseError, "Results element not found below #{root_element}"
         end
 
         results = root[:results]
@@ -163,7 +163,7 @@ module Identikey
         # Result code
         #
         unless results.key?(:result_codes)
-          raise Identikey::Error, "Result codes not found below #{root_element}"
+          raise Identikey::ParseError, "Result codes not found below #{root_element}"
         end
 
         result_code = results[:result_codes][:status_code_enum] || 'STAT_UNKNOWN'
@@ -171,7 +171,7 @@ module Identikey
         # Result attributes
         #
         unless results.key?(:result_attribute)
-          raise Identikey::Error, "Result attribute not found below #{root_element}"
+          raise Identikey::ParseError, "Result attribute not found below #{root_element}"
         end
 
         results_attr = results[:result_attribute]
@@ -257,7 +257,7 @@ module Identikey
             next
 
           else
-            raise Identikey::Error, "#{name} type #{value.class} is unsupported"
+            raise Identikey::UsageError, "#{name} type #{value.class} is unsupported"
           end
 
           { attributeID: name.to_s,

data/lib/identikey/version.rb

@@ -1,3 +1,3 @@
 module Identikey
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/identikey.rb

@@ -6,5 +6,21 @@ require 'identikey/authentication'
 require 'identikey/administration'
 
 module Identikey
+  # Generic error class
   class Error < StandardError; end
+
+  # Raised when the user is not doing things correctly
+  class UsageError < Error; end
+
+  # Raised when the received XML does not conform to documentation
+  class ParseError < Error; end
+
+  # Raised when something is "not found", such as an user or a digipass.
+  class NotFound < Error; end
+
+  # Raised when Admin logon failed
+  class LogonFailed < Error; end
+
+  # Raised when read/write operations fail
+  class OperationFailed < Error; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: identikey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Marcello Barnaba