sf_cli 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa13644d7e9281efbbb57516775a5edd9b69fb7ff9fbc260332a54d0afebc227
-  data.tar.gz: feb9c574b8d0681fbe9ba43572cb9b7725558fc20f69eebbbd3a2b3734aa60b9
+  metadata.gz: 64f11658c0b90ce494643c625b80f6826ec42597723315fd52690aefc6d97c8c
+  data.tar.gz: e0318c64547346287a378766a3441249cf2906539693bc982e486d6bca4b7836
 SHA512:
-  metadata.gz: ade35b3acd147ac13367c6d681c31028fef4b661ab2a97101e21b170221231c81c8d76a13c9e6f2688b085ae4889c8872ced4dd72b4f1d21cc8ac465cde78096
-  data.tar.gz: f7fb45fc3c50d2ab557f82d28b74119465fddad2c5930710aadbe0b44c19da49b8ac76c6815f0e18132d0f49d1590ed456ed42069ca07385e75db3d630f0812e
+  metadata.gz: 57c9f53f54298b2bcb7e566bceb48704012154c6a160e08402eb48d998cd2dc361d1f021bedb7866fade1beecfddab30affb0dcffa812cdfb20b7b6417c69df5
+  data.tar.gz: 875b18097589d7f4df8a212a078bbaf98e35de738782a8d4522f2a198861f280457ed23828838a77c645d170305423985edc16ee4e23ef77bd0afaeb8f0986af

data/README.rdoc

@@ -50,12 +50,12 @@ Delete a record
   sf.data.delete_record :Hoge__c, where: {Name: 'Jonny B.Good', Country: 'USA'}
 
 Using Bulk API 2.0
-  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # waiting for 5 minutes at maximum
+  sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', wait: 5  # waiting for 5 minutes at maximum
 
 Run Apex
   sf.apex.run file: 'path/to/file'
   sf.apex.run file: StringIO.new("System.debug('Hello World')")
-== Object Model Support (experimental)
+== Object Model Support
 With sf command:
   rows = sf.data.query "SELECT Id, Name FROM Contact WHERE Name = 'Akin Kristen'", model_class: Contact
   rows.first      # <Contact: @Id="0035j00001RW3xbAAD", @Name="Akin Kristen">

data/lib/sf_cli/console/commands.rb

@@ -4,7 +4,21 @@ require 'sf_cli/sf/model/sf_command_connection'
 require 'stringio'
 
 module SfCli
+  # @private :nodoc: just for developers
   module Console
+    #
+    # Developer Console commands
+    # @example
+    #  $ bundle exec rake irb[your_target_org]
+    #  irb(main):001> gen :Account, :Contact  # generate Account and Contact class
+    #  => [:Account, :Contact]
+    #
+    #  irb(main):002> Account.describe.label
+    #  => "Account"
+    #
+    #  irb(main):003> apex "System.debug('abc');" # execute Apex code
+    #  => returns the result
+    #
     module Commands
       def use(_target_org)
         target_org = _target_org.to_sym == :default ? nil : _target_org
@@ -25,7 +39,9 @@ module SfCli
         connection.target_org
       end
 
-      def apex(apex_code)
+      def apex(apex_code = nil)
+        return sf.apex.run target_org: target_org if apex_code.nil?
+
         sf.apex.run target_org: target_org, file: StringIO.new(apex_code)
       end
 

data/lib/sf_cli/sf/apex/run.rb

@@ -1,5 +1,4 @@
 require 'tempfile'
-require 'stringio'
 
 module SfCli::Sf::Apex
   module Run
@@ -10,10 +9,11 @@ module SfCli::Sf::Apex
     #
     # @param target_org [Symbol,String]
     #   an alias of paticular org, or username can be used.
-    #
-    # @param file [String,StringIO]
+    # @param file [String,#read]
     #   (1) path to a local file that contains Apex code. 
-    #   (2) StringIO object
+    #   (2) object that has #read method
+    # @param api_version [Numeric]
+    #   override the api version used for api requests made by this command
     #
     # @return [ApexResult] Apex execution result.
     #
@@ -53,46 +53,33 @@ module SfCli::Sf::Apex
     #       "Execute Anonymous: System.debug(acc.Name);",
     #      ....]
     #
