qbwc_requests 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c63cbac1d987efa9d56e8e33cb66891d3ff6e06
-  data.tar.gz: 3b4fba0e3fc2e5937c97dbae9278411007e71705
+  metadata.gz: 55e98a7c49505aa0fe9b0fac41e7073849a55636
+  data.tar.gz: d272895bce72dfa14c73e32040ffc40773b59658
 SHA512:
-  metadata.gz: eafc791de78e5d6cce44843b6b5636fba7f47d4447111dc303206378609cd4b47389a534f1a193fa5eb6aa0169f61acd379784051b76ce1e78cc8f06995f3fe8
-  data.tar.gz: 1e52e9188decebbbab7ec7d77cac097306fd31e6c3ebd44aaf18da894cda85c762100d3fcac6d95fc1d4f71e11843558c4757bc215dce70f1690d78ef577bcff
+  metadata.gz: 10dc09cfdeac01e7f944bd673e54f73dc381ba63b74a8fcf6a3790ed007e9063f269e29914ad4448780669431e19a99c97e26278ea2ef02f60d9c05b41b26dc3
+  data.tar.gz: 2d30beb012534d3fe8ad7f511636315ac7f809ab6e1921bcf239575b1aa9f4172339022d7ab6e4d297a3454df1522a4260762c1a7a4743db67dc8d86e979a0a1

data/README.md

