leap_salesforce 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0643c6bdb99cf5d5ab3c1daa4993be2d57405e8beca02b4554188b260cf35c38
-  data.tar.gz: 2aadf0ffb313f32e35280794de1a182ca3e9567b1753c878493ac24180069658
+  metadata.gz: f223007c3c8d006fd9d639357756108c242a18f70a5843648ffe3393ce1928be
+  data.tar.gz: abe22b8c691f391158e38520476ed23e1378e54e2feabb4cac1ff366d422847b
 SHA512:
-  metadata.gz: 4af203c910c8aaf8c3b9322c72e26010a45cbb3b4a60b594584537f2f934038a12dde800cb58ba600392d676aa6b46970c3747094daf91774d76e80917fe27f6
-  data.tar.gz: 07f636197ce307d8390b694317ddcfec9e8dadf56277650b124b93f1646210d17850ea8a5b070f91fd6418911f69d2ca266ff943f03874bba5a8216fae202306
+  metadata.gz: 24fa2a866b764c494127fd2413c4a6f9c14d2faee72d0f47b3efec4a96295e9decdff0c2ebc8e701f880663c8777649d05a6fb5411a49255650106b75759c3f0
+  data.tar.gz: 1aad23255a4ee3233096a029962f24ecf7079850c67107834be0d11671c7165a673edb2733d8e586407a3dd68c368bd4ba52f1e23183127d4d3563b707eeb710

data/.idea/.rakeTasks

@@ -4,4 +4,4 @@ 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.1.gem into the pkg directory" fullCmd="build" taksId="build" /><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.1.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install leap_salesforce-0.1.1.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.1 and build and push leap_salesforce-0.1.1.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.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>

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

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

data/ChangeLog

@@ -1,3 +1,10 @@
+Version 0.1.12
+* Enhancements
+  * Add contact factory to source control so it can be used to demonstrate traits and associations
+  * Provide 2 more ways of creating objects.
+    * Through specifying hash on 'new'
+    * Through 'create' which calls FactoryBot for itself
+
 Version 0.1.11
 * Enhancements
   * Set retry limit to 0 for OAuth as retrying too many times causes user to be locked

data/PITCHME.md

@@ -0,0 +1,110 @@
+# Leap Salesforce
+
+Making Salesforce testing easy
+
+---
+
+## Contents
+
+* What does this library do
+* Bootstrap of test automation suite from Salesforce credentials
+* Verification of Salesforce on different levels
+* Creation of objects
+* Querying for objects
+* Updating objects
+* Deleting objects
+
+---
+
+## What it does
+
+Makes it easy to create integrated tests using Salesforce API with Ruby objects that map to objects in Salesforce. 
+Ruby gem is open source and has many convenience methods to performing actions that form automated tests.
+
+---
+
+## Bootstrapping test automation suite
+
+* Install gem
+* From Salesforce credentials create a full automation suite
+* See a recording of running through this [here](https://asciinema.org/a/259098)
+
+---
+
+## Verification on different levels
+
+From faster with broadest coverage to slower and harder to maintain 
+
+* Metadata
+* System
+* Integration  
+* UI
+
+---
+
+## Metadata
+
+Creating a baseline of Metadata and checking what has changed (For example, the values in a picklist can be 
+recorded and then every time there's a change, the test will be to whether the values are the same. The baseline
+can be re-recorded easily when a change is meant to occur). 
+
+---
+
+## System
+
+Entities can have single actions on them and a small step checked. (For example, not setting all mandatory fields
+can be checked to see if an error message occurs or an update could be made to an object that automatically creates
+another object which can be verified)
+
+---
+
+## Integration
+
+Business processes that verify the integration of entities, automated processes, third party systems, etc
+
+---
+
+## UI
+
+Crucial actions can be performed via the UI to verify the User interface.
+At the moment this library does not assist in UI testing but the plan is
+to accommodate this in the future through page objects that are tied to
+metadata.
+
+---
+
+## Creation of data
+
+---?code=spec/integration/creating_spec.rb&lang=ruby&title=Creating entities
+
+@[1](Declare what it is you're testing)
+@[2](Define what 'it' is, a the object under test must do)
+@[3](Create an instance of the object class - nothing sent to Salesforce yet)
+@[4-5](Set the first and last name to random names)
+@[6](Create the object in Salesforce by sending request via API)
+@[7](Verify creation was successful)
+@[9-12](Creating through Factory)
+
+---
+
+## Reading data
+
+---?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)
+
+---
+
+## Updating and deleting data
+
+---?code=spec/integration/crud_eg_spec.rb&lang=ruby&title=Updating entities
+
+@[7-8,19-20](Update first name using 'first_name' setting)
+@[23](Delete test contact)
+
+---
+
+## Thank you
+
+Any questions?

data/PITCHME.yaml

@@ -0,0 +1,2 @@
+
+logo : assets/img/logo.png

data/README.md

@@ -50,7 +50,8 @@ E.g.,
 
 `rake` # Run all tests
 
-API Traffic logs can be seen in the `logs` folder. You can see an example of running through this [here](https://asciinema.org/a/259098)
+API Traffic logs can be seen in the `logs` folder. You can see an example of running through 
+this [here](https://asciinema.org/a/259098).
 
 ### Understanding how things work
  
@@ -158,6 +159,8 @@ Everyone interacting in the LeapSalesforce project’s codebases, issue trackers
 
 # Examples
 
+See [spec/integration](spec/integration) folder for examples of tests.  
+
 ```ruby
 # deleting old contacts
 objects = Contact.each_id_with CreatedDate: "<#{5.days.ago}"
@@ -167,3 +170,7 @@ objects.each do |id|
   Contact.delete id
 end 
 ```
+
+# References
+
+See the presentation on this [here](https://gitpitch.com/leap-dojo/leap_salesforce?grs=gitlab)

data/lib/leap_salesforce.rb

@@ -6,7 +6,7 @@ require 'soaspec'
 Soaspec::OAuth2.refresh_token = :once # Save access token and reuse it
 Soaspec.log_warnings = false # Log any API warnings
 Soaspec::OAuth2.request_message = false
-Soaspec::OAuth2.retry_limit = 0 # Retrying for OAuth token results in error
+Soaspec::OAuth2.retry_limit = 1 # Retrying for OAuth token too many times results in user locked out
 require 'active_support/core_ext/integer/time' # Creating time objects
 require 'leap_salesforce/parameters'
 require 'leap_salesforce/ext/string'

data/lib/leap_salesforce/soql_data/soql_data.rb

@@ -26,13 +26,18 @@ class SoqlData < Exchange
   #   contact.last_name = 'Smith'
   #   contact.save! # API request made at this point
   #
+  # @example Create a Contact by specifying field names
+  #   contact = Contact.new first_name: 'Bob', last_name: 'Smith'
+  #   contact.save!
+  #
   # @example Create a contact using a factory with a trait of :email
   #   contact_with_email = FactoryBot.create(:contact, :email)
   #
   # @example Perform a get to the Salesforce limits api
   #   SoqlData.new("Limits", method: :get, suburl: 'limits/')
   #
-  # @param [String] name Name describing object. Defaults to itself
+  # @param [String, Hash] name Name describing object. Defaults to itself. If Hash is provided
+  #   with no 'http_parameters' then list will be fields to set on creating entity
   # @param [Hash] http_parameters Parameters used in making HTTP request. If creating a new object
   #   leave this to empty. Otherwise Hash would look like method: :get, suburl: 'URL_AFTER_SOQL_HANDLER_BASE_URL'
   def initialize(name = nil, http_parameters = {})
@@ -44,6 +49,17 @@ class SoqlData < Exchange
     self.suburl = "sobjects/#{table_name}"
     optional_name = self.class.to_s == table_name ? '' : "(#{table_name})"
     self.test_name = "Factory for '#{self.class}'#{optional_name}" unless name
+    return unless name.is_a? Hash
+
+    name.each do |field_name, field_value|
+      send("#{field_name}=", field_value)
+    end
+  end
+
+  # Create object using FactoryBot
+  # @param [Hash] factory_parameters Parameters to pass to FactoryBot
+  def self.create(*factory_parameters)
+    FactoryBot.create(to_s.snakecase.to_sym, *factory_parameters)
   end
 
   # @return [String] User used to make api calls

data/lib/leap_salesforce/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -237,6 +237,7 @@ files:
 - ".idea/.rakeTasks"
 - ".idea/dictionaries/iqa.xml"
 - ".idea/leap-salesforce.iml"
+- ".idea/markdown-exported-files.xml"
 - ".idea/markdown-navigator.xml"
 - ".idea/markdown-navigator/profiles_settings.xml"
 - ".idea/misc.xml"
@@ -249,8 +250,11 @@ files:
 - ChangeLog
 - Gemfile
 - LICENSE.txt
+- PITCHME.md
+- PITCHME.yaml
 - README.md
 - Rakefile
+- assets/img/logo.png
 - bin/console
 - bin/setup
 - config/environments/prod.rb