adf_builder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 273896ee8ce6282f9b8c8f2b1a5c2ff9dd50617d88cd98a9a165e7bf319f48d8
-  data.tar.gz: 87dda47e5a500c476fef3ecf67e6a8160a8cb061ef134830c1bda8613f6615bb
+  metadata.gz: 9a45dd0135682b562fe9fe49cacd5590a0da5c702894ae9f0b888d1d48c6536c
+  data.tar.gz: 479f5c42eb07d457a0196abe35192f719d77a953bf6045739a3944157ff41434
 SHA512:
-  metadata.gz: 2e3ea523f1c88100648a915b23fd3f83d728ce504ba4f51b720041627f1d85235675123c9579a91867729ee00a216d346a2540d0817e0050f889fafaf5f12af8
-  data.tar.gz: ef93592778d5e317ea816e330c5b86d054222481e0821ce1976f1afe7a19c5ab76b8f2fd3f9f7b21e23b8ecdbb856f3d0923f295bdf850ed6221018d546a0928
+  metadata.gz: 1d43d0eb120efacce6e7e52e610a51435f7d9dbc2f0cd366dbeae29f57eb1446ff220e70ce600dd8adeb9b33a0609d897a34ba4efa519af631777d9413563c6d
+  data.tar.gz: 63e65e9fa0fe65d6a285bdf52d246ab4f075fefd297fe9fda70d6784358a502ec2924f5dce41f5e5209cbc09835898e646784b9976aa7b237880559bfa297a96

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 ## [Unreleased]
+- Add Vehicle structure
+- Add Vendor structure
+- Add Customer structure
+- Add Provider structure
+- Add Contact structure
+- Add Price structure
+
+## [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/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 an update an ADF XML file that can easily be added to an email or saved to a file.
 
 ## Installation
 
@@ -22,7 +19,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.base.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.base.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>
+
+
 
 ## Development
 

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,7 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "adf_builder/version"
-require_relative 'adf_builder/lead'
+require_relative 'adf_builder/base'
+require_relative 'adf_builder/base/prospect'
+require_relative 'adf_builder/base/request_date'
+require_relative 'adf_builder/id'
+
 
 require 'ox'
 
@@ -10,15 +14,20 @@ module AdfBuilder
   class Builder
     def initialize
       @doc = self.init_doc
-      @lead = Lead.new(@doc)
+      @base = Base.new(@doc)
+    end
+
+    def base
+      @base
     end
 
-    def lead
-      @lead
+    # 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,6 +78,8 @@ module AdfBuilder
     end
 
 
+
+
     private
 
 
@@ -82,6 +93,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.rb

@@ -0,0 +1,15 @@
+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,29 @@
+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)
+    end
+
+    def request_date
+      @request_date
+    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,21 @@
+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
+      @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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdfBuilder
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 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.2
 platform: ruby
 authors:
 - marcus.salinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-04 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,10 @@ files:
 - bin/console
 - bin/setup
 - lib/adf_builder.rb
-- lib/adf_builder/lead.rb
+- lib/adf_builder/base.rb
+- lib/adf_builder/base/prospect.rb
+- lib/adf_builder/base/request_date.rb
+- lib/adf_builder/id.rb
 - lib/adf_builder/version.rb
 homepage: https://github.com/jippylong12/adf_builder
 licenses:
@@ -72,5 +75,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