vng 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cff4f73336138d9e2386b1273fd4e398c8d3e8e9c52fb60ba4f47fb7b98e3bf
-  data.tar.gz: 6dbfa0fdad71e5fe35b113071e451a27e0150cde5ccffc7bc0676f191d433486
+  metadata.gz: de1ec03096db648933db7f9886eaa72b6c4af73e614e475bc0ad26126f35015e
+  data.tar.gz: 0adb9f129d030b78ec726f6a2a1cedd61ebc37c88a88df524aca23ff4d2583ca
 SHA512:
-  metadata.gz: d76586e4271dc06bfe12ab3784f9534373f82e1953084c012ca79522ffbad4744486f55f66076b735bcafe7bddddc1465ef624f2af001aa0c183106a4403f0c4
-  data.tar.gz: 5bb9df92265cf90e2e10a88efc2e5cbd4de6d0b4e80e38dc2faf597780ea9b759e951fe331ae453db38253df4c93a58bd04d8a6c299318f475a5c04f6b5d08c1
+  metadata.gz: ce83ddaea6c34121333fdaf15b5600b2486e51c2803b82a71826ca464b7c18f79f1c5d39e0837a0483ecda73512abae325fda7aea0b6ec7b4f8fac3ebcc201c4
+  data.tar.gz: 7efd6a2bc16eae79b5ecde44d85ec4ce4de4366a9c735bebc99350d1c743ccc4a6320d47a834e84a92205524761222d07e43a02b06878ff413ca5ff8219e7962

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.14] - 2024-11-17
+
+- Adds Vng::Error
+
 ## [0.1.13] - 2024-11-15
 
 - Enable Vng.configuration.security_token

data/README.md

@@ -5,8 +5,11 @@ Vng helps you write apps that need to interact with Vonigo.
 
 The **source code** is available on [GitHub](https://github.com/HouseAccountEng/vng) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/vng/frames).
 
+[![Code Climate](https://codeclimate.com/github/HouseAccountEng/vng.png)](https://codeclimate.com/github/HouseAccountEng/vng)
+
 After [registering your app](#configuring-your-app), you can run commands like:
 
+
 ```ruby
 Vng::Zip.all
 Vng::Franchise.all
@@ -42,15 +45,6 @@ indicating the full version in your Gemfile (~> *major*.*minor*.*patch*)
 guarantees that your project won’t occur in any error when you `bundle update`
 and a new version of Vng is released.
 
-Available resources
-===================
-
-Vng::Zip
--------
-
-TODO
-
-
 Configuring your app
 ====================
 
@@ -95,8 +89,8 @@ How to release new versions
 
 If you are a manager of this project, remember to upgrade the [Vng gem](http://rubygems.org/gems/vng)
 whenever a new feature is added or a bug gets fixed.
-Make sure all the tests are passing ,
-document the changes in CHANGELOG.md and README.md, bump the version, then run
+Make sure all the tests are passing and the code is 100% test-covered.
+Document the changes in CHANGELOG.md and README.md, bump the version, then run:
 
     rake release
 

data/lib/vng/asset.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo assets.
-  class Asset
+  class Asset < Resource
+    PATH = '/api/v1/data/Assets/'
+
     attr_reader :id
 
     def initialize(id:)
@@ -9,7 +13,6 @@ module Vng
 
     def self.create(name:, weight:, breed_option_id:, client_id:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
         clientID: client_id,
         Fields: [
@@ -19,15 +22,7 @@ module Vng
         ]
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Assets/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH, body: body
 
       # curl = 'curl'.tap do |curl|
       #   curl <<  ' -X POST'
@@ -37,25 +32,16 @@ module Vng
       # end
       # puts curl
 
-      new id: JSON(response.body)['Asset']['objectID']
+      new id: data['Asset']['objectID']
     end
 
     def destroy
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '4',
         objectID: id,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Assets/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = self.class.request path: PATH, body: body
     end
   end
 end

data/lib/vng/availability.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo availabilities.
-  class Availability
+  class Availability < Resource
+    PATH = '/api/v1/resources/availability/'
+
     attr_reader :route_id, :date, :minutes
 
     def initialize(route_id:, date:, minutes:)
@@ -11,29 +15,20 @@ module Vng
 
     def self.where(location_id:, duration:, from_time:, to_time:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '0',
         serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
         locationID: location_id,
-        duration: duration.to_i,
+        duration: [duration.to_i, 30].max, # or 'duration is not provided'
         dateStart: from_time.to_i,
         dateEnd: to_time.to_i,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/availability/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH, body: body
 
-      JSON(response.body)['Availability'].map do |body|
-        route_id = body['routeID']
-        date = Date.strptime body['dayID'], '%Y%m%d'
-        minutes = body['startTime'].to_i
+      data['Availability'].map do |availability|
+        route_id = availability['routeID']
+        date = Date.strptime availability['dayID'], '%Y%m%d'
+        minutes = availability['startTime'].to_i
 
         new route_id: route_id, date: date, minutes: minutes
       end

data/lib/vng/breed.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo breeds.
-  class Breed
+  class Breed < Resource
+    PATH = '/api/v1/resources/breeds/'
+
     attr_reader :id, :name, :species, :option_id, :low_weight, :high_weight
 
     def initialize(id:, name:, species:, option_id:, low_weight:, high_weight:)
@@ -14,27 +18,15 @@ module Vng
 
     # TODO: Needs pagination
     def self.all
-      body = {
-        securityToken: Vng.configuration.security_token,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/breeds/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH
 
-      JSON(response.body)['Breeds'].map do |body|
-        id = body['breedID']
-        name = body['breed']
-        species = body['species']
-        option_id = body['optionID']
-        low_weight = body['breedLowWeight']
-        high_weight = body['breedHighWeight']
+      data['Breeds'].map do |breed|
+        id = breed['breedID']
+        name = breed['breed']
+        species = breed['species']
+        option_id = breed['optionID']
+        low_weight = breed['breedLowWeight']
+        high_weight = breed['breedHighWeight']
 
         new id: id, name: name, species: species, option_id: option_id, low_weight: low_weight, high_weight: high_weight
       end

data/lib/vng/case.rb

@@ -1,53 +1,44 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo cases.
-  class Case
+  class Case < Resource
+    PATH = '/api/v1/data/Cases/'
+
     attr_reader :id
 
     def initialize(id:)
       @id = id
     end
 
-    def self.create(client_id:, summary:, comments:)
+    def self.create(client_id:, summary:, comments:, phone:, email:, zip:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
-        objectID: client_id,
+        clientID: client_id,
         Fields: [
            {fieldID: 219, optionID: 239}, # Status: open
-           {fieldID: 220, fieldValue: summary},
-           {fieldID: 230, fieldValue: comments},
+           {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:
         ]
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Cases/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: PATH, body: body
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      new id: JSON(response.body)['Case']['objectID']
+      new id: data['Case']['objectID']
     end
 
     def destroy
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '4',
         objectID: id,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Cases/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      self.class.request path: PATH, body: body
     end
   end
 end

data/lib/vng/connection_error.rb

@@ -0,0 +1,5 @@
+module Vng
+  # A wrapper around StandardError.
+  class ConnectionError < StandardError
+  end
+end

data/lib/vng/contact.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo contacts.
-  class Contact
+  class Contact < Resource
+    PATH = '/api/v1/data/Contacts/'
+
     attr_reader :id, :first_name, :last_name, :email, :phone
 
     def initialize(id:, first_name:, last_name:, email:, phone:)
@@ -13,7 +17,6 @@ module Vng
 
     def self.create(first_name:, last_name:, email:, phone:, client_id:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
         clientID: client_id,
         Fields: [
@@ -24,44 +27,26 @@ module Vng
         ]
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Contacts/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: PATH, body: body
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      body = JSON response.body
-
-      id = body['Contact']['objectID']
-      first_name = body['Fields'].find{|field| field['fieldID'] == 127}['fieldValue']
-      last_name = body['Fields'].find{|field| field['fieldID'] == 128}['fieldValue']
-      email = body['Fields'].find{|field| field['fieldID'] == 97}['fieldValue']
-      phone = body['Fields'].find{|field| field['fieldID'] == 96}['fieldValue']
+      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']
 
       new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone
     end
 
-    def destroy
-      body = {
-        securityToken: Vng.configuration.security_token,
-        method: '4',
-        objectID: id,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Contacts/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-    end
+    # Data validation failed. [{"fieldID"=>0, "fieldName"=>nil, "errNo"=>-1408, "errMsg"=>"Primary contact cannot be deleted."}]
+    # def destroy
+    #   body = {
+    #     method: '4',
+    #     objectID: id,
+    #   }
+    #
+    #   self.class.request path: PATH, body: body
+    # end
   end
 end
 

data/lib/vng/error.rb

@@ -0,0 +1,5 @@
+module Vng
+  # A wrapper around StandardError.
+  class Error < StandardError
+  end
+end

data/lib/vng/franchise.rb

@@ -1,6 +1,10 @@
+require 'vng/availability'
+
 module Vng
   # Provides methods to interact with Vonigo franchises.
-  class Franchise
+  class Franchise < Resource
+    PATH = '/api/v1/resources/franchises/'
+
     attr_reader :id, :name, :gmt_offset
 
     def initialize(id:, name: nil, gmt_offset: nil)
@@ -12,46 +16,25 @@ module Vng
 
     def self.find_by(zip:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '1',
         zip: zip,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/availability/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: Vng::Availability::PATH, body: body
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      franchise_id = JSON(response.body)['Ids']['franchiseID']
+      franchise_id = data['Ids']['franchiseID']
       new(id: franchise_id) unless franchise_id == '0'
     end
 
     def self.all
-      body = {
-        securityToken: Vng.configuration.security_token,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/franchises/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      JSON(response.body)['Franchises'].filter do |body|
-        body['isActive']
-      end.map do |body|
-        id = body['franchiseID']
-        name = body['franchiseName']
-        gmt_offset = body['gmtOffsetFranchise']
+      data = request path: PATH
+
+      data['Franchises'].filter do |franchise|
+        franchise['isActive']
+      end.map do |franchise|
+        id = franchise['franchiseID']
+        name = franchise['franchiseName']
+        gmt_offset = franchise['gmtOffsetFranchise']
 
         new id: id, name: name, gmt_offset: gmt_offset
       end

data/lib/vng/lead.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo leads.
-  class Lead
+  class Lead < Resource
+    PATH = '/api/v1/data/Leads/'
+
     attr_reader :id, :name, :email, :phone
 
     def initialize(id:, name:, email:, phone:)
@@ -12,7 +16,6 @@ module Vng
 
     def self.create(name:, email:, phone:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
         Fields: [
            {fieldID: 121, optionID: '59'},
@@ -22,51 +25,25 @@ module Vng
         ]
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Leads/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      body = JSON response.body
-
-      if body['errNo']
-        # 'errNo'=>-600,
-        # 'errMsg'=>'Data validation failed.',
-        # 'dateNow'=>'1731342482',
-        # 'Errors'=>[{"fieldID"=>1024, "fieldName"=>"Phone # to Reach You", "errNo"=>-602, "errMsg"=>"Field data is in incorrect format."}]}
-
-        # raise Vng::Error
-      end
+      data = request path: PATH, body: body
 
-      id = body['Client']['objectID']
-      name = body['Fields'].find{|field| field['fieldID'] == 126}['fieldValue']
-      email = body['Fields'].find{|field| field['fieldID'] == 238}['fieldValue']
-      phone = body['Fields'].find{|field| field['fieldID'] == 1024}['fieldValue']
+      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']
 
       new id: id, name: name, email: email, phone: phone
     end
 
-    def destroy
-      body = {
-        securityToken: Vng.configuration.security_token,
-        method: '4',
-        objectID: id,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Leads/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-    end
+    # Data validation failed. [{"fieldID"=>0, "fieldName"=>nil, "errNo"=>-1201, "errMsg"=>"Lead ID does not exist."}]
+    # TODO: has become an account meanwhile!! so this doesn't work
+    # def destroy
+    #   body = {
+    #     method: '4',
+    #     objectID: id,
+    #   }
+    #
+    #   self.class.request path: PATH, body: body
+    # end
   end
 end

data/lib/vng/location.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo locations.
-  class Location
+  class Location < Resource
+    PATH = '/api/v1/data/Locations/'
+
     # TODO: fetch from /system/objects/ method: 1, objectID: 20
     STATES_OPTION_ID = {
       AK: 9879, AL: 9878, AR: 9877, AZ: 9880, CA: 9883, CO: 9876, CT: 9875,
@@ -21,7 +25,6 @@ module Vng
 
     def self.create(address:, city:, zip:, state:, client_id:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
         clientID: client_id,
         Fields: [
@@ -33,36 +36,20 @@ module Vng
         ]
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Locations/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: PATH, body: body
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      new id: JSON(response.body)['Location']['objectID']
+      new id: data['Location']['objectID']
     end
 
-    def destroy
-      body = {
-        securityToken: Vng.configuration.security_token,
-        method: '4',
-        objectID: id,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/Locations/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-    end
+    # Data validation failed. [{"fieldID"=>0, "fieldName"=>"", "errNo"=>-1809, "errMsg"=>"Primary location cannot be deleted."}]
+    # def destroy
+    #   body = {
+    #     method: '4',
+    #     objectID: id,
+    #   }
+    #
+    #   self.class.request path: PATH, body: body
+    # end
   end
 end
 

data/lib/vng/lock.rb

@@ -1,6 +1,10 @@
+require 'vng/availability'
+
 module Vng
   # Provides methods to interact with Vonigo locks.
-  class Lock
+  class Lock < Resource
+    PATH = '/api/v1/resources/availability/'
+
     attr_reader :id
 
     def initialize(id:)
@@ -9,7 +13,6 @@ module Vng
 
     def self.create(duration:, location_id:, date:, minutes:, route_id:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '2',
         serviceTypeID: '14', # only create items of serviceType 'Pet Grooming'
         duration: duration.to_i,
@@ -19,36 +22,18 @@ module Vng
         startTime: minutes,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/availability/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: Vng::Availability::PATH, body: body
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      id = JSON(response.body)['Ids']['lockID']
-      new id: id
+      new id: data['Ids']['lockID']
     end
 
-    def destroy
-      body = {
-        securityToken: Vng.configuration.security_token,
-        method: '4',
-        objectID: id,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/availability/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-    end
+    # def destroy
+    #   body = {
+    #     method: '4',
+    #     lockID: id,
+    #   }
+    #
+    #   self.class.request path: PATH, body: body
+    # end
   end
 end

data/lib/vng/price_item.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo price items.
-  class PriceItem
+  class PriceItem < Resource
+    PATH = '/api/v1/data/priceLists/'
+
     attr_reader :id, :price_item, :value, :tax_id, :duration_per_unit, :service_badge, :service_category
 
     def initialize(id:, price_item:, value:, tax_id:, duration_per_unit:, service_badge:, service_category:)
@@ -15,25 +19,15 @@ module Vng
 
     def self.where(location_id:, asset_id:)
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '2',
         serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
         locationID: location_id,
         assetID: asset_id,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/priceLists/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH, body: body
 
-      JSON(response.body)['PriceItems'].filter do |body|
-        # TODO: body['serviceBadge'] != 'Not Offered'
+      data['PriceItems'].filter do |body|
         body['isOnline'] && body['isActive']
       end.map do |body|
         id = body['priceItemID']

data/lib/vng/resource.rb

@@ -0,0 +1,40 @@
+require 'vng/connection_error'
+require 'vng/error'
+
+module Vng
+  # Provides an abstract class for every Vonigo resource.
+  class Resource
+  private
+    def self.request(path:, body: {}, query: {}, include_security_token: true)
+      uri = URI::HTTPS.build host: host, path: path
+      uri.query = URI.encode_www_form(query) if query.any?
+
+      method = query.any? ? Net::HTTP::Get : Net::HTTP::Post
+      request = method.new uri.request_uri
+      request.initialize_http_header 'Content-Type' => 'application/json'
+
+      if query.none?
+        body = body.merge(securityToken: security_token) if include_security_token
+        request.body = body.to_json
+      end
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request request
+      end
+
+      JSON(response.body).tap do |data|
+        raise Vng::Error, "#{data['errMsg']} #{data['Errors']}" unless data['errNo'].zero?
+      end
+    rescue Errno::ECONNREFUSED, SocketError => e
+      raise Vng::ConnectionError, e.message
+    end
+
+    def self.host
+      Vng.configuration.host
+    end
+
+    def self.security_token
+      Vng.configuration.security_token
+    end
+  end
+end

data/lib/vng/security_token.rb

@@ -1,51 +1,51 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo work security tokens.
-  class SecurityToken
+  class SecurityToken < Resource
+    PATH = '/api/v1/security/login/'
+
     attr_reader :token
 
-    def initialize(token:, host:)
+    def initialize(token:)
       @token = token
-      @host = host
     end
 
-    def self.create(host:, username:, password:)
+    def self.create
       body = {
         app_version: '1',
         company: 'Vonigo',
-        host: host,
-        password: Digest::MD5.hexdigest(password),
-        username: username,
+        username: Vng.configuration.username,
+        password: Digest::MD5.hexdigest(Vng.configuration.password),
       }
 
-      uri = URI::HTTPS.build host: host, path: '/api/v1/security/login/'
-
-      request = Net::HTTP::Get.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json; charset=utf-8'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      token = JSON(response.body)['securityToken']
+      data = request path: PATH, body: body, include_security_token: false
 
-      new token: token, host: host
+      new token: data['securityToken']
     end
 
-    def destroy
+    # 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,
+        method: "2",
+        franchiseID: franchise_id,
       }
 
-      uri = URI::HTTPS.build host: @host, path: '/api/v1/security/login/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      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
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+    def destroy
+      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
 end

data/lib/vng/service_type.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo service types.
-  class ServiceType
+  class ServiceType < Resource
+    PATH = '/api/v1/resources/serviceTypes/'
+
     attr_reader :id, :type, :duration
 
     def initialize(id:, type:, duration:)
@@ -11,21 +15,9 @@ module Vng
 
     # TODO: Needs pagination
     def self.all
-      body = {
-        securityToken: Vng.configuration.security_token,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/serviceTypes/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+      data = request path: PATH
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
-
-      JSON(response.body)['ServiceTypes'].map do |body|
+      data['ServiceTypes'].map do |body|
         id = body['serviceTypeID']
         type = body['serviceType']
         duration = body['duration']
@@ -36,21 +28,12 @@ module Vng
 
     def self.where(zip:)
       body = {
-        securityToken: Vng.configuration.security_token,
         zip: zip,
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/serviceTypes/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH, body: body
 
-      JSON(response.body)['ServiceTypes'].filter do |body|
+      data.fetch('ServiceTypes', []).filter do |body|
         body['isActive']
       end.map do |body|
         id = body['serviceTypeID']

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 end

data/lib/vng/work_order.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo work orders.
-  class WorkOrder
+  class WorkOrder < Resource
+    PATH = '/api/v1/data/WorkOrders/'
+
     attr_reader :id
 
     def initialize(id:)
@@ -8,20 +12,7 @@ module Vng
     end
 
     def self.create(lock_id:, client_id:, contact_id:, location_id:, duration:, summary:, line_items:)
-      charges = line_items.map do |line_item|
-        {
-          priceItemID: line_item[:price_item_id],
-          taxID: line_item[:tax_id],
-          assetID: line_item[:asset_id],
-          Fields: [
-            {fieldID: 9289, fieldValue: line_item[:description]},
-            {fieldID: 9287, fieldValue: line_item[:price]}
-          ]
-        }
-      end
-
       body = {
-        securityToken: Vng.configuration.security_token,
         method: '3',
         serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
         lockID: lock_id,
@@ -33,39 +24,47 @@ module Vng
           {fieldID: 186, fieldValue: duration.to_i},
           {fieldID: 201, optionID: '9537'} # label: Online Tentative
         ],
-        Charges: charges
+        Charges: charges_for(line_items)
       }
 
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/WorkOrders/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH, body: body
 
-      id = JSON(response.body)['WorkOrder']['objectID']
-      new id: id
+      new id: data['WorkOrder']['objectID']
     end
 
-    def destroy
-      body = {
-        securityToken: Vng.configuration.security_token,
-        method: '4',
-        objectID: id,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/data/WorkOrders/'
+    # TODO: This moves to "archived". actual cancelation is different
+    # def destroy
+    #   body = {
+    #     method: '8',
+    #     objectID: id,
+    #   }
+    #
+    #   data = self.class.request path: PATH, body: body
+    # end
 
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
+  private
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
+    def self.charges_for(line_items)
+      line_items.map do |line_item|
+        {
+          priceItemID: line_item[:price_item_id],
+          taxID: line_item[:tax_id],
+          assetID: line_item[:asset_id],
+          Fields: charge_fields_for(line_item)
+        }
       end
     end
+
+    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
+      ]
+    end
   end
 end

data/lib/vng/zip.rb

@@ -1,6 +1,10 @@
+require 'vng/resource'
+
 module Vng
   # Provides methods to interact with Vonigo ZIP codes.
-  class Zip
+  class Zip < Resource
+    PATH = '/api/v1/resources/zips/'
+
     attr_reader :zip, :state, :zone_name
 
     def initialize(zip:, state:, zone_name:)
@@ -11,21 +15,9 @@ module Vng
 
     # TODO: Needs pagination
     def self.all
-      body = {
-        securityToken: Vng.configuration.security_token,
-      }
-
-      uri = URI::HTTPS.build host: 'aussiepetmobileusatraining2.vonigo.com', path: '/api/v1/resources/zips/'
-
-      request = Net::HTTP::Post.new(uri.request_uri)
-      request.initialize_http_header 'Content-Type' => 'application/json'
-      request.body = body.to_json
-
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request request
-      end
+      data = request path: PATH
 
-      JSON(response.body)['Zips'].map do |body|
+      data['Zips'].map do |body|
         zip = body['zip']
         state = body['state']
         zone_name = body['zoneName']

data/lib/vng.rb

@@ -9,6 +9,7 @@ require_relative 'vng/availability'
 require_relative 'vng/breed'
 require_relative 'vng/case'
 require_relative 'vng/config'
+require_relative 'vng/connection_error'
 require_relative 'vng/contact'
 require_relative 'vng/franchise'
 require_relative 'vng/lead'
@@ -20,8 +21,3 @@ require_relative 'vng/service_type'
 require_relative 'vng/version'
 require_relative 'vng/work_order'
 require_relative 'vng/zip'
-
-module Vng
-  class Error < StandardError; end
-  # Your code goes here...
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -43,12 +43,15 @@ files:
 - lib/vng/case.rb
 - lib/vng/config.rb
 - lib/vng/configuration.rb
+- lib/vng/connection_error.rb
 - lib/vng/contact.rb
+- lib/vng/error.rb
 - lib/vng/franchise.rb
 - lib/vng/lead.rb
 - lib/vng/location.rb
 - lib/vng/lock.rb
 - lib/vng/price_item.rb
+- lib/vng/resource.rb
 - lib/vng/security_token.rb
 - lib/vng/service_type.rb
 - lib/vng/version.rb