vng 3.2.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b010ddfb951a8a49807d40e1eae41355cfac53f9eb4774143e3b86ffbc4b892b
-  data.tar.gz: c495b73abd2a24b93f7fe0556a1ede1a48adeb9e08b19809099d9c95134c9fb6
+  metadata.gz: 7c12edbb4518fc769872a46bb3060e6e88d8850c18e0c0eec6b9aea157bfcaa8
+  data.tar.gz: 1bb1e134d2bf6b1ab736fd9c342f594fd826b1de7b116f114113f383fc33d157
 SHA512:
-  metadata.gz: 50527cbbbbb3e550b54052dd9ff42e511d24fcf6904687ad46b1a7f931882a4064fed2db14243ca4f8d5c890147f806c7f2a7dbb33ff0708848b7e09448bc79b
-  data.tar.gz: 7611cfffca87c56f59a39e526386ebd1c224d65c6d8be53d86518f0f5dc2a616c3d80e6d4242032939a5bc6380dd259bb95a133fec775bb67f3288b4d51ff328
+  metadata.gz: 61b780b5a55aa0c4cc87ee51ca4c9c9b1d850e4fb68bfae22939d95d4c5aef7315a79775c1be3ce37121ffbaff4400166693ec433eedd7a4ef6346d14766d120
+  data.tar.gz: 6f87f2b80d1d52c9aa7711556bc1ae211f2b330b2e612cff7d2f450b803dc21838c1880cbc255609f94ecf4bed1f63df8f783d5a0c5f18ab56be43fc8f1707ea

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.3.1] - 2025-01-22
+
+- Add Route#type_id
+
+## [3.3.0] - 2025-01-15
+
+- Add SystemObject.find_by(name:)
+
 ## [3.2.0] - 2025-01-15
 
 - Add Lead#notes

data/README.md

@@ -19,6 +19,8 @@ Vng::ServiceType.where zip:
 Vng::SecurityToken.create host:, usename:, password:
 Vng::Lead.create email:, phone:, name: full_name
 Vng::Contact.create first_name:, last_name:, email:, phone:, client_id:
+Vng::Contact.edited_since timestamp
+Vng::Client.find contact_id
 Vng::Location.create address:, city:, zip:, state: state, client_id:
 Vng::Breed.all
 Vng::Asset.create name:, weight:, breed_option_id:, client_id:

data/lib/vng/lead.rb

@@ -15,7 +15,7 @@ module Vng
       @notes = notes
     end
 
