vacman_controller 0.5.0 → 0.6.0

data/lib/vacman_controller/token/properties.rb

@@ -40,7 +40,7 @@ module VacmanController
         name  = name.to_s
         value = VacmanController::LowLevel.get_token_property(@token.to_h, name)
 
-        cast(name, value)
+        read_cast(name, value)
       end
 
 
@@ -52,63 +52,114 @@ module VacmanController
       #   the property name. See +Token.property_names+
       #
       # value::
-      #   the property value. Only values convertible to integer are
-      #   supported.
+      #   the property value. The AAL2 library accepts only values
+      #   convertible to integer. For symmetry with +[]+, boolean
+      #   values are converted to the appropriate integer.
+      #
+      # see::
+      #   +write_cast!+
       #
       def []=(name, value)
         name  = name.to_s
-        value = value.to_i
-
-        check_bounded_property!(name, value)
+        value = write_cast!(name, value)
 
         VacmanController::LowLevel.set_token_property(@token.to_h, name, value)
       end
 
-
       protected
-        def bounded_property?(name)
-          PROPERTY_BOUNDS.key?(name)
+        #
+        def write_cast!(property, value)
+          case property
+            # Bounded integer values
+          when 'last_time_used'
+            write_check_bounds! property, value,
+              [631152000, 2147483647]
+
+          when 'last_time_shift'
+            write_check_bounds! property, value,
+              [-100_000, 100_000]
+
+          when 'pin_enabled'
+            value ? 1 : 2
+
+          when 'pin_change_forced'
+            if value
+              1
+            else
+              raise VacmanController::Error,
+                "Token property #{property} cannot be set to #{value.inspect}"
+            end
+
+          when 'pin_min_len', 'pin_minimum_length'
+            write_check_bounds! property, value,
+              [3, 8]
+
+          when 'virtual_token_grace_period'
+            write_check_bounds! property, value,
+              [1, 364]
+
+          when 'virtual_token_remain_use'
+            write_check_bounds! property, value,
+              [0, 254]
+
+          when 'error_count'
+            if value == 0
+              value
+            else
+              raise VacmanController::Error,
+                "Token property #{property} cannot be set to #{value.inspect}"
+            end
+
+          when 'event_value'
+            write_check_bounds! property, value,
+              [0, 4_294_967_294]
+
+          when 'token_status'
+            case value
+            when :disabled     then 0
+            when :primary_only then 1
+            when :backup_only  then 2
+            when :enabled      then 3
+            else
+              raise VacmanController::Error,
+                "Token property #{property} cannot be set to #{value.inspect}"
+            end
+
+          else
+            raise VacmanController::Error,
+              "Invalid or read-only property: #{property}"
+          end
         end
 
         # The library also does these checks, but we want to present
         # custom error message to the caller.
         #
-        def check_bounded_property!(name, value)
-          return unless bounded_property?(name)
-
-          min, max = PROPERTY_BOUNDS.fetch(name)
+        def write_check_bounds!(property, value, bounds)
+          min, max = bounds
 
           if value < min || value > max
             raise VacmanController::Error,
-              "Invalid #{name} value provided: #{value}. " \
+              "Invalid #{property} value provided: #{value}. " \
               "Must be between greater than #{min} and less than #{max}."
           end
 
-          true
+          value
         end
 
-        PROPERTY_BOUNDS = {
-          'last_time_used'             => [ 631152000, 2147483647 ],
-
-          'last_time_shift'            => [ -100_000, 100_000 ],
-
-          'pin_min_length'             => [ 3, 8 ],
-          'pin_minimum_length'         => [ 3, 8 ],
-
-          'virtual_token_grace_period' => [ 1, 364 ],
-
-          'virtual_token_remain_use'   => [ 0, 254 ],
-
-          'event_value'                => [ 0, 4_294_967_294 ],
-        }
-
-        def cast(property, value)
 
+        # Maps the given property value to a Ruby value for:
+        #
+        # * Integers
+        # * Booleans
+        # * Dates
+        # * Enumerations (Symbols)
+        #
+        def read_cast(property, value)
           # Short-circuit on 'NA'
           return nil if value == 'NA' or value == 'DISABLE'
 
           case property
