sf_cli 0.0.4 → 0.0.5

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

@@ -0,0 +1,64 @@
+module SfCli::Sf::Org
+  module Login
+    # login to the org by the browser.
+    #
+    # *target_org* --- an alias of paticular org, or username can be used<br>
+    #
+    # *instance_url* --- URL of the instance that the org lives on.
+    #
+    # *browser* --- browser in which to open the org.
+    #
+    # == examples:
+    #   sf.org.login_web
+    #   sf.org.login_web target_org: :dev
+    #
+    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_web_unified]
+    #
+    def login_web(target_org: nil, instance_url: nil, browser: nil)
+      flags = {
+        :"alias"        => target_org,
+        :"instance-url" => instance_url,
+        :"browser"      => browser,
+      }
+      action = __method__.to_s.tr('_', ' ')
+      exec(action, flags: flags)
+    end
+
+    # login to the org by access token.
+    #
+    # NOTE: this method doesn't support user interactive mode, so *SF_ACCESS_TOKEN* environment variable must be set before call this method.
+    #
+    # *instance_url* --- URL of the instance that the org lives on.
+    #
+    # *target_org* --- an alias of paticular org, or username can be used<br>
+    #
+    # ======
+    #  ENV['SF_ACCESS_TOKEN'] = 'xxxxxxxxxx'
+    #  sf.org.login_access_token instance_url: https://hoge.bar.baz.salesforce.com
+    #
+    # == how to set env variable outside of ruby
+    # In Unix/mac:
+    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx'
+    #   $ ruby app_using_sfcli.rb
+    # or
+    #   $ SF_ACCESS_TOKEN='xxxxxxxxxx' ruby app_using_sfcli.rb
+    #
+    # In Windows:
+    #   $ set SF_ACCESS_TOKEN=xxxxxxxxxx
+    #   $ ruby app_using_sfcli.rb
+    #
+    # For more command details, see {the command reference}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm#cli_reference_org_login_access-token_unified]
+    #
+    def login_access_token(instance_url:, target_org: nil)
+      flags = {
+        :"instance-url" => instance_url,
+        :"alias"        => target_org,
+      }
+      switches = {
+        :"no-prompt" => true,
+      }
+      action = __method__.to_s.tr('_', '-').sub('-', ' ')
+      exec action, flags: flags, switches: switches, redirection: :null_stderr
+    end
+  end
+end

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

@@ -14,11 +14,14 @@ module SfCli
         GenerateResult = Struct.new(:output_dir, :files, :raw_output, :warnings)
 
         #
-        # generate a Salesforce project. (equivalent to *sf* *project* *generate*)
+        # generate a Salesforce project
         #
         # *name*        --- project name<br>
+        #
         # *template*    --- project template name<br>
+        #
         # *output_dir*  --- output directory<br>
+        #
         # *manifest*    --- switch to create manifest file in the project directory (manifest/package.xml). default: false
         #
         # For more command details, see the {reference document}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_generate_unified]
@@ -42,15 +45,19 @@ module SfCli
           )
         end
 
-        # generate the manifest file of a Salesforce project. (equivalent to *sf* *project* *generate* *manifest*)
+        # generate the manifest file of a Salesforce project
         #
         # *metadata*    --- an array that consists of metadata type like CustomObject, Layout and so on.  (default: [])<br>
+        #
         # *api_verson*  --- api version (default: nil)<br>
+        #
         # *output_dir*  --- manifest's output directory in the project directory. You can use relative path from the project root (default: nil)<br>
+        #
         # *from_org*    --- username or alias of the org that contains the metadata components from which to build a manifest (default: nil)<br>
+        #
         # *source_dir*  --- paths to the local source files to include in the manifest (default: nil)
         #
-        # == examples
+        # ======
         #  sf.project.generate_manifest metadata: %w[CustomObject Layout]  # creates a package.xml, which is initialized with CustomObject and Layout
         #  sf.project.generate_manifest from_org: <org_name>               # creates a package.xml, which is initialized with all metadata types in the org
         #

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

@@ -11,10 +11,11 @@ module SfCli
       class Core
         include ::SfCli::Sf::Core::Base
 
