leap_salesforce 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe3d1e7b89c6a0185c21a67a0b9b96a151a09a18c313bd81d27675911d7922e
-  data.tar.gz: c3542d891c596f1b5f40d53362ef4184bbb1d774bc5839b8d508a8bf09646ef5
+  metadata.gz: 455d4ec9852a5afd9bf82cbe504b755fee025025ff3a7ad35d958ca944ea89cd
+  data.tar.gz: 304a5f93081a5e65fff63b34ce61a8cb0f4a8ed90e71d4ef9947a57eb8155562
 SHA512:
-  metadata.gz: 82c5fdb6d8841ad1472a42462cd316ee9db718a9bd7fdd0696506ebc751ba55fa58648f596d938fb4f19c300c2d01ab94b1cc711a2613641ce749964f0865355
-  data.tar.gz: 8f4ab171180697bd999dc7b159ddbde298be59977d904ef4d33e7df3b84aa8b1610706ad871a3210ff33d565617e5fd89d0b17a5f691c9f3c90f316a555d1f47
+  metadata.gz: bfa00811dd445829c140a9980353c32b8568feb47c3caa37a8e950426b7b31c1ac00bb333ac1707861271b21684d770892263061c7cddc7f0c2d3cf22b553c8a
+  data.tar.gz: b48b467b870cf0b239d39ce648d2ed7b7cc5d4762c9c9bb6668f89a92b4a5a298535e6a08d12e8c3baedc1de13717952b886926a8eb2df35d0052e971aace28c

data/.idea/.rakeTasks

@@ -1,7 +1,7 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <Settings><!--This file was automatically generated by Ruby plugin.
 You are allowed to: 
 1. Remove rake task
 2. Add existing rake tasks
 To add existing rake tasks automatically delete this file and reload the project.
---><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build leap_salesforce-0.1.16.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Check Salesforce OAuth2 authentication is working" fullCmd="check_oauth" taksId="check_oauth" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install leap_salesforce-0.1.16.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install leap_salesforce-0.1.16.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeGroup description="" fullCmd="" taksId="leaps"><RakeTask description="Create objects, fields, enums" fullCmd="leaps:create_all" taksId="create_all" /><RakeTask description="Create Enumeration objects for picklists from Salesforce Metadata" fullCmd="leaps:create_enums" taksId="create_enums" /><RakeTask description="Create Soql Data objects" fullCmd="leaps:create_soql_objects" taksId="create_soql_objects" /></RakeGroup><RakeTask description="Create tag v0.1.16 and build and push leap_salesforce-0.1.16.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="Create stubs for dynamic methods so they're picked up by the IDE" fullCmd="stub" taksId="stub" /><RakeGroup description="" fullCmd="" taksId="yard"><RakeTask description="Run YARD doctests" fullCmd="yard:doctest" taksId="doctest" /></RakeGroup><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build leap_salesforce-0.1.16.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Check Salesforce OAuth2 authentication is working" fullCmd="check_oauth" taksId="check_oauth" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install leap_salesforce-0.1.16.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install leap_salesforce-0.1.16.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeGroup description="" fullCmd="" taksId="leaps"><RakeTask description="Create objects, fields, enums" fullCmd="leaps:create_all" taksId="create_all" /><RakeTask description="Create Enumeration objects for picklists from Salesforce Metadata" fullCmd="leaps:create_enums" taksId="create_enums" /><RakeTask description="Create Soql Data objects" fullCmd="leaps:create_soql_objects" taksId="create_soql_objects" /></RakeGroup><RakeTask description="Create tag v0.1.16 and build and push leap_salesforce-0.1.16.gem to rubygems.org" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="Create stubs for dynamic methods so they're picked up by the IDE" fullCmd="stub" taksId="stub" /><RakeGroup description="" fullCmd="" taksId="yard"><RakeTask description="Run YARD doctests" fullCmd="yard:doctest" taksId="doctest" /></RakeGroup><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.idea/leap-salesforce.iml

