leap_salesforce 0.1.0 → 0.1.1

data/lib/leap_salesforce/soql_data/data_relationships.rb

@@ -9,27 +9,27 @@ module DataRelationships
   def organisation
     raise '"Organisation" class not yet defined' unless defined? Organisation
 
-    Organisation.get(Id: self['AccountId'])
+    Organisation.find(Id: self['AccountId'])
   end
 
   # @example Get user name
   #   record.owner.name
   # @return [Exchange] object representing owner of object
   def owner
-    User.get(Id: self[:owner_id])
+    User.find(Id: self[:owner_id])
   end
 
   # @example Get user name
   #   record.queue.name
   # @return [Exchange] object representing owner of object
   def queue
-    Group.get(Id: self[:owner_id])
+    Group.find(Id: self[:owner_id])
   end
 
   # Retrieve record type for current object
   def record_type
     raise '"RecordType" class not yet defined' unless defined? RecordType
 
-    RecordType.get(Id: self['RecordTypeId'])
+    RecordType.find(Id: self['RecordTypeId'])
   end
 end

data/lib/leap_salesforce/soql_data/soql_data.rb

@@ -79,8 +79,8 @@ class SoqlData < Exchange
   # Get details of itself by searching for it's id
   # Store response within itself
   # @return [Exchange] Exchange with details of data
-  def get
-    @response = self.class.get(Id: id).response # Make get call and store result
+  def find
+    @response = self.class.find(Id: id).response # Make get call and store result
     self
   end
 

data/lib/leap_salesforce/soql_data/soql_global_data.rb

@@ -19,6 +19,8 @@ module SoqlGlobalData
   #   objects.size
   # @example Find description of object with label Organisation
   #   org_desc = SoqlData.global_describe['sobjects'].find { |obj| obj['label'] == 'Organisation' }
+  # @example Find names of all objects that include 'File' in their label
+  #   SoqlData.global_describe['sobjects'].find_all { |obj| obj['label'].include? 'File' }.collect { |f| f['name'] }
   # @return [Exchange] Global describe of salesforce Objects
   def global_describe
     @global_describe ||= new('Global describe of sobjects', method: :get, suburl: 'sobjects/')

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -63,21 +63,26 @@ module SoqlGlobalObjectData
     query
   end
 
-  # Get the response data for a SoqlObject using the calling class's table.
+  # Find the data for a single SoqlObject using the calling class's table.
   # Will get the latest created date.
-  # @example
-  #   # Get a contact where LastName is 'Bob'
-  #   Contact.get(LastName: 'Bob')
+  # @example Get a contact where LastName is 'Bob'
+  #   Contact.find(LastName: 'Bob')
+  # @example Get a contact that includes 'Test' in their first name
+  #   Contact.find(~FirstName: '~%Test%')
+  # @example Get a contact created 10 days ago
+  #   Contact.find CreatedDate: "<#{10.days.ago}"
   # @param [Hash] lookup Key value pair unique to Salesforce to query for
   # @option lookup [Boolean] :teardown Whether to remove id after scenario finished
   # @return [SoqlData]
-  def get(lookup)
+  def find(lookup)
     teardown = lookup.delete(:teardown)
+    wait = lookup.delete(:wait) || true
     SoqlHandler.new("Query on #{self}").use
     instance_to_get = if lookup.key? :Id
                         new("Lookup id: #{lookup[:Id]}", method: :get, suburl: "sobjects/#{soql_object_name}/#{lookup[:Id]}")
                       else
-                        initial_query = query "SELECT Id FROM #{soql_object_name} #{soql_lookup_filter(lookup)}"
+                        initial_query = query "SELECT Id FROM #{soql_object_name} #{soql_lookup_filter(lookup)}",
+                                              wait: wait
                         data_from_url initial_query['$..url'], lookup
                       end
     SoqlData.ids_to_delete[self] = instance_to_get[:id] if teardown
@@ -124,7 +129,7 @@ module SoqlGlobalObjectData
   # @return [Array] List of Soql objects matching criteria
   def each_with(lookup)
     ids = each_id_with lookup
-    ids.collect { |id| get(Id: id) }
+    ids.collect { |id| find(Id: id) }
   end
 
   # Remove all ids from table that match lookup criteria
@@ -191,7 +196,7 @@ module SoqlGlobalObjectData
       rescue NoElementAtPath
         raise diagnose_error if error_message?
 
