gotransverse-tract-api 0.4.3 → 0.5.0

data/lib/gotransverse-tract-api/service/service.rb

@@ -82,8 +82,8 @@ module GoTransverseTractApi
         #
         def resume eid, service
           data = {
-            :resumeService => {},
-            :service => {eid: eid}
+            resumeService: {},
+            service: {eid: eid}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'resumeService')
@@ -96,8 +96,8 @@ module GoTransverseTractApi
         #
         def suspend eid, service
           data = {
-            :suspendService => {},
-            :service => {eid: eid}
+            suspendService: {},
+            service: {eid: eid}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'suspendService')
@@ -110,13 +110,13 @@ module GoTransverseTractApi
         #
         def add_service_resource eid, service
           data = {
-            :addServiceResourceToService => {},
-            :service => {eid: eid},
-            :serviceResource => {
-              :attributes => {
-                :identifier => service[:service_resource][:identifier]
+            addServiceResourceToService: {},
+            service: {eid: eid},
+            serviceResource: {
+              attributes: {
+                identifier: service[:service_resource][:identifier]
               },
-              :category => {
+              category: {
                 eid: :service[:service_resource][:category][:eid]
               }
             }
@@ -132,9 +132,9 @@ module GoTransverseTractApi
         #
         def remove_service_resource eid, service
           data = {
-            :removeServiceResourceFromService => {},
-            :service => {eid: eid},
-            :serviceResource => {eid: service[:service_resource][:eid]}
+            removeServiceResourceFromService: {},
+            service: {eid: eid},
+            serviceResource: {eid: service[:service_resource][:eid]}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'removeServiceResourceFromService')
@@ -147,31 +147,31 @@ module GoTransverseTractApi
         #
         def add_service_usage_rule_to_service eid, service
           data = {
-            :addServiceUsageRuleToService => {},
-            :service => {eid: eid},
-            :matchAllServiceUsageRule => {
-              :attributes => {
-                :limit => service[:match_all_service_usage_rule][:limit],
-                :usageUom => service[:match_all_service_usage_rule][:usage_uom],
-                :name => service[:match_all_service_usage_rule][:name],
-                :order => service[:match_all_service_usage_rule][:order],
-                :proratedOnOrder => service[:match_all_service_usage_rule][:prorated_on_order],
-                :proratedOnCancel => service[:match_all_service_usage_rule][:prorated_on_cancel],
-                :rollOverType => service[:match_all_service_usage_rule][:roll_over_type],
-                :allowanceType => service[:match_all_service_usage_rule][:allowance_type],
-                :validFrom => service[:match_all_service_usage_rule][:valid_from],
-                :validTo => service[:match_all_service_usage_rule][:valid_to],
-                :ruleType => service[:match_all_service_usage_rule][:rule_type],
-                :status => service[:match_all_service_usage_rule][:status]
+            addServiceUsageRuleToService: {},
+            service: {eid: eid},
+            matchAllServiceUsageRule: {
+              attributes: {
+                limit: service[:match_all_service_usage_rule][:limit],
+                usageUom: service[:match_all_service_usage_rule][:usage_uom],
+                name: service[:match_all_service_usage_rule][:name],
+                order: service[:match_all_service_usage_rule][:order],
+                proratedOnOrder: service[:match_all_service_usage_rule][:prorated_on_order],
+                proratedOnCancel: service[:match_all_service_usage_rule][:prorated_on_cancel],
+                rollOverType: service[:match_all_service_usage_rule][:roll_over_type],
+                allowanceType: service[:match_all_service_usage_rule][:allowance_type],
+                validFrom: service[:match_all_service_usage_rule][:valid_from],
+                validTo: service[:match_all_service_usage_rule][:valid_to],
+                ruleType: service[:match_all_service_usage_rule][:rule_type],
+                status: service[:match_all_service_usage_rule][:status]
               },
-              :chargeCategory => {
+              chargeCategory: {
                 eid: service[:match_all_service_usage_rule][:charge_categroy][:eid]
               },
-              :flatUsageRate => {
-                :uom => service[:match_all_service_usage_rule][:flat_usage_rate][:uom], 
-                :validFrom => service[:match_all_service_usage_rule][:flat_usage_rate][:valid_from], 
-                :validTo => service[:match_all_service_usage_rule][:flat_usage_rate][:valid_to], 
-                :rate => service[:match_all_service_usage_rule][:flat_usage_rate][:rate]
+              flatUsageRate: {
+                uom: service[:match_all_service_usage_rule][:flat_usage_rate][:uom],
+                validFrom: service[:match_all_service_usage_rule][:flat_usage_rate][:valid_from],
+                validTo: service[:match_all_service_usage_rule][:flat_usage_rate][:valid_to],
+                rate: service[:match_all_service_usage_rule][:flat_usage_rate][:rate]
               }
             }
           }
@@ -186,9 +186,9 @@ module GoTransverseTractApi
         #
         def remove_service_usage_rule_from_service eid, service
           data = {
-            :removeServiceUsageRuleFromService => {},
-            :service => {eid: eid},
-            :matchAllServiceUsageRule => {
+            removeServiceUsageRuleFromService: {},
+            service: {eid: eid},
+            matchAllServiceUsageRule: {
               eid: service[:match_all_service_usage_rule][:eid]
             }
           }
@@ -202,15 +202,15 @@ module GoTransverseTractApi
         #
         def add_agreement eid, service
           data = {
-            :addAgreementToService => {},
-            :service => {eid: eid},
-            :agreementService=> {
-              :attributes => {
-                :endAction => service[:agreement_service][:end_action],
-                :endDate => service[:agreement_service][:end_date],
-                :startDate => service[:agreement_service][:start_date]
+            addAgreementToService: {},
+            service: {eid: eid},
+            agreementService: {
+              attributes: {
+                endAction: service[:agreement_service][:end_action],
+                endDate: service[:agreement_service][:end_date],
+                startDate: service[:agreement_service][:start_date]
               },
-              :agreement => {
+              agreement: {
                 eid: service[:agreement_service][:agreement][:eid]
               }
             }
@@ -226,18 +226,18 @@ module GoTransverseTractApi
         #
         def add_counter eid, service
           data = {
-            :addCounterToService => {},
-            :service => {eid: eid},
-            :usageRuleCounter => {
-              :attributes => {
-                :name => service[:usage_rule_counter][:name],
-                :description => service[:usage_rule_counter][:description],
-                :status => service[:usage_rule_counter][:status],
-                :entityRelationType => service[:usage_rule_counter][:entity_relation_type],
-                :uom => service[:usage_rule_counter][:uom],
-                :threshold => service[:usage_rule_counter][:threshold]
+            addCounterToService: {},
+            service: {eid: eid},
+            usageRuleCounter: {
+              attributes: {
+                name: service[:usage_rule_counter][:name],
+                description: service[:usage_rule_counter][:description],
+                status: service[:usage_rule_counter][:status],
+                entityRelationType: service[:usage_rule_counter][:entity_relation_type],
+                uom: service[:usage_rule_counter][:uom],
+                threshold: service[:usage_rule_counter][:threshold]
               },
-              :servicePeriodCounterResetCriteria => {}
+              servicePeriodCounterResetCriteria: {}
             }
           }
 
@@ -251,13 +251,13 @@ module GoTransverseTractApi
         #
         def add_custom_field_value eid, service
           data = {
-            :addCustomFieldValueToService => {},
-            :service => {eid: eid},
-            :customFieldValue => {
-              :attributes => {
-                :value => service[:custom_field_value][:value]
+            addCustomFieldValueToService: {},
+            service: {eid: eid},
+            customFieldValue: {
+              attributes: {
+                value: service[:custom_field_value][:value]
               },
-              :customField => {
+              customField: {
                 eid: service[:custom_field_value][:custom_field][:eid]
               }
             }
@@ -273,9 +273,9 @@ module GoTransverseTractApi
         #
         def remove_custom_field_value eid, service
           data = {
-            :removeCustomFieldValueFromService => {},
-            :service => {eid: eid},
-            :customFieldValue => {
+            removeCustomFieldValueFromService: {},
+            service: {eid: eid},
+            customFieldValue: {
               eid: service[:custom_field_value][:eid]
             }
           }
@@ -292,44 +292,44 @@ module GoTransverseTractApi
           api_data = GoTransverseTractApi::ApiData.new
 
           data = { 
-            :addDiscountIdentifierToService => {},
-            :service => {
-              :attributes => {
-                :amount => service[:amount],
-                :startDate => service[:start_date],
-                :status => service[:status],
-                :description => service[:description],
-                :renewalCount => service[:renewal_count],
+            addDiscountIdentifierToService: {},
+            service: {
+              attributes: {
+                amount: service[:amount],
+                startDate: service[:start_date],
+                status: service[:status],
+                description: service[:description],
+                renewalCount: service[:renewal_count],
                 eid: service[:eid],
-                :queryScope => service[:query_scope]
+                queryScope: service[:query_scope]
               },
-              :billingAccount => {
+              billingAccount: {
                 eid: service[:billing_account][:eid],
-                :queryScope => service[:billing_account][:query_scope]
+                queryScope: service[:billing_account][:query_scope]
               },
-              :serviceResources => GoTransverseTractApi::ApiData.new.get_page_info(service[:service_resources]),
-              :product => {
+              serviceResources: GoTransverseTractApi::ApiData.new.get_page_info(service[:service_resources]),
+              product: {
                 eid: service[:product][:eid],
-                :queryScope => service[:product][:query_scope]
+                queryScope: service[:product][:query_scope]
               },
-              :servicePeriods => api_data.get_page_info(service[:service_periods]),
-              :servicePrices => api_data.get_page_info(service[:service_prices]),
-              :serviceUsageRules => api_data.get_page_info(service[:service_usage_rules]),
-              :counters => api_data.get_page_info(service[:counters]),
-              :customFieldValues => api_data.get_page_info(service[:custom_field_values])
+              servicePeriods: api_data.get_page_info(service[:service_periods]),
+              servicePrices: api_data.get_page_info(service[:service_prices]),
+              serviceUsageRules: api_data.get_page_info(service[:service_usage_rules]),
+              counters: api_data.get_page_info(service[:counters]),
+              customFieldValues: api_data.get_page_info(service[:custom_field_values])
             },
-            :discountIdentifier => {
-              :attributes => {
-                :status => service[:discount_identifier][:status],
-                :unlimited => service[:discount_identifier][:unlimited],
-                :uses => service[:discount_identifier][:uses],
-                :identifier => service[:discount_identifier][:identifier],
+            discountIdentifier: {
+              attributes: {
+                status: service[:discount_identifier][:status],
+                unlimited: service[:discount_identifier][:unlimited],
+                uses: service[:discount_identifier][:uses],
+                identifier: service[:discount_identifier][:identifier],
                 eid: service[:discount_identifier][:eid],
-                :queryScope => service[:discount_identifier][:query_scope]
+                queryScope: service[:discount_identifier][:query_scope]
               },
-              :category => {
+              category: {
                 eid: service[:discount_identifier][:category][:eid],
-                :queryScope => service[:discount_identifier][:category][:query_scope]
+                queryScope: service[:discount_identifier][:category][:query_scope]
               }
             }
           }
@@ -344,11 +344,11 @@ module GoTransverseTractApi
         #
         def change_price eid, service
           data = {
-            :changeServicePrice => {
-              :attributes => {
-                :newRecurringUnitPrice => service[:new_recurring_unit_price]
+            changeServicePrice: {
+              attributes: {
+                newRecurringUnitPrice: service[:new_recurring_unit_price]
               },
-              :service => {eid: eid}
+              service: {eid: eid}
             }
           }
 
@@ -362,12 +362,12 @@ module GoTransverseTractApi
         #
         def change_quantity eid, service
           data = {
-            :changeServiceQuantity => {
-              :attributes => {
-                :newQuantity => service[:new_quantity],
-                :effectiveDate => service[:effective_date]
+            changeServiceQuantity: {
+              attributes: {
+                newQuantity: service[:new_quantity],
+                effectiveDate: service[:effective_date]
               },
-              :service => {eid: eid}
+              service: {eid: eid}
             }
           }
 
@@ -381,46 +381,46 @@ module GoTransverseTractApi
         #
         def renew eid, service
           data = {
-            :renewService => {},
-            :service => {
-              :attributes => {eid: eid},
-              :billingAccount => {
+            renewService: {},
+            service: {
+              attributes: {eid: eid},
+              billingAccount: {
                 eid: service[:billing_account][:eid]
               }
             },
-            :order => { 
-              :attributes => {},
-              :orderItems => {
-                :attributes => {},
-                :orderItem => {
-                  :attributes => {
-                    :quantity => service[:order][:order_items][:order_item][:quantity],
-                    :sequence => service[:order][:order_items][:order_item][:sequence]
+            order: {
+              attributes: {},
+              orderItems: {
+                attributes: {},
+                orderItem: {
+                  attributes: {
+                    quantity: service[:order][:order_items][:order_item][:quantity],
+                    sequence: service[:order][:order_items][:order_item][:sequence]
                   },
-                  :product => {
+                  product: {
                     eid: service[:order][:order_items][:order_item][:product][:eid]
                   },
-                  :selectedAgreement => {
+                  selectedAgreement: {
                     eid: service[:order][:order_items][:order_item][:selected_agreement][:eid]
                   }
                 }
               },
-              :billingAccount => { eid: service[:order][:billing_account][:eid] },
-              :payments => { 
-                :attributes => {},
-                :payment => {
-                  :attributes => {
-                    :amount => service[:order][:payments][:payment][:amount],
-                    :description => service[:order][:payments][:payment][:description]
+              billingAccount: { eid: service[:order][:billing_account][:eid] },
+              payments: {
+                attributes: {},
+                payment: {
+                  attributes: {
+                    amount: service[:order][:payments][:payment][:amount],
+                    description: service[:order][:payments][:payment][:description]
                   },
-                  :billingAccount => { eid: service[:order][:payments][:payment][:billing_account][:eid] },
-                  :creditCardPayment => {
-                    :cardType => service[:order][:payments][:payment][:credit_card_payment][:card_type],
-                    :cardHolderFirstName => service[:order][:payments][:payment][:credit_card_payment][:card_holder_first_name],
-                    :cardHolderMiddleName => service[:order][:payments][:payment][:credit_card_payment][:card_holder_middle_name],
-                    :cardHolderLastName => service[:order][:payments][:payment][:credit_card_payment][:card_holder_last_name],
-                    :cardIdentifierNumber => service[:order][:payments][:payment][:credit_card_payment][:card_identifier_number],
-                    :cardExpiration => service[:order][:payments][:payment][:credit_card_payment][:card_expiration]
+                  billingAccount: { eid: service[:order][:payments][:payment][:billing_account][:eid] },
+                  creditCardPayment: {
+                    cardType: service[:order][:payments][:payment][:credit_card_payment][:card_type],
+                    cardHolderFirstName: service[:order][:payments][:payment][:credit_card_payment][:card_holder_first_name],
+                    cardHolderMiddleName: service[:order][:payments][:payment][:credit_card_payment][:card_holder_middle_name],
+                    cardHolderLastName: service[:order][:payments][:payment][:credit_card_payment][:card_holder_last_name],
+                    cardIdentifierNumber: service[:order][:payments][:payment][:credit_card_payment][:card_identifier_number],
+                    cardExpiration: service[:order][:payments][:payment][:credit_card_payment][:card_expiration]
                   }
                 }
               }
@@ -437,8 +437,8 @@ module GoTransverseTractApi
         #
         def deactivate eid, service
           data = {
-            :deactivateService => {},
-            :service => {eid: eid}
+            deactivateService: {},
+            service: {eid: eid}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'deactivateService')
@@ -450,7 +450,15 @@ module GoTransverseTractApi
         # @param {Hash} service
         #
         def update eid, service
-          GoTransverseTractApi.put_request_for(self, {eid: eid}, service)
+          data = {
+            service: {
+              eid: eid,
+              description: service[:description]
+            }
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'service')
+          GoTransverseTractApi.put_request_for(self, {eid: eid}, xml_data)
         end
 
       end

data/lib/gotransverse-tract-api/service/service_resource.rb

@@ -60,12 +60,12 @@ module GoTransverseTractApi
         #
         def request service_resource
           data = {
-            :requestServiceResource => {
-              :identifier => service_resource[:identifier],
-              :status => service_resource[:status],
-              :description => service_resource[:description]
+            requestServiceResource: {
+              identifier: service_resource[:identifier],
+              status: service_resource[:status],
+              description: service_resource[:description]
             },
-            :serviceResourceCategory => {eid: service_resource[:service_resource_category][:eid]}
+            serviceResourceCategory: {eid: service_resource[:service_resource_category][:eid]}
           }
           xml_data = GoTransverseTractApi.generateXML(data, 'requestServiceResource')
           GoTransverseTractApi.post_request_for(self, {}, xml_data, "request")
@@ -77,15 +77,15 @@ module GoTransverseTractApi
         #
         def change eid, service_resource
           data = {
-            :changeServiceResource => {},
-            :serviceResource => {eid: eid},
-            :changeToServiceResource => {
-              :attributes => {
-                :identifier => service_resource[:change_to_service_resource][:identifier],
-                :status => service_resource[:change_to_service_resource][:status],
-                :description => service_resource[:change_to_service_resource][:description]
+            changeServiceResource: {},
+            serviceResource: {eid: eid},
+            changeToServiceResource: {
+              attributes: {
+                identifier: service_resource[:change_to_service_resource][:identifier],
+                status: service_resource[:change_to_service_resource][:status],
+                description: service_resource[:change_to_service_resource][:description]
               },
-              :category => {eid: service_resource[:category][:eid]}
+              category: {eid: service_resource[:category][:eid]}
             }
           }
 
@@ -99,8 +99,8 @@ module GoTransverseTractApi
         #
         def deactivate eid, service_resource
           data = {
-            :deactivateServiceResource => {},
-            :serviceResource => {eid: eid}
+            deactivateServiceResource: {},
+            serviceResource: {eid: eid}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'deactivateServiceResource')
@@ -112,12 +112,12 @@ module GoTransverseTractApi
         #
         def create_service_resource service_resource
           data = {
-            :serviceResource => {
-              :identifier => service_resource[:identifier],
-              :status => service_resource[:status],
-              :description => service_resource[:description]
+            serviceResource: {
+              identifier: service_resource[:identifier],
+              status: service_resource[:status],
+              description: service_resource[:description]
             },
-            :category => {eid: service_resource[:category][:eid]}
+            category: {eid: service_resource[:category][:eid]}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'serviceResource')
@@ -129,7 +129,16 @@ module GoTransverseTractApi
         # @param {Hash} service_resource
         #
         def update eid, service_resource
-          GoTransverseTractApi.put_response_for(self, {eid: eid}, service_resource)
+          data = {
+            serviceResource: {
+              eid: eid,
+              identifier: service_resource[:identifier],
+              description: service_resource[:description]
+            }
+          }
+
+          xml_data = GoTransverseTractApi.generateXML(data, 'serviceResource')
+          GoTransverseTractApi.put_request_for(self, {eid: eid}, xml_data)
         end
 
         #
@@ -138,13 +147,13 @@ module GoTransverseTractApi
         #
         def add_service_resource eid, service_resource
           data = {
-            :addServiceResourceToService => {},
-            :service => {eid: eid},
-            :serviceResource => {
-              :attributes => {
-                :identifier => service_resource[:identifier]
+            addServiceResourceToService: {},
+            service: {eid: eid},
+            serviceResource: {
+              attributes: {
+                identifier: service_resource[:identifier]
               },
-              :category => {eid: service_resource[:category][:eid]}
+              category: {eid: service_resource[:category][:eid]}
             }
           }
 
@@ -158,9 +167,9 @@ module GoTransverseTractApi
         #
         def self.remove_service_resource eid, service_resource
           data = {
-            :removeServiceResourceFromService => {},
-            :service => {eid: eid},
-            :serviceResource => {eid: service_resource[:eid]}
+            removeServiceResourceFromService: {},
+            service: {eid: eid},
+            serviceResource: {eid: service_resource[:eid]}
           }
 
           xml_data = GoTransverseTractApi.generateXML(data, 'removeServiceResourceFromService')

data/lib/gotransverse-tract-api/usage/usage_event.rb

@@ -70,13 +70,7 @@ module GoTransverseTractApi
         #
         def create_usage_event usage_event
           data = {
-            usageEvent: {
-              startTime: usage_event[:start_time],
-              serviceResourceId: usage_event[:service_resource_id],
-              usageUom: usage_event[:usage_uom],
-              usageAmount: usage_event[:usage_amount],
-              number01: usage_event[:number01]
-            },
+            usageEvent: get_usage_event(usage_event),
             serviceResourceType: usage_event[:service_resource_type]
           }
 
@@ -126,13 +120,7 @@ module GoTransverseTractApi
           usage_event.each do|event|
             events << {
               usageEvent: {
-                attributes: {
-                  startTime: event[:start_time],
-                  serviceResourceId: event[:service_resource_id],
-                  usageUom: event[:usage_uom],
-                  usageAmount: event[:usage_amount],
-                  description: event[:description]
-                },
+                attributes: get_usage_event(event),
                 serviceResourceType: event[:service_resource_type]
               }
             }
@@ -141,6 +129,32 @@ module GoTransverseTractApi
           events      
         end
 
+        #
+        # params: Usage Event
+        #
+        # Returns A single usage event for XML
+        #
+        def get_usage_event(event)
+          udfs = {}
+
+          (1..5).each do|i|
+            udfs["text0#{i}".to_sym] = event["text0#{i}".to_sym]
+            udfs["number0#{i}".to_sym] = event["number0#{i}".to_sym]
+            udfs["date0#{i}".to_sym] = event["date0#{i}".to_sym]
+          end
+
+          ({ 
+            description: event[:description],
+            startTime: event[:start_time],
+            endTime: event[:end_time],
+            serviceResourceId: event[:service_resource_id],
+            usageUom: event[:usage_uom],
+            usageAmount: event[:usage_amount],
+            referenceId: event[:reference_id],
+            sequenceId: event[:sequence_id]
+          }.merge udfs).delete_if{|k,v| v.nil?}
+        end
+
       end
 
     end

data/lib/gotransverse-tract-api/version.rb

@@ -1,6 +1,6 @@
 module GoTransverseTractApi
 
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
   TARGET_API_VERSION = "1.28"
 
 end

data/lib/gotransverse-tract-api.rb

@@ -186,7 +186,7 @@ module GoTransverseTractApi
 
   def self.generateXML(data, root_elem)
     tract_api_ver = GoTransverseTractApi::TARGET_API_VERSION
-    data[root_elem.to_sym][:xmlns] = "http://www.tractbilling.com/billing/#{tract_api_ver}/domain"
+    data[root_elem.to_sym][:xmlns] = "http://www.tractbilling.com/billing/" + tract_api_ver.tr('.','_') + "/domain"
 
     builder = Nokogiri::XML::Builder.new do|xml|
       xml.send(root_elem,Hash[data[root_elem.to_sym]]) do
@@ -196,7 +196,8 @@ module GoTransverseTractApi
       end
     end
 
-    builder.doc.root.to_xml
+    xml_str = builder.doc.root.to_xml
+    xml_str.tr!('"', "'")
   end
 
   private
@@ -249,7 +250,7 @@ module GoTransverseTractApi
     hsh = Hash.from_xml(xml_response.to_s).recursive_symbolize_keys!
 
     if method == :get
-      hsh = hsh[klass.pluralize.camelize(:lower).to_sym][klass.camelize(:lower).to_sym] rescue Hash.from_xml(xml_response.to_s)[klass.camelize(:lower).to_sym]
+      hsh = hsh[klass.pluralize.camelize(:lower).to_sym] rescue Hash.from_xml(xml_response.to_s)[klass.camelize(:lower).to_sym]
     end
 
     return hsh