@@ -22,7 +22,7 @@
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="factory_bot (v5.0.2, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="faker (v2.1.0, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faker (v2.1.2, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="gyoku (v1.3.1, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="hashie (v3.6.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.3, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -41,7 +41,7 @@
     <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.13.1, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="mustermann (v1.0.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.10.3, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.10.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="nori (v2.6.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parallel (v1.17.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parser (v2.6.3.0, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -51,7 +51,7 @@
     <orderEntry type="library" scope="PROVIDED" name="rack-protection (v2.0.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="random-port (v0.3.1, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="random-port (v0.3.2, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="require_all (v2.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rest-client (v2.0.2, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec (v3.8.0, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -67,7 +67,7 @@
     <orderEntry type="library" scope="PROVIDED" name="sinatra (v2.0.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="sinatra-basic-auth (v0.1.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="sinatra-docdsl (v0.8.6, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="soaspec (v0.2.29, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="soaspec (v0.2.30, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="socksify (v1.7.1, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="thor (v0.20.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="thread_safe (v0.3.6, RVM: ruby-2.6.0) [gem]" level="application" />

data/.leap_salesforce.yml

@@ -9,4 +9,4 @@ soql_objects:
   - Group
   - Broker: Broker__c
   - Account
-  - Attachment
+  - Attachment

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.1.17
+* Enhancements
+  * Retry if a Server breaks connection intermittently raises an error
+
 Version 0.1.16
 * Bug Fix
   * Fixed where ERB was not being used to interpret user on init script

data/README.md

@@ -7,6 +7,35 @@ In the future it will also planned to be used to create page objects based on me
 
 [![Build Status](https://gitlab.com/leap-dojo/leap_salesforce/badges/master/build.svg)](https://gitlab.com/leap-dojo/leap_salesforce/pipelines)
 
+## Table of Contents
+
+* [LeapSalesforce](#leapsalesforce)
+    * [Table of Contents](#table-of-contents)
+    * [Installation](#installation)
+    * [Usage](#usage)
+        * [Getting started](#getting-started)
+        * [Understanding how things work](#understanding-how-things-work)
+            * [Important files](#important-files)
+                * [.leap_salesforce.yml](#leap_salesforceyml)
+                * [salesforce_oauth2.yml](#salesforce_oauth2yml)
+                * [config/general.rb](#configgeneralrb)
+            * [Test Users](#test-users)
+        * [CRUD of data](#crud-of-data)
+            * [Creating entities](#creating-entities)
+            * [Reading entities](#reading-entities)
+                * [Retrieving entities](#retrieving-entities)
+                * [Retrieving the value of a field](#retrieving-the-value-of-a-field)
+            * [Updating entities](#updating-entities)
+            * [Deleting entities](#deleting-entities)
+        * [Other Examples](#other-examples)
+    * [Structure](#structure)
+    * [Docs](#docs)
+    * [Development](#development)
+    * [Contributing](#contributing)
+    * [License](#license)
+    * [Code of Conduct](#code-of-conduct)
+    * [References](#references)
+
 > Note this documentation is a work in progress. Look at `spec` for code examples.
 
 ## Installation
@@ -114,7 +143,7 @@ LeapSalesforce.api_user = LeapSalesforce::Users.where username: /admin/
 LeapSalesforce.api_user = LeapSalesforce::Users.where description: /System Admin/
 ```
 
-#### CRUD of data
+### CRUD of data
 
 To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
 that an object in Ruby code maps to the object in Salesforce and requests and updates to this object
@@ -137,7 +166,7 @@ end
 For all interactions with Salesforce the API traffic logs are recorded in a log created in the `logs`
 folder of the suite.
 
-##### Creating entities
+#### Creating entities
 
 There are several ways entities can be created. By instantiating the object with the `new` method a new
 object will be created in memory but in Salesforce. Only when the `save!` method is called will an object
@@ -201,8 +230,8 @@ example:
 @contact = Contact.create
 ```
 
-##### Reading entities
-
+#### Reading entities
+##### Retrieving entities
 To retrieve an entity, the `find` method can be called on the class for the object required. For example
 to obtain an object representing a contact with a last name of 'Test Person' we could do:
 
@@ -210,6 +239,145 @@ to obtain an object representing a contact with a last name of 'Test Person' we
 @contact = Contact.find last_name: 'Test Person'
 ```
 
+This uses the ruby friendly method defined for `Contact` and shown in `Contact::Fields` to extract
+the Salesforce field name `LastName`. Note, the name designated is derived from the `label` name which
+is assumed to be more user friendly than the backend name. See `spec/unit/ext/string_spec.rb` for
+examples of how different behaviours are handled.
+The backend name can also be used directly within a `find` so
+the following could also be done:
+
+```ruby
+@contact = Contact.find LastName: 'Test Person'
+```
+
+The values used in these requests are validated against Metadata before the request is made so an
+error will be received if a field name is used that does not exist on the object.
+
+Any number of parameters can be passed to the find method to narrow the search. For example:
+
+```ruby
+@contact = Contact.find last_name: 'Test Person', first_name: 'Number 1'
+```
+
+When a date is passed as the value it will be automatically formatted so that it can be used in the
+backend SOQL query. So to get a contact created less than 5 days ago one can use:
+
+```ruby
+@contact = Contact.find created_date: "<#{5.days.ago}"
+```
+
+To use the `LIKE` operator for partial matches put a '`' at the start of the string. Following is an
+example of finding a contact that has the string 'Test' anywhere in their first name. As one can see
+the '%' symbols are used as a wild card to indicate any value.
+
+```ruby
+@contact = Contact.find(first_name: '~%Test%')
+```
+
+Note for non unique criterion, the value returned will be the most recent one.
+
+##### Retrieving the value of a field
+
+Getters (methods that retrieve something about an object) are created for each field name on an object.
+So to get the first name of the contact, the `first_name` method is simply called on it.
+
+```ruby
+@contact = Contact.find first_name: 'Test Person'
+@contact.first_name # => 'Test Person'
+```
+
+The backend name can also be used in the `[]` method to retrieve a value.
+
+```ruby
+@contact['FirstName'] # => 'Test Person'
+```
+
+There are 2 special methods related to verifying that a response is successful or not. 
+
+* `success` - returns `true` or `false` indicating whether the previous action performed worked 
+  as expected
+* `error_message` - returns a string with the error message returned from Salesforce. 
+
+For example, say you want to test that a `LineItem` cannot be deleted. You can verify it and it's
+error message with:
+
+```ruby
+item = LineItem.find status: 'New'
+expect(item.delete.error_message).to eq 'Deleting of line item is not allowed.'
+```
+
+#### Updating entities
+
+The same field name used above is used as a setter to update an individual field. For example, to
+change the first name of a contact from Test1 to Test2:
+
+```ruby
+@contact = Contact.find first_name: 'Test1'
+@contact.first_name = 'Test2'
+```
+
+To update multiple fields at once, use the `update` method:
+
+```ruby
+@case.update status: Case::Status.escalated, case_reason: 'Feedback'
+``` 
+
+This does not fail if the update is not successful. To fail in this situation, the `success_update`
+method can be used:
+
+```ruby
+@case.success_update status: Case::Status.escalated, case_reason: 'Feedback'
+```
+
+If the main action of the test is this update, it is recommended that success be verified
+explicitly with:
+
+```ruby
+@case.update status: Case::Status.escalated, case_reason: 'Feedback'
+expect(@case).to be_successful
+```
+
+The reason for this is to account for error scenarios where you want to update a value and expect
+and error message. For example:
+
+```ruby
+item = LineItem.find(status: 'New')
+update = item.update owner_id: User.find(Name: '~%Confidential%').id
+expect(update.error_message).to eq 'Cannot change owner to confidential user'
+```
+
+#### Deleting entities
+
+Once an entity is obtained through `find` or `create`, it can be deleted simply with the 
+`delete`. If you want an exception to be raised if the delete fails, pass `must_pass: true` to the
+delete method. For example:
+
+```ruby
+@contact = Contact.find first_name 'No longer needed'
+@contact.delete must_pass: true
+```
+
+An entity can also be deleted with merely it's id. For example:
+
+```ruby
+Contact.delete '0032v00002rgv2pAAA', must_pass: true 
+```
+
+### Other Examples
+
+See [spec/integration](spec/integration) folder for examples of tests.  
+
+#### Delete old contacts
+```ruby
+# Deleting old contacts
+objects = Contact.each_id_with created_date: "<#{5.days.ago}"
+puts objects.count # Log how many are being deleted
+objects.each do |id|
+  puts "Deleting #{id}"
+  Contact.delete id
+end 
+```
+
 ## Structure
 
 Following is the general structure of test automation suite that uses this approach. Details may vary depending on the
@@ -256,20 +424,6 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 Everyone interacting in the LeapSalesforce project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/leap-dojo/leap_salesforce/blob/master/CODE_OF_CONDUCT.md).
 
-# Examples
-
-See [spec/integration](spec/integration) folder for examples of tests.  
-
-```ruby
-# deleting old contacts
-objects = Contact.each_id_with CreatedDate: "<#{5.days.ago}"
-puts objects.count
-objects.each do |id|
-  puts "Deleting #{id}"
-  Contact.delete id
-end 
-```
-
-# References
+## References
 
 See the presentation on this [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)

data/leap_salesforce.gemspec

@@ -40,6 +40,6 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_dependency 'require_all'
   spec.add_dependency 'rubocop'
   spec.add_dependency 'rubykeyword'
-  spec.add_dependency 'soaspec', '>= 0.2.29'
+  spec.add_dependency 'soaspec', '>= 0.2.30'
   spec.add_dependency 'thor'
 end

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -65,10 +65,10 @@ module SoqlGlobalObjectData
 
   # 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'
+  # @example Get a contact where LastName is 'Bob' using backend name
   #   Contact.find(LastName: 'Bob')
-  # @example Get a contact that includes 'Test' in their first name
-  #   Contact.find(~FirstName: '~%Test%')
+  # @example Get a contact that includes 'Test' in their first name (using ruby accessor name)
+  #   Contact.find(first_name: '~%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
@@ -160,6 +160,9 @@ module SoqlGlobalObjectData
   end
 
   # Remove object from Salesforce with provided id
+  # @example Delete a contact with a specified id, failing if the delete fails
+  #   Contact.delete '0032v00002rgv2pAAA', must_pass: true
+  #
   # @param [String] id Id of element to remove
   # @param [Boolean] must_pass Whether to raise exception if call is not successful
   # @return [self] Exchange object making delete call

data/lib/leap_salesforce/soql_data/soql_handler.rb

@@ -17,6 +17,9 @@ class SoqlHandler < Soaspec::RestHandler
   element :error_message_element, '$..message'
   element :soql_fields, :fields
 
+  # This error appears to happen intermittently on test environments
+  retry_on_exceptions [RestClient::ServerBrokeConnection], pause: 1, count: 5
+
   # @return [String] Version of Salesforce API to use
   @api_version = '45.0'
 

data/lib/leap_salesforce/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -213,14 +213,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.29
+        version: 0.2.30
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.29
+        version: 0.2.30
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement