spreadsheet_goodies 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ac665483c2a857085d25a1237cbab883b2b12c3
-  data.tar.gz: 01d5aeed49efd551611bfc80981258a9d4346dcf
+  metadata.gz: 1cb1da443d319f91e093023601d1688081db8344
+  data.tar.gz: 10d6c084df8ae3da6ba1a1322805750d52191a3d
 SHA512:
-  metadata.gz: f963fcdda1e06d423fdb49584e9d19e7b8507eb2a20bbebd0ca4716b01b6aef9134594819aede023b1dfd044cbb93e48209ef1e173f8a52e5b5bd0e281d0d0f7
-  data.tar.gz: 2c03a6bb43be7e8794ea8d03e8f7c23b4a226b16b6d777d1aff7309526a2467d077d7a2bee5e5463fdd8dea78750940d1948125dc2e91311d0113fe3d244ad37
+  metadata.gz: ec886820ca483030f181f1d82542660aa9f54a898f9d0c97478648937c7e4ea9f44cf5086a508efe4442acc4ed6f002b941e8c4f3680912fe77ee031f95a1078
+  data.tar.gz: 434ed1a593759e605e34f18f345245a78ea7c208c64f9f9a1f9dbdd3d1f719f093b6d638a3dfb15e47b206aaecfb3965da89e0ad37bdf8f969b7fa1529267fe9

data/README.md

@@ -1,11 +1,11 @@
 # SpreadsheetGoodies
 
-SpreadsheetGoodies is a collection of tools to help work with spreadsheets in 
-Excel and Google Spreadhseets formats. It relies heavily on other gems to make 
-the actual work of reading and writing to spreadsheet documents. It main 
+SpreadsheetGoodies is a collection of tools to help work with spreadsheets in
+Excel and Google Spreadhseets formats. It relies heavily on other gems to make
+the actual work of reading and writing to spreadsheet documents. It main
 features are:
 
-* Read a spreadseet as an array of arrays to allow aceessing its data without 
+* Read a spreadseet as an array of arrays to allow aceessing its data without
   using the original document
 * Access a row's elements using the column titles as keys"
 
@@ -28,24 +28,75 @@ Or install it yourself as:
 ## Usage
 
 Read a Google Spreadsheet:
-```
-spreadsheet_key = '1UC43X6aZwlWPCnn...', '~> 0'#, '~> 1.13.2'
-sheet = SpreadsheetGoodies::GoogleDriveWorksheet.new(spreadsheet_key, 'Relação Lojas').read_from_google_drive
+```ruby
+sheet = SpreadsheetGoodies::GoogleDrive.read_worksheet(
+  spreadsheet_key: '1UC43X6aZwlWPCnn...', # required,
+  worksheet_title: 'sheet1', # optional, first worksheet is loaded if not specified
+)
 ```
 
 Read an Excel workbook:
-```
-sheet = SpreadsheetGoodies::ExcelWorksheet.new('~/workbook.xlsx')
+```ruby
+sheet = SpreadsheetGoodies::Excel.read_worksheet(
+  file_pathname: '~/workbook.xlsx', # required,
+  worksheet_title_or_index: 'sheet1', # optional, first worksheet is loaded if not specified
+)
 ```
 
