vng 0.1.20 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b49dda09b2542875760b7b2cdd3c4ab50d548458400e7dda9586edafd5c18b2
-  data.tar.gz: 0e86208199aebd2f79914bfd5e6c5ec330682bcebbe4d154bd808bb3bb4a64f7
+  metadata.gz: 1356553075599aa2888d10740b02d282d6f6407c69bf49f67e0dbdc46475cebc
+  data.tar.gz: a8d09b9454c4fe51de636f61a880614eca6d12e9fc8455e5fc3888f324eaab9c
 SHA512:
-  metadata.gz: 751d1a4eb1774f508106113b6cdc21988b6515ae8d965be322b205670b716214668ae72c67828e2a05fcb127a6c525fa741704c72244e8d9c52ad5e33fc55e43
-  data.tar.gz: 552dcc79f28b148d54559849f04052b5348e552c7fbecc2dbba81dc46a07744db9b83b90b4ff740e48893b1aedede0e3db31d05fcccb043bf6620a3c8af276ee
+  metadata.gz: 273b479db2901d89fbdd880383cdcf212aaffcfd1637ca973464567b33b98eafeb2036a6e7e46357d6e7aadc87d70876733bc7094c7c727a0e04118f0b8772fe
+  data.tar.gz: '088ea1b5e63a121b23f956b533d34b3adcf5a570851d999e583197134ae5af69b8345e9ff4946d15183723e031c87015dae8b112e1bf30edc2a2d683b3ca8ee1'

data/.rubocop.yml

@@ -0,0 +1,17 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+AllCops:
+  TargetRubyVersion: 3.2.2
+
+Style/StringLiterals:
+  Enabled: false
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [1.1] - 2024-11-20
+
+- Support optional ActiveSupport::Notifications
+
+## [1.0.0] - 2024-11-20
+
+- First major release
+- Includes all the methods added so far
+- 100% code coverage and Rubocop-happy
+
 ## [0.1.20] - 2024-11-20
 
 - Adds Franchise.find

data/README.md

@@ -38,7 +38,7 @@ To install on your system, run
 
 To use inside a bundled Ruby project, add this line to the Gemfile:
 
-    gem 'vng', '~> 0.1.13'
+    gem 'vng', '~> 1.0'
 
 Since the gem follows [Semantic Versioning](http://semver.org),
 indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)

data/lib/vng/asset.rb

@@ -16,10 +16,10 @@ module Vng
         method: '3',
         clientID: client_id,
         Fields: [
-           {fieldID: 1013, fieldValue: name},
-           {fieldID: 1017, fieldValue: weight},
-           {fieldID: 1014, optionID: breed_option_id},
-        ]
+          { fieldID: 1013, fieldValue: name },
+          { fieldID: 1017, fieldValue: weight },
+          { fieldID: 1014, optionID: breed_option_id },
+        ],
       }
 
       data = request path: PATH, body: body
@@ -45,4 +45,3 @@ module Vng
     end
   end
 end
-

data/lib/vng/breed.rb

@@ -16,7 +16,6 @@ module Vng
       @high_weight = high_weight
     end
 
-    # TODO: Needs pagination
     def self.all
       data = request path: PATH
 

data/lib/vng/case.rb

@@ -16,14 +16,14 @@ module Vng
         method: '3',
         clientID: client_id,
         Fields: [
-           {fieldID: 219, optionID: 239}, # Status: open
-           {fieldID: 220, fieldValue: summary}, # Summary:
-           {fieldID: 230, fieldValue: comments}, # Comments:
-           {fieldID: 226, optionID: 227}, # Type: 'General request'
-           {fieldID: 227, optionID: 232}, # Preferred Contact Method: 'Phone'
-           {fieldID: 228, fieldValue: phone}, # Phone Me Back at:
-           {fieldID: 229, fieldValue: email}, # Email:
-           {fieldID: 1023, fieldValue: zip}, # Zip Code:
+           { fieldID: 219, optionID: 239 }, # Status: open
+           { fieldID: 220, fieldValue: summary }, # Summary:
+           { fieldID: 230, fieldValue: comments }, # Comments:
+           { fieldID: 226, optionID: 227 }, # Type: 'General request'
+           { fieldID: 227, optionID: 232 }, # Preferred Contact Method: 'Phone'
+           { fieldID: 228, fieldValue: phone }, # Phone Me Back at:
+           { fieldID: 229, fieldValue: email }, # Email:
+           { fieldID: 1023, fieldValue: zip }, # Zip Code:
         ]
       }
 
