adf_builder 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a45dd0135682b562fe9fe49cacd5590a0da5c702894ae9f0b888d1d48c6536c
-  data.tar.gz: 479f5c42eb07d457a0196abe35192f719d77a953bf6045739a3944157ff41434
+  metadata.gz: 363203a0be498b2a4c64b3a8468fb9f5107c0a64a53f7931ebfc6b5804763b96
+  data.tar.gz: 7b1500ef7e17368b62987600f306f216321e5ffdeecfdc439569db89a85cb0d2
 SHA512:
-  metadata.gz: 1d43d0eb120efacce6e7e52e610a51435f7d9dbc2f0cd366dbeae29f57eb1446ff220e70ce600dd8adeb9b33a0609d897a34ba4efa519af631777d9413563c6d
-  data.tar.gz: 63e65e9fa0fe65d6a285bdf52d246ab4f075fefd297fe9fda70d6784358a502ec2924f5dce41f5e5209cbc09835898e646784b9976aa7b237880559bfa297a96
+  metadata.gz: 3966f161aeeff1e4657860bf6f87a6d730ffc689c7ff726353ceb2f84c8a87dd942f64374623bd0e7c0532d22e844e9f7bc275534cd9cda7bd3b04ebbad12986
+  data.tar.gz: 5eafe81b9c315faf6f9e4f6302fb2f5328916033e3f9ef3507a0618dabcbdf6f59729f2c1dbe772022c4a8ef42b353a06f38ef5bf530048af8e7a54a75d6a6f0

data/CHANGELOG.md

@@ -1,11 +1,36 @@
 ## [Unreleased]
-- Add Vehicle structure
-- Add Vendor structure
-- Add Customer structure
+- Vehicle Structure
+  - Remaining Optional Tags that are not free text
+  - odometer
+  - condition
+  - colorcombination
+  - imagetag
+  - price
+  - option
+  - finance
+- Expand Structures for all parameters
+  - Customer 
+  - Vehicle
+  - Contact
+
+### In many moons
 - Add Provider structure
-- Add Contact structure
 - Add Price structure
 
+## [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
+
 ## [0.0.2] - 2021-08-04
 
 - Can create a prospect and dynamically update params and values for the base and parent level

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adf_builder (0.0.1)
+    adf_builder (0.0.6)
       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
 
@@ -10,70 +10,195 @@ gem 'adf_builder'
 ```
 
 And then execute:
-
-    $ bundle install
+```shell
+$ bundle install
+```
 
 Or install it yourself as:
-
-    $ gem install adf_builder
+```shell
+$ gem install adf_builder
+```
 
 ## Usage
 
 Quickly create the minimal lead found in the spec document
-
-    builder = AdfBuilder::Builder.new
-    builder.minimal_lead
-
+```ruby
+builder = AdfBuilder::Builder.new
+builder.minimal_lead
+```
 Start Building
+```ruby
+builder = AdfBuilder::Builder.new
+builder.to_xml
+```
+
 
-    builder = AdfBuilder::Builder.new
-    builder.to_xml
+Outputs
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-04T15:18:30+04:00</requestdate>
+  </prospect>
+</adf>
+```
 
-Outputs 
-    
-    <?ADF version="1.0"?>
-    <?xml version="1.0"?>
-    <adf>
-      <prospect status="new">
-        <requestdate>2021-08-04T15:18:30+04:00</requestdate>
-      </prospect>
-    </adf>
 
 Update Requestdate value
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.request_date.update_val(Date.new(2021,12,12))
+```
+Outputs
 
-    builder = AdfBuilder::Builder.new
-    builder.base.prospect.request_date.update_val(Date.new(2021,12,12))
+```xml
+<?ADF version="1.0"?>
 
