saasu 0.0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem "nokogiri"
+gem "activesupport", ">= 2.3.2"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rspec"
+  gem "yard"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kieran Johnson
+
+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.md

@@ -0,0 +1,34 @@
+# Saasu
+
+This gem provide a ruby wrapper to the Saasu api.
+
+## Installation
+
+    gem install saasu
+    
+## Getting Started
+
+Usage is currently limited to fetching invoices.
+
+Firstly setup the library with your api\_key and file\_uid
+
+    Saasu::Base.api_key  = key
+    Saasu::Base.file_uid = uid
+
+To fetch all invoices
+
+    invoices = Saasu::Invoice.all
+    
+You can pass in any conditions as a hash. The keys should be in snake case.
+
+    invoices = Saasu::Invoice.all(:transaction_type => "s", :paid_status => "Unpaid")
+    
+For a complete list of supported options see the [Saasu API Reference](http://help.saasu.com/api/http-get/)
+    
+To fetch a single invoice by its uid
+
+    invoice = Saasu::Invoice.find(uid)
+    
+## Copyright
+
+Copyright (c) 2011 Kieran Johnson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "saasu"
+  gem.summary     = "Ruby wrapper for the Saasu api"
+  gem.description = "Ruby wrapper for the Saasu api"
+  gem.email       = "hello@invisiblelines.com"
+  gem.homepage    = "http://github.com/kieranj/saasu"
+  gem.authors     = ["Kieran Johnson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/saasu/base.rb

@@ -0,0 +1,174 @@
+module Saasu
+  
+  class Base
+    
+    ENDPOINT = "https://secure.saasu.com/webservices/rest/r1"
+    
+    def initialize(xml)
+      klass = self.class.name.split("::")[1].downcase
+      xml.children.each do |child|
+        if !child.text?
+          child.attributes.each do |attr|
+            send("#{attr[1].name.underscore.sub(/#{klass}_/, "")}=", attr[1].text)
+          end
+          
+          send("#{child.name.underscore.sub(/#{klass}_/, "")}=", child.children.first.text) unless child.children.first.nil?
+        end
+      end
+    end
+    
+    class << self
+      
+      # @param [String] the API key
+      #
+      def api_key=(key)
+        @@api_key = key
+      end
+      
+      # Return the API key
+      #
+      def api_key
+        @@api_key
+      end
+      
+      # @param [Integer] the file_uid
+      #
+      def file_uid=(uid)
+        @@file_uid = uid
+      end
+      
+      # Returns the file_uid
+      #
+      def file_uid
+        @@file_uid
+      end
+      
+      # Returns all resources matching the supplied conditions
+      # @param [Hash] conditions for the request
+      #
+      def all(options = {})
+        response = get(options)
+        xml      = Nokogiri::XML(response).css("#{defaults[:collection_name]}")
+        
+        collection = xml.inject([]) do |result, item|
+          result << new(item)
+          result
+        end
+        collection
+      end
+      
+      # Finds a specific resource by its uid
+      # @param [Integer] the uid
+      #
+      def find(uid)
+        response = get({:uid => uid}, false)
+        xml      = Nokogiri::XML(response).css("#{defaults[:resource_name]}")
+        new(xml.first)
+      end
+      
+      # Allows defaults for the object to be set.
+      # Generally the class name will be suitable and options will not need to be provided
+      # @param [Hash] options to override the default settings
+      #
+      def defaults(options = {})
+        default_options.merge!(options)
+      end
+       
+      protected
+        
+        # Default options for the class
+        #
+        def default_options
+          defaults                   = {}
+          defaults[:resource_name]   = name.split("::").last.downcase
+          defaults[:collection_name] = name.split("::").last.downcase + "ListItem"
+          defaults
+        end
+        
+        # Defines the fields for a resource and any transformations
+        # @param [Hash] key/value pair of field name and object type
+        #
+        def fields(fields = {})
+          fields.each do |k,v|
+            define_accessor(k.underscore, v)
+          end
+        end
+        
+        def define_accessor(field, type)
+          m = field.sub(/#{defaults[:resource_name]}_/, "")
+          case type
+          when :decimal
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = v.to_f
+              end
+            END
+          when :date
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = Date.parse(v)
+              end
+            END
+          when :integer
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = v.to_i
+              end
+            END
+          when :boolean
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = (v.match(/true/i) ? true : false)
+              end
+            END
+          when :array
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = v.split(",")
+              end
+            END
+          else
+            class_eval <<-END
+              def #{m}=(v)
+                @#{m} = v
+              end
+            END
+          end
+          
+          class_eval <<-END
+            def #{m}
+              @#{m}
+            end
+          END
+        end
+        
+        # Makes the request to saasu
+        # @param [Hash] options for the request
+        # @param [Boolean] toggles searching between collection and a singular resource
+        #
+        def get(options = {}, all = true)
+          uri              = URI.parse(request_path(options, all))
+          puts request_path(options, all)
+          http             = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl     = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          response         = http.request(Net::HTTP::Get.new(uri.request_uri))
+          puts response.body
+          (options[:format] && options[:format] == "pdf") ? response.body : response.body
+        end
+        
+        def query_string(options = {})
+          options = { :wsaccesskey => api_key, :fileuid => file_uid }.merge!(options)
+          options.map { |k,v| "#{k.to_s.gsub(/_/, "")}=#{v}"}.join("&")
+        end
+        
+        def request_path(options = {}, all = true)
+          path = (all == true ? defaults[:collection_name].sub(/Item/, "") : defaults[:resource_name])
+          ENDPOINT + "/#{path}?#{query_string(options)}"
+        end
+      
+    end
+    
+  end
+
+end

data/lib/saasu/invoice.rb

@@ -0,0 +1,42 @@
+module Saasu
+  
+  class Invoice < Base
+    
+    fields "uid"                       => :integer,
+           "lastUpdatedUid"            => :string,
+           "transactionType"           => :string,
+           "date"                      => :date,
+           "dueOrExpiryDate"           => :date,
+           "utcFirstCreated"           => :date,
+           "utcLastModified"           => :date,
+           "summary"                   => :string,
+           "invoiceNumber"             => :string,
+           "purchaseOrderNumber"       => :string,
+           "dueDate"                   => :date,
+           "ccy"                       => :string,
+           "autoPopulateFxRate"        => :boolean,
+           "fcToBcFxRate"              => :decimal,
+           "paymentCount"              => :integer,
+           "totalAmountInclTax"        => :decimal,
+           "amountOwed"                => :decimal,
+           "paidStatus"                => :string,
+           "requiresFollowUp"          => :boolean,
+           "isSent"                    => :boolean,
+           "layout"                    => :string,
+           "status"                    => :string,
+           "typeUid"                   => :string,
+           "contactUid"                => :integer,
+           "contactGivenName"          => :string,
+           "contactFamilyName"         => :string,
+           "contactOrganisationName"   => :string,
+           "shipToContactUid"          => :string,
+           "shipToContactFirstname"    => :string,
+           "shipToContactLastName"     => :string,
+           "shipToContactOrganisation" => :string,
+           "tags"                      => :array,
+           "totalAmountPaid"           => :decimal,
+           "invoiceItems"              => :array
+      
+  end
+  
+end

data/lib/saasu.rb

@@ -0,0 +1,10 @@
+$:.unshift File.join(File.dirname(__FILE__))
+
+require "rubygems"
+require "uri"
+require "net/https"
+require "nokogiri"
+require "active_support/inflector"
+
+require "saasu/base"
+require "saasu/invoice"

data/saasu.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{saasu}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kieran Johnson"]
+  s.date = %q{2011-08-24}
+  s.description = %q{Ruby wrapper for the Saasu api}
+  s.email = %q{hello@invisiblelines.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/saasu.rb",
+    "lib/saasu/base.rb",
+    "lib/saasu/invoice.rb",
+    "saasu.gemspec",
+    "spec/base_spec.rb",
+    "spec/mocks/invoice.xml",
+    "spec/mocks/invoice_item.xml",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kieranj/saasu}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby wrapper for the Saasu api}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/base_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe "Saasu::Base" do
+  
+  it "should set the default option for collection_name" do
+    Saasu::Invoice.defaults[:collection_name].should eql("invoiceListItem")
+  end
+  
+  it "should set the default option for resource_name" do
+    Saasu::Invoice.defaults[:resource_name].should eql("invoice")
+  end
+  
+  describe "fields" do
+    
+    before do
+      file     = open(File.join(File.dirname(__FILE__), "mocks", "invoice_item.xml"))
+      xml      = Nokogiri::XML(file).css("invoiceListItem")
+      @invoice = Saasu::Invoice.new(xml)
+    end
+    
+    it "should define accessors for all fields listed" do
+      @invoice.methods.should include("uid=")
+      @invoice.methods.should include("uid")
+    end
+    
+    it "should cast any field listed as a decimal to a float" do
+      @invoice.amount_owed.should be_an_instance_of(Float)
+    end
+    
+    it "should cast any field listed as a date to a date" do
+      @invoice.date.should be_an_instance_of(Date)
+    end
+    
+    it "should cast any field listed as a integer to a integer" do
+      @invoice.uid.should be_an_instance_of(Fixnum)
+    end
+    
+    describe "boolean fields" do
+      
+      it "should cast any field listed as a boolean, with a value of true as true" do
+        @invoice.is_sent.should eql(true)
+      end
+    
+      it "should cast any field listed as a boolean, with a value of false as false" do
+        @invoice.requires_follow_up.should eql(false)
+      end
+      
+    end
+    
+    it "should cast any field listed as a array to a array" do
+      @invoice.tags.should be_an_instance_of(Array)
+    end
+      
+  end
+  
+end

data/spec/mocks/invoice.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="utf-8"?> 
+<invoiceResponse> 
+  <invoice uid="5335574" lastUpdatedUid="AAAAAAM//Ic="> 
+    <utcFirstCreated>2011-02-21T10:05:40</utcFirstCreated> 
+    <utcLastModified>2011-02-22T09:20:01</utcLastModified> 
+    <transactionType>S</transactionType> 
+    <date>2011-02-21</date> 
+    <contactUid>1098116</contactUid> 
+    <ccy>GBP</ccy> 
+    <autoPopulateFxRate>false</autoPopulateFxRate> 
+    <fcToBcFxRate>1.0000000000</fcToBcFxRate> 
+    <requiresFollowUp>false</requiresFollowUp> 
+    <layout>S</layout> 
+    <status>I</status> 
+    <invoiceNumber>2</invoiceNumber> 
+    <invoiceItems> 
+      <serviceInvoiceItem> 
+        <description>ghfj</description> 
+        <accountUid>10</accountUid> 
+        <totalAmountInclTax>100.0000</totalAmountInclTax> 
+      </serviceInvoiceItem> 
+    </invoiceItems> 
+    <isSent>false</isSent> 
+  </invoice> 
+</invoiceResponse>

data/spec/mocks/invoice_item.xml

@@ -0,0 +1,33 @@
+<invoiceListItem>
+  <invoiceUid>5335574</invoiceUid>
+  <lastUpdatedUid>AAAAAAM//Ic=</lastUpdatedUid>
+  <ccy>GBP</ccy>
+  <autoPopulateFXRate>false</autoPopulateFXRate>
+  <fcToBcFxRate>1.0000000000</fcToBcFxRate>
+  <transactionType>S</transactionType>
+  <invoiceDate>2011-02-21</invoiceDate>
+  <utcFirstCreated>2011-02-21T10:05:40</utcFirstCreated>
+  <utcLastModified>2011-02-22T09:20:01</utcLastModified>
+  <summary/>
+  <invoiceNumber>2</invoiceNumber>
+  <purchaseOrderNumber/>
+  <dueDate/>
+  <totalAmountInclTax>100.0000</totalAmountInclTax>
+  <paymentCount>0</paymentCount>
+  <totalAmountPaid>0.0000</totalAmountPaid>
+  <amountOwed>100.0000</amountOwed>
+  <paidStatus>Unpaid</paidStatus>
+  <requiresFollowUp>False</requiresFollowUp>
+  <isSent>True</isSent>
+  <invoiceLayout>S</invoiceLayout>
+  <invoiceStatus>I</invoiceStatus>
+  <contactUid>1098116</contactUid>
+  <contactGivenName>tom</contactGivenName>
+  <contactFamilyName>jones</contactFamilyName>
+  <contactOrganisationName/>
+  <shipToContactUid/>
+  <shipToContactGivenName/>
+  <shipToContactLastName/>
+  <shipToContactOrganisation/>
+  <tags>urgent,important</tags>
+</invoiceListItem>

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+%w(rubygems rspec open-uri).each { |lib| require lib }
+
+require File.dirname(__FILE__) + '/../lib/saasu'

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification 
+name: saasu
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kieran Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: nokogiri
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: yard
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+description: Ruby wrapper for the Saasu api
+email: hello@invisiblelines.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/saasu.rb
+- lib/saasu/base.rb
+- lib/saasu/invoice.rb
+- saasu.gemspec
+- spec/base_spec.rb
+- spec/mocks/invoice.xml
+- spec/mocks/invoice_item.xml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kieranj/saasu
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Saasu api
+test_files: []
+