-    def run(target_org: nil, file: nil)
-      return run_interactive(target_org) if file.nil?
-      return run_by_io(target_org, file) if file.is_a? StringIO
-
-      return unless file.is_a? String
-
-      flags = {:"target-org" => target_org, :"file" => file}
+    def run(target_org: nil, file: nil, api_version: nil)
+      _file = crate_tmpfile(file)
+      path = _file&.path || file
+      flags = {:"target-org" => target_org, :"file" => path, :"api-version" => api_version}
 
       json = exec(__method__, flags: flags, redirection: :null_stderr)
       ApexResult.new(json['result'])
+    ensure
+      _file&.close!
     end
 
     private
 
-    def run_by_io(target_org, io)
-      file = Tempfile.open(%w[sf apex]){|f| f.write(io.read); f}
-
-      flags = {:"target-org" => target_org, :"file" => file.path}
-      json = exec(:run, flags: flags, redirection: :null_stderr)
-      ApexResult.new(json['result'])
-    ensure
-      file&.close!
+    def crate_tmpfile(path_or_io)
+      return create_tmpfile_by_user_input if path_or_io.nil?
+      create_tmpfile_by_io(path_or_io)
     end
 
-    def run_interactive(target_org)
-      file = Tempfile.open(%w[sf apex]) do |f|
-               s = $stdin.gets
-               while s
-                 f.puts(s)
-                 s = $stdin.gets
-               end
-               f
-             end
-
-      flags = {:"target-org" => target_org, :"file" => file.path}
-
-      json = exec(:run, flags: flags, redirection: :null_stderr)
-      ApexResult.new(json['result'])
-    ensure
-      file&.close!
+    def create_tmpfile_by_user_input
+      Tempfile.open(%w[sf apex]) do |f|
+        s = $stdin.gets
+        while s
+          f.puts(s)
+          s = $stdin.gets
+        end
+        f
+      end
     end
 
     class ApexResult

data/lib/sf_cli/sf/core/base.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'tempfile'
 
 module SfCli
   module Sf
@@ -77,6 +78,12 @@ module SfCli
               ' 2> /dev/null'
             end
         end
+
+        def create_tmpfile_by_io(io)
+          return nil unless io.respond_to? :read
+
+          Tempfile.open(%w[sf]){|f| f.write(io.read); f}
+        end
       end
     end
   end

data/lib/sf_cli/sf/data/create_record.rb

@@ -5,6 +5,7 @@ module SfCli::Sf::Data
     # @param object_type [Symbol, String] object type(ex. Account)
     # @param values      [Hash]           field values to be assigned
     # @param target_org  [Symbol, String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]        override the api version used for api requests made by this command
     #
     # @return [String] record ID
     #
@@ -12,12 +13,13 @@ module SfCli::Sf::Data
     #   # create a TheCustomObject record with name and age
     #   sf.data.create_record :TheCustomObject__c, values: {Name: "John Smith", Age: 33}
     #
-    def create_record(object_type, values: {}, target_org: nil)
+    def create_record(object_type, values: {}, target_org: nil, api_version: nil)
       field_values = field_value_pairs(values)
       flags = {
         :"sobject"    => object_type,
         :"values"      => (field_values.nil? ? nil : %|"#{field_values}"|),
         :"target-org" => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/data/delete_bulk.rb

@@ -3,10 +3,13 @@ require_relative './bulk_result_v2'
 module SfCli::Sf::Data
   module DeleteBulk
     # Delete records using Bulk API 2.0
-    # @param file       [String]         path of a CSV file, which is written record IDs to delete
-    # @param sobject    [Symbol, String] object type (ex. Account)
-    # @param timeout    [Integer]        max minutes to wait for the job complete the task.
-    # @param target_org [Symbol, String] an alias of paticular org, or username can be used
+    # @param file [String,#read]
+    #   (1)path of a CSV file, which is written record IDs to delete.
+    #   (2) IO-like object, which has #read method
+    # @param sobject     [Symbol, String] object type (ex. Account)
+    # @param wait        [Integer]        max minutes to wait for the job complete the task.
+    # @param target_org  [Symbol, String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]        override the api version used for api requests made by this command
     #
     # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
@@ -19,17 +22,29 @@ module SfCli::Sf::Data
     #   sf.data.delete_resume job_id: jobinfo.id
     #
     #   # Or, you can wait for the job completion with one try.
-    #   result = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.csv', timeout: 5  # wait within 5 minutes
+    #   result = sf.data.delete_bulk sobject: :TestCustomObject__c, file: 'delete.csv', wait: 5  # wait within 5 minutes
+    #
+    #   # you can use IO-like object, which has #read, to `file` keyword:
+    #   require 'stringio'
+    #   csv = StringIO.new <<CSV
+    #     Id
+    #     001J400000Ki61uIAB
+    #     001J400000Ki3WRIAZ
+    #   CSV
+    #   jobinfo = sf.data.delete_bulk sobject: :TestCustomObject__c, file: csv
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_delete_bulk_unified command reference
     #
     #
-    def delete_bulk(file:, sobject:, timeout: nil, target_org: nil)
+    def delete_bulk(file:, sobject:, wait: nil, target_org: nil, api_version: nil)
+      _file = create_tmpfile_by_io(file)
+      path  = _file&.path || file
       flags = {
-        :"file"    => file,
+        :"file"    => path,
         :"sobject"    => sobject,
-        :"wait"      => timeout,
+        :"wait"      => wait,
         :"target-org" => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)
@@ -41,6 +56,8 @@ module SfCli::Sf::Data
         job_info: job_info,
         records:  ::SfCli::Sf::Data::BulkRecordsV2.new(**json['result']['records'])
       )