-        @response = get.response
+        @response = find.response
         self[backend_name]
       end
     end

data/lib/leap_salesforce/soql_object.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module LeapSalesforce
+  # Container for information regarding a SoqlObject
+  class SoqlObject
+    # @return [String] Ruby class name
+    attr_accessor :class_name
+    # @return [String] Salesforce backend name
+    attr_accessor :backend_name
+    # @return [String] Snakecase version of ruby class. Name for methods / files to refer to class as
+    attr_accessor :reference
+    # @return [String] Description of Soql object from '.leap_salesforce' YAML
+    attr_accessor :description
+    # @return [Boolean] Whether to create enumerations for object
+    attr_accessor :create_enum
+
+    # Create a representation of a Soql object from a description (usually in .leap_salesforce.yml)
+    def initialize(description)
+      self.description = description
+      interpret_description
+      self.reference = @class_name.snakecase
+    end
+
+    private
+
+    # Set attributes based on description
+    def interpret_description
+      if description.is_a? Hash
+        interpret_hash_description
+      else
+        self.backend_name = description.to_s
+        self.class_name = backend_name.tr(" '/()-", '').tr('ā', 'a')
+        self.create_enum = true
+      end
+    end
+
+    # Set attributes based on description where description is a Hash
+    def interpret_hash_description
+      self.create_enum = create_enum?
+      self.class_name = description.keys[0]
+      self.backend_name = description.values[0] || description.keys[0]
+    end
+
+    # @return [Boolean] Whether to create enum. Default is true.
+    def create_enum?
+      description['create_enum'].nil? ? true : description['create_enum']
+    end
+  end
+end

data/lib/leap_salesforce/users/user.rb

@@ -23,5 +23,17 @@ module LeapSalesforce
     def username
       ERB.new(@username).result(binding)
     end
+
+    # @param [Symbol, String] field Field to check
+    # @param [Object, Regex] criteria Either object with same value or regex that has a match anywhere in string
+    # @return [Boolean] Whether key and criteria match current user
+    def match?(field, criteria)
+      actual_value = send(field.to_s)
+      case criteria
+      when Regexp then !actual_value[criteria].nil?
+      else
+        actual_value == criteria
+      end
+    end
   end
 end

data/lib/leap_salesforce/users/users.rb

@@ -8,17 +8,27 @@ module LeapSalesforce
     @list = []
     class << self
       # @return [Array] List of test users
-      attr_reader :list
+      attr_accessor :list
 
-      # @param [LeapSalesforce::User]
+      # @param [LeapSalesforce::User] user Test user to add to leap salesforce
       def add(user)
-        @list << user
+        return @list << user if user.is_a? LeapSalesforce::User
+
+        unless user.is_a? Array
+          raise LeapSalesforce::UserError, "Incorrect type #{user.class} for user. Expected either " \
+          'type LeapSalesforce::User or Array'
+        end
+
+        @list << User.new(*user)
       end
 
       # Return a user that meets the criteria
       def where(filter)
         lookup_key, lookup_value = filter.first
-        @list.find { |user| user.send(lookup_key) == lookup_value }
+        user = @list.find { |user_queried| user_queried.match?(lookup_key, lookup_value) }
+        raise LeapSalesforce::UserError, "Unable to find user based on filer #{filter}" unless user
+
+        user
       end
     end
   end

data/lib/leap_salesforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LeapSalesforce
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/leap_salesforce.rb

@@ -3,13 +3,16 @@
 require 'leap_salesforce/version'
 
 require 'soaspec'
+Soaspec::OAuth2.refresh_token = :once # Save access token and reuse it
+Soaspec.log_warnings = false # Log any API warnings
 require 'active_support/core_ext/integer/time' # Creating time objects
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/ext/string'
 require 'leap_salesforce/ext/time'
 require 'require_all'
 require 'rake'
-require 'factory_bot'
+require 'factory_bot' # For mass production of data
+require 'faker' # For fake data
 
 module LeapSalesforce
   class Error < StandardError; end
@@ -17,6 +20,9 @@ module LeapSalesforce
   class ResponseError < StandardError; end
   # Error related to setup of test automation suite
   class SetupError < Error; end
+  # Error related to Test Users
+  class UserError < Error;
+  end
 end
 
 LEAP_CONFIG_FILE = '.leap_salesforce.yml'
@@ -52,12 +58,16 @@ end
   raise LeapSalesforce::SetupError, "LeapSalesforce.#{param} not set" if LeapSalesforce.send(param).nil?
 end
 
