afc_salesforce 0.1.0

data/lib/afc_salesforce/tools/validation/validator.rb

@@ -0,0 +1,128 @@
+module AFCSalesforce
+  module Tools
+    module Validation
+      module Rule
+        # A hash of rules for this object
+        def rules
+          @rules ||= {}
+        end
+
+        # A hash of errors for this object
+        def errors
+          @errors ||= {}
+        end
+
+        # Define a rule for this object
+        #
+        # The rule parameter can be one of the following:
+        #
+        # * a symbol that matches to a class in the AFCSalesforce::Tools::Validation::Rules namespace
+        #   * e.g. rule(:field, :not_empty)
+        # * a hash containing the rule as the key and it's parameters as the values
+        #   * e.g. rule(:field, :length => { minimum: 3, maximum: 5 })
+        # * an array combining the two previous types
+        #   * e.g. rule(:field, [:not_empty, length: { minimum: 3, maximum: 5}])
+        def rule(field, definition)
+          field = field.to_sym
+          rules[field] = [] if rules[field].nil?
+
+          if definition.respond_to?(:each_pair)
+            add_parameterized_rules(field, definition)
+          elsif definition.respond_to?(:each)
+            definition.each do |item|
+              if item.respond_to?(:each_pair)
+                add_parameterized_rules(field, item)
+              else
+                add_single_rule(field, item)
+              end
+            end
+          else
+            add_single_rule(field, definition)
+          end
+
+          self
+        end
+
+        # Determines if this object is valid. When a rule fails for a field,
+        # this will stop processing further rules. In this way, you'll only get
+        # one error per field
+        def valid?
+          valid = true
+
+          rules.each_pair do |field, rules|
+            if ! @obj.respond_to?(field)
+              raise InvalidKey, "cannot validate non-existent field '#{field}'"
+            end
+
+            rules.each do |r|
+              value = @obj.send(field)
+              if !r.valid_value?(value)
+                valid = false
+                errors[field] = {rule: r.error_key}.merge(r.error(value))
+                break
+              end
+            end
+          end
+
+          @valid = valid
+        end
+
+        protected
+
+        # Adds a single rule to this object
+        def add_single_rule(field, key_or_klass, params = nil)
+          klass = if key_or_klass.respond_to?(:new)
+            key_or_klass
+          else
+            get_rule_class_by_name(key_or_klass)
+          end
+
+          args = [params].compact
+          rule = klass.new(*args)
+          rule.obj = @obj if rule.respond_to?(:obj=)
+          rules[field] << rule
+        end
+
+        # Adds a set of parameterized rules to this object
+        def add_parameterized_rules(field, rules)
+          rules.each_pair do |key, params|
+            add_single_rule(field, key, params)
+          end
+        end
+
+        # Resolves the specified rule name to a rule class
+        def get_rule_class_by_name(klass)
+          klass = camelize(klass)
+          AFCSalesforce::Tools::Validation::Rule.const_get(klass)
+        rescue NameError => e
+          raise InvalidRule.new(e)
+        end
+
+        # Converts a symbol to a class name, taken from rails
+        def camelize(term)
+          string = term.to_s
+          string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+          string.gsub(/(?:_|(\/))([a-z\d]*)/i) { $2.capitalize }.gsub('/', '::')
+        end
+      end
+
+
+      class Validator
+        include AFCSalesforce::Tools::Validation::Rule
+
+        def initialize(obj)
+          @rules = self.class.rules if self.class.is_a?(AFCSalesforce::Tools::Validation::Rule)
+          @obj = obj
+        end
+      end
+
+      # InvalidKey is raised if a rule is added to a field that doesn't exist
+      class InvalidKey < RuntimeError
+      end
+
+      # InvalidRule is raised if a rule is added that doesn't exist
+      class InvalidRule < RuntimeError
+      end
+    end
+  end
+end

data/lib/afc_salesforce/version.rb

@@ -0,0 +1,3 @@
+module AFCSalesforce
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: afc_salesforce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donavan White
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Ruby lib for handling the connection to REST endpoints on any Sandbox
+  and Production Salesforce
+email:
+- donavan.white@americanfinancing.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- afc_salesforce.gemspec
+- bin/console
+- bin/setup
+- lib/afc_salesforce.rb
+- lib/afc_salesforce/account.rb
+- lib/afc_salesforce/additional_income.rb
+- lib/afc_salesforce/ahc_realtor.rb
+- lib/afc_salesforce/asset.rb
+- lib/afc_salesforce/base.rb
+- lib/afc_salesforce/borrower.rb
+- lib/afc_salesforce/configuration.rb
+- lib/afc_salesforce/forms/agent_referral.rb
+- lib/afc_salesforce/forms/long_purchase.rb
+- lib/afc_salesforce/forms/long_refinance.rb
+- lib/afc_salesforce/forms/short_lead.rb
+- lib/afc_salesforce/lead.rb
+- lib/afc_salesforce/models/account.rb
+- lib/afc_salesforce/models/ahc_realtor.rb
+- lib/afc_salesforce/models/asset.rb
+- lib/afc_salesforce/models/base.rb
+- lib/afc_salesforce/models/concerns/type_setter.rb
+- lib/afc_salesforce/models/contact.rb
+- lib/afc_salesforce/models/income.rb
+- lib/afc_salesforce/models/lead.rb
+- lib/afc_salesforce/tools.rb
+- lib/afc_salesforce/tools/utilities.rb
+- lib/afc_salesforce/tools/validation.rb
+- lib/afc_salesforce/tools/validation/rule/email.rb
+- lib/afc_salesforce/tools/validation/rule/instance_of.rb
+- lib/afc_salesforce/tools/validation/rule/length.rb
+- lib/afc_salesforce/tools/validation/rule/matches.rb
+- lib/afc_salesforce/tools/validation/rule/not_empty.rb
+- lib/afc_salesforce/tools/validation/rule/not_nil.rb
+- lib/afc_salesforce/tools/validation/rule/numeric.rb
+- lib/afc_salesforce/tools/validation/rule/phone.rb
+- lib/afc_salesforce/tools/validation/rule/regular_expression.rb
+- lib/afc_salesforce/tools/validation/validator.rb
+- lib/afc_salesforce/version.rb
+homepage: https://www.americanfinancing.net
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Salesforce Library for the AFC Salesforce Instance
+test_files: []