adf_builder 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b52ffaa62f849533560890d14c698c1de3e4475b347c23d43a12cb5c75ea42c
-  data.tar.gz: 3a1d8dd414e73453ca32d768406518b01648c555e1c9e0cf8416f06924321d64
+  metadata.gz: 7b6904f4a4346718e3a08189a1da210b0c6a8305679d49f00d552854abb36db2
+  data.tar.gz: becdc5415db73468da3508f93f9d8d6a7a094a80e19f2b5bcf872e248d3520df
 SHA512:
-  metadata.gz: 2b2361f9fe58e67dbbce7990b045d791383e5a07c164ad82b4ec3b72099d8d220b75942c45e974e82e7ce885cc5a5c3af56e247dd517126998fd7232ce508ed6
-  data.tar.gz: e4beaad79cc2613f219c34ac1aa291a87ac186b9240c5f23e32d344886673bc4eb746b180029fdd2feee661aed9976612a46fc46a41dbfc75844ded7d3234c16
+  metadata.gz: '0798101309032835894eb10965dfbcbcc97b7481f1e1aefda8f617b4a1219c469eb505df14c7344c2be80c0ce39d2bf347aa33f63106d893fcd1010d52775d0f'
+  data.tar.gz: 15d466aa189bf14ba7a7b79fa807a596f9d6d789ab06c68e40692d4b9e81336195b9581c1243fea22f12fa87b5059d7d453282de1c2455d89811d6f48f11bbae

data/CHANGELOG.md

@@ -8,14 +8,31 @@
   - price
   - option
   - finance
-  
+- Expand Structures for all parameters
+  - Customer 
+  - Vehicle
+  - Contact
+
 ### In many moons
-- Add Vendor structure
-- Add Customer structure
 - Add Provider structure
-- Add Contact structure
 - Add Price structure
 
+## [0.0.7] - 2021-08-08
+- Much refactoring so that we can reuse functions 
+- Added more functionality to the Vehicle structure including all free text, all same level tags with params, and Color Combination and ImageTag
+
+
+## [0.0.6] - 2021-08-08
+- minimal_lead function will remove all previous adf nodes
+- Created ability to reset doc
+
+## [0.0.5] - 2021-08-08
+- Fixed bug that kept us from using the library
+
+## [0.0.4] - 2021-08-08
+- Added Customer, Contact, Vendor basic structure
+
+
 ## [0.0.3] - 2021-08-04
 - Added ability to add simple vehicle structures
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adf_builder (0.0.2)
+    adf_builder (0.0.7)
       ox (~> 2.14)
 
 GEM

data/README.md

@@ -1,5 +1,5 @@
 # AdfBuilder
-Hopefully this will help with development in the ADF format. The goal is to intuitively create an update an ADF XML file that can easily be added to an email or saved to a file.
+Hopefully this will help with development in the ADF format. The goal is to intuitively create and update an ADF XML file that can easily be added to an email or saved to a file.
 
 ## Installation
 
@@ -49,7 +49,7 @@ Outputs
 Update Requestdate value
 ```ruby
 builder = AdfBuilder::Builder.new
-builder.base.prospect.request_date.update_val(Date.new(2021,12,12))
+builder.prospect.request_date.update_val(Date.new(2021,12,12))
 ```
 Outputs
 
@@ -68,7 +68,7 @@ Outputs
 Add ID tag to Prospect
 ```ruby
 builder = AdfBuilder::Builder.new
-builder.base.prospect.add_id('howdy', 'Ag')
+builder.prospect.add_id('howdy', 'Ag')
 ```
 
 Outputs
@@ -88,7 +88,7 @@ Add Vehicle
 
 ```ruby
 builder = AdfBuilder::Builder.new
-builder.base.prospect.vehicles.add(2021, 'Ford', 'Raptor')
+builder.prospect.vehicles.add(2021, 'Ford', 'Raptor')
 ```
 
 Outputs
@@ -108,15 +108,28 @@ Outputs
   </prospect>
 </adf>
 ```
-Add Vehicle with tags
+
+Vehicle with different operations
 
 ```ruby
 builder = AdfBuilder::Builder.new
-builder.base.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
-  interest: :sell, 
+builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
   status: :used,
-  vin: 'XXXXXXXXXX',
 })
+builder.prospect.vehicles.update_tags_with_free_text(0, {
+  bodystyle: 'howdy',
+  year: '2000'
+})
+builder.prospect.vehicles.update_odometer(0, 9000, {
+  units: 'km'
+})
+builder.prospect.vehicles.update_condition(0, 'ffff')
+builder.prospect.vehicles.update_imagetag(0, 'http://adfxml.info/adf_spec.pdf', {
+  width: 400,
+  height: 500,
+  alttext: 'Howdy'
+})
+puts builder.to_xml
 ```
 
 Outputs
@@ -127,18 +140,120 @@ Outputs
 <?xml version="1.0"?>
 <adf>
   <prospect status="new">
-    <requestdate>2021-08-04T18:16:31+04:00</requestdate>
-    <vehicle interest="sold" status="used">
+    <requestdate>2021-08-09T00:53:59+04:00</requestdate>
+    <customer/>
+    <vendor/>
+    <vehicle status="used">
+      <year>2000</year>
+      <make>Toyota</make>
+      <model>Prius</model>
+      <bodystyle>howdy</bodystyle>
+      <odometer units="km">9000</odometer>
+      <imagetag width="400" height="500" alttext="Howdy">http://adfxml.info/adf_spec.pdf</imagetag>
+    </vehicle>
+  </prospect>
+</adf>
+```
+
+Color Combination
+
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
+  status: :used,
+})
+builder.prospect.vehicles.add_color_combination(0, 'black', 'yellow', 1)
+puts builder.to_xml
+```
+
+Outputs
+
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-09T00:56:07+04:00</requestdate>
+    <customer/>
+    <vendor/>
+    <vehicle status="used">
       <year>2021</year>
       <make>Toyota</make>
       <model>Prius</model>
-      <vin>XXXXXXXXXX</vin>
+      <colorcombination>
+        <interiorcolor>black</interiorcolor>
+        <exteriorcolor>yellow</exteriorcolor>
+        <preference>1</preference>
+      </colorcombination>
     </vehicle>
   </prospect>
 </adf>
+```
+
+Add Vendor
 
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.vendor.add('Dealer One', 'Manager Name', {
+  part: 'full',
+  type: 'individual'
+}) # options for customer object that is required in vendor
 ```
 
+Outputs
+
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-08T18:43:02+04:00</requestdate>
+    <customer/>
+    <vendor>
+      <vendorname>Dealer One</vendorname>
+      <contact>
+        <name part="full" type="individual">Manager Name</name>
+      </contact>
+    </vendor>
+  </prospect>
+</adf>
+```
+
+Add Contact with phone
+
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.customer.add('New Guy', {
+  part: 'full',
+  type: 'individual'
+})
+builder.prospect.customer.contact.add_phone('(555)-444-3333')
+```
+
+Outputs
+
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-08T18:44:45+04:00</requestdate>
+    <customer>
+      <contact>
+        <name part="full" type="individual">New Guy</name>
+        <phone>(555)-444-3333</phone>
+      </contact>
+    </customer>
+    <vendor/>
+  </prospect>
+</adf>
+```
+
+Different Vehicle operations
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/adf_builder.rb

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
+require 'ox'
 require_relative "adf_builder/version"
-require_relative 'adf_builder/base'
-require_relative 'adf_builder/id'
+
+# CUSTOMER
+require_relative 'adf_builder/customer/customer'
 
 # BASE
+require_relative 'adf_builder/base/base'
 require_relative 'adf_builder/base/prospect'
 require_relative 'adf_builder/base/request_date'
 
+# SHARED
+require_relative 'adf_builder/shared/id'
+require_relative 'adf_builder/shared/contact'
+
 # VEHICLES
 require_relative 'adf_builder/vehicles/vehicles'
+require_relative 'adf_builder/vehicles/colorcombinations'
 
-
-
-require 'ox'
+# VENDOR
+require_relative 'adf_builder/vendor/vendor'
 
 module AdfBuilder
   class Error < StandardError; end
@@ -23,8 +30,8 @@ module AdfBuilder
       @base = Base.new(@doc)
     end
 
-    def base
-      @base
+    def prospect
+      @base.prospect
     end
 
     # output the XML
@@ -34,8 +41,6 @@ module AdfBuilder
 
     # def an example of minimal XML taken from ADF spec file http://adfxml.info/adf_spec.pdf
     def minimal_lead
-      adf = Ox::Element.new("adf")
-
       prospect = Ox::Element.new("prospect")
 
       request_date = Ox::Element.new("requestdate")
@@ -78,16 +83,15 @@ module AdfBuilder
       vendor << contact
 
       prospect << request_date << vehicle << customer << vendor
-      adf << prospect
-      @doc << adf
+      @doc.remove_children_by_path("adf/prospect")
+      @doc.adf << prospect
       Ox.dump(@doc, {})
     end
 
-
-
-
-    private
-
+    # go back to the initial structure
+    def reset_doc
+      @doc.adf.prospect.remove_children_by_path("*")
+    end
 
     # all the files will start with this same header
     def init_doc
@@ -103,5 +107,42 @@ module AdfBuilder
       doc << adf
       doc
     end
+
+    # we will either create a new node with the value or replace the one if it is available
+    def self.update_node(parent_node, key, value, params={})
+      key = key.to_s
+      value = value.to_s
+      if parent_node.locate(key).size > 0
+        node = parent_node.locate(key).first
+        node.replace_text(value)
+      else
+        node = (Ox::Element.new(key) << value)
+        parent_node << node
+      end
+
+      AdfBuilder::Builder.update_params(node, key, params)
+    end
+
+    # update the params by first checking if they are valid params and then checking if the values are valid if necessary
+    def self.update_params(node, key, params)
+      return true if params.empty?
+      key = key.to_sym
+      valid_values = params[:valid_values]
+      valid_parameters = params[:valid_parameters]
+      _params = AdfBuilder::Builder.whitelabel_params(params,valid_parameters, key)
+      _params.each do |k,v|
+        node[k] = v if valid_values[key][k] == true or valid_values[key][k].include? v.to_s
+      end
+    end
+
+    # clear out the opts that don't match valid keys
+    def self.whitelabel_params(opts, valid_parameters, key)
+      opts.slice(*valid_parameters[key])
+    end
+
+    def self.valid_child?(parent, tag_name, index)
+      child = parent.locate(tag_name)[index]
+      return !child.nil?,child
+    end
   end
 end

data/lib/adf_builder/{base.rb → base/base.rb}

@@ -9,7 +9,5 @@ module AdfBuilder
     def prospect
       @prospect
     end
-
-
   end
 end

data/lib/adf_builder/base/prospect.rb

@@ -14,6 +14,8 @@ module AdfBuilder
 
       @request_date = RequestDate.new(@prospect)
       @vehicles = Vehicles.new(@prospect)
+      @customer = Customer.new(@prospect)
+      @vendor = Vendor.new(@prospect)
     end
 
     def request_date
@@ -24,6 +26,14 @@ module AdfBuilder
       @vehicles
     end
 
+    def customer
+      @customer
+    end
+
+    def vendor
+      @vendor
+    end
+
     # set status to renew
     def set_renew
       @prospect[:status] = STATUSES[:resend]

data/lib/adf_builder/customer/customer.rb

@@ -0,0 +1,27 @@
+module AdfBuilder
+  class Customer
+    def initialize(prospect)
+      @customer = Ox::Element.new('customer')
+      @contact = nil
+
+      prospect << @customer
+    end
+
+    def contact
+      @contact
+    end
+
+    def add(name, opts={})
+      @contact = Contact.new(@customer, name, opts)
+    end
+
+    def add_id(index, value, source=nil, sequence=1)
+      if @prospect.locate("customer").empty?
+        false
+      else
+        Id.new.add(@prospect.customer(index), value, source, sequence)
+      end
+    end
+
+  end
+end

data/lib/adf_builder/shared/contact.rb

