luxafor-toggl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e008e5f5cdb90b0a8fbf5fff16a62de4a8587d50e828fe59db7dfd1e401c48b2
+  data.tar.gz: 6d7c7490fd2ba3ba815baa80b4b540ac341cee73238c25e69bb33110112b0af2
+SHA512:
+  metadata.gz: c7d4435141f9986048a031c01b23b6d359f14af630ed2a44b7a09e1bb39bf1530a5ef667cd9450abbc2cf9b9af48332715a82604fed0f59a2f5a987aac3aee64
+  data.tar.gz: 6bb066191cb050aceda7efd50fa57c73ff5b27a185e3161f5841bf3fadafff6c7af6909a071c059ad32f3e9b3abd091a26abfcbca23a635b7fd60ed4aa58d8e4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gabriel@zero-one.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in luxafor-toggl.gemspec
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+# Luxafor Toggl Syncer
+
+This is a small utility to synchronise your [Luxafor Flag](https://luxafor.com/flag-usb-busylight-availability-indicator/) with your [Toggl activity](https://toggl.com)
+
+* The utility will turn your flag red if you're busy tracking time to indicate that you're busy
+* The utility will turn your flag green you have stopped tracking time to indicate that you're free
+* The utility will switch off your flag if you haven't tracked any time within 2 hours to indicate that you're idle
+
+**NOTE** It might work with other webhook enabled Luxafor devices. I don't have any other ones besides the flag, which is a pretty cool gadget.
+
+## Installation
+
+This gem is not meant for integration into a project via a Gemfile. It is meant for running as a standalone utility.
+
+```shell
+gem install luxafor-toggl
+```
+
+## Usage
+
+```shell
+export LUXAFOR_KEY=abc123 # Get me from your luxafor app webhook settings
+export TOGGL_KEY=123abc   # Get me from your toggl user account
+
+luxafor-toggl
+```
+
+### Cron Usage
+
+Have it sync once every 2 minutes
+
+```cron
+*/2 * * * * LUXAFOR_KEY=abc123 TOGGL_KEY=123abc /path/to/luxafor-toggl
+```
+
+### Configuration
+
+You can control certain aspects of the utility by setting a few environment variables:
+
+* `LUXAFOR_KEY`: Required for controlling your Luxafor flag
+* `TOGGL_KEY`: Required for reading from your Toggl account
+* `LUXAFOR_TOGGL_STATE_FILE`: Optional. Default: `/tmp/myuser-luxafor-toggl-state.json`. Keeps state between runs. Delete this file to reset the utility's state.
+* `LUXAFOR_TOGGL_IDLE_TIME`: Optional. Default: `7200`. Time in seconds before you're considered idle.
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gee-forr/luxafor-toggl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Luxafor::Toggl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gee-forr/luxafor-toggl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "awesome_print"
+require "luxafor/toggl"
+
+def client
+  @client ||= Luxafor::Toggl::Client.new
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/setup

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

data/exe/luxafor-toggl

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'luxafor/toggl'
+
+client = Luxafor::Toggl::Client.new
+
+client.execute!

data/lib/luxafor/toggl.rb

@@ -0,0 +1,63 @@
+require "awesome_print"
+require "date"
+require "value_semantics"
+
+require 'luxafor'
+require 'togglv8'
+
+require "luxafor/toggl/version"
+require "luxafor/toggl/client"
+require "luxafor/toggl/state"
+
+# As of Apr 2020, because of a 1/2 removed awesome print dep in the gem which hasnt been released.
+# See https://github.com/kanet77/togglv8/issues/17
+class Logger
+  def ap(*args, **kwargs, &block)
+    true
+  end
+end
+
+module Luxafor
+  module Toggl
+    class Error < StandardError; end
+
+    extend self
+
+    EXPECTED_ERRORS = [
+      # Filelock::ExecTimeout,
+      # Filelock::WaitTimeout,
+      # KeyError,
+      # Oj::Error,
+      # Oj::ParseError,
+      # Oj::DepthError,
+      # Oj::LoadError,
+      # ValueSemantics::MissingAttributes,
+    ].freeze
+
+    attr_writer :toggl_key, :luxafor_key, :state_file, :idle_time
+
+    def toggl_key
+      @toggl_key || ENV.fetch('TOGGL_KEY')
+    end
+
+    def luxafor_key
+      @luxafor_key || ENV.fetch('LUXAFOR_KEY')
+    end
+
+    def state_file
+      @state ||= ENV.fetch("LUXAFOR_TOGGL_STATE_FILE", "/tmp/#{Etc.getpwuid(Process.euid).name}-luxafor-toggl-state.json")
+    end
+
+    def idle_time
+      @idle_time ||= ENV.fetch("LUXAFOR_TOGGL_IDLE_TIME", 60 * 60 * 2).to_i # Default is 2 hours before you're idle
+    end
+
+    def toggl_client
+      @toggl_client ||= TogglV8::API.new(toggl_key)
+    end
+
+    def luxafor_client
+      @luxafor_client ||= Luxafor::Client.new(luxafor_key)
+    end
+  end
+end

data/lib/luxafor/toggl/client.rb

@@ -0,0 +1,43 @@
+module Luxafor
+  module Toggl
+    class Client
+      def initialize(toggl: Luxafor::Toggl.toggl_client, luxafor: Luxafor::Toggl.luxafor_client, state: Luxafor::Toggl::state_file)
+        @toggl      = toggl
+        @luxafor    = luxafor
+        @state_file = state
+      end
+
+      def execute!
+        return false unless current_state.sufficiently_different_from?(stored_state)
+
+        luxafor.on(current_state.colour)
+
+        current_state.store!(state_file)
+
+        true
+      end
+
+      private
+
+      attr_reader :toggl, :luxafor, :state_file
+
+      def latest_task
+        start         = DateTime.now - 1
+        @_latest_task = toggl.get_time_entries(start_date: start).last
+      end
+
+      def current_state
+        @_current_state ||= State.new_from_task(latest_task)
+      end
+
+      def stored_state
+        return State.new unless File.exist?(state_file)
+
+        file_contents = File.new(state_file).read.to_s
+        state_json    = Oj.load(file_contents)
+
+        State.new(state: state_json['state'], as_of: state_json['as_of'])
+      end
+    end
+  end
+end

data/lib/luxafor/toggl/state.rb

@@ -0,0 +1,92 @@
+module Luxafor
+  module Toggl
+    class State
+      DEFAULT_TIME = DateTime.parse('2000-01-01 00:00:00')
+
+      include ValueSemantics.for_attributes {
+        state    Symbol,   default: :idle,        coerce: true
+        as_of    DateTime, default: DEFAULT_TIME, coerce: true
+      }
+
+      def self.coerce_state(value)
+        value.to_sym
+      end
+
+      def self.coerce_as_of(value)
+        return value if value.is_a? DateTime
+
+        DateTime.parse(value)
+      end
+
+      def self.new_from_task(task)
+        instance = allocate
+
+        instance.initialize_from_task(task)
+        instance
+      end
+
+      def initialize_from_task(task)
+        @state = determine_state_from_task(task)
+        @as_of = determine_as_of_from_task(task)
+      end
+
+      def sufficiently_different_from?(other_state)
+        return true if @state != other_state.state
+
+        false
+      end
+
+      def colour
+        case state
+        when :idle
+          '000000'
+        when :busy
+          'FF0000'
+        when :available
+          '00FF00'
+        end
+      end
+
+      def store!(destination)
+        data = {
+          'state' => state,
+          'as_of' => as_of.to_s,
+        }
+
+        File.unlink(destination) if File.exist?(destination)
+
+        File.open(destination, 'w') do |f|
+          f.write(Oj.dump(data))
+        end
+      end
+
+      private
+
+      def determine_state_from_task(task)
+        return :idle if     task.nil?        # There is no latest task at all...
+        return :busy unless task.key? 'stop' # There's a task with no stop time, still in progress.
+
+        now        = DateTime.now.to_time.to_i
+        stopped_at = DateTime.parse(task['stop']).to_time.to_i
+
+        (now - stopped_at) >= Luxafor::Toggl.idle_time ? :idle : :available
+      end
+
+      def determine_as_of_from_task(task)
+        state = determine_state_from_task(task)
+
+        if state == :busy
+          DateTime.parse(task['start'])
+        elsif state == :available
+          DateTime.parse(task['stop'])
+        elsif state == :idle
+          return DEFAULT_TIME if task.nil?
+
+          DateTime.parse(task['stop'])
+        else
+          raise "Cannot determine as_of from task in state #{state}: #{task}"
+        end
+      end
+    end
+  end
+end

data/lib/luxafor/toggl/version.rb

@@ -0,0 +1,5 @@
+module Luxafor
+  module Toggl
+    VERSION = '1.0.0'.freeze
+  end
+end

data/luxafor-toggl.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "luxafor/toggl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "luxafor-toggl"
+  spec.version       = Luxafor::Toggl::VERSION
+  spec.authors       = ["Gabriel Fortuna"]
+  spec.email         = ["gabriel@zero-one.io"]
+
+  spec.summary       = "Integrate your Luxafor flag with your toggl account"
+  spec.description   = "A simple utility to integrate and sync your Toggl activity with your Luxafor flag"
+  spec.homepage      = "https://www.zero-one.io"
+  spec.licenses      = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/gee-forr/luxafor-toggl"
+  # spec.metadata["changelog_uri"]   = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'awesome_print', '~> 1'
+  spec.add_development_dependency 'bundler',       '~> 2.0'
+  spec.add_development_dependency 'pry',           '0.13.1'
+  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rspec',         '~> 3.0'
+
+  spec.add_dependency 'luxafor',         '~> 0.1.0'
+  spec.add_dependency 'oj',              '~> 3.10', '>= 3.10.6'
+  spec.add_dependency 'togglv8',         '~> 1.2',  '>= 1.2.1'
+  spec.add_dependency 'value_semantics', '~> 3.2'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: luxafor-toggl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Fortuna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: luxafor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+- !ruby/object:Gem::Dependency
+  name: togglv8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: value_semantics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A simple utility to integrate and sync your Toggl activity with your
+  Luxafor flag
+email:
+- gabriel@zero-one.io
+executables:
+- luxafor-toggl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/luxafor-toggl
+- lib/luxafor/toggl.rb
+- lib/luxafor/toggl/client.rb
+- lib/luxafor/toggl/state.rb
+- lib/luxafor/toggl/version.rb
+- luxafor-toggl.gemspec
+homepage: https://www.zero-one.io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.zero-one.io
+  source_code_uri: https://github.com/gee-forr/luxafor-toggl
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Integrate your Luxafor flag with your toggl account
+test_files: []