leap_salesforce 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 258bca84c4767b65af3cd5c8d9ba5793bde62df0252362e0f1e299104285da0a
-  data.tar.gz: dbd278d3534e47034f9ea13b01343b5411b0e57a5f1a06e571d27154bcb3d774
+  metadata.gz: c7d7840f64baf2e945a29ab4f022f5ff2191b3443e9068f9cbd32afafb7520bb
+  data.tar.gz: fbe2a1d779b5605cd19c7eb79b2327fb673865170e2becc567bc587fa4d32798
 SHA512:
-  metadata.gz: 40c2ed16eafa5a643fca053388b67ca49014039850c5b1c4a36da11857b3f6f98c1abc032215b2426069df4c854751be4378f97550663c25459318d41434275e
-  data.tar.gz: 781698e76929b80b87607616f27525d5d09c359a1880e27768c4dc970e26f9a825f882e6b8495860c16ab4776340135b93a768e771cef201f7829c6f31ea529c
+  metadata.gz: 861290a24fbb1575f0c3338690bd0aef6c65d3ee6a6d0e7a98c5b511e6bffc243891d927b08cd925fa819a09e9b9bcd523a6950729364c5597815f26b8f95bb9
+  data.tar.gz: c027b01dc9606cb88d388d25ba3b8895f05c9d5ae47b1377efc42022887b8fa160999c870e078f3434383a1249f24e66951c72b84dcbd5fcaf3398ca22bcd683

data/ChangeLog

@@ -1,3 +1,8 @@
+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
 

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/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

@@ -9,18 +9,21 @@ module LeapSalesforce
     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)
-      login_body = LeapSalesforce::Session.soap_login username, password
+    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)
+      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"
@@ -29,7 +32,7 @@ module LeapSalesforce
         response = client.call(:login, message:
             {
               username: username,
-              password: password
+              password: password + security_token
             })
         response.body
       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.2'
+  VERSION = '1.2.0'
 end

data/lib/leap_salesforce.rb

@@ -83,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.2
+  version: 1.2.0
 platform: ruby
 authors:
 - IQA
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler