costagent 0.1.1 → 0.1.2

data/README.rdoc

@@ -20,10 +20,14 @@ costagent = CostAgent.new subdomain, username, password
 
 (remember you need to enable API access from within your FreeAgent account)
 
-To see all projects:
+To see all active projects:
 
 projects = costagent.projects
 
+To see all projects:
+
+projects = costagent.projects("all")
+
 To find a specific project:
 
 project = costagent.project(id)
@@ -32,6 +36,14 @@ To find timeslips:
 
 timeslips = costagent.timeslips(start_date, end_date)
 
+To return all tasks for a specific project:
+
+tasks = costagent.tasks(project_id)
+
+To return your FA user ID:
+
+costagent.user_id
+
 And to return a GBP figure of the money earnt during a specific timeframe based on billable hours:
 
 total = costagent.earnt(start_date, end_date)

data/lib/costagent.rb

@@ -23,13 +23,13 @@ class CostAgent
   end
     
   # Returns all projects
-  def projects
-    @projects ||= (self.api("projects")/"project").collect { |project| Project.new((project/"id").text.to_i, (project/"name").text, (project/"currency").text, (project/"normal-billing-rate").text.to_f) }
+  def projects(filter = "active")
+    @projects ||= (self.api("projects", {:view => filter})/"project").collect { |project| Project.new((project/"id").text.to_i, (project/"name").text, (project/"currency").text, (project/"normal-billing-rate").text.to_f) }
   end
     
   # This returns the specified project
   def project(id)
-    self.projects.detect { |p| p.id == id }
+    self.projects("all").detect { |p| p.id == id }
   end
 
   # This returns all timeslips for the specified date range, with additional cost information
@@ -37,14 +37,18 @@ class CostAgent
     (self.api("timeslips", :view => "#{start_date.strftime("%Y-%m-%d")}_#{end_date.strftime("%Y-%m-%d")}")/"timeslip").collect do |timeslip|
       # Find the project and hours for this timeslip
       project = self.project((timeslip/"project-id").text.to_i)
-      hours = (timeslip/"hours").text.to_f
-      # Build the timeslip out using the timeslip data and the project it's tied to
-      Timeslip.new((timeslip/"id").text.to_i,
-                   project,
-                   hours,
-                   DateTime.parse((timeslip/"updated-at").text),
-                   project.hourly_billing_rate * hours)
-    end
+      if project
+        hours = (timeslip/"hours").text.to_f
+        # Build the timeslip out using the timeslip data and the project it's tied to
+        Timeslip.new((timeslip/"id").text.to_i,
+                     project,
+                     hours,
+                     DateTime.parse((timeslip/"updated-at").text),
+                     project.hourly_billing_rate * hours)
+      else
+        nil
+      end
+    end - [nil]
   end
 
   # This returns all tasks for the specified project_id
@@ -58,6 +62,11 @@ class CostAgent
                    project)
     end
   end
+
+  # This looks up the user ID using the CostAgent credentials
+  def user_id
+    self.client("verify").get.headers[:user_id]
+  end
     
   # This returns the amount of GBP earnt in the specified timeframe
   def earnt(start_date = DateTime.now, end_date = start_date)
@@ -72,12 +81,17 @@ class CostAgent
     
   # This calls the FA API for the specified resource
   def api(resource, parameters = {})
-    url = "https://#{self.subdomain}.freeagentcentral.com/#{resource}#{parameters.empty? ? "" : "?" + parameters.collect { |p| p.join("=") }.join("&")}"
-    res = RestClient::Resource.new(url, self.username, self.password).get
+    res = self.client(resource, parameters).get
     raise "No response from #{url}!" if res.body.nil? && res.body.empty?
     Hpricot(res.body)
   end
 
+  # This returns a client ready to query the FA API
+  def client(resource, parameters = {})
+    url = "https://#{self.subdomain}.freeagentcentral.com/#{resource}#{parameters.empty? ? "" : "?" + parameters.collect { |p| p.join("=") }.join("&")}"
+    RestClient::Resource.new(url, self.username, self.password)
+  end
+
   class << self
     # This returns the current USD rate from xe.com (or falls back on 1.6 if there is an error)
     def usd_rate

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Elliott Draper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 +01:00
+date: 2010-06-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency