leap_salesforce 0.1.15 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ac3a7c96d31655ef2684afb14ba1088656bfba4bdba621d1c282163783b6a4
-  data.tar.gz: 5aad78509c4ef1844c58bd0dbe600f81248126e4570eec154ef0a35abe1091a4
+  metadata.gz: 0fe3d1e7b89c6a0185c21a67a0b9b96a151a09a18c313bd81d27675911d7922e
+  data.tar.gz: c3542d891c596f1b5f40d53362ef4184bbb1d774bc5839b8d508a8bf09646ef5
 SHA512:
-  metadata.gz: 1efdda645ee1103bce00418fd65f75badfc570191a60f7f6d5b44dca2eda1d38a395c3b9f164ec4a10a8a7f980401e1a88d031663fa76ef3d1c752626d2fca10
-  data.tar.gz: 917b74365cc67fe2d4ec7d9ab6bb3e723c8a7a4b3cdcf2cfcdfa7f42d901d37807c689d940f7be933f764117160016e8595a54e348eb8053dc9b4bb872791f1d
+  metadata.gz: 82c5fdb6d8841ad1472a42462cd316ee9db718a9bd7fdd0696506ebc751ba55fa58648f596d938fb4f19c300c2d01ab94b1cc711a2613641ce749964f0865355
+  data.tar.gz: 8f4ab171180697bd999dc7b159ddbde298be59977d904ef4d33e7df3b84aa8b1610706ad871a3210ff33d565617e5fd89d0b17a5f691c9f3c90f316a555d1f47

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.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>
+--><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

@@ -60,7 +60,7 @@
     <orderEntry type="library" scope="PROVIDED" name="rspec-its (v1.3.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.8.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.8.0, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.73.0, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.74.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.10.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubykeyword (v0.0.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="savon (v2.12.0, RVM: ruby-2.6.0) [gem]" level="application" />

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.1.16
+* Bug Fix
+  * Fixed where ERB was not being used to interpret user on init script
+  * Map keys representing elements passed to `find` and `update` to use snakecase version as defined by soql_element
+
 Version 0.1.15
 * Enhancements
   * Handle greater than/less than equal comparator in query

data/README.md

@@ -180,7 +180,7 @@ If we had the following `factory` for Contact
 ```ruby
 FactoryBot.define do
   factory :contact do    
-    first_name { 'Test Person' }
+    last_name { 'Test Person' }
   end
 end
 ```
@@ -203,7 +203,12 @@ example:
 
 ##### Reading 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:
 
+```ruby
+@contact = Contact.find last_name: 'Test Person'
+```
 
 ## Structure
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/clean'
 require 'yard'
 require 'yard/doctest/rake'
 
-require 'leap_salesforce/rake'
+require 'leap_salesforce/rake' # TODO: Append this line to existing repo
 
 CLEAN.include 'tmp/*'
 

data/lib/leap_salesforce/generator/exe_helpers.rb

@@ -38,9 +38,9 @@ module LeapSalesforce
     def verify_oauth
       LeapSalesforce.client_id = options[:client_id] || input_for('Client id (Customer Id)')
       LeapSalesforce.client_secret = options[:client_secret] || STDIN.getpass('Client secret (Consumer Secret)')
-      LeapSalesforce.api_user = options[:username] || input_for('Salesforce username. It is ideal to start with a System admin' \
+      LeapSalesforce.api_user = ERB.new(options[:username] || input_for('Salesforce username. It is ideal to start with a System admin' \
 ' so that any necessary metadata can be read. More users can be added later. You can use ERB to make name' \
-' vary according to environment (e.g., test.user@<%= LeapSalesforce.environment %>.my.company.com)')
+' vary according to environment (e.g., test.user@<%= LeapSalesforce.environment %>.my.company.com)')).result(binding)
       LeapSalesforce.password = options[:password] || STDIN.getpass('Password (Recommendation is that 1 password' \
 ' be shared across all test users to be easier to manage):')
       LeapSalesforce.oauth_working?

data/lib/leap_salesforce/generator/soql_objects.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'fileutils'
+require 'leap_salesforce'
 require_relative 'default'
 require_relative 'generator'
 

