slimtimer4r 0.2.0

data/History.txt

@@ -0,0 +1,9 @@
+== 0.2.0 / 2008-01-09
+
+* 1 major enhancement
+  * Not-so-ugly code thanks to borrowing from the 37 Signals / Basecamp sample Ruby wrappers
+
+== 0.1.0 / Sometime back in 2006...
+
+* Lots of UGLY code
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/slimtimer4r
+lib/slimtimer4r.rb
+test/test_slimtimer4r.rb

data/README.txt

@@ -0,0 +1,51 @@
+== SlimTimer4R
+
+== Overview
+
+A basic wrapper against the SlimTimer (www.slimtimer.com) API.
+
+== Installation
+
+RubyGems FTW!
+
+  sudo gem install slimtimer4r
+
+== Usage
+
+  require 'slimtimer4r'
+
+  slimtimer = SlimTimer.new("EMAIL", "PASSWORD", "API_KEY")
+  tasks = slimtimer.list_tasks
+	  => [#<Record(Task) "name"=>"Ta...">, #<Record(Task) "name"=>"Br...">...]
+
+== Thanks
+- 37 Signals for their sample Backpack/Basecamp Ruby wrappers
+
+== Author
+- Dylan Markow (dylan@dylanmarkow.com)
+
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/slimtimer4r.rb'
+
+Hoe.new('slimtimer4r', SlimTimer::VERSION) do |p|
+  p.rubyforge_name = 'slimtimer4r'
+  p.author = 'Dylan Markow'
+  p.email = 'dylan@dylanmarkow.com'
+  p.remote_rdoc_dir = ''
+  # p.summary = 'FIX'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/lib/slimtimer4r.rb

@@ -0,0 +1,207 @@
+require 'yaml'
+require 'net/http'
+
+class SlimTimer
+  VERSION = '0.2.0'
+
+  #
+  # The Record class is used to encapsulate the data returned from the SlimTimer API
+  class Record
+    attr_reader :type, :hash
+
+    def initialize(type, hash)
+      @type = type
+      @hash = hash
+    end
+
+    # Checks to see if one of the values of the hash is another hash, and if so, changes it to a Record object. This allows you to use time_entry.task.name instead of time_entry.task["name"]
+    def [](name)
+      case @hash[name]
+      when Hash then
+        @hash[name] = (@hash[name].keys.length == 1 && Array === @hash[name].values.first) ? @hash[name].values.first.map { |v| Record.new(@hash[name].keys.first, v) } : Record.new(name, @hash[name])
+      else
+        @hash[name]
+      end
+    end
+
+    def id
+      @hash["id"]
+    end
+
+    def attributes
+      @hash.keys
+    end
+
+    def respond_to?(sym)
+      super || @hash.has_key?(sym)
+    end
+
+    # Used to convert an unknown method into a hash key. For example, item.user_id would become item["user_id"]
+    def method_missing(sym, *args)
+      if args.empty? && !block_given? && respond_to?(sym.to_s)
+        self[sym.to_s]
+      else
+        super
+      end
+    end
+
+    def to_s
+      "\#<Record(#{@type}) #{@hash.inspect[1..-2]}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    private
+
+    def dashify(name)
+      name.to_s.tr("_","-")
+    end
+  end
+
+  attr_accessor :email, :password, :api_key, :user_id, :access_token, :request
+
+  # Creates a new SlimTimer object and obtains the +access_token+ and +user_id+ from the SlimTimer API by sending your +email+, +password+, and +api_key+. Raises a _RuntimeError_ if it can't authenticate.
+  # 
+  #   slim_timer = SlimTimer.new("person@example.com", "password", "12345")
+  #     => #<SlimTimer:0x68bca8 @password="password"...>
+  # 
+  #   slim_timer = SlimTimer.new("bademail@example.com", "badpassword", "12345")
+  #     => RuntimeError: Error occurred (500)
+  def initialize(email, password, api_key)
+    @email, @password, @api_key = email, password, api_key
+    connect
+    get_token
+  end
+
+  # Returns a list of tasks.
+  #
+  # Options:
+  # <tt>show_completed</tt>::          Include completed tasks. Specify +only+ to only include the completed tasks. Valid options are +yes+, +no+, and +only+. Default is +yes+.
+  # <tt>role</tt>::                    Include tasks where the user's role is one of the roles given (comma delimited). Valid options include +owner+, +coworker+, and +reporter+. Default is +owner,coworker+.
+  def list_tasks(show_completed="yes", role="owner,coworker")
+    request("get", "#{@user_id}/tasks?api_key=#{@api_key}&access_token=#{@access_token}&show_completed=#{show_completed}&role=#{role}", "Tasks")
+  end
+
+  # Returns a specific task. Returns _nil_ if the record is not found.
+  #
+  # Options:
+  # <tt>task_id</tt>:: The id of the task you would like to retrieve.
+  def show_task(task_id)
+    request("get", "#{@user_id}/tasks/#{task_id}?api_key=#{@api_key}&access_token=#{@access_token}", "Task")
+  end
+
+  def delete_task(task_id)
+    request("delete", "#{@user_id}/tasks/#{task_id}?api_key=#{@api_key}&access_token=#{@access_token}", "Task")
+  end
+
+  def create_task(name, tags=nil, coworker_emails=nil, reporter_emails=nil, completed_on=nil)
+    request("post", "#{@user_id}/tasks", {"access_token" => @access_token, "api_key" => @api_key, "task" => {"name" => name, "tags" => tags, "coworker_emails" => coworker_emails, "reporter_emails" => reporter_emails, "completed_on" => completed_on}}, "Task")
+  end
+
+  def update_task(task_id, name, tags=nil, coworker_emails=nil, reporter_emails=nil, completed_on=nil)
+    request("put", "#{@user_id}/tasks/#{task_id}", {"access_token" => @access_token, "api_key" => @api_key, "task" => {"name" => name, "tags" => tags, "coworker_emails" => coworker_emails, "reporter_emails" => reporter_emails, "completed_on" => completed_on}}, "Task")
+  end
+
+  def list_timeentries(range_start=nil, range_end=nil)
+    range_start = range_start.strftime("%Y-%m-%dT%H:%M:%SZ") unless range_start.nil?
+    range_end   = range_end.strftime("%Y-%m-%dT%H:%M:%SZ") unless range_end.nil?
+    request("get", "#{@user_id}/time_entries?api_key=#{@api_key}&access_token=#{@access_token}&range_start=#{range_start}&range_end=#{range_end}", "TimeEntries")
+  end
+
+  def update_timeentry(timeentry_id, start_time, duration_in_seconds, task_id, end_time, tags=nil, comments=nil, in_progress=nil)
+    start_time = start_time.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end_time = end_time.strftime("%Y-%m-%dT%H:%M:%SZ") unless end_time.nil?
+
+    # add the default params
+    params = {
+      "start_time" => start_time,
+      "duration_in_seconds" => duration_in_seconds,
+      "task_id" => task_id,
+      "end_time" => end_time,
+    }
+
+    # only add the applicable params
+    params.merge!({"tags" => tags}) unless tags.nil?
+    params.merge!({"comments" => comments}) unless comments.nil?
+    params.merge!({"in_progress" => in_progress}) unless in_progress.nil?
+
+
+    request("put", "#{@user_id}/time_entries/#{timeentry_id}", {"access_token" => @access_token, "api_key" => @api_key, "time_entry" => params}, "TimeEntry")
+  end
+
+  def create_timeentry(start_time, duration_in_seconds, task_id, end_time, tags=nil, comments=nil, in_progress=nil)
+    start_time = start_time.strftime("%Y-%m-%dT%H:%M:%SZ")
+    end_time = end_time.strftime("%Y-%m-%dT%H:%M:%SZ") unless end_time.nil?
+
+    # add the default params
+    params = {
+      "start_time" => start_time,
+      "duration_in_seconds" => duration_in_seconds,
+      "task_id" => task_id,
+      "end_time" => end_time,
+    }
+
+    # only add the applicable params
+    params.merge!({"tags" => tags}) unless tags.nil?
+    params.merge!({"comments" => comments}) unless comments.nil?
+    params.merge!({"in_progress" => in_progress}) unless in_progress.nil?
+
+
+    request("post", "#{@user_id}/time_entries", {"access_token" => @access_token, "api_key" => @api_key, "time_entry" => params}, "TimeEntry")
+  end
+
+  def show_timeentry(timeentry_id)
+    request("get", "#{@user_id}/time_entries/#{timeentry_id}?api_key=#{@api_key}&access_token=#{@access_token}", "TimeEntry")
+  end
+
+  def delete_timeentry(timeentry_id)
+    request("delete", "#{@user_id}/time_entries/#{timeentry_id}?api_key=#{@api_key}&access_token=#{@access_token}", "TimeEntry")
+  end
+
+
+  private
+  def get_token
+    values = request("post", "token", {"user" => {"email" => @email, "password" => @password}, "api_key" => @api_key})
+    @access_token = values.access_token
+    @user_id = values.user_id
+  end
+
+  def connect
+    @connection = Net::HTTP.new("www.slimtimer.com", 80)
+  end
+
+  def request(method, path, parameters = {}, type="Result")
+    method.downcase!
+    if !['post','get','delete','put'].include?(method)
+      raise "Error: bad method parameter"
+    end
+    if %w(get delete).include?(method)
+      response = @connection.send(method, "/users/#{path}", {"Accept" => "application/x-yaml"})
+    else
+      response = @connection.send(method, "/users/#{path}", parameters.to_yaml, {"Content-Type" => "application/x-yaml", "Accept" => "application/x-yaml"})
+    end
+
+    if response.code == "200"
+
+      # If this was a delete request, return true
+      if method == 'delete'
+        true
+      else
+        result = YAML::load(response.body)
+        if result.is_a?(Array)
+          result.map { |row| Record.new(type, row) }
+        else
+          Record.new(type, result)
+        end
+      end
+    elsif response.code == "404"
+      method == 'get' ? nil : false
+    else
+      raise "Error occurred (#{response.code}): #{response.body}"
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: slimtimer4r
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dylan Markow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: The author was too lazy to write a description
+email: dylan@dylanmarkow.com
+executables: 
+- slimtimer4r
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/slimtimer4r
+- lib/slimtimer4r.rb
+- test/test_slimtimer4r.rb
+has_rdoc: true
+homepage: http://www.zenspider.com/ZSS/Products/slimtimer4r/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: slimtimer4r
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: The author was too lazy to write a summary
+test_files: 
+- test/test_slimtimer4r.rb