clockker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69851fff50f8e00c0fc78c209864330dee98e78130b7c982593545de6ad02687
+  data.tar.gz: 5850c706c8d88b03aa1f8c4acaf5e2a15eb3de7e53ac801d4f872591c3a35881
+SHA512:
+  metadata.gz: 79acd1ea6482332e3bbfe521fe6c060366393f4953b3cbe16854d53b60d4e08844ea81024161a5b7f70ce6c25e0557651d11a49c4c9255e5e0584b609b9cfdc7
+  data.tar.gz: 0d53068a16887be5090b7083e987964f59571fecc1c665847aeff8dc1864257e6774e479104c64552918d82bc8c578d826ca0488d3d06fe20d5771eb04bb36bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 paul@liquidmedia.ca. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clockker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Paul Doerwald
+
+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,76 @@
+# Clockker
+
+Clockker watches your macOS file system and submits any file changes to the Clockk web service. Learn more about Clockk at http://clockk.com.
+
+## Installation
+
+Install it with:
+
+    $ gem install clockker
+
+## Usage
+
+Run it with:
+
+    $ clockker watch <path>
+
+This will start the clockker executable in the foreground, and it will watch for file changes at <path>.
+
+Clockker takes several command-line options:
+
+`-t=x` / `--token=x`
+: sets the token for communication, as provided by Clockk. REQUIRED.
+
+`-v` / `--verbose`
+: sets verbosity. Default: `info`. Options (with `-v=` or `--verbose=`): `debug`, `info`, `warn`, `error`, `fatal`
+
+`-s=x` / `--submit-frequency=x`
+: upload changed files list to Clockk server every <x> seconds. Default: 300 seconds.
+
+`-w=x y z` / `--whitelist=x y z`
+: Space-separated list of absolute paths to watch. Defaults to your home directory (~).
+
+`-b=x y z` / `--blacklist=x y z`
+: Space-separated list of absolute paths to ignore that are undeneath your whitelisted paths. Defaults to ~/Library.
+
+Instead of using the command-line options, you can specify a default configuration in ~/.clockker, which is a JSON-formatted file. An example structure is:
+
+```json
+{
+  "version": "0.1.0",
+  "token": "asdfasdf",
+  "whitelist": [
+    "/Users/paul",
+    "/web"
+  ],
+  "blacklist": [
+    "/Users/paul/Library",
+    "/web/nordia"
+  ]
+}
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/liquidmedia/clockker. 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.
+
+Please note that this software is intended for use with the Clockk web service. It is released as open source for the following reasons:
+
+* To be as transparent as possible with software that runs on our users’ computers.
+* To be open to bug fixes from our user community.
+* To share some of the code (and the lessons we learn from it) that we develop internally with the wider community.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Clockker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clockker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clockker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/clockker.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "clockker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "clockker"
+  spec.version       = Clockker::VERSION
+  spec.authors       = ["Paul Doerwald"]
+  spec.email         = ["paul@clockk.com"]
+
+  spec.summary       = %q{Clockker aggregates and submits file system changes to the clockk.com web service.}
+  spec.description   = %q{Clockker aggregates and submits file system changes to the clockk.com web service.}
+  spec.homepage      = "https://github.com/liquidmedia/clockker"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'rb-fsevent', '>= 0.10.2'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+end

data/exe/clockker

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "clockker"
+require "clockker/cli"
+
+major, minor, patch = Clockker.macos_version
+if minor < 12
+  puts "Clockker can only run on macOS 10.12 (Sierra) or newer."
+  exit
+end
+
+Clockker::CLI.start

data/lib/clockker/cli.rb

@@ -0,0 +1,71 @@
+require 'thor'
+require 'logger'
+
+module Clockker
+  class CLI < Thor
+    hostname = `hostname`.strip
+    macaddrpart = `ifconfig` =~ /en0.*?(([A-F0-9]{2}:){5}[A-F0-9]{2})/im
+    macaddrpart = $1[2..4]
+    identifier = hostname+macaddrpart
+
+    desc "watch", "Start the Clockker watcher"
+    method_option :token, aliases: '-t', type: :string, desc: "REQUIRED Token for communicating to Clockk server, provided by Clockk"
+    method_option :region, aliases: '-r', type: :string, desc: "REQUIRED server region. e.g. ca-central, us-east, eu-frankfurt"
+    method_option :whitelist, aliases: '-w', type: :array, desc: "Space-separated list of absolute paths to watch. Defaults to your home directory (~)."
+    method_option :blacklist, aliases: '-b', type: :array, desc: "Space-separated list of absolute paths to ignore that are undeneath your whitelisted paths. Defaults to ~/Library."
+    method_option :identifier, aliases: '-i', type: :string, desc: "The identifier for this computer.", default: identifier
+    method_option :submit_frequency, aliases: '-s', default: 300, desc: "Submit changeset to Clockk server every N seconds", type: :numeric
+    method_option :verbose, aliases: '-v', default: 'fatal', lazy_default: 'info', enum: %w{debug info warn error fatal}, desc: "Set verbosity (default: info)"
+    def watch
+      logger = Logger.new(STDERR)
+      case options[:verbose]
+      when 'debug'
+        logger.level = Logger::DEBUG
+      when 'info'
+        logger.level = Logger::INFO
+      when 'warn'
+        logger.level = Logger::WARN
+      when 'error'
+        logger.level = Logger::ERROR
+      else # fatal and no preference
+        logger.level = Logger::FATAL
+      end
+      logger.debug "Setting verbosity to #{options[:verbose]}"
+      
+      # config_params = {}
+      # config_params[:submit_frequency] = options[:submit_frequency].to_i if options[:submit_frequency].present?
+      # config_params[:log_level] = options[:verbose] if options[:verbose].present?
+      # config_params[:token] = options[:token] if options[:token].present?
+      # config_params[:whitelist] = options[:whitelist] if options[:whitelist].present?
+      # config_params[:blacklist] = options[:blacklist] if options[:blacklist].present?
+
+      clockker_config = Clockker::Config.new(
+        submit_frequency: options[:submit_frequency].to_i,
+        log_level: options[:verbose],
+        identifier: options[:identifier]
+      )
+
+      clockker_config.token = options[:token] if options[:token]
+      clockker_config.region = options[:region] if options[:region]
+      clockker_config.whitelist = options[:whitelist] if options[:whitelist]
+      clockker_config.blacklist = options[:blacklist] if options[:blacklist]
+
+      if options[:token].nil? && clockker_config.token.nil?
+        puts "You must provide a value for the token, either as a parameter (--token=x) or in the ~/.clockker_config file."
+        exit
+      end
+
+      if options[:region].nil? && clockker_config.region.nil?
+        puts "You must provide a value for the server region (e.g. ca-central, us-east, eu-frankfurt, etc.), either as a parameter (--region=x) or in the ~/.clockker_config file."
+        exit
+      end
+
+      Clockker::Watcher.new(clockker_config, logger: logger)
+    end
+
+    desc "version", "Show Clockker version"
+    def version
+      puts Clockker.version_string
+    end
+  end
+end

data/lib/clockker/config.rb

@@ -0,0 +1,28 @@
+require 'JSON'
+
+module Clockker
+  class Config
+    attr_accessor :whitelist, :blacklist, :config_version, :token, :region, :identifier, :submit_frequency, :log_level
+    def initialize(overrides = {})
+      if File.exists?(File.join(Dir.home, '.clockker'))
+        clockker_config = JSON.parse(File.read(File.join(Dir.home, '.clockker')))
+      else
+        clockker_config = '{}'
+      end
+
+      # Set values from clockker_config
+      @whitelist = clockker_config["whitelist"]
+      @blacklist = clockker_config["blacklist"]
+      @config_version = clockker_config["version"]
+      @token = clockker_config["token"]
+      @region = clockker_config["region"]
+      @submit_frequency = clockker_config["submit_frequency"]
+      @log_level = clockker_config["log_level"]
+
+      # override values specified at the command line
+      overrides.each do |key, value|
+        instance_variable_set "@#{key}".to_sym, value
+      end
+    end
+  end
+end

data/lib/clockker/version.rb

@@ -0,0 +1,17 @@
+module Clockker
+  VERSION = "0.1.0"
+
+  def self.macos_version
+    @mov ||= `sw_vers -productVersion`
+    major, minor, patch = @mov.split('.').map{|x| x.to_i}
+    return [major, minor, patch]    
+  end
+
+  def self.version_string
+    "Clockker #{Clockker::VERSION} on macOS #{Clockker.macos_version.join('.')}"
+  end
+
+  def self.version
+    ["Clockker", Clockker::VERSION, "macOS", Clockker.macos_version.join('.')].join(' ')
+  end
+end

data/lib/clockker/watcher.rb

@@ -0,0 +1,97 @@
+require 'rb-fsevent'
+require 'logger'
+require 'net/http'
+
+module Clockker
+  class Watcher
+    def initialize(config, logger: Logger.new)
+      Thread.abort_on_exception = true
+
+      trap "INT" do
+        @fsevent.stop
+        # @watcher.kill  # this also works, but the former is a bit more elegant
+        @queue << :exit  # this shuts down the submitter, first letting it submit its changeset
+      end
+
+      white_black_list = WhiteBlackList.new(config)
+
+      @queue = Queue.new
+      @watcher = Thread.new { create_watcher('/', white_black_list, logger) }
+      @submitter = Thread.new { create_submitter(config.submit_frequency, config.region, config.token, config.identifier, logger) }
+      
+      @watcher.join
+      @submitter.join
+    end
+
+    def create_watcher(dir, white_black_list, logger)
+      @fsevent = FSEvent.new
+      @fsevent.watch dir, {file_events: true} do |directories, event_meta|
+        t = Time.now.utc
+        count = 0
+        event_meta['events'].each do |event|
+          next if white_black_list.ignore?(event['path'])
+          count += 1
+          @queue << {created_at: t, event_id: event['id'], filepath: event['path'], flags: event['flags']}
+        end
+        logger.debug "#{Time.now} checked #{event_meta['numEvents']} events and added #{count} to the queue"
+      end
+      logger.info "#{Time.now} now watching /"
+      logger.info "#{Time.now} whitelist paths: #{white_black_list.whitelist}"
+      logger.info "#{Time.now} blacklist paths: #{white_black_list.blacklist}"
+      @fsevent.run
+      logger.info "#{Time.now} fswatcher done"
+    end
+
+    def create_submitter(submit_frequency, region, token, identifier, logger)
+      logger.info "#{Time.now} submitting to clockk.com every #{submit_frequency} seconds with token #{token} from identifier #{identifier} with version #{Clockker.version}"
+      t_start = Time.now
+      clockk_agent_uri = URI("https://#{region}.clockk.io/api/v1/agent/artifacts")
+      @changeset = []
+      loop do
+        submit_now = false
+        exit_now = false
+
+        value = @queue.pop
+        case value
+        when :submit
+          submit_now = true
+        when :exit
+          submit_now = true
+          exit_now = true
+        else
+          @changeset << value
+        end
+
+        if Time.now - t_start > submit_frequency
+          submit_now = true
+        end
+
+        if exit_now
+          logger.info "#{Time.now} preparing to exit"
+        end
+
+        if submit_now
+          logger.info "#{Time.now} submitting #{@changeset.length} items to the Clockk server using token #{token}"
+          @changeset.each_with_index do |cs, idx|
+            logger.debug "#{Time.now} changeset #{idx}: #{cs.inspect}"
+          end
+
+          begin
+            res = Net::HTTP.post(clockk_agent_uri, {artifacts: @changeset.map{|c| {file_path: c[:filepath], touched_at: c[:created_at].strftime("%Y-%m-%d %H:%M:%S"), identifier: identifier, agent: Clockker.version}}}.to_json, {"Authorization" => "Bearer #{token}", "Content-Type" => "application/json"})
+            @changeset = []
+          rescue Exception => e
+            logger.info "#{Time.now} Reached exception #{e}"
+          end
+
+          t_start = Time.now
+        end
+
+        if exit_now
+          logger.info "#{Time.now} exiting"
+          break
+        end
+      end
+    end
+
+  end
+end

data/lib/clockker/white_black_list.rb

@@ -0,0 +1,28 @@
+require 'JSON'
+
+module Clockker
+  class WhiteBlackList
+    # whitelist_path should return an array of absolute paths that are to be watched and reported to the clockk server.
+
+    # blacklist_path should return an array of absolute paths that are to be ignored. Implicitly any path that isn't whitelisted is blacklisted; this method is only useful if it returns subpaths of whitelisted paths. i.e. /Users/paul/Documents is whitelisted, but /Users/paul/Documents/customers/Bell is blacklisted.
+    attr_accessor :whitelist, :blacklist
+
+    def initialize(clockker_config)
+      @whitelist = clockker_config.whitelist
+      @blacklist = clockker_config.blacklist
+
+      # Now set defaults in the absence of a config file
+      @whitelist ||= [ Pathname.new(Dir.home) ]
+      @blacklist ||= [ Pathname.new(File.join(Dir.home, 'Library')) ]
+    end
+
+    def ignore?(filepath)
+      file_matches_whitelist = @whitelist.any? {|wl| filepath =~ Regexp.new(wl)}
+      file_matches_blacklist = @blacklist.any? {|bl| filepath =~ Regexp.new(bl)}
+      return true if file_matches_blacklist
+      return false if file_matches_whitelist
+      return true
+    end
+
+  end
+end

data/lib/clockker.rb

@@ -0,0 +1,9 @@
+require "clockker/version"
+require 'clockker/cli'
+require 'clockker/watcher'
+require 'clockker/config'
+require 'clockker/white_black_list'
+
+module Clockker
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: clockker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Doerwald
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Clockker aggregates and submits file system changes to the clockk.com
+  web service.
+email:
+- paul@clockk.com
+executables:
+- clockker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clockker.gemspec
+- exe/clockker
+- lib/clockker.rb
+- lib/clockker/cli.rb
+- lib/clockker/config.rb
+- lib/clockker/version.rb
+- lib/clockker/watcher.rb
+- lib/clockker/white_black_list.rb
+homepage: https://github.com/liquidmedia/clockker
+licenses:
+- MIT
+metadata: {}
+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: Clockker aggregates and submits file system changes to the clockk.com web
+  service.
+test_files: []