-        # returns a hash object containing the Salesforce object schema. (equivalent to *sf* *sobject* *describe*)
+        # returns a hash object containing the Salesforce object schema
         #
         # *objectType* --- object type (ex: Account)<br>
-        # *target_org* --- an alias of paticular org, not default one<br>
+        #
+        # *target_org* --- an alias of paticular org, or username can be used<br>
         #
         # For more command details, see {the command reference}[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]
         #
@@ -27,10 +28,11 @@ module SfCli
           json['result']
         end
 
-        # returns a list of Salesforce object API name. (equivalent to *sf* *sobject* *list*)
+        # returns a list of Salesforce object name
         #
         # *object_type* --- all or custom<br>
-        # *target_org* --- an alias of paticular org, not default one<br>
+        #
+        # *target_org* --- an alias of paticular org, or username can be used<br>
         #
         # For more command details, see {the command reference}[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]
         #

data/lib/sf_cli.rb

@@ -1,15 +1,18 @@
 require 'sf_cli/sf/main'
 #
 # the global method that represents *sf* command.
-# This is desgined as the syntax suger, which can use with similar usability to the original.
 #
-# For command details, see the {reference document}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm]
+# With method chaining, you can use similar syntax as original command.
 #
 # == examples
-#   # you can follow the similar syntax to the original command by using method chain.
 #
-#   sf.org.display                            # same as original command 'sf org display'
-#   sf.data.query "SELECT Name FROM Account"  # same as original command 'sf data query "SELECT Name FROM Account"`
+# ======
+#   sf.org.display # => returns the org information object
+#
+# ======
+#   sf.data.query "SELECT Name FROM Account" # => [{"Name"=>"Aethna Home Products"}]
+#
+# For details of sf command, see the {reference guide}[https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm]
 #
 def sf
   SfCli::Sf::Main.instance

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sf_cli
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Takanobu Maekawa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-09-08 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.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -23,14 +23,30 @@ files:
 - README.rdoc
 - lib/sf_cli.rb
 - lib/sf_cli/sf/core/base.rb
+- lib/sf_cli/sf/data/bulk_result_v2.rb
 - lib/sf_cli/sf/data/core.rb
+- lib/sf_cli/sf/data/create_record.rb
+- lib/sf_cli/sf/data/delete_bulk.rb
+- lib/sf_cli/sf/data/delete_record.rb
+- lib/sf_cli/sf/data/delete_resume.rb
+- lib/sf_cli/sf/data/get_record.rb
 - lib/sf_cli/sf/data/helper_methods.rb
+- lib/sf_cli/sf/data/query.rb
+- lib/sf_cli/sf/data/query_helper.rb
+- lib/sf_cli/sf/data/resume.rb
+- lib/sf_cli/sf/data/search.rb
+- lib/sf_cli/sf/data/update_record.rb
+- lib/sf_cli/sf/data/upsert_bulk.rb
+- lib/sf_cli/sf/data/upsert_resume.rb
 - lib/sf_cli/sf/main.rb
 - lib/sf_cli/sf/model.rb
 - lib/sf_cli/sf/model/class_definition.rb
 - lib/sf_cli/sf/model/generator.rb
 - lib/sf_cli/sf/model/schema.rb
 - lib/sf_cli/sf/org/core.rb
+- lib/sf_cli/sf/org/display.rb
+- lib/sf_cli/sf/org/list.rb
+- lib/sf_cli/sf/org/login.rb
 - lib/sf_cli/sf/project/core.rb
 - lib/sf_cli/sf/sobject/core.rb
 homepage: https://github.com/tmkw/sf_cli
@@ -38,7 +54,7 @@ licenses:
 - MIT
 metadata:
   homepage_url: https://github.com/tmkw/sf_cli
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,9 +69,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'Salesforce CLI ( >= 2.54.0): https://developer.salesforce.com/tools/salesforcecli'
+- 'Salesforce CLI ( >= 2.56.7): https://developer.salesforce.com/tools/salesforcecli'
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A library for using Salesforce CLI in Ruby
 test_files: []