@@ -3,6 +3,8 @@
 With qbwc_requests you have an easy way to create Qbxml requests.
 
 [![Build Status](https://semaphoreci.com/api/v1/projects/c357ba42-3d3e-4061-985e-6c3c9c68a9b4/557601/badge.svg)](https://semaphoreci.com/apotema/qbwc_requests)
+[![Code Climate](https://codeclimate.com/github/apotema/qbwc_requests/badges/gpa.svg)](https://codeclimate.com/github/apotema/qbwc_requests)
+[![Test Coverage](https://codeclimate.com/github/apotema/qbwc_requests/badges/coverage.svg)](https://codeclimate.com/github/apotema/qbwc_requests/coverage)
 
 ## Installation
 
@@ -29,7 +31,7 @@ Or install it yourself as:
   result
 
   ```xml
-    <?xml version='1.0' encoding='utf-8'?>
+    <?xml version="1.0" encoding="ISO-8859-1"?>
     <?qbxml version="7.0"?>
     <QBXML>
       <QBXMLMsgsRq onError="stopOnError">
@@ -51,7 +53,7 @@ That will create an Account query for the qbxml version 7.0
   result  
 
   ```xml
-  <?xml version='1.0' encoding='utf-8'?>
+  <?xml version="1.0" encoding="ISO-8859-1"?>
   <?qbxml version="7.0"?>
   <QBXML>
     <QBXMLMsgsRq onError="stopOnError">

data/lib/qbwc_requests/{qbwc/request/v07/account.rb → account/v07/add.rb}

@@ -1,7 +1,7 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module Account
     module V07
-      class Account < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
 

data/lib/qbwc_requests/account/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Account
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/base.rb

@@ -0,0 +1,76 @@
+module QbwcRequests
+  class Base
+
+    include QbwcRequests::OrderedFields
+    include QbwcRequests::XmlActions
+
+    def to_xml request_id
+      self.valid? ? xml(request_id, self.class.name.demodulize) : self
+    end
+
+    def initialize(attributes = {})
+      @attributes = compact(attributes)
+      @attributes.each do |name, value|
+        self.instance_variable_set("@#{name}", value) if value.present?
+      end
+    end
+
+    def self.qbxml hash
+      Qbxml.new(:qb, "#{version.to_i}.0").to_qbxml(hash)
+    end
+
+    def class_name
+      self.class.underscore(self.class.name.split("::")[1].gsub("Qbxml",""))
+    end
+
+    def self.version
+      self.name.split("::")[2].gsub("V","")
+    end
+
+    def persisted?
+      false
+    end
+
+    private
+
+      def self.underscore string
+        string.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+
+      def compact opts={}
+        # I pass two times to avoid {v: '1',k: {}}, gotta find a better algorithm (recursive)
+        return {} if opts.nil?
+        proc = Proc.new { |k, v| v.kind_of?(Hash) ? (v.delete_if(&proc); nil) : (v == nil || (v.respond_to?(:empty) && v.empty?)) };
+        hash = opts.delete_if(&proc)
+        hash.delete_if { |k, v| (v == nil || (v.respond_to?(:empty) && v.empty?)) }
+      end
+
+      def xml request_id, action
+        req = XmlActions.header
+        if action != "Query"
+          req['qbxml']['qbxml_msgs_rq']["#{class_name}_#{action}_rq"] = {"xml_attributes"=>
+              {"requestID"=>"#{request_id}"},
+                "#{class_name}_#{action}"=> self.ordered_fields
+              }  
+        else
+          req['qbxml']= {
+            'qbxml_msgs_rq' => { 
+              "xml_attributes" => {
+                "onError"=>"stopOnError"
+              }, 
+              "#{class_name}_query_rq" => { 
+                "xml_attributes" => {
+                  "requestID" => "#{request_id}"} 
+                }.merge(self.ordered_fields) 
+            } 
+          }
+        end
+        self.class.qbxml(req)
+      end
+
+  end
+end

data/lib/qbwc_requests/bill/v07/add.rb

@@ -0,0 +1,11 @@
+module QbwcRequests
+  module Bill
+    module V07
+      class Add < QbwcRequests::Base
+
+        ref_to :vendor, 41
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/bill/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Bill
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/customer/v07/add.rb

@@ -0,0 +1,39 @@
+module QbwcRequests
+  module Customer
+    module V07
+      class Add < QbwcRequests::Base
+
+        field :name
+        field :is_active
+        ref_to :parent, 1000
+        field :company_name
+        field :salutation
+        field :first_name
+        field :middle_name
+        field :last_name
+        field :bill_address
+        field :ship_address
+        field :phone
+        field :alt_phone
+        field :fax
+        field :email
+        field :contact
+        field :alt_contact
+
+        validates :name, presence: true, length: { maximum: 41 }
+        validates :company_name, length: { maximum: 41 }
+        validates :salutation, length: { maximum: 15 }
+        validates :first_name, length: { maximum: 25 }
+        validates :middle_name, length: { maximum: 5 }
+        validates :last_name, length: { maximum: 25 }
+        validates :phone, length: { maximum: 21 }
+        validates :alt_phone, length: { maximum: 21 }
+        validates :fax, length: { maximum: 21 }
+        validates :email, length: { maximum: 1023 }
+        validates :contact, length: { maximum: 41 }
+        validates :alt_contact, length: { maximum: 41 }
+        
+      end
+    end
+  end
+end

data/lib/qbwc_requests/customer/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Customer
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/estimate.rb → estimate/v07/add.rb}

@@ -1,13 +1,14 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module Estimate
     module V07
-      class Estimate < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
-        field :customer_ref
+        ref_to :customer, 209
         field :estimate_line_add
 
         validates :customer_ref, presence: true
         validates :estimate_line_add, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/estimate/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Estimate
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/factory.rb

@@ -0,0 +1,32 @@
+module QbwcRequests
+  module Factory  
+
+    class Instantiator
+
+      def initialize module_name, klass
+        @module_name = module_name
+        @klass = klass
+      end
+
+      def factory params = {}, version = nil
+        final_version = version || QbwcRequests.QBXML_VERSION
+        object = Object.const_get("QbwcRequests::#{@module_name}::V#{final_version}::#{@klass}")
+        object.new(params)
+      end
+
+      def name
+        @module_name
+      end
+
+    end
+
+
+    def const_missing(name)
+      if [:Mod, :Add, :Query].include?(name)
+        Instantiator.new(self.name.gsub("Qbxml",""),name)
+      else
+        raise "NameError: uninitialized constant #{name}"
+      end
+    end
+  end
+end

data/lib/qbwc_requests/general_detail_report/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module GeneralDetailReport
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/invoice.rb → invoice/v07/add.rb}

@@ -1,14 +1,14 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module Invoice
     module V07
-      class Invoice < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
-        field :customer_ref
+        ref_to :customer, 209
         field :invoice_line_add
 
         validates :customer_ref, presence: true
         validates :invoice_line_add, presence: true
-        
+            
       end
     end
   end

data/lib/qbwc_requests/invoice/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Invoice
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/item/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module Item
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_discount.rb → item_discount/v07/add.rb}

@@ -1,14 +1,15 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemDiscount
     module V07
-      class ItemDiscount < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
-        field :account_ref
+        ref_to :account, 159
         field :discount_rate
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_discount/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemDiscount
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_group.rb → item_group/v07/add.rb}

@@ -1,13 +1,14 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemGroup
     module V07
-      class ItemGroup < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
         field :item_desc
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_group/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemGroup
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_non_inventory.rb → item_non_inventory/v07/add.rb}

@@ -1,14 +1,15 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemNonInventory
     module V07
-      class ItemNonInventory < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
         field :pricetype
-        field :parent_ref
+        ref_to :parent, 1000
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_non_inventory/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemNonInventory
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_other_charge.rb → item_other_charge/v07/add.rb}

@@ -1,7 +1,7 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemOtherCharge
     module V07
-      class ItemOtherCharge < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
@@ -10,6 +10,7 @@ module Qbwc
 
         validates :sales_or_purchase, presence: true
         validates :name, presence: true, length: { maximum: 41 }
+            
       end
     end
   end

