sf_cli 0.0.4 → 0.0.6

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

@@ -0,0 +1,36 @@
+module SfCli
+  module Sf
+    module Model
+      module DmlMethods
+        def self.included(c)
+          c.extend ClassMethods
+        end
+
+        def save
+          if new_record?
+            self.Id = self.class.connection.create(self.class.name.to_sym, current_attributes.reject{|_,v| v.nil?})
+          else
+            self.class.connection.update(self.class.name.to_sym, self.Id, updated_attributes.reject{|_,v| v.nil?})
+          end
+
+          @original_attributes = current_attributes.dup
+          @updated_attributes = {}
+
+          self.Id
+        end
+
+        def delete
+          return if self.Id.nil?
+
+          self.class.connection.delete(self.class.name.to_sym, self.Id)
+        end
+
+        module ClassMethods
+          def create(values = {})
+            connection.create(name.to_sym, values, Object.const_get(name.to_sym))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,25 +1,26 @@
-require_relative '../sobject/core'
 require_relative './class_definition'
 
 module SfCli
   module Sf
     module Model
       class Generator
-        attr_reader :sf_sobject, :target_org
+        attr_reader :sf_sobject, :connection
 
-        def initialize(target_org: nil)
-          @sf_sobject = ::SfCli::Sf::Sobject::Core.new
-          @target_org = target_org
+        def initialize(connection)
+          @connection = connection
         end
 
         def generate(object_name)
-          class_definition = ClassDefinition.new(describe object_name)
+          schema = describe(object_name)
+          class_definition = ClassDefinition.new(schema)
 
           instance_eval "::#{object_name} = #{class_definition}"
+          klass = Object.const_get object_name.to_sym
+          klass.connection = connection
         end
 
         def describe(object_name)
-          sf_sobject.describe object_name, target_org: target_org
+          connection.describe object_name
         end
       end
     end

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

@@ -0,0 +1,136 @@
+require 'date'
+
+module SfCli
+  module Sf
+    module Model
+      module QueryMethods
+        class QueryCondition
+          attr_reader :connection, :object_name, :all_field_names, :fields, :conditions, :limit_num, :row_order
+
+          def initialize(connection, object_name, field_names)
+            @object_name = object_name
+            @all_field_names = field_names 
+            @connection = connection
+            @fields = []
+            @conditions = [] 
+            @limit_num = nil
+            @row_order = nil
+          end
+
+          def where(*expr)
+            return self if expr&.empty?
+            return self if expr.map{|o| (o == '' || o == {} || o == []) ? nil : o}.compact.size.zero?
+            return self unless [Hash, Symbol, String].any?{|klass| expr.first.instance_of? klass}
+
+            if expr.size > 1
+              return self if expr.size < 3
+
+              value = case expr[2].class.name.to_sym
+                      when :String
+                        %|'#{expr[2]}'|
+                      when :Time
+                        expr[2].to_datetime
+                      when :Array
+                        candidates = expr[2].map do |o|
+                            case o.class.name.to_sym
+                            when :String
+                              %|'#{o}'|
+                            when :Time
+                              o.to_datetime
+                            else
+                              o
+                            end
+                          end
+                        %|IN (#{candidates.join(', ')})|
+                      else
+                        expr[2]
+                      end
+              conditions << %|#{expr[0]} #{expr[1]} #{value}|
+
+              return self
+            end
+
+            if expr[0].instance_of? String
+              conditions << expr[0]
+              return self
+            end
+
+            new_conditions =
+              expr[0].map do |k,v| 
+                case v.class.name.to_sym
+                when :String
+                  %|#{k} = '#{v}'|
+                when :Time
+                  %|#{k} = #{v.to_datetime}|
+                when :Array
+                  candidates = v.map do |o|
+                      case o.class.name.to_sym
+                      when :String
+                        %|'#{o}'|
+                      when :Time
+                        %|#{o.to_datetime}|
+                      else
+                        o
+                      end
+                    end
+                  %|#{k} IN (#{candidates.join(', ')})|
+                else
+                  "#{k} = #{v}"
+                end
+              end
+            conditions.append new_conditions
+            return self
+          end
+
+          def select(*expr)
+            return self if expr&.empty?
+
+            if expr.size > 1
+              @fields = self.fields + expr
+            else
+              self.fields << expr.first
+            end
+            return self
+          end
+
+          def limit(num)
+            @limit_num = num
+            return self
+          end
+
+          def order(*fields)
+            return self if fields&.empty?
+
+            @row_order = fields
+            return self
+          end
+
+          def to_soql
+            base   = 'SELECT %{select} FROM %{object}' % {select: select_fields, object: object_name}
+            where  = conditions.size.zero?  ? nil : 'WHERE %{where}'    % {where: conditions.flatten.join(' AND ')}
+            _order = row_order.nil?         ? nil : 'ORDER BY %{order}' % {order: row_order.join(', ')}
+            limit  = limit_num.nil?         ? nil : 'LIMIT %{limit}'    % {limit: limit_num} 
+
+            [base, where, _order, limit].compact.join(' ')
+          end
+
+          def all
+            connection.query(to_soql, Object.const_get(object_name.to_sym))
+          end
+
+          def pluck(field_name)
+            all.map{|record| record.__send__(field_name.to_sym)}
+          end
+
+          def take
+            all.first
+          end
+
+          def select_fields
+            (fields.empty? ? all_field_names : fields).join(', ')
+          end 
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require_relative './query_condition'
+
+module SfCli
+  module Sf
+    module Model
+      module QueryMethods
+        def self.included(c)
+          c.extend ClassMethods
+        end
+
+        module ClassMethods
+          def where(*expr)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.where(*expr)
+            return qc
+          end
+
+          def select(*fields)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.select(*fields)
+            return qc
+          end
+
+          def find(id)
+            connection.find(name.to_sym, id, Object.const_get(name.to_sym))
+          end
+
+          def limit(num)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.limit(num)
+            qc
+          end
+
+          def order(*field_names)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.order(*field_names)
+            qc
+          end
+
+          def all
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.all
+          end
+
+          def pluck(field_name)
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.pluck(field_name)
+          end
+
+          def take
+            qc = QueryCondition.new(connection, self.name, self.field_names)
+            qc.take
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require_relative '../sobject/core'
+require_relative '../data/core'
+require_relative '../org/core'
+
+module SfCli
+  module Sf
+    module Model
+      class SfCommandConnection
+        attr_reader :sf_data, :sf_org, :sf_sobject, :target_org, :instance_url
+
+        def initialize(target_org: nil, instance_url: nil)
+          @sf_org = ::SfCli::Sf::Org::Core.new
+          @sf_data = ::SfCli::Sf::Data::Core.new
+          @sf_sobject = ::SfCli::Sf::Sobject::Core.new
+          @target_org = target_org
+          @instance_url = instance_url
+        end
+
+        def open
+          if ENV['SF_ACCESS_TOKEN']
+            sf_org.login_access_token target_org: target_org, instance_url: instance_url
+          else
+            sf_org.login_web target_org: target_org, instance_url: instance_url
+          end
+        end
+
+        def find(object_type, id, klass)
+          sf_data.get_record object_type, record_id: id, target_org: target_org, model_class: klass
+        end
+
+        def create(object_type, values, klass = nil)
+          id = sf_data.create_record object_type, values: values, target_org: target_org
+          return id if klass.nil?
+
+          find(object_type, id, klass)
+        end
+
+        def update(object_type, id, values)
+          sf_data.update_record object_type, record_id: id, where: nil, values: values, target_org: target_org
+        end
+
+        def delete(object_type, id)
+          sf_data.delete_record object_type, record_id: id, where: nil, target_org: target_org
+        end
+
+        def query(soql, klass)
+          sf_data.query soql, target_org: target_org, model_class: klass
+        end
+
+        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)
+        end
+
+        def describe(object_type)
+          sf_sobject.describe(object_type, target_org: target_org)
+        end
+      end
+    end
+  end
+end

data/lib/sf_cli/sf/model.rb

@@ -9,8 +9,16 @@ module SfCli
     # see the section {"Object Model support"}[link://files/README_rdoc.html#label-Object+Model+support+-28experimental-2C+since+0.0.4-29] in README.
     #
     module Model
-      def self.generate(object_names, target_org: nil)
-        generator = Generator.new(target_org: target_org)
+      def self.connection
+        @@connection
+      end
+
+      def self.set_connection(conn)
+        @@connection = conn
+      end
+
+      def self.generate(object_names)
+        generator = Generator.new(connection)
 
         object_names.each do |object_name|
           generator.generate(object_name)

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

@@ -1,4 +1,7 @@
 require_relative '../core/base'
+require_relative './login'
+require_relative './display'
+require_relative './list'
 
 module SfCli
   module Sf
@@ -11,50 +14,9 @@ module SfCli
       #
       class Core
         include ::SfCli::Sf::Core::Base
-
-        ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
-
-        # login to the org by the browser. (equivalent to *sf* *org* *login* *web*)
-        #
-        # *target_org* --- an alias of paticular org, not default one<br>
-        # *instance_url* --- custom login url.
-        #
-        # == examples:
-        #   sf.org.login_web
-        #   sf.org.login_web target_org: :dev  # if the org you login isn't the default one, you should give it alias name for later use.
-        #
-        # 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)
-          flags    = {
-            :"alias"        => target_org,
-            :"instance-url" => instance_url,
-          }
-          action = __method__.to_s.tr('_', ' ')
-          exec(action, flags: flags)
-        end
-
-        #
-        # returns the org's connection information. (equivalent to *sf* *org* *display*)
-        #
-        # *target_org* --- an alias of paticular org, not default one<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_org_commands_unified.htm#cli_reference_org_display_unified]
-        #
-        def display(target_org: nil)
-          flags    = {:"target-org" => target_org}
-          json = exec(__method__, flags: flags, redirection: :null_stderr)
-
-          ConnectionInfo.new(
-            id:           json['result']['id'],
-            access_token: json['result']['accessToken'],
-            alias:        json['result']['alias'],
-            instance_url: json['result']['instanceUrl'],
-            user_name:    json['result']['username'],
-            api_version:  json['result']['apiVersion'],
-            status:       json['result']['connectedStatus']
-          )
-        end
+        include Login
+        include Display
+        include List
       end
     end
   end

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

@@ -0,0 +1,41 @@
+module SfCli::Sf::Org
+  module Display
+    ConnectionInfo = Struct.new(:id, :access_token, :alias, :instance_url, :user_name, :api_version, :status)
+
+    #
+    # returns the org's connection information. (equivalent to *sf* *org* *display*)
+    #
+    # *target_org* --- an alias of paticular org, or username can be used<br>
+    #
+    # ======
+    #  # example (in irb):
+    #
+    #  > sf.org.display
+    #  =>
+    #  #<struct SfCli::Sf::Org::Display::ConnectionInfo
+    #   id="00D5j00000DiuxmEAB",
+    #   access_token="<some access token>",
+    #   alias="dev",
+    #   instance_url="https://hoge-bar-baz.abc.my.salesforce.com.example",
+    #   user_name="user@example.sandbox",
+    #   api_version="61.0",
+    #   status="Connected">
+    #
+    # 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_display_unified]
+    #
+    def display(target_org: nil)
+      flags    = {:"target-org" => target_org}
+      json = exec(__method__, flags: flags, redirection: :null_stderr)
+
+      ConnectionInfo.new(
+        id:           json['result']['id'],
+        access_token: json['result']['accessToken'],
+        alias:        json['result']['alias'],
+        instance_url: json['result']['instanceUrl'],
+        user_name:    json['result']['username'],
+        api_version:  json['result']['apiVersion'],
+        status:       json['result']['connectedStatus']
+      )
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module SfCli::Sf::Org
+  module List
+    OrgConfig = Struct.new( :accessToken, :instanceUrl, :orgId, :username, :loginUrl,
+      :clientId, :isDevHub, :instanceApiVersion, :instanceApiVersionLastRetrieved, :name,
+      :instanceName, :namespacePrefix, :isSandbox, :isScratch, :trailExpirationDate, :tracksSource,
+      :alias, :isDefaultDevHubUsername, :isDefaultUsername, :lastUsed, :connectedStatus) do
+      def devhub?
+        isDevHub
+      end
+
+      def sandbox?
+        isSandbox
+      end
+
+      def scratch?
+        isScratch
+      end
+
+      def default?
+        isDefaultUsername
+      end
+
+      def default_devhub?
+        isDefaultDevHubUsername
+      end
+
+      def connected?
+        connectedStatus == 'Connected'
+      end
+    end
+
+    # \List orgs you’ve created or authenticated to
+    #
+    # ======
+    #   org_config_list = sf.org.list # returns a list of OrgConfig
+    #
+    # \OrgConfig object has a org information including security sensitive things such as access token, username and so on.
+    #
+    # It also has some methods to identify its org type:
+    # - devhub?
+    # - sandbox?
+    # - scratch?
+    # - default?
+    # - default_devhub?
+    #
+    # and you can check the org connected like this:
+    #   org_config_list = sf.org.list # returns a list of OrgConfig
+    #   org_config.first.conncected?
+    #
+    # 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_list_unified]
+    #
+    def list
+      flags = {
+        # reserved for later option addition
+      }
+      json = exec(__method__, flags: flags, redirection: :null_stderr)
+
+      others = json['result']['other'].map{|config| OrgConfig.new(**config)}
+      sandboxes = json['result']['sandboxes'].map{|config| OrgConfig.new(**config)}
+      non_scratch_orgs = json['result']['nonScratchOrgs'].map{|config| OrgConfig.new(**config)}
+      devhubs = json['result']['devHubs'].map{|config| OrgConfig.new(**config)}
+      scratch_orgs = json['result']['scratchOrgs'].map{|config| OrgConfig.new(**config)}
+      
+      (others + sandboxes + non_scratch_orgs + devhubs + scratch_orgs).uniq{|config| config.alias}
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require_relative '../core/base'
+require_relative './schema'
 
 module SfCli
   module Sf
@@ -11,10 +12,18 @@ 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 schema 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>
+        #
+        # ======
+        #   schema = sf.sobject.describe :Account
+        #   schema.name  # Account
+        #   schema.label # Account
+        #   schema.field_names # [:Id, :Name, ....]
+        #   schema.fields[:Name] # => {"aggregatable"=>true, "aiPredictionField"=>false, "autoNumber"=>false,...}
         #
         # 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]
         #
@@ -24,13 +33,14 @@ module SfCli
             :"target-org" => target_org,
           }
           json = exec(__method__, flags: flags, redirection: :null_stderr)
-          json['result']
+          Schema.new(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]
         #