adf_builder 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 273896ee8ce6282f9b8c8f2b1a5c2ff9dd50617d88cd98a9a165e7bf319f48d8
-  data.tar.gz: 87dda47e5a500c476fef3ecf67e6a8160a8cb061ef134830c1bda8613f6615bb
+  metadata.gz: '0806861185a24169f9427bfdc78e01f699ea30523cd6db4e055ac951a811e21d'
+  data.tar.gz: 7b5574210760b69ad5e7bb5b2cbc8d3a4e16b58967cfe7c7c94edd3ff3266d15
 SHA512:
-  metadata.gz: 2e3ea523f1c88100648a915b23fd3f83d728ce504ba4f51b720041627f1d85235675123c9579a91867729ee00a216d346a2540d0817e0050f889fafaf5f12af8
-  data.tar.gz: ef93592778d5e317ea816e330c5b86d054222481e0821ce1976f1afe7a19c5ab76b8f2fd3f9f7b21e23b8ecdbb856f3d0923f295bdf850ed6221018d546a0928
+  metadata.gz: 453cbe5ebca171565d2cb3be708130979bb782287d96e622fbdaa8ded37ecff51e63004a6ba3c25dd4b9d37e1f552918dfa4924698a4c7867981eea1677c3ab0
+  data.tar.gz: b2d3ebcd64bbcd89034a1b8d9f1dc56518c3147eee88ec44774d8ce4ee877c2347a28820c72fb24b80fed267518457fd58ff6e43504cafce39970bf4f304fa66

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 ## [Unreleased]
+- 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 Price structure
+
+## [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
 
 ## [0.0.1] - 2021-08-03
 
 - Initial release
-- Can return the sample XML given from spec doc
+- Can return the minimal XML given from spec doc

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,5 @@
 # AdfBuilder
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/adf_builder`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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
 
@@ -13,17 +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
 
-TODO: Write usage instructions here
+Quickly create the minimal lead found in the spec document
+```ruby
+builder = AdfBuilder::Builder.new
+builder.minimal_lead
+```
+Start Building
+```ruby
+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>
+```
+
+
+Update Requestdate value
+```ruby
+builder = AdfBuilder::Builder.new
+builder.prospect.request_date.update_val(Date.new(2021,12,12))
+```
+Outputs
+
+```xml
+<?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
+
+```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
+
+```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/adf_builder.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["marcus.salinas"]
   spec.email         = ["12.marcus.salinas@gmail.com"]
 
-  spec.summary       = "Create XML for the Auto-lead Date Format"
-  spec.description   = "Useful in order to easily create XML so in ADF format to send by email."
+  spec.summary       = "Create XML for the Auto-base Date Format"
+  spec.description   = "Easily create XML in ADF format to send by email."
   spec.homepage      = "https://github.com/jippylong12/adf_builder"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 2.4.0"

data/lib/adf_builder.rb

@@ -1,24 +1,45 @@
 # frozen_string_literal: true
 
+require 'ox'
 require_relative "adf_builder/version"
-require_relative 'adf_builder/lead'
 
-require 'ox'
+# 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'
+
+# VENDER
+require_relative 'adf_builder/vendor/vendor'
 
 module AdfBuilder
   class Error < StandardError; end
   class Builder
     def initialize
       @doc = self.init_doc
-      @lead = Lead.new(@doc)
+      @base = Base.new(@doc)
     end
 
-    def lead
-      @lead
+    def prospect
+      @base.prospect
+    end
+
+    # output the XML
+    def to_xml
+      Ox.dump(@doc, {})
     end
 
     # def an example of minimal XML taken from ADF spec file http://adfxml.info/adf_spec.pdf
-    def minimal_xml
+    def minimal_lead
       adf = Ox::Element.new("adf")
 
       prospect = Ox::Element.new("prospect")
@@ -69,9 +90,6 @@ module AdfBuilder
     end
 
 
-    private
-
-
     # all the files will start with this same header
     def init_doc
       doc = Ox::Document.new
@@ -82,6 +100,8 @@ module AdfBuilder
       instruct = Ox::Instruct.new(:xml)
       instruct[:version] = '1.0'
       doc << instruct
+      adf = Ox::Element.new("adf")
+      doc << adf
       doc
     end
   end

data/lib/adf_builder/base/base.rb

@@ -0,0 +1,13 @@
+module AdfBuilder
+  class Base
+    # initialize the prospect, id, and requestdate node
+    def initialize(doc)
+      @doc = doc
+      @prospect = Prospect.new(@doc)
+    end
+
+    def prospect
+      @prospect
+    end
+  end
+end

data/lib/adf_builder/base/prospect.rb

@@ -0,0 +1,46 @@
+module AdfBuilder
+  class Prospect
+    STATUSES = {
+      new: :new,
+      resend: :resend
+    }
+
+    def initialize(doc)
+      @doc = doc
+      @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]
+    end
+
+    def add_id(value, source=nil, sequence=1)
+      Id.new.add(@prospect, value, source, sequence)
+    end
+  end
+end

data/lib/adf_builder/base/request_date.rb

@@ -0,0 +1,20 @@
+module AdfBuilder
+  class RequestDate
+    WITH_SYMBOLS = '%FT%T%:z'
+    WITHOUT_SYMBOLS = '%Y%m%dT%H%M%S%z'
+
+    def initialize(prospect_node)
+      @request_date_node = Ox::Element.new('requestdate')
+      @request_date_node << DateTime.now.strftime('%FT%T%:z')
+      prospect_node << @request_date_node
+    end
+
+    def update_val(datetime_value, format=1)
+      if format == 1
+        @request_date_node.replace_text(datetime_value.strftime(WITH_SYMBOLS))
+      elsif format == 2
+        @request_date_node.replace_text(datetime_value.strftime(WITHOUT_SYMBOLS))
+      end
+    end
+  end
+end

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/shared/id.rb

@@ -0,0 +1,20 @@
+module AdfBuilder
+  class Id
+    def initialize
+
+    end
+
+    # add id tag to the form
+    def add(parent_node, value, source=nil, sequence=1)
+      id_node = Ox::Element.new('id')
+      id_node << value
+      id_node[:sequence] = sequence
+
+      if source
+        id_node[:source] = source
+      end
+
+      parent_node.prepend_child(id_node)
+    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.1"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - marcus.salinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ox
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-description: Useful in order to easily create XML so in ADF format to send by email.
+description: Easily create XML in ADF format to send by email.
 email:
 - 12.marcus.salinas@gmail.com
 executables: []
@@ -45,7 +45,14 @@ files:
 - bin/console
 - bin/setup
 - lib/adf_builder.rb
-- lib/adf_builder/lead.rb
+- lib/adf_builder/base/base.rb
+- lib/adf_builder/base/prospect.rb
+- lib/adf_builder/base/request_date.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:
@@ -72,5 +79,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Create XML for the Auto-lead Date Format
+summary: Create XML for the Auto-base Date Format
 test_files: []

data/lib/adf_builder/lead.rb

@@ -1,13 +0,0 @@
-require 'ox'
-
-module AdfBuilder
-  class Lead
-    def initialize(doc)
-      @doc = doc
-    end
-
-    def base_xml
-      Ox.dump(@doc, {})
-    end
-  end
-end