-require File.join(Dir.pwd, LeapSalesforce.config_folder, 'general')
-require File.join(Dir.pwd, LeapSalesforce.config_folder, 'environments', LeapSalesforce.environment)
+config_folder = File.join(Dir.pwd, LeapSalesforce.config_folder)
+general_file = File.join(config_folder, 'general')
+specific_environment_file = File.join(config_folder, 'environments', LeapSalesforce.environment)
+require general_file if File.exist? "#{general_file}.rb"
+require specific_environment_file if File.exist? "#{specific_environment_file}.rb"
 
 require 'leap_salesforce/soql_data/soql_data'
 require 'leap_salesforce/limits'
 
+FileUtils.mkdir_p LeapSalesforce.lib_folder unless Dir.exist? LeapSalesforce.lib_folder
 require_all LeapSalesforce.lib_folder
 
 LeapSalesforce.objects_to_verify = SoqlData.descendants if LeapSalesforce.objects_to_verify.empty?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: faker
-  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -54,41 +40,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: topoisomerase
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: topoisomerase
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -96,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -214,11 +200,13 @@ email:
 - samuel.garratt@integrationqa.com
 - leap.salesforce@integrationqa.com
 executables:
-- leap-salesforce
+- leap_salesforce
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
+- ".idea/.rakeTasks"
 - ".idea/dictionaries/iqa.xml"
 - ".idea/leap-salesforce.iml"
 - ".idea/markdown-navigator.xml"
@@ -231,24 +219,39 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
+- ChangeLog
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- exe/leap-salesforce
+- config/environments/prod.rb
+- config/general.rb
+- exe/leap_salesforce
 - leap_salesforce.gemspec
 - lib/leap_salesforce.rb
 - lib/leap_salesforce/ext/string.rb
 - lib/leap_salesforce/ext/time.rb
-- lib/leap_salesforce/generator/default_fields.rb
+- lib/leap_salesforce/generator/default.rb
+- lib/leap_salesforce/generator/exe_helpers.rb
+- lib/leap_salesforce/generator/generator.rb
 - lib/leap_salesforce/generator/soql_enums.rb
 - lib/leap_salesforce/generator/soql_objects.rb
+- lib/leap_salesforce/generator/templates/.leap_salesforce.yml.erb
+- lib/leap_salesforce/generator/templates/.rspec.erb
+- lib/leap_salesforce/generator/templates/Gemfile.erb
+- lib/leap_salesforce/generator/templates/Rakefile.erb
+- lib/leap_salesforce/generator/templates/config/credentials/salesforce_oauth2.yml.erb
+- lib/leap_salesforce/generator/templates/config/environments/specific_file.rb.erb
+- lib/leap_salesforce/generator/templates/config/general.rb.erb
 - lib/leap_salesforce/generator/templates/factory.rb.erb
 - lib/leap_salesforce/generator/templates/picklist.rb.erb
 - lib/leap_salesforce/generator/templates/soql_object.rb.erb
 - lib/leap_salesforce/generator/templates/soql_object_field_names.rb.erb
+- lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb
+- lib/leap_salesforce/generator/templates/spec/limit_spec.rb.erb
+- lib/leap_salesforce/generator/templates/spec/spec_helper.rb.erb
 - lib/leap_salesforce/limits.rb
 - lib/leap_salesforce/parameters.rb
 - lib/leap_salesforce/rake.rb
@@ -262,6 +265,7 @@ files:
 - lib/leap_salesforce/soql_data/soql_handler.rb
 - lib/leap_salesforce/soql_data/soql_object_describe.rb
 - lib/leap_salesforce/soql_data/soql_settings.rb
+- lib/leap_salesforce/soql_object.rb
 - lib/leap_salesforce/users/user.rb
 - lib/leap_salesforce/users/users.rb
 - lib/leap_salesforce/version.rb
@@ -284,8 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Helps with setting up integrated automated test frameworks against Salesforce.

data/exe/leap-salesforce

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'leap/salesforce'
-
-# Ask for test user details
-#

data/lib/leap_salesforce/generator/default_fields.rb

@@ -1,13 +0,0 @@
-module LeapSalesforce
-  module DefaultFields
-    class << self
-      def contact
-        %w[FirstName LastName]
-      end
-
-      def account
-        ['Name']
-      end
-    end
-  end
-end