quickbooks-ruby-oauth2 0.6.1

data/lib/quickbooks/service/responses/oauth_http_response.rb

@@ -0,0 +1,21 @@
+module Quickbooks
+  module Service
+    module Responses
+
+      # This class just proxies and returns a wrapped response so that callers
+      # can invoke a common interface
+      class OAuthHttpResponse
+
+        def self.wrap(response)
+          if response.is_a?(OAuth2::Response)
+            Quickbooks::Service::Responses::OAuth2HttpResponse.new(response)
+          else
+            Quickbooks::Service::Responses::OAuth1HttpResponse.new(response)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/sales_receipt.rb

@@ -0,0 +1,46 @@
+module Quickbooks
+  module Service
+    class SalesReceipt < BaseService
+
+      def delete(sales_receipt)
+        delete_by_query_string(sales_receipt)
+      end
+
+      def pdf(sales_receipt)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{sales_receipt.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
+      def send(sr, email_address=nil)
+        query = email_address.present? ? "?sendTo=#{email_address}" : ""
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{sr.id}/send#{query}"
+        response = do_http_post(url,{})
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          nil
+        end
+      end
+
+      def void(sales_receipt, options = {})
+        raise Quickbooks::InvalidModelException.new(sales_receipt.errors.full_messages.join(',')) unless sales_receipt.valid?
+        xml = sales_receipt.to_xml_ns(options)
+        url = "#{url_for_resource(model::REST_RESOURCE)}?include=void"
+
+        response = do_http_post(url, valid_xml_document(xml), {})
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          false
+        end
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::SalesReceipt
+      end
+    end
+  end
+end

data/lib/quickbooks/service/service_crud.rb

@@ -0,0 +1,75 @@
+module Quickbooks
+  module Service
+    module ServiceCrud
+
+      def query(object_query = nil, options = {})
+        fetch_collection(object_query, model, options)
+      end
+
+      # fetch all records, returns an array of models
+      def all(object_query=nil, options={})
+        collection = []
+        self.query_in_batches(object_query, options) do |batch|
+          collection << batch.entries
+        end
+        collection.flatten
+      end
+
+      def query_in_batches(object_query=nil, options={})
+        page = 0
+        per_page = options.delete(:per_page) || 1_000
+        begin
+          page += 1
+          results = query(object_query, page: page, per_page: per_page)
+          yield results if results.count > 0
+        end until results.count < per_page
+      end
+
+      def exists?(field, selector, options={})
+        find_by(field, selector, options).count > 0
+      end
+
+      def find_by(field, selector, options={})
+        if field.class == Symbol
+          field = field.to_s.camelcase
+        end
+        q = "select * from %s where %s = '%s'" % [model.resource_for_singular, field, selector]
+        self.query(q, options)
+      end
+
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_resource(model.resource_for_singular)}/#{id}"
+        fetch_object(model, url, params)
+      end
+
+      def create(entity, options = {})
+        raise Quickbooks::InvalidModelException.new(entity.errors.full_messages.join(',')) unless entity.valid?
+        xml = entity.to_xml_ns(options)
+
+        response = do_http_post(url_for_resource(model.resource_for_singular), valid_xml_document(xml), options[:query])
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body))
+        else
+          nil
+        end
+      end
+      alias :update :create
+
+      def delete(entity)
+        raise NotImplementedError
+      end
+
+      def delete_by_query_string(entity, options = {})
+        url = "#{url_for_resource(model::REST_RESOURCE)}?operation=delete"
+
+        xml = entity.to_xml_ns(options)
+        response = do_http_post(url, valid_xml_document(xml))
+        if response.code.to_i == 200
+          parse_singular_entity_response_for_delete(model, response.plain_body)
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/quickbooks/service/service_crud_json.rb

