leap_salesforce 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455d4ec9852a5afd9bf82cbe504b755fee025025ff3a7ad35d958ca944ea89cd
-  data.tar.gz: 304a5f93081a5e65fff63b34ce61a8cb0f4a8ed90e71d4ef9947a57eb8155562
+  metadata.gz: 467199374ed9914ed99da0b95b4c9fbe7105eed96b1456ea469d55c1cfadc0f9
+  data.tar.gz: 1aca36e08dca7f60197fc8809d2fa69a1468087c0114c0fc70964cb0b46c80c6
 SHA512:
-  metadata.gz: bfa00811dd445829c140a9980353c32b8568feb47c3caa37a8e950426b7b31c1ac00bb333ac1707861271b21684d770892263061c7cddc7f0c2d3cf22b553c8a
-  data.tar.gz: b48b467b870cf0b239d39ce648d2ed7b7cc5d4762c9c9bb6668f89a92b4a5a298535e6a08d12e8c3baedc1de13717952b886926a8eb2df35d0052e971aace28c
+  metadata.gz: 18f11ad55eee275cad36b44ba80eef5a34ba1de1cdba00d2c40541bf2449dedf29234f3854a1629e174d6353916ee40e834ea2ec0f4bc351a1142e0e60613a1e
+  data.tar.gz: ed67318c6a72655e8053d02f945ed133e6bf8461a89fc00ea7dd7684402d30291375c046b418f3465a2edcf33f45ddac1345027557cfc9a75623be041ea3d2a2

data/.idea/dictionaries/iqa.xml

@@ -3,6 +3,7 @@
     <words>
       <w>rubocop</w>
       <w>salesforce</w>
+      <w>sfdx</w>
       <w>soql</w>
       <w>topoisomerase</w>
     </words>

data/.idea/leap-salesforce.iml

