kommen-freckle-cmd 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-07
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008, 2009 Dieter Komendera
+
+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/Manifest.txt

@@ -0,0 +1,20 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/freckle
+freckle-cmd.gemspec
+lib/freckle.rb
+lib/freckle/app_config.rb
+lib/freckle/cli.rb
+lib/freckle/entry.rb
+lib/freckle/project.rb
+script/console
+script/destroy
+script/generate
+test/entry_test.rb
+test/project_test.rb
+test/test_freckle_cli.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,16 @@
+
+To use the command line tool which comes with this gem, place a file .freckle.yml with following content into your home directory:
+
+freckle:
+  subdomain: <your freckle subodmain>
+  authtoken: <your freckle api auth token>
+  user: <your freckle user name>
+
+Then you can start tracking time from your command line:
+
+  freckle -t 2h -p ProjectX -d "Implementing a command line tool"
+
+For more information you can run
+
+  freckle -h
+

data/README.rdoc

@@ -0,0 +1,34 @@
+= freckle
+
+http://letsfreckle.com
+
+== DESCRIPTION:
+
+Command line tool to track time with freckle (http://letsfreckle.com)
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+  freckle -t 2h -p ProjectX -d "tag1, description for the entry"
+
+== REQUIREMENTS:
+
+* an active freckle account
+* a valid .freckle.yml file in your home directory (see INSTALL section below)
+* json and activeresource gems installed
+
+== INSTALL:
+
+sudo gem install kommen-freckle --source http://gems.github.com
+
+Place a file .freckle.yml with following content into your home directory:
+
+  freckle:
+    subdomain: <your freckle subodmain>
+    authtoken: <your freckle api auth token>
+    user: <your freckle user name>
+
+== LICENSE:
+
+The freckle gem is licensed under the terms of the MIT License, see the included MIT-LICENSE file. 

data/Rakefile

@@ -0,0 +1,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/freckle'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('freckle-cmd', Freckle::VERSION) do |p|
+  p.developer('Dieter Komendera', 'dieter@abloom.at')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.rubyforge_name       = p.name
+
+  p.extra_deps         = [
+    ['json', '>= 1.1.3'],
+    ['activeresource', '>= 2.2.2']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['activesupport', '>= 2.2.2']
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+

data/bin/freckle

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+#  Created by Dieter Komendera on 2008-12-7.
+#  Copyright (c) 2008, 2009. All rights reserved.
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/freckle")
+
+require "freckle/cli"
+
+Freckle::CLI.execute(STDOUT, ARGV)

data/lib/freckle.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Freckle
+  VERSION = '0.0.1'
+end

data/lib/freckle/app_config.rb

@@ -0,0 +1,14 @@
+module Freckle
+
+  class AppConfig
+    @@global_config = {
+      'host' => 'letsfreckle.com',
+      'port' => 80
+    }.merge(File.open(File.expand_path("~/.freckle.yml")) { |yf| YAML::load(yf)['freckle'] })
+
+    def self.method_missing(method_symbol, *arguments)
+      method_name = method_symbol.to_s
+      @@global_config.has_key?(method_name) ? @@global_config[method_name] : super
+    end
+  end
+end

data/lib/freckle/cli.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'optparse'
+require 'yaml'
+require 'json'
+require 'activeresource'
+require 'freckle/app_config'
+require 'freckle/entry'
+require 'freckle/project'
+
+module Freckle
+  class CLI
+    def self.execute(stdout, arguments=[])
+
+      options = {}
+      entry_attributes = {}
+
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER.gsub(/^          /,'')
+          This is a commandline interface for tracking time with freckle.
+
+          Usage: #{File.basename($0)} [options]
+
+          Options are:
+        BANNER
+        opts.separator ""
+
+        opts.on("-t", "--time=TIME", "required") { |arg| entry_attributes[:minutes] = arg }
+        opts.on("-p", "--project=PROJECT") { |arg| options[:project_name] = arg }
+        opts.on("-d", "--description=DESCRIPTION") { |arg| entry_attributes[:description] = arg }
+        opts.on("-D", "--date=DATE", "default: Today") { |arg| entry_attributes[:date] = arg }
+
+        opts.on("-h", "--help",
+                "Show this help message.") { stdout.puts opts; exit }
+        opts.parse!(arguments)
+      end
+
+      entry = Freckle::Entry.new(entry_attributes.merge(:user => Freckle::AppConfig.user))
+      entry.project_name = options[:project_name] if options[:project_name]
+      if entry.save
+        puts "time entry saved"
+      else
+        puts "failed to save entry."
+        entry.errors.full_messages.each { |msg| puts msg }
+      end
+    end
+  end
+end

data/lib/freckle/entry.rb

@@ -0,0 +1,40 @@
+
+module Freckle
+
+  class Entry < ActiveResource::Base
+    self.site = "http://#{Freckle::AppConfig.subdomain}.#{Freckle::AppConfig.host}:#{Freckle::AppConfig.port}/api/"
+
+    TIME_REGEXP = /^[0-9]{0,3}[:,.]?[0-9]{0,2}(m|min|mins|minute|minutes|h|hr|hrs|hour|hours|d|day|days)?$/
+
+    attr_accessor :project
+
+    def self.headers
+      @headers ||= { 'X_FRECKLETOKEN' => Freckle::AppConfig.authtoken }
+    end
+
+    def attributes
+      { :date => Date.today, :project_id => project ? project.id : nil }.merge(@attributes || {})
+    end
+
+    def project_name=(name)
+      self.project = Project.find_or_create_by_name(name)
+    end
+
+    def save
+      valid? ? super : false
+    end
+
+    def valid?
+      validate
+      super
+    end
+
+    protected
+
+    def validate
+      if minutes && !(minutes =~ TIME_REGEXP)
+        errors.add('minutes', 'has invalid format')
+      end
+    end
+  end
+end

data/lib/freckle/project.rb

@@ -0,0 +1,16 @@
+
+module Freckle
+
+  class Project < ActiveResource::Base
+    self.site = "http://#{Freckle::AppConfig.subdomain}.#{Freckle::AppConfig.host}:#{Freckle::AppConfig.port}/api/"
+
+    def self.headers
+      @headers ||= { 'X_FRECKLETOKEN' => Freckle::AppConfig.authtoken }
+    end
+
+    def self.find_or_create_by_name(name)
+      raise "Invalid Argument: Name can't be blank." if name.nil? || name.empty?
+      find(:first, :params => { :name => name }) || create(:name => name)
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/freckle.rb'}"
+puts "Loading freckle gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/entry_test.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+class Freckle::ProjectTest < Test::Unit::TestCase
+
+  class Freckle::Project
+    def self.headers
+      { 'X_FRECKLETOKEN' => '123' }
+    end
+  end
+
+  def setup
+    @entry = Freckle::Entry.new
+    @projects = [{ :id => 1, :name => "Test1" }].to_xml(:root => "projects")
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/api/projects.xml?name=Test1", { 'X_FRECKLETOKEN' => '123' }, @projects
+    end
+  end
+
+  def test_should_have_today_as_default_date
+    assert_equal Date.today, @entry.attributes[:date]
+  end
+
+  def test_should_allow_default_date_to_be_overwritten
+    assert_equal '2009/11/10', Freckle::Entry.new({ :date => '2009/11/10' }).date
+  end
+
+  def test_attribute_project_id_when_entry_has_project
+    @entry.project = Freckle::Project.new(:id => 1, :name => 'Test1')
+    assert_equal 1, @entry.attributes[:project_id]
+  end
+
+  def test_attribute_project_id_when_entry_has_no_project
+    assert_nil @entry.attributes[:project_id]
+  end
+
+  def test_set_project_name_should_assing_project
+    @entry.project_name = 'Test1'
+    assert_equal 1, @entry.attributes[:project_id]
+  end
+
+  def test_minute_validation
+    ['2h', '100', '50min'].each do |min|
+      entry = Freckle::Entry.new(:minutes => min)
+      assert entry.valid?
+    end
+
+    ['2ah', '1x0', '50)min'].each do |min|
+      entry = Freckle::Entry.new(:minutes => min)
+      assert !entry.valid?
+    end
+  end
+
+  def test_entry_does_not_get_saved_when_invalid
+    entry = Freckle::Entry.new(:minutes => 'invalid')
+    assert !entry.save
+  end
+end

data/test/project_test.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+class Freckle::ProjectTest < Test::Unit::TestCase
+
+  class Freckle::Project
+    def self.headers
+      { 'X_FRECKLETOKEN' => '123' }
+    end
+  end
+
+  def setup
+    @projects = [{ :id => 1, :name => "Test1" }].to_xml(:root => "projects")
+    @project = { :id => 2, :name => "Test2" }.to_xml(:root => "project")
+    @no_projects = [].to_xml(:root=> 'projects')
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.post   "/api/projects.xml", { 'X_FRECKLETOKEN' => '123' }, @project, 201, "Location" => "/api/projects/1.xml"
+      mock.get    "/api/projects.xml?name=Test1", { 'X_FRECKLETOKEN' => '123' }, @projects
+      mock.get    "/api/projects.xml?name=Test2", { 'X_FRECKLETOKEN' => '123' }, @no_projects
+    end
+  end
+
+  def test_finding_project_by_name
+    project = Freckle::Project.find(:first, :params => { :name => 'Test1' })
+    assert_equal "Test1", project.name
+  end
+
+  def test_create_project
+    project = Freckle::Project.create(:name => 'Test2')
+    assert_equal 2, project.id
+  end
+
+  def test_find_or_create_by_name_should_find_existing_project
+    project = Freckle::Project.find_or_create_by_name('Test1')
+    assert_equal 1, project.id
+  end
+
+  def test_find_or_create_by_name_should_create_non_existing_project
+    project = Freckle::Project.find_or_create_by_name('Test2')
+    assert_equal 2, project.id
+  end
+end

data/test/test_freckle_cli.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+require 'freckle/cli'
+
+class TestFreckleCli < Test::Unit::TestCase
+  def setup
+    @stdout_io = StringIO.new
+    Freckle::CLI.execute(@stdout_io, [])
+    @stdout_io.rewind
+    @stdout = @stdout_io.read
+  end
+
+  def test_not_print_default_output
+    assert_no_match(/To update this executable/, @stdout)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'stringio'
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_resource/http_mock'
+
+require File.dirname(__FILE__) + '/../lib/freckle'
+require File.dirname(__FILE__) + '/../lib/freckle/cli'
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: kommen-freckle-cmd
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dieter Komendera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-13 00:00:00 -08:00
+default_executable: freckle
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Command line tool to track time with freckle (http://letsfreckle.com)
+email: 
+- dieter@abloom.at
+executables: 
+- freckle
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- MIT-LICENSE
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/freckle
+- freckle.gemspec
+- lib/freckle.rb
+- lib/freckle/app_config.rb
+- lib/freckle/cli.rb
+- lib/freckle/entry.rb
+- lib/freckle/project.rb
+- script/console
+- script/destroy
+- script/generate
+- test/entry_test.rb
+- test/project_test.rb
+- test/test_freckle_cli.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://letsfreckle.com
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: freckle-cmd
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Command line tool to track time with freckle (http://letsfreckle.com)
+test_files: 
+- test/test_freckle_cli.rb
+- test/test_helper.rb