knuverse-knufactor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224e08737aef33c81546244ee7b5c61ee4dee62d
-  data.tar.gz: abd0db60daee18081303470062a4f120b5300e0c
+  metadata.gz: d6495c6005e362bb072ac482e12e65e230948415
+  data.tar.gz: e2715ef043a98af50920e28a190c3eea25eecd04
 SHA512:
-  metadata.gz: bbc6a2bdc236889d73413e8ebc55b0de64404c457eb522c028f217000f7de000d82088af673bf998a2fe08569864002d7cc43f81838cfcec234fee366bf260a2
-  data.tar.gz: 5c7d09db089ebf5517c98a3c97a145e134c627f8ca551954318cbb231d6e78cb2358330835c28b66c09d51a508180c370ae448443ebc3851183380f5cb14d76f
+  metadata.gz: 1ad718408ab62421877b13b2c111f1df17732a3eae75acde1d1ffd5895e4a3737bf24ee3435ad85dee670dd6b935dc09f79752e7d2332e3992c8eb7deb4f34b4
+  data.tar.gz: 13662a52e850d3827f9efab976d72808200f1f1a30cc29bb855e721b1d57ae9e854fb16bf0250ca3fd784c2eb0b9a5fb4a3ec3f030166ab6d83fb8799ab60902

data/README.md

@@ -6,6 +6,7 @@ About
 This project is a Ruby SDK that allows developers to create apps that use Knuverse's Knufactor Cloud APIs.
 
 Documentation for the API can be found [here](https://cloud.knuverse.com/docs/)
+Full documentation for this SDK can be found [here](http://www.rubydoc.info/gems/knuverse-knufactor/)
 
 Note that this SDK isn't a direct port of the [Python SDK](https://github.com/KnuVerse/knuverse-sdk-python), though it is based heavily on the work done there. This SDK uses a Object-Oriented pattern, which is likely more familiar to Ruby developers than a collection of functions may be.
 

data/lib/knuverse/knufactor/helpers/resource_class.rb

@@ -3,6 +3,31 @@ module KnuVerse
     module Helpers
       # Simple helper class methods for Resource
       module ResourceClass
+        # Determine a list of names to use to access a resource entity attribute
+        # @param original_name [String,Symbol] the name of the underlying attribute
+        # @param opts [Hash] property options as defined in a {Resource} subclass
+        # @return [Array<Symbol>] the list of names
+        def determine_getter_names(original_name, opts)
+          names = []
+          names << (opts[:type] == :boolean ? "#{original_name}?" : original_name)
+          if opts[:as]
+            Array(opts[:as]).each do |new_name|
+              names << (opts[:type] == :boolean ? "#{new_name}?" : new_name)
+            end
+          end
+          names.map(&:to_sym).uniq
+        end
+
+        # Determine a list of names to use to set a resource entity attribute
+        # @param original_name [String,Symbol] the name of the underlying attribute
+        # @param opts [Hash] property options as defined in a {Resource} subclass
+        # @return [Array<Symbol>] the list of names
+        def determine_setter_names(original_name, opts)
+          names = ["#{original_name}="]
+          names.concat Array(opts[:as]).map { |new_name| "#{new_name}=" } if opts[:as]
+          names.map(&:to_sym).uniq
+        end
+
         # Produce a more human-readable representation of {#i18n_key}
         # @note ActiveRecord ActiveModel::Name compatibility method
         # @return [String]

data/lib/knuverse/knufactor/resource.rb

@@ -37,6 +37,8 @@ module KnuVerse
       end
 
       # Set the URI path for a resource method
+      # @param kind [Symbol] how to refer to the URI
+      # @param uri [String] an API URI to refer to later
       def self.path(kind, uri)
         paths[kind.to_sym] = uri
       end
@@ -53,29 +55,35 @@ module KnuVerse
       end
 
       def self.gen_getter_method(name, opts)
-        method_name = opts[:type] == :boolean ? "#{name}?" : name
-        define_method(method_name.to_sym) do
-          name_as_string = name.to_s
-          reload if @lazy && !@entity.key?(name_as_string)
-
-          case opts[:type]
-          when :time
-            if @entity[name_as_string] && !@entity[name_as_string].to_s.empty?
-              Time.parse(@entity[name_as_string].to_s).utc
+        determine_getter_names(name, opts).each do |method_name|
+          define_method(method_name) do
+            name_as_string = name.to_s
+            reload if @lazy && !@entity.key?(name_as_string)
+
+            # Casting values based on type
+            case opts[:type]
+            when :time
+              if @entity[name_as_string] && !@entity[name_as_string].to_s.empty?
+                Time.parse(@entity[name_as_string].to_s).utc
+              end
+            else
+              @entity[name_as_string]
             end
-          else
-            @entity[name_as_string]
           end
         end
       end
 
       def self.gen_setter_method(name, opts)
-        define_method("#{name}=".to_sym) do |value|
-          raise Exceptions::ImmutableModification if immutable?
-          # TODO: allow specifying a list of allowed values and validating against it
-          @entity[name.to_s] = opts[:type] == :time ? Time.parse(value.to_s).utc : value
-          @tainted = true
-          @modified_properties << name.to_sym
+        determine_setter_names(name, opts).each do |method_name|
+          define_method(method_name) do |value|
+            raise Exceptions::ImmutableModification if immutable?
+            if opts[:validate]
+              raise Exceptions::InvalidArguments unless send("validate_#{name}".to_sym, value)
+            end
+            @entity[name.to_s] = opts[:type] == :time ? Time.parse(value.to_s).utc : value
+            @tainted = true
+            @modified_properties << name.to_sym
+          end
         end
       end
 

data/lib/knuverse/knufactor/resources/client.rb

@@ -3,6 +3,7 @@ module KnuVerse
     module Resources
       # The Knufactor Client resource
       #   rubocop:disable Style/ExtraSpacing
+      #   rubocop:disable Metrics/LineLength
       class Client < Resource
         property :bypass_expiration
         property :bypass_limit
@@ -19,25 +20,37 @@ module KnuVerse
         property :enroll_deadline_remaining_minutes
         property :has_password,           type: :boolean, read_only: true
         property :has_pin,                type: :boolean, read_only: true
-        property :has_verified,           type: :boolean, read_only: true
+        property :has_verified,           type: :boolean, read_only: true,  as: :verified
         property :help_tip,                               read_only: true
-        property :is_disabled,            type: :boolean
-        property :is_gauth,               type: :boolean, read_only: true
-        property :is_tenant_client,       type: :boolean, read_only: true
+        property :is_disabled,            type: :boolean,                   as: :disabled
+        property :is_gauth,               type: :boolean, read_only: true,  as: :gauth
+        property :is_tenant_client,       type: :boolean, read_only: true,  as: :tenant_client
         property :last_verification_date, type: :time,    read_only: true
         property :name,                                   read_only: true
         property :notification,                           read_only: true
         property :password,                               write_only: true
-        property :password_lock,          type: :boolean
+        property :password_lock,          type: :boolean,                   as: :password_locked, validate: true
         property :phone_number_last,                      read_only: true
         property :pin_rev,                                read_only: true
         property :role
         property :role_rationale
         property :row_doubling
         property :state,                                  read_only: true
-        property :verification_lock,      type: :boolean
+        property :verification_lock,      type: :boolean,                   as: :verification_locked, validate: true
         property :verification_speed
         property :verification_speed_floor,               read_only: true
+
+        private
+
+        # Used to validate {#password_lock} on set
+        def validate_password_lock(value)
+          value == false # only `false` is valid
+        end
+
+        # Used to validate {#password_lock} on set
+        def validate_verification_lock(value)
+          value == false # only `false` is valid
+        end
       end
     end
   end

data/lib/knuverse/knufactor/version.rb

@@ -4,7 +4,7 @@ module KnuVerse
     VERSION = [
       0, # Major
       0, # Minor
-      1, # Patch
+      2, # Patch
     ].join('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knuverse-knufactor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonathan Gnagy