-          when # Integer values
+          when  # Integer values
             'use_count',
             'pin_len',
             'pin_length',
@@ -123,7 +174,6 @@ module VacmanController
             'response_len',
             'response_length',
             'time_step'
-
             value.to_i
 
           when # Boolean values
@@ -178,6 +228,10 @@ module VacmanController
         end
 
       private
+        # Exposes a getter and setter method for each
+        # property name. Delegates error handling for
+        # invalid properties to +[]+ and +[]=+.
+        #
         def method_missing(name, *args, &block)
           prop, setter = name.to_s.match(/\A(.+?)(=)?\Z/).values_at(1, 2)
 

data/lib/vacman_controller/token.rb

@@ -110,7 +110,7 @@ module VacmanController
     # Enables the PIN on this token
     #
     def enable_pin!
-      properties[:pin_enabled] = 1
+      properties[:pin_enabled] = true
       true
     end
 
@@ -118,7 +118,7 @@ module VacmanController
     # Disables the PIN on this token
     #
     def disable_pin!
-      properties[:pin_enabled] = 2
+      properties[:pin_enabled] = false
       true
     end
 
@@ -126,7 +126,7 @@ module VacmanController
     # Forces PIN change on this token
     #
     def force_pin_change!
-      properties[:pin_change_forced] = 1
+      properties[:pin_change_forced] = true
       true
     end
 
@@ -142,7 +142,7 @@ module VacmanController
     # Sets the "disabled" token status
     #
     def disable!
-      properties[:token_status] = 0
+      properties[:token_status] = :disabled
       true
     end
 
@@ -150,7 +150,7 @@ module VacmanController
     # Set the primary application enabled status
     #
     def enable_primary_only!
-      properties[:token_status] = 1
+      properties[:token_status] = :primary_only
       true
     end
 
@@ -158,7 +158,7 @@ module VacmanController
     # Set the backup application enabled status
     #
     def enable_backup_only!
-      properties[:token_status] = 2
+      properties[:token_status] = :backup_only
       true
     end
 
@@ -166,7 +166,7 @@ module VacmanController
     # Set both primary and backup application enabled status
     #
     def enable!
-      properties[:token_status] = 3
+      properties[:token_status] = :enabled
       true
     end
 

data/lib/vacman_controller/version.rb

@@ -0,0 +1,3 @@
+module VacmanController
+  VERSION = '0.6.0'
+end

data/lib/vacman_controller.rb

@@ -1,4 +1,4 @@
-require 'vacman_controller/low_level'
+require 'vacman_controller/vacman_low_level'
 require 'vacman_controller/token'
 require 'vacman_controller/kernel'
 require 'vacman_controller/error'
@@ -6,9 +6,6 @@ require 'vacman_controller/error'
 # Wraps VACMAN Controller functionality for Ruby.
 #
 module VacmanController
-
-  VERSION = '0.5.0'
-
   class << self
     # Imports a .dpx file containing the token key material.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vacman_controller
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marcus Lankenau
@@ -53,6 +53,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Expose the AAL2 SDK API via a set of Ruby classes optimised for developer
   happiness
 email:
@@ -63,13 +91,19 @@ extensions:
 - ext/vacman_controller/extconf.rb
 extra_rdoc_files: []
 files:
+- ext/vacman_controller/dpx.c
 - ext/vacman_controller/extconf.rb
-- ext/vacman_controller/low_level.c
+- ext/vacman_controller/kernel.c
+- ext/vacman_controller/main.c
+- ext/vacman_controller/serialize.c
+- ext/vacman_controller/token.c
+- ext/vacman_controller/vacman_controller.h
 - lib/vacman_controller.rb
 - lib/vacman_controller/error.rb
 - lib/vacman_controller/kernel.rb
 - lib/vacman_controller/token.rb
 - lib/vacman_controller/token/properties.rb
+- lib/vacman_controller/version.rb
 homepage: https://github.com/ifad/vacman_controller
 licenses: []
 metadata: {}