data/lib/qbwc_requests/item_other_charge/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemOtherCharge
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_payment.rb → item_payment/v07/add.rb}

@@ -1,13 +1,14 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemPayment
     module V07
-      class ItemPayment < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
         field :item_desc
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_payment/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemPayment
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_service.rb → item_service/v07/add.rb}

@@ -1,7 +1,7 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemService
     module V07
-      class ItemService < Qbwc::Request::Base
+      class Add < QbwcRequests::Base
 
         field :name
         field :is_active
@@ -9,6 +9,7 @@ module Qbwc
         field :sales_or_purchase
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_service/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemService
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/{qbwc/request/v07/item_subtotal.rb → item_subtotal/v07/add.rb}

@@ -1,14 +1,15 @@
-module Qbwc 
-  module Request
+module QbwcRequests
+  module ItemSubtotal
     module V07
-      class ItemSubtotal < Qbwc::Request::Base
-              
+      class Add < QbwcRequests::Base
+
         field :name
         field :is_active
         field :item_desc
         field :bar_code
 
         validates :name, presence: true
+            
       end
     end
   end

data/lib/qbwc_requests/item_subtotal/v07/query.rb

@@ -0,0 +1,9 @@
+module QbwcRequests
+  module ItemSubtotal
+    module V07
+      class Query < QbwcRequests::Base
+        field :max_returned
+      end
+    end
+  end
+end

data/lib/qbwc_requests/ordered_fields.rb

@@ -0,0 +1,81 @@
+module QbwcRequests
+  module OrderedFields
+    module ClassMethods
+      def field attribute_name
+        @attr_order ||= Set.new
+        @attr_order << attribute_name
+        attr_accessor attribute_name
+      end
+      def has_one attribute_name, klass
+        @attr_order ||= Set.new
+        @attr_order << attribute_name
+        attr_accessor attribute_name
+        validates_each attribute_name do |record, attribute, value|
+          if !value.blank? and value.class != klass
+            record.errors.add(attribute, "must be of type #{klass}") 
+          end
+        end
+      end
+      def ref_to attribute_prefix, name_length
+        attribute_name = "#{attribute_prefix}_ref".to_sym
+        @attr_order ||= Set.new
+        @attr_order << attribute_name
+        attr_accessor attribute_name
+        validates_each attribute_name do |record, attribute, value|
+          if value.present? 
+            if value.is_a?(Hash)
+              if !(value[:list_id].present? ^ value[:full_name].present?)
+                record.errors.add(attribute, "Must have list_id or full_name")
+              elsif value.fetch(:full_name, "").length > name_length
+                record.errors.add(attribute, "- maximum 'full name' length is: #{name_length}")
+              end
+            else
+              record.errors.add(attribute, "Must have the format {list_id: 'value'} or {full_name: 'value'}")
+            end
+          end
+        end
+      end
+      def attr_order
+        @attr_order
+      end
+    end
+
+    class SubModelsValidator < ActiveModel::Validator
+      def validate record
+        return true if record.class.attr_order.blank?
+        for field in record.class.attr_order
+          value = record.send(field)
+          if value.respond_to?(:valid?) and value.invalid?
+            for error in value.errors
+              record.errors.add("#{field}##{error}", value.errors.messages[error] )
+            end
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ActiveModel::Naming)
+      base.include(ActiveModel::Validations)
+      base.include(ActiveModel::Conversion)
+      base.extend(ClassMethods)
+      base.validates_with(SubModelsValidator)
+    end
+    
+    def ordered_fields
+      return {} if self.class.attr_order.blank?
+      new_hash = {}
+      for attribute in self.class.attr_order
+        value = send(attribute)
+        if value.present?
+          if value.respond_to?(:ordered_fields)
+            new_hash[attribute] = value.ordered_fields
+          else
+            new_hash[attribute] = value
+          end
+        end
+      end
+      new_hash
+    end   
+  end
+end

data/lib/qbwc_requests/purchase_order/v07/add.rb

@@ -0,0 +1,33 @@
+module QbwcRequests
+  module PurchaseOrder
+    module V07
+      class Add < QbwcRequests::Base
+
+        ref_to :vendor, 41
+        ref_to :class, 159
+        ref_to :ship_to_entity, 209
+        ref_to :template, 31
+        field :txn_date
+        field :ref_number
+        field :vendor_address
+        field :ship_address
+        ref_to :terms, 31
+        field :due_date
+        field :expected_date
+        ref_to :ship_method, 15
+        field :FOB
+        field :memo
+        field :vendor_msg
+        field :is_to_be_printed
+        field :is_to_be_emailed
+        field :is_tax_included
+        ref_to :sales_tax_code, 3 
+        field :other1
+        field :other2
+        field :purchase_order_line_add
+        field :purchase_order_line_group_add
+            
+      end
+    end
+  end
+end