-    def self.create(name:, email:, phone:, notes: nil)
+    def self.create(name:, email:, phone:, notes: nil, campaign_option_id: nil)
       body = {
         method: '3',
         Fields: [
@@ -27,6 +27,7 @@ module Vng
       }
 
       body[:Fields] << { fieldID: 108, fieldValue: notes } if notes
+      body[:Fields] << { fieldID: 795, optionID: campaign_option_id } if campaign_option_id
 
       data = request path: PATH, body: body
 

data/lib/vng/mock_request.rb

@@ -47,6 +47,21 @@ module Vng
           @@logged_out = true
           {}
         end
+      when '/api/v1/system/objects/'
+        if @body[:method] == '1'
+          { "Fields" => [
+            { "fieldID" => 795, "field" => "Marketing Campaign" },
+            { "fieldID" => 830, "field" => "Primary Contact" },
+          ], "Options" => [
+            {"optionID" => 15840, "name" => "Referral", "fieldID" => 795, "objectTypeID" => 28, "isActive" => false},
+            {"optionID" => 15841, "name" => "Website", "fieldID" => 795, "objectTypeID" => 28, "isActive" => true},
+          ] }
+        else
+          { "Objects"=>[
+            { "objectTypeID" => 15, "name" => "User" },
+            { "objectTypeID" => 28, "name" => "Lead" },
+          ] }
+        end
       when '/api/v1/resources/zips/'
         if @body[:method] == '1'
           # TODO: The response already includes the ServiceTypes so there
@@ -246,9 +261,9 @@ module Vng
         end
       when '/api/v1/resources/Routes/'
         {"Routes" => [
-          {"routeID" => AVAILABLE_ROUTE_ID, "routeName" => "Route 1", "isActive" => true},
-          {"routeID" => 2, "routeName" => "Route 2", "isActive" => true},
-          {"routeID" => 3, "routeName" => "Route 3 (Inactive)", "isActive" => false},
+          {"routeID" => AVAILABLE_ROUTE_ID, "routeName" => "Route 1", "isActive" => true, "routeTypeID" => 106},
+          {"routeID" => 2, "routeName" => "Route 2", "isActive" => true, "routeTypeID" => 107},
+          {"routeID" => 3, "routeName" => "Route 3 (Inactive)", "isActive" => false, "routeTypeID" => 1},
         ]}
       when '/api/v1/data/WorkOrders/'
         if @body[:pageNo].eql? 1

data/lib/vng/route.rb

@@ -5,11 +5,12 @@ module Vng
   class Route < Resource
     PATH = '/api/v1/resources/Routes/'
 
-    attr_reader :id, :name
+    attr_reader :id, :name, :type_id
 
-    def initialize(id:, name:)
+    def initialize(id:, name:, type_id:)
       @id = id
       @name = name
+      @type_id = type_id
     end
 
     def self.all
@@ -20,8 +21,9 @@ module Vng
       end.map do |body|
         id = body['routeID']
         name = body['routeName']
+        type_id = body['routeTypeID']
 
-        new id: id, name: name
+        new id: id, name: name, type_id: type_id
       end
     end
   end

data/lib/vng/system_field.rb

@@ -0,0 +1,26 @@
+require 'vng/system_option'
+
+module Vng
+  # Provides methods to interact with Vonigo system fields.
+  class SystemField < Resource
+    PATH = '/api/v1/system/objects/'
+
+    attr_reader :id, :name, :options
+
+    def initialize(id:, name:, options:)
+      @id = id
+      @name = name
+      @options = options
+    end
+
+    def self.for_system_object_id(system_object_id)
+      body = { objectID: system_object_id, method: '1' }
+      data = request path: PATH, body: body
+
+      data['Fields'].lazy.map do |field|
+        options = SystemOption.for_system_field_id field['fieldID'], data['Options']
+        new id: field['fieldID'], name: field['field'], options: options
+      end # TODO: make this thing respond to find_by(name:)
+    end
+  end
+end

data/lib/vng/system_object.rb

@@ -0,0 +1,26 @@
+require 'vng/system_field'
+
+module Vng
+  # Provides methods to interact with Vonigo system objects.
+  class SystemObject < Resource
+    PATH = '/api/v1/system/objects/'
+
+    attr_reader :id, :name, :fields
+
+    def initialize(id:, name:, fields:)
+      @id = id
+      @name = name
+      @fields = fields
+    end
+
+    def self.find_by(name:)
+      data = request path: PATH
+      object = data['Objects'].find{|object| object['name'].eql? name}
+
+      if object
+        fields = SystemField.for_system_object_id object['objectTypeID']
+        new id: object['objectTypeID'], name: name, fields: fields
+      end
+    end
+  end
+end

data/lib/vng/system_option.rb

@@ -0,0 +1,21 @@
+module Vng
+  # Provides methods to interact with Vonigo system fields’ options.
+  class SystemOption
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    def self.for_system_field_id(system_field_id, options = {})
+      options.lazy.filter_map do |option|
+        next unless option['isActive']
+
+        if option['fieldID'].eql? system_field_id
+          new id: option['optionID'], name: option['name']
+        end
+      end # TODO: make this thing respond to find_by(name:)
+    end
+  end
+end

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '3.2.0'
+  VERSION = '3.3.1'
 end

data/lib/vng.rb

@@ -21,6 +21,7 @@ require_relative 'vng/price_item'
 require_relative 'vng/route'
 require_relative 'vng/security_token'
 require_relative 'vng/service_type'
+require_relative 'vng/system_object'
 require_relative 'vng/version'
 require_relative 'vng/work_order'
 require_relative 'vng/zip'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.1
 platform: ruby
 authors:
 - claudiob
 bindir: exe
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -89,6 +89,9 @@ files:
 - lib/vng/route.rb
 - lib/vng/security_token.rb
 - lib/vng/service_type.rb
+- lib/vng/system_field.rb
+- lib/vng/system_object.rb
+- lib/vng/system_option.rb
 - lib/vng/version.rb
 - lib/vng/work_order.rb
 - lib/vng/zip.rb