adf_builder 0.4.0 → 1.1.0

data/lib/adf_builder.rb

@@ -4,154 +4,22 @@ require "ox"
 require "json"
 
 require_relative "adf_builder/version"
-
-# CUSTOMER
-require_relative "adf_builder/customer/customer"
-require_relative "adf_builder/customer/timeframe"
-
-# BASE
-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"
-require_relative "adf_builder/vehicles/price"
-
-# VENDOR
-require_relative "adf_builder/vendor/vendor"
+require_relative "adf_builder/validations"
+
+# Nodes
+require_relative "adf_builder/nodes/node"
+require_relative "adf_builder/nodes/prospect"
+require_relative "adf_builder/nodes/shared"
+require_relative "adf_builder/nodes/vehicle"
+require_relative "adf_builder/nodes/vehicle_nodes"
+require_relative "adf_builder/nodes/customer"
+require_relative "adf_builder/nodes/vendor"
+require_relative "adf_builder/nodes/provider"
+
+# Core
+require_relative "adf_builder/serializer"
+require_relative "adf_builder/dsl"
 
 module AdfBuilder
   class Error < StandardError; end
-
-  class Builder
-    def initialize
-      @doc = init_doc
-      @base = Base.new(@doc)
-    end
-
-    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_lead
-      prospect = Ox::Element.new("prospect")
-
-      request_date = Ox::Element.new("requestdate")
-      request_date << "2000-03-30T15:30:20-08:00"
-
-      vehicle = Ox::Element.new("vehicle")
-      year = Ox::Element.new("year")
-      year << "1999"
-
-      make = Ox::Element.new("make")
-      make << "Chevrolet"
-
-      model = Ox::Element.new("model")
-      model << "Blazer"
-
-      vehicle << year << make << model
-
-      customer = Ox::Element.new("customer")
-
-      contact = Ox::Element.new("contact")
-
-      name = Ox::Element.new("name")
-      name[:part] = "full"
-      name << "John Doe"
-
-      phone = Ox::Element.new("phone")
-      phone << "393-999-3922"
-
-      contact << name << phone
-      customer << contact
-
-      vendor = Ox::Element.new("vendor")
-
-      contact = Ox::Element.new("contact")
-      name = Ox::Element.new("name")
-      name[:part] = "full"
-      name << "Acura of Bellevue"
-
-      contact << name
-      vendor << contact
-
-      prospect << request_date << vehicle << customer << vendor
-      @doc.remove_children_by_path("adf/prospect")
-      @doc.adf << prospect
-      Ox.dump(@doc, {})
-    end
-
-    # 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
-      doc = Ox::Document.new
-      instruct = Ox::Instruct.new(:xml)
-      instruct[:version] = "1.0"
-      doc << instruct
-      doc << Ox::Raw.new("")
-      instruct = Ox::Instruct.new("ADF")
-      instruct[:version] = "1.0"
-      doc << instruct
-      adf = Ox::Element.new("adf")
-      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.positive?
-        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) || 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]
-      [!child.nil?, child]
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adf_builder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.1.0
 platform: ruby
 authors:
 - marcus.salinas
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,19 +100,18 @@ files:
 - bin/console
 - bin/setup
 - lib/adf_builder.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/customer/timeframe.rb
 - lib/adf_builder/data/iso-4217-currency-codes.json
-- 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/price.rb
-- lib/adf_builder/vehicles/vehicles.rb
-- lib/adf_builder/vendor/vendor.rb
+- lib/adf_builder/dsl.rb
+- lib/adf_builder/nodes/customer.rb
+- lib/adf_builder/nodes/node.rb
+- lib/adf_builder/nodes/prospect.rb
+- lib/adf_builder/nodes/provider.rb
+- lib/adf_builder/nodes/shared.rb
+- lib/adf_builder/nodes/vehicle.rb
+- lib/adf_builder/nodes/vehicle_nodes.rb
+- lib/adf_builder/nodes/vendor.rb
+- lib/adf_builder/serializer.rb
+- lib/adf_builder/validations.rb
 - lib/adf_builder/version.rb
 homepage: https://github.com/jippylong12/adf_builder
 licenses:

data/lib/adf_builder/base/base.rb

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

data/lib/adf_builder/base/prospect.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Prospect
-    STATUSES = {
-      new: :new,
-      resend: :resend
-    }.freeze
-
-    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)
-      @provider = Provider.new(@prospect)
-    end
-
-    attr_reader :request_date, :vehicles, :customer, :vendor, :provider
-
-    # 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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Customer
-    def initialize(prospect)
-      @customer = Ox::Element.new("customer")
-      @contact = nil
-      @timeframe = nil
-
-      prospect << @customer
-    end
-
-    attr_reader :contact, :timeframe
-
-    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
-
-    # @param descriptin [String] - Description of customer’s timing intention.
-    # @param earliest_date [DateTime] - Earliest date customer is interested in. If timeframe tag
-    # is present, it is required to specify earliestdate and/or
-    # latestdate
-    # @param latest_date [DateTime] - Latest date customer is interested in. If timeframe tag
-    # is present, it is required to specify earliestdate and/or
-    # latestdate
-    def add_timeframe(description, earliest_date = nil, latest_date = nil)
-      return false if earliest_date.nil? && latest_date.nil?
-
-      return false if earliest_date && (earliest_date.class != DateTime)
-
-      return false if latest_date && (latest_date.class != DateTime)
-
-      @timeframe = Timeframe.new(@customer, description, earliest_date, latest_date) if @timeframe.nil?
-    end
-
-    def update_comments(comments)
-      return false if comments.class != String
-
-      AdfBuilder::Builder.update_node(@customer, :comments, comments)
-    end
-  end
-end

data/lib/adf_builder/customer/timeframe.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Timeframe
-    def initialize(customer, description, earliest_date, latest_date)
-      begin
-        earliest_date = earliest_date.strftime("%FT%T%:z") if earliest_date
-        latest_date = latest_date.strftime("%FT%T%:z") if latest_date
-      rescue StandardError
-        return nil
-      end
-
-      @timeframe = Ox::Element.new("timeframe")
-
-      @timeframe << (Ox::Element.new("description") << description)
-      @timeframe << (Ox::Element.new("earliestdate") << earliest_date) if earliest_date
-      @timeframe << (Ox::Element.new("latestdate") << latest_date) if latest_date
-      customer << @timeframe
-    end
-
-    def update_description(description)
-      AdfBuilder::Builder.update_node(@timeframe, :description, description)
-    end
-
-    def update_earliest_date(date)
-      begin
-        date = date.strftime("%FT%T%:z")
-      rescue StandardError
-        return false
-      end
-      AdfBuilder::Builder.update_node(@timeframe, :earliestdate, date)
-    end
-
-    def update_latest_date(date)
-      begin
-        date = date.strftime("%FT%T%:z")
-      rescue StandardError
-        return false
-      end
-
-      AdfBuilder::Builder.update_node(@timeframe, :latestdate, date)
-    end
-  end
-end

data/lib/adf_builder/provider/provider.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Provider
-    FREE_TEXT_OPTIONAL_TAGS = %i[service url].freeze
-
-    def initialize(prospect)
-      @prospect = prospect
-      @provider = nil
-      @contact = nil
-    end
-
-    attr_reader :contact
-
-    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|
-        AdfBuilder::Builder.update_node(@provider, key, value) if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-      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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Contact
-    VALID_PARAMETERS = {
-      name: %i[part type primarycontact],
-      email: [:preferredcontact],
-      phone: %i[type time preferredcontact]
-    }.freeze
-
-    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]
-      }
-    }.freeze
-
-    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
-    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_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/shared/id.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-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
-
-      id_node[:source] = source if source
-
-      parent_node.prepend_child(id_node)
-    end
-  end
-end

data/lib/adf_builder/vehicles/colorcombinations.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class ColorCombinations
-    FREE_TEXT_OPTIONAL_TAGS = %i[interiorcolor exteriorcolor preference].freeze
-
-    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)
-      return unless valid
-
-      tags.each do |key, value|
-        AdfBuilder::Builder.update_node(vehicle, key, value) if FREE_TEXT_OPTIONAL_TAGS.include? key.to_sym
-      end
-    end
-  end
-end

data/lib/adf_builder/vehicles/price.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module AdfBuilder
-  class Price
-    VALID_PARAMETERS = {
-      price: %i[type currency delta relativeto source]
-    }.freeze
-
-    VALID_VALUES = {
-      price: {
-        type: %w[quote offer msrp invoice call appraisal asking],
-        currency: true,
-        delta: %w[absolute relative percentage],
-        relativeto: %w[msrp invoice],
-        source: true
-      }
-    }.freeze
-
-    def initialize(parent_node, value, params = {})
-      @parent_node = parent_node
-      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
-      validate_currency(params)
-      AdfBuilder::Builder.update_node(@parent_node, :price, value, params)
-      @price = @parent_node.price
-    end
-
-    def update(value, params = {})
-      params.merge!({ valid_values: VALID_VALUES, valid_parameters: VALID_PARAMETERS })
-      AdfBuilder::Builder.update_node(@parent_node, :price, value, params)
-    end
-
-    def validate_currency(params)
-      code = params[:currency]
-      return unless code
-
-      json = JSON.parse(File.read("./lib/adf_builder/data/iso-4217-currency-codes.json"))
-      codes = json.map { |j| j["Alphabetic_Code"] }.reject(&:nil?)
-      return if codes.include? code
-
-      params.delete(:currency)
-    end
-  end
-end