@@ -0,0 +1,31 @@
+module Quickbooks
+  module Service
+    module ServiceCrudJSON
+
+      def fetch_by_id(id, params = {})
+        raise NotImplementedError
+      end
+
+      def create(entity, options = {})
+        raise Quickbooks::InvalidModelException.new(entity.errors.full_messages.join(',')) unless entity.valid?
+        response = do_http(:post, url_for_resource(model.resource_for_singular), entity.to_json, options)
+        if response.code.to_i == 200
+          JSON.parse(response.plain_body)
+        else
+          nil
+        end
+      end
+      alias :update :create
+
+      def delete
+        raise NotImplementedError
+      end
+
+      def delete_by_query_string
+        raise NotImplementedError
+      end
+
+    end
+  end
+end
+

data/lib/quickbooks/service/tax_agency.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Service
+    class TaxAgency < BaseService
+
+      private
+
+      def model
+        Quickbooks::Model::TaxAgency
+      end
+    end
+  end
+end

data/lib/quickbooks/service/tax_code.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Service
+    class TaxCode < BaseService
+
+      private
+
+      def model
+        Quickbooks::Model::TaxCode
+      end
+    end
+  end
+end

data/lib/quickbooks/service/tax_rate.rb

@@ -0,0 +1,12 @@
+module Quickbooks
+  module Service
+    class TaxRate < BaseService
+
+      private
+
+      def model
+        Quickbooks::Model::TaxRate
+      end
+    end
+  end
+end

data/lib/quickbooks/service/tax_service.rb

@@ -0,0 +1,11 @@
+module Quickbooks
+  module Service
+    class TaxService < BaseServiceJSON
+      private
+
+      def model
+        Quickbooks::Model::TaxService
+      end
+    end
+  end
+end

data/lib/quickbooks/service/term.rb

@@ -0,0 +1,17 @@
+module Quickbooks
+  module Service
+    class Term < BaseService
+
+      def delete(term)
+        term.active = false
+        update(term, :sparse => true)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Term
+      end
+    end
+  end
+end

data/lib/quickbooks/service/time_activity.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class TimeActivity < BaseService
+
+      def delete(time_activity)
+        delete_by_query_string(time_activity)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::TimeActivity
+      end
+    end
+  end
+end

data/lib/quickbooks/service/transfer.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class Transfer < BaseService
+
+      def delete(transfer)
+        delete_by_query_string(transfer)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Transfer
+      end
+    end
+  end
+end

data/lib/quickbooks/service/upload.rb

@@ -0,0 +1,39 @@
+module Quickbooks
+  module Service
+    class Upload < BaseService
+
+      XML_NODE = "AttachableResponse"
+
+      # path_to_file: String - path to file
+      # mime_type: String - the MIME type of the file, e.g. image/jpeg
+      # attachable: Quickbooks::Model::Attachable meta-data details, can be null
+      def upload(path_to_file, mime_type, attachable = nil)
+        url = url_for_resource("upload")
+        uploadIO = class_for_io.new(path_to_file, mime_type)
+        response = do_http_file_upload(uploadIO, url, attachable)
+        prefix = "AttachableResponse/xmlns:Attachable"
+        if response.code.to_i == 200
+          model.from_xml(parse_singular_entity_response(model, response.plain_body, prefix))
+        else
+          nil
+        end
+      end
+
+      def class_for_io
+        oauth.is_a?(OAuth2::AccessToken) ? Faraday::UploadIO : UploadIO
+      end
+
+      def download(uploadId)
+        url = url_for_resource("download/#{uploadId}")
+        do_http_get(url, {}, headers)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Attachable
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/vendor.rb

