gigawatt 1.0.0

data/lib/gigawatt/commands/setup.rb

@@ -0,0 +1,107 @@
+module Gigawatt
+  module Commands
+    class Setup
+      attr_accessor :options
+
+      def self.run!(settings)
+        options = Trollop::options do
+          banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+This command will request an access token, giving the command line utility access to your 88 Miles account.
+
+To do this, you will be asked for your 88 Miles login and password. Please note that the login and password will not be saved.
+
+Usage
+  88miles setup [options]
+
+options:
+          EOS
+          opt :force, "Override existing settings", :default => false, :type => :boolean
+        end
+
+        instance = self.new(settings, options)
+
+        if instance.settings_exists?
+          puts "The settings file #{instance.settings.path} already exists. Use --force to overwrite"
+          return SETTINGS_FILE_EXISTS
+        end
+
+        instance.preamble
+
+        begin
+          instance.authenticate
+        rescue OAuth2::Error => e
+          puts "There was an issue authenticating your account. Please try again."
+          return INVALID_OAUTH_TOKEN_EXIT_CODE
+        end
+        instance.postamble
+
+        return OK_EXIT_CODE
+      end
+
+      def initialize(settings, options)
+        @options = options
+        @settings = settings
+      end
+
+      def settings
+        @settings
+      end
+
+      def settings_exists?
+        return false if options[:force]
+        @settings.setup?
+      end
+
+      def preamble
+        say("88 Miles command line utility setup")
+        say("-----------------------------------")
+        say("To setup the 88 Miles command line utility, we need to authenticate you and request an access token.")
+        say("We will open a browser, where you will be asked to login and approve access to this app.")
+      end
+
+      def postamble
+        say("Thank you. We can now access your account. You can now initialize a directory by running <%= color('88miles init [directory]', BOLD) %>")
+      end
+
+      def get_access_key(url)
+        uri = URI(url)
+        token = uri.fragment.split('&').map{ |kv| kv.split('=') }.delete_if{ |kv| kv[0] != 'access_token' }.first
+        return token[1] if token
+        return nil
+      end
+
+      def authenticate
+        client = Gigawatt::OAuth.client
+
+        redirect_uri = Gigawatt::OAuth.redirect_uri
+        url = client.auth_code.authorize_url(:response_type => 'token', :redirect_uri => redirect_uri)
+
+        Launchy.open(url) do |exception|
+          say "Couldn't open a browser. Please paste the following URL into a browser"
+          say url
+        end
+
+        say("After you have completed the approval process, cut and paste the URL you are redirected to.")
+        access_key = get_access_key(ask("URL: ") do |url|
+          url.validate = /\A#{redirect_uri}#access_token=.+&state=\Z/
+          url.responses[:not_valid] = "That URL doesn't look right. It should look like: #{redirect_uri}#access_token=[some characters]&state="
+        end)
+
+        @settings.access_key = access_key
+        @access_key = OAuth.token(access_key)
+
+        cache = Gigawatt::Cache.new(@settings, @access_key)
+
+        cache.refresh!
+
+        @settings.companies = cache.companies
+        @settings.projects = cache.projects
+
+        @settings.write(:accesskey)
+        @access_key.token
+      end
+    end
+  end
+end

data/lib/gigawatt/commands/start.rb

@@ -0,0 +1,75 @@
+module Gigawatt
+  module Commands
+    class Start
+      attr_accessor :options
+
+      def self.run!(settings)
+        options = Trollop::options do
+          banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+Punch into the project.
+
+Usage
+  88miles start [options]
+
+options:
+          EOS
+
+
+          opt :activity, "Select an activity", :type => :flag
+        end
+
+        instance = self.new(settings, options)
+        begin
+          return instance.punch_in
+        rescue OAuth2::Error => e
+          say "Access to your 88 Miles may have been revoked. Please run <%= color('88miles setup', BOLD) %> again."
+          return INVALID_OAUTH_TOKEN_EXIT_CODE
+        end
+      end
+
+      def initialize(settings, options)
+        @settings = settings
+        @options = options
+
+        @access_key = OAuth.token(@settings.access_key)
+        @cache = Cache.new(settings, @access_key)
+      end
+
+      def select_activity(project)
+        return nil unless options[:activity]
+        return nil unless project["activities"]
+
+        selected = nil
+        choose do |menu|
+          menu.prompt = "Pick an Activity"
+          project["activities"].each do |activity|
+            menu.choice("#{activity["name"]}") { selected = activity }
+          end
+        end
+        selected
+      end
+
+      def punch_in
+        project = Gigawatt::ProjectFile.new.project
+
+        if project
+          activity = select_activity(project)
+          opts = {}
+          opts = { :body => { :activity_uuid => activity["uuid"] } } if activity
+          response = JSON.parse(@access_key.post("/api/1/projects/#{project["uuid"]}/punch_in.json", opts).body)
+          current = response["response"]
+          ProjectFile.write(current)
+
+          company = @cache.companies(true)[project["company_uuid"]]
+          say("Punched in to #{company["name"]}: #{project["name"]}")
+          return OK_EXIT_CODE
+        else
+          say("No project found. Did you remember to run <%= color('88miles init [directory]', BOLD) %>?")
+          return NO_PROJECT_EXIT_CODE
+        end
+      end
+    end
+  end
+end

