costagent 0.1.4 → 0.1.5

data/README.rdoc

@@ -40,6 +40,14 @@ To return all tasks for a specific project:
 
 tasks = costagent.tasks(project_id)
 
+To return all invoices for the account:
+
+invoices = costagent.invoices
+
+To lookup a specific invoice:
+
+invoice = costagent.invoice(id)
+
 To return your FA user ID:
 
 costagent.user_id
@@ -90,4 +98,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/costagent.rb

@@ -6,9 +6,11 @@ require "open-uri"
 
 #  This exposes additional billable tracking functionality around the Freeagent API
 class CostAgent
-  Project = Struct.new(:id, :name, :currency, :hourly_billing_rate)
-  Timeslip = Struct.new(:id, :project, :hours, :date, :cost)
+  Project = Struct.new(:id, :name, :currency, :hourly_billing_rate, :daily_billing_rate, :hours_per_day)
+  Timeslip = Struct.new(:id, :project, :hours, :date, :cost, :comment, :status)
   Task = Struct.new(:id, :name, :project)
+  Invoice = Struct.new(:id, :project_id, :description, :reference, :amount, :status, :date, :due, :items)
+  InvoiceItem = Struct.new(:id, :invoice_id, :project_id, :item_type, :description, :price, :quantity, :cost)
 
   attr_accessor :subdomain, :username, :password
   
@@ -25,7 +27,19 @@ class CostAgent
   # Returns all projects
   def projects(filter = "active")
     @projects ||= {}
-    @projects[filter] ||= (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) }
+    @projects[filter] ||= (self.api("projects", {:view => filter})/"project").collect do |project|
+      billing_rate = (project/"normal-billing-rate").text.to_f
+      hours_per_day = (project/"hours-per-day").text.to_f
+      billing_period = (project/"billing-period").text
+      hourly_rate = (billing_period == "hour" ? billing_rate : billing_rate / hours_per_day)
+      daily_rate = (billing_period == "hour" ? billing_rate * hours_per_day : billing_rate)
+      Project.new((project/"id").text.to_i,
+                  (project/"name").text,
+                  (project/"currency").text,
+                  hourly_rate,
+                  daily_rate,
+                  hours_per_day)
+    end
   end
     
   # This returns the specified project
@@ -44,8 +58,10 @@ class CostAgent
         Timeslip.new((timeslip/"id").text.to_i,
                      project,
                      hours,
-                     DateTime.parse((timeslip/"updated-at").text),
-                     project.hourly_billing_rate * hours)
+                     DateTime.parse((timeslip/"dated-on").text),
+                     project.hourly_billing_rate * hours,
+                     (timeslip/"comment").text,
+                     (timeslip/"status").text)
       else
         nil
       end
@@ -64,6 +80,42 @@ class CostAgent
     end
   end
 
+  # This returns all invoices
+  def invoices
+    @invoices ||= (self.api("invoices")/"invoice").collect do |invoice|
+      items = (invoice/"invoice-item").collect do |item|
+        price = (item/"price").first.inner_text.to_f
+        quantity = (item/"quantity").first.inner_text.to_f
+        cost = price * quantity
+        InvoiceItem.new(
+          (item/"id").first.inner_text.to_i,
+          (item/"invoice-id").first.inner_text.to_i,
+          (item/"project-id").first.inner_text.to_i,
+          (item/"item-type").first.inner_text,
+          (item/"description").first.inner_text,
+          price,
+          quantity,
+          cost)
+      end
+      Invoice.new(
+        (invoice/"id").first.inner_text.to_i,
+        (invoice/"project-id").first.inner_text.to_i,
+        (invoice/"description").first.inner_text,
+        (invoice/"reference").text,
+        (invoice/"net-value").text.to_f,
+        (invoice/"status").text,
+        DateTime.parse((invoice/"dated-on").text),
+        DateTime.parse((invoice/"due-on").text),
+        items)
+    end
+    @invoices
+  end
+
+  # This returns the specific invoice by ID
+  def invoice(id)
+    self.invoices.detect { |i| i.id == id }
+  end
+
   # This looks up the user ID using the CostAgent credentials
   def user_id
     self.client("verify").get.headers[:user_id]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Elliott Draper
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-05 00:00:00 +01:00
+date: 2010-10-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
@@ -35,6 +36,7 @@ dependencies:
   name: hpricot
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
@@ -49,6 +51,7 @@ dependencies:
   name: shoulda
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -61,6 +64,7 @@ dependencies:
   name: mocha
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -91,6 +95,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -98,6 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -107,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: costagent is a Ruby gem that provides lightweight access to the projects/timeslips part of the FreeAgent API, with a view to tracking billable hours and figures.