use_salesforce_dataloader 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ab36d2a09a460f3b092870ace1bedbd63332784
-  data.tar.gz: 3d6d104e5b0357c3091c74e158e28b99e1e89a57
+SHA256:
+  metadata.gz: 8ddaf30c25c5ec5c092d0de40e2477b622bfb441eae8fd9556432de57a19498d
+  data.tar.gz: 6f2c3c603164383be7326b7690d104cbbd394882476fe1e96b74234896b38916
 SHA512:
-  metadata.gz: 5fa2faaf0084cfe2418d37ed56564e7baedd8a9dbd580aa2027db08a071ba3a270e249cc1d33295276869bb75dba30db9e0096d0496ede68c311f817d211c0be
-  data.tar.gz: f17d8bb60aa544ba798a1746af208557332c01c102928461673aced76f5ad2c3d27cb475001f191b991257ae3cb1fa88abf9a418f2aeb31ffa27ef56982bf808
+  metadata.gz: 5e909679727ea08bc3f7e84c885821ba38e6241fbdaffe70cba12510fcf860d20c388fd0e772f721d4eb7ad29de30be17a7321d13a05cdb713c043ea0034d763
+  data.tar.gz: 7cdbe099b7a94449b8fe637246f78e16c6d78b417a0ab2a9ccc09430938784571e88db077cf653fa2d50fe3c2007861654a9b3d7eeb35d08c77a586619bd27a9

data/lib/use_salesforce_dataloader.rb

@@ -1,38 +1,83 @@
 # -*- coding: utf-8 -*-
 require 'open3'
 
-# see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/loader_params.htm
+# @see https://developer.salesforce.com/docs/atlas.en-us.dataLoader.meta/dataLoader/loader_params.htm
+# Standard file layout (allow different layout):
+# - <tt>conf_dir/</tt>
+#   - <tt>key.txt</tt>
+#   - <tt>process-conf.xml</tt>
+#   - <tt>map.sdl</tt>
+#
 class UseSalesforceDataLoader
+  VERSION = '0.0.8'
 
-  # File layout:
-  # conf_dir/key.txt
-  # conf_dir/process-conf.xml
-  # conf_dir/map.sdl
-  attr_accessor :conf_dir
-  attr_accessor :conf_key_file
-  attr_accessor :conf_process_xml_file
-  attr_accessor :conf_map_file
+  # Setter for <tt>@conf_dir</tt>, set values <tt>@conf_key_file</tt>, <tt>@conf_process_xml_file</tt> and <tt>@conf_map_file</tt> at the same time.
   def conf_dir=(path)
     @conf_dir = path
     @conf_key_file = @conf_dir + '/key.txt'
-    @conf_process_xml_file = @conf_dir + '/process-conf.xml'
     @conf_map_file = @conf_dir + '/map.sdl'
+    @conf_process_xml_file = @conf_dir + '/process-conf.xml'
+    @conf_dir
   end
 
-  # process-conf.xml
+  # @return [String] path of conf_dir
+  # @see #conf_dir=
+  def conf_dir
+    @conf_dir
+  end
+
+  # @return [String] path of conf_key_file.
+  # @see #conf_dir=
+  attr_accessor :conf_key_file
+
+  # @return [String] path of conf_process_xml_file
+  # @see #conf_dir=
+  attr_accessor :conf_process_xml_file
+
+  # @return [String] path of conf_map_file
+  # @see #conf_dir=
+  attr_accessor :conf_map_file
+
+  # Set/get <tt>sfdc.endpoint</tt> in XML config.
+  # @return [String] 
+  # @example
+  #   dataloader.endpoint = 'https://' + 'test.salesforce.com'
+  attr_accessor :endpoint
+
+  # Set/get <tt>sfdc.username</tt> in XML config.
+  # @return [String] 
+  # @example
+  #   dataloader.usrname = 'foo@example.com'
+  attr_accessor :username
+
+  # Set/get <tt>sfdc.password</tt> in XML config.
+  # @return [String] 
+  # @example
+  #   dataloader.password = '0123456789'
+  attr_accessor :password
+
+  # @return [String]
+  # @see PROCESS_XML_TEMPLATE
   attr_accessor :bean_id
+
+  # @return [String]
+  # @see PROCESS_XML_TEMPLATE
   attr_accessor :bean_description
+
+  # @return [String]
+  # @see PROCESS_XML_TEMPLATE
   attr_accessor :property_name
-  attr_accessor :overwrite_entries
 
