leap_salesforce 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abbfab4a385a6d834dfcaf784c14d232669e85e0e2f7f9aaa8a4fdc99398b288
-  data.tar.gz: 4292651ae00e51421a0dc4260cd44e7f77539e8753431008c8fd30e7acd1f5ef
+  metadata.gz: 44ffa8e3367450ab36724adf3fc899d2cb95afe6f53d35e691f0b195abb76951
+  data.tar.gz: 913a39e2840894dd0c1a906a301ae864b1e368b9ebc80fa4e547315c06c25497
 SHA512:
-  metadata.gz: 8937117f55d69b733902bb49ded422a5602cb6040da7f987f2de5d36dbdfbab597fef81db1b256cf036cf7dea0ee3452fa7ccbbd10482c57b2f0104500785812
-  data.tar.gz: 12aa02241dbe430e5b048a0ca6c1bf683cb2fb279592a2adcc6203fe5861dc3ff8029b2573c76c035ec6168f093ead8e3bd0f10a53788399fadcead161302d6d
+  metadata.gz: b0f4e1e61acf32114e51fe16451ea745d92198eb3944177885bc0f3cbc36bada65bc70c5efaa596978422b31246eaf3cd16aeab927ede42662dff79aa74d97dd
+  data.tar.gz: a8f1cfaea86a0766dbe58889e46c9a51370c2a934140bb37f55d5da235b31af7640aa2b79d70125aa6b9626d92d722d35c19d85d89e018f21d0b3f8210409ba1

data/ChangeLog

@@ -1,3 +1,17 @@
+Version 1.2.1
+* Debug SOAP login request so it can be debugged
+
+Version 1.2.0
+* Ability to set security token on leap_salesforce user by setting an environment variable with the format
+  `ENV["#{key}_token"]``
+* Remove deprecated method of create_enum within soql_settings class
+
+Version 1.1.2
+* Fix user_id from session
+
+Version 1.1.1
+* Allow session information from SOAP login to be available with LeapSalesforce::Session class
+
 Version 1.1.0
 * Proper fix to work with activerecord 7 - requires ruby > 2.7
 

data/README.md

@@ -104,6 +104,10 @@ Credentials are not stored in stored in source control. They can be setting thro
 * 'client_secret'
 * 'password'
 
+> Security tokens can be set for each user (adding to password in OAuth like in [this article](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_login.htm))
+> To do that set an environment variable as USER_KEY_token. E.g, so for a user with a key of :admin
+> the token would be set with the `admin_token` environment variable
+
 Tests can be run using the default `Rake` task.
 
 E.g.,

data/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'config/credentials/token' if File.exist? 'config/credentials/token.rb'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rake/clean'
@@ -14,6 +15,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Check Salesforce OAuth2 authentication is working'
 task :check_oauth do
+  Soaspec::OAuth2.debug_oauth = true
   LeapSalesforce.oauth_working?
 end
 

data/bin/console

@@ -7,6 +7,7 @@ require 'leap_salesforce'
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require 'pry'
+require 'irb'
+require 'irb/completion'
 
-Pry.start
+IRB.start(__FILE__)

data/config/general.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Set environment variable to set a security token that will be sent for a user
+# ENV['admin_token'] = 'test'
+
 # Add users to LeapSalesforce context. First user is the default
 module LeapSalesforce
   Users.add User.new :admin, 'samuel.garratt@brave-otter-ttxype.com'

data/exe/leap_salesforce

@@ -36,6 +36,7 @@ module LeapSalesforce
         exit if oauth_setup.downcase == 'n'
       end
       query_for_parameters # TODO: for sfdx
+      has_ignore_file = File.exist?('.gitignore')
       generate_files binding, ['Gemfile', 'Rakefile', '.leap_salesforce.yml', '.rspec', '.gitignore',
                                { config: ['general.rb', { credentials: 'salesforce_oauth2.yml' }] },
                                { spec: %w[spec_helper.rb limit_spec.rb crud_eg_spec.rb picklists_spec.rb] }]
@@ -52,6 +53,10 @@ module LeapSalesforce
       puts `rake leaps:create_soql_objects`
       puts 'Creating enums'.colorize :yellow
       puts `rake leaps:create_enums`
+      return unless has_ignore_file
+
+      puts 'Your .gitignore is already present so not updated.
+Please ignore "config/credentials/" and "logs/"'.colorize :red
     end
   end
 end

data/lib/leap_salesforce/parameters.rb

@@ -76,14 +76,13 @@ module LeapSalesforce
     # using sfdx
     # @return [Hash] OAuth2 parameters used in connecting to salesforce
     def oauth_settings
-      settings = {
-        username: '<%= LeapSalesforce.api_user %>', password: LeapSalesforce.password,
+      {
+        username: '<%= LeapSalesforce.api_user %>',
+        password: '<%= LeapSalesforce.password + LeapSalesforce.security_token.to_s %>',
         client_id: LeapSalesforce.client_id,
         client_secret: LeapSalesforce.client_secret,
         token_url: "#{LeapSalesforce.general_url}/services/oauth2/token"
       }
-      settings[:security_token] = LeapSalesforce.security_token if LeapSalesforce.security_token
-      settings
     end
 
     # @return [String] General salesforce URL for logging in to
@@ -98,6 +97,8 @@ module LeapSalesforce
                   else
                     LeapSalesforce::Users.where(user)&.username
                   end
+      leaps_user = LeapSalesforce::Users.where username: @api_user
+      LeapSalesforce.security_token = leaps_user.security_token
       Soaspec::SpecLogger.info "Using user '#{@api_user}' for API"
     end
 

data/lib/leap_salesforce/session.rb

@@ -0,0 +1,45 @@
+require_relative 'auth'
+require 'savon'
+require 'json'
+
+module LeapSalesforce
+  # Holds information about a login session
+  class Session
+    # @return [String] Session id returned from SOAP API
+    attr_accessor :session_id
+    # @return [String] User id returned from SOAP API
+    attr_accessor :user_id
+    # @return [Hash] Login response
+    attr_accessor :login_response
+
+    def initialize(username, password, security_token = '')
+      login_body = LeapSalesforce::Session.soap_login username, password, security_token
+
+      self.session_id = login_body[:login_response][:result][:session_id]
+      self.user_id = login_body[:login_response][:result][:user_id]
+      self.login_response = login_body[:login_response]
+    end
+
+    class << self
+
+      # Login via SOAP API
+      def soap_login(username, password, security_token)
+        client = Savon.client do
+          endpoint "#{SoqlHandler.instance_url}/services/Soap/u/51.0"
+          namespace "urn:partner.soap.sforce.com"
+          log true # See request and response. (Put this in traffic file)
+          log_level :debug
+          logger Soaspec::SpecLogger.create
+          pretty_print_xml true # Prints XML pretty
+        end
+
+        response = client.call(:login, message:
+            {
+              username: username,
+              password: password + security_token.to_s
+            })
+        response.body
+      end
+    end
+  end
+end

data/lib/leap_salesforce/soql_data/soql_settings.rb

@@ -13,10 +13,4 @@ module SoqlSettings
   def soql_object_name
     @soql_object_name || to_s
   end
-
-  # @deprecated Not used, setting in '.leap_salesforce.yml' controls this now
-  def create_enum(_set)
-    LeapSalesforce.logger.warn "Method 'create_enum' called when it is deprecated" \
-    " from #{caller_locations[0]}"
-  end
 end

data/lib/leap_salesforce/users/user.rb

@@ -14,11 +14,16 @@ module LeapSalesforce
     #   readable format is required such as in a Cucumber test
     attr_accessor :description
 
-    # @param [String, Symbol] key Key used to identify a test user
-    # @param [String] username Name used to login with user. In email address format.
+    # @return [String] Security token of user. Recommend this be set through ENV variable
+    attr_accessor :security_token
+
+    # @param [String, Symbol] user_params[0] key Key used to identify a test user
+    # @param [String] user_params[1] username Name used to login with user. In email address format.
+    # @param [String] user_params[1] security_token Security token of user
     def initialize(*user_params, description: nil)
       self.key = user_params[0]
       self.username = user_params[1]
+      self.security_token = ENV["#{key}_token"] || nil
       self.description = description
     end
 

data/lib/leap_salesforce/version.rb

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

data/lib/leap_salesforce.rb

@@ -19,6 +19,7 @@ require 'factory_bot' # For mass production of data
 require 'faker' # For fake data
 require 'leap_salesforce/error'
 require 'leap_salesforce/loader'
+require 'leap_salesforce/session'
 
 # If variable is present within LeapSalesforce set it
 def load_variables_from(file)
@@ -82,3 +83,5 @@ module LeapSalesforce
 
   self.objects_to_verify = SoqlData.descendants if objects_to_verify.empty?
 end
+
+LeapSalesforce.api_user = LeapSalesforce::Users.list.first.username

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leap_salesforce
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -333,6 +333,7 @@ files:
 - lib/leap_salesforce/rake.rb
 - lib/leap_salesforce/rake/setup.rake
 - lib/leap_salesforce/rake/sfdx.rake
+- lib/leap_salesforce/session.rb
 - 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