adf_builder 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d008819843612af5533e3967bcd340b078b9d72a8616bd9ae53cd0ef00b8a483
-  data.tar.gz: d5c4308aff6683a815f1afda34e5fbaf3efcc617c2738a9ce2cd702ad4cc67d9
+  metadata.gz: 8a2725ac72b47a548355664e21014fd434ead3aa0829f0dfd3d8c506dd12c1db
+  data.tar.gz: 584cabe276de7ef15cecc2e50911005e6a7100468582934f3efa97107d5d576b
 SHA512:
-  metadata.gz: 73b81965ecfa689d8b107dcbdea47e6c7d75b49efed0bb589bdd677a7b417c1b71002d0e25e3772aa5a5f3b26b881470fef752493f9dc476145d0715448157a3
-  data.tar.gz: 1784480ea361713eafcd0caba178558d97c02b66b30657b28154185cc59160cdcd8dd6d53d74147396f773fe9e6ad22ef4e4189554bfedd2bf194ee19c07467a
+  metadata.gz: 5a4e274b4ea6af2af31d0cec8c6c452ff8da5db67b8f4c3b9442a0d44449dbf912e6b6ad1146649f12b7b8a20017716598e56b01e19f5ebb17020aa94ee57faf
+  data.tar.gz: b7c13eab73118e95fe03af6c1428c01f18a69c895ef2d48d4eda9731289353857d210328f08150818d27141e332bace07ff6c991c482d6063526939beca3e492

data/CHANGELOG.md

@@ -1,21 +1,29 @@
 ## [Unreleased]
-- Vehicle Structure
-  - Remaining Optional Tags that are not free text
-  - odometer
-  - condition
-  - colorcombination
-  - imagetag
+- Vehicle Structure - Remaining Optional Tags that are not free text
   - price
   - option
   - finance
 - Expand Structures for all parameters
   - Customer 
-  - Vehicle
   - Contact
+  - Vehicle
+  - Price
+
+
+## [0.0.8] - 2021-08-12
+- Added all of Provider 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
 
-### In many moons
-- Add Provider structure
-- Add Price structure
+## [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

data/Gemfile.lock

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

data/README.md

@@ -108,15 +108,28 @@ Outputs
   </prospect>
 </adf>
 ```
-Add Vehicle with tags
+
+Vehicle with different operations
 
 ```ruby
 builder = AdfBuilder::Builder.new
 builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
-  interest: :sell, 
   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,16 +140,55 @@ Outputs
 <?xml version="1.0"?>
 <adf>
   <prospect status="new">
-    <requestdate>2021-08-04T18:16:31+04:00</requestdate>
-    <vehicle interest="sell" status="used">
-      <year>2021</year>
+    <requestdate>2021-08-09T00:53:59+04:00</requestdate>
+    <customer/>
+    <vendor/>
+    <vehicle status="used">
+      <year>2000</year>
       <make>Toyota</make>
       <model>Prius</model>
-      <vin>XXXXXXXXXX</vin>
+      <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>
+      <colorcombination>
+        <interiorcolor>black</interiorcolor>
+        <exteriorcolor>yellow</exteriorcolor>
+        <preference>1</preference>
+      </colorcombination>
+    </vehicle>
+  </prospect>
+</adf>
 ```
 
 Add Vendor
@@ -199,6 +251,49 @@ Outputs
   </prospect>
 </adf>
 ```
+A complex Provider 
+
+```ruby
+builder = AdfBuilder::Builder.new
+provider = builder.prospect.provider
+provider.add('Testing', {part: 'full', type: 'business'})
+provider.update_tags_with_free_text({
+                                                       url: 'howdy',
+                                                       service: "Nice"
+                                                     })
+provider.add_email("test@test.com", {preferredcontact: 0})
+provider.add_phone("+14445556666", {
+  type: 'fax',
+  time: 'day'
+})
+provider.add_contact("Mr Sir")
+provider.contact.add_phone("+132435523424")
+```
+
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-12T18:56:41+04:00</requestdate>
+    <customer/>
+    <vendor/>
+    <provider>
+      <name part="full" type="business">Testing</name>
+      <url>howdy</url>
+      <service>Nice</service>
+      <email preferredcontact="0">test@test.com</email>
+      <phone type="fax" time="day">+14445556666</phone>
+      <contact>
+        <name>Mr Sir</name>
+        <phone>+132435523424</phone>
+      </contact>
+    </provider>
+  </prospect>
+</adf>
+```
+
 ## 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

@@ -11,14 +11,18 @@ require_relative 'adf_builder/base/base'
 require_relative 'adf_builder/base/prospect'
 require_relative 'adf_builder/base/request_date'
 
+# PROVIDER
+require_relative 'adf_builder/provider/provider'
+
 # 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'
 
-# VENDER
+# VENDOR
 require_relative 'adf_builder/vendor/vendor'
 
 module AdfBuilder
@@ -40,8 +44,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")
@@ -84,16 +86,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
@@ -109,5 +110,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/prospect.rb

@@ -16,6 +16,7 @@ module AdfBuilder
       @vehicles = Vehicles.new(@prospect)
       @customer = Customer.new(@prospect)
       @vendor = Vendor.new(@prospect)
+      @provider = Provider.new(@prospect)
     end
 
     def request_date
@@ -34,6 +35,10 @@ module AdfBuilder
       @vendor
     end
 
+    def provider
+      @provider
+    end
+
     # set status to renew
     def set_renew
       @prospect[:status] = STATUSES[:resend]

data/lib/adf_builder/provider/provider.rb

@@ -0,0 +1,55 @@
+module AdfBuilder
+  class Provider
+
+
+    FREE_TEXT_OPTIONAL_TAGS = [:service, :url]
+
+    def initialize(prospect)
+      @prospect = prospect
+      @provider = nil
+      @contact = nil
+    end
+
+    def contact
+      @contact
+    end
+
+
+    def add(name, params={})
+      @provider = Ox::Element.new('provider')
+      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@provider, :name, name,  params)
+      @prospect << @provider
+    end
+
+    def add_contact(name, opts={})
+      @contact = Contact.new(@provider, name, opts)
+    end
+
+    def add_phone(phone, params={})
+      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@provider, :phone, phone,  params)
+    end
+
+    def add_email(email, params={})
+      params.merge!({valid_values: AdfBuilder::Contact::VALID_VALUES, valid_parameters: AdfBuilder::Contact::VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@provider, :email, email,  params)
+    end
+
+    def update_tags_with_free_text(tags)
+      tags.each do |key, value|
+        if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
+          AdfBuilder::Builder.update_node(@provider, key, value)
+        end
+      end
+    end
+
+    def add_id(index, value, source=nil, sequence=1)
+      if @prospect.locate("provider").empty?
+        false
+      else
+        Id.new.add(@prospect.provider(index), value, source, sequence)
+      end
+    end
+  end
+end

data/lib/adf_builder/shared/contact.rb

@@ -6,50 +6,37 @@ module AdfBuilder
       phone: [:type, :time, :preferredcontact]
     }
 
-    PHONE_TYPES = [:phone, :fax, :cellphone, :pager]
+    VALID_VALUES = {
+      name: {
+        part: %w[first middle suffix last full],
+        type: %w[individual business],
+        primarycontact: %w[0 1]
+      },
+      email: {
+        preferredcontact: %w[0 1],
+      },
+      phone: {
+        preferredcontact: %w[0 1],
+        type: %w[phone fax cellphone pager],
+        time: %w[morning afternoon evening nopreference day]
+      }
+    }
 
-    def initialize(parent_node, name, opts={})
-      @contact = Ox::Element.new('contact') << (Ox::Element.new('name') << name)
+    def initialize(parent_node, name, params={})
+      @contact = Ox::Element.new('contact')
+      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@contact, :name, name,  params)
       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
+    def add_phone(phone, params={})
+      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@contact, :phone, phone,  params)
     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
-
-
-
-
-    private
-
-    # clear out the opts that don't match valid keys
-    def whitelabel_opts(opts, key)
-      opts.slice(*VALID_PARAMETERS[key])
+    def add_email(email, params={})
+      params.merge!({valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS})
+      AdfBuilder::Builder.update_node(@contact, :email, email,  params)
     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,60 +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)
-        vehicle[:interest] = interest
+    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)
-        vehicle[:status] = status
-      end
+    def color_combinations
+      @color_combinations
+    end
+
+    def add(year, make, model, params={})
+      vehicle = Ox::Element.new('vehicle')
 
+      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)
@@ -64,6 +99,5 @@ module AdfBuilder
         Id.new.add(@prospect.vehicle(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.4"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - marcus.salinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-08 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -49,8 +49,10 @@ files:
 - lib/adf_builder/base/prospect.rb
 - lib/adf_builder/base/request_date.rb
 - lib/adf_builder/customer/customer.rb
+- lib/adf_builder/provider/provider.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