quickeebooks 0.0.2

data/lib/quickeebooks/windows/model/vendor_reference.rb

@@ -0,0 +1,13 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class VendorReference < IntuitType
+        xml_accessor :vendor_id, :from => 'VendorId'
+        xml_accessor :vendor_name, :from => 'VendorName'
+      
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/web_site.rb

@@ -0,0 +1,19 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class WebSite < Quickeebooks::Windows::Model::IntuitType
+        xml_accessor :id, :from => 'Id'
+        xml_accessor :uri, :from => 'URI'
+        xml_accessor :tag, :from => 'Tag'
+        xml_accessor :default, :from => 'Default'
+
+        def to_xml(options = {})
+          return "" if uri.to_s.empty?
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/service/account.rb

@@ -0,0 +1,16 @@
+require 'quickeebooks/windows/model/account'
+require 'quickeebooks/windows/service/service_base'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class Account < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection("accounts", "Account", Quickeebooks::Windows::Model::Account, nil, filters, page, per_page, sort, options)
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/service/customer.rb

@@ -0,0 +1,16 @@
+require 'quickeebooks/windows/service/service_base'
+require 'nokogiri'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class Customer < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection("customer", "Customer", Quickeebooks::Windows::Model::Customer, nil, filters, page, per_page, sort, options)
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/service/invoice.rb

@@ -0,0 +1,27 @@
+require 'quickeebooks/windows/service/service_base'
+require 'quickeebooks/windows/model/invoice'
+require 'quickeebooks/windows/model/invoice_header'
+require 'quickeebooks/windows/model/invoice_line_item'
+require 'tempfile'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class Invoice < Quickeebooks::Windows::Service::ServiceBase
+
+
+        # Fetch a +Collection+ of +Invoice+ objects
+        # Arguments:
+        # filters: Array of +Filter+ objects to apply
+        # page: +Fixnum+ Starting page
+        # per_page: +Fixnum+ How many results to fetch per page
+        # sort: +Sort+ object
+        # options: +Hash+ extra arguments
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection("invoices", "Invoice", Quickeebooks::Windows::Model::Invoice, nil, filters, page, per_page, sort, options)
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/service/item.rb

@@ -0,0 +1,18 @@
+require 'quickeebooks/windows/model/item'
+require 'quickeebooks/windows/service/service_base'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class Item < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          custom_field_query = '<ItemQuery xmlns="http://www.intuit.com/sb/cdm/v2"><CustomFieldEnable>true</CustomFieldEnable></ItemQuery>'
+          fetch_collection("item", "Item", Quickeebooks::Windows::Model::Item, custom_field_query, filters, page, per_page, sort, options)
+        end
+
+      end
+    end
+    
+  end
+end

data/lib/quickeebooks/windows/service/service_base.rb