-  # Salesforce.com authentication data
-  attr_accessor :endpoint # ex. https://test.salesforce.com
-  attr_accessor :username # ex. foo@example.com
-  attr_accessor :password # ex. 0123456789
+  # @return [String]
+  # @see BASE_ENTRIES
+  attr_accessor :overwrite_entries
 
-  # jar:      path of dataloader-NN.N.N-uber.jar, ex. "/usr/lib/dataloader-41.0.0-uber.jar"
-  # java:     command line of java runtime, ex. "/usr/bin/java"
-  # java_opt: ex.  "-Dfile.encoding=UTF-8"
+  # @param jar [String] path of dataloader-NN.N.N-uber.jar.
+  # @param java [String] path of java runtime.
+  # @param java_opt [String] command line option for java runtime.
+  # @example
+  #   UseSalesforceDataLoader.new('/usr/lib/dataloader-41.0.0-uber.jar', '/usr/bin/java', '-Dfile.encoding=UTF-8')
+  #
   def initialize(jar, java = nil, java_opt = nil)
     java = exec_command('which java') unless java
     path_check(java)
@@ -42,22 +87,17 @@ class UseSalesforceDataLoader
     @process = "#{j} -Dsalesforce.config.dir=%s com.salesforce.dataloader.process.ProcessRunner process.name=%s"
   end
 
-  # Original: dataloader/bin/encrypt.sh
-  # Usage: dataloader/bin/encrypt.sh
-  # Utility to encrypt a string based on a static or a provided key
-  # Options (mutually exclusive - use one at a time):
-  #   -g <seed text>                                 Generate key based on seed
-  #   -v <encrypted> <decrypted value> [Path to Key] Validate whether decryption of encrypted value matches the decrypted value, optionally provide key file
-  #   -e <plain text> [Path to Key]                  Encrypt a plain text value, optionally provide key file (generate key using option -g)
+  # @note
   #
-  def encrypt(args)
-    cmd = "#{@encrypt} #{args} | sed 's/^.*) \- //g'"
-    exec_command(cmd)
-  end
-
-  # Original: dataloader/bin/process.sh
-  # Usage: dataloader/bin/process.sh [conf-dir] <process-name>
+  #   Original:
+  #
+  #   dataloader/bin/process.sh
   #
+  #   Usage: dataloader/bin/process.sh [conf-dir] <process-name>
+  #
+  # Return command line string for execute dataloader by named process.
+  # @param name [String]
+  # @return [String] command line
   def process_cmd(name)
     path_check(@conf_dir)
     path_check(@conf_process_xml_file)
@@ -65,6 +105,8 @@ class UseSalesforceDataLoader
   end
 
   # Save encrypt key file
+  # @see #conf_key_file
+  # @return [String] conf_key_file
   def save_conf_key_file
     @conf_key_file.tap do |f|
       open(f, 'w:UTF-8') do |o|
@@ -74,6 +116,8 @@ class UseSalesforceDataLoader
   end
 
   # Save conf xml file
+  # @see #conf_process_xml
+  # @return [String] conf_process_xml_file
   def save_conf_process_xml_file
     @conf_process_xml_file.tap do |f|
       open(f, 'w:UTF-8') do |o|
@@ -83,6 +127,7 @@ class UseSalesforceDataLoader
   end
 
   # Generate XML config
+  # @return [String] xml config
   def conf_process_xml
     entries = BASE_ENTRIES.merge(default_overwrite_entries)
     entries.merge!(@overwrite_entries) if @overwrite_entries
@@ -97,9 +142,35 @@ class UseSalesforceDataLoader
                             entries_xml]
   end
 
-  private
+  # @note
+  #
+  #   Original:
+  #
+  #   dataloader/bin/encrypt.sh
+  #
+  #   Usage: dataloader/bin/encrypt.sh
+  #
+  #   Utility to encrypt a string based on a static or a provided key
+  #
+  #   Options (mutually exclusive - use one at a time):
+  #
+  #   -g <seed text> Generate key based on seed
+  #
+  #   -v <encrypted> <decrypted value> [Path to Key] Validate whether decryption of encrypted value matches the decrypted value, optionally provide key file
+  #
+  #   -e <plain text> [Path to Key]                  Encrypt a plain text value, optionally provide key file (generate key using option -g)
+  #
+  # internal use
+  # @param [String] options
+  # @return [String]
+  def encrypt(options)
+    cmd = "#{@encrypt} #{options} | sed 's/^.*) \- //g'"
+    exec_command(cmd)
+  end
 
   # internal use
