https://github.com/marcoroth/timingapp-ruby
Ruby client for the database of the Timingapp.com macOS application.
https://github.com/marcoroth/timingapp-ruby
activerecord ruby sqlite sqlite3 time-tracking timing timingapp tracking
Last synced: 4 months ago
JSON representation
Ruby client for the database of the Timingapp.com macOS application.
- Host: GitHub
- URL: https://github.com/marcoroth/timingapp-ruby
- Owner: marcoroth
- Created: 2025-01-26T02:23:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-26T23:43:34.000Z (about 1 year ago)
- Last Synced: 2025-09-19T09:12:17.002Z (4 months ago)
- Topics: activerecord, ruby, sqlite, sqlite3, time-tracking, timing, timingapp, tracking
- Language: Ruby
- Homepage: https://timingapp.com
- Size: 49.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Timingapp
Ruby client for the database of the [Timing](https://timingapp.com) macOS application. It allows you to read the Timing SQLite database from your local disk and gives you an interface to query it's data.
## Installation
Install the gem and add to the application's `Gemfile` by executing:
```bash
bundle add timingapp
```
If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install timingapp
```
## Usage
To utilize the `timingapp` gem, `require` it in your project:
```ruby
require "timingapp"
```
Next, initiate database access using:
```ruby
Timingapp.load!
```
> [!NOTE]
> The `Timingapp.load!` method accepts an optional `path` parameter specifying the location of the SQLite database file.
> It defaults to `"~/Library/Application Support/info.eurocomp.Timing2/SQLite.db"`.
```ruby
Timingapp.load!("path/to/other/timingapp/database.db")
```
After successfully loading the database, you get access to all the models exposed by the gem. Currently, these models are read-only and are all instances of `ActiveRecord::Base`.
```ruby
irb(main):001> Timingapp::AppActivity.all
# =>
[
#,
#,
#...
]
```
Consequently, you can leverage the ActiveRecord DSL for querying and traversing the models.
```ruby
irb(main):002> activity = Timingapp::AppActivity.find(3686251181653903872)
=> #
irb(main):003> activity.project
=> #
irb(main):004> activity.project.title
=> "StimulusReflex"
irb(main):005> activity.project.parent.title
=> "Open Source"
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/timingapp-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/timingapp-ruby/blob/main/CODE_OF_CONDUCT.md).
## Code of Conduct
Everyone interacting in the Timingapp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/timingapp-rubyblob/main/CODE_OF_CONDUCT.md).