freeagent_api 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Aaron Russell
+
+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/README.rdoc

@@ -0,0 +1,66 @@
+= freeagent_api
+
+Simple Ruby interface to the Freeagent Central API (http://www.freeagentcentral.com/developers/freeagent-api).
+
+This is an early development version of a Ruby wrapper for the Freeagent API. Currently this only supports GET requests (POST will follow shortly) and only the following API methods are supported (more will follow):
+
+* Contacts
+* Invoices
+* Invoice items
+* Projects
+* Tasks
+* Timeslips
+
+There is no test suite yet. If you feel brave, then feel free to clone, fork and play around.
+
+== Installation
+
+To install as a Gem, just run:
+
+  $ sudo gem install freeagent_api -s http://gemcutter.org
+
+== Usage
+
+=== Authentication
+
+  Freeagent.domain = 'yourdomain.freeagentcentral.com'
+  Freeagent.username = 'your@login.com'
+  Freeagent.password = 'your_password'
+
+=== Contacts
+
+  @contacts = Contact.find_all                # returns all contacts
+  @contact = Contact.find(contact_id)         # returns specific contact
+
+=== Invoice
+
+  @invoices = Invoice.find_all                # returns all invoices
+  @invoices = Invoice.find_all(project_id)    # returns all invoices for project
+  @invoice = Invoice.find(invoice_id)         # returns specific invoice
+
+=== Invoice items
+
+  @items  = InvoiceItem.find_all(invoice_id)  # returns all items for invoice
+
+=== Projects
+
+  @projects = Project.find_all                # returns all projects
+  @project = Project.find(project_id)         # returns specific project
+
+=== Tasks
+
+  @task = Task.find(project_id, task_id)      # returns specific task for project
+
+=== Timeslips
+
+  @timeslips = Timeslip.find_all              # returns all timeslips
+  @timeslips = Timeslip.find_all(project_id)  # returns all timeslips for project
+  @timeslip = Timeslip.find(timeslip_id)      # returns specific timeslip
+
+== Author
+ 
+* Aaron Russell - (www.aaronrussell.co.uk)
+
+== Copyright
+
+Copyright (c) 2009 Aaron Russell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "freeagent_api"
+    gem.summary = %Q{Simple Ruby interface to the Freeagent Central API.}
+    gem.description = %Q{This is an early development version of a Ruby wrapper for the Freeagent API. Currently this only supports GET requests (POST will follow shortly) and not all API methods are currently supported (more will follow).}
+    gem.email = "aaron@gc4.co.uk"
+    gem.homepage = "http://github.com/aaronrussell/freeagent_api"
+    gem.authors = ["Aaron Russell"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "activesupport"
+    gem.add_dependency "nokogiri"
+    gem.add_dependency "api_cache"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "freeagent_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/freeagent_api.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{freeagent_api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Russell"]
+  s.date = %q{2009-10-14}
+  s.description = %q{This is an early development version of a Ruby wrapper for the Freeagent API. Currently this only supports GET requests (POST will follow shortly) and not all API methods are currently supported (more will follow).}
+  s.email = %q{aaron@gc4.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "freeagent_api.gemspec",
+     "lib/freeagent_api.rb",
+     "test/freeagent_api_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/aaronrussell/freeagent_api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple Ruby interface to the Freeagent Central API.}
+  s.test_files = [
+    "test/freeagent_api_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<api_cache>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<api_cache>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<api_cache>, [">= 0"])
+  end
+end

data/lib/freeagent_api.rb

@@ -0,0 +1,172 @@
+require 'rubygems'
+require 'nokogiri'
+require 'net/https'
+require 'api_cache'
+require 'activesupport'
+
+module Freeagent
+  
+  class << self
+    attr_accessor :domain, :username, :password
+
+    def self.domain=(domain)
+      @domain = domain
+    end
+
+    def self.username=(username)
+      @username = username
+    end
+
+    def self.password=(password)
+      @password = password
+    end
+  end
+  
+  class Base
+    
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        raise "no attr_accessor set for #{key} on #{self.class}" if !respond_to?("#{key}=")
+        self.send("#{key}=", value)
+      end
+    end
+    
+    def self.get(path)
+      @@resp = APICache.get(path) do
+        http = Net::HTTP.new(Freeagent.domain, 443)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.start do |http|
+          request = Net::HTTP::Get.new(path, {'Content-Type' => 'application/xml', 'Accept' => 'application/xml'})
+          request.basic_auth(Freeagent.username, Freeagent.password)
+          response = http.request(request)
+          case response
+          when Net::HTTPSuccess
+            @@resp = response.body
+          else
+            response.error!
+            raise APICache::InvalidResponse
+          end
+        end
+      end
+    end
+    
+    def self.parse(path, options)
+      response = []
+      Nokogiri::XML(@@resp).xpath(path).each do |ts|
+        res = {}
+        options.each do |key|
+          res[key.underscore.to_sym] = ts.xpath(key).text
+        end
+        response << self.new(res)
+      end
+      return response
+    end
+    
+  end
+  
+  class Contact < Base
+    @elements = ['id', 'organisation-name', 'first-name', 'last-name', 'address1', 'address2', 'address3', 'town', 'region', 'country', 'postcode', 'phone-number', 'email', 'contact-name-on-invoices', 'sales-tax-registration_number', 'uses-contact-invoice-sequence']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+    
+    def self.find_all
+      get '/contacts'
+      contacts = parse('contacts/contact', @elements)
+      return contacts
+    end
+    
+    def self.find(contact_id)
+      get '/contacts/'+contact_id
+      contacts = parse('contact', @elements)
+      return contacts[0]
+    end
+  end
+  
+  class Invoice < Base
+    @elements = ['id', 'contact-id', 'project-id', 'dated-on', 'due-on', 'reference', 'net-value', 'sales-tax-value', 'status', 'comments', 'discount-percent', 'omit-header', 'payment-terms', 'written-off-date', 'invoice-items']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+    
+    def self.find_all(project_id = false)
+      if project_id
+        get '/projects/'+project_id+'/invoices' 
+      else
+        get '/invoices'
+      end
+      invoices = parse('invoices/invoice', @elements)
+      return invoices.reverse
+    end
+    
+    def self.find(invoice_id)
+      get '/invoices/'+invoice_id
+      invoices = parse('invoice', @elements)
+      invoices.each do |i|
+        i.invoice_items = InvoiceItem.find_all(invoice_id)
+      end
+      return invoices[0]
+    end
+  end
+  
+  class InvoiceItem < Invoice
+    @elements = ['id', 'invoice-id', 'project-id', 'item-type', 'price', 'quantity', 'description', 'sales-tax-rate']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+
+    def self.find_all(invoice_id)
+      items = parse('invoice/invoice-items/invoice-item', @elements)
+      return items
+    end
+  end
+  
+  class Project < Base
+    @elements = ['id', 'contact-id', 'name', 'billing-basis', 'budget', 'budget-units', 'invoicing-reference', 'is-ir35', 'normal-billing-rate', 'payment-terms-in-days', 'starts-on', 'ends-on', 'status', 'uses-project-invoice-sequence']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+    
+    def self.find_all
+      get '/projects'
+      projects = parse('projects/project', @elements)
+      return projects
+    end
+    
+    def self.find(project_id)
+      get '/projects/'+project_id
+      projects = parse('project', @elements)
+      return projects[0]
+    end
+  end
+  
+  class Task < Base
+    @elements = ['id', 'project-id', 'name']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+
+    def self.find(project_id, task_id)
+      get '/projects/'+project_id+'/tasks/'+task_id
+      tasks = parse('task', @elements)
+      return tasks[0]
+    end
+  end
+  
+  class Timeslip < Base
+    @elements = ['id', 'dated-on', 'project-id', 'task-id', 'task', 'user-id', 'hours', 'comment']
+    @elements.each {|t| attr_accessor t.underscore.to_sym}
+
+    def self.find_all(project_id = false)
+      if project_id
+        get '/projects/'+project_id+'/timeslips'
+      else
+        get '/timeslips'
+      end
+      timeslips = parse('timeslips/timeslip', @elements)
+      timeslips.each do |t|
+        t.task = Task.find(project_id, t.task_id)
+      end
+      return timeslips.reverse
+    end
+    
+    def self.find(timeslip_id)
+      get '/timeslips'+timeslip_id
+      timeslips = parse('timeslip', @elements)
+      return timeslips[0]
+    end
+  end
+  
+  
+end

data/test/freeagent_api_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FreeagentApiTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'freeagent_api'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: freeagent_api
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Russell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: api_cache
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This is an early development version of a Ruby wrapper for the Freeagent API. Currently this only supports GET requests (POST will follow shortly) and not all API methods are currently supported (more will follow).
+email: aaron@gc4.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- freeagent_api.gemspec
+- lib/freeagent_api.rb
+- test/freeagent_api_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/aaronrussell/freeagent_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple Ruby interface to the Freeagent Central API.
+test_files: 
+- test/freeagent_api_test.rb
+- test/test_helper.rb