+  # @see #conf_process_xml
+  # @return [Hash]
   def default_overwrite_entries
     path_check(@conf_key_file)
     encrypt_password = encrypt("-e '#{@password}' '#{@conf_key_file}'")
@@ -115,22 +186,27 @@ class UseSalesforceDataLoader
   end
 
   # interal use
-  def text_seed
+  # @return [String] random seed
+  private def text_seed
     rand(0xffff_ffff).to_s(16)
   end
 
   # internal use
-  def path_check(f)
+  # @return [true, false]
+  private def path_check(f)
     raise "Path not found: #{f}" unless File.exist?(f)
   end
 
   # internal use
-  def exec_command(cmd)
+  # @param [String] cmd
+  # @return [String] stdout of cmd
+  private def exec_command(cmd)
     o, e, s = Open3.capture3(cmd)
     raise "Something wrong" unless e.empty? and s.success?
     o.chomp
   end
 
+  # @note internal use
   PROCESS_XML_TEMPLATE = <<'PROCESS_XML'
 <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd">
 <beans>
@@ -148,10 +224,12 @@ class UseSalesforceDataLoader
 </beans>
 PROCESS_XML
 
+  # @note internal use
   ENTRIES_XML_TEMPLATE = <<'ENTRIES_XML'
         <entry key="%s" value="%s"/>
 ENTRIES_XML
           
+  # @note internal use
   BASE_ENTRIES = {
     'dataAccess.readUTF8'               => 'true',
     'dataAccess.writeUTF8'              => 'true',
@@ -161,13 +239,13 @@ ENTRIES_XML
     'dataAccess.writeBatchSize'         => nil,
     'process.enableExtractStatusOutput' => 'false',
     'process.enableLastRunOutput'       => 'true',
-    'process.encryptionKeyFile'         => nil,
+    'process.encryptionKeyFile'         => nil, # see also #conf_dir
     'process.initialLastRunDate'        => nil,
-    'process.lastRunOutputDirectory'    => nil,
+    'process.lastRunOutputDirectory'    => nil, # see also #conf_dir
     'process.loadRowToStartAt'          => nil,
-    'process.mappingFile'               => nil,
+    'process.mappingFile'               => nil, # see also #conf_dir
     'process.operation'                 => nil,
-    'process.statusOutputDirectory'     => nil,
+    'process.statusOutputDirectory'     => nil, # see also #conf_dir
     'process.outputError'               => nil,
     'process.outputSuccess'             => nil,
     'process.useEuropeanDates'          => nil,
@@ -179,17 +257,17 @@ ENTRIES_XML
     'sfdc.debugMessages'                => nil,
     'sfdc.debugMessagesFile'            => nil,
     'sfdc.enableRetries'                => nil,
-    'sfdc.endpoint'                     => nil,
+    'sfdc.endpoint'                     => nil, # see also #endpoint
     'sfdc.entity'                       => nil,
     'sfdc.externalIdField'              => nil,
     'sfdc.extractionRequestSize'        => nil,
     'sfdc.extractionSOQL'               => nil,
     'sfdc.insertNulls'                  => 'true',
-    'sfdc.loadBatchSize'                => nil,
+    'sfdc.loadBatchSize'                => nil, # recommended value? -> 200(Not Bulk API) / 2000(Bulk API)
     'sfdc.maxRetries'                   => nil,
     'sfdc.minRetrySleepSecs'            => nil,
     'sfdc.noCompression'                => nil,
-    'sfdc.password'                     => nil,
+    'sfdc.password'                     => nil, # see also #password
     'sfdc.proxyHost'                    => nil,
     'sfdc.proxyPassword'                => nil,
     'sfdc.proxyPort'                    => nil,
@@ -199,6 +277,6 @@ ENTRIES_XML
     'sfdc.timezone'                     => nil,
     'sfdc.truncateFields'               => 'false',
     'sfdc.useBulkApi'                   => nil,
-    'sfdc.username'                     => nil,
+    'sfdc.username'                     => nil, # see also #username
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_salesforce_dataloader
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Hiroaki Nagoya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: hnagoya@gmail.com
@@ -19,7 +19,7 @@ files:
 - lib/use_salesforce_dataloader.rb
 homepage: https://rubygems.org/gems/use_salesforce_dataloader
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -37,7 +37,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Force.com Apex Data Loader for Ruby/Linux - command line version