frecli 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa2a056d45476409699fa4a851d0cf52f70484bb
-  data.tar.gz: 4322731614f81187010f2a5fe85c819278c2f3cf
+  metadata.gz: 16f3a566c8afc7aab09f9214e42ac57d5ab0e247
+  data.tar.gz: 6e49c3f9e9b561da01918ac677e1f5e36dffd7d2
 SHA512:
-  metadata.gz: b954dcfcbee6b3f9f7c82f1f57230c974ca594cf889a30c6b058416ddce7c5d0b9bc2baf8c9a4d41a9460e7603d60c88291f827a1b6a543b26cd6f3451afe805
-  data.tar.gz: 25822400a7b82abef2cb660251d68af0f53af1c4f73afd6d797b9383dd2f7c4397195bdd9c5b268c160d1969e6773b452be19387b8ec2b7d4722050283da5e86
+  metadata.gz: a14af37475312f06d8582ca8997616099ec3f2feb3c340140a3e88ec3ad61f920d46fb6400c0b6bc395bacd032d7583dc9ea955cb0955b7a46bda4f1eb40d91d
+  data.tar.gz: 5bd67c5fc7417e1ea33188eaf04007fa12962eab01529d84e98a850d7a438d880dd4b6d9e026222580c99488fcc0d253352fdbd58a11917d662ce9d302843c6a

data/README.md

