ActiveWorksheet

ActiveWorksheet reads local spreadsheet files (XLS, XLSX and CSV) and presents them as ActiveRecord/ActiveResource objects, mapping rows as records and columns and attributes.

Installation

Add this line to your application's Gemfile:

gem 'active_worksheet'

And then execute:

$ bundle

Or install it yourself as:

$ gem install active_worksheet

Usage

Having the following CSV file:

id,first_name,last_name,email,company
1,Brendis,MacCahee,[email protected],Klocko and Sons
2,Abbe,John,[email protected],"Mayer, Weimann and Stark"
3,Buffy,Schiersch,[email protected],"Gusikowski, Schmidt and Watsica"
4,Flore,Aberhart,[email protected],Beatty Group

class ImportedAccount < ActiveWorksheet::Base
  self.source = "./accounts.csv"
end

The ImportedAccount class will read the file as a spreadsheet and treat the first row as the collection's headers, where each column is an attribute name.

ImportedAccount.count
# => 4

ImportedAccount.first
# => #<ImportedAccount id=1, first_name="Brendis", last_name="MacCahee", email="[email protected]", company="Klocko and Sons">

ActiveWorksheet works with .xls, .xlsx and .csv files.

ActiveWorksheet::Base exposes the following class methods, similar to ActiveRecord::Base or ActiveResource::Base:

• .all
• .find(index)
• .first
• .last
• .count

Using Google Sheets (experimental)

ActiveWorksheet can connect to Google Sheets files by setting a URL as source and an authorization strategy.

class Savings < ActiveWorksheet::Base
  self.source = "https://docs.google.com/spreadsheets/d/YOUR_GOOGLE_SHEETS_ID/edit"
  self.authorization = {
    credentials: Google::Auth::UserRefreshCredentials.new(
      client_id: "CLIENT_ID",
      client_secret: "CLIENT_SECRET",
      refresh_token: "REFRESH_TOKEN",
      type: "authorized_user"
    )
  }
end

Note: At the moment, all attributes are formatted strings (the same way they're represented in Google Sheets).

Savings.last.week
# => "52"

Savings.last.weekly_savings
# => "S/.1,300.00"

Authorization

ActiveWorksheet supports the following authorization strategies:

OAuth client ID (For "Other" Application type)

With a JSON file containing client_id and client_secret:

self.authorization = {
  config: "YOUR_CONFIG_FILE_PATH.json",
}

OAuth client ID (For "Web application" Application type)

With a credentials object:

require "googleauth"

self.authorization = {
  credentials: Google::Auth::UserRefreshCredentials.new(
    client_id: "CLIENT_ID",
    client_secret: "CLIENT_SECRET",
    refresh_token: "USER_REFRESH_TOKEN",
    type: "authorized_user"
  )
}

Service account key

With a JSON file downloaded from Google Developer Console:

self.authorization = {
  service_account_key: "my-service-account-xxxxxxxxxxxx.json",
}

Note: You can check available configuration strategies and a more thorough explanation here.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hpneo/active_worksheet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ActiveWorksheet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.