sf_cli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de348eca269f611892a10afe7064a6db06d701cc349d92bf5092543e4372e176
+  data.tar.gz: 33057527c8449b9f6a39e88a23bfaa5179084267243501b04dbaa17ce8f7d9c4
+SHA512:
+  metadata.gz: b1918b2fca8857f3a7520fec1c7dc0fc596d0ae272997edf24eb4335189a1ea62dd9d2fbeb80ed9dec91341fe2d85f48293d499e4873d3a4ae8fc6d59266b9cc
+  data.tar.gz: fae662b7c7534da4c59bed8a3f1dbe8fb4191224b8fdb79810f507bb81f617892ae0b6252dff007512750845c91d90425779fe8306c7fc16d2203fc9bdd24aad

data/lib/sf_cli/helper_methods.rb

@@ -0,0 +1,26 @@
+module SfCli
+  module HelperMethods
+    def os
+      @os ||= ENV['OS']
+    end
+
+    def null_stderr_redirection
+      @null_stderr_redirection ||=
+        if os.nil? || os.eql?('Windows_NT')
+          '2>nul'
+        else
+          '2> dev/null'
+        end
+    end
+
+    def flag(name, arg = nil, use_argument: true, long_flag: true)
+      flag_indicator = long_flag ? '--' : '-'
+
+      if use_argument
+        arg ? %(#{flag_indicator}#{name} #{arg}) : ''
+      else
+        %(#{flag_indicator}#{name})
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/base.rb

@@ -0,0 +1,17 @@
+require_relative '../helper_methods'
+
+module SfCli
+  class Sf
+    class Base
+      include ::SfCli::HelperMethods
+
+      attr_reader :target_org
+
+      # *target_org* --- an org alias name, which is used for sf command operations (default is nil). If it is nil, the command uses the default org.
+      #
+      def initialize(target_org = nil)
+        @target_org = target_org
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/data.rb

@@ -0,0 +1,38 @@
+require 'json'
+require_relative './base'
+
+module SfCli
+  class Sf
+    #
+    # ==== description
+    # The class representing *sf* *data*
+    #
+    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_data_commands_unified.htm
+    #
+    class Data < Base
+
+      # get the object records. It's eqivalent to use *sf* *data* *query*
+      #
+      # *soql* --- SOQL
+      #
+      # *model_class* --- the data model class representing the record object.  
+      #
+      # ==== examples
+      #   sf.data.query('SELECT Id, Name From Account Limit 3') # returns an array of Hash object
+      #
+      #   Account = Struct.new(:Id, :Name)
+      #   sf.data.query('SELECT Id, Name From Account Limit 3', model_class: Account)  # returns an array of Account struct object
+      #
+      def query(soql, model_class: nil)
+        json = JSON.parse `sf data query --json --query "#{soql}" #{flag :"target-org", target_org} #{null_stderr_redirection}`
+        raise StandardError.new(%|sf data query: failed. (query: "#{soql}")|) if json['status'] != 0
+
+        json['result']['records'].each_with_object([]) do |h, a|
+          h.delete "attributes"
+          a << (model_class ? model_class.new(**h) : h)
+        end
+      end
+    end
+  end
+end
+

data/lib/sf_cli/sf/operations.rb

@@ -0,0 +1,4 @@
+require_relative './org'
+require_relative './data'
+require_relative './sobject'
+require_relative './project'

data/lib/sf_cli/sf/org.rb

@@ -0,0 +1,56 @@
+require_relative './base'
+
+module SfCli
+  class Sf
+    #
+    # ==== description
+    # The class representing *sf* *org*.
+    #
+    # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_org_commands_unified.htm
+    #
+    class Org < Base
+      ConnectionInfo = Struct.new(:access_token, :alias, :instance_url, :api_version, :status)
+
+      # login to the org by the browser. It's equivalent to use *sf* *org* *login* *web*
+      #
+      # *instance_url* --- custom login url.
+      #
+      def login_web(instance_url: nil)
+        `sf org login web #{flag :alias, target_org} #{flag :"instance-url", instance_url}`
+      end
+
+      #
+      # returns the org's connection information. It's equivalent to use *sf* *org* *display*.
+      #
+      def display
+        lines = StringIO.new(`sf org display #{flag :"target-org", target_org} #{null_stderr_redirection}`).readlines
+
+        connection_info = ConnectionInfo.new(
+          access_token: nil,
+          alias:        nil,
+          instance_url: nil,
+          api_version:  nil,
+          status:       nil
+        )
+
+        lines.each do |line|
+          case line
+          when /Access Token/
+            connection_info.access_token = line.split(' ')[2]
+          when /Alias/
+            connection_info.alias = line.split(' ')[1]
+          when /Instance Url/
+            connection_info.instance_url = line.split(' ')[2]
+          when /Api Version/
+            connection_info.api_version = line.split(' ')[2]
+          when /Connected Status/
+            connection_info.status = line.split(' ')[2]
+          end
+        end
+
+        connection_info
+      end
+    end
+  end
+end
+

data/lib/sf_cli/sf/project.rb

@@ -0,0 +1,74 @@
+require 'pathname'
+require_relative './base'
+
+module SfCli
+  class Sf
+    # ==== description
+    # The class representing *sf* *project*
+    #
+    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm
+    #
+    class Project < Base
+
+      #
+      # generate a Salesforce project. It's equivalent to *sf* *project* *generate*.
+      #
+      # *name*        --- project name
+      #
+      # *template*    --- project template name
+      #
+      # *output_dir*  --- output directory
+      #
+      def generate(name, template: 'standard', output_dir: nil)
+        `sf project generate #{flag :name, name} #{flag :template, template} #{flag :"output-dir", output_dir} --manifest #{null_stderr_redirection}`
+        raise StandardError.new(%|command 'sf project generate' failed.|) unless $?.success?
+      end
+
+      # generate the manifest file of a Salesforce project.  It's equivalent to *sf* *project* *generate* *manifest*
+      #
+      # *metadata*    --- an array that consists of metadata type like CustomObject, Layout and so on.  (default: [])
+      # 
+      # *api_verson*  --- api version (default: nil)
+      # 
+      # *project_dir* --- project directory which you want to create the manifest  (default: nil)
+      # 
+      # *output_dir*  --- manifest's output directory in the project directory. You can use relative path from the project root (default: nil)
+      # 
+      # *from_org*    --- username or alias of the org that contains the metadata components from which to build a manifest (default: nil)
+      # 
+      # *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
+      #
+      def generate_manifest(metadata: [], api_version: nil, project_dir: nil, output_dir: nil, from_org: nil, source_dir: nil)
+        raise StandardError.new('Exactly one of the following must be provided: --from-org, --metadata, --source-dir') if metadata.empty? && from_org.nil? && source_dir.nil?
+        base_dir = Dir.pwd
+
+        if project_dir
+          raise StandardError.new('the project directory not found') unless FileTest.exist?(project_dir) && FileTest.directory?(project_dir)
+          Dir.chdir project_dir
+        end
+
+        Dir.mkdir(output_dir) if output_dir && FileTest.exist?(output_dir) == false
+
+        metdata_flags = metadata.empty? ? '' : metadata.map{|md| %|--metadata #{md}|}.join(' ')
+        cmd =
+          %|sf project generate manifest %{metdata} %{output_dir} %{api_version} %{from_org} %{source_dir}| %
+            {
+              metdata: metdata_flags,
+              output_dir:   flag(:"output-dir", output_dir),
+              api_version:  flag(:"api-version", api_version),
+              from_org:     flag(:"from-org", from_org),
+              source_dir:   flag(:"source-dir", source_dir),
+            }
+        `#{cmd} #{null_stderr_redirection}`
+
+        raise StandardError.new(%|command 'sf project generate manifest' failed.|) unless $?.success?
+      ensure 
+        Dir.chdir base_dir
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/sobject.rb

@@ -0,0 +1,36 @@
+require 'json'
+require_relative './base'
+
+module SfCli
+  class Sf
+    # ==== description
+    # The class representing *sf* *sobject*
+    #
+    # command reference: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_sobject_commands_unified.htm
+    #
+    class SObject < Base
+
+      # get the schema information of a Salesforce object and returns a hash object. It's equivalent to use *sf* *sobject* *describe*
+      #
+      # *objectType* --- object type (ex: Account)
+      #
+      def describe(objectType)
+        json = JSON.parse `sf sobject describe --json --sobject #{objectType} #{flag :"target-org", target_org}  #{null_stderr_redirection}`
+        raise StandardError.new(%|sf sobject describe: failed. (sobject: #{objectType})|) if json['status'] != 0
+
+        json['result']
+      end
+
+      # returns a list of Salesforce object name (object's API name). It's equivalent to *sf* *sobject* *list*
+      #
+      # *object_type* --- all or custom (default: all)
+      #
+      def list(object_type: 'all')
+        json = JSON.parse `sf sobject list --json --sobject #{object_type} #{flag :"target-org", target_org} #{null_stderr_redirection}`
+        raise StandardError.new(%|sf sobject list: failed.|) if json['status'] != 0
+
+        json['result']
+      end
+    end
+  end
+end

data/lib/sf_cli/sf.rb

@@ -0,0 +1,33 @@
+require_relative './sf/operations'
+
+module SfCli
+  # ==== description
+  # The main object class of *sf* command.
+  #
+  #
+  # https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_unified.htm
+  #
+  # ==== examples
+  #  sf = SfCli::Sf.new                     # use default org
+  #  sf = SfCli::Sf.new target_org: 'hoge'  # use an alias "hoge" as target org
+  #
+  #  # get the org connection infomation, which is equivalent to the result of 'sf org display'
+  #  sf.org.display 
+  #
+  #  # get Account records (equivalent to 'sf data query')
+  #  sf.data.query 'SELECT Id, Name FROM Account LIMIT 3' # => returns an array containing 3 records
+  #
+  class Sf
+    attr_reader :target_org, :org, :data, :sobject, :project
+
+    #
+    # *\target_org* --- an org alias name, which is used for sf command operations (default is nil). If it is nil, the command uses the default org.
+    #
+    def initialize(target_org: nil)
+      @org = Org.new(target_org)
+      @data = Data.new(target_org)
+      @sobject = SObject.new(target_org)
+      @project = Project.new
+    end
+  end
+end

data/lib/sf_cli.rb

@@ -0,0 +1 @@
+require 'sf_cli/sf'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: sf_cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takanobu Maekawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-17 00:00:00.000000000 Z
+dependencies: []
+description: A thin wrapper classes representing salesforce CLI. Currenty only sf
+  command is implemented, but not all functions are supported.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sf_cli.rb
+- lib/sf_cli/helper_methods.rb
+- lib/sf_cli/sf.rb
+- lib/sf_cli/sf/base.rb
+- lib/sf_cli/sf/data.rb
+- lib/sf_cli/sf/operations.rb
+- lib/sf_cli/sf/org.rb
+- lib/sf_cli/sf/project.rb
+- lib/sf_cli/sf/sobject.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key: 
+specification_version: 4
+summary: A wrapper class library for Salesforce CLI
+test_files: []