toggl_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3e59b8333c1e639df56bc5b28487def4ed4fbce
+  data.tar.gz: '0218ed7d70e6f03026cddab8654b509f1e26c7e3'
+SHA512:
+  metadata.gz: 5019fcfa24a11cc789d1083aec3aa5bf42ee45daea85eb593a335fa540a25287802a34a8c4381f215b6c2a9599c5d2778c473e278adb530f3cbf1bece21bd0c4
+  data.tar.gz: dc4af37451d09cdea3b344c377981f53b29432c74307d73a41419679ca1c2a29c1da0129a75e9cf243b089fe81852e735d348e9cbdd7bbad90e481ca0ce79c96

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - config/**
+    - lib/**
+    - "**.rb"
+exclude_paths:
+  - spec/**/*

data/.env.test

@@ -0,0 +1,7 @@
+APP_ENV=test
+DATABASE_URL=postgres://toggl_cache_user:password@localhost:5433/toggl_cache_test
+POSTGRES_USER=toggl_cache_user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=toggl_cache_test
+TOGGL_API_TOKEN=toggl_api_token
+TOGGL_WORKSPACE_ID=toggl_workspace_id

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.env.development
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/LineLength:
+  Max: 120
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/EmptyLinesAroundBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation

data/.ruby-gemset

@@ -0,0 +1 @@
+toggl_cache

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
+after_success: bundle exec codeclimate-test-reporter
+services:
+  - postgresql
+addons:
+  postgresql: "9.4"
+env:
+  global:
+    - APP_ENV=test
+    - DATABASE_URL=postgres://localhost:5432/travis_ci_test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in toggl_cache.gemspec
+gemspec
+
+group :development do
+  gem 'guard', require: false
+  gem 'guard-rspec', require: false
+  gem 'terminal-notifier-guard'
+
+  # For CLI
+  gem 'thor'
+  gem 'tty-pager'
+  gem 'tty-progressbar'
+  gem 'tty-spinner'
+  gem 'tty-table'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rack-test'
+  gem 'webmock'
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+  gem 'simplecov-json', require: false
+end

data/Guardfile

@@ -0,0 +1 @@
+./config/Guardfile

data/HISTORY.md

@@ -0,0 +1,5 @@
+# History
+
+## 2017-03-08 - 0.1.0
+
+- Initial version

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Romain Champourlier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,50 @@
+# TogglCache
+
+Fetches reports data from Toggl API and caches them in a MongoDB store.
+
+This allows you to build applications performing complex operations on a large number of Toggl content without the Toggl API latency. You may also use it to backup your precious data!
+
+[![Build Status](https://travis-ci.org/rchampourlier/toggl_cache.svg)](https://travis-ci.org/rchampourlier/toggl_cache)
+[![Code Climate](https://codeclimate.com/github/rchampourlier/toggl_cache/badges/gpa.svg)](https://codeclimate.com/github/rchampourlier/toggl_cache)
+[![Coverage Status](https://coveralls.io/repos/github/rchampourlier/toggl_cache/badge.svg?branch=master)](https://coveralls.io/github/rchampourlier/toggl_cache?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toggl_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install toggl_cache
+
+## Usage
+
+Inside of `bin/console`:
+
+```ruby
+logger = Logger.new(STDOUT)
+logger.level = Logger::DEBUG
+client = TogglCache::Client.new(
+  api_token: 'SOME-API-TOKEN',
+  user_agent: 'MyCustomTogglCache',
+  logger: logger
+)
+TogglCache.sync_reports(client, 'TOGGL-WORKSPACE-ID')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rchampourlier/toggl_cache/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Check the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# Load dependencies
+require "rubygems"
+require "bundler/setup"
+
+$LOAD_PATH.unshift File.expand_path("../..", __FILE__)
+require "config/boot"
+
+require "toggl_api/client"
+require "toggl_api/reports_client"
+
+require "pry"
+Pry.start

data/bin/db/migrate

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  sequel -m config/db_migrations $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && sequel -m config/db_migrations $DATABASE_URL
+fi

data/bin/db/psql

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  psql $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && psql $DATABASE_URL
+fi

data/bin/db/reset

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if [ "$RACK_ENV" == "production" ]
+then
+  sequel -m config/db_migrations -M 0 $DATABASE_URL
+else
+  export $(cat .env.development | xargs) && sequel -m config/db_migrations -M 0 $DATABASE_URL
+fi

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/boot.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+env = ENV["APP_ENV"] || "development"
+if env == "development" || env == "test"
+  require "dotenv"
+  Dotenv.load(".env.#{env}")
+end
+
+root_dir = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift root_dir
+$LOAD_PATH.unshift File.join(root_dir, "lib")
+require "toggl_cache"

data/config/db_migrations/001_create_toggl_cache_reports.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Sequel.migration do
+  up do
+    create_table :toggl_cache_reports do
+      String :description
+      Integer :duration
+      DateTime :end
+      Integer :pid
+      String :project
+      String :uid
+      String :user
+      DateTime :start
+      String :task
+      Integer :tid
+      String :id, unique: true
+      DateTime :toggl_updated
+
+      # Timestamps
+      DateTime :created_at
+      DateTime :updated_at
+    end
+  end
+
+  down do
+    drop_table(:toggl_cache_reports)
+  end
+end

data/docker-compose.yml

@@ -0,0 +1,25 @@
+version: '2'
+
+services:
+  pg-dev:
+    env_file:
+      - .env.development
+    image: postgres:9.4
+    ports:
+      - "5432:5432"
+    volumes:
+      - pg-dev-data:/var/lib/postgresql/data
+  pg-test:
+    env_file:
+      - .env.test
+    image: postgres:9.4
+    ports:
+      - "5433:5432"
+    volumes:
+      - pg-test-data:/var/lib/postgresql/data
+
+volumes:
+  pg-dev-data:
+    driver: local
+  pg-test-data:
+    driver: local

data/lib/toggl_api/base_client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module TogglAPI
+  DEFAULT_WORKSPACE_ID = ENV["TOGGL_WORKSPACE_ID"]
+  Error = Class.new(StandardError)
+
+  # Superclass for API clients.
+  class BaseClient
+    DEFAULT_USER_AGENT = "TogglAPI"
+    attr_reader :api_token, :logger
+
+    # Returns a new instance of the client, configured with
+    # the specified parameters.
+    #
+    # @param api_token [String] Toggl API token, for authentication
+    # @param user_agent [String] defaults to "TogglCache"
+    # @param logger [Logger] used to log messages (in particular fetch
+    #   events). Defaults to nil.
+    #
+    def initialize(api_token: default_api_token, user_agent: default_user_agent, logger: nil)
+      raise "Missing api_token" if api_token.nil? || api_token.empty?
+      @api_token = api_token
+      @user_agent = user_agent
+      @logger = logger
+    end
+
+    def default_api_token
+      ENV["TOGGL_API_TOKEN"]
+    end
+
+    def default_user_agent
+      DEFAULT_USER_AGENT
+    end
+
+    def credentials
+      {
+        username: @api_token,
+        password: "api_token"
+      }
+    end
+
+    def default_headers
+      {
+        "Content-Type" => "application/json"
+      }
+    end
+
+    def default_workspace_id
+      DEFAULT_WORKSPACE_ID
+    end
+  end
+end

data/lib/toggl_api/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require "uri"
+require "httparty"
+require "toggl_api/base_client"
+
+module TogglAPI
+
+  # The Toggl API Client
+  class Client < BaseClient
+    API_URL = "https://www.toggl.com/api/v8"
+
+    # Update the Toggl time entry with the specified `ìd` using
+    # the provided `time_entry` data.
+    def update_time_entry(id:, time_entry:)
+      perform_request(
+        verb: :put,
+        url: "#{API_URL}/time_entries/#{id}",
+        body: { time_entry: time_entry }
+      )["data"]
+    end
+
+    # Get the projects from the specified workspace.
+    def get_workspace_projects(workspace_id: default_workspace_id, active: "true")
+      perform_request(
+        url: "#{API_URL}/workspaces/#{workspace_id}/projects",
+        query: { active: active }
+      )
+    end
+
+    def get_project_tasks(project_id:)
+      perform_request(
+        url: "#{API_URL}/projects/#{project_id}/tasks"
+      ) || []
+    end
+
+    private
+
+    def perform_request(verb: :get, url:, headers: default_headers, query: {}, body: {})
+      response = HTTParty.send(
+        verb,
+        url,
+        headers: headers,
+        query: { user_agent: default_user_agent }.merge(query),
+        body: body.to_json,
+        basic_auth: credentials
+      )
+
+      begin
+        if response.code == 200 || response.code == 201
+          return nil if response.body == 'null'
+          JSON.parse(response.body)
+        else
+          logger.error "Error (response code #{response.code}, content '#{response.body.strip}')"
+          nil
+        end
+      # rescue => e
+        # TODO: fix this too large rescue
+        # logger.error "Exception (#{e})"
+      end
+    end
+  end
+end