freeagent 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+# https://github.com/weppos/gitignore/blob/weppos/Ruby.gitignore
+
+coverage
+rdoc
+tmp
+
+# Bundler
+.bundle
+pkg
+
+# Rubinius
+*.rbc
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+utils/whois-utf8.rb

data/.rspec

@@ -0,0 +1 @@
+--colour

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+= Changelog
+
+
+== Release 0.1.0
+
+* Initial version

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in freeagent.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    freeagent (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activeresource (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+    activesupport (3.0.6)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    json (1.5.1)
+    mimic (0.4.1)
+      json
+      plist
+      rack
+      sinatra
+    plist (3.1.0)
+    rack (1.2.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sinatra (1.2.1)
+      rack (~> 1.1)
+      tilt (< 2.0, >= 1.2.2)
+    tilt (1.2.2)
+    yard (0.6.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeresource (>= 3.0.0)
+  freeagent!
+  mimic
+  rspec (~> 2.5.0)
+  yard

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2011 Simone Carletti <weppos@weppos.net>
+
+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,27 @@
+= FreeAgent Client
+
+(Unofficial) Ruby client for the {FreeAgent Central API}[http://www.freeagentcentral.com/developers/freeagent-api].
+
+
+== Requirements
+
+* Ruby >= 1.8.7
+* ActiveResource 3.0.x
+
+
+== Installation
+
+  $ gem install freeagent
+
+
+== Author
+
+* {Simone Carletti}[http://www.simonecarletti.com] <weppos@weppos.net>
+
+
+== License
+
+FreeAgent (the Client) is Copyright (c) 2011 Simone Carletti.
+This is Free Software distributed under the MIT license.
+
+FreeAgent Online Accounting Software is Copyright (c) by FreeAgent Central.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+
+# Run test by default.
+task :default => :rspec
+task :test => :rspec
+
+
+Bundler::GemHelper.install_tasks
+
+
+# Run all the specs in the /spec folder
+RSpec::Core::RakeTask.new(:rspec)
+
+
+YARD::Rake::YardocTask.new(:yardoc) do |y|
+  y.options = ["--output-dir", "yardoc"]
+end
+
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r freeagent.rb"
+end

data/freeagent.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "free_agent/version"
+
+Gem::Specification.new do |s|
+  s.name        = "freeagent"
+  s.version     = FreeAgent::VERSION
+  s.summary     = ""
+  s.description = ""
+
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 1.8.7"
+
+  s.authors     = ["Simone Carletti"]
+  s.email       = ["weppos@weppos.net"]
+  s.homepage    = ""
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("rspec", "~> 2.5.0")
+  s.add_development_dependency("yard")
+  s.add_development_dependency("activeresource", ">= 3.0.0")
+  s.add_development_dependency("mimic")
+end

data/lib/free_agent.rb

@@ -0,0 +1,64 @@
+require 'active_resource'
+require 'free_agent/version'
+require 'free_agent/base'
+
+module FreeAgent
+
+  BASE_URI = "https://%s.freeagentcentral.com"
+
+  autoload :Attachment,   'free_agent/attachment'
+  autoload :BankAccount,  'free_agent/bank_account'
+  autoload :Bill,         'free_agent/bill'
+  autoload :Contact,      'free_agent/contact'
+  autoload :Invoice,      'free_agent/invoice'
+  autoload :InvoiceItem,  'free_agent/invoice_item'
+  autoload :Project,      'free_agent/project'
+
+
+  class << self
+
+    # Checks if the client is properly configured.
+    #
+    # @return [Boolean]
+    def configured?
+      Base.user && Base.password && Base.site
+    end
+
+    # Sets the client configuration.
+    #
+    # @return [void]
+    #
+    # @yield  [self]
+    #
+    # @example
+    #   FreeAgent.configure do |config|
+    #     config.username   = "email@example.com"
+    #     config.password   = "letmein"
+    #     config.subdomain  = "example"
+    #   end
+    #
+    def configure
+      if block_given?
+        yield self
+      else
+        raise LocalJumpError, "Required configuration block"
+        # TODO: allow users to pass configuration using an environment variable
+      end
+    end
+
+
+    def username=(value)
+      Base.user = value
+    end
+
+    def password=(value)
+      Base.password = value
+    end
+
+    def subdomain=(value)
+      Base.site = value.blank? ? nil : (BASE_URI % value)
+    end
+    
+  end
+
+end

data/lib/free_agent/attachment.rb

@@ -0,0 +1,21 @@
+module FreeAgent
+
+  # Represents an Attachment in FreeAgent.
+  #
+  # == Attachment URL
+  #
+  # FreeAgent stores attachments on Amazon S3. The real attachment URL
+  # is stored in the {Attachment#location} attribute.
+  #
+  #   a = FreeAgent::Attachment.first
+  #   a.location
+  #   # => "https://s3.amazonaws.com/freeagent-prod/attachments/165002/original.pdf"
+  #
+  # Attachments stored on Amazon S3 are private. For this reason,
+  # the location returned by FreeAgent contains an amazon AWSAccessKeyId and Signature
+  # that allows you to access the content for a limited set of time.
+  #
+  class Attachment < Base
+  end
+
+end

data/lib/free_agent/bank_account.rb

@@ -0,0 +1,7 @@
+module FreeAgent
+
+  # Represents a Bank Account in FreeAgent.
+  class BankAccount < Base
+  end
+
+end

data/lib/free_agent/base.rb

@@ -0,0 +1,6 @@
+module FreeAgent
+
+  class Base < ActiveResource::Base
+  end
+
+end

data/lib/free_agent/bill.rb

@@ -0,0 +1,15 @@
+module FreeAgent
+
+  # Represents a Bill in FreeAgent.
+  class Bill < Base
+
+    # TODO
+    # This resource requires a period parameter which is used
+    # to specify the date range of the bills to retrieve.
+    # The format of this parameter is yyyy-mm-dd_yyyy-mm-dd
+    # where the first date is the 'from' date
+    # and the second date is the 'to' date.
+
+  end
+
+end

data/lib/free_agent/contact.rb

@@ -0,0 +1,7 @@
+module FreeAgent
+
+  # Represents a Contact in FreeAgent.
+  class Contact < Base
+  end
+
+end

data/lib/free_agent/invoice.rb

@@ -0,0 +1,7 @@
+module FreeAgent
+
+  # Represents an Invoice in FreeAgent.
+  class Invoice < Base
+  end
+
+end

data/lib/free_agent/invoice_item.rb

@@ -0,0 +1,10 @@
+module FreeAgent
+
+  # Represents an Invoice Item in FreeAgent.
+  class InvoiceItem < Base
+
+    self.prefix = '/invoices/:invoice_id/'
+
+  end
+
+end

data/lib/free_agent/project.rb

@@ -0,0 +1,7 @@
+module FreeAgent
+
+  # Represents a Project in FreeAgent.
+  class Project < Base
+  end
+
+end

data/lib/free_agent/version.rb

@@ -0,0 +1,16 @@
+module FreeAgent
+
+  # Holds information about library version.
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")
+  end
+
+  # The current library version.
+  VERSION = Version::STRING
+
+end

data/lib/freeagent.rb

@@ -0,0 +1 @@
+require 'free_agent'

data/spec/fixtures/attachments/all.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<attachments type="array">
+  <attachment location="https://s3.amazonaws.com/freeagent-prod/attachments/165002/original.pdf?AWSAccessKeyId=00000000000000000000&amp;Expires=1302622321&amp;Signature=008SugGf4dWD05ZPaZHSt6R%2BCPA%3D">
+    <id type="integer">165002</id>
+    <content-type>application/pdf</content-type>
+    <file-name>Invoice-USD100_20100104.pdf</file-name>
+    <file-size type="integer">9214</file-size>
+    <description>Invoice</description>
+    <attachable-id type="integer">157514</attachable-id>
+    <attachable-type>Bill</attachable-type>
+    <processing>false</processing>
+  </attachment>
+  <attachment location="https://s3.amazonaws.com/freeagent-prod/attachments/165006/original.pdf?AWSAccessKeyId=00000000000000000000&amp;Expires=1302622321&amp;Signature=00CY0P6sRBhHE4G854lK1seR0Lg%3D">
+    <id type="integer">165006</id>
+    <content-type>application/pdf</content-type>
+    <file-name>Invoice-USD122_20110401.pdf</file-name>
+    <file-size type="integer">33653</file-size>
+    <description>Invoice</description>
+    <attachable-id type="integer">157528</attachable-id>
+    <attachable-type>Bill</attachable-type>
+    <processing>false</processing>
+  </attachment>
+</attachments>

data/spec/fixtures/attachments/single.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<attachment location="https://s3.amazonaws.com/freeagent-prod/attachments/165002/original.pdf?AWSAccessKeyId=00000000000000000000&amp;Expires=1302622321&amp;Signature=008SugGf4dWD05ZPaZHSt6R%2BCPA%3D">
+  <id type="integer">165002</id>
+  <content-type>application/pdf</content-type>
+  <file-name>Invoice-USD100_20100104.pdf</file-name>
+  <file-size type="integer">9214</file-size>
+  <description>Invoice</description>
+  <attachable-id type="integer">157514</attachable-id>
+  <attachable-type>Bill</attachable-type>
+  <processing>false</processing>
+</attachment>

data/spec/fixtures/bank_accounts/all.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<records type="array">
+  <bank-account>
+    <id type="integer">85327</id>
+    <type>StandardBankAccount</type>
+    <name>Business Checking Account</name>
+    <account-number>00000000</account-number>
+    <sort-code>00000000</sort-code>
+    <secondary-sort-code></secondary-sort-code>
+    <iban></iban>
+    <bic></bic>
+    <current-balance type="decimal">5571.18</current-balance>
+    <current-balance-date type="datetime">2011-04-04</current-balance-date>
+    <opening-balance type="decimal">4733.42</opening-balance>
+    <is-personal>false</is-personal>
+  </bank-account>
+  <bank-account>
+    <id type="integer">85563</id>
+    <type>CreditCardAccount</type>
+    <name>Credit</name>
+    <account-number>XXXX-XXXX-0000-0000</account-number>
+    <current-balance type="decimal">1000.0</current-balance>
+    <current-balance-date type="datetime">2011-04-12</current-balance-date>
+    <opening-balance type="decimal">1000.0</opening-balance>
+  </bank-account>
+  <bank-account>
+    <id type="integer">85564</id>
+    <type>PaypalAccount</type>
+    <name>Example</name>
+    <email>email@example.com</email>
+    <current-balance type="decimal">1000.0</current-balance>
+    <current-balance-date type="datetime">2011-04-12</current-balance-date>
+    <opening-balance type="decimal">1000.0</opening-balance>
+  </bank-account>
+</records>