leap_salesforce 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2bdee6f535909036c914ded9bf6a3e558947795a7e2368a3cf0c9ba21901b3d
-  data.tar.gz: 26e600cd1fab6236d251738837e19c9034e0bb2e98cbfdfa7f535c93f4899a4e
+  metadata.gz: a9ac3a7c96d31655ef2684afb14ba1088656bfba4bdba621d1c282163783b6a4
+  data.tar.gz: 5aad78509c4ef1844c58bd0dbe600f81248126e4570eec154ef0a35abe1091a4
 SHA512:
-  metadata.gz: 47508644606e0aa2b11a6654e4369ad469ae783df0f2c777a981b97332508420112e5a0e3297d959903f4a296bc306b891f95ce85ea5dd2680f4c6fd8b2ba3dd
-  data.tar.gz: fca8cb67769917a6542bbf27fc6047f9038d0078bd05ed1aa696f3215b45b84b114f2b87e82c66a8163432a8ac6c3aeddf0270548800f3848721bc1436f513c8
+  metadata.gz: 1efdda645ee1103bce00418fd65f75badfc570191a60f7f6d5b44dca2eda1d38a395c3b9f164ec4a10a8a7f980401e1a88d031663fa76ef3d1c752626d2fca10
+  data.tar.gz: 917b74365cc67fe2d4ec7d9ab6bb3e723c8a7a4b3cdcf2cfcdfa7f42d901d37807c689d940f7be933f764117160016e8595a54e348eb8053dc9b4bb872791f1d

data/.gitlab-ci.yml

@@ -1,3 +1,6 @@
+include:
+  - template: Code-Quality.gitlab-ci.yml
+
 image: ruby:2.5
 
 stages:
@@ -8,15 +11,13 @@ variables:
   client_id: $client_id
   client_secret: $client_secret
   
-before_script:
-  - ruby -v
-  - which ruby
-  - gem install bundler rake
-  - bundle install
-  
 test:
   stage: test
   script:
+    - ruby -v
+    - which ruby
+    - gem install bundler rake
+    - bundle install
     - bundle exec rake leaps:create_soql_objects
     - bundle exec rake leaps:create_enums
     - bundle exec rake

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.11.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.11.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install leap_salesforce-0.1.11.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.11 and build and push leap_salesforce-0.1.11.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" /><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.14.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.14.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install leap_salesforce-0.1.14.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.14 and build and push leap_salesforce-0.1.14.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/dictionaries/iqa.xml

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

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.0.0, 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="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" />
@@ -80,5 +80,7 @@
     <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v1.6.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="wasabi (v3.5.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="xml-simple (v1.1.5, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="yard (v0.9.19, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="yard-doctest (v0.1.16, RVM: ruby-2.6.0) [gem]" level="application" />
   </component>
 </module>

data/ChangeLog

@@ -1,3 +1,13 @@
+Version 0.1.15
+* Enhancements
+  * Handle greater than/less than equal comparator in query
+  * Fail before request is sent if querying based on a field that is not on object
+  * Don't wait by default for an object to appear
+
+Version 0.1.14
+* Bug Fix
+  * Fixed order of picklist comparison so error message shows error correctly
+
 Version 0.1.13
 * Bug Fix
   * Updated 'Delete' where must_pass of true was calling 'successful?' method on wrong object

data/README.md

@@ -152,19 +152,59 @@ For example
 ```
 
 The `log` for this call will look like the following:
+(Note that explanations are in ALL CAPS and line numbers have been added)
 
 ```verilog
-Leaps, [13:39:14] : Example Factory for 'Contact'
-Leaps, [13:39:14] : request body: {"FirstName":"Lewis","LastName":"Gleichner"}
-Leaps, [13:39:14] : RestClient.post "https://brave-otter-ttxype-dev-ed.my.salesforce.com/services/data/v45.0/sobjects/Contact", "{\"FirstName\":\"Lewis\",\"LastName\":\"Gleichner\"}", "Accept"=>"*/*", "Accept-Encoding"=>"gzip, deflate", "Authorization"=>"Bearer 00D2v000001eBDw!AREAQK_UWp9onsfZdv5ag5j70WIbwe_IG5tLJHKC1Ti0lpVZY0EsKcmpCE8bqTd7GtGx9WmN57PRpp06yhmfczK9TUR9rZx2", "Content-Length"=>"44", "Content-Type"=>"application/json", "User-Agent"=>"rest-client/2.0.2 (linux-gnu x86_64) ruby/2.6.0p0"
+1. Leaps, [13:39:14] : Example Factory for 'Contact'
+2. Leaps, [13:39:14] : request body: {"LastName":"Gleichner"}
+3. Leaps, [13:39:14] : RestClient.post "https://SALESFORCE_INSTANCE_URL/services/data/v45.0/sobjects/Contact", "{\"FirstName\":\"Lewis\"}", HEADERS INFO
 
-Leaps, [13:39:16] : # => 201 Created | application/json 71 bytes
+4. Leaps, [13:39:16] : # => 201 Created | application/json 71 bytes
 
-Leaps, [13:39:16] : response: 
-  headers: {:date=>"Thu, 01 Aug 2019 01:39:15 GMT", :strict_transport_security=>"max-age=31536002; includeSubDomains", :public_key_pins_report_only=>"pin-sha256=\"9n0izTnSRF+W4W4JTq51avSXkWhQB8duS2bxVLfzXsY=\"; pin-sha256=\"5kJvNEMw0KjrCAu7eXY5HZdvyCS13BbA0VJG1RSP91w=\"; pin-sha256=\"njN4rRG+22dNXAi+yb8e3UMypgzPUPHlv4+foULwl1g=\"; max-age=86400; includeSubDomains; report-uri=\"https://a.forcesslreports.com/hpkp-report/00D2v000001eBDwm\";", :expect_ct=>"max-age=86400; report-uri=\"https://a.forcesslreports.com/Expect-CT-report/00D2v000001eBDwm\";", :x_content_type_options=>"nosniff", :x_xss_protection=>"1; mode=block", :x_robots_tag=>"none", :cache_control=>"no-cache,must-revalidate,max-age=0,no-store,private", :set_cookie=>["BrowserId=DOR6nshpQC659waq6EKS3A;Path=/;Domain=.salesforce.com;Expires=Mon, 30-Sep-2019 01:39:15 GMT;Max-Age=5184000"], :expires=>"Thu, 01 Jan 1970 00:00:00 GMT", :sforce_limit_info=>"api-usage=331/15000", :location=>"/services/data/v45.0/sobjects/Contact/0032v00002qU3hvAAC", :content_type=>"application/json;charset=UTF-8", :vary=>"Accept-Encoding", :content_encoding=>"gzip", :transfer_encoding=>"chunked"}
-  body: {"id":"0032v00002qU3hvAAC","success":true,"errors":[]}
+5. Leaps, [13:39:16] : response: 
+6.  headers: {:date=>"Thu, 01 Aug 2019 01:39:15 GMT", OTHER_HEADER_INFO}
+7.  body: {"id":"0032v00002qU3hvAAC","success":true,"errors":[]}
 ```
 
+Following is a step by step explanation of each log line:
+1. Brief description of what's being done. Creating a Contact.
+2. Parameters used in HTTP request. This will be the fields set on the object created
+3. The actual REST Post made to the Salesforce API showing the URL, payload, headers, etc
+4. A brief summary of the response. Object has been created successfully
+5. A more in depth description of the response follows in next two lines
+6. Headers of the response 
+7. Body of the response
+
+Representation of the details for created an entity can be handled much neater by `FactoryBot`.
+If we had the following `factory` for Contact
+```ruby
+FactoryBot.define do
+  factory :contact do    
+    first_name { 'Test Person' }
+  end
+end
+```
+then we could perform the same creation of a contact with simply
+
+```ruby
+@contact = FactoryBot.create(:contact)
+```
+
+FactoryBot has traits, associations, after blocks for helping with creating objects with fast number
+of relationships. See FactoryBot's getting started for more information and have a look at the 
+examples in the `spec` folder. 
+
+To create an object using a factory, the `create` method can also be used on the object itself. For 
+example:
+
+```ruby
+@contact = Contact.create
+```
+
+##### Reading entities
+
+
+
 ## Structure
 
 Following is the general structure of test automation suite that uses this approach. Details may vary depending on the

data/Rakefile

@@ -3,6 +3,8 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rake/clean'
+require 'yard'
+require 'yard/doctest/rake'
 
 require 'leap_salesforce/rake'
 
@@ -24,3 +26,11 @@ task :stub do
   require 'topoisomerase'
   Topoisomerase.create_stubs_based_on SoqlData
 end
+
+desc 'Test examples shown in documentation'
+YARD::Doctest::RakeTask.new do |task|
+  task.doctest_opts = %w[-v]
+  # task.pattern = 'lib/**/*.rb'
+  # TODO: Get all examples working in this way
+  task.pattern = 'lib/leap_salesforce/ext/string.rb'
+end

data/leap_salesforce.gemspec

@@ -30,6 +30,7 @@ It reads the Metadata from Salesforce and creates the foundation for API tests.'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'topoisomerase'
+  spec.add_development_dependency 'yard-doctest'
   spec.add_dependency 'activerecord'
   spec.add_dependency 'colorize'
   spec.add_dependency 'factory_bot'

data/lib/leap_salesforce/error.rb

@@ -1,6 +1,8 @@
 module LeapSalesforce
   # Any error specific to LeapSalesforce
   class Error < StandardError; end
+  # Error related to handling a request
+  class RequestError < StandardError; end
   # Error related to handling a response
   class ResponseError < StandardError; end
   # Error related to setup of test automation suite

data/lib/leap_salesforce/ext/string.rb

@@ -19,7 +19,12 @@ class String
                   .humanize_numbered_string
   end
 
-  # @return [String] If all characters were stripped out, put a placeholder 'X'. If starts with underscore remove it
+  # @example Remove stripped characters
+  #   ''.handle_initial_characters # => 'X'
+  # @example Remove leading underscores
+  #   '_leading'.handle_initial_characters # => 'leading'
+  # @return [String] If all characters were stripped out, put a placeholder 'X'.
+  #   If starts with underscore remove it
   def handle_initial_characters
     if size.zero?
       +'X'

data/lib/leap_salesforce/soql_data/soql_enum.rb

@@ -2,6 +2,8 @@
 
 # Module all SoqlEnums include
 module SoqlEnum
+  # @param [Class] object Object inheriting from SoqlData that has picklists underneath it
+  # @return [Array] List of picklist classes that inherit from SoqlEnum and relate to provided class
   def self.values_for(object)
     ObjectSpace.each_object(Module).select { |class_name| class_name < self && class_name.to_s.start_with?("#{object}::") }
   end

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -24,12 +24,11 @@ module SoqlGlobalObjectData
   # (see https://www.w3schools.com/tags/ref_urlencode.asp)
   # @param [String] soql_query String representing SOQL query
   # @param [Boolean] wait Whether to wait for record if no result returned
-  # @example
-  #   query SELECT Name from Account WHERE Name = 'TEST Org 001'
-  #   This is converted to:
-  #   perform_query "SELECT+Name+from+Account+WHERE+Name+=+'TEST+Org+001'"
+  # @example Find an account with test organisation name
+  #   my_query = "SELECT Name from Account WHERE Name = 'TEST Org 001'"
+  #   query my_query # => "SELECT+Name+from+Account+WHERE+Name+=+'TEST+Org+001'"
   # @return [Exchange] Exchange object from which JSON response can be obtained (i.e, with exchange.response)
-  def query(soql_query, wait: true)
+  def query(soql_query, wait: false)
     rest_query = soql_query.gsub('%', '%25').gsub('+', '%2B').tr(' ', '+')
     if wait
       new("SOQL Query: #{soql_query}", method: :get, suburl: "query/?q=#{rest_query}").until(timeout: 20, interval: 1) do
@@ -56,6 +55,10 @@ module SoqlGlobalObjectData
     conditional = ''
     lookup.each do |key, value|
       conditional_term = conditional.empty? ? 'WHERE' : 'AND'
+      unless field_names.include? key.to_s
+        raise LeapSalesforce::RequestError, "#{key} not in #{self}. " \
+        " Must be one of #{field_names}"
+      end
       conditional += "#{conditional_term} #{key} #{condition_for(value)} "
     end
     query = conditional + 'ORDER BY CreatedDate DESC NULLS FIRST'
@@ -73,10 +76,10 @@ module SoqlGlobalObjectData
   #   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]
+  # @return [self] Instance of itself storing reference to found object
   def find(lookup)
     teardown = lookup.delete(:teardown)
-    wait = lookup.delete(:wait) || true
+    wait = lookup.delete(:wait) || false
     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]}")
@@ -206,25 +209,34 @@ module SoqlGlobalObjectData
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize
 
-  private
-
-  # @todo: Cover >= condition
-  # @param [String] value Value to search for. Certain
-  # @return [String] Condition criteria to match value
+  # Returns SOQL condition for value passed to be used in SOQL query
+  # @example Greater than or equal to yesterday's date
+  #   condition_for("<=#{Time.mktime(2019,1,1)}") # => '<= 2019-01-01T00:00:00.000Z'
+  # @param [String] value Value to search for. Certain characters modify this to be more of a complex
+  #   check
+  # @return [String] Condition criteria to match value using SOQL
   def condition_for(value)
-    operator = case value[0]
-               when '>' then '>'
-               when '<' then '<'
-               when '~' then 'LIKE'
-               else
-                 return "= '#{value}'" unless value.type_of_time?
+    operator, value = case value[0]
+                      when '>', '<' then extract_comparator(value)
+                      when '~' then ['LIKE', value[1..-1]]
+                      else
+                        return "= '#{value}'" unless value.type_of_time?
 
-                 return "= #{value.to_zulu_date_string}"
-               end
+                        return "= #{value.to_zulu_date_string}"
+                      end
 
-    value = value[1..-1]
     return "#{operator} #{value.to_zulu_date_string}" if value.type_of_time?
 
     "#{operator} '#{value}'"
   end
+
+  # @param [String] value Value to extract comparator for
+  # @return [Array] Extract of >, >, >= from string and rest of string
+  def extract_comparator(value)
+    if value[1] == '='
+      [value[0..1], value[2..-1]]
+    else
+      [value[0], value[1..-1]]
+    end
+  end
 end

data/lib/leap_salesforce/version.rb

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

data/support/doctest_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'leap_salesforce/ext/string'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -303,6 +317,7 @@ files:
 - lib/leap_salesforce/users/user.rb
 - lib/leap_salesforce/users/users.rb
 - lib/leap_salesforce/version.rb
+- support/doctest_helper.rb
 homepage: https://gitlab.com/leap-dojo/leap_salesforce
 licenses:
 - MIT