@@ -0,0 +1,50 @@
+module AdfBuilder
+  class Contact
+    VALID_PARAMETERS = {
+      name: [:part, :type, :primarycontact],
+      email: [:preferredcontact],
+      phone: [:type, :time, :preferredcontact]
+    }
+
+    PHONE_TYPES = [:phone, :fax, :cellphone, :pager]
+
+    def initialize(parent_node, name, opts={})
+      @contact = Ox::Element.new('contact') << (Ox::Element.new('name') << name)
+      parent_node << @contact
+
+      opts = whitelabel_opts(opts, :name)
+
+      if opts[:primary_contact]
+        @contact[:primarycontact] = opts[:primary_contact].to_s
+      end
+
+      opts.each do |k,v|
+        @contact.locate("name")[0][k] = v.to_s
+      end
+
+    end
+
+    def add_email(email, opts={})
+      @contact << (Ox::Element.new('email') << email)
+      opts = whitelabel_opts(opts, :phone)
+
+      opts.each do |k,v|
+        @contact.email[k] = v.to_s
+      end
+    end
+
+    def add_phone(phone, opts={})
+      @contact << (Ox::Element.new('phone') << phone)
+      opts = whitelabel_opts(opts, :phone)
+
+      opts.each do |k,v|
+        @contact.phone[k] = v.to_s
+      end
+    end
+
+    # clear out the opts that don't match valid keys
+    def whitelabel_opts(opts, key)
+      opts.slice(*VALID_PARAMETERS[key])
+    end
+  end
+end

data/lib/adf_builder/vehicles/colorcombinations.rb

