leap_salesforce 0.2.21 → 0.2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6acf0841e84803228e921e0e119012eb59579b7c94429be48081ae514f14cadd
-  data.tar.gz: 7a78d0e7fcbe4fca41982728df4c5aa3be1ee10a9f29a9ec1a7ffc3fc7e2be15
+  metadata.gz: da79723306cce1184458cea71bcd195548c701f48fa3de87961d2d95becc99d4
+  data.tar.gz: 587308a13bfd4164e27638c82ee8adc59a833165aaeb3561b26b17e944ab455e
 SHA512:
-  metadata.gz: 6ee717b08825129749332f3b76870391006741d1429bfa929fb457e7f40101e53af9ad523f1c03cde9fbd0a74802284beb52511db7978cd43b98c17a8cfd0c04
-  data.tar.gz: f0be337595c4f16c1d4f8e1a6d11d181d7ef6aea7d223c1da5276841757f48047ee8b490bf7e6245b98006b1f0cdbd5433fd0106f42936e03dede9e449ecc05d
+  metadata.gz: eeb1dfacd0c1812b5637c7709d34303a7e852e308f87d8c789e6993aecf9ab3261a3c90df42cdde17d49ed337b14ac5c0a00998de639fc8bd98b2617150a2a9e
+  data.tar.gz: 0d5ca787cdebd092f3a21c1489d57b56f0236272740fe1129e945729cda776eea007f66b2e1b021a5b217db9c28f6c696fa7836f9df841cb89cdb4049239449d

data/.gitignore

@@ -10,6 +10,7 @@ Gemfile.lock
 logs/
 stub/
 /.idea/
+.rakeTasks
 stub_log
 
 # Generated files for now

data/.gitlab-ci.yml

@@ -602,7 +602,6 @@ pages:
 
 test:
   stage: test
-  parallel: 5
   script:
     # Decrypt server key
     - *sfdx_helpers

data/.rubocop.yml

@@ -1,3 +1,3 @@
 # Modifies RuboCop (Static analysis tool)
-Metrics/LineLength:
+Layout/LineLength:
   Max: 160

data/ChangeLog

@@ -1,3 +1,11 @@
+Version 0.2.23
+* Enhancement
+  * Raise better error when could not find record using query
+
+Version 0.2.22
+* Enhancement
+  * New Salesforce module to make it more intuitive to inquire about Salesforce with `Salesforce.limits`
+
 Version 0.2.21
 * Enhancement
   * Remove enums that are no longer present on entities due to metadata changing to create_enums task

data/README.md