-Iterate over every data row (i.e., all but the header row) and print the value 
-of a column titled 'Total': 
-```
+Iterate over every data row (i.e., all but the header row) and print the value
+of a column titled 'Total':
+```ruby
 sheet.data_rows.each do |row|
   puts "#{row.row_number} -- #{row['Total']}"
 end
 ```
 
+Writing values to cells (only available for GoogleDrive adapter right now):
+```ruby
+row = sheet[0]
+row[0] = 'First cell'
+row[1] = 'Second cell'
+sheet.commit_writes! # changes are applied to real spreadsheet
+```
+
+## Logging in to Google Drive
+If you need to access a spreadsheet on Google Drive that is not publicly accessible,
+you are required to setup an authentication method. Currently, there are two available
+authentication methods.
+
+### OAuth2
+To setup OAuth2, first you must configure your Google client id and a client secret
+like the example below. If you don't have a client id yet, you must create a project
+and enable the GoogleDrive API at https://console.developers.google.com. Then you
+need to create a OAuth client id.
+```ruby
+SpreadsheetGoodies.configure do |config|
+  config.login_method = :oauth2
+  config.google_client_id = '1012345678904-fdks82jfhe8ojdks7285fj4pnqiejrnbt.apps.googleusercontent.com' # put your real client id here
+  config.client_secret = 'Aa-Ku8C-askjfAYKkdjf9ssnf' # put your real secret here
+end
+```
+
+Then run your code. You will be prompted to make the authorization process to obtain
+a refresh token:
+```
+1. Open this page:
+https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=1012345678904-fdks82jfhe8ojdks7285fj4pnqiejrnbt.apps.googleusercontent.com&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=code&scope=https://www.googleapis.com/auth/drive%20https://spreadsheets.google.com/feeds/
+
+2. Enter the authorization code shown in the page: 4/LADQHhpk7x27BMeP2tIEe_pKuTJmJmZhWoRcBhBmFTVRqSEtcap7Z6s
+
+Congratulations! Your refresh token is: 1/c9JDKAUF83_4SPqNc8ldQWe9TdXOxqXvMJJPtmDA2k
+Set the refresh_token in your SpreadsheetGoodies configuration and run your code again
+```
+
+### Service Accounts
+```ruby
+SpreadsheetGoodies.configure do |config|
+  config.login_method = :service_account
+  config.service_account_key_json = '...'
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ricardo-jasinski/spreadsheet_goodies.
@@ -54,4 +105,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/ricard
 ## License
 
 The gem is available as open source under the terms of the [Unlicense](http://unlicense.org/UNLICENSE).
-

data/lib/spreadsheet_goodies/abstract_base_worksheet.rb

@@ -0,0 +1,39 @@
+
+# Base class for all worksheets
+module SpreadsheetGoodies
+  class AbstractBaseWorksheet
+    attr_reader :rows, :header_row
+
+    def [](index)
+      @rows[index]
+    end
+
+    # Return only the rows that contain data (excludes the header rows)
+    def data_rows
+      @rows[@num_header_rows..-1]
+    end
+
+    # Finds and returns the first row that contains cell_value at the given column
+    def find_row_by_column_value(column_title, cell_value)
+      data_rows.each do |row|
+        return row if row[column_title] == cell_value
+      end
+
+      nil
+    end
+
+    # Writes to a given cell identified by row and column indexes (they start at 1)
+    # This method should be overriden by worksheets that wish to implement writes.
+    # Usually this method is not called directly by the gem user, but rather from
+    # the modified row itself
+    def write_to_cell(row_index, col_index, value)
+      raise 'writes are not implemented for this type of worksheet'
+    end
+
+    # Some adapters (like GoogleDrive) require writes to be committed to actually
+    # make the changes on the spreadsheet
+    def commit_writes!
+      raise 'this kind of worksheet does not require writes to be committed'
+    end
+  end
+end

data/lib/spreadsheet_goodies/excel/workbook_builder.rb

@@ -0,0 +1,80 @@
+require 'axlsx'
+
+# A set of methods to help create and format Excel workbooks
+module SpreadsheetGoodies::Excel
+  class WorkbookBuilder
+    attr_reader :current_sheet
+
+    def initialize(output_file_pathname)
+      @output_file_pathname = output_file_pathname
+      @axlsx_package = Axlsx::Package.new
+    end
+
+    # The underlying Axlsx::Workbook object
+    def workbook
+      @axlsx_package.workbook
+    end
+
+    def add_worksheet(sheet_name)
+      @current_sheet = @workbook.add_worksheet(name: sheet_name)
+      setup_current_sheet_styles
+      freeze_top_row
+      @current_sheet
+    end
+
+    # Add a row to the current sheet using the data row style
+    def add_data_row(row_values)
+      @current_sheet.add_row(row_values, style: @data_row_style)
+    end
+
+    # Add a row to the current sheet using the header row style
+    def add_header_row(row_values)
+      @current_sheet.add_row(row_values, style: @header_row_style)
+    end
+
+    # Add filter and sorting controls to a sheet.
+    def setup_auto_filter(sheet=nil)
+      worksheet = sheet || @current_sheet
+      top_left_cell_label = worksheet.dimension.first_cell_reference
+      bottom_right_cell_label = worksheet.dimension.last_cell_reference
+      filter_range = "#{top_left_cell_label}:#{bottom_right_cell_label}"
+      worksheet.auto_filter = filter_range
+    end
+
+    def write_to_file
+      @axlsx_package.serialize(@output_file_pathname)
+    end
+
+    def freeze_top_row
+      @current_sheet.sheet_view.pane do |pane|
+        pane.top_left_cell = 'A2'
+        pane.state = :frozen_split
+        pane.y_split = 1
+        pane.active_pane = :bottom_right
+      end
+    end
+
+  private
+
+    def setup_current_sheet_styles
+      @header_row_style = @current_sheet.styles.add_style(
+        alignment: {horizontal: :center, vertical: :center},
+        font_name: 'Calibri',
+        bg_color: 'FFDDDDDD',
+        b: true,
+      )
+
+      @header_row_sodexo_style = @current_sheet.styles.add_style(
+        alignment: {horizontal: :center, vertical: :center},
+        font_name: 'Calibri',
+        bg_color: '002060',
+        fg_color: 'FFFFFF',
+        b: true,
+      )
+
+      @data_row_style = @current_sheet.styles.add_style(
+        font_name: 'Calibri',
+      )
+    end
+  end
+end

data/lib/spreadsheet_goodies/excel/worksheet.rb

@@ -0,0 +1,53 @@
+require_relative '../abstract_base_worksheet'
+require_relative '../row'
+
+# A cached copy of an Excel worksheet (a single workbook "tab"), stored as an
+# array of arrays. Individual cells can be accessed by column title, e.g.:
+#   worksheet[0]['A column title']
+module SpreadsheetGoodies::Excel
+  class Worksheet < SpreadsheetGoodies::AbstractBaseWorksheet
+    attr_reader :workbook, :worksheet
+
+    # @param workbook_file_pathname [String] Full path and filename to Excel workbook document
+    # @param worksheet_title_or_index [String|Integer] Sheet name or index (zero-based)
+    #   within the workbook. Optional; if unspecified, the first sheet will be used.
+    # @param num_header_rows [Integer] Number of rows at the top of the sheet that
+    #   contain headers or stuff other than data. Optional; if unspecified, assumes
+    #   that a single top row contains the header and all rows below are data.
+    def initialize(workbook_file_pathname, worksheet_title_or_index=0, num_header_rows=1)
+      @worksheet_title = worksheet_title_or_index
+      @num_header_rows = num_header_rows
+
+      @workbook = case workbook_file_pathname.to_s
+      when /\.xls[^x]/ then Roo::Excel.new(workbook_file_pathname, file_warning: :ignore)
+      when /\.xlsx/ then Roo::Excelx.new(workbook_file_pathname, file_warning: :ignore)
+      end
+
+      @worksheet = @workbook.sheet(worksheet_title_or_index)
+
+      @header_row = @worksheet.row(num_header_rows)
+
+      # Reads all the worksheet rows, one at a time, using Workshete#row (note: reading
+      # them all at once using Worksheet#parse didn't work because the first row
+      # was missed some times.)
+      rows = (1..@worksheet.last_row).map {|row_number| @worksheet.row(row_number) }
+
+      # Create the rows cache, made of instances of ExcelWorksheetRow
+      @rows = rows.collect.with_index do |row, index|
+        SpreadsheetGoodies::Row.new(@header_row, index+1, self, *row)
+      end
+
+      self
+    end
+
+    def add_row(row_data)
+      last_row_number = @rows.count
+      @rows << SpreadsheetGoodies::Row.new(@header_row, last_row_number+1, self, *row_data)
+    end
+
+    def spreadsheet
+      @workbook
+    end
+
+  end
+end

data/lib/spreadsheet_goodies/excel.rb

@@ -0,0 +1,11 @@
+
+module SpreadsheetGoodies::Excel
+
+  def self.read_worksheet(file_pathname:, worksheet_title_or_index:0, num_header_rows:1)
+    Worksheet.new(file_pathname, worksheet_title_or_index, num_header_rows)
+  end
+
+end
+
+# loads all files in excel folder
+Dir[File.join(File.dirname(__FILE__), "excel/**/*.rb")].each { |f| require f }

data/lib/spreadsheet_goodies/google_drive/connector.rb

@@ -0,0 +1,104 @@
+require 'google_drive'
+require 'googleauth'
+
+module SpreadsheetGoodies::GoogleDrive
+  class Connector
+    attr_reader :logger, :session
+
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @session = log_into_google_drive
+      raise 'Session not found!' unless @session
+    end
+
+    # Reads a GoogleDrive::Spreadsheet object from Google Drive, using the
+    # google_drive gem. Documentation for this class can be found here:
+    # https://www.rubydoc.info/github/gimite/google-drive-ruby/GoogleDrive/Spreadsheet
+    def read_worksheet(spreadsheet_key, worksheet_title=nil)
+      puts "Reading sheet '#{worksheet_title}' from Google Drive..."
+      spreadsheet = @session.spreadsheet_by_key(spreadsheet_key)
+
+      if worksheet_title
+        worksheet = spreadsheet.worksheet_by_title(worksheet_title)
+        if worksheet.nil?
+          raise "Worksheet named '#{worksheet_title}' not found in spreadsheet."
+        end
+      else
+        worksheet = spreadsheet.worksheets.first
+      end
+
+      worksheet
+    end
+
+    def read_worksheet_as_string(spreadsheet_key, worksheet_title)
+      worksheet = read_worksheet(spreadsheet_key, worksheet_title)
+      contents = worksheet.export_as_string.force_encoding('utf-8')
+      puts 'Spreadsheet read successfully.'
+      contents
+    end
+
+  private
+
+    def log_into_google_drive
+      case SpreadsheetGoodies.configuration.login_method
+      when :service_account then log_into_google_drive_via_service_account
+      when :oauth2 then log_into_google_drive_via_oauth2
+      end
+    end
+
+    # Authenticate with Google Drive via OAuth2.
+    # Your OAuth2 ids can be accessed at https://console.developers.google.com/apis/credentials,
+    # logged with your Google account in your custom project. The keys are at
+    # 'API manager' > 'Credentials'. CLIENT_ID and CLIENT_SECRET are available
+    # from the credentials page. The REFRESH_TOKEN must be obtained uncommenting
+    # some rows from the method below and obtaining an access_token via a browser
+    # logged in to your google account.
+    def log_into_google_drive_via_oauth2
+      credentials = Google::Auth::UserRefreshCredentials.new(
+        client_id: SpreadsheetGoodies.configuration.google_client_id,
+        client_secret: SpreadsheetGoodies.configuration.client_secret,
+        scope: [
+          'https://www.googleapis.com/auth/drive',
+          'https://spreadsheets.google.com/feeds/',
+        ],
+        redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
+      )
+
+      # if has refresh_token, logs in
+      if SpreadsheetGoodies.configuration.refresh_token
+        credentials.refresh_token = SpreadsheetGoodies.configuration.refresh_token
+
+      # if refresh_token is missing, prompts user to obtain it
+      else
+        print("1. Open this page:\n%s\n\n" % credentials.authorization_uri)
+        print("2. Enter the authorization code shown in the page: ")
+        credentials.code = $stdin.gets.chomp
+        credentials.fetch_access_token!
+        print("\nCongratulations! Your refresh token is: #{credentials.refresh_token}\n")
+        print("Set the refresh_token in your SpreadsheetGoodies configuration and run your code again\n")
+        exit(0)
+      end
+
+      begin
+        credentials.fetch_access_token!
+      rescue Faraday::ConnectionFailed
+        logger.info 'Error logging into Google Drive. Is your internet connection down?'
+        exit
+      end
+
+      session = GoogleDrive::Session.from_credentials(credentials)
+    end
+
+    # Authenticate with Google Drive via a service account.
+    # Your service accounts can be accessed at https://console.developers.google.com/apis/credentials,
+    # logged with your Google account in your custom project.
+    # The service accounts are at 'IAM and administrator' > 'Service accounts'.
+    # The keys are at 'API manager' > 'Credentials'.
+    def log_into_google_drive_via_service_account
+      session = GoogleDrive::Session.from_service_account_key(
+        StringIO.new(SpreadsheetGoodies.configuration.service_account_key_json)
+      )
+      session
+    end
+  end
+end

data/lib/spreadsheet_goodies/google_drive/worksheet.rb

@@ -0,0 +1,68 @@
+require 'csv'
+require_relative '../abstract_base_worksheet'
+require_relative '../row'
+
+# A cached copy of a Google Spreadsheets worksheet (i.e., a single workbook "tab"),
+# Individual cells of a row can be accessed by column title.
+# Example:
+#   worksheet[0]['A column title']
+module SpreadsheetGoodies::GoogleDrive
+  class Worksheet < SpreadsheetGoodies::AbstractBaseWorksheet
+    # @param spreadsheet_key [String] Spreadsheet identifier, which can be retrieved
+    #   from the spreasheet's url
+    # @param worksheet_title_or_index [String] Sheet name; if unspecified, the
+    #   first sheet will be used.
+    # @param num_header_rows [Integer] Number of rows at the top of the sheet that
+    #   contain headers or stuff other than data. Optional; if unspecified, assumes
+    #   that a single top row contains the header and all rows below are data.
+    def initialize(spreadsheet_key, worksheet_title=nil, num_header_rows=1)
+      @spreadsheet_key = spreadsheet_key
+      @worksheet_title = worksheet_title
+      @num_header_rows = num_header_rows
+
+      read_from_google_drive
+    end
+
+    # Writes to a given cell identified by row and column indexes (they start at 1)
+    # @override
+    def write_to_cell(row_index, col_index, value)
+      underlying_adapter_worksheet[row_index, col_index] = value
+    end
+
+    # Commit writes so they are propagated to the real spreadsheet
+    # @override
+    def commit_writes!
+      underlying_adapter_worksheet.save
+    end
+
+  private
+
+    # Reads sheet contents and caches it into instance variables to so that it
+    # can be accessed later without accessing Google Drive.
+    def read_from_google_drive
+      worksheet_contents = underlying_adapter_worksheet.export_as_string.force_encoding('utf-8')
+
+      rows = CSV::parse(worksheet_contents)
+
+      if SpreadsheetGoodies.configuration.strip_values_on_read
+        rows = rows.map do |row|
+          row.map {|element| element.try(:strip) }
+        end
+      end
+
+      @header_row = rows[@num_header_rows-1]
+      @rows = rows.collect.with_index do |row, index|
+        SpreadsheetGoodies::Row.new(@header_row, index+1, self, *row)
+      end
+
+      self
+    end
+
+    # Reads a GoogleDrive::Spreadsheet object from Google Drive, using the
+    # google_drive gem. Documentation for this class can be found here:
+    # https://www.rubydoc.info/github/gimite/google-drive-ruby/GoogleDrive/Spreadsheet
+    def underlying_adapter_worksheet
+      @underlying_adapter_worksheet ||= Connector.new.read_worksheet(@spreadsheet_key, @worksheet_title)
+    end
+  end
+end

data/lib/spreadsheet_goodies/google_drive.rb

@@ -0,0 +1,12 @@
+
+module SpreadsheetGoodies::GoogleDrive
+
+  # Accesses GoogleDrive and returns a SpreadsheetGoodies::GoogleDrive::Worksheet
+  def self.read_worksheet(spreadsheet_key:, worksheet_title:nil, num_header_rows:1)
+    Worksheet.new(spreadsheet_key, worksheet_title, num_header_rows)
+  end
+
+end
+
+# loads all files in google_drive folder
+Dir[File.join(File.dirname(__FILE__), "google_drive/**/*.rb")].each { |f| require f }

data/lib/spreadsheet_goodies/row.rb

@@ -0,0 +1,33 @@
+module SpreadsheetGoodies
+
+
+  # Sobrecarrega método [] da Array para permitir acessar células passando
+  # o título da coluna como índice. Ex: row['Data formal do pedido']
+  class Row < Array
+    attr_reader :header_row, :row_number, :parent_worksheet
+
+    def initialize(header_row, sheet_row_number, parent_worksheet, *args)
+      @header_row = header_row
+      @row_number = sheet_row_number
+      @parent_worksheet = parent_worksheet
+      super(args)
+    end
+
+    def [](locator)
+      cell_index = (locator.is_a?(String) ? @header_row.index(locator) : locator)
+
+      # queries local cache only
+      super(cell_index)
+    end
+
+    def []=(locator, value)
+      cell_index = (locator.is_a?(String) ? @header_row.index(locator) : locator)
+
+      # propagates change to real worksheet
+      @parent_worksheet.write_to_cell(@row_number, cell_index+1, value)
+
+      # updates local cache
+      super(cell_index, value)
+    end
+  end
+end

data/lib/spreadsheet_goodies/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetGoodies
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/spreadsheet_goodies.rb

@@ -1,7 +1,10 @@
+module SpreadsheetGoodies
+
+end
+
 require 'spreadsheet_goodies/version'
-require 'spreadsheet_goodies/google_drive_worksheet'
-require 'spreadsheet_goodies/google_drive_connector'
-require 'spreadsheet_goodies/excel_worksheet'
+require 'spreadsheet_goodies/google_drive'
+require 'spreadsheet_goodies/excel'
 require 'roo'
 
 module SpreadsheetGoodies
@@ -31,4 +34,4 @@ module SpreadsheetGoodies
     end
   end
 
-end
+end

data/spreadsheet_goodies.gemspec

@@ -6,13 +6,13 @@ require 'spreadsheet_goodies/version'
 Gem::Specification.new do |gemspec|
   gemspec.name = 'spreadsheet_goodies'
   gemspec.version = SpreadsheetGoodies::VERSION
-  gemspec.authors = ['Ricardo Jasinski']
-  gemspec.email = ['jasinski@solvis.com.br']
+  gemspec.authors = ['Ricardo Jasinski', 'Henrique Gubert']
+  gemspec.email = ['jasinski@solvis.com.br', 'guberthenrique@hotmail.com']
 
   gemspec.summary = "SpreadsheetGoodies is a collection of tools to help work " +
-    "with Excel and Google Drive spreadhseets."
+    "with Excel and Google Drive spreadsheets."
   gemspec.description = "SpreadsheetGoodies is a collection of tools to help work " +
-    "with Excel and Google Drive spreadhseets. It relies " +
+    "with Excel and Google Drive spreadsheets. It relies " +
     "on other gems to do the actual work of reading and writing to " +
     "spreadsheet documents. It main features are:"
     "  * Read a spreadseet to an array of arrays, to allow accessing its data " +
@@ -38,4 +38,4 @@ Gem::Specification.new do |gemspec|
   gemspec.add_dependency 'csv', '>= 3.0.0'
   gemspec.add_dependency 'roo', '>= 1.13.2'
 
-end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: spreadsheet_goodies
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ricardo Jasinski
+- Henrique Gubert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,10 +110,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.13.2
 description: 'SpreadsheetGoodies is a collection of tools to help work with Excel
-  and Google Drive spreadhseets. It relies on other gems to do the actual work of
+  and Google Drive spreadsheets. It relies on other gems to do the actual work of
   reading and writing to spreadsheet documents. It main features are:'
 email:
 - jasinski@solvis.com.br
+- guberthenrique@hotmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -124,7 +126,6 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -132,13 +133,16 @@ files:
 - builds/spreadsheet_goodies-0.0.1.gem
 - builds/spreadsheet_goodies-0.0.2.gem
 - builds/spreadsheet_goodies-0.0.3.gem
+- builds/spreadsheet_goodies-0.0.4.gem
 - lib/spreadsheet_goodies.rb
-- lib/spreadsheet_goodies/excel_workbook_builder.rb
-- lib/spreadsheet_goodies/excel_worksheet.rb
-- lib/spreadsheet_goodies/excel_worksheet_row.rb
-- lib/spreadsheet_goodies/google_drive_connector.rb
-- lib/spreadsheet_goodies/google_drive_worksheet.rb
-- lib/spreadsheet_goodies/google_drive_worksheet_row.rb
+- lib/spreadsheet_goodies/abstract_base_worksheet.rb
+- lib/spreadsheet_goodies/excel.rb
+- lib/spreadsheet_goodies/excel/workbook_builder.rb
+- lib/spreadsheet_goodies/excel/worksheet.rb
+- lib/spreadsheet_goodies/google_drive.rb
+- lib/spreadsheet_goodies/google_drive/connector.rb
+- lib/spreadsheet_goodies/google_drive/worksheet.rb
+- lib/spreadsheet_goodies/row.rb
 - lib/spreadsheet_goodies/version.rb
 - spreadsheet_goodies.gemspec
 homepage: https://github.com/ricardo-jasinski/spreadsheet_goodies
@@ -162,9 +166,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: SpreadsheetGoodies is a collection of tools to help work with Excel and Google
-  Drive spreadhseets.
+  Drive spreadsheets.
 test_files: []

data/LICENSE.txt

@@ -1,24 +0,0 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <http://unlicense.org>

data/lib/spreadsheet_goodies/excel_workbook_builder.rb

@@ -1,78 +0,0 @@
-require 'axlsx'
-
-# A set of methods to help create and format Excel workbooks
-class SpreadsheetGoodies::ExcelWorkbookBuilder
-  attr_reader :current_sheet
-
-  def initialize(output_file_pathname)
-    @output_file_pathname = output_file_pathname
-    @axlsx_package = Axlsx::Package.new
-  end
-
-  # The underlying Axlsx::Workbook object
-  def workbook
-    @axlsx_package.workbook
-  end
-
-  def add_worksheet(sheet_name)
-    @current_sheet = @workbook.add_worksheet(name: sheet_name)
-    setup_current_sheet_styles
-    freeze_top_row
-    @current_sheet
-  end
-
-  # Add a row to the current sheet using the data row style
-  def add_data_row(row_values)
-    @current_sheet.add_row(row_values, style: @data_row_style)
-  end
-
-  # Add a row to the current sheet using the header row style
-  def add_header_row(row_values)
-    @current_sheet.add_row(row_values, style: @header_row_style)
-  end
-
-  # Add filter and sorting controls to a sheet.
-  def setup_auto_filter(sheet=nil)
-    worksheet = sheet || @current_sheet
-    top_left_cell_label = worksheet.dimension.first_cell_reference
-    bottom_right_cell_label = worksheet.dimension.last_cell_reference
-    filter_range = "#{top_left_cell_label}:#{bottom_right_cell_label}"
-    worksheet.auto_filter = filter_range
-  end
-
-  def write_to_file
-    @axlsx_package.serialize(@output_file_pathname)
-  end
-
-  def freeze_top_row
-    @current_sheet.sheet_view.pane do |pane|
-      pane.top_left_cell = 'A2'
-      pane.state = :frozen_split
-      pane.y_split = 1
-      pane.active_pane = :bottom_right
-    end
-  end
-
-private
-
-  def setup_current_sheet_styles
-    @header_row_style = @current_sheet.styles.add_style(
-      alignment: {horizontal: :center, vertical: :center},
-      font_name: 'Calibri',
-      bg_color: 'FFDDDDDD',
-      b: true,
-    )
-
-    @header_row_sodexo_style = @current_sheet.styles.add_style(
-      alignment: {horizontal: :center, vertical: :center},
-      font_name: 'Calibri',
-      bg_color: '002060',
-      fg_color: 'FFFFFF',
-      b: true,
-    )
-
-    @data_row_style = @current_sheet.styles.add_style(
-      font_name: 'Calibri',
-    )
-  end
-end

data/lib/spreadsheet_goodies/excel_worksheet.rb

@@ -1,68 +0,0 @@
-require_relative 'excel_worksheet_row'
-
-# A cached copy of an Excel worksheet (a single workbook "tab"), stored as an
-# array of arrays. Individual cells can be accessed by column title, e.g.:
-#   worksheet[0]['A column title']
-class SpreadsheetGoodies::ExcelWorksheet
-  attr_reader :rows, :workbook, :worksheet
-
-  # @param workbook_file_pathname [String] Full path and filename to Excel workbook document
-  # @param worksheet_title_or_index [String|Integer] Sheet name or index (zero-based)
-  #   within the workbook. Optional; if unspecified, the first sheet will be used.
-  # @param num_header_rows [Integer] Number of rows at the top of the sheet that
-  #   contain headers or stuff other than data. Optional; if unspecified, assumes
-  #   that a single top row contains the header and all rows below are data.
-  def initialize(workbook_file_pathname, worksheet_title_or_index=0, num_header_rows=1)
-    @worksheet_title = worksheet_title_or_index
-    @num_header_rows = num_header_rows
-
-    @workbook = case workbook_file_pathname.to_s
-    when /\.xls[^x]/ then Roo::Excel.new(workbook_file_pathname, file_warning: :ignore)
-    when /\.xlsx/ then Roo::Excelx.new(workbook_file_pathname, file_warning: :ignore)
-    end
-
-    @worksheet = @workbook.sheet(worksheet_title_or_index)
-
-    @header_row = @worksheet.row(num_header_rows)
-
-    # Reads all the worksheet rows, one at a time, using Workshete#row (note: reading
-    # them all at once using Worksheet#parse didn't work because the first row
-    # was missed some times.)
-    rows = (1..@worksheet.last_row).map {|row_number| @worksheet.row(row_number) }
-
-    # Create the rows cache, made of instances of ExcelWorksheetRow
-    @rows = rows.collect.with_index do |row, index|
-      ExcelWorksheetRow.new(@header_row, index+1, *row)
-    end
-
-    self
-  end
-
-  def [](index)
-    @rows[index]
-  end
-
-  # Return only the rows that contain data (excludes the header rows)
-  def data_rows
-    @rows[@num_header_rows..-1]
-  end
-
-  # Finds and returns the first row that contains cell_value at the given column
-  def find_row_by_column_value(column_title, cell_value)
-    data_rows.each do |row|
-      return row if row[column_title] == cell_value
-    end
-
-    nil
-  end
-
-  def add_row(row_data)
-    last_row_number = @rows.count
-    @rows << ExcelWorksheetRow.new(@header_row, last_row_number+1, *row_data)
-  end
-
-  def spreadsheet
-    @workbook
-  end
-
-end

data/lib/spreadsheet_goodies/excel_worksheet_row.rb

@@ -1,30 +0,0 @@
-class SpreadsheetGoodies::ExcelWorksheet
-
-  # Overload Array#[] to allow reading a cell's contents using its column title
-  # as index, e.g.: row['Column Title']
-  class ::ExcelWorksheetRow < Array
-    attr_reader :header_row, :row_number
-
-    # @param header_row [Array] The header cells of the sheet from were the row was taken
-    # @param sheet_row_number [Integer] The original row number of the row in the
-    #   sheet from where the row was taken. Row numebrs follow the spreadshet convention,
-    #   i.e., starting from 1.
-    def initialize(header_row, sheet_row_number, *args)
-      @header_row = header_row
-      @row_number = sheet_row_number
-      super(args)
-    end
-
-    # @param locator [Integer|String] The index of a row element. Can be a string
-    #   (a column title) or an integer (starting at 0 for the first cell).
-    # @return [String]
-    def [](locator)
-      if locator.is_a?(String)
-        return self[ @header_row.index(locator) ]
-      else
-        return super(locator)
-      end
-    end
-  end
-
-end

data/lib/spreadsheet_goodies/google_drive_connector.rb

@@ -1,93 +0,0 @@
-require 'google_drive'
-require 'googleauth'
-
-class SpreadsheetGoodies::GoogleDriveConnector
-  attr_reader :logger, :session
-
-  def initialize
-    @logger = Logger.new(STDOUT)
-    @session = log_into_google_drive
-    raise 'Session not found!' unless @session
-  end
-
-  def log_into_google_drive
-    case SpreadsheetGoodies.configuration.login_method
-    when :service_account then log_into_google_drive_via_service_account
-    when :oauth2 then log_into_google_drive_via_oauth2
-    end
-  end
-
-  def read_worksheet(spreadsheet_key, worksheet_title=nil)
-    puts "Reading sheet '#{worksheet_title}' from Google Drive..."
-    spreadsheet = @session.spreadsheet_by_key(spreadsheet_key)
-
-    if worksheet_title
-      worksheet = spreadsheet.worksheet_by_title(worksheet_title)
-      if worksheet.nil?
-        raise "Worksheet named '#{worksheet_title}' not found in spreadsheet."
-      end
-    else
-      worksheet = spreadsheet.worksheets.first
-    end
-
-    worksheet
-  end
-
-  def read_worksheet_as_string(spreadsheet_key, worksheet_title)
-    worksheet = read_worksheet(spreadsheet_key, worksheet_title)
-    contents = worksheet.export_as_string.force_encoding('utf-8')
-    puts 'Spreadhseet read successfully.'
-    contents
-  end
-
-private
-
-  # Authenticate with Google Drive via OAuth2.
-  # Your OAuth2 ids can be accessed at https://console.developers.google.com/apis/credentials,
-  # logged with your Google account in your custom project. The keys are at
-  # 'API manager' > 'Credentials'. CLIENT_ID and CLIENT_SECRET are available
-  # from the credentials page. The REFRESH_TOKEN must be obtained uncommenting
-  # some rows from the method below and obtaining an access_token via a browser
-  # logged in to your google account.
-  def log_into_google_drive_via_oauth2
-    credentials = Google::Auth::UserRefreshCredentials.new(
-      client_id: SpreadsheetGoodies.configuration.google_client_id,
-      client_secret: SpreadsheetGoodies.configuration.client_secret,
-      scope: [
-        'https://www.googleapis.com/auth/drive',
-        'https://spreadsheets.google.com/feeds/',
-      ],
-      redirect_uri: 'urn:ietf:wg:oauth:2.0:oob'
-    )
-    credentials.refresh_token = SpreadsheetGoodies.configuration.refresh_token if SpreadsheetGoodies.configuration.refresh_token
-
-    # Uncomment the rows below to obtain the refresh_token:
-    # print("1. Open this page:\n%s\n\n" % credentials.authorization_uri)
-    # print("2. Enter the authorization code shown in the page: ")
-    # credentials.code = $stdin.gets.chomp
-    # credentials.fetch_access_token!
-    # puts credentials.refresh_token
-    # debugger
-
-    begin
-      credentials.fetch_access_token!
-    rescue Faraday::ConnectionFailed
-      logger.info 'Error logging into Google Drive. Is your internet connection down?'
-      exit
-    end
-
-    session = GoogleDrive::Session.from_credentials(credentials)
-  end
-
-  # Authenticate with Google Drive via a service account.
-  # Your service accounts can be accessed at https://console.developers.google.com/apis/credentials,
-  # logged with your Google account in your custom project.
-  # The service accounts are at 'IAM and administrator' > 'Service accounts'.
-  # The keys are at 'API manager' > 'Credentials'.
-  def log_into_google_drive_via_service_account
-    session = GoogleDrive::Session.from_service_account_key(
-      StringIO.new(SpreadsheetGoodies.configuration.service_account_key_json)
-    )
-    session
-  end
-end

data/lib/spreadsheet_goodies/google_drive_worksheet.rb

@@ -1,68 +0,0 @@
-require_relative 'google_drive_worksheet_row'
-require 'csv'
-
-# A cached copy of a Google Spreadsheets worksheet (i.e., a single workbook "tab"),
-# stored as an array of arrays. Individual cells can be accessed by column title.
-# Example:
-#   worksheet[0]['A column title']
-class SpreadsheetGoodies::GoogleDriveWorksheet
-  attr_reader :rows, :header_row
-
-  # @param worksheet_title_or_index [String] Sheet name; if unspecified, the
-  #   first sheet will be used.
-  # @param num_header_rows [Integer] Number of rows at the top of the sheet that
-  #   contain headers or stuff other than data. Optional; if unspecified, assumes
-  #   that a single top row contains the header and all rows below are data.
-  def initialize(spreadsheet_key, worksheet_title=nil, num_header_rows=1)
-    @spreadsheet_key = spreadsheet_key
-    @worksheet_title = worksheet_title
-    @num_header_rows = num_header_rows
-  end
-
-  # Reads sheet contents and caches it into instance variables to so that it
-  # can be accessed later without accessing Google Drive.
-  def read_from_google_drive
-    worksheet_contents = read_worksheet.export_as_string.force_encoding('utf-8')
-
-    rows = CSV::parse(worksheet_contents)
-
-    if SpreadsheetGoodies.configuration.strip_values_on_read
-      rows = rows.map do |row|
-        row.map {|element| element.try(:strip) }
-      end
-    end
-
-    @header_row = rows[@num_header_rows-1]
-    @rows = rows.collect.with_index do |row, index|
-      GoogleDriveWorksheetRow.new(@header_row, index+1, *row)
-    end
-
-    self
-  end
-
-  def [](index)
-    @rows[index]
-  end
-
-  # Return only the rows that contain data (excludes the header rows)
-  def data_rows
-    @rows[@num_header_rows..-1]
-  end
-
-  # Finds and returns the first row that contains cell_value at the given column
-  def find_row_by_column_value(column_title, cell_value)
-    data_rows.each do |row|
-      return row if row[column_title] == cell_value
-    end
-
-    nil
-  end
-
-  # Reads a GoogleDrive::Spreadsheet object from Google Drive. The sheet object
-  # can be used to write data to the online spreadhseet, as we don't yet provide
-  # the helper methods for our users to do it via our public interface.
-  def read_worksheet
-    connector = SpreadsheetGoodies::GoogleDriveConnector.new
-    connector.read_worksheet(@spreadsheet_key, @worksheet_title)
-  end
-end

data/lib/spreadsheet_goodies/google_drive_worksheet_row.rb

@@ -1,23 +0,0 @@
-class SpreadsheetGoodies::GoogleDriveWorksheet
-
-  # Sobrecarrega método [] da Array para permitir acessar células passando
-  # o título da coluna como índice. Ex: row['Data formal do pedido']
-  class ::GoogleDriveWorksheetRow < Array
-    attr_reader :header_row, :row_number
-
-    def initialize(header_row, sheet_row_number, *args)
-      @header_row = header_row
-      @row_number = sheet_row_number
-      super(args)
-    end
-
-    def [](locator)
-      if locator.is_a?(String)
-        return self[ @header_row.index(locator) ]
-      else
-        return super(locator)
-      end
-    end
-  end
-
-end