rvgp 0.3.2

data/lib/rvgp/plot/google-drive/output_google_sheets.rb

@@ -0,0 +1,434 @@
+# frozen_string_literal: true
+
+require 'psych'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'google/apis/sheets_v4'
+
+module RVGP
+  class Plot
+    # This module contains the classes which support our 'Publish to Google' features.
+    module GoogleDrive
+      # This class works as a driver, to the plot subsystem. And, exports plots too a
+      # google sheets document.
+      #
+      # Here's the guide I used, to generate the credentials:
+      #   https://medium.com/building-rigup/wrangling-google-services-in-ruby-5493e906c84f
+      #
+      # NOTE: The guide doesn't exactly say it, but, make sure that your oauth client ID
+      #       is of type 'Web Application'. That will ensure that you're able to provide
+      #       a redirect URI, and use the playground...
+      #
+      # You'll want to write these credentials, in the following files:
+      #
+      # **config/google-secrets.yml**
+      # ```
+      # client_id: ""
+      # project_id: "ruby-rake-accounting"
+      # client_secret: ""
+      # token_path: "google-token.yml"
+      # application_name: "rvgp"
+      # ```
+      #
+      # **config/google-token.yml**
+      # ```
+      # ---
+      # default: '{"client_id":"","access_token":"","refresh_token":"","scope":["https://www.googleapis.com/auth/spreadsheets"],"expiration_time_millis":1682524731000}'
+      # ```
+      #
+      # The empty values in these files, should be populated with the values you secured
+      # following the medium link above. The only exception here, might be that refresh_token.
+      # Which, I think gets written by the googleauth library, automatically.
+      # @attr_reader [String] current_sheet_id The id of the most recently created sheet, as provided by Google
+      # @attr_reader [String] spreadsheet_url The url to this Sheet, which can be used to access the sheet, by the user.
+      class ExportSheets
+        # The required parameter, :secrets_file, wasn't supplied
+        class MissingSecretsFile < StandardError
+          # The error message we're outputing
+          MSG_FORMAT = 'Missing required parameter :secrets_file'
+
+          def initialize
+            super MSG_FORMAT
+          end
+        end
+
+        # The the contents of the :secrets_file, was missing one or more required parameters
+        class MissingSecretsParams < StandardError
+          # The error message we're outputing
+          MSG_FORMAT = 'Config file is missing one or more of the required parameters: ' \
+                       ':client_id, :project_id, :client_secret, :token_path, :application_name'
+
+          def initialize
+            super MSG_FORMAT
+          end
+        end
+
+        # This is just a shorthand we're using, to simply the sheets_v4 implementation
+        SV4 = Google::Apis::SheetsV4
+
+        # Dates are expected to be provided wrt to their relative offset from this date
+        LOTUS_EPOCH = Date.new 1899, 12, 30
+
+        # The coloring schemes, used by our sheets. This constant... needs some work
+        COLOR_SCHEMES = [
+          # Pink:  TODO : maybe remove this, or put into a palettes file/option
+          [233, 29, 99, 255, 255, 255, 253, 220, 232]
+        ].freeze
+
+        # Our OAuth base_url
+        OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+        attr_reader :current_sheet_id, :spreadsheet_url
+
+        # Create a Spreadsheet, in a Google Drive.
+        # @param [Hash] options The parameters governing this Spreadsheet
+        # @option options [String] :secrets_file The path to a yaml file, containing the secrets used to login to this
+        #                                        drive.
+        # @option options [String] :title The title of this spreadsheet
+        # @option options [TrueClass,FalseClass] :log_http_requests a flag to indicate whether we want to debug the http
+        #                                                           session involved in the creation of this spreadsheet
+        def initialize(options)
+          raise MissingSecretsFile unless options.key? :secrets_file
+
+          config = Psych.load File.read(options[:secrets_file]), symbolize_names: true
+
+          raise MissingSecretsParams unless %w[
+            client_id project_id client_secret token_path application_name
+          ].all? { |p| config.key? p.to_sym }
+
+          @spreadsheet_title = options[:title]
+          @service = SV4::SheetsService.new
+          @service.client_options.log_http_requests = true if options[:log_http_requests]
+          @client_id = Google::Auth::ClientId.from_hash(
+            'installed' => {
+              'client_id' => config[:client_id],
+              'project_id' => config[:project_id],
+              'client_secret' => config[:client_secret],
+              'auth_uri' => 'https://accounts.google.com/o/oauth2/auth',
+              'token_uri' => 'https://oauth2.googleapis.com/token',
+              'auth_provider_x509_cert_url' => 'https://www.googleapis.com/oauth2/v1/certs',
+              'redirect_uris' => ['urn:ietf:wg:oauth:2.0:oob', 'http://localhost']
+            }
+          )
+
+          @token_store = Google::Auth::Stores::FileTokenStore.new(
+            file: [File.dirname(options[:secrets_file]), config[:token_path]].join('/')
+          )
+          @application_name = config[:application_name]
+
+          @service.client_options.application_name = @application_name
+          @service.authorization = authorize
+
+          @current_sheet_id = nil
+          @now = Time.now
+        end
+
+        # Add the provided sheet, to the Spreadsheet document
+        # @param [RVGP::Plot::GoogleDrive::Sheet] sheet The options, and data, for this sheet
+        # @return [void]
+        def sheet(sheet)
+          raise StandardError, 'Too many columns...' if sheet.columns.length > 26
+          raise StandardError, 'No header...' if sheet.columns.empty?
+
+          # Create a sheet, or update the sheet 0 title:
+          if current_sheet_id.nil?
+            update_sheet_title! 0, sheet.title
+          else
+            add_sheet! sheet.title
+          end
+
+          # Now that we have a title and sheet id, we can insert the data:
+          update_spreadsheet_value! sheet.title, [sheet.columns] + sheet.rows
+
+          # Format the sheet:
+          batch_update_spreadsheet! [
+            # Set the Date column:
+            repeat_cell(
+              create_range(1, 0, sheet.rows.count + 1),
+              'userEnteredFormat.numberFormat',
+              { userEnteredFormat: { numberFormat: { type: 'DATE', pattern: 'mm/dd/yy' } } }
+            ),
+            # Set the Money columns:
+            repeat_cell(
+              create_range(1, 1, sheet.rows.count + 1, sheet.columns.count),
+              'userEnteredFormat.numberFormat',
+              { userEnteredFormat: { numberFormat: { type: 'CURRENCY', pattern: '"$"#,##0.00' } } }
+            ),
+            # Format the header row text:
+            repeat_cell(
+              create_range(0, 0, 1, sheet.columns.count),
+              'userEnteredFormat(textFormat,horizontalAlignment)',
+              { userEnteredFormat: { textFormat: { bold: true }, horizontalAlignment: 'CENTER' } }
+            ),
+            # Color-band the rows:
+            band_rows(sheet.rows.count + 1, sheet.columns.count),
+            # Resize the series columns:
+            update_column_width(1, sheet.columns.count, 70)
+          ], skip_serialization: true
+
+          # Add a chart!
+          add_chart! sheet
+        end
+
+        private
+
+        def authorize
+          authorizer = Google::Auth::UserAuthorizer.new(@client_id,
+                                                        Google::Apis::SheetsV4::AUTH_SPREADSHEETS,
+                                                        @token_store)
+          user_id = 'default'
+          credentials = authorizer.get_credentials user_id
+          if credentials.nil?
+            # I'm a little fuzzy on some of this, since it's been a while since I've
+            # used this path
+            url = authorizer.get_authorization_url base_url: OOB_URI
+            puts 'Open the following URL in the browser and enter the ' \
+                 "resulting code after authorization:\n" + url
+            code = gets
+            credentials = authorizer.get_and_store_credentials_from_code(
+              user_id: user_id, code: code, base_url: OOB_URI
+            )
+          end
+          credentials
+        end
+
+        def spreadsheet_title
+          @now.strftime @spreadsheet_title
+        end
+
+        # Create new spreadsheet object or return the existing one:
+        def spreadsheet_id
+          return @spreadsheet_id if @spreadsheet_id
+
+          response = @service.create_spreadsheet(
+            SV4::Spreadsheet.new(properties: { title: spreadsheet_title })
+          )
+
+          @spreadsheet_url = response.spreadsheet_url
+          @spreadsheet_id = response.spreadsheet_id
+          @current_sheet_id = response.sheets[0].properties.sheet_id
+
+          unless [@spreadsheet_id, @spreadsheet_url, @current_sheet_id].all?
+            raise StandardError, 'Unable to create spreadsheet'
+          end
+
+          @spreadsheet_id
+        end
+
+        def update_sheet_title!(sheet_id, title)
+          update_sheet_properties_request = SV4::UpdateSheetPropertiesRequest.new(
+            properties: { sheet_id: sheet_id, title: title }, fields: 'title'
+          )
+          request_body = SV4::BatchUpdateSpreadsheetRequest.new(
+            requests: [SV4::Request.new(
+              update_sheet_properties: update_sheet_properties_request
+            )]
+          )
+
+          response = @service.batch_update_spreadsheet spreadsheet_id, request_body
+
+          raise StandardError, 'Malformed response' unless spreadsheet_id == response.spreadsheet_id
+        end
+
+        def band_rows(row_count, col_count)
+          SV4::Request.new(
+            add_banding: SV4::AddBandingRequest.new(
+              banded_range: SV4::BandedRange.new(
+                range: create_range(0, 0, row_count, col_count),
+                row_properties: band_scheme(0)
+              )
+            )
+          )
+        end
+
+        def palettes_file_path
+          # This has about 151 color palettes at the time of writing...
+          File.expand_path format('%s/../color-palettes.yml', File.dirname(__FILE__))
+        end
+
+        def hex_to_rgb(hex)
+          colors = hex.scan(/[0-9a-f]{#{hex.length == 6 ? 2 : 1}}/i).map { |h| h.hex.to_f / 255 }
+          SV4::Color.new red: colors[0], green: colors[1], blue: colors[2]
+        end
+
+        def band_scheme(number)
+          hr, hg, hb, fr, fg, fb, sr, sg, sb = COLOR_SCHEMES[number]
+
+          SV4::BandingProperties.new(
+            header_color: SV4::Color.new(red: hr.to_f / 255, green: hg.to_f / 255, blue: hb.to_f / 255),
+            first_band_color: SV4::Color.new(red: fr.to_f / 255, green: fg.to_f / 255, blue: fb.to_f / 255),
+            second_band_color: SV4::Color.new(red: sr.to_f / 255, green: sg.to_f / 255, blue: sb.to_f / 255)
+          )
+        end
+
+        def add_sheet!(title)
+          request_body = SV4::BatchUpdateSpreadsheetRequest.new(
+            requests: [
+              SV4::Request.new(add_sheet: SV4::AddSheetRequest.new(properties: { title: title }))
+            ]
+          )
+
+          response = @service.batch_update_spreadsheet spreadsheet_id, request_body
+
+          raise StandardError, 'Invalid sheet index' unless [
+            response.replies[0].add_sheet.properties.title,
+            response.replies[0].add_sheet.properties.sheet_id,
+            response.replies[0].add_sheet.properties.title == title
+          ].all?
+
+          @current_sheet_id = response.replies[0].add_sheet.properties.sheet_id
+        end
+
+        def update_spreadsheet_value!(sheet_title, values)
+          range_name = [format('%<title>s!A1:%<col>s%<row>d',
+                               title: sheet_title,
+                               col: (values[0].length + 64).chr,
+                               row: values.count)]
+
+          # We do this because dates are a pita, and are easier to send as floats
+          values_transformed = values.map do |row|
+            row.map { |c| c.is_a?(Date) ? (c - LOTUS_EPOCH).to_f : c }
+          end
+
+          response = @service.update_spreadsheet_value(
+            spreadsheet_id,
+            range_name,
+            SV4::ValueRange.new(values: values_transformed),
+            value_input_option: 'RAW'
+          )
+
+          unless [(response.updated_cells == values_transformed.flatten.compact.count),
+                  (response.updated_rows == values_transformed.count),
+                  (response.updated_columns == values_transformed.max_by(&:length).length)].all?
+            raise StandardError, 'Not all cells were updated'
+          end
+        end
+
+        def create_range(start_row = 0, start_col = 0, end_row = nil, end_col = nil)
+          SV4::GridRange.new(
+            sheet_id: current_sheet_id,
+            start_row_index: start_row,
+            start_column_index: start_col,
+            end_row_index: end_row || (start_row + 1),
+            end_column_index: end_col || (start_col + 1)
+          )
+        end
+
+        def update_column_width(col_start, col_end, width)
+          SV4::Request.new(
+            update_dimension_properties: SV4::UpdateDimensionPropertiesRequest.new(
+              range: {
+                sheet_id: current_sheet_id,
+                dimension: 'COLUMNS',
+                start_index: col_start,
+                end_index: col_end
+              },
+              fields: 'pixelSize',
+              properties: SV4::DimensionProperties.new(pixel_size: width)
+            )
+          )
+        end
+
+        def repeat_cell(range, fields, cell)
+          { repeat_cell: { range: range, fields: fields, cell: cell } }
+        end
+
+        def batch_update_spreadsheet!(requests, skip_serialization: false)
+          # Seems like there a bug in the BatchUpdateSpreadsheetRequest::Reflection
+          # that is preventing the api from serializing the 'cell' key. I think that
+          # the word is a reserved word in the reflection api...
+          # Nonetheless, the manual approach works with skip_serialization enabled.
+          #
+          request_body = { requests: requests }
+
+          @service.batch_update_spreadsheet(
+            spreadsheet_id,
+            skip_serialization ? request_body.to_h.to_json : request_body,
+            options: { skip_serialization: skip_serialization }
+          )
+        end
+
+        def add_chart!(sheet)
+          stacked_type = nil
+
+          if sheet.options.key?(:google)
+            gparams = sheet.options[:google]
+
+            default_series_type = gparams[:default_series_type]
+            chart_type = gparams[:chart_type] ? gparams[:chart_type].to_s.upcase : nil
+            stacked_type = gparams[:stacked_type] if gparams[:stacked_type]
+
+            series_colors = gparams[:series_colors] ? gparams[:series_colors].transform_keys(&:to_s) : nil
+            series_types = gparams[:series_types] ? gparams[:series_types].transform_keys(&:to_s) : nil
+            series_line_styles = gparams[:series_line_styles].transform_keys(&:to_s) if gparams[:series_line_styles]
+            series_target_axis = gparams[:series_target_axis]
+          end
+
+          series = (1...sheet.columns.count).map do |i|
+            series_params = {
+              targetAxis: format('%s_AXIS', (series_target_axis || :left).to_s.upcase),
+              series: { sourceRange: { sources: [create_range(0, i, sheet.rows.count + 1, i + 1)] } }
+            }
+
+            if series_colors && sheet.columns[i]
+              color = series_colors[sheet.columns[i].to_sym]
+              series_params[:color] = hex_to_rgb(color) if color
+            end
+
+            if series_line_styles
+              style = series_line_styles[sheet.columns[i].to_sym]
+              series_params[:lineStyle] = SV4::LineStyle.new type: 'MEDIUM_DASHED' if style == 'dashed'
+            end
+
+            series_params[:type] = series_types[sheet.columns[i]] || default_series_type if series_types
+
+            series_params
+          end
+
+          request_body = [
+            { addChart: {
+              chart: {
+                position: { newSheet: true },
+                spec: {
+                  title: sheet.title,
+                  basicChart: {
+                    headerCount: 1,
+                    chartType: chart_type || 'LINE',
+                    legendPosition: 'RIGHT_LEGEND',
+                    stackedType: stacked_type,
+                    domains: [{
+                      domain: { sourceRange: { sources: [create_range(0, 0, sheet.rows.count + 1)] } }
+                    }],
+                    series: series
+                  }
+                }
+              }
+            } }
+          ]
+
+          response = batch_update_spreadsheet! request_body, skip_serialization: true
+
+          chart_sheet_id = response.replies[0].add_chart.chart.position.sheet_id
+
+          raise StandardError, 'Error Creating Chart'  unless chart_sheet_id
+
+          # Rename the new chart tab name to match the title:
+          request_body = SV4::BatchUpdateSpreadsheetRequest.new(
+            requests: [SV4::Request.new(
+              update_sheet_properties: SV4::UpdateSheetPropertiesRequest.new(
+                properties: SV4::SheetProperties.new(
+                  sheet_id: chart_sheet_id,
+                  title: format('%s (Chart)', sheet.title)
+                ),
+                fields: 'title'
+              )
+            )]
+          )
+          response = @service.batch_update_spreadsheet spreadsheet_id, request_body
+
+          raise StandardError, 'Malformed response' unless spreadsheet_id == response.spreadsheet_id
+        end
+      end
+    end
+  end
+end

data/lib/rvgp/plot/google-drive/sheet.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RVGP
+  class Plot
+    module GoogleDrive
+      # This class represents a csv-like matrix, that is to be sent to google, as a sheet
+      # in an exported workbook. There's not much logic here.
+      # @attr_reader [string] title The title of this sheet
+      # @attr_reader [Hash] options The options configured on this sheet
+      class Sheet
+        attr_accessor :title, :options
+
+        # This is the maximum number of columns that we support, in our sheets. This number is
+        # mostly here because Google stipulates this restriction
+        MAX_COLUMNS = 26
+
+        # A sheet, and its options.
+        # @param [String] title The title of this sheet
+        # @param [Array<Array<Object>>] grid The data contents of this sheet
+        # @param [Hash] options The parameters governing this Sheet
+        # @option options [String] :default_series_type This parameter is sent to google's addChart method. Expected
+        #                                               to be either "COLUMN" or "LINE".
+        # @option options [String] :chart_type ('LINE') This parameter determines the kind plot that is built. Expected
+        #                                      to be one of: "area", or "column_and_lines"
+        # @option options [String] :stacked_type This parameter is sent to google's addChart method. Expected
+        #                                        to be either "STACKED" or nil.
+        # @option options [Hash<String,String>] :series_colors A Hash, indexed under the name of a series, whose value
+        #                                                      is set to the intended html rgb color of that series.
+        # @option options [Hash<String,String>] :series_types A Hash, indexed under the name of a series, whose value is
+        #                                                     set to either "COLUMN" or "LINE". This setting allows you
+        #                                                     to override the :default_series_type, for a specific
+        #                                                     series.
+        # @option options [Hash<String,String>] :series_line_styles A Hash, indexed under the name of a series, whose
+        #                                                           value is set to either "dashed" or nil. This
+        #                                                           setting allows you to dash a series on the
+        #                                                           resulting plot.
+        # @option options [Symbol] :series_target_axis (:left) Either :bottom, :left, or :right. This parameter is sent
+        #                                              to google's addChart method, to determine the 'targetAxis' of the
+        #                                              plot.
+        def initialize(title, grid, options = {})
+          @title = title
+          @options = options
+          @grid = grid
+
+          # This is a Google constraint:
+          if columns.length > MAX_COLUMNS
+            raise StandardError, format('Too many columns. Max is %<max>d, provided %<provided>d.',
+                                        max: MAX_COLUMNS,
+                                        provided: columns.length)
+          end
+        end
+
+        # The column titles for this spreadsheet, as calculated from the provided data.
+        # @return [Array<Object>]
+        def columns
+          @grid[0]
+        end
+
+        # The rows values for this spreadsheet, as calculated from the provided data.
+        # @return [Array<Object>]
+        def rows
+          @grid[1...]
+        end
+      end
+    end
+  end
+end