@@ -42,4 +42,3 @@ module Vng
     end
   end
 end
-

data/lib/vng/config.rb

@@ -42,4 +42,4 @@ module Vng
   # @note Config is the only module auto-loaded in the Vng module,
   #       in order to have a syntax as easy as Vng.configure
   extend Config
-end
+end

data/lib/vng/configuration.rb

@@ -52,4 +52,4 @@ module Vng
       @mock = ENV['VNG_MOCK'] == '1'
     end
   end
-end
+end

data/lib/vng/contact.rb

@@ -20,23 +20,22 @@ module Vng
         method: '3',
         clientID: client_id,
         Fields: [
-           {fieldID: 127, fieldValue: first_name},
-           {fieldID: 128, fieldValue: last_name},
-           {fieldID: 97, fieldValue: URI.encode_uri_component(email)},
-           {fieldID: 96, fieldValue: phone},
+           { fieldID: 127, fieldValue: first_name },
+           { fieldID: 128, fieldValue: last_name },
+           { fieldID: 97, fieldValue: URI.encode_uri_component(email) },
+           { fieldID: 96, fieldValue: phone },
         ]
       }
 
       data = request path: PATH, body: body
 
       id = data['Contact']['objectID']
-      first_name = data['Fields'].find{|field| field['fieldID'] == 127}['fieldValue']
-      last_name = data['Fields'].find{|field| field['fieldID'] == 128}['fieldValue']
-      email = data['Fields'].find{|field| field['fieldID'] == 97}['fieldValue']
-      phone = data['Fields'].find{|field| field['fieldID'] == 96}['fieldValue']
+      first_name = value_for_field data, 127
+      last_name = value_for_field data, 128
+      email = value_for_field data, 97
+      phone = value_for_field data, 96
 
       new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone
     end
   end
 end
-

data/lib/vng/franchise.rb

@@ -34,9 +34,7 @@ module Vng
       }
 
       data = request path: PATH, body: body
-
-      email_field = data['Fields'].find{|field| field['fieldID'] == 9}
-      email = email_field['fieldValue'] if email_field
+      email = value_for_field data, 9
       new id: franchise_id, email: email
     end
 

data/lib/vng/lead.rb

@@ -18,19 +18,19 @@ module Vng
       body = {
         method: '3',
         Fields: [
-           {fieldID: 121, optionID: '59'},
-           {fieldID: 126, fieldValue: name},
-           {fieldID: 238, fieldValue: URI.encode_uri_component(email)},
-           {fieldID: 1024, fieldValue: phone},
+           { fieldID: 121, optionID: '59' },
+           { fieldID: 126, fieldValue: name },
+           { fieldID: 238, fieldValue: URI.encode_uri_component(email) },
+           { fieldID: 1024, fieldValue: phone },
         ]
       }
 
       data = request path: PATH, body: body
 
       id = data['Client']['objectID']
-      name = data['Fields'].find{|field| field['fieldID'] == 126}['fieldValue']
-      email = data['Fields'].find{|field| field['fieldID'] == 238}['fieldValue']
-      phone = data['Fields'].find{|field| field['fieldID'] == 1024}['fieldValue']
+      name = value_for_field data, 127
+      email = value_for_field data, 238
+      phone = value_for_field data, 1024
 
       new id: id, name: name, email: email, phone: phone
     end

data/lib/vng/location.rb

@@ -5,7 +5,7 @@ module Vng
   class Location < Resource
     PATH = '/api/v1/data/Locations/'
 
