quickbooks-ruby 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29ef312218c64559e66c1e6809607a401580e890
-  data.tar.gz: 0289d2568a1693c609eac8180be21f1b89bd605b
+  metadata.gz: 6f4883102897a891ec4461cf30ea0e193aeae3e0
+  data.tar.gz: 060b71166e7cf0c1d44c9fef3f6f6d776863cdb5
 SHA512:
-  metadata.gz: 0bef7a00293d97267adad435239a57c0f477ec5985c291c8251c8084e5776ce9179e490f54cc0d6d84f4488ff0ee8b83973dc26133709ad1c0289aaa299584c9
-  data.tar.gz: 687fb9ba0c4d6ec042f644864430ab5987b9ef07e60df23715326e43202e71d3e0bff606717c871a79dd9a3be43fc65c9b7c6f80645c775aa75096f52d915330
+  metadata.gz: f563e31ee5eb5614a823409262cc380876c8f3f61527eac6c4110ae1514d49aba5d1ee09b20ca58064d52db0bb39c6a4f3659fd8f4240d83dcc97e0bc992ec3f
+  data.tar.gz: e710072fff70fad89c32496dddc544945e51fc4c26c7de0f151d656a96763567e0cb8825ebe2e47c0b238a924a65bb9815ae71957d78802b2ec4bdd811af4c2f

data/lib/quickbooks-ruby.rb

@@ -10,6 +10,7 @@ require 'oauth'
 require 'quickbooks/util/logging'
 require 'quickbooks/util/class_util'
 require 'quickbooks/util/http_encoding_helper'
+require 'quickbooks/util/name_entity'
 
 #== Models
 require 'quickbooks/model/base_model'
@@ -26,8 +27,8 @@ require 'quickbooks/model/item'
 require 'quickbooks/model/account'
 require 'quickbooks/model/check_payment'
 require 'quickbooks/model/credit_card_payment'
-
 require 'quickbooks/model/telephone_number'
+require 'quickbooks/model/other_contact_info'
 require 'quickbooks/model/email_address'
 require 'quickbooks/model/web_site_address'
 require 'quickbooks/model/physical_address'
@@ -45,6 +46,8 @@ require 'quickbooks/model/bill_payment_line_item'
 require 'quickbooks/model/bill_payment_check'
 require 'quickbooks/model/bill_payment_credit_card'
 require 'quickbooks/model/bill_payment'
+require 'quickbooks/model/vendor'
+require 'quickbooks/model/employee'
 
 #== Services
 require 'quickbooks/service/base_service'
@@ -59,6 +62,8 @@ require 'quickbooks/service/payment_method'
 require 'quickbooks/service/credit_memo'
 require 'quickbooks/service/bill'
 require 'quickbooks/service/bill_payment'
+require 'quickbooks/service/vendor'
+require 'quickbooks/service/employee'
 
 unless Quickbooks::Util::ClassUtil.defined?("InvalidModelException")
   class InvalidModelException < StandardError; end

data/lib/quickbooks/model/account.rb

@@ -45,7 +45,6 @@ module Quickbooks
       #== Validations
       validates_inclusion_of :classification, :in => ACCOUNT_CLASSIFICATION
       validates_length_of :name, :minimum => 1, :maximum => 100
-      validates_length_of :description, :minimum => 1, :maximum => 100
       validate :name_cannot_contain_invalid_characters
 
       def name_cannot_contain_invalid_characters

data/lib/quickbooks/model/customer.rb

@@ -13,6 +13,8 @@ module Quickbooks
       XML_COLLECTION_NODE = "Customer"
       XML_NODE = "Customer"
       REST_RESOURCE = 'customer'
+      include NameEntity::Quality
+      include NameEntity::PermitAlterations
 
       xml_name XML_NODE
       xml_accessor :id, :from => 'Id', :as => Integer
@@ -56,10 +58,6 @@ module Quickbooks
 
       reference_setters :parent_ref, :sales_term_ref, :payment_method_ref
 
-      def active?
-        active.to_s == 'true'
-      end
-
       def job?
         job.to_s == 'true'
       end
@@ -71,51 +69,6 @@ module Quickbooks
       def taxable?
         taxable.to_s == 'true'
       end
-
-      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
-
-      def email_address=(email_address)
-        self.primary_email_address = EmailAddress.new(email_address)
-      end
-
-      def email_address
-        primary_email_address
-      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
-
-      def names_cannot_contain_invalid_characters
-        [:display_name, :given_name, :middle_name, :family_name, :print_on_check_name].each do |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
-          unless address.index('@') && address.index('.')
-            errors.add(:primary_email_address, "Email address must contain @ and . (dot)")
-          end
-        end
-      end
-
     end
   end
-end
+end

data/lib/quickbooks/model/employee.rb

