leap_salesforce 0.2.23 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da79723306cce1184458cea71bcd195548c701f48fa3de87961d2d95becc99d4
-  data.tar.gz: 587308a13bfd4164e27638c82ee8adc59a833165aaeb3561b26b17e944ab455e
+  metadata.gz: 985b2a787327d829a036c867917e750a9fcbcd6c1a06879b70b99d4ca7712ef6
+  data.tar.gz: 3b743a1a1f41024f5f97f1213c36949ec5f447f88ed070c593851caf74dc2ee2
 SHA512:
-  metadata.gz: eeb1dfacd0c1812b5637c7709d34303a7e852e308f87d8c789e6993aecf9ab3261a3c90df42cdde17d49ed337b14ac5c0a00998de639fc8bd98b2617150a2a9e
-  data.tar.gz: 0d5ca787cdebd092f3a21c1489d57b56f0236272740fe1129e945729cda776eea007f66b2e1b021a5b217db9c28f6c696fa7836f9df841cb89cdb4049239449d
+  metadata.gz: 97b52f1ef171e95bfaccb1564b1956d375bbdb2293b95015e87e8bcd38130d9cc46cda400330560dff5cdd23f75b8ac6f57eb3c7bce15f15ba57bb3a3a16f097
+  data.tar.gz: 5efd8b9a0679ac8472ae9ee8d11652c0a01c88ff51f531fbea468cf284aa9341c1a667666f6a16bf323deb183f9af8af5ce98da792f169f96d4c98484d8d3afb

data/.gitlab-ci.yml

@@ -1,7 +1,7 @@
 include:
   - template: Code-Quality.gitlab-ci.yml
 
-image: ruby:2.6
+image: ruby:2.7
 
 stages:
   - test
@@ -18,7 +18,7 @@ variables:
 pages:
   stage: deploy
   dependencies:
-    - test
+    - test_2.7
   script:
     - mv coverage/ public
   artifacts:
@@ -600,25 +600,49 @@ pages:
     done
   }
 
-test:
+  function setup_integration_env() {
+    # Decrypt server key
+    openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
+    ls -la assets
+    install_jq
+    install_salesforce_cli
+    # Integrated test
+    gem install bundler rake
+    bundle install
+    sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+  }
+
+test_2.6:
+  image: ruby:2.6
   stage: test
+  script:
+    - *sfdx_helpers
+    - setup_integration_env
+    - bundle exec rake check_oauth   # Check OAuth
+    - bundle exec rake leaps:create_soql_objects
+    - bundle exec rake leaps:create_enums
+    - bundle exec rspec
+
+test_2.7:
   script:
     # Decrypt server key
     - *sfdx_helpers
-    - openssl aes-256-cbc -d -md md5 -in assets/server.key.enc -out assets/server.key -k $SERVER_KEY_PASSWORD
-    - ls -la assets
-    - install_jq
-    - install_salesforce_cli
-    # Integrated test
-    - ruby -v
-    - which ruby
-    - gem install bundler rake
-    - bundle install
-    - sfdx force:auth:jwt:grant --clientid "$SF_CONSUMER_KEY" --jwtkeyfile assets/server.key --username "$SF_USERNAME" --setdefaultdevhubusername --setalias HubOrg
+    - setup_integration_env
     - bundle exec rake check_oauth   # Check OAuth
     - bundle exec rake leaps:create_soql_objects
     - bundle exec rake leaps:create_enums
-    - bundle exec rspec_booster --job $CI_NODE_INDEX/$CI_NODE_TOTAL
+    - bundle exec rspec
   artifacts:
     paths:
       - coverage/
+
+test_3.0:
+  image: ruby:3.0
+  script:
+    # Decrypt server key
+    - *sfdx_helpers
+    - setup_integration_env
+    - bundle exec rake check_oauth   # Check OAuth
+    - bundle exec rake leaps:create_soql_objects
+    - bundle exec rake leaps:create_enums
+    - bundle exec rspec

data/.leap_salesforce.yml

@@ -6,9 +6,15 @@ soql_objects:
   - Contact
   - Document: ContentDocument
   - User:
-    create_enum: true # Set this to false to not track enums for object
-  - Group
+    create_enum:
+      exclude:
+        - Time
+  - Group:
+    create_enum: false # Set this to false to not track enums for object
   - Broker: Broker__c
-  - Account
+  - Account:
+    create_enum:
+      exclude:
+        - Rating
   - Attachment
   - EventLogFile

data/.rubocop.yml

@@ -1,3 +1,17 @@
 # Modifies RuboCop (Static analysis tool)
 Layout/LineLength:
-  Max: 160
+  Max: 160
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/ChangeLog

@@ -1,3 +1,29 @@
+Version 1.0.0
+* Enhancement
+  * Disable rubocop output for pending ops when creating/fixing files
+  * Specify that working with Ruby 3 is a work in progress
+
+Version 0.2.28
+* Enhancement
+  * Make exclude method able to use class name in exclusion filter (hence easier to use)
+
+Version 0.2.27
+* Bug fix
+  * Patch to update deprecated `create_enum` method so it allows 1 parameter
+
+Version 0.2.26
+* Enhancement
+  * Create method to exclude picklists being created based on regexp in .leap_salesforce.yml
+
+Version 0.2.25
+* Enhancement
+  * `execute_as` user method that raises error if user not present
+
+Version 0.2.24
+* Bug fix
+  * Handle metadata label name that is the same name as a method on SoqlData (which one would not want overwriting)
+    such as 'status_code'
+
 Version 0.2.23
 * Enhancement
   * Raise better error when could not find record using query
@@ -205,4 +231,4 @@ Version 0.1.1
   * Suggestions for generated factory
   * Begin unit tests
   * Handle Macrons by ensuring they're not copied into Ruby names / Modules
-  * Created executable
+  * Created executable

data/PITCHME.md

@@ -80,7 +80,7 @@ metadata.
 @[3](Declare what it is you're testing)
 @[5](Define what 'it' is, a the object under test must do)
 @[6](Create an instance of the object class - nothing sent to Salesforce yet)
-@[7-8](Set the first and last name to random names)
+@[4,7-8](Set the first and last name to random names)
 @[9](Create the object in Salesforce by sending request via API)
 @[10](Verify creation was successful)
 @[11](Verify first name set as expected)
@@ -92,8 +92,8 @@ metadata.
 
 ---?code=spec/integration/query_spec.rb&lang=ruby&title=Querying entities
 
-@[6](Find an object using a specific attribute specific value)
-@[19](Find an object using a comparator)
+@[21](Find an object using a specific attribute specific value)
+@[29-30](Find list of objects meeting condition)
 
 ---
 

data/README.md

@@ -258,6 +258,10 @@ This method can be used directly with the backend name. E.g, `contact[:FieldName
 This method in turn sets a value of the `@override_parameters[:body]` variable within the entity. 
 The value of request body can be interrogated with `entity.request_parameters.body`.
 
+##### Logging
+
+By default, API traffic will be logged in a log file in a `logs` folder. 
+
 ### CRUD of data
 
 To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
@@ -560,3 +564,5 @@ Everyone interacting in the LeapSalesforce project’s codebases, issue trackers
 
 * Presentation on this library [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)
 * Example of this library within a CI/CD pipeline [here](https://gitlab.com/iqa_public/labs/salesforce_cicd_demo)
+* Using `leap_salesforce` to download event log files [here](https://gitlab.com/samuel-garratt/leap_salesforce_event_log_files)
+

data/Rakefile

@@ -34,3 +34,21 @@ YARD::Doctest::RakeTask.new do |task|
   # TODO: Get all examples working in this way
   task.pattern = 'lib/leap_salesforce/ext/string.rb'
 end
+
+desc 'Task to enter pry terminal and types commands using the standard library code'
+task :pry do
+  require 'pry'
+  Pry.start
+end
+
+desc 'Example of cleaning up data'
+task :remove_contacts do
+  contacts = Contact.where first_name: '!null'
+  puts "Deleting #{contacts.size} contacts"
+  contacts.each do |contact|
+    contact.delete
+    print '.'
+  end
+  contacts = Contact.where first_name: '!null'
+  puts "#{contacts.size} contacts left"
+end

data/config/environments/prod.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Files with the format 'env.rb' should be used if
 
 Soaspec::OAuth2.debug_oauth = false # Turn this true if you need debug authentication

data/config/general.rb

@@ -7,4 +7,4 @@ module LeapSalesforce
   Users.add User.new :cet, 'test.cet@brave-otter-ttxype.com'
 end
 
-ENV['SF_USERNAME'] = 'samuel.garratt@brave-otter-ttxype.com'
+ENV['SF_USERNAME'] = 'samuel.garratt@brave-otter-ttxype.com'

data/exe/leap_salesforce

@@ -56,4 +56,4 @@ module LeapSalesforce
   end
 end
 
-LeapSalesforce::Exe.start(ARGV)
+LeapSalesforce::Exe.start(ARGV)

data/lib/leap_salesforce/ext/string.rb

@@ -6,14 +6,21 @@ require 'active_support/core_ext/string'
 require 'date'
 require 'json'
 
+class MockHandler < Soaspec::RestHandler
+  base_url 'mock_url'
+end
+
 # Override string object to provide convenience methods for Strings
 class String
   # @return [Array] List of keywords reserved for FactoryBot
-  FACTORY_WORDS = ['sequence']
+  FACTORY_WORDS = ['sequence'].freeze
   # @return [Array] List of ruby keywords. Some words are only key to FactoryBot like 'sequence'
   KEYWORDS = %w[BEGIN END __ENCODING__ __END__ __FILE__ __LINE__ alias and begin break case class def defined?
                 do else elsif end ensure false for if in module next nil not or redo rescue retry return
                 self super then true undef unless until when while yield private].freeze
+  Soaspec.api_handler = MockHandler.new
+  SOQLDATA_METHODS = Exchange.new.public_methods.collect(&:to_s)
+
   # @note This removes '?' which is allowed in a method but is not desired for automatic creation of their names
   #   in the way that is being used here
   # @return [String] Convert string to something that would be friendly to use as in Ruby
@@ -112,6 +119,6 @@ class String
 
   # @return [Boolean] Whether string is a Ruby keyword
   def keyword?
-    KEYWORDS.include?(self) || FACTORY_WORDS.include?(self)
+    KEYWORDS.include?(self) || FACTORY_WORDS.include?(self) || SOQLDATA_METHODS.include?(self)
   end
 end

data/lib/leap_salesforce/generator/soql_enums.rb

@@ -28,7 +28,10 @@ module LeapSalesforce
       # @param [LeapSalesforce::SoqlData] entity An object representing an object in Salesforce
       #   Object inheriting from SoqlData that has picklists underneath it
       def create_picklists_for(entity)
-        unless entity.create_enum?
+        soql_object = LeapSalesforce.soql_objects.find { |so| so.class_name == entity.to_s }
+        raise "Could not find soql object for '#{entity}'" unless soql_object
+
+        unless soql_object.create_enum != false
           puts "Skipping picklists for #{entity}"
           return
         end
@@ -36,7 +39,13 @@ module LeapSalesforce
         @entity_name = entity
         picklists = entity.picklists
         puts "#{picklists.count} picklists found"
-        picklists.each { |picklist| generate_picklist_file picklist }
+        picklists.each do |picklist|
+          if soql_object.excludes?(picklist)
+            puts "Excluding picklist '#{picklist}'"
+          else
+            generate_picklist_file picklist
+          end
+        end
       end
 
       # Generate file for a picklist from it's metadata
@@ -61,7 +70,7 @@ module LeapSalesforce
 
       # Clean up files generated for all picklists
       def cleanup_files_created
-        `rubocop -a #{ENUM_FOLDER}`
+        `rubocop -a #{ENUM_FOLDER} --display-only-fail-level-offenses --enable-pending-cops`
       end
     end
   end

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -62,8 +62,8 @@ module LeapSalesforce
           generate_field_module
           generate_factory
         end
-        `rubocop -a #{SOQL_OBJECT_FOLDER}`
-        `rubocop -a #{FACTORY_FOLDER}`
+        `rubocop -a #{SOQL_OBJECT_FOLDER} --enable-pending-cops`
+        `rubocop -a #{FACTORY_FOLDER} --enable-pending-cops`
       end
 
       private

data/lib/leap_salesforce/generator/templates/soql_object.rb.erb

@@ -3,5 +3,4 @@ require_relative '<%= @field_name_file %>'
 class <%= @soql_object.class_name %> < SoqlData
   include <%= @soql_object.class_name %>::Fields
   <%= "soql_object '#{@soql_object.backend_name}'" unless @soql_object.backend_name == @soql_object.class_name %>
-  <%= "create_enum false" if @soql_object.create_enum == false %>
 end

data/lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb

@@ -4,8 +4,8 @@
 # Depending on validation rules and mandatory fields this may or may not work
 
 RSpec.describe 'Contact CRUD' do
-  let(:uniq_value) { 'UNIQ FIRST NAME' }
-  let(:updated_value) { 'New Value' }
+  let(:uniq_value) { "UNIQ #{Faker::Name.first_name} #{Faker::Name.middle_name}" }
+  let(:updated_value) { "New #{Faker::Name.first_name} #{Faker::Name.neutral_first_name}" }
   it 'Create using factory bot' do
     @contact = FactoryBot.create(:contact)
   end

data/lib/leap_salesforce/leaps.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Create a Leaps alias to LeapSalesforce as it's faster to type.
 # This will not be automatically required in case as 'Leaps' may be defined elsewhere
 
 require 'leap_salesforce'
-Leaps = LeapSalesforce
+Leaps = LeapSalesforce

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -154,6 +154,12 @@ module SoqlGlobalObjectData
   # @param [Symbol, String] name Name of accessor to refer to field/element with
   # @param [String] backend_name Name of Salesforce field
   def soql_element(name, backend_name)
+    if String::SOQLDATA_METHODS.include?(name.to_s)
+      LeapSalesforce.logger.warn "Cannot create metadata for '#{name}' (defined at #{caller_locations[0]})" \
+      ' as method already defined in SoqlData'
+      return
+    end
+
     # Either set the element (if creating a new record) or update the object
     # @param [String] new_value Value to update record to
     define_method("#{name}=") do |new_value|

data/lib/leap_salesforce/soql_data/soql_settings.rb

@@ -14,18 +14,9 @@ module SoqlSettings
     @soql_object_name || to_s
   end
 
-  # Whether to create enumerations for object when running generation tasks. By default this is true
-  # For some objects you may want to use them without tracking their enumerations
-  def create_enum(set)
-    @create_enum = set
-  end
-
-  # @return [Boolean] Whether to create enum for object
-  def create_enum?
-    if @create_enum.nil?
-      true # True by default
-    else
-      @create_enum
-    end
+  # @deprecated Not used, setting in '.leap_salesforce.yml' controls this now
+  def create_enum(_set)
+    LeapSalesforce.logger.warn "Method 'create_enum' called when it is deprecated" \
+    " from #{caller_locations[0]}"
   end
 end

data/lib/leap_salesforce/soql_object.rb

@@ -11,17 +11,42 @@ module LeapSalesforce
     attr_accessor :reference
     # @return [String] Description of Soql object from '.leap_salesforce' YAML
     attr_accessor :description
-    # @return [Boolean] Whether to create enumerations for object
+    # @return [Boolean, Hash] 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)
-    # @param [Hash, String]
+    # @example Specific Salesforce object 'Case' to be represented
+    #   'Case'
+    # @example Represent Broker object by class with different name
+    #   { 'Broker' => Broker__c }
+    # @example Represent Group object, specifying to ignore enums
+    #   {"Group"=>nil, "create_enum"=>true} }
+    # @example Represent User object, specifying to ignore enum with name of Timezone
+    #   {"User"=>nil, "create_enum"=>{"exclude"=>["Timezone"]}}
+    # @param [Hash, String] description
     def initialize(description)
       self.description = description
       interpret_description
       self.reference = @class_name.snakecase
     end
 
+    # @param [String] picklist
+    # @return [Boolean] Whether picklist should be excluded from being generated
+    def excludes?(picklist)
+      if create_enum.is_a? Hash
+        if create_enum['exclude']
+          picklist_class = picklist.to_class_name
+          create_enum['exclude'].any? do |exclusion_list|
+            !picklist.to_s[Regexp.new(exclusion_list)].nil? || !picklist_class[Regexp.new(exclusion_list)].nil?
+          end
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
     private
 
     # Set attributes based on description

data/lib/leap_salesforce/users/user.rb

@@ -16,9 +16,9 @@ module LeapSalesforce
 
     # @param [String, Symbol] key Key used to identify a test user
     # @param [String] username Name used to login with user. In email address format.
-    def initialize(key, username, description: nil)
-      self.key = key
-      self.username = username
+    def initialize(*user_params, description: nil)
+      self.key = user_params[0]
+      self.username = user_params[1]
       self.description = description
     end
 

data/lib/leap_salesforce/users/users.rb

@@ -23,18 +23,31 @@ module LeapSalesforce
           raise LeapSalesforce::UserError, "Incorrect type #{user.class} for user. Expected either " \
           'type LeapSalesforce::User or Array'
         end
+        if user[2]
+          desc = user[2].is_a?(Hash) ? user[2].values[0] : user[2].dup
+          user[2] = nil
+        end
 
-        @list << User.new(*user)
+        @list << User.new(*user, description: desc)
       end
 
+      # @example Filter user by key of :admin
+      #   where(key: :admin)
+      # @example Filter user by description containing Payroll
+      #   where(description: /Payroll/)
+      # @example Filter user by username
+      #   where(username: 'username@domain.com')
       # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find users by
-      # @param [Boolean] all Whether to return all users matching criteria, not just first
-      # @return [LeapSalesforce::User, Array] A user that meets the criteria
-      def where(filter, all: false)
-        @all = all
+      # @param_key [Boolean] all Whether to return all users matching criteria, not just first
+      # @return [LeapSalesforce::User, Array] A user that meets the criteria.
+      #   If all is true this returns array of users
+      def where(filter)
+        @all = false
         case filter
         when :default then list.first # Will then use first user defined
-        when Hash then match_params filter
+        when Hash
+          @all = filter[:all] || false
+          match_params filter
         when String then match_params(username: filter)
         when Symbol then match_params(key: filter)
         when Regexp then match_params(description: filter)
@@ -49,7 +62,7 @@ module LeapSalesforce
       # Iterate through each user, narrowing on filter if provided
       def each(filter = nil)
         if filter
-          where(filter, all: true).each { yield }
+          where({**filter, all: true}).each { yield }
         else
           list.each { yield }
         end
@@ -66,20 +79,26 @@ module LeapSalesforce
         @all ? users : users.first
       end
 
+      # @param [Symbol, Hash, String, Regexp, LeapSalesforce::User] filter Filter to find user by
+      # @return [Object] Result of block
+      def execute_as(filter)
+        current_user = LeapSalesforce.api_user
+        LeapSalesforce.api_user = LeapSalesforce::Users.where filter
+        result = yield
+        LeapSalesforce.api_user = current_user
+        result
+      end
+
       # Execute block as user matching filter if that user is present
       # If user is not present the current user will be used
       # @return [Object] Result of block
-      def execute_as_if_present(filter)
+      def execute_as_if_present(user_filter)
         raise ArgumentError, 'Pass block to :execute_as_if_present method' unless block_given?
 
-        current_user = LeapSalesforce.api_user
-        if any? filter
-          LeapSalesforce.api_user = LeapSalesforce::Users.where filter
-          result = yield
-          LeapSalesforce.api_user = current_user
-          result
+        if any? user_filter
+          execute_as(user_filter) { yield }
         else
-          LeapSalesforce.logger.warn "No user found user filter #{filter}, using '#{current_user}'"
+          LeapSalesforce.logger.warn "No user found user filter #{user_filter}, using '#{LeapSalesforce.api_user}'"
           yield
         end
       end

data/lib/leap_salesforce/version.rb

@@ -2,5 +2,5 @@
 
 module LeapSalesforce
   # @return [String] Version of leap salesforce
-  VERSION = '0.2.23'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.23
+  version: 1.0.0
 platform: ruby
 authors:
 - IQA
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-14 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -355,7 +355,7 @@ homepage: https://gitlab.com/leap-dojo/leap_salesforce
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -371,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Helps with setting up integrated automated test frameworks against Salesforce.
 test_files: []