@@ -0,0 +1,31 @@
+module AdfBuilder
+  class ColorCombinations
+
+    FREE_TEXT_OPTIONAL_TAGS = [:interiorcolor, :exteriorcolor, :preference]
+
+    def initialize(vehicle)
+      @vehicle = vehicle
+      @color_combination = nil
+    end
+
+    def add(interior_color, exterior_color, preference)
+      @color_combination = Ox::Element.new('colorcombination')
+      @color_combination <<
+        (Ox::Element.new('interiorcolor') << interior_color) <<
+        (Ox::Element.new('exteriorcolor') << exterior_color) <<
+        (Ox::Element.new('preference') << preference.to_s)
+       @vehicle << @color_combination
+    end
+
+    def update_tags(index, tags)
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@vehicle,'colorcombination', index)
+      if valid
+        tags.each do |key, value|
+          if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
+            AdfBuilder::Builder.update_node(vehicle, key, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adf_builder/vehicles/vehicles.rb

@@ -1,64 +1,95 @@
 module AdfBuilder
   class Vehicles
-    INTEREST_VALUES = {
-      buy: 'buy',
-      lease: 'lease',
-      sell: 'sell',
-      trade_in: 'trade-in',
-      test_drive: 'test-drive'
+    VALID_PARAMETERS = {
+      vehicle: [:interest, :status],
+      odometer: [:status, :units],
+      imagetag: [:width, :height, :alttext],
     }
 
-    STATUS_VALUES = {
-      new: 'new',
-      used: 'used'
+    VALID_VALUES = {
+      vehicle: {
+        interest: %w[buy lease sell trade-in test-drive],
+        status: %w[new used]
+      },
+      odometer: {
+        status: %w[unknown rolledover replaced original],
+        units: %w[km mi]
+      },
+      imagetag: {
+        width: true,
+        height: true,
+        alttext: true
+      }
     }
 
-    FREE_TEXT_OPTIONAL_TAGS = {
-      vin: :vin,
-      stock: :stock,
-      trim: :trim,
-      doors: :doors,
-      bodystyle: :bodystyle,
-      transmission: :transmission,
-      pricecomments: :pricecomments,
-      comments: :comments
-    }
+    FREE_TEXT_OPTIONAL_TAGS = [:year, :make, :model, :vin, :stock,
+      :trim, :doors, :bodystyle, :transmission, :pricecomments, :comments]
+
+    CONDITIONS = %w[excellent good fair poor unknown]
 
     def initialize(prospect)
       @prospect = prospect
+      @color_combinations = []
     end
 
-    def add(year, make, model, tags={})
-      vehicle = Ox::Element.new('vehicle')
-
-      if tags[:interest]
-        interest = INTEREST_VALUES[tags[:interest].to_sym]
-        tags.delete(:interest)
-      else
-        interest = INTEREST_VALUES[:buy]
+    def add_color_combination(v_index, interior_color, exterior_color, preference)
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', v_index)
+      if valid
+        cc = ColorCombinations.new(vehicle)
+        cc.add(interior_color, exterior_color, preference)
+        @color_combinations.push(cc)
       end
+    end
 
-      if tags[:status]
-        status = STATUS_VALUES[tags[:status].to_sym]
-        tags.delete(:status)
-      else
-        status = STATUS_VALUES[:new]
-      end
+    def color_combinations
+      @color_combinations
+    end
+
+    def add(year, make, model, params={})
+      vehicle = Ox::Element.new('vehicle')
 
-      vehicle[:interest] = interest
-      vehicle[:status] = status
+      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      AdfBuilder::Builder.update_params(vehicle, :vehicle, params)
 
       vehicle << (Ox::Element.new('year') << year.to_s)
       vehicle << (Ox::Element.new('make') << make)
       vehicle << (Ox::Element.new('model') << model)
 
-      tags.each do |key, value|
-        if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-          vehicle << (Ox::Element.new(key.to_s) << value)
-        end
+      @prospect << vehicle
+    end
+
+    def update_odometer(index, value, params={})
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
+      if valid
+        params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+        AdfBuilder::Builder.update_node(vehicle, 'odometer', value, params)
       end
+    end
 
-      @prospect << vehicle
+    def update_condition(index, value)
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
+      if valid and CONDITIONS.include? value
+        AdfBuilder::Builder.update_node(vehicle, 'condition', value)
+      end
+    end
+
+    def update_imagetag(index, value, params={})
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
+      if valid
+        params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+        AdfBuilder::Builder.update_node(vehicle, 'imagetag', value, params)
+      end
+    end
+
+    def update_tags_with_free_text(index, tags)
+      valid, vehicle = AdfBuilder::Builder.valid_child?(@prospect,'vehicle', index)
+      if valid
+        tags.each do |key, value|
+          if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
+            AdfBuilder::Builder.update_node(vehicle, key, value)
+          end
+        end
+      end
     end
 
     def add_id(index, value, source=nil, sequence=1)
@@ -68,6 +99,5 @@ module AdfBuilder
         Id.new.add(@prospect.vehicle(index), value, source, sequence)
       end
     end
-
   end
 end

data/lib/adf_builder/vendor/vendor.rb

@@ -0,0 +1,34 @@
+module AdfBuilder
+  class Vendor
+    def initialize(prospect)
+      @vendor = Ox::Element.new('vendor')
+      @contact = nil
+      prospect << @vendor
+    end
+
+    def contact
+      @contact
+    end
+
+    def add(name, contact_name, opts={})
+      @vendor << (Ox::Element.new('vendorname') << name)
+      @contact = Contact.new(@vendor, contact_name, opts)
+    end
+
+    def add_url(url)
+      if @vendor.locate("url").size > 0
+        @vendor.remove_children(@vendor.url)
+      end
+      @vendor << (Ox::Element.new('url') << url)
+    end
+
+    def add_id(index, value, source=nil, sequence=1)
+      if @prospect.locate("vendor").empty?
+        false
+      else
+        Id.new.add(@prospect.vendor(index), value, source, sequence)
+      end
+    end
+
+  end
+end

data/lib/adf_builder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdfBuilder
-  VERSION = "0.0.3"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - marcus.salinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -45,11 +45,15 @@ files:
 - bin/console
 - bin/setup
 - lib/adf_builder.rb
-- lib/adf_builder/base.rb
+- lib/adf_builder/base/base.rb
 - lib/adf_builder/base/prospect.rb
 - lib/adf_builder/base/request_date.rb
-- lib/adf_builder/id.rb
+- lib/adf_builder/customer/customer.rb
+- lib/adf_builder/shared/contact.rb
+- lib/adf_builder/shared/id.rb
+- lib/adf_builder/vehicles/colorcombinations.rb
 - lib/adf_builder/vehicles/vehicles.rb
+- lib/adf_builder/vendor/vendor.rb
 - lib/adf_builder/version.rb
 homepage: https://github.com/jippylong12/adf_builder
 licenses: