sheet_reader_writer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49a1e38c8954ca72c9ac99c94edfbe60beb6447b
+  data.tar.gz: 3e5cd57904c2011a473f9045207cd1007fb9aeca
+SHA512:
+  metadata.gz: 951d29bb7c422436803385f7b26abb8d35c6fd36b1f4b308585ebeb3c8353d35b64f16f9d44d9861da253fdd7de8bbbb626611c55bc13de522c7ecc55fbe536c
+  data.tar.gz: fe95f4ac11f327ad5c64caaa9cfd733f197090c32650de95a8848c19eb21cafdd4369b90518a6359bc23b653a8297b3f07eba7169ce33a243637e3a4ef00b0fe

data/lib/sheet_reader_writer.rb

@@ -0,0 +1,148 @@
+require 'google/apis/sheets_v4'
+require 'googleauth'
+require 'sheet_reader_writer/errors'
+
+class SheetReaderWriter
+  REQUIRED_ENV_VARS = %w[GOOGLE_CLIENT_EMAIL
+                         GOOGLE_ACCOUNT_TYPE
+                         GOOGLE_PRIVATE_KEY]
+
+  # Creates a new instance to interact with Google Sheets
+  #
+  # Example:
+  #   >> SheetReaderWriter.new("1ukhJwquqRTgfX-G-nxV6AsAH726TOsKQpPJfpqNjWGg").read("Sheet 1")
+  #   => [{"foo"=>"hey", "bar"=>"ho"},
+  #       {"foo"=>"let's ", "bar"=>"go"}]
+  #
+  # Arguments:
+  #   sheet_id: (String) The google sheet identifier.
+  #
+  def initialize(sheet_id, write_permission: true)
+    raise MissingEnvVars unless required_env_vars?
+    ensure_valid_key_format
+
+    with_exceptions do
+      sheets = Google::Apis::SheetsV4::SheetsService.new
+
+      scopes = if write_permission
+        ['https://www.googleapis.com/auth/spreadsheets']
+      else
+        ['https://www.googleapis.com/auth/spreadsheets.readonly']
+      end
+
+      sheets.authorization = Google::Auth.get_application_default(scopes)
+
+      @sheet_service = sheets
+      @sheet_id = sheet_id
+    end
+  end
+
+  # Fetches the content of a google spreadsheet
+  #
+  # Example:
+  #   >> sheet_reader_writer.read("Sheet 1")
+  #   => [{"foo"=>"hey", "bar"=>"ho"},
+  #       {"foo"=>"let's ", "bar"=>"go"}]
+  #
+  # Arguments:
+  #   sheet_name: (String) The sheet name, by default it's the first one
+  #
+  def read(sheet_name = "")
+    with_exceptions do
+      raw_values = @sheet_service.get_spreadsheet_values(@sheet_id, "#{sheet_name}!A:ZZ").values
+      rows_as_hashes(raw_values)
+    end
+  end
+
+  # Writes the specified content to a google spreadsheet
+  #
+  # Example:
+  #
+  # screen_reader_writer.write [
+  #   {"foo"=>"hey", "bar"=>"ho"},
+  #   {"foo"=>"let's"},
+  #   {"bar"=>"go"}
+  # ]
+  #
+  # Arguments:
+  #   row_hashes: (Array of hashes) The values to update in the same format as returned by the read method 
+  #
+  def write(row_hashes, sheet_name = "")
+    value_range_object = {
+      major_dimension: "ROWS",
+      values: to_values_array(row_hashes)
+    }
+
+    with_exceptions do
+      @sheet_service.update_spreadsheet_value(@sheet_id, "#{sheet_name}!A:ZZ", value_range_object, value_input_option: 'USER_ENTERED')
+    end
+  end
+
+  # Clears a google spreadsheet
+  #
+  # Example:
+  #   >> sheet_reader_writer.clear
+  #
+  def clear(sheet_name = "")
+    with_exceptions do
+      @sheet_service.clear_values(@sheet_id, "#{sheet_name}!A:ZZ")
+    end
+  end
+
+  private
+
+  def to_values_array(row_hashes)
+    keys = row_hashes.map do |row_hash|
+      row_hash.keys
+    end.flatten.uniq.sort
+
+    values_array = row_hashes.map do |row_hash|
+      keys.map do |key|
+        row_hash[key]
+      end
+    end
+
+    values_array.unshift(keys)
+  end
+
+  def with_exceptions
+    begin
+      yield
+    rescue Google::Apis::ClientError => e
+      raise BadSheetId if e.message =~ /notFound/
+      raise Unauthorized if e.message =~ /forbidden/
+    rescue
+      raise Error
+    end
+  end
+
+  def ensure_valid_key_format
+    ENV['GOOGLE_PRIVATE_KEY'] = ENV['GOOGLE_PRIVATE_KEY'].gsub(/\\n/, "\n")
+  end
+
+  def rows_as_hashes(rows)
+    keys, *rest = rows
+
+    rest.map do |row|
+      Hash[keys.zip(convery_empty_cells_to_nil(row))]
+    end
+  end
+
+  def convery_empty_cells_to_nil(row)
+    row.map do |cell|
+      if cell.strip == ""
+        nil
+      else
+        cell
+      end
+    end
+  end
+
+  def required_env_vars?
+    REQUIRED_ENV_VARS.all? do |e|
+      ENV.has_key?(e) &&
+      ENV.fetch(e) &&
+      ENV.fetch(e).strip != ""
+    end
+  end
+end

data/lib/sheet_reader_writer/errors.rb

@@ -0,0 +1,24 @@
+class SheetReaderWriter
+  class Error < StandardError;
+    def backtrace
+      return cause.backtrace if cause
+      super
+    end
+
+    def message
+      return cause.message if cause
+      super
+    end
+  end
+
+  class BadSheetId < Error; end
+  class Unauthorized < Error; end
+
+  class MissingEnvVars < Error
+    def message
+      "Missing environment variables for the service account.\n" \
+      "Please provide #{REQUIRED_ENV_VARS.join(', ')}.\n" \
+      "See https://github.com/clearbit/sheet_reader_writer for more info.\n"
+    end
+  end
+end

data/lib/sheet_reader_writer/version.rb

@@ -0,0 +1,3 @@
+class SheetReaderWriter
+  VERSION='1.0.0'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: sheet_reader_writer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Clearbit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A gem to read and write to google spreadsheets
+email: daniel@clearbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sheet_reader_writer.rb
+- lib/sheet_reader_writer/errors.rb
+- lib/sheet_reader_writer/version.rb
+homepage: http://github.com/cleabit/sheet_reader_writer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.5
+signing_key: 
+specification_version: 4
+summary: Read and write to google spreadsheets
+test_files: []