@@ -46,6 +46,8 @@ The benefits of an open source tool like this are:
             * [Setup scripts](#setup-scripts)
             * [Changing environment](#changing-environment)
             * [Test Users](#test-users)
+            * [Advanced](#advanced)
+                * [Understanding how request is built](#understanding-how-request-is-built)
         * [CRUD of data](#crud-of-data)
             * [Creating entities](#creating-entities)
             * [Reading entities](#reading-entities)
@@ -239,6 +241,23 @@ LeapSalesforce.api_user = LeapSalesforce::Users.where username: /admin/
 LeapSalesforce.api_user = LeapSalesforce::Users.where description: /System Admin/
 ```
 
+#### Advanced
+
+Topics in here for understanding how things work behind the scenes and are not necessary for simple
+use of this gem.
+
+##### Understanding how request is built
+
+###### Creating entities
+
+When creating entities, the convention is that the accessors defined by the `soql_element` that are
+auto-generated by the `leaps:create_soql_objects` rake task are used. 
+These methods internally call the `[]=` method to set values that will be sent in the POST request.
+This method can be used directly with the backend name. E.g, `contact[:FieldName] = 'Value'`
+
+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`.
+
 ### CRUD of data
 
 To work data in Salesforce, an object inheriting from the `SoqlData` class is always used. The idea is
@@ -326,6 +345,21 @@ example:
 @contact = Contact.create
 ```
 
+##### Composite creation
+
+When creating bulk data (e.g, data with related fields), it's faster to use the composite API.
+
+See `spec/integration/composite_spec.rb` for an example of how to do this. This will be built into
+this gem more in the future (so that composite requests are made automatically). 
+
+Following is an example of the time difference for just putting 2 requests into one request.
+
+Create Account: 0.96s
+Create Contact linked to this account: 0.75s
+Total: 1.7s
+
+Create Contact and account using Composite: 1.24s
+
 #### Reading entities
 ##### Retrieving entities
 To retrieve an entity, the `find` method can be called on the class for the object required. For example
@@ -524,4 +558,5 @@ Everyone interacting in the LeapSalesforce project’s codebases, issue trackers
 
 ## References
 
-See the presentation on this [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)
+* 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)

data/leap_salesforce.gemspec

@@ -42,6 +42,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 'simplecov'
-  spec.add_dependency 'soaspec', '>= 0.3.9' # Version can send payload for :delete method
+  spec.add_dependency 'soaspec', '>= 0.3.10' # Version can send payload for :delete method
   spec.add_dependency 'thor'
 end

data/lib/leap_salesforce/limits.rb

@@ -7,7 +7,7 @@ module LeapSalesforce
       # @param [Symbol, String] limit_name Name of limit to find remaining amount for
       # @return [Integer] Finds remaining amount for a Salesforce limit
       def remaining_for(limit_name)
-        SoqlData.limits[limit_name]['Remaining']
+        Salesforce.limits[limit_name]['Remaining']
       end
     end
   end

data/lib/leap_salesforce/soql_data/salesforce.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'soql_global_data'
+
+# ApiService that interacts with Salesforce via the API globally.
+# For interacts that are specific to an object, use a class inheriting from SoqlData
+# See SoqlGlobalData for details on how it's used
+module Salesforce
+  extend SoqlGlobalData
+end

data/lib/leap_salesforce/soql_data/soql.rb

@@ -3,16 +3,19 @@
 module LeapSalesforce
   # Handles interaction with Soql, mapping ruby to soql query strings
   class Soql
-    # @return [String] Soql table
+    # @return [SoqlData] Soql table
     attr_accessor :soql_table
 
+    # @param [SoqlData] soql_table Object mapping to a Salesforce table
     def initialize(soql_table)
       self.soql_table = soql_table
       @default_filter = soql_table.instance_variable_get(:@default_filter)
       @soql_object_name = soql_table.soql_object_name
     end
 
-    # This will be inefficient if an Id is passed
+    # Find the Salesforce object using the lookup query provided.
+    # When id is returned it will look up the id directly, otherwise it will return an
+    # object referring to the list of results returned
     # @return [> SoqlData] SoqlData object that is the result of looking up id based on lookup criteria
     def lookup_id(lookup)
       teardown = lookup.delete(:teardown)
@@ -33,6 +36,7 @@ module LeapSalesforce
       "SELECT Id FROM #{@soql_object_name} #{soql_lookup_filter(lookup)}"
     end
 
+    # Perform SOQL query against Salesforce
     # Url encoding needs to be used when searching for special characters (+ => '%2B')
     # (see https://www.w3schools.com/tags/ref_urlencode.asp)
     # @param [String] soql_query String representing SOQL query
@@ -56,7 +60,7 @@ module LeapSalesforce
     def data_from_url(url, lookup)
       soql_table.new("Id at #{url}", method: :get, suburl: url)
     rescue NoElementAtPath
-      raise NoElementAtPath, "No result found for #{lookup} under user #{LeapSalesforce.api_user}"
+      raise NoElementAtPath, "No result found for '#{lookup}' under user #{LeapSalesforce.api_user}"
     end
 
     # For dates (ending with .000Z), query is always greater than

data/lib/leap_salesforce/soql_data/soql_global_data.rb

@@ -9,7 +9,7 @@ module SoqlGlobalData
   #   SoqlData.limits["['Conga Composer - EU']"]
   # @return [Exchange] Limits of Salesforce ORG
   def limits
-    @limits ||= new("#{self} limits", method: :get, suburl: 'limits/')
+    @limits ||= SoqlData.new("#{self} limits", method: :get, suburl: 'limits/')
   end
 
   # Describe all salesforce objects (this returns BIG response)
@@ -23,6 +23,6 @@ module SoqlGlobalData
   #   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/')
+    @global_describe ||= SoqlData.new('Global describe of sobjects', method: :get, suburl: 'sobjects/')
   end
 end

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -31,7 +31,13 @@ module SoqlGlobalObjectData
   # @return [< SoqlData] Instance of itself storing reference to found object
   def find(lookup = {})
     id_lookup = soql.lookup_id lookup
-    lookup.key?(:Id) ? id_lookup : soql.data_from_url(id_lookup['$..url'], lookup)
+    begin
+      lookup.key?(:Id) ? id_lookup : soql.data_from_url(id_lookup['$..url'], lookup)
+    rescue NoElementAtPath => e
+      raise e unless e.message.include?('"totalSize":0')
+
+      raise LeapSalesforce::RequestError, "Could not find #{self} using #{lookup}"
+    end
   end
 
   # @return [LeapSalesforce::Soql] Object to handle Soql interactions
@@ -144,13 +150,16 @@ module SoqlGlobalObjectData
     delete
   end
 
+  # Define a mapping between a ruby friendly name to reference field and Salesforce backend name
+  # @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)
     # 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|
       if @response # Performing an update
         @response = update(backend_name => new_value).response
-      else # Setting value on creating new object
+      else # Setting value on creating new object. Uses id of object if SoqlData object passed
         self[backend_name] = new_value.class < SoqlData ? new_value.id : new_value
       end
     end

data/lib/leap_salesforce/soql_data/soql_handler.rb

@@ -4,6 +4,7 @@ require 'soaspec'
 
 # Handles basic Soql interactions. These are done through classes that are tied to this handler, i.e, the SoqlData
 # class.
+# This is a service that handles all interactions with the API
 # Credentials are stored either in 'config/credentials' folder or via environment variables
 # To check out SOQL SCHEMA go to workbench.developerforce.com. Use Sandbox and login
 class SoqlHandler < Soaspec::RestHandler

data/lib/leap_salesforce/version.rb

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

data/lib/leap_salesforce.rb

@@ -70,6 +70,7 @@ module LeapSalesforce
   end
 
   require 'leap_salesforce/soql_data/soql_data'
+  require 'leap_salesforce/soql_data/salesforce'
   require 'leap_salesforce/limits'
 
   FileUtils.mkdir_p lib_folder unless Dir.exist? lib_folder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.23
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -241,14 +241,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.3.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.9
+        version: 0.3.10
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -276,13 +276,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".idea/dictionaries/iqa.xml"
-- ".idea/dictionaries/samuelgarratt.xml"
-- ".idea/markdown-exported-files.xml"
-- ".idea/markdown-navigator.xml"
-- ".idea/markdown-navigator/profiles_settings.xml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
 - ".idea/vcs.xml"
 - ".leap_salesforce.yml"
 - ".rspec"
@@ -343,6 +336,7 @@ files:
 - lib/leap_salesforce/soql_data/common_enum_methods.rb
 - lib/leap_salesforce/soql_data/data_relationships.rb
 - lib/leap_salesforce/soql_data/meta_data_handler.rb
+- lib/leap_salesforce/soql_data/salesforce.rb
 - lib/leap_salesforce/soql_data/soql.rb
 - lib/leap_salesforce/soql_data/soql_data.rb
 - lib/leap_salesforce/soql_data/soql_enum.rb

data/.idea/dictionaries/iqa.xml

@@ -1,11 +0,0 @@
-<component name="ProjectDictionaryState">
-  <dictionary name="iqa">
-    <words>
-      <w>rubocop</w>
-      <w>salesforce</w>
-      <w>sfdx</w>
-      <w>soql</w>
-      <w>topoisomerase</w>
-    </words>
-  </dictionary>
-</component>

data/.idea/dictionaries/samuelgarratt.xml

@@ -1,7 +0,0 @@
-<component name="ProjectDictionaryState">
-  <dictionary name="samuelgarratt">
-    <words>
-      <w>soaspec</w>
-    </words>
-  </dictionary>
-</component>

data/.idea/markdown-exported-files.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MarkdownExportedFiles">
-    <htmlFiles />
-    <imageFiles />
-    <otherFiles />
-  </component>
-</project>

data/.idea/markdown-navigator/profiles_settings.xml

@@ -1,3 +0,0 @@
-<component name="MarkdownNavigator.ProfileManager">
-  <settings default="" pdf-export="" plain-text-search-scope="Project Files" />
-</component>

data/.idea/markdown-navigator.xml

@@ -1,86 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="MarkdownProjectSettings" wasCopied="true">
-    <PreviewSettings splitEditorLayout="SPLIT" splitEditorPreview="PREVIEW" useGrayscaleRendering="false" zoomFactor="1.0" maxImageWidth="0" showGitHubPageIfSynced="false" allowBrowsingInPreview="false" synchronizePreviewPosition="true" highlightPreviewType="NONE" highlightFadeOut="5" highlightOnTyping="true" synchronizeSourcePosition="true" verticallyAlignSourceAndPreviewSyncPosition="true" showSearchHighlightsInPreview="false" showSelectionInPreview="true" openRemoteLinks="true" replaceUnicodeEmoji="false" lastLayoutSetsDefault="false">
-      <PanelProvider>
-        <provider providerId="com.vladsch.idea.multimarkdown.editor.swing.html.panel" providerName="Default - Swing" />
-      </PanelProvider>
-    </PreviewSettings>
-    <ParserSettings gitHubSyntaxChange="false" emojiShortcuts="0" emojiImages="0">
-      <PegdownExtensions>
-        <option name="ABBREVIATIONS" value="false" />
-        <option name="ANCHORLINKS" value="true" />
-        <option name="ASIDE" value="false" />
-        <option name="ATXHEADERSPACE" value="true" />
-        <option name="AUTOLINKS" value="true" />
-        <option name="DEFINITIONS" value="false" />
-        <option name="DEFINITION_BREAK_DOUBLE_BLANK_LINE" value="false" />
-        <option name="FENCED_CODE_BLOCKS" value="true" />
-        <option name="FOOTNOTES" value="false" />
-        <option name="HARDWRAPS" value="false" />
-        <option name="HTML_DEEP_PARSER" value="false" />
-        <option name="INSERTED" value="false" />
-        <option name="QUOTES" value="false" />
-        <option name="RELAXEDHRULES" value="true" />
-        <option name="SMARTS" value="false" />
-        <option name="STRIKETHROUGH" value="true" />
-        <option name="SUBSCRIPT" value="false" />
-        <option name="SUPERSCRIPT" value="false" />
-        <option name="SUPPRESS_HTML_BLOCKS" value="false" />
-        <option name="SUPPRESS_INLINE_HTML" value="false" />
-        <option name="TABLES" value="true" />
-        <option name="TASKLISTITEMS" value="true" />
-        <option name="TOC" value="false" />
-        <option name="WIKILINKS" value="true" />
-      </PegdownExtensions>
-      <ParserOptions>
-        <option name="ADMONITION_EXT" value="false" />
-        <option name="ATTRIBUTES_EXT" value="false" />
-        <option name="COMMONMARK_LISTS" value="true" />
-        <option name="DUMMY" value="false" />
-        <option name="EMOJI_SHORTCUTS" value="true" />
-        <option name="ENUMERATED_REFERENCES_EXT" value="false" />
-        <option name="FLEXMARK_FRONT_MATTER" value="false" />
-        <option name="GFM_LOOSE_BLANK_LINE_AFTER_ITEM_PARA" value="false" />
-        <option name="GFM_TABLE_RENDERING" value="true" />
-        <option name="GITBOOK_URL_ENCODING" value="false" />
-        <option name="GITHUB_LISTS" value="false" />
-        <option name="GITHUB_WIKI_LINKS" value="true" />
-        <option name="GITLAB_EXT" value="false" />
-        <option name="GITLAB_MATH_EXT" value="false" />
-        <option name="GITLAB_MERMAID_EXT" value="false" />
-        <option name="HEADER_ID_NON_ASCII_TO_LOWERCASE" value="false" />
-        <option name="HEADER_ID_NO_DUPED_DASHES" value="false" />
-        <option name="JEKYLL_FRONT_MATTER" value="false" />
-        <option name="MACROS_EXT" value="false" />
-        <option name="NO_TEXT_ATTRIBUTES" value="false" />
-        <option name="PARSE_HTML_ANCHOR_ID" value="false" />
-        <option name="PLANTUML_FENCED_CODE" value="false" />
-        <option name="PUML_FENCED_CODE" value="false" />
-        <option name="SIM_TOC_BLANK_LINE_SPACER" value="true" />
-      </ParserOptions>
-    </ParserSettings>
-    <HtmlSettings headerTopEnabled="false" headerBottomEnabled="false" bodyTopEnabled="false" bodyBottomEnabled="false" embedUrlContent="false" addPageHeader="true" embedImages="false" embedHttpImages="false" imageUriSerials="false" addDocTypeHtml="true" noParaTags="false" plantUmlConversion="0" mathConversion="-1">
-      <GeneratorProvider>
-        <provider providerId="com.vladsch.idea.multimarkdown.editor.swing.html.generator" providerName="Default Swing HTML Generator" />
-      </GeneratorProvider>
-      <headerTop />
-      <headerBottom />
-      <bodyTop />
-      <bodyBottom />
-    </HtmlSettings>
-    <CssSettings previewScheme="UI_SCHEME" cssUri="" isCssUriEnabled="false" isCssUriSerial="true" isCssTextEnabled="false" isDynamicPageWidth="true">
-      <StylesheetProvider>
-        <provider providerId="com.vladsch.idea.multimarkdown.editor.swing.html.css" providerName="Default Swing Stylesheet" />
-      </StylesheetProvider>
-      <ScriptProviders />
-      <cssText />
-      <cssUriHistory />
-    </CssSettings>
-    <AnnotatorSettings targetHasSpaces="true" linkCaseMismatch="true" wikiCaseMismatch="true" wikiLinkHasDashes="true" notUnderWikiHome="true" targetNotWikiPageExt="true" notUnderSourceWikiHome="true" targetNameHasAnchor="true" targetPathHasAnchor="true" wikiLinkHasSlash="true" wikiLinkHasSubdir="true" wikiLinkHasOnlyAnchor="true" linkTargetsWikiHasExt="true" linkTargetsWikiHasBadExt="true" notUnderSameRepo="true" targetNotUnderVcs="false" linkNeedsExt="true" linkHasBadExt="true" linkTargetNeedsExt="true" linkTargetHasBadExt="true" wikiLinkNotInWiki="true" imageTargetNotInRaw="true" repoRelativeAcrossVcsRoots="true" multipleWikiTargetsMatch="true" unresolvedLinkReference="true" linkIsIgnored="true" anchorIsIgnored="true" anchorIsUnresolved="true" anchorLineReferenceIsUnresolved="true" anchorLineReferenceFormat="true" anchorHasDuplicates="true" abbreviationDuplicates="true" abbreviationNotUsed="true" attributeIdDuplicateDefinition="true" attributeIdNotUsed="true" footnoteDuplicateDefinition="true" footnoteUnresolved="true" footnoteDuplicates="true" footnoteNotUsed="true" macroDuplicateDefinition="true" macroUnresolved="true" macroDuplicates="true" macroNotUsed="true" referenceDuplicateDefinition="true" referenceUnresolved="true" referenceDuplicates="true" referenceNotUsed="true" referenceUnresolvedNumericId="true" enumRefDuplicateDefinition="true" enumRefUnresolved="true" enumRefDuplicates="true" enumRefNotUsed="true" enumRefLinkUnresolved="true" enumRefLinkDuplicates="true" simTocUpdateNeeded="true" simTocTitleSpaceNeeded="true" />
-    <HtmlExportSettings updateOnSave="false" parentDir="" targetDir="" cssDir="css" scriptDir="js" plainHtml="false" imageDir="" copyLinkedImages="false" imageUniquifyType="0" targetPathType="2" targetExt="" useTargetExt="false" noCssNoScripts="false" useElementStyleAttribute="false" linkToExportedHtml="true" exportOnSettingsChange="true" regenerateOnProjectOpen="false" linkFormatType="HTTP_ABSOLUTE" />
-    <LinkMapSettings>
-      <textMaps />
-    </LinkMapSettings>
-  </component>
-</project>

data/.idea/misc.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="JavaScriptSettings">
-    <option name="languageLevel" value="ES6" />
-  </component>
-  <component name="ProjectPlainTextFileTypeManager">
-    <file url="file://$PROJECT_DIR$/lib/leap_salesforce/generator/templates/picklist.rb.erb" />
-    <file url="file://$PROJECT_DIR$/lib/leap_salesforce/generator/templates/soql_object.rb.erb" />
-    <file url="file://$PROJECT_DIR$/lib/leap_salesforce/generator/templates/soql_object_field_names.rb.erb" />
-    <file url="file://$PROJECT_DIR$/lib/leap_salesforce/generator/templates/spec/spec_helper.rb.erb" />
-  </component>
-  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-2.5.0" project-jdk-type="RUBY_SDK" />
-</project>

data/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/leap-salesforce.iml" filepath="$PROJECT_DIR$/.idea/leap-salesforce.iml" />
-    </modules>
-  </component>
-</project>