+    ensure
+      _file&.close!
     end
   end
 end

data/lib/sf_cli/sf/data/delete_record.rb

@@ -6,6 +6,7 @@ module SfCli::Sf::Data
     # @param record_id   [String]         Id of the object
     # @param where       [Hash]           conditions to identify a record
     # @param target_org  [Symbol, String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]        override the api version used for api requests made by this command
     #
     # @return [String] ID that is deleted.
     #
@@ -15,13 +16,14 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_delete_record_unified the command reference
     #
-    def delete_record(object_type, record_id: nil, where: nil, target_org: nil)
+    def delete_record(object_type, record_id: nil, where: nil, target_org: nil, api_version: nil)
       where_conditions = field_value_pairs(where)
       flags = {
         :"sobject"    => object_type,
         :"record-id"  => record_id,
         :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
         :"target-org" => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/data/delete_resume.rb

@@ -4,9 +4,10 @@ module SfCli::Sf::Data
   module DeleteResume
     # Resume a bulk delete job you previously started with Bulk API 2.0 and return a bulk result object.
     #
-    # @param job_id     [String]         job ID you want to resume<br>
-    # @param timeout    [Integer]        max minutes to wait for the job complete the task.<br>
-    # @param target_org [Symbol, String] an alias of paticular org, or username can be used<br>
+    # @param job_id      [String]         job ID you want to resume<br>
+    # @param wait        [Integer]        max minutes to wait for the job complete the task.<br>
+    # @param target_org  [Symbol, String] an alias of paticular org, or username can be used<br>
+    # @param api_version [Numeric]        override the api version used for api requests made by this command
     #
     # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
@@ -17,18 +18,19 @@ module SfCli::Sf::Data
     #
     #   # the job has already started asynchronously.
     #   # So you should check its progress.
-    #   # if you want to wait for the job complete the task, try 'timeout' option.
+    #   # if you want to wait for the job complete the task, try 'wait' option.
     #   result = sf.data.delete_resume job_id: jobinfo.id
     #
     #   puts 'yey!' if result.job_info.completed? # the job has completed
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_delete_resume_unified the command reference
     #
-    def delete_resume(job_id:, timeout: nil, target_org: nil)
+    def delete_resume(job_id:, wait: nil, target_org: nil, api_version: nil)
       flags = {
-        :"job-id"     => job_id,
-        :"wait"       => timeout,
-        :"target-org" => target_org,
+        :"job-id"      => job_id,
+        :"wait"        => wait,
+        :"target-org"  => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/data/query.rb

@@ -9,7 +9,8 @@ module SfCli::Sf::Data
     # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
     # @param model_class [Class]         the object model class
     # @param bulk        [Boolean]       use Bulk API
-    # @param timeout     [Integer]       max minutes to wait for the job complete in Bulk API mode
+    # @param wait        [Integer]       max minutes to wait for the job complete in Bulk API mode
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [Array,[String,Array]] records or a tuple containing a flag and records
     #
@@ -30,20 +31,21 @@ module SfCli::Sf::Data
     #
     # @example
     #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true              # max wait 1 min to get result (default)
-    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 5  # max wait 5 min to get result
-    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
+    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 5  # max wait 5 min to get result
+    #   done, result = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 0  # returns immediately
     #
     #   rows = result   if done     # if job is completed, the result is an array of record
     #   job_id = result unless done # if job hasn't completed or it has aborted, the result is the job ID
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_unified command reference
     #
-    def query(soql, target_org: nil, format: nil, bulk: false, timeout: nil, model_class: nil)
+    def query(soql, target_org: nil, format: nil, bulk: false, wait: nil, api_version: nil, model_class: nil)
       flags    = {
         :"query"    => %("#{soql}"),
         :"target-org" => target_org,
         :"result-format" => format,
-        :"wait" => (bulk ? timeout : nil),
+        :"wait" => (bulk ? wait : nil),
+        :"api-version" => api_version,
       }
       switches = {
         bulk: bulk,
@@ -61,12 +63,13 @@ module SfCli::Sf::Data
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
     # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available
     # @param model_class [Class]         the object model class
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [Array,[String,Array]] records or a tuple containing a flag and records
     #
     # @example
     #   # start a query job
-    #   result1 = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, timeout: 0  # returns immediately
+    #   result1 = sf.data.query 'SELECT Id, Name FROM Account', bulk: true, wait: 0  # returns immediately
     #
     #   result1 # => [false, "<job id>"]
     #
@@ -80,11 +83,12 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_query_resume_unified command reference
     #
-    def query_resume(job_id:, target_org: nil, format: nil, model_class: nil)
+    def query_resume(job_id:, target_org: nil, format: nil, api_version: nil, model_class: nil)
       flags    = {
         :"bulk-query-id" => job_id,
         :"target-org" => target_org,
         :"result-format" => format,
+        :"api-version" => api_version,
       }
       raw_output = format ? true : false
       format = format || :json

data/lib/sf_cli/sf/data/resume.rb

@@ -49,8 +49,9 @@ module SfCli::Sf::Data
     end
 
     # View the status of a bulk job.
-    # @param job_id     [String]        job ID you want to resume
-    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
+    # @param job_id      [String]        job ID you want to resume
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [JobInfo] job information
     #
@@ -73,10 +74,11 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_resume_unified command reference
     #
-    def resume(job_id:, target_org: nil)
+    def resume(job_id:, target_org: nil, api_version: nil)
       flags = {
         :"job-id"     => job_id,
         :"target-org" => target_org,
+        :"api-version" => api_version,
       }
       json = exec(__method__, flags: flags, redirection: :null_stderr)
 

data/lib/sf_cli/sf/data/search.rb

@@ -1,9 +1,10 @@
 module SfCli::Sf::Data
   module Search
     # Search objects using SOSL.
-    # @param sosl       [String]        SOSL
-    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
-    # @param format     [Symbol,String] get the command's raw output. human, csv, json can be available.
+    # @param sosl        [String]        SOSL
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param format      [Symbol,String] get the command's raw output. human, csv, json can be available.
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [Hash] the search result
     # @note if you choose csv as format, csv files are downloaded in current directory
@@ -25,11 +26,12 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_search_unified command reference
     #
-    def search(sosl, target_org: nil, format: nil)
+    def search(sosl, target_org: nil, format: nil, api_version: nil)
       flags = {
         :"query"         => %|"#{sosl}"|,
         :"target-org"    => target_org,
         :"result-format" => format,
+        :"api-version" => api_version,
       }
       raw_output = format ? true : false
       format = format&.to_sym || :json

data/lib/sf_cli/sf/data/update_record.rb

@@ -7,6 +7,7 @@ module SfCli::Sf::Data
     # @param where       [Hash]          field values to identify a record
     # @param values      [Hash]          field values for update
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     # 
     # @return [String] ID of the record updated 
     # 
@@ -16,15 +17,16 @@ module SfCli::Sf::Data
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_update_record_unified command reference
     #
-    def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil)
+    def update_record(object_type, record_id: nil, where: nil, values: nil, target_org: nil, api_version: nil)
       where_conditions  = field_value_pairs(where)
       field_values      = field_value_pairs(values)
       flags = {
-        :"sobject"    => object_type,
-        :"record-id"  => record_id,
-        :"where"      => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
-        :"values"     => (field_values.nil? ? nil : %|"#{field_values}"|),
-        :"target-org" => target_org,
+        :"sobject"     => object_type,
+        :"record-id"   => record_id,
+        :"where"       => (where_conditions.nil? ? nil : %|"#{where_conditions}"|),
+        :"values"      => (field_values.nil? ? nil : %|"#{field_values}"|),
+        :"target-org"  => target_org,
+        :"api-version" => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/data/upsert_bulk.rb

@@ -3,11 +3,14 @@ require_relative './bulk_result_v2'
 module SfCli::Sf::Data
   module UpsertBulk
     # Update records using Bulk API 2.0
-    # @param file        [String]        path of a CSV file to update records
+    # @param file [String,#read]
+    #   (1)path of a CSV file, which is written record IDs to delete.
+    #   (2) IO-like object, which has #read method
     # @param sobject     [Symbol,String] object type(ex. Account)
     # @param external_id [String]        name of the external ID field.Otherwise it must be Id
-    # @param timeout     [Integer]       max minutes to wait for the job complete the task
-    # @param target_org [Symbol,String]  an alias of paticular org, or username can be used
+    # @param wait        [Integer]       max minutes to wait for the job complete the task
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
@@ -20,17 +23,29 @@ module SfCli::Sf::Data
     #   sf.data.upsert_resume job_id: jobinfo.id
     #
     #   # Or, you can wait for the job completion with one try.
-    #   result = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', timeout: 5  # wait within 5 minutes
+    #   result = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: 'upsert.csv', wait: 5  # wait within 5 minutes
+    #
+    #   # you can use IO-like object, which has #read, to `file` keyword:
+    #   require 'stringio'
+    #   csv = StringIO.new <<CSV
+    #     Id,Name
+    #     001J400000Ki61uIAB,John Smith
+    #     001J400000Ki3WRIAZ,Foo Baz Bar
+    #   CSV
+    #   jobinfo = sf.data.upsert_bulk sobject: :TestCustomObject__c, file: csv
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_bulk_unified command reference
     #
-    def upsert_bulk(file:, sobject:, external_id:, timeout: nil, target_org: nil)
+    def upsert_bulk(file:, sobject:, external_id:, wait: nil, target_org: nil, api_version: nil)
+      _file = create_tmpfile_by_io(file)
+      path  = _file&.path || file
       flags = {
-        :"file"    => file,
-        :"sobject"    => sobject,
-        :"external-id"  => external_id,
-        :"wait"      => timeout,
-        :"target-org" => target_org,
+        :"file"        => path,
+        :"sobject"     => sobject,
+        :"external-id" => external_id,
+        :"wait"        => wait,
+        :"target-org"  => target_org,
+        :"api-version"  => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)
@@ -42,6 +57,8 @@ module SfCli::Sf::Data
         job_info: job_info,
         records:  ::SfCli::Sf::Data::BulkRecordsV2.new(**json['result']['records'])
       )
+    ensure
+      _file&.close!
     end
   end
 end

data/lib/sf_cli/sf/data/upsert_resume.rb

@@ -3,9 +3,10 @@ require_relative './bulk_result_v2'
 module SfCli::Sf::Data
   module UpsertResume
     # Resume a bulk upsert job you previously started with Bulk API 2.0 and return a bulk result object.
-    # @param job_id     [String]        job ID you want to resume
-    # @param timeout    [Integer]       max minutes to wait for the job complete the task
-    # @param target_org [Symbol,String] an alias of paticular org, or username can be used
+    # @param job_id      [String]        job ID you want to resume
+    # @param wait        [Integer]       max minutes to wait for the job complete the task
+    # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [JobInfo, BulkResultV2] the job result, whose type is changed by situation
     #
@@ -16,18 +17,19 @@ module SfCli::Sf::Data
     #
     #   # the job has already started asynchronously.
     #   # So you should check its progress.
-    #   # if you want to wait for the job complete the task, try 'timeout' option.
+    #   # if you want to wait for the job complete the task, try 'wait' option.
     #   result = sf.data.upsert_resume job_id: jobinfo.id
     #
     #   puts 'yey!' if result.job_info.completed? # the job has completed
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm#cli_reference_data_upsert_resume_unified command reference
     #
-    def upsert_resume(job_id:, timeout: nil, target_org: nil)
+    def upsert_resume(job_id:, wait: nil, target_org: nil, api_version: nil)
       flags = {
         :"job-id"     => job_id,
-        :"wait"       => timeout,
+        :"wait"       => wait,
         :"target-org" => target_org,
+        :"api-version"  => api_version,
       }
       action = __method__.to_s.tr('_', ' ')
       json = exec(action, flags: flags, redirection: :null_stderr)

data/lib/sf_cli/sf/model/query_methods.rb

@@ -26,6 +26,11 @@ module SfCli
             connection.find(name.to_sym, id, Object.const_get(name.to_sym))
           end
 
+          def find_by(*find_condition)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.where(*find_condition).take
+          end
+
           def limit(num)
             qc = QueryCondition.new(connection, self.name, self.field_names)
             qc.limit(num)

data/lib/sf_cli/sf/model/sf_command_connection.rb

@@ -37,8 +37,8 @@ module SfCli
         #
         # For query details, see {SfCli::Sf::Data::Query sf data query}
         #
-        def exec_query(soql, format: nil, bulk: false, timeout: nil, model_class: nil)
-          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, timeout: timeout, model_class: model_class)
+        def exec_query(soql, format: nil, bulk: false, wait: nil, model_class: nil)
+          sf_data.query(soql, target_org: target_org, format: format, bulk: bulk, wait: wait, model_class: model_class)
         end
 
         # @private :nodoc: just for developers

data/lib/sf_cli/sf/org/display.rb

@@ -5,6 +5,7 @@ module SfCli::Sf::Org
     #
     # Returns the org's connection information
     # @param target_org [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]      override the api version used for api requests made by this command
     #
     # @note this function returns the org information including security sensitive things such as access token, username and so on.
     # @return [ConnectionInfo] the org's connection information
@@ -24,8 +25,8 @@ module SfCli::Sf::Org
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_display_unified command reference
     #
-    def display(target_org: nil)
-      flags    = {:"target-org" => target_org}
+    def display(target_org: nil, api_version: nil)
+      flags    = {:"target-org" => target_org, :"api-version" => api_version}
       json = exec(__method__, flags: flags, redirection: :null_stderr)
 
       ConnectionInfo.new(

data/lib/sf_cli/sf/sobject/describe.rb

@@ -5,6 +5,7 @@ module SfCli::Sf::Sobject
     # Returns a schema object containing the Salesforce object schema
     # @param object_type [Symbol,String] object type(ex: Account)
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @return [Schema] a schema object that represents the object schema
     #
@@ -17,10 +18,11 @@ module SfCli::Sf::Sobject
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_describe_unified command reference
     #
-    def describe(object_type, target_org: nil)
+    def describe(object_type, target_org: nil, api_version: nil)
       flags    = {
-        :"sobject"    => object_type,
-        :"target-org" => target_org,
+        :"sobject"     => object_type,
+        :"target-org"  => target_org,
+        :"api-version" => api_version,
       }
       json = exec(__method__, flags: flags, redirection: :null_stderr)
       Schema.new(json['result'])

data/lib/sf_cli/sf/sobject/list.rb

@@ -3,13 +3,15 @@ module SfCli::Sf::Sobject
     # Returns a list of Salesforce object name
     # @param object_type [Symbol,String] 'all' or 'custom'
     # @param target_org  [Symbol,String] an alias of paticular org, or username can be used
+    # @param api_version [Numeric]       override the api version used for api requests made by this command
     #
     # @see https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm#cli_reference_sobject_list_unified command reference
     #
-    def list(object_type, target_org: nil)
+    def list(object_type, target_org: nil, api_version: nil)
       flags    = {
-        :"sobject"    => (object_type.to_sym == :custom ? :custom : :all),
-        :"target-org" => target_org,
+        :"sobject"     => (object_type.to_sym == :custom ? :custom : :all),
+        :"target-org"  => target_org,
+        :"api-version" => api_version,
       }
       json = exec(__method__, flags: flags, redirection: :null_stderr)
       json['result']

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Takanobu Maekawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies: []
-description: This is a class library for introducing Salesforce CLI to Ruby scripting.
-  Currenty only sf command is the target of development.
+description: A class library for introducing Salesforce CLI to Ruby scripting. Currenty
+  only sf command is the target of development.
 email:
 executables: []
 extensions: []
@@ -84,5 +84,5 @@ requirements:
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: A library for using Salesforce CLI in Ruby
+summary: A library for Salesforce CLI in Ruby
 test_files: []