@@ -0,0 +1,47 @@
+# == Business Rules
+# * DisplayName, GivenName, MiddleName, FamilyName, and PrintOnCheckName must not contain a colon (":")
+# * DisplayName must be unique across all other customers, employees, vendors, and other names.
+
+module Quickbooks
+  module Model
+    class Employee < BaseModel
+      XML_COLLECTION_NODE = "Employee"
+      XML_NODE = "Employee"
+      REST_RESOURCE = 'employee'
+      include NameEntity::Quality
+      include NameEntity::PermitAlterations
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :organization?, :from => 'Organization'
+      xml_accessor :title, :from => 'Title'
+      xml_accessor :given_name, :from => 'GivenName'
+      xml_accessor :middle_name, :from => 'MiddleName'
+      xml_accessor :family_name, :from => 'FamilyName'
+      xml_accessor :suffix, :from => 'Suffix'
+      xml_accessor :display_name, :from => 'DisplayName'
+      xml_accessor :print_on_check_name, :from => 'PrintOnCheckName'
+      xml_accessor :active, :from => 'Active'
+      xml_accessor :primary_phone, :from => 'PrimaryPhone', :as => TelephoneNumber
+      xml_accessor :mobile_phone, :from => 'Mobile', :as => TelephoneNumber
+      xml_accessor :primary_email_address, :from => 'PrimaryEmailAddr', :as => EmailAddress
+      xml_accessor :number, :from => 'EmployeeNumber', :as => Integer
+      xml_accessor :ssn, :from => 'SSN'
+      xml_accessor :address, :from => 'PrimaryAddr', :as => PhysicalAddress
+      xml_accessor :billable?, :from => 'BillableTime'
+      xml_accessor :billable_rate, :from => 'BillRate', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :birth_date, :from => 'BirthDate', :as => Date
+      xml_accessor :gender, :from => 'Gender'
+      xml_accessor :hired_date, :from => 'HiredDate', :as => Date
+      xml_accessor :released_date, :from => 'ReleasedDate', :as => Date
+
+      #== Validations
+      validate :names_cannot_contain_invalid_characters
+      validate :email_address_is_valid
+
+
+    end
+  end
+end

data/lib/quickbooks/model/other_contact_info.rb

@@ -0,0 +1,8 @@
+module Quickbooks
+  module Model
+    class OtherContactInfo < BaseModel
+      xml_accessor :type, :from => 'Type'
+      xml_accessor :telephone, :from => 'Telephone', :as => TelephoneNumber
+    end
+  end
+end

data/lib/quickbooks/model/sales_receipt.rb

@@ -28,6 +28,9 @@ module Quickbooks
 
       xml_accessor :deposit_to_account_ref, :from => 'DepositToAccountRef', :as => BaseReference
 
+      xml_accessor :customer_memo, :from => 'CustomerMemo'
+      xml_accessor :private_note, :from => 'PrivateNote'
+
       # readonly
       xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal
 

data/lib/quickbooks/model/vendor.rb

@@ -0,0 +1,52 @@
+# == Business Rules
+# * The DisplayName, GivenName, MiddleName, FamilyName, and PrintOnCheckName attributes must not contain a colon,":".
+# * The DisplayName attribute must be unique across all other customers, employees, vendors, and other names.
+# * The PrimaryEmailAddress attribute must contain an at sign, "@," and dot, ".".
+# * Either the DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, Suffix, or FullyQualifiedName attributes are required during create.
+
+module Quickbooks
+  module Model
+    class Vendor < BaseModel
+      XML_COLLECTION_NODE = "Vendor"
+      XML_NODE = "Vendor"
+      REST_RESOURCE = 'vendor'
+      include NameEntity::Quality
+      include NameEntity::PermitAlterations
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id', :as => Integer
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :title, :from => 'Title'
+      xml_accessor :given_name, :from => 'GivenName'
+      xml_accessor :middle_name, :from => 'MiddleName'
+      xml_accessor :family_name, :from => 'FamilyName'
+      xml_accessor :suffix, :from => 'Suffix'
+      xml_accessor :company_name, :from => 'CompanyName'
+      xml_accessor :display_name, :from => 'DisplayName'
+      xml_accessor :print_on_check_name, :from => 'PrintOnCheckName'
+      xml_accessor :active, :from => 'Active'
+      xml_accessor :primary_phone, :from => 'PrimaryPhone', :as => TelephoneNumber
+      xml_accessor :alternate_phone, :from => 'AlternatePhone', :as => TelephoneNumber
+      xml_accessor :mobile_phone, :from => 'Mobile', :as => TelephoneNumber
+      xml_accessor :fax_phone, :from => 'Fax', :as => TelephoneNumber
+      xml_accessor :primary_email_address, :from => 'PrimaryEmailAddr', :as => EmailAddress
+      xml_accessor :web_site, :from => 'WebAddr', :as => WebSiteAddress
+      xml_accessor :billing_address, :from => 'BillAddr', :as => PhysicalAddress
+      xml_accessor :other_contact_info, :from => 'OtherContactInfo', :as => OtherContactInfo
+      xml_accessor :tax_identifier, :from => 'TaxIdentifier'
+      xml_accessor :term_ref, :from => 'TermRef', :as => BaseReference
+      xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :account_number, :from => 'AcctNum'
+      xml_accessor :is_1099?, :from => 'Vendor1099'
+      xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
+
+      #== Validations
+      validate :names_cannot_contain_invalid_characters
+      validate :email_address_is_valid
+
+      reference_setters :term_ref
+
+    end
+  end
+end

data/lib/quickbooks/service/base_service.rb

@@ -91,13 +91,8 @@ module Quickbooks
         page = options.fetch(:page, 1)
         per_page = options.fetch(:per_page, 20)
 
-        if page == 1
-          start_position = 1
-        else
-          start_position = (page * per_page) + 1 # page=2, per_page=10 then we want to start at 11
-        end
-
-        max_results = (page * per_page)
+        start_position = ((page - 1) * per_page) + 1 # page=2, per_page=10 then we want to start at 11
+        max_results = per_page
         response = do_http_get(url_for_query(query, start_position, max_results))
 
         parse_collection(response, model)

data/lib/quickbooks/service/employee.rb

@@ -0,0 +1,29 @@
+module Quickbooks
+  module Service
+    class Employee < BaseService
+      include ServiceCrud
+
+      # override update as sparse is not supported
+      def update(entity, options = {})
+        raise InvalidModelException.new('Employee sparse update is not supported by Intuit at this time') if options[:sparse] && options[:sparse] == true
+        super(entity, options)
+      end
+
+      def delete(employee)
+        employee.active = false
+        update(employee, :sparse => false)
+      end
+
+      private
+
+      def default_model_query
+        "SELECT * FROM EMPLOYEE"
+      end
+
+      def model
+        Quickbooks::Model::Employee
+      end
+
+    end
+  end
+end

data/lib/quickbooks/service/vendor.rb

@@ -0,0 +1,29 @@
+module Quickbooks
+  module Service
+    class Vendor < BaseService
+      include ServiceCrud
+
+      # 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 default_model_query
+        "SELECT * FROM VENDOR"
+      end
+
+      def model
+        Quickbooks::Model::Vendor
+      end
+
+    end
+  end
+end

data/lib/quickbooks/util/name_entity.rb

@@ -0,0 +1,54 @@
+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
+      [:display_name, :given_name, :middle_name, :family_name, :print_on_check_name].each do |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
+        unless address.index('@') && address.index('.')
+          errors.add(:primary_email_address, "Email address must contain @ and . (dot)")
+        end
+      end
+    end
+  end
+
+  module PermitAlterations
+    def active?
+      active.to_s == 'true'
+    end
+
+    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/version.rb

@@ -1,5 +1,5 @@
 module Quickbooks
 
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Cody Caughlan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-15 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -188,12 +188,14 @@ files:
 - lib/quickbooks/model/customer.rb
 - lib/quickbooks/model/discount_override.rb
 - lib/quickbooks/model/email_address.rb
+- lib/quickbooks/model/employee.rb
 - lib/quickbooks/model/invoice.rb
 - lib/quickbooks/model/invoice_line_item.rb
 - lib/quickbooks/model/item.rb
 - lib/quickbooks/model/line.rb
 - lib/quickbooks/model/linked_transaction.rb
 - lib/quickbooks/model/meta_data.rb
+- lib/quickbooks/model/other_contact_info.rb
 - lib/quickbooks/model/payment_line_detail.rb
 - lib/quickbooks/model/payment_method.rb
 - lib/quickbooks/model/physical_address.rb
@@ -201,6 +203,7 @@ files:
 - lib/quickbooks/model/sales_receipt.rb
 - lib/quickbooks/model/sub_total_line_detail.rb
 - lib/quickbooks/model/telephone_number.rb
+- lib/quickbooks/model/vendor.rb
 - lib/quickbooks/model/web_site_address.rb
 - lib/quickbooks/service/account.rb
 - lib/quickbooks/service/base_service.rb
@@ -209,14 +212,17 @@ files:
 - lib/quickbooks/service/company_info.rb
 - lib/quickbooks/service/credit_memo.rb
 - lib/quickbooks/service/customer.rb
+- lib/quickbooks/service/employee.rb
 - lib/quickbooks/service/invoice.rb
 - lib/quickbooks/service/item.rb
 - lib/quickbooks/service/payment_method.rb
 - lib/quickbooks/service/sales_receipt.rb
 - lib/quickbooks/service/service_crud.rb
+- lib/quickbooks/service/vendor.rb
 - lib/quickbooks/util/class_util.rb
 - lib/quickbooks/util/http_encoding_helper.rb
 - lib/quickbooks/util/logging.rb
+- lib/quickbooks/util/name_entity.rb
 - lib/quickbooks/version.rb
 - lib/quickbooks-ruby.rb
 homepage: http://github.com/ruckus/quickbooks-ruby