@@ -0,0 +1,24 @@
+module Quickbooks
+  module Service
+    class Vendor < BaseService
+
+      # override update as sparse is not supported
+      def update(entity, options = {})
+        raise InvalidModelException.new('Vendor sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(vendor)
+        vendor.active = false
+        update(vendor, :sparse => false)
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::Vendor
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/vendor_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class VendorChange < ChangeService
+
+      private
+
+      def entity
+        "Vendor"
+      end
+
+      def model
+        Quickbooks::Model::VendorChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/vendor_credit.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class VendorCredit < BaseService
+
+      def delete(vendor_credit)
+        delete_by_query_string(vendor_credit)
+      end
+
+      private
+      
+      def model
+        Quickbooks::Model::VendorCredit
+      end
+    end
+  end
+end

data/lib/quickbooks/util/collection.rb

@@ -0,0 +1,18 @@
+module Quickbooks
+  class Collection
+    include Enumerable
+    attr_accessor :entries
+
+    attr_accessor :body
+
+    # Legacy Attributes (v2)
+    attr_accessor :count, :current_page
+
+    # v3 Attributes
+    attr_accessor :start_position, :max_results, :total_count
+
+    def each(*args, &block)
+      (entries|| []).each *args, &block
+    end
+  end
+end

data/lib/quickbooks/util/http_encoding_helper.rb

@@ -0,0 +1,54 @@
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"
+# end
+#
+
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+
+    encoding = self['Content-Encoding']
+    @_content ||= nil
+
+    return @_content if @_content
+
+    if encoding
+      case encoding
+        when 'gzip'
+          i = Zlib::GzipReader.new(StringIO.new(self.body))
+          @_content = i.read
+        when 'deflate'
+          i = Zlib::Inflate.new
+          @_content = i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      @_content = self.body
+    end
+
+    @_content
+  end
+end

data/lib/quickbooks/util/logging.rb

@@ -0,0 +1,19 @@
+module Quickbooks
+  module Util
+    module Logging
+      def log(msg)
+        ::Quickbooks.log(msg)
+      end
+
+      def log_xml(str)
+        if ::Quickbooks.log_xml_pretty_print? && !(str and str.empty?)
+          Nokogiri::XML(str).to_xml
+        else
+          str
+        end
+      rescue => e
+        e
+      end
+    end
+  end
+end

data/lib/quickbooks/util/multipart.rb

@@ -0,0 +1,85 @@
+module OauthMultipart
+end
+
+require "oauth"
+
+OAuth::Consumer.class_eval do
+  def create_http_request(http_method, path, *arguments)
+    http_method = http_method.to_sym
+
+    if [:post, :put].include?(http_method)
+      data = arguments.shift
+    end
+
+    # if the base site contains a path, add it now
+    uri = URI.parse(site)
+    path = uri.path + path if uri.path
+
+    headers = arguments.first.is_a?(Hash) ? arguments.shift : {}
+
+    case http_method
+    when :post
+      request = Net::HTTP::Post.new(path,headers)
+      request["Content-Length"] = '0' # Default to 0
+    when :put
+      request = Net::HTTP::Put.new(path,headers)
+      request["Content-Length"] = '0' # Default to 0
+    when :get
+      request = Net::HTTP::Get.new(path,headers)
+    when :delete
+      request =  Net::HTTP::Delete.new(path,headers)
+
+    when :head
+      request = Net::HTTP::Head.new(path,headers)
+    when :multipart_post
+      request = Net::HTTP::Post::Multipart.new(path, headers)
+    else
+      raise ArgumentError, "Don't know how to handle http_method: :#{http_method.to_s}"
+    end
+
+    if data.is_a?(Hash)
+      form_data = {}
+      data.each {|k,v| form_data[k.to_s] = v if !v.nil?}
+      request.set_form_data(form_data)
+    elsif data
+      if data.respond_to?(:read)
+        request.body_stream = data
+        if data.respond_to?(:length)
+          request["Content-Length"] = data.length.to_s
+        elsif data.respond_to?(:stat) && data.stat.respond_to?(:size)
+          request["Content-Length"] = data.stat.size.to_s
+        else
+          raise ArgumentError, "Don't know how to send a body_stream that doesn't respond to .length or .stat.size"
+        end
+      else
+        request.body = data.to_s
+        request["Content-Length"] = request.body.length.to_s
+      end
+    end
+
+    request
+
+  end
+end
+
+OAuth::AccessToken.class_eval do
+
+  def post_with_multipart(*args)
+    multipart_post *args
+  end
+
+  def multipart_post(*args)
+   request(:multipart_post, *args)
+  end
+end
+
+OAuth2::AccessToken.class_eval do
+
+  def post_with_multipart(*args)
+    multipart_post *args
+  end
+
+  def multipart_post(*args)
+    request(:post, *args)
+  end
+end

data/lib/quickbooks/util/name_entity.rb

@@ -0,0 +1,85 @@
+module NameEntity
+
+  module Quality
+    def email_address=(email_address)
+      self.primary_email_address = Quickbooks::Model::EmailAddress.new(email_address)
+    end
+
+    def email_address
+      primary_email_address
+    end
+
+    def names_cannot_contain_invalid_characters
+      [:name, :display_name, :given_name, :middle_name, :family_name, :print_on_check_name].each do |property|
+        next unless respond_to? property
+        value = send(property).to_s
+        if value.index(':')
+          errors.add(property, ":#{property} cannot contain a colon (:).")
+        end
+      end
+    end
+
+    def email_address_is_valid
+      if primary_email_address
+        address = primary_email_address.address.to_s
+        return false if address.length == 0
+        unless address.index('@') && address.index('.')
+          errors.add(:primary_email_address, "Email address must contain @ and . (dot)")
+        end
+      end
+    end
+
+    def posting_type_is_valid
+      if posting_type
+        unless %w(Debit Credit).include?(posting_type)
+          errors.add(:posting_type, "Posting Type must be either 'Debit' or 'Credit'")
+        end
+      end
+    end
+
+    def billable_status_is_valid
+      if billable_status
+        unless %w(Billable NotBillable HasBeenBilled).include?(billable_status)
+          errors.add(:posting_type, "Posting Type must be either 'Debit' or 'Credit'")
+        end
+      end
+    end
+
+    def entity_type_is_valid
+      if entity_type
+        unless %w(Customer Vendor).include?(entity_type)
+          errors.add(:entity_type, "Entity Type must be either 'Customer' or 'Vendor'")
+        end
+      end
+    end
+
+    def journal_line_entry_tax
+      if tax_code_ref
+        # tax_applicable_on must be set
+        errors.add(:tax_applicable_on, "TaxApplicableOn must be set when TaxCodeRef is set") if tax_applicable_on.nil?
+        errors.add(:tax_amount, "TaxAmount must be set when TaxCodeRef is set") if tax_amount.nil?
+      end
+    end
+  end
+
+  module PermitAlterations
+
+    def valid_for_update?
+      if sync_token.nil?
+        errors.add(:sync_token, "Missing required attribute SyncToken for update")
+      end
+      errors.empty?
+    end
+
+    def valid_for_create?
+      valid?
+      errors.empty?
+    end
+
+    # To delete an account Intuit requires we provide Id and SyncToken fields
+    def valid_for_deletion?
+      return false if(id.nil? || sync_token.nil?)
+      id.to_i > 0 && !sync_token.to_s.empty? && sync_token.to_i >= 0
+    end
+  end
+end

data/lib/quickbooks/util/query_builder.rb

@@ -0,0 +1,35 @@
+require 'uri'
+
+module Quickbooks
+  module Util
+    class QueryBuilder
+
+      VALUE_QUOTE = "'"
+
+      def initialize
+      end
+
+      def clause(field, operator, value)
+        value = case value
+                when DateTime, Time
+                  value.iso8601
+                when Date
+                  value.strftime('%Y-%m-%d')
+                when Array
+                  value = value.map{|v| v.to_s.gsub("'", "\\\\'") }
+                else
+                  # escape single quotes with an escaped backslash
+                  value = value.gsub("'", "\\\\'")
+                end
+
+        if operator.downcase == 'in' && value.is_a?(Array)
+          value = value.map{|v| "#{VALUE_QUOTE}#{v}#{VALUE_QUOTE}"}
+          "#{field} #{operator} (#{value.join(', ')})"
+        else
+          "#{field} #{operator} #{VALUE_QUOTE}#{value}#{VALUE_QUOTE}"
+        end
+      end
+
+    end
+  end
+end

data/lib/quickbooks/version.rb

@@ -0,0 +1,5 @@
+module Quickbooks
+
+  VERSION = "0.6.1"
+
+end