adf_builder 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 363203a0be498b2a4c64b3a8468fb9f5107c0a64a53f7931ebfc6b5804763b96
-  data.tar.gz: 7b1500ef7e17368b62987600f306f216321e5ffdeecfdc439569db89a85cb0d2
+  metadata.gz: 7b6904f4a4346718e3a08189a1da210b0c6a8305679d49f00d552854abb36db2
+  data.tar.gz: becdc5415db73468da3508f93f9d8d6a7a094a80e19f2b5bcf872e248d3520df
 SHA512:
-  metadata.gz: 3966f161aeeff1e4657860bf6f87a6d730ffc689c7ff726353ceb2f84c8a87dd942f64374623bd0e7c0532d22e844e9f7bc275534cd9cda7bd3b04ebbad12986
-  data.tar.gz: 5eafe81b9c315faf6f9e4f6302fb2f5328916033e3f9ef3507a0618dabcbdf6f59729f2c1dbe772022c4a8ef42b353a06f38ef5bf530048af8e7a54a75d6a6f0
+  metadata.gz: '0798101309032835894eb10965dfbcbcc97b7481f1e1aefda8f617b4a1219c469eb505df14c7344c2be80c0ce39d2bf347aa33f63106d893fcd1010d52775d0f'
+  data.tar.gz: 15d466aa189bf14ba7a7b79fa807a596f9d6d789ab06c68e40692d4b9e81336195b9581c1243fea22f12fa87b5059d7d453282de1c2455d89811d6f48f11bbae

data/CHANGELOG.md

@@ -17,6 +17,11 @@
 - Add Provider 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adf_builder (0.0.6)
+    adf_builder (0.0.7)
       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,9 @@ Outputs
   </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

@@ -17,8 +17,9 @@ 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
@@ -106,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/shared/contact.rb

@@ -42,11 +42,6 @@ module AdfBuilder
       end
     end
 
-
-
-
-    private
-
     # clear out the opts that don't match valid keys
     def whitelabel_opts(opts, key)
       opts.slice(*VALID_PARAMETERS[key])

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.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - marcus.salinas
@@ -51,6 +51,7 @@ files:
 - 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