toggl_cache 0.1.0

data/scripts/sync.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# Usage:
+#
+#   - Syncs reports since 1 month:
+#       ruby scripts/sync.rb
+#
+#   - Sync reports since the specified date (use Ruby-parseable
+#     format):
+#       ruby scripts/sync.rb 2015-01-01
+
+# Load dependencies
+require 'rubygems'
+require 'bundler/setup'
+
+$LOAD_PATH.unshift File.expand_path('../..', __FILE__)
+require 'config/boot'
+
+date_since = Time.parse(ARGV[0]) unless ARGV[0].nil? || ARGV[0].empty?
+TogglCache.sync_reports(date_since: date_since)

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+# Load dependencies
+require "rubygems"
+require "bundler/setup"
+require "rspec"
+require "webmock/rspec"
+require "rack/test"
+require "pry"
+
+require "simplecov"
+SimpleCov.start do
+  add_filter do |src|
+    # Ignoring files from the spec directory
+    src.filename =~ %r{/spec/}
+  end
+end
+
+# ENV["APP_ENV"] replaces "RACK_ENV" since we're not in
+# a Rack context.
+ENV["APP_ENV"] = "test"
+require File.expand_path("../../config/boot", __FILE__)
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require(f) }
+
+# Database setup, teardown and cleanup during tests
+require "sequel/extensions/migration"
+require "toggl_cache/data/report_repository"
+client = TogglCache::Data::DB
+
+MIGRATIONS_DIR = File.expand_path("../../config/db_migrations", __FILE__)
+RSpec.configure do |config|
+
+  config.before(:all) do
+    Sequel::Migrator.apply(client, MIGRATIONS_DIR)
+  end
+
+  config.after(:each) do
+    TogglCache::Data::ReportRepository.delete_where("TRUE")
+  end
+
+  config.after(:all) do
+    Sequel::Migrator.apply(client, MIGRATIONS_DIR, 0)
+  end
+end
+
+require "toggl_cache"

data/spec/unit/toggl_api/reports_client_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require "spec_helper"
+require "toggl_api/reports_client"
+
+describe TogglAPI::ReportsClient do
+  let(:options) { {} }
+  let(:expected_api_call_url) { "https://toggl_api_token:api_token@toggl.com/reports/api/v2/details?page=1&user_agent=TogglAPI" }
+
+  let(:api_response_status) { 200 }
+  let(:api_response_body) do
+    {
+      total_count: total_count,
+      data: data_page1
+    }.to_json
+  end
+  let(:total_count) { 0 }
+  let(:data_page1) do
+    50.times.map { { id: 1 } } # faking 50 entries
+  end
+
+  before do
+    stub_request(:get, expected_api_call_url)
+      .with(headers: { "Content-Type" => "application/json" })
+      .to_return(status: api_response_status, body: api_response_body, headers: {})
+  end
+
+  describe "#fetch_reports(params)" do
+
+    context "only 1 page" do
+      let(:total_count) { 50 }
+
+      it "fetches the data only once" do
+        described_class.new.fetch_reports(options)
+        # It will fail if it fetches several times because
+        # the second request, with page=2, is not mocked.
+      end
+
+      it "returns the received data" do
+        results = described_class.new.fetch_reports(options)
+        expect(results.count).to eq(50)
+      end
+    end
+
+    context "several pages" do
+      let(:total_count) { 60 }
+      let(:data_page2) do
+        10.times.map { { id: 2 } } # faking 10 entries
+      end
+
+      before do
+        api_response_body_page2 = {
+          total_count: total_count,
+          data: data_page2
+        }.to_json
+        stub_request(:get, expected_api_call_url.gsub('page=1', 'page=2'))
+          .with(headers: { "Content-Type" => "application/json" })
+          .to_return(status: api_response_status, body: api_response_body_page2, headers: {})
+      end
+
+      it "fetches the additional pages" do
+        results = described_class.new.fetch_reports(options)
+        expect(results.count).to eq(60)
+      end
+
+      it "returns the merged data" do
+        results = described_class.new.fetch_reports(options)
+        expect(results.inject(0) { |s, i| s + i["id"] }).to eq(50 * 1 + 10 * 2)
+      end
+    end
+
+    context "receiving non-successful response" do
+      let(:api_response_status) { 500 }
+
+      it "raises a TogglAPI::Error" do
+        expect { described_class.new.fetch_reports(options) }
+          .to raise_error(TogglAPI::Error)
+      end
+    end
+  end
+end

data/toggl_cache.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "toggl_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "toggl_cache"
+  spec.version       = TogglCache::VERSION
+  spec.authors       = ["Romain Champourlier"]
+  spec.email         = ["pro@rchampourlier.com"]
+  spec.summary       = "Fetches reports from Toggl and caches them in a MongoDB store."
+  spec.homepage      = "https://github.com/rchampourlier/toggl_cache"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting "allowed_push_host", or
+  # delete this section to allow pushing this gem to any host.
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "i18n"
+  spec.add_dependency "activesupport-inflector"
+  spec.add_dependency "pg"
+  spec.add_dependency "sequel"
+  spec.add_dependency "sequel_pg"
+  spec.add_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: toggl_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Romain Champourlier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel_pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pro@rchampourlier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".env.test"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- HISTORY.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/db/migrate
+- bin/db/psql
+- bin/db/reset
+- bin/setup
+- config/boot.rb
+- config/db_migrations/001_create_toggl_cache_reports.rb
+- docker-compose.yml
+- lib/toggl_api/base_client.rb
+- lib/toggl_api/client.rb
+- lib/toggl_api/reports_client.rb
+- lib/toggl_cache.rb
+- lib/toggl_cache/data.rb
+- lib/toggl_cache/data/report_repository.rb
+- lib/toggl_cache/version.rb
+- lib/toggl_cli.rb
+- scripts/sync.rb
+- spec/spec_helper.rb
+- spec/unit/toggl_api/reports_client_spec.rb
+- toggl_cache.gemspec
+homepage: https://github.com/rchampourlier/toggl_cache
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Fetches reports from Toggl and caches them in a MongoDB store.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/toggl_api/reports_client_spec.rb