@@ -0,0 +1,176 @@
+require 'rexml/document'
+require 'uri'
+require 'cgi'
+
+class IntuitRequestException < Exception
+  attr_accessor :code, :cause
+  def initialize(msg)
+    super(msg)
+  end
+end
+class AuthorizationFailure < Exception; end
+
+module Quickeebooks
+  module Windows
+    module Service
+      class ServiceBase
+
+        attr_accessor :realm_id
+        attr_accessor :oauth
+        attr_reader :base_uri
+        attr_reader :last_response_body
+        attr_reader :last_response_xml
+
+        XML_NS = %{xmlns:ns2="http://www.intuit.com/sb/cdm/qbo" xmlns="http://www.intuit.com/sb/cdm/v2" xmlns:ns3="http://www.intuit.com/sb/cdm"}
+
+        def initialize(oauth_access_token, realm_id)
+          @base_uri = 'https://services.intuit.com/sb'
+          @oauth = oauth_access_token
+          @realm_id = realm_id
+        end
+
+        def url_for_resource(resource)
+          url_for_base(resource)
+        end
+
+        def url_for_base(raw)
+          "#{@base_uri}/#{raw}/v2/#{@realm_id}"
+        end
+
+        private
+
+        def parse_xml(xml)
+          @last_response_xml ||= 
+          begin
+            x = Nokogiri::XML(xml)
+            #x.document.remove_namespaces!
+            x
+          end
+        end
+
+        def valid_xml_document(xml)
+          %Q{<?xml version="1.0" encoding="utf-8"?>\n#{xml.strip}}
+        end
+
+        def fetch_collection(resource, container, model, custom_field_query = nil, filters = [], page = 1, per_page = 20, sort = nil, options ={})
+          raise ArgumentError, "missing resource to fetch" if resource.nil?
+          raise ArgumentError, "missing result container" if container.nil?
+          raise ArgumentError, "missing model to instantiate" if model.nil?
+
+          if custom_field_query != nil
+            response = do_http_post(url_for_resource(resource), custom_field_query, {}, {'Content-Type' => 'text/xml'})
+          else
+            response = do_http_get(url_for_resource(resource), {}, {'Content-Type' => 'text/html'})
+          end
+          if response
+            collection = Quickeebooks::Collection.new
+            xml = parse_xml(response.body)
+            begin
+              results = []
+              path_to_nodes = "//xmlns:RestResponse/xmlns:#{model::XML_COLLECTION_NODE}/xmlns:#{model::XML_NODE}"
+              collection.count = xml.xpath(path_to_nodes).count
+              if collection.count > 0
+                xml.xpath(path_to_nodes).each do |xa|
+                  entry = model.from_xml(xa)
+                  results << entry
+                end
+              end
+              collection.entries = results
+              collection.current_page = 1 # TODO: fix this
+            rescue => ex
+              log("Error parsing XML: #{ex.message}")
+              raise IntuitRequestException.new("Error parsing XML: #{ex.message}")
+            end
+            collection
+          else
+            nil
+          end
+        end
+
+        def do_http_post(url, body = "", params = {}, headers = {}) # throws IntuitRequestException
+          url = add_query_string_to_url(url, params)
+          do_http(:post, url, body, headers)
+        end
+
+        def do_http_get(url, params = {}, headers = {}) # throws IntuitRequestException
+          url = add_query_string_to_url(url, params)
+          do_http(:get, url, "", headers)
+        end
+
+        def do_http(method, url, body, headers) # throws IntuitRequestException
+          unless headers.has_key?('Content-Type')
+            headers.merge!({'Content-Type' => 'application/xml'})
+          end
+          # puts "METHOD = #{method}"
+          # puts "URL = #{url}"
+          # puts "BODY = #{body == nil ? "<NIL>" : body}"
+          # puts "HEADERS = #{headers.inspect}"
+          response = @oauth.request(method, url, body, headers)
+          check_response(response)
+        end
+
+        def add_query_string_to_url(url, params)
+          if params.is_a?(Hash) && !params.empty?
+            url + "?" + params.collect { |k| "#{k.first}=#{k.last}" }.join("&")
+          else
+            url
+          end
+        end
+
+        def check_response(response)
+          #puts "HTTP Response: #{response.code}"
+          parse_xml(response.body)
+          status = response.code.to_i
+          case status
+          when 200
+            # even HTTP 200 can contain an error, so we always have to peek for an Error
+            if response_is_error?
+              parse_and_raise_exceptione
+            else
+              response
+            end
+          when 302
+            raise "Unhandled HTTP Redirect"
+          when 401
+            raise AuthorizationFailure
+          when 400, 500
+            parse_and_raise_exceptione
+          else
+            raise "HTTP Error Code: #{status}, Msg: #{response.body}"
+          end
+        end
+        
+        def parse_and_raise_exceptione
+          err = parse_intuit_error
+          ex = IntuitRequestException.new(err[:message])
+          ex.code = err[:code]
+          ex.cause = err[:cause]
+          raise ex
+        end
+        
+        def response_is_error?
+          @last_response_xml.xpath("//xmlns:RestResponse/xmlns:Error").first != nil
+        end
+
+        def parse_intuit_error
+          error = {:message => "", :code => 0, :cause => ""}
+          fault = @last_response_xml.xpath("//xmlns:RestResponse/xmlns:Error/xmlns:ErrorDesc")[0]
+          if fault
+            error[:message] = fault.text
+          end
+          error_code = @last_response_xml.xpath("//xmlns:RestResponse/xmlns:Error/xmlns:ErrorCode")[0]
+          if error_code
+            error[:code] = error_code.text
+          end
+          error
+        end
+
+        def log(msg)
+          Quickeebooks.logger.info(msg)
+          Quickeebooks.logger.flush if Quickeebooks.logger.respond_to?(:flush)
+        end
+
+      end
+    end
+  end
+end

data/quickeebooks.gemspec

@@ -0,0 +1,27 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "quickeebooks/version"
+
+Gem::Specification.new do |gem|
+  gem.name     = "quickeebooks"
+  gem.version  = Quickeebooks::VERSION
+
+  gem.author   = "Cody Caughlan"
+  gem.email    = "toolbag@gmail.com"
+  gem.homepage = "http://github.com/ruckus/quickeebooks"
+  gem.summary  = "REST integration with Quickbooks Online"
+
+  gem.description = gem.summary
+
+  gem.files = Dir["**/*"]#.select { |d| d =~ %r{^(README|bin/|data/|ext/|lib/|spec/|test/)} }
+
+  gem.add_dependency 'roxml'
+  gem.add_dependency 'oauth'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'activemodel'
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rcov',   '~> 0.9.8'
+  gem.add_development_dependency 'rr',     '~> 1.0.2'
+  gem.add_development_dependency 'rspec',  '~> 2.0.0'
+  gem.add_development_dependency 'fakeweb'
+end

data/spec/mocks/oauth_consumer_mock.rb

@@ -0,0 +1,2 @@
+class OauthConsumerMock
+end

data/spec/quickeebooks/online/account_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+require "stringio"
+require "quickeebooks/online/model/account"
+
+describe "Quickeebooks::Online::Model::Account" do
+  
+  it "should convert Ruby to XML" do
+    account = Quickeebooks::Online::Model::Account.new
+    account.sync_token = 1
+    account.name = "John Doe"
+    expected = "<Account><Name>John Doe</Name></Account>"
+    # we have to jump through some hoops to get a non-pretty version for easier comparison
+    s = StringIO.new
+    xml = account.to_xml(:fields => 'Name').write_to(s, :indent => 0, :indent_text => '')
+    xml.string.gsub(/\n/, '').should == expected
+  end
+  
+  it "has a validation error on invalid subtype" do
+    account = Quickeebooks::Online::Model::Account.new
+    account.sub_type = "invalid"
+    account.valid?.should == false
+  end
+
+  it "has a validation error when required attributes are not given" do
+    account = Quickeebooks::Online::Model::Account.new
+    account.valid?.should == false
+  end
+
+  it "should pass validation when all required attributes are given" do
+    account = Quickeebooks::Online::Model::Account.new
+    account.name = "John Doe"
+    account.sub_type = "AccountsPayable"
+    account.valid?.should == true
+  end
+  
+  it "cannot delete an Account without providing required fields" do
+    account = Quickeebooks::Online::Model::Account.new
+    account.valid_for_deletion?.should == false
+  end
+  
+end

data/spec/quickeebooks/online/customer_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+require "quickeebooks/online/model/customer"
+
+describe "Quickeebooks::Online::Model::Customer" do
+  
+  it "parse customer from XML" do
+    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/customer.xml")
+    customer = Quickeebooks::Online::Model::Customer.from_xml(xml)
+    customer.sync_token.should == 1
+    customer.name.should == "John Doe"
+    
+    create_time = Date.civil(2011, 9, 29)
+    customer.meta_data.create_time.year.should == create_time.year
+    customer.addresses.count.should == 2
+    
+    customer.addresses.first.line1.should == "123 Main St."
+    
+    customer.phones.size.should == 2
+    customer.phones.first.free_form_number.should == "(408) 555-1212"
+    
+    customer.email.address.should == "johndoe@gmail.com"
+    
+    customer.notes.count.should == 1
+    customer.notes.first.content.should == "Likes chocolate and horses"
+
+    customer.custom_fields.count.should == 3
+
+    customer.open_balance.amount.should == 6200.0
+  end
+  
+  it "can assign an email address" do
+    customer = Quickeebooks::Online::Model::Customer.new
+    the_email = "foo@example.org"
+    customer.email_address = the_email
+    customer.email.is_a?(Quickeebooks::Online::Model::Email).should == true
+    customer.email.address.should == the_email
+  end
+  
+  it "cannot update an invalid model" do
+    customer = Quickeebooks::Online::Model::Customer.new
+    customer.valid_for_update?.should == false
+    customer.errors.keys.include?(:sync_token).should == true
+  end
+  
+end

data/spec/quickeebooks/online/invoice_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+require "quickeebooks/online/model/invoice"
+
+describe "Quickeebooks::Online::Model::Invoice" do
+  
+  describe "parse invoice from XML" do
+    xml = File.read(File.dirname(__FILE__) + "/../../xml/online/invoice.xml")
+    invoice = Quickeebooks::Online::Model::Invoice.from_xml(xml)
+    invoice.id.should == 28
+    invoice.line_items.count.should == 1
+    invoice.line_items.first.unit_price.should == 100
+  end
+  
+end

data/spec/quickeebooks/online/services/account_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+require "fakeweb"
+require "oauth"
+require "quickeebooks/online/service/account"
+
+describe "Quickeebooks::Online::Service::Account" do
+  before(:all) do
+    FakeWeb.allow_net_connect = false
+    qb_key = "key"
+    qb_secret = "secreet"
+
+    @realm_id = "9991111222"
+    @base_uri = "https://qbo.intuit.com/qbo36"
+    @oauth_consumer = OAuth::Consumer.new(qb_key, qb_key, {
+        :site                 => "https://oauth.intuit.com",
+        :request_token_path   => "/oauth/v1/get_request_token",
+        :authorize_path       => "/oauth/v1/get_access_token",
+        :access_token_path    => "/oauth/v1/get_access_token"
+    })
+    @oauth = OAuth::AccessToken.new(@oauth_consumer, "blah", "blah")
+  end
+  
+  it "receives 404 from invalid base URL" do
+    uri = "https://qbo.intuit.com/invalid"
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, uri)
+    FakeWeb.register_uri(:post, service.url_for_resource("accounts"), :status => ["200", "OK"], :body => "blah")
+    lambda { service.list }.should raise_error(IntuitRequestException)
+  end
+  
+  it "can fetch a list of accounts" do
+    xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/accounts.xml")
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    FakeWeb.register_uri(:post, service.url_for_resource("accounts"), :status => ["200", "OK"], :body => xml)
+    accounts = service.list
+    accounts.current_page.should == 1
+    accounts.entries.count.should == 10
+    accounts.entries.first.current_balance.should == 6200
+  end
+  
+  it "can create an account" do
+    xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/account.xml")
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    FakeWeb.register_uri(:post, service.url_for_resource("account"), :status => ["200", "OK"], :body => xml)
+    account = Quickeebooks::Online::Model::Account.new
+    account.name = "Billy Bob"
+    account.sub_type = "AccountsPayable"
+    account.valid?.should == true
+    result = service.create(account)
+    result.id.to_i.should > 0
+  end
+
+  it "can delete an account" do
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    url = "#{service.url_for_resource("account")}/99?methodx=delete"
+    FakeWeb.register_uri(:post, url, :status => ["200", "OK"])
+    account = Quickeebooks::Online::Model::Account.new
+    account.id = 99
+    account.sync_token = 0
+    result = service.delete(account)
+    result.should == true
+  end
+  
+  it "cannot delete an account with missing required fields for deletion" do
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    account = Quickeebooks::Online::Model::Account.new
+    lambda { service.delete(account) }.should raise_error(InvalidModelException, "Missing required parameters for delete")
+  end
+  
+  it "exception is raised when we try to create an invalid account" do
+    account = Quickeebooks::Online::Model::Account.new
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    lambda { service.create(account) }.should raise_error(InvalidModelException)
+  end
+  
+  it "can fetch an account by id" do
+    xml = File.read(File.dirname(__FILE__) + "/../../../xml/online/account.xml")
+    service = Quickeebooks::Online::Service::Account.new(@oauth, @realm_id, @base_uri)
+    url = "#{service.url_for_resource("account")}/99"
+    FakeWeb.register_uri(:get, url, :status => ["200", "OK"], :body => xml)
+    account = service.fetch_by_id(99)
+    account.name.should == "Billy Bob"
+  end
+  
+end