data/lib/leap_salesforce/generator/templates/Rakefile.erb

@@ -1,5 +1,4 @@
 require 'rspec/core/rake_task'
-require 'leap_salesforce/rake'
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -10,4 +9,5 @@ end
 
 task default: %i[check_oauth spec]
 
-require 'leap_salesforce'
+require 'leap_salesforce/rake' # Load LeapSalesforce tasks
+require 'leap_salesforce'      # Require basic leap salesforce files

data/lib/leap_salesforce/generator/templates/spec/crud_eg_spec.rb.erb

@@ -11,7 +11,7 @@ RSpec.describe 'Contact CRUD' do
   end
   it 'Read contact by name' do
     FactoryBot.create(:contact, first_name: uniq_value)
-    @contact = Contact.find(FirstName: uniq_value)
+    @contact = Contact.find(first_name: uniq_value)
     retrieved_first_name = @contact.first_name
     expect(retrieved_first_name).to eq uniq_value
   end

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -27,7 +27,7 @@ module SoqlGlobalObjectData
   # @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)
+  # @return [self] Exchange object from which JSON response can be obtained (i.e, with exchange.response)
   def query(soql_query, wait: false)
     rest_query = soql_query.gsub('%', '%25').gsub('+', '%2B').tr(' ', '+')
     if wait
@@ -39,7 +39,7 @@ module SoqlGlobalObjectData
     end
   end
 
-  # @param [Symbol, String] lookup Hash representing look up performed
+  # @param [Hash] lookup Hash representing look up performed
   # @param [String] url Url to get
   def data_from_url(url, lookup)
     new("Id at #{url}", method: :get, suburl: url.split("v#{SoqlHandler.api_version}/").last)
@@ -55,11 +55,8 @@ 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)} "
+      key_used = map_key key
+      conditional += "#{conditional_term} #{key_used} #{condition_for(value)} "
     end
     query = conditional + 'ORDER BY CreatedDate DESC NULLS FIRST'
     query += " LIMIT #{limit}" if limit
@@ -92,7 +89,7 @@ module SoqlGlobalObjectData
     instance_to_get
   end
 
-  # @return [Exchange] Result of looking up id based on lookup criteria
+  # @return [self] SoqlData object that is the result of looking up id based on lookup criteria
   def lookup_id(lookup)
     teardown = lookup.delete(:teardown)
     SoqlHandler.new("Query on #{self}").use
@@ -144,18 +141,18 @@ module SoqlGlobalObjectData
   # Remove object from Salesforce with provided id
   # @param [String] id Id of element to update
   # @param [Hash] data Key value pairs with data to update
-  # @return [Exchange] Exchange object for object
+  # @return [self] SoqlData object representing result of API update call
   def update(id, data)
     must_pass = data.delete(:must_pass)
     data = data.transform_values do |value|
       value.is_a?(Time) ? value.salesforce_format : value
     end
+    data.transform_keys! { |key| map_key(key) } # Map keys to valid field names
     SoqlHandler.new("Update #{id}").use
 
     update = new("Update #{self}, #{id} with '#{data}'", method: :patch,
                                                          suburl: "sobjects/#{soql_object_name}/#{id}", body: data)
     update.call
-
     return update unless must_pass
 
     successful?
@@ -209,6 +206,21 @@ module SoqlGlobalObjectData
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize
 
+  # Map key to a field name if used directly or field defined through 'soql_element'
+  # @param [Symbol, String] key Key to map to Table field name
+  # @return [String] Field name of Salesforce entity to use
+  def map_key(key)
+    if field_names.include? key.to_s
+      key.to_s
+    else
+      return new.send("#{key}_element") if new.respond_to?("#{key}_element")
+
+      raise LeapSalesforce::RequestError, "#{key} not in #{self}. " \
+        " Must be one of #{field_names} or a field name described in" \
+        " #{self}::FieldNames"
+    end
+  end
+
   # 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'

data/lib/leap_salesforce/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
 platform: ruby
 authors:
 - IQA