-Outputs
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-12-12T00:00:00+00:00</requestdate>
+  </prospect>
+</adf>
+```
 
-    <?ADF version="1.0"?>
-    
-    <?xml version="1.0"?>
-    <adf>
-      <prospect status="new">
-        <requestdate>2021-12-12T00:00:00+00:00</requestdate>
-      </prospect>
-    </adf>
 
 Add ID tag to Prospect
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.add_id('howdy', 'Ag')
+```
+
+Outputs
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <id sequence="1" source="Ag">howdy</id>
+    <requestdate>2021-08-04T15:24:16+04:00</requestdate>
+  </prospect>
+</adf>
+```
+
+Add Vehicle
 
-    builder = AdfBuilder::Builder.new
-    builder.base.prospect.add_id('howdy', 'Ag')
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.vehicles.add(2021, 'Ford', 'Raptor')
+```
+
+Outputs
+
+```xml
+<?ADF version="1.0"?>
+
+<?xml version="1.0"?>
+<adf>
+  <prospect status="new">
+    <requestdate>2021-08-04T18:08:50+04:00</requestdate>
+    <vehicle interest="buy" status="new">
+      <year>2021</year>
+      <make>Ford</make>
+      <model>Raptor</model>
+    </vehicle>
+  </prospect>
+</adf>
+```
+Add Vehicle with tags
+
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
+  interest: :sell, 
+  status: :used,
+  vin: 'XXXXXXXXXX',
+})
+```
+
+Outputs
+
+```xml
+<?ADF version="1.0"?>
+
+<?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>
+      <make>Toyota</make>
+      <model>Prius</model>
+      <vin>XXXXXXXXXX</vin>
+    </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
 
-    <?ADF version="1.0"?>
-    
-    <?xml version="1.0"?>
-    <adf>
-      <prospect status="new">
-        <id sequence="1" source="Ag">howdy</id>
-        <requestdate>2021-08-04T15:24:16+04:00</requestdate>
-      </prospect>
-    </adf>
+```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>
+```
 ## 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,13 +1,25 @@
 # frozen_string_literal: true
 
+require 'ox'
 require_relative "adf_builder/version"
-require_relative 'adf_builder/base'
+
+# 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'
-require_relative 'adf_builder/id'
 
+# SHARED
+require_relative 'adf_builder/shared/id'
+require_relative 'adf_builder/shared/contact'
 
-require 'ox'
+# VEHICLES
+require_relative 'adf_builder/vehicles/vehicles'
+
+# VENDER
+require_relative 'adf_builder/vendor/vendor'
 
 module AdfBuilder
   class Error < StandardError; end
@@ -17,8 +29,8 @@ module AdfBuilder
       @base = Base.new(@doc)
     end
 
-    def base
-      @base
+    def prospect
+      @base.prospect
     end
 
     # output the XML
@@ -28,8 +40,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")
@@ -72,16 +82,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

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

@@ -10,13 +10,30 @@ module AdfBuilder
       @doc.adf << Ox::Element.new("prospect")
       @prospect = @doc.adf.prospect
       @prospect[:status] = STATUSES[:new]
+
+
       @request_date = RequestDate.new(@prospect)
+      @vehicles = Vehicles.new(@prospect)
+      @customer = Customer.new(@prospect)
+      @vendor = Vendor.new(@prospect)
     end
 
     def request_date
       @request_date
     end
 
+    def vehicles
+      @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/base/request_date.rb

@@ -7,7 +7,6 @@ module AdfBuilder
       @request_date_node = Ox::Element.new('requestdate')
       @request_date_node << DateTime.now.strftime('%FT%T%:z')
       prospect_node << @request_date_node
-      @request_date_node
     end
 
     def update_val(datetime_value, format=1)

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,55 @@
+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
+
+
+
+
+    private
+
+    # 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/vehicles.rb

@@ -0,0 +1,69 @@
+module AdfBuilder
+  class Vehicles
+    INTEREST_VALUES = {
+      buy: 'buy',
+      lease: 'lease',
+      sell: 'sell',
+      trade_in: 'trade-in',
+      test_drive: 'test-drive'
+    }
+
+    STATUS_VALUES = {
+      new: 'new',
+      used: 'used'
+    }
+
+    FREE_TEXT_OPTIONAL_TAGS = {
+      vin: :vin,
+      stock: :stock,
+      trim: :trim,
+      doors: :doors,
+      bodystyle: :bodystyle,
+      transmission: :transmission,
+      pricecomments: :pricecomments,
+      comments: :comments
+    }
+
+    def initialize(prospect)
+      @prospect = prospect
+    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
+      end
+
+      if tags[:status]
+        status = STATUS_VALUES[tags[:status].to_sym]
+        tags.delete(:status)
+        vehicle[:status] = status
+      end
+
+
+      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
+      end
+
+      @prospect << vehicle
+    end
+
+    def add_id(index, value, source=nil, sequence=1)
+      if @prospect.locate("vehicle").empty? or @prospect.vehicle(index).nil?
+        false
+      else
+        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.2"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 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,10 +45,14 @@ 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/vehicles.rb
+- lib/adf_builder/vendor/vendor.rb
 - lib/adf_builder/version.rb
 homepage: https://github.com/jippylong12/adf_builder
 licenses: