gitlab_support_readiness 1.0.37 → 1.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e459cc3f2cb6630193b9782e6d9b679e8cbd9f1700682f52de8345e9a3f4e970
-  data.tar.gz: 17d46a1beaa0fd0fe550616d8a607b82e298dfa4581f6aaa89dedcfac7d0f373
+  metadata.gz: 435ea0c0bf835de3187a51cba503c25d3a01a33e8654506833beb99ce303861d
+  data.tar.gz: 7f0d93630710b1bbc2d3280f917c8272d117101763f5c3ab1b599c3c175f6df1
 SHA512:
-  metadata.gz: 660521337677a451df9fdefe8a74e10161bf2ab3c7cbb0c0ba3ddf7b5c82c499d6fecdc679bd79f2c129ed9ae374281bcf299e79de88b0e3b6093df67ed0b49e
-  data.tar.gz: 14d7ef1485caf2c3f10cc16f1a7015cbb29000bcab4e39691a0796639b86e1243e4c1939012bd3651745172e760e4652c2eb808d49dd475cf13f6e72fa0ff231
+  metadata.gz: f3684cc0b6d09eab8203aca9729260e36f6174dcf9d297eea5e3ce1458f23db053ffba3c9ee93a4bd362ce7e22708e669f49050b93e57a8f7a9b28da49fd1402
+  data.tar.gz: 7189ae491dc391e9da253428f3e2b6d559269297dc6f451db6ec1d380d8697be746ec9e692702f7c0c5c51d4649dfda154e9a3e59058362117a87cb538dd34a6

data/lib/support_readiness/google_sheets/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleSheets
+  module GoogleSheets
+    ##
+    # Defines the class Client within the module {Readiness::GoogleSheets}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.39
+    class Client
+      attr_accessor :spreadsheet_id, :service
+
+      ##
+      # Creates a new {Readiness::GoogleSheets::Client} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param config [Object] An instance of {Readiness::GoogleSheets::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   pp client.spreadsheet_id
+      #   # => "abc123"
+      def initialize(config = Readiness::GoogleSheets::Configuration.new)
+        @service = generate_service(config)
+        @spreadsheet_id = config.spreadsheet_id
+      end
+
+      ##
+      # Generates a service connection to Google Calendar
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param config [Object] An instance of {Readiness::GoogleSheets::Configuration}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   service = Readiness::GoogleSheets::Client.generate_service(config)
+      def generate_service(config)
+        authorize = Google::Auth::ServiceAccountCredentials.make_creds(
+          json_key_io: File.open(config.filepath),
+          scope: config.scope
+        )
+        authorize.fetch_access_token!
+        service = Google::Apis::SheetsV4::SheetsService.new
+        service.authorization = authorize
+        service
+      end
+    end
+  end
+end

data/lib/support_readiness/google_sheets/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleSheets
+  module GoogleSheets
+    ##
+    # Defines the class Configuration within the module {Readiness::GoogleCalendar}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.39
+    class Configuration
+      attr_accessor :spreadsheet_id, :filepath, :scope
+
+      ##
+      # Creates a new {Readiness::GoogleSheets::Configuration} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   pp config
+      #   # => #<Readiness::GoogleSheets::Configuration:0x00007f352fdd1420
+      #          @spreadsheet_id="abc123"
+      #          @filepath="data/config.json"
+      #          @scope="https://www.googleapis.com/auth/spreadsheets">
+      def initialize
+        # /home/jason/dev/gitlab-support-readiness/zendesk-us-government/tickets/round-robin/lib/round_robin
+        @spreadsheet_id = ''
+        @filepath = ''
+        @scope = 'https://www.googleapis.com/auth/spreadsheets'
+      end
+    end
+  end
+end

data/lib/support_readiness/google_sheets/spreadsheets.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleSheets
+  module GoogleSheets
+    ##
+    # Defines the class Spreadsheets within the module {Readiness::GoogleSheets}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.39
+    class Spreadsheets < Readiness::Client
+      ##
+      # Gets spreadsheet information
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param client [Object] An instance of {Readiness::GoogleSheets::Client}
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   spreadsheet = Readiness::GoogleSheets::Spreadsheets.get_info(client)
+      #   pp spreadsheet.properties.title
+      #   # => "Jason Test"
+      def self.get_info(client)
+        client.service.get_spreadsheet(client.spreadsheet_id)
+      end
+
+      ##
+      # Gets a list of spreadsheet sheets
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param spreadsheet [Object] The spreadsheet to use
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   spreadsheet = Readiness::GoogleSheets::Spreadsheets.get_info(client)
+      #   pp Readiness::GoogleSheets::Spreadsheets.sheets(spreadsheet)
+      #   # => ["Sheet1", "Sheet2"]
+      def self.sheets(spreadsheet)
+        spreadsheet.sheets.map { |s| s.properties.title }
+      end
+
+      ##
+      # Gets data within a spreadsheet
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param client [Object] An instance of {Readiness::GoogleSheets::Client}
+      # @param range [String] A Google Sheets range
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   data = Readiness::GoogleSheets::Spreadsheets.data(client, 'A1:A3')
+      #   pp data.values.first
+      #   # => ["Test 1", "Test 2"]
+      def self.data(client, range)
+        client.service.get_spreadsheet_values(client.spreadsheet_id, range)
+      end
+
+      ##
+      # Appends data to a spreadsheet
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param client [Object] An instance of {Readiness::GoogleSheets::Client}
+      # @param range [String] A Google Sheets range
+      # @param values[Array] An Array of Arrays for the values to use
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   values = [
+      #     ['Tickets 2024-10', 125],
+      #     ['Agents 2024-10', 150],
+      #     ['SSAT 2024-10', '95%']
+      #   ]
+      #   Readiness::GoogleSheets::Spreadsheets.append_data(client, 'Ticket Data!A1:A3', values)
+      def self.append_data(client, range, values)
+        value_range = Google::Apis::SheetsV4::ValueRange.new(values: values)
+        client.service.append_spreadsheet_value(client.spreadsheet_id, range, value_range, value_input_option: 'RAW')
+      end
+
+      ##
+      # Updates data in a spreadsheet
+      #
+      # @author Jason Colyer
+      # @since 1.0.39
+      # @param client [Object] An instance of {Readiness::GoogleSheets::Client}
+      # @param range [String] A Google Sheets range
+      # @param values[Array] An Array of Arrays for the values to use
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GoogleSheets::Configuration.new
+      #   config.spreadsheet_id = 'abc123'
+      #   config.filepath = 'data/config.json'
+      #   client = Readiness::GoogleSheets::Client.new(config)
+      #   values = [
+      #     ['Tickets 2024-10', 125],
+      #     ['Agents 2024-10', 150],
+      #     ['SSAT 2024-10', '95%']
+      #   ]
+      #   Readiness::GoogleSheets::Spreadsheets.update_data(client, 'Ticket Data!A1:A3', values)
+      def self.update_data(client, range, values)
+        value_range = Google::Apis::SheetsV4::ValueRange.new(values: values)
+        client.service.update_spreadsheet_value(client.spreadsheet_id, range, value_range, value_input_option: 'RAW')
+      end
+    end
+  end
+end

data/lib/support_readiness/google_sheets.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module GoogleSheets
+  # @author Jason Colyer
+  # @since 1.0.39
+  module GoogleSheets
+    require "#{__dir__}/google_sheets/client"
+    require "#{__dir__}/google_sheets/configuration"
+    require "#{__dir__}/google_sheets/spreadsheets"
+  end
+end

data/lib/support_readiness/repos/ticket_fields.rb

@@ -52,8 +52,8 @@ module Readiness
             repo.custom_field_options.map! { |o| Zendesk::TicketFieldOptions.new(o) } unless repo.custom_field_options.first.is_a? Object
             repo.custom_field_options.each do |repo_option|
               repo_option.position = repo.custom_field_options.index(repo_option) if repo_option.position.nil?
-              zd_option = zd_options.detect { |zd_o| zd_o.name == repo_option.name }
-              if zd_option.nil? || to_clean_json(zd_option) != to_clean_json(repo_option)
+              zd_option = zd.custom_field_options.detect { |zd_o| zd_o.value == repo_option.value }
+              if zd_option.nil? || option_difference?(zd_option, repo_option)
                 @diffs[:option_updates].push({ "#{repo.title}" => repo_option })
               end
             end
@@ -69,6 +69,22 @@ module Readiness
         @diffs
       end
 
+      ##
+      # Deterine if there is a difference between the repo ticket field options to the Zendesk instance ticket field options
+      #
+      # @author Jason Colyer
+      # @since 1.0.38
+      # @param zd_option [Object] An instance of {Readiness::Zendesk::TicketFieldOptions}
+      # @param repo_option [Object] An instance of {Readiness::Zendesk::TicketFieldOptions}
+      # @return [Boolean]
+      def self.option_difference?(zd_option, repo_option)
+        return true if zd_option.name != repo_option.name
+        return true if zd_option.position != repo_option.position
+        return true if zd_option.value != repo_option.value
+
+        false
+      end
+
       ##
       # Outputs a comparison report
       #

data/lib/support_readiness.rb

@@ -18,6 +18,7 @@ require 'faraday'
 require 'faraday/multipart'
 require 'faraday/retry'
 require 'google/apis/calendar_v3'
+require 'google/apis/sheets_v4'
 require 'json'
 require 'nokogiri'
 require 'oj'
@@ -34,6 +35,7 @@ require "#{__dir__}/support_readiness/calendly"
 require "#{__dir__}/support_readiness/dates"
 require "#{__dir__}/support_readiness/gitlab"
 require "#{__dir__}/support_readiness/google_calendar"
+require "#{__dir__}/support_readiness/google_sheets"
 require "#{__dir__}/support_readiness/mailgun"
 require "#{__dir__}/support_readiness/pagerduty"
 require "#{__dir__}/support_readiness/redis"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.37
+  version: 1.0.39
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: digest
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.43.0
+- !ruby/object:Gem::Dependency
+  name: google-apis-sheets_v4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +272,10 @@ files:
 - lib/support_readiness/google_calendar/client.rb
 - lib/support_readiness/google_calendar/configuration.rb
 - lib/support_readiness/google_calendar/events.rb
+- lib/support_readiness/google_sheets.rb
+- lib/support_readiness/google_sheets/client.rb
+- lib/support_readiness/google_sheets/configuration.rb
+- lib/support_readiness/google_sheets/spreadsheets.rb
 - lib/support_readiness/mailgun.rb
 - lib/support_readiness/mailgun/bounces.rb
 - lib/support_readiness/mailgun/client.rb