data/lib/gigawatt/commands/status.rb

@@ -0,0 +1,101 @@
+module Gigawatt
+  module Commands
+    class Status
+      attr_accessor :options
+
+      def self.run!(settings)
+        options = Trollop::options do
+          banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+Get status about the linked project
+
+Usage:
+  88miles status [options]
+
+options:
+          EOS
+
+          opt :sync, "Sync the data from the server first. Uses the cache if false", :type => :flag
+          opt :foreground, "Don't exit - just refresh the timer", :type => :flag
+          opt :time, "Only return the time", :type => :flag
+        end
+
+        instance = self.new(settings, options)
+        return instance.get_settings
+      end
+
+      def initialize(settings, options)
+        @settings = settings
+        @options = options
+
+        @access_key = OAuth.token(@settings.access_key)
+        @cache = Cache.new(settings, @access_key)
+
+        @project = Gigawatt::ProjectFile.new.project
+      end
+
+      def get_settings
+        unless @project
+          say("No project found.")
+          return NO_PROJECT_EXIT_CODE
+        end
+
+        if @options[:sync]
+          sync = Gigawatt::Commands::Sync.new(@settings, @options)
+          begin
+            sync.sync
+            sync.sync_current
+          rescue OAuth2::Error => e
+            say "Access to your 88 Miles may have been revoked. Please run <%= color('88miles setup', BOLD) %> again."
+            return INVALID_OAUTH_TOKEN_EXIT_CODE
+          end
+        end
+
+        if @options[:foreground]
+          while(1)
+            print_status
+            sleep(1)
+          end
+          print "\n"
+        else
+          print_status
+          print "\n"
+        end
+
+        return OK_EXIT_CODE
+      end
+
+      def print_status
+        company = @cache.companies(true)[@project["company_uuid"]]
+
+        grand_total = @project["grand_total"]
+        grand_total += (Time.now.to_i - @project["started_at"]) if @project["running"]
+        overdue = grand_total > @project["time_limit"] if @project["time_limit"]
+
+        clock_string = to_clock_s(grand_total, true)
+        clock_string = " [#{HighLine::String.new(clock_string).red}]" if overdue
+
+        str = ""
+        if @options[:time]
+           str = clock_string
+        else
+          str += "#{company["name"]}: #{@project["name"]}"
+          str += " [#{clock_string}]"
+          str += " #{HighLine::String.new("Running").green}" if @project["running"]
+        end
+
+        print "\e[0K\r#{str}" if @options[:foreground]
+        print str unless @options[:foreground]
+      end
+
+      def to_clock_s(time, show_seconds = false)
+        hour = (time.abs / 3600).floor
+        minute = (time.abs / 60 % 60).floor
+        seconds = (time.abs % 60).floor if show_seconds
+
+        return (time != 0 && (time / time.abs) == -1 ? "-" : "") + hour.to_s.rjust(2, '0') + ":" + minute.to_s.rjust(2, '0') + (show_seconds ? ":" + seconds.to_s.rjust(2, '0') : '')
+      end
+    end
+  end
+end

data/lib/gigawatt/commands/stop.rb

