adf_builder

AdfBuilder

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

Add this line to your application's Gemfile:

gem 'adf_builder'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install adf_builder

Usage

Quickly create the minimal lead found in the spec document

builder = AdfBuilder::Builder.new
builder.minimal_lead

Start Building

builder = AdfBuilder::Builder.new
builder.to_xml

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

builder = AdfBuilder::Builder.new
builder.prospect.request_date.update_val(Date.new(2021,12,12))

Outputs

<?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

builder = AdfBuilder::Builder.new
builder.prospect.add_id('howdy', 'Ag')

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>

Add Vehicle

builder = AdfBuilder::Builder.new
builder.prospect.vehicles.add(2021, 'Ford', 'Raptor')

Outputs

<?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>

Vehicle with different operations

builder = AdfBuilder::Builder.new
builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
  status: :used,
})
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

<?ADF version="1.0"?>

<?xml version="1.0"?>
<adf>
  <prospect status="new">
    <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

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

<?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

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">
    <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

builder = AdfBuilder::Builder.new
builder.prospect.customer.add('New Guy', {
  part: 'full',
  type: 'individual'
})
builder.prospect.customer.contact.add_phone('(555)-444-3333')

Outputs

<?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>

A complex Provider

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("[e-mail]", {preferredcontact: 0})
provider.add_phone("[phone]", {
  type: 'fax',
  time: 'day'
})
provider.add_contact("Mr Sir")
provider.contact.add_phone("[phone]")

<?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">[e-mail]</email>
      <phone type="fax" time="day">[phone]</phone>
      <contact>
        <name>Mr Sir</name>
        <phone>[phone]</phone>
      </contact>
    </provider>
  </prospect>
</adf>

Adding and Updating Price of Vehicle

builder = AdfBuilder::Builder.new
builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
  status: :used,
})

builder.prospect.vehicles.add_price(0,23400, {
  type: 'quote',
  currency: 'blah',
  source: "YES"
})

puts builder.to_xml

builder.prospect.vehicles.price(0).update(3444, {
  currency: 'USD'
})

puts builder.to_xml

Outputs

<?ADF version="1.0"?>

<?xml version="1.0"?>
<adf>
  <prospect status="new">
    <requestdate>2021-08-13T13:28:50+04:00</requestdate>
    <customer/>
    <vendor/>
    <vehicle status="used">
      <year>2021</year>
      <make>Toyota</make>
      <model>Prius</model>
      <price type="quote" source="YES">23400</price>
    </vehicle>
  </prospect>
</adf>

<?ADF version="1.0"?>

<?xml version="1.0"?>

<adf>
  <prospect status="new">
    <requestdate>2021-08-13T13:28:50+04:00</requestdate>
    <customer/>
    <vendor/>
    <vehicle status="used">
      <year>2021</year>
      <make>Toyota</make>
      <model>Prius</model>
      <price type="quote" source="YES" currency="USD">3444</price>
    </vehicle>
  </prospect>
</adf>

Adding comments to Vehicle

builder = AdfBuilder::Builder.new
builder.prospect.vehicles.add(2021, 'Toyota', 'Prius', {
  status: :used,
})

builder.prospect.vehicles.add_comments(0, "This is a comment")

puts builder.to_xml

Outputs

<?ADF version="1.0"?>

<?xml version="1.0"?>
<adf>
  <prospect status="new">
    <requestdate>2021-11-02T16:35:43+04:00</requestdate>
    <customer/>
    <vendor/>
    <vehicle status="used">
      <year>2021</year>
      <make>Toyota</make>
      <model>Prius</model>
      <comments>This is a comment</comments>
    </vehicle>
  </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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jippylong12/adf_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the AdfBuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.