leap_salesforce 0.2.28 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c713a2f3052a5b335fb56963091508d652a4b1d570a6283e2ad775e2e062dd9b
-  data.tar.gz: a845f0ee3220c1d88ae9086a529e61612b25cc79ccdacf2bae0296b12ade189e
+  metadata.gz: 985b2a787327d829a036c867917e750a9fcbcd6c1a06879b70b99d4ca7712ef6
+  data.tar.gz: 3b743a1a1f41024f5f97f1213c36949ec5f447f88ed070c593851caf74dc2ee2
 SHA512:
-  metadata.gz: b8b6b99d725267fe4e89f32cfd513aadea6ee83e9ac1220052882988e88fa5bd1762ecaafc9ac23a8698f2645beea1bb2dce7cd1d38ae2b101bdb947588c1258
-  data.tar.gz: 93bcc18ead3300a227163fd19e18e5f9b7bbcc0c19c71cd0f32136ce3e176eb2b1515e00815507f438f94e84853a3d4c7f921edb3a9f76ded23d122b94035c43
+  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/ChangeLog

@@ -1,3 +1,8 @@
+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)
@@ -226,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/lib/leap_salesforce/generator/soql_enums.rb

@@ -70,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/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/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,8 +23,12 @@ 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
@@ -34,14 +38,16 @@ module LeapSalesforce
       # @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
+      # @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)
-        @all = all
+      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)
@@ -56,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

data/lib/leap_salesforce/version.rb

@@ -2,5 +2,5 @@
 
 module LeapSalesforce
   # @return [String] Version of leap salesforce
-  VERSION = '0.2.28'
+  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.28
+  version: 1.0.0
 platform: ruby
 authors:
 - IQA
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-29 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: []