@@ -0,0 +1,57 @@
+module Gigawatt
+  module Commands
+    class Stop
+      attr_accessor :options
+
+      def self.run!(settings)
+        options = Trollop::options do
+          banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+Punch out of the project.
+
+Usage
+  88miles stop [options]
+
+options:
+          EOS
+          opt :notes, "Save notes against the shift", :type => :string
+          opt :tags, "Allocate tags to the shift", :type => :string
+        end
+
+        instance = self.new(settings, options)
+        begin
+          return instance.punch_out
+        rescue OAuth2::Error => e
+          say "Access to your 88 Miles may have been revoked. Please run <%= color('88miles setup', BOLD) %> again."
+          return INVALID_OAUTH_TOKEN_EXIT_CODE
+        end
+      end
+
+      def initialize(settings, options)
+        @settings = settings
+        @options = options
+
+        @access_key = OAuth.token(@settings.access_key)
+        @cache = Cache.new(settings, @access_key)
+      end
+
+      def punch_out
+        project = Gigawatt::ProjectFile.new.project
+
+        if project
+          response = JSON.parse(@access_key.post("/api/1/projects/#{project["uuid"]}/punch_out.json", { :params => { :notes => options.notes.to_s } }).body)
+          current = response["response"]
+          ProjectFile.write(current)
+
+          company = @cache.companies(true)[project["company_uuid"]]
+          say("Punched out of #{company["name"]}: #{project["name"]}")
+          return OK_EXIT_CODE
+        else
+          say("No project found. Did you remember to run <%= color('88miles init [directory]', BOLD) %>?")
+          return NO_PROJECT_EXIT_CODE
+        end
+      end
+    end
+  end
+end

data/lib/gigawatt/commands/sync.rb

@@ -0,0 +1,53 @@
+module Gigawatt
+  module Commands
+    class Sync
+      attr_accessor :options
+
+      def self.run!(settings)
+        options = Trollop::options do
+          banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+88 Miles caches your company and project list to speed things up. Run this command if you add, edit or remove companies or projects
+
+If run inside a directory with a linked project, the linked project will be updated too
+
+Usage
+  88miles sync
+        EOS
+        end
+
+        instance = self.new(settings, options)
+        begin
+          instance.sync
+          instance.sync_current
+        rescue OAuth2::Error => e
+          say "Access to your 88 Miles may have been revoked. Please run <%= color('88miles setup', BOLD) %> again."
+          return INVALID_OAUTH_TOKEN_EXIT_CODE
+        end
+
+        return 0
+      end
+
+      def initialize(settings, options)
+        @settings = settings
+        @options = options
+
+        @access_key = OAuth.token(@settings.access_key)
+        @cache = Cache.new(settings, @access_key)
+      end
+
+      def sync
+        @cache.refresh!
+      end
+
+      def sync_current
+        project = Gigawatt::ProjectFile.new.project
+        if project
+          response = JSON.parse(@access_key.get("/api/1/projects/#{project["uuid"]}.json").body)
+          ProjectFile.write(response["response"])
+        end
+      end
+    end
+  end
+end

data/lib/gigawatt/oauth.rb

@@ -0,0 +1,23 @@
+module Gigawatt
+  class OAuth
+    def self.client
+      if ENV['ENV'] == 'development'
+        client = OAuth2::Client.new('NjtVKz6Di3ccJjn2AGwZKhSxYBX4QHPJ5w1LrZOR', nil, :site => 'http://localhost:3000')
+      else
+        client = OAuth2::Client.new('hhWZrEF6YTlPUKrggiesnjXAFViLa8FBZNNUtr8L', nil, :site => 'https://88miles.net')
+      end
+    end
+
+    def self.token(token)
+      OAuth2::AccessToken.new(self.client, token)
+    end
+
+    def self.redirect_uri
+      if ENV['ENV'] == 'development'
+        "http://localhost:3000/oauth/authorized"
+      else
+        "https://88miles.net/oauth/authorized"
+      end
+    end
+  end
+end

data/lib/gigawatt/options.rb

@@ -0,0 +1,53 @@
+module Gigawatt
+  class Options
+    SUB_COMMANDS = %w(setup init start stop sync status log)
+
+    def self.parse!
+      version_string = File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).strip
+
+      options = Trollop::options do
+        version "88miles #{version_string}"
+        stop_on SUB_COMMANDS
+        banner <<-EOS
+88 Miles Command line application - http://88miles.net
+
+Usage:
+  88miles [globaloptions] <subcommand> [options]
+
+subcommands:
+  setup:  Link your 88 Miles account to this program
+  init:   Link a project to a directory
+  start:  Punch in to the linked project
+  stop:   Punch out of the linked project
+  sync:   Refresh the local cache from the server
+  status: Show the project timer
+  log:    Print out the project shifts
+
+globaloptions:
+        EOS
+        opt :settings, "Path to store 88 Miles settings", :default => Settings.defaults[:path], :type => :string
+      end
+
+      settings = Settings.new(options)
+      cmd = ARGV.shift.strip
+      case cmd
+      when "setup"
+        Gigawatt::Commands::Setup.run!(settings)
+      when "init"
+        Gigawatt::Commands::Init.run!(settings)
+      when "start"
+        Gigawatt::Commands::Start.run!(settings)
+      when "stop"
+        Gigawatt::Commands::Stop.run!(settings)
+      when "sync"
+        Gigawatt::Commands::Sync.run!(settings)
+      when "status"
+        Gigawatt::Commands::Status.run!(settings)
+      when "log"
+        Gigawatt::Commands::Log.run!(settings)
+      else
+        Trollop::die "Unknown subcommand #{cmd.inspect}"
+      end
+    end
+  end
+end

data/lib/gigawatt/project_file.rb

@@ -0,0 +1,34 @@
+module Gigawatt
+  class ProjectFile
+    def find_the_dotfile(dir = Dir.pwd)
+      file = File.join(dir, ProjectFile.filename)
+      if File.exists?(file)
+        return File.join(file)
+      else
+        parts = dir.split(File::SEPARATOR)[0..-2]
+        if parts.length == 0
+          return nil
+        else
+          return find_the_dotfile(File.join(parts))
+        end
+      end
+    end
+
+    def project
+      dotfile = find_the_dotfile
+      if dotfile
+        YAML.load_file(dotfile)
+      else
+        nil
+      end
+    end
+
+    def self.write(project)
+      File.write(File.join(Dir.pwd, ProjectFile.filename), project.to_hash.to_yaml)
+    end
+
+    def self.filename
+      ".88miles"
+    end
+  end
+end

data/lib/gigawatt/settings.rb

@@ -0,0 +1,41 @@
+module Gigawatt
+  class Settings
+    attr_accessor :access_key, :projects, :companies, :staff
+
+    def initialize(options = {})
+      @options = Settings.defaults.merge(options)
+      read if setup?
+    end
+
+    def self.defaults
+      {
+        :path => File.join(Dir.home, '.88miles')
+      }
+    end
+
+    def setup?
+      File.exists?(path) && File.directory?(path)
+    end
+
+    def path
+      @options[:path]
+    end
+
+    def read
+      self.access_key = YAML.load_file(File.join(path, 'accesskey')) if File.exists?(File.join(path, 'accesskey'))
+      self.companies = YAML.load_file(File.join(path, 'companies')) if File.exists?(File.join(path, 'companies'))
+      self.projects = YAML.load_file(File.join(path, 'projects')) if File.exists?(File.join(path, 'projects'))
+      self.staff = YAML.load_file(File.join(path, 'staff')) if File.exists?(File.join(path, 'staff'))
+    end
+
+    def write(type)
+      # Make the directory if it doesn't exist
+      FileUtils.mkdir_p(path) unless File.exists?(path)
+      File.write(File.join(path, 'accesskey'), self.access_key.to_yaml) if type == :accesskey
+      File.write(File.join(path, 'companies'), self.companies.to_yaml) if type == :companies
+      File.write(File.join(path, 'projects'), self.projects.to_yaml) if type == :projects
+      File.write(File.join(path, 'staff'), self.staff.to_yaml) if type == :staff
+      FileUtils.chmod 0700, path
+    end
+  end
+end

data/lib/gigawatt.rb

@@ -0,0 +1,29 @@
+require 'trollop'
+require 'highline/import'
+require 'oauth2'
+require 'fileutils'
+require 'json'
+require 'open-uri'
+require 'terminal-table'
+require 'launchy'
+
+require File.join(File.dirname(__FILE__), 'gigawatt', 'cache')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'settings')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'project_file')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'application')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'oauth')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'options')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'setup')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'init')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'start')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'stop')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'sync')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'status')
+require File.join(File.dirname(__FILE__), 'gigawatt', 'commands', 'log')
+
+module Gigawatt
+  NO_PROJECT_EXIT_CODE = 3
+  SETTINGS_FILE_EXISTS = 2
+  INVALID_OAUTH_TOKEN_EXIT_CODE = 1
+  OK_EXIT_CODE = 0
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gigawatt'
+
+class Test::Unit::TestCase
+end

data/test/test_gigawatt.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGigawatt < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end