@@ -7,15 +7,49 @@ Freckle CLI client in Ruby.
 [![Code Climate](https://codeclimate.com/github/shkm/frecli/badges/gpa.svg)](https://codeclimate.com/github/shkm/frecli)
 [![Test Coverage](https://codeclimate.com/github/shkm/frecli/badges/coverage.svg)](https://codeclimate.com/github/shkm/frecli/coverage)
 
-## What it does right now
+## What you can do with it right now
 
-This is still very basic and in development, but some functionality works. I'm working on both this and the API client behind it ([freckle-api](https://github.com/shkm/freckle-api)) consecutively.
+- Basic time tracking (start, pause, log)
 
+I'd eventually like FreCLI to be a real alternative UI for interacting with Freckle, but have had to scale it down in the short-term due to time constraints. Currently, I'd like to get basic time tracking and logging nailed, as that's the most interesting functionality to me and those around me.
 
-### Projects
+Having said that, I do intend to implement considerably more features. Also note that I'm working on the API client behind this, [freckle-api](https://github.com/shkm/freckle-api), as FreCLI is developed.
 
-- `projects` lists all projects available to you
-- `project ID` list the given project's attributes by its ID.
+
+## Commands
+
+### `frecli time`
+
+Presents you with a list of projects. Simply enter the number of the project you'd like to time, and away you go.
+
+### `frecli status`
+
+Displays the time on the running timer, if there is one.
+
+### `frecli pause`
+
+Pauses the running timer.
+
+### `frecli log [description]`
+
+Logs the current timer, adding a description if one is given.
+
+
+## TODO
+
+- Daily report (time logged, unlogged, total)
+- More specs
+- Log timers of other projects
+- Deal with exceptions / errors
+- Project selection via settings
+- Caching
+- Expanded reports (e.g. weekly, monthly, with natural time parsing)
+- Various report outputs (e.g. stdout, csv, html)
+- Administrative features
+  - Project management
+  - Invoices
+  - Tags
+  - Reports for other users
 
 ## Configuration
 
@@ -80,5 +114,5 @@ fi
 ```
 
 ## Thanks
-- My work, [Lico Innovations](http://lico.nl/) for using Freckle :-)
+- My work, [Lico Innovations](http://lico.nl/) for using Freckle and employing the coolest kids in town (I'm the exception).
 - The awesome Freckle developers — Thomas Cannon in particular — who shared interest in this project and even gave me a free account for testing!

data/bin/frecli

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'gli'
-require 'frecli/table'
 require 'frecli'
 
 include GLI::App
@@ -14,102 +13,37 @@ version Frecli::VERSION
 subcommand_option_handling :normal
 arguments :strict
 
-desc 'Manage projects'
-command [:project, :projects, :p] do |c|
-  c.desc 'List all projects'
-  c.command [:all, :a] do |all|
-    all.action do
-      puts Frecli::Table.vertical(
-        Frecli.projects,
-        [ 'ID', 'Name', 'Date created', 'Date updated' ],
-        [ :id, :name, :created_at, :updated_at ]
-      )
-    end
+desc 'Shows the current timing status'
+command :status do |c|
+  c.action do
+    Frecli::Cli.status
   end
-
-  c.desc 'Show a project'
-  c.arg :id, :required
-  c.command [:show, :s] do |show|
-    show.action do |_, _, args|
-      id = args[0]
-
-      puts Frecli::Table.horizontal(
-        Frecli.project(id),
-        { ID: :id,
-          Name: :name,
-          Minutes: :minutes }
-      )
-    end
-  end
-
-  c.desc 'Show the currently timed project'
-  c.command [:current, :c] do |current|
-    current.action do
-
-      # TODO: DRY
-      puts Frecli::Table.horizontal(
-        Frecli.project_current,
-        { ID: :id,
-          Name: :name,
-          Minutes: :minutes }
-      )
-    end
-  end
-
-  c.default_command :current
 end
 
-desc 'Manage timers'
-command [:timer, :timers, :t] do |c|
-  c.desc 'List all timers'
-  c.command [:all, :a] do |all|
-    all.action do
-      puts Frecli::Table.vertical(
-        Frecli.timers,
-        [ 'Project ID', 'State', 'Time', 'Date' ],
-        [ -> (timer) { timer.project.id }, :state, :formatted_time, :date ]
-      )
-    end
+desc 'Times a project'
+command :time do |c|
+  c.action do
+    Frecli::Cli.time
   end
+end
 
-  c.desc 'Show a timer'
-  c.arg :id, :required
-  c.command [:show, :s] do |show|
-    show.action do |_, _, args|
-      project_id = args[0]
-
-
-      # TODO: DRY
-      puts Frecli::Table.horizontal(
-        Frecli.timer(project_id),
-        { ID: :id,
-          State: :state,
-          Time: :formatted_time,
-          Description: :description }
-      )
-    end
+desc 'Pauses the running timer'
+command :pause do |c|
+  c.action do
+    Frecli::Cli.pause
   end
+end
 
-  c.desc 'Show the current timer'
-  c.command [:current, :c] do |current|
-    current.action do
+desc 'Logs the running timer'
+arg_name 'description', :optional
+command :log do |c|
+  c.action do |_, _, args|
+    description = args.shift.to_s
 
-      # TODO: DRY
-      puts Frecli::Table.horizontal(
-        Frecli.timer_current,
-        { ID: :id,
-          State: :state,
-          Time: :formatted_time,
-          Description: :description }
-      )
-    end
+    Frecli::Cli.log(description)
   end
-
-  c.default_command :current
 end
 
-
-
 pre do |global,command,options,args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the

data/lib/frecli.rb

@@ -1,6 +1,8 @@
 require 'frecli/version.rb'
 require 'frecli/settings.rb'
 require 'frecli/queries.rb'
+require 'frecli/cli.rb'
+
 require 'freckle_api'
 require 'json'
 

data/lib/frecli/cli.rb

@@ -0,0 +1,69 @@
+class Frecli
+  module Cli
+    def self.status
+      timer = Frecli.timer_current
+
+      if timer
+        puts "Timer running on #{timer.project.name} (#{timer.formatted_time})."
+      else
+        puts "No timer running."
+      end
+    end
+
+    def self.time
+      projects = Frecli.projects.sort { |x, y| x.name <=> y.name }
+
+      puts "Select a project to time:\n\n"
+
+      projects.each_with_index do |project, i|
+        puts "[#{i + 1}] #{project.name}"
+      end
+
+      print "\n\nProject: "
+
+      selection = STDIN.gets.chomp.to_i
+
+      unless (1..projects.count).include? selection
+        puts "Project invalid."
+
+        return
+      end
+
+      project = projects[selection - 1]
+      timer = Frecli.timer_start(project)
+
+      puts "Now timing #{project.name} (#{timer.formatted_time})."
+    end
+
+    def self.pause
+      timer = Frecli.timer_current
+
+      unless timer
+        puts 'No timer running.'
+        return
+      end
+
+      if Frecli.timer_pause(timer)
+        puts "Paused #{timer.project.name} (#{timer.formatted_time})."
+      else
+        puts 'Could not pause timer.'
+      end
+    end
+
+    def self.log(description = '')
+      timer = Frecli.timer_current
+
+      unless timer
+        puts 'No timer running.'
+        return
+      end
+
+      if Frecli.timer_log(timer, description)
+        puts "Logged #{timer.project.name} (#{timer.formatted_time})."
+        puts %Q("#{description}") unless description.empty?
+      else
+        puts 'Could not log timer.'
+      end
+    end
+  end
+end

data/lib/frecli/queries.rb

@@ -9,15 +9,6 @@ class Frecli
         @api = FreckleApi.new(Settings[:api_key])
       end
 
-      # The project which is currently being timed.
-      def project_current
-        project_id = timer_current.project.id
-
-        # TODO: use a reload method instead.
-        sleep 0.5
-        project(project_id)
-      end
-
       def projects
         api.projects
       end
@@ -26,18 +17,31 @@ class Frecli
         api.project(id)
       end
 
+      def timers
+        api.timers
+      end
+
+      def timer_log(timer, description = nil)
+        timer.log!(api, description: description)
+      end
+
+      def timer(project_id = nil)
+        api.timer(project_id) || timer_current
+      end
+
       def timer_current
         timers.detect { |timer| timer.state == :running }
       end
 
-      def timers
-        api.timers
+      def timer_start(project)
+        FreckleApi::Timer.new(project: project).tap do |timer|
+          timer.start!(api)
+        end
       end
 
-      def timer(project_id)
-        api.timer(project_id)
+      def timer_pause(timer)
+        timer.pause!(api)
       end
-
     end
   end
 end

data/lib/frecli/version.rb

@@ -1,3 +1,3 @@
 class Frecli
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frecli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jamie Schembri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,34 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
-- !ruby/object:Gem::Dependency
-  name: terminal-table
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: freckle-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.6
 description: 
 email: jamie@schembri.me
 executables:
@@ -162,9 +148,9 @@ files:
 - bin/frecli
 - frecli.rdoc
 - lib/frecli.rb
+- lib/frecli/cli.rb
 - lib/frecli/queries.rb
 - lib/frecli/settings.rb
-- lib/frecli/table.rb
 - lib/frecli/version.rb
 - spec/frecli/frecli_spec.rb
 - spec/frecli/settings_spec.rb

data/lib/frecli/table.rb

@@ -1,61 +0,0 @@
-require 'terminal-table'
-
-class Frecli
-  module Table
-    # Table where heading is in the first row,
-    # and values are in the columns
-    #
-    # When records  =  [ { id: 1, name: 'Hello', body: 'Hello, world!' } ]
-    #      headings =  'ID', 'Name', 'Body']
-    #      values   =  [ :id, :name, :body]
-    # +----------------------------+
-    # | ID | Name  | Body          |
-    # +----------------------------+
-    # | 1  | Hello | Hello, world! |
-    # +----------------------------+
-    def self.vertical(records, headings, values)
-      Terminal::Table.new do |table|
-
-        table.headings = headings
-        table.rows = records.map do |record|
-          values.map { |value| table_item(record, value)}
-        end
-      end
-    end
-
-    # Table where heading is in the first column,
-    # and value in the second.
-    #
-    # When records = [ { id: 1, name: 'Hello', body: 'Hello, world!' } ]
-    #      items   = [ { ID: :id, Name: :name, Body: :body } ]
-    # +----------------------+
-    # | ID   | 1             |
-    # | Name | Hello         |
-    # | Body | Hello, world! |
-    # +----------------------+
-    def self.horizontal(record, items)
-      Terminal::Table.new do |table|
-        table.rows = items.map do |name, value|
-          [name, table_item(record, value)]
-        end
-      end
-    end
-
-    # When record = { id: 1, name: 'Hello', body: 'Hello, world!' }
-    #
-    #      value  = :id
-    #            => 1
-    #
-    #      value  = -> (record) { record.name.upcase }
-    #            => 'HELLO'
-    #
-    #      value  = 'foo'
-    #            => 'foo'
-    def self.table_item(record, value)
-      return record[value] if value.is_a? Symbol
-      return value[record] if value.respond_to? :call
-
-      value
-    end
-  end
-end