-    # TODO: fetch from /system/objects/ method: 1, objectID: 20
+    # These could be fetched from /system/objects/ method: 1, objectID: 20
     STATES_OPTION_ID = {
       AK: 9879, AL: 9878, AR: 9877, AZ: 9880, CA: 9883, CO: 9876, CT: 9875,
       DC: 9874, DE: 9873, FL: 9872, GA: 9871, HI: 9870, IA: 9869, ID: 9868,
@@ -28,11 +28,11 @@ module Vng
         method: '3',
         clientID: client_id,
         Fields: [
-           {fieldID: 779, optionID: 9906}, # 'USA'
-           {fieldID: 778, optionID: STATES_OPTION_ID[state.to_sym]},
-           {fieldID: 776, fieldValue: city},
-           {fieldID: 773, fieldValue: address},
-           {fieldID: 775, fieldValue: zip},
+           { fieldID: 779, optionID: 9906 }, # 'USA'
+           { fieldID: 778, optionID: STATES_OPTION_ID[state.to_sym] },
+           { fieldID: 776, fieldValue: city },
+           { fieldID: 773, fieldValue: address },
+           { fieldID: 775, fieldValue: zip },
         ]
       }
 
@@ -42,4 +42,3 @@ module Vng
     end
   end
 end
-

data/lib/vng/mock_resource.rb

@@ -7,7 +7,7 @@ module Vng
   private
     def self.request(path:, body: {}, query: {}, include_security_token: true)
       if Vng.configuration.mock
-        mock_request path:, body:, query:
+        mock_request(path:, body:, query:)
       else
         http_request(path:, body:, query:, include_security_token:)
       end
@@ -16,57 +16,57 @@ module Vng
     def self.mock_request(path:, body:, query:)
       case path
       when '/api/v1/security/login/'
-        {"securityToken"=>"1234567"}
+        { "securityToken"=>"1234567" }
       when '/api/v1/resources/zips/'
-        {"Zips"=>[{"zip"=>"21765", "zoneName"=>"Brentwood", "state"=>"MD"}]}
+        { "Zips"=>[{ "zip"=>"21765", "zoneName"=>"Brentwood", "state"=>"MD" }] }
       when '/api/v1/resources/franchises/'
-        {"Franchises"=>[
-          {"franchiseID"=>106, "franchiseName"=>"Mississauga", "gmtOffsetFranchise"=>-300, "isActive"=>false},
-          {"franchiseID"=>107, "franchiseName"=>"Boise", "gmtOffsetFranchise"=>-420, "isActive"=>true},
-        ]}
+        { "Franchises"=>[
+          { "franchiseID"=>106, "franchiseName"=>"Mississauga", "gmtOffsetFranchise"=>-300, "isActive"=>false },
+          { "franchiseID"=>107, "franchiseName"=>"Boise", "gmtOffsetFranchise"=>-420, "isActive"=>true },
+        ] }
       when '/api/v1/resources/availability/'
         if body.key?(:zip)
-          {"Ids"=>{"franchiseID"=>"172"}}
+          { "Ids"=>{ "franchiseID"=>"172" } }
         elsif body[:method] == '2'
-          {"Ids"=>{"lockID"=>"1406328"}}
+          { "Ids"=>{ "lockID"=>"1406328" } }
         else
-          {"Availability"=> [
-            {"dayID"=>"20241119", "routeID"=>"8949", "startTime"=>"1080"},
-            {"dayID"=>"20241119", "routeID"=>"8949", "startTime"=>"1110"},
-          ]}
+          { "Availability"=> [
+            { "dayID"=>"20241119", "routeID"=>"8949", "startTime"=>"1080" },
+            { "dayID"=>"20241119", "routeID"=>"8949", "startTime"=>"1110" },
+          ] }
         end
       when '/api/v1/resources/breeds/'
-        {"Breeds"=>[{"breedID"=>2, "breed"=>"Bulldog", "species"=>"Dog", "optionID"=>303, "breedLowWeight"=>30, "breedHighWeight"=>50}]}
+        { "Breeds"=>[{ "breedID"=>2, "breed"=>"Bulldog", "species"=>"Dog", "optionID"=>303, "breedLowWeight"=>30, "breedHighWeight"=>50 }] }
       when '/api/v1/data/Leads/'
-        {"Client"=>{"objectID"=>"916347"}, "Fields"=>[
-          {"fieldID"=>126, "fieldValue"=>"Vng Example"},
-          {"fieldID"=>238, "fieldValue"=>"vng@example.com"},
-          {"fieldID"=>1024, "fieldValue"=>"8648648640"},
-        ]}
+        { "Client"=>{ "objectID"=>"916347" }, "Fields"=> [
+          { "fieldID"=>126, "fieldValue"=>"Vng Example" },
+          { "fieldID"=>238, "fieldValue"=>"vng@example.com" },
+          { "fieldID"=>1024, "fieldValue"=>"8648648640" },
+        ] }
       when '/api/v1/data/Contacts/'
-        {"Contact"=>{"objectID"=>"2201007"}, "Fields"=>[
-          {"fieldID"=>127, "fieldValue"=>"Vng"},
-          {"fieldID"=>128, "fieldValue"=>"Example"},
-          {"fieldID"=>97, "fieldValue"=>"vng@example.com"},
-          {"fieldID"=>96, "fieldValue"=>"8648648640"},
-        ]}
+        { "Contact"=>{ "objectID"=>"2201007" }, "Fields"=>[
+          { "fieldID"=>127, "fieldValue"=>"Vng" },
+          { "fieldID"=>128, "fieldValue"=>"Example" },
+          { "fieldID"=>97, "fieldValue"=>"vng@example.com" },
+          { "fieldID"=>96, "fieldValue"=>"8648648640" },
+        ] }
       when '/api/v1/data/Locations/'
-        {"Location"=>{"objectID"=>"995681"}}
+        { "Location"=>{ "objectID"=>"995681" } }
       when '/api/v1/data/Assets/'
-        {"Asset"=>{"objectID"=>"2201008"}}
+        { "Asset"=>{ "objectID"=>"2201008" } }
       when '/api/v1/data/priceLists/'
-        {"PriceItems"=>[
-          {"priceItemID"=>275111, "priceItem"=>"15 Step SPA Grooming", "value"=>85.0, "taxID"=>256, "durationPerUnit"=>45.0, "serviceBadge"=>"Required", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true},
-          {"priceItemID"=>275300, "priceItem"=>"De-Shedding Treatment", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>false},
-        ]}
+        { "PriceItems"=>[
+          { "priceItemID"=>275111, "priceItem"=>"15 Step SPA Grooming", "value"=>85.0, "taxID"=>256, "durationPerUnit"=>45.0, "serviceBadge"=>"Required", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+          { "priceItemID"=>275300, "priceItem"=>"De-Shedding Treatment", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>false },
+        ] }
       when '/api/v1/resources/serviceTypes/'
-        {"ServiceTypes"=>[
-          {"serviceTypeID"=>14, "serviceType"=>"Pet Grooming", "duration"=>90, "isActive"=>true},
-        ]}
+        { "ServiceTypes"=>[
+          { "serviceTypeID"=>14, "serviceType"=>"Pet Grooming", "duration"=>90, "isActive"=>true },
+        ] }
       when '/api/v1/data/WorkOrders/'
-        {"WorkOrder"=>{"objectID"=>"4138030"}}
+        { "WorkOrder"=>{ "objectID"=>"4138030" } }
       when '/api/v1/data/Cases/'
-        {"Case"=>{"objectID"=>"28460"}}
+        { "Case"=>{ "objectID"=>"28460" } }
       else
         {}
       end

data/lib/vng/resource.rb

@@ -18,8 +18,10 @@ module Vng
         request.body = body.to_json
       end
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
+      response = instrument do |data|
+        data[:response] = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          http.request request
+        end
       end
 
       JSON(response.body).tap do |data|
@@ -36,5 +38,19 @@ module Vng
     def self.security_token
       Vng.configuration.security_token
     end
+
+    def self.value_for_field(data, field_id)
+      field = data['Fields'].find { |field| field['fieldID'] == field_id }
+      field['fieldValue'] if field
+    end
+
+    def self.instrument(&block)
+      data = {class_name: name} # TODO: Add path, query, ...
+      if defined?(ActiveSupport::Notifications)
+        ActiveSupport::Notifications.instrument 'Vng.request', data, &block
+      else
+        block.call(data)
+      end
+    end
   end
 end

data/lib/vng/route.rb

@@ -12,7 +12,6 @@ module Vng
       @name = name
     end
 
-    # TODO: Needs pagination
     def self.all
       data = request path: PATH
 

data/lib/vng/security_token.rb

@@ -24,8 +24,6 @@ module Vng
       new token: data['securityToken']
     end
 
-    # TODO: Check if it's not the correct one already or catch
-    # Data validation failed. [{"fieldID"=>0, "fieldName"=>nil, "errNo"=>-5213, "errMsg"=>"Same franchise ID supplied."}]
     def assign_to(franchise_id:)
       body = {
         securityToken: @token,
@@ -35,7 +33,6 @@ module Vng
 
       self.class.request path: '/api/v1/security/session/', body: body, include_security_token: false
     rescue Vng::Error => e
-      # TODO: improve: ignore if the token was already assigned to the franchise
       raise unless e.message.include? 'Same franchise ID supplied'
     end
 
@@ -43,8 +40,6 @@ module Vng
       query = { securityToken: @token }
       self.class.request path: '/api/v1/security/logout/', query: query
     rescue Vng::Error => e
-      p "Vng:Error! #{e}"
-      # TODO: improve: ignore if the token was already destroyed
       raise unless e.message.include?('Session expired') || e.message.include?('Session does not exist')
     end
   end

data/lib/vng/service_type.rb

@@ -13,7 +13,6 @@ module Vng
       @duration = duration
     end
 
-    # TODO: Needs pagination
     def self.all
       data = request path: PATH
 

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '0.1.20'
+  VERSION = '1.1.0'
 end

data/lib/vng/work_order.rb

@@ -20,9 +20,9 @@ module Vng
         contactID: contact_id,
         locationID: location_id,
         Fields: [
-          {fieldID: 200, fieldValue: summary},
-          {fieldID: 186, fieldValue: duration.to_i},
-          {fieldID: 201, optionID: '9537'} # label: Online Tentative
+          { fieldID: 200, fieldValue: summary },
+          { fieldID: 186, fieldValue: duration.to_i },
+          { fieldID: 201, optionID: '9537' } # label: Online Tentative
         ],
         Charges: charges_for(line_items)
       }
@@ -47,13 +47,13 @@ module Vng
 
     def self.charge_fields_for(line_item)
       [
-        {fieldID: 9289, fieldValue: line_item[:description]},
-        {fieldID: 9287, fieldValue: line_item[:price]}, # Unit price
-        {fieldID: 8673, fieldValue: line_item[:price]}, # Price item
-        {fieldID: 813, fieldValue: line_item[:price]}, # Price
-        {fieldID: 9286, fieldValue: line_item[:price]}, # Subtotal
-        {fieldID: 9283, fieldValue: line_item[:price]}, # Total
-        {fieldID: 9288, fieldValue: 1}, # Qty
+        { fieldID: 9289, fieldValue: line_item[:description] },
+        { fieldID: 9287, fieldValue: line_item[:price] }, # Unit price
+        { fieldID: 8673, fieldValue: line_item[:price] }, # Price item
+        { fieldID: 813, fieldValue: line_item[:price] }, # Price
+        { fieldID: 9286, fieldValue: line_item[:price] }, # Subtotal
+        { fieldID: 9283, fieldValue: line_item[:price] }, # Total
+        { fieldID: 9288, fieldValue: 1 }, # Qty
       ]
     end
   end

data/lib/vng/zip.rb

@@ -13,7 +13,6 @@ module Vng
       @zone_name = zone_name
     end
 
-    # TODO: Needs pagination
     def self.all
       data = request path: PATH
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 1.1.0
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby client for the Vonigo API.
 email:
 - claudiob@users.noreply.github.com
@@ -32,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md