@@ -7,12 +7,11 @@
     <content url="file://$MODULE_DIR$" />
     <orderEntry type="jdk" jdkName="RVM: ruby-2.6.0" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="activemodel (v5.2.3, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="activerecord (v5.2.3, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="activesupport (v5.2.3, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v6.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activerecord (v6.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="addressable (v2.6.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="akami (v1.3.1, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="arel (v9.0.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.3, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundler (v2.0.2, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -25,6 +24,7 @@
     <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-accept (v1.7.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" />
     <orderEntry type="library" scope="PROVIDED" name="httpi (v2.4.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="humanize (v2.1.1, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -51,9 +51,9 @@
     <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.2, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="random-port (v0.4.1, 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="rest-client (v2.1.0, 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" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.8.0, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.8.3, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -67,13 +67,13 @@
     <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.30, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="soaspec (v0.2.31, 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" />
     <orderEntry type="library" scope="PROVIDED" name="tilt (v2.0.9, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="to_regexp (v0.2.1, RVM: ruby-2.6.0) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="topoisomerase (v0.1.3, RVM: ruby-2.6.0) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="topoisomerase (v0.1.5, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tzinfo (v1.2.5, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.6.0) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.7.6, RVM: ruby-2.6.0) [gem]" level="application" />
@@ -82,5 +82,6 @@
     <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" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.1.9, RVM: ruby-2.6.0) [gem]" level="application" />
   </component>
 </module>

data/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.1.18
+* Enhancements
+  * `LeapSalesforce.logger` can be used to configure logger
+  * Cater for deprecated `get` method with deprecation warning
+
 Version 0.1.17
 * Enhancements
   * Retry if a Server breaks connection intermittently raises an error

data/lib/leap_salesforce/parameters.rb

@@ -2,6 +2,7 @@
 
 require_relative 'users/users'
 require_relative 'soql_object'
+require 'logger'
 
 # Adding parameters to set for authentication, environment and other common settings
 module LeapSalesforce
@@ -13,6 +14,8 @@ module LeapSalesforce
   @client_secret = ENV['client_secret']
   @password = ENV['password']
   @environment = nil
+  @logger = Logger.new STDOUT
+  @sfdx = false
   class << self
     # @return [String] Environment to use for tests. This can be accessed to change the username used to login
     #   to test.salesforce with. This can be set on the command line with 'LEAP_ENV'
@@ -86,12 +89,17 @@ module LeapSalesforce
     attr_accessor :objects_to_verify
     # @return [Array] List of Soql Objects identified for Leap Salesforce to maintain
     attr_reader :soql_objects
-
+    # @return [Logger] Logger used by LeapSalesforce
+    attr_accessor :logger
     # @return [Array] list_of_soql_objects Array describing Soql objects taken from .leap_salesforce.yml
     def soql_objects=(list_of_soql_objects)
       @soql_objects = list_of_soql_objects.collect do |soql_object_desc|
         SoqlObject.new(soql_object_desc)
       end
     end
+    # Setting this variable uses sfdx for authentication and other actions such
+    # as opening an organisation link
+    # @return [Boolean] Whether Salesforce sfdx is being used
+    attr_accessor :sfdx
   end
 end

data/lib/leap_salesforce/soql_data/soql_data.rb

@@ -100,6 +100,16 @@ class SoqlData < Exchange
     self
   end
 
+  # @deprecated
+  # Get details of itself by searching for it's id
+  # Store response within itself
+  # @return [Exchange] Exchange with details of data
+  def get
+    LeapSalesforce.logger.warn "Method 'get' called when it is deprecated" \
+    " from #{caller_locations[0]}"
+    find
+  end
+
   # Update current record with data provided
   # @param [Hash] data Data to update exchange with
   def update(data)

data/lib/leap_salesforce/soql_data/soql_global_object_data.rb

@@ -89,6 +89,16 @@ module SoqlGlobalObjectData
     instance_to_get
   end
 
+  # @deprecated
+  # Get details of itself by searching for it's id
+  # Store response within itself
+  # @return [Exchange] Exchange with details of data
+  def get(lookup)
+    LeapSalesforce.logger.warn "Method 'get' called when it is deprecated" \
+    " from #{caller_locations[0]}"
+    find(lookup)
+  end
+
   # @return [self] SoqlData object that is the result of looking up id based on lookup criteria
   def lookup_id(lookup)
     teardown = lookup.delete(:teardown)
@@ -183,6 +193,7 @@ module SoqlGlobalObjectData
   # rubocop:disable Metrics/AbcSize
   def soql_element(name, backend_name)
     # Either set the element (if creating a new record) or update the object
+    # @todo: ensure next time an element is retrieved it's not from a cached value
     # @param [String] new_value Value to update record to
     define_method("#{name}=") do |new_value|
       if @response
@@ -199,6 +210,7 @@ module SoqlGlobalObjectData
       rescue NoElementAtPath
         raise diagnose_error if error_message?
 
+        # TODO: Response here should not be necessary. Only find is
         @response = find.response
         self[backend_name]
       end

data/lib/leap_salesforce/soql_data/soql_handler.rb

@@ -7,7 +7,13 @@ require 'soaspec'
 # 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
-  oauth2 LeapSalesforce.oauth_settings
+  oauth2 LeapSalesforce.oauth_settings unless LeapSalesforce.sfdx
+  if LeapSalesforce.sfdx
+    # @return [String]
+    def instance_url
+      # TODO: Get this
+    end
+  end
   base_url '<%= instance_url %>/services/data/v<%= api_version %>/'
 
   pascal_keys true

data/lib/leap_salesforce/users/users.rb

@@ -10,7 +10,7 @@ module LeapSalesforce
       # @return [Array] List of test users
       attr_accessor :list
 
-      # @param [LeapSalesforce::User] user Test user to add to leap salesforce
+      # @param [LeapSalesforce::User, Array] user Test user to add to leap salesforce
       def add(user)
         return @list << user if user.is_a? LeapSalesforce::User
 

data/lib/leap_salesforce/version.rb

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

data/lib/leap_salesforce.rb

@@ -3,13 +3,13 @@
 require 'leap_salesforce/version'
 
 require 'soaspec'
-Soaspec::OAuth2.refresh_token = :once # Save access token and reuse it
-Soaspec.log_warnings = false # Log any API warnings
-Soaspec::SpecLogger.progname = 'Leaps'
-Soaspec::OAuth2.request_message = false
+Soaspec::OAuth2.refresh_token = :once   # Save access token and reuse it
+Soaspec.log_warnings = false            # Log any API warnings
+Soaspec::SpecLogger.progname = 'Leaps'  # Program name shown in logs
+Soaspec::OAuth2.request_message = false # Don't display message explaining OAuth request
 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/parameters' # Important to load this first
 require 'leap_salesforce/ext/string'
 require 'leap_salesforce/ext/time'
 require 'require_all'
@@ -21,7 +21,7 @@ require 'leap_salesforce/error'
 LEAP_CONFIG_FILE = '.leap_salesforce.yml'
 CREDENTIAL_FILE = File.join('config', 'credentials', 'salesforce_oauth2.yml')
 
-leap_logger = Logger.new STDOUT
+leap_logger = LeapSalesforce.logger
 leap_logger.level = Logger::DEBUG
 leap_logger.datetime_format = '%Y-%m-%d %H:%M:%S'
 
@@ -41,7 +41,15 @@ end
 
 raise LeapSalesforce::SetupError, 'LeapSalesforce.environment not set' if LeapSalesforce.environment.nil?
 
-if File.exist? CREDENTIAL_FILE
+if LeapSalesforce.sfdx
+  # Assume authentication already made through 'sfdx force:auth:jwt:grant'
+  unless ENV['SF_USERNAME'] && ENV['SF_CONSUMER_KEY']
+    raise LeapSalesforce::SetupError,
+          'Please set SF_USERNAME and SF_CONSUMER_KEY environment variables'
+  end
+  `sfdx force:user:display -u #{ENV['SF_USERNAME']}`
+elsif File.exist? CREDENTIAL_FILE
+  # Set credentials from credentials file for ConnectedApp
   YAML.load_file(CREDENTIAL_FILE).each do |key, value|
     LeapSalesforce.send("#{key}=", value)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler