vng 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1356553075599aa2888d10740b02d282d6f6407c69bf49f67e0dbdc46475cebc
-  data.tar.gz: a8d09b9454c4fe51de636f61a880614eca6d12e9fc8455e5fc3888f324eaab9c
+  metadata.gz: d55841e2ab8e3e620c5bd29d8c994cbbb441a327ab3006ee262c3c44f207fda1
+  data.tar.gz: d4fb1cd2865d72faa464711cd03d61974a991d53e766310523ee5adc0353ba1e
 SHA512:
-  metadata.gz: 273b479db2901d89fbdd880383cdcf212aaffcfd1637ca973464567b33b98eafeb2036a6e7e46357d6e7aadc87d70876733bc7094c7c727a0e04118f0b8772fe
-  data.tar.gz: '088ea1b5e63a121b23f956b533d34b3adcf5a570851d999e583197134ae5af69b8345e9ff4946d15183723e031c87015dae8b112e1bf30edc2a2d683b3ca8ee1'
+  metadata.gz: f118bbfc089a69e924fdcc0948de07dbb20217d4b5556a0e80abea896734f545199f27afdf1edf7c6d1c3ffec2ee9a6a04497a7629527e1623c44ba5ea75e894
+  data.tar.gz: fce28eb9405e05bc3620e67a53942ae901ec0f655dca7e640755ac231c975b262329596ec5dbd6a5e0dfa6180ebd5b2edc9d95503b3e8f09db0f670c97618920

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Unreleased]
+## [Unreleased] -
+
+## [1.3] - 2024-11-21
+
+- Adds MockRequest which can be set with VNG_MOCK=1
+
+## [1.2] - 2024-11-20
+
+- Adds WorkOrder#url and Case#url
 
 ## [1.1] - 2024-11-20
 

data/README.md

@@ -84,7 +84,14 @@ To run tests:
 rspec
 ```
 
-Set `VNG_MOCK=1` to test against HTTP mocks.
+By default, tests are run with real HTTP calls to Vonigo that must be
+set with the environment variables specified above.
+
+If you do not have access to Vonigo, you can still run the tests mocked:
+
+```bash
+VNG_MOCK=1 rspec
+```
 
 How to release new versions
 ===========================

data/lib/vng/availability.rb

@@ -1,3 +1,4 @@
+require 'date'
 require 'vng/resource'
 
 module Vng

data/lib/vng/case.rb

@@ -32,6 +32,11 @@ module Vng
       new id: data['Case']['objectID']
     end
 
+    # Returns the URL to manage the case in the Vonigo UI.
+    def url
+      "https://#{self.class.host}/Client/Case/Case_Main.aspx?caseID=#{id}"
+    end
+
     def destroy
       body = {
         method: '4',

data/lib/vng/franchise.rb

@@ -21,7 +21,7 @@ module Vng
         zip: zip,
       }
 
-      data = request path: Vng::Availability::PATH, body: body
+      data = request path: Availability::PATH, body: body
 
       franchise_id = data['Ids']['franchiseID']
       new(id: franchise_id) unless franchise_id == '0'

data/lib/vng/http_request.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'net/http'
+
+require 'vng/connection_error'
+require 'vng/error'
+
+module Vng
+  # A wrapper around +Net::HTTP+ to send HTTP requests to the Vonigo API and
+  # return their result or raise an error if the result is unexpected.
+  # The basic way to use HTTPRequest is by calling +run+ on an instance.
+  # @example List the species of all breeds.
+  #   host = ''subdomain.vonigo.com'
+  #   path = '/api/v1/resources/breeds/'
+  #   body = {securityToken: security_token}
+  #   response = Vng::HTTPRequest.new(path: path, body: body).run
+  #   response['Breeds'].map{|breed| breed['species']}
+  # @api private
+  class Request
+    # Initializes an HTTPRequest object.
+    # @param [Hash] options the options for the request.
+    # @option options [String] :host The host of the request URI.
+    # @option options [String] :path The path of the request URI.
+    # @option options [Hash] :query ({}) The params to use as the query
+    #   component of the request URI, for instance the Hash +{a: 1, b: 2}+
+    #   corresponds to the query parameters +"a=1&b=2"+.
+    # @option options [Hash] :body The body of the request.
+    def initialize(options = {})
+      @host = options[:host]
+      @path = options[:path]
+      @body = options[:body]
+      @query = options.fetch :query, {}
+    end
+
+    # Sends the request and returns the body parsed from the JSON response.
+    # @return [Hash] the body parsed from the JSON response.
+    # @raise [Vng::ConnectionError] if the request fails.
+    # @raise [Vng::Error] if parsed body includes errors.
+    def run
+      return {} if response.body.empty?
+      JSON(response.body).tap do |data|
+        raise Error, "#{data['errMsg']} #{data['Errors']}" unless data['errNo'].zero?
+      end
+    end
+
+  private
+
+    # Run the request and memoize the response or the server error received.
+    def response
+      @response ||= Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request http_request
+      end
+    rescue *server_errors => e
+      raise ConnectionError, e.message
+    end
+
+    # @return [URI::HTTPS] the (memoized) URI of the request.
+    def uri
+      attributes = { host: @host, path: @path, query: URI.encode_www_form(@query) }
+      @uri ||= URI::HTTPS.build attributes
+    end
+
+    # @return [Net::HTTPRequest] the full HTTP request object,
+    #   inclusive of headers of request body.
+    def http_request
+      http_class = @query.any? ? Net::HTTP::Get : Net::HTTP::Post
+
+      @http_request ||= http_class.new(uri.request_uri).tap do |request|
+        set_request_body! request
+        set_request_headers! request
+      end
+    end
+
+    # Adds the request headers to the request in the appropriate format.
+    # The User-Agent header is also set to recognize the request.
+    def set_request_headers!(request)
+      request.initialize_http_header 'Content-Type' => 'application/json'
+      request.add_field 'User-Agent', 'Vng::HTTPRequest'
+    end
+
+    # Adds the request body to the request in the appropriate format.
+    def set_request_body!(request)
+      request.body = @body.to_json if @body
+    end
+
+    # Returns the list of server errors worth retrying the request once.
+    def server_errors
+      [
+        Errno::ECONNRESET, Errno::EHOSTUNREACH, Errno::ENETUNREACH,
+        Errno::ETIMEDOUT, Errno::ECONNREFUSED, Net::HTTPServerError,
+        OpenSSL::SSL::SSLError, OpenSSL::SSL::SSLErrorWaitReadable,
+        Net::OpenTimeout, SocketError,
+      ]
+    end
+  end
+end

data/lib/vng/lock.rb

@@ -22,7 +22,7 @@ module Vng
         startTime: minutes,
       }
 
-      data = request path: Vng::Availability::PATH, body: body
+      data = request path: Availability::PATH, body: body
 
       new id: data['Ids']['lockID']
     end

data/lib/vng/mock_request.rb

@@ -0,0 +1,130 @@
+module Vng
+  # A mock version of HTTPRequest which returns pre-built responses.
+  # @example List the species of all breeds.
+  #   host = ''subdomain.vonigo.com'
+  #   path = '/api/v1/resources/breeds/'
+  #   body = {securityToken: security_token}
+  #   response = Vng::Request.new(path: path, body: body).run
+  #   response['Breeds'].map{|breed| breed['species']}
+  # @api private
+  class Request
+    # Initializes an MockRequest object.
+    # @param [Hash] options the options for the request.
+    # @option options [String] :host The host of the request URI.
+    # @option options [String] :path The path of the request URI.
+    # @option options [Hash] :query ({}) The params to use as the query
+    #   component of the request URI, for instance the Hash +{a: 1, b: 2}+
+    #   corresponds to the query parameters +"a=1&b=2"+.
+    # @option options [Hash] :body The body of the request.
+    def initialize(options = {})
+      @host = options[:host]
+      @path = options[:path]
+      @body = options[:body]
+      @query = options.fetch :query, {}
+    end
+
+    ROUTE_ID = 1630
+    @@logged_out = false
+
+    # Sends the request and returns the body parsed from the JSON response.
+    # @return [Hash] the body parsed from the JSON response.
+    # @raise [Vng::ConnectionError] if the request fails.
+    # @raise [Vng::Error] if parsed body includes errors.
+    def run
+      case @path
+      when '/api/v1/security/session/'
+        raise Error.new 'Same franchise ID supplied.'
+      when '/api/v1/security/login/'
+        if @host == 'invalid-host'
+          raise ConnectionError.new 'Failed to open connection'
+        else
+          { "securityToken"=>"1234567" }
+        end
+      when '/api/v1/security/logout/'
+        if @@logged_out
+          raise Error.new 'Session expired. '
+        else
+          @@logged_out = true
+          {}
+        end
+      when '/api/v1/resources/zips/'
+        { "Zips"=>[{ "zip"=>"21765", "zoneName"=>"Brentwood", "state"=>"MD" }] }
+      when '/api/v1/resources/franchises/'
+        if @body.key?(:objectID)
+          { "Franchise"=>{ "objectID"=>"2201007" }, "Fields"=>[
+            { "fieldID"=>9, "fieldValue"=>"vng@example.com" },
+          ] }
+        else
+          { "Franchises"=>[
+            { "franchiseID"=>106, "franchiseName"=>"Mississauga", "gmtOffsetFranchise"=>-300, "isActive"=>false },
+            { "franchiseID"=>107, "franchiseName"=>"Boise", "gmtOffsetFranchise"=>-420, "isActive"=>true },
+          ] }
+        end
+      when '/api/v1/resources/availability/'
+        if @body.key?(:zip)
+          { "Ids"=>{ "franchiseID"=>"172" } }
+        elsif @body[:method] == '2'
+          { "Ids"=>{ "lockID"=>"1406328" } }
+        else
+          { "Availability"=> [
+            { "dayID"=>"20281119", "routeID"=>"#{ROUTE_ID}", "startTime"=>"1080" },
+            { "dayID"=>"20281119", "routeID"=>"#{ROUTE_ID}", "startTime"=>"1110" },
+          ] }
+        end
+      when '/api/v1/resources/breeds/'
+        { "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" },
+        ] }
+      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" },
+        ] }
+      when '/api/v1/data/Locations/'
+        { "Location"=>{ "objectID"=>"995681" } }
+      when '/api/v1/data/Assets/'
+        if @body[:method].eql? '3'
+          { "Asset"=>{ "objectID"=>"2201008" } }
+        elsif @body[:method].eql? '4'
+          {}
+        end
+      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-Matting - Light", "value"=>10.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+          { "priceItemID"=>275301, "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/'
+        if @body.key?(:zip)
+          {"ServiceTypes" => [
+            {"serviceTypeID" => 14, "serviceType" => "Pet Grooming (name)", "duration" => 45,"isActive" => true},
+            {"serviceTypeID" => 16, "serviceType" => "Pet Grooming (name)", "duration" => 45,"isActive" => false},
+          ]}
+        else
+          { "ServiceTypes"=>[
+            { "serviceTypeID"=>14, "serviceType"=>"Pet Grooming", "duration"=>90, "isActive"=>true },
+          ] }
+        end
+      when '/api/v1/resources/Routes/'
+        {"Routes" => [
+          {"routeID" => ROUTE_ID, "routeName" => "Route 1", "isActive" => true},
+          {"routeID" => 2, "routeName" => "Inactive", "isActive" => false},
+        ]}
+      when '/api/v1/data/WorkOrders/'
+        { "WorkOrder"=>{ "objectID"=>"4138030" } }
+      when '/api/v1/data/Cases/'
+        if @body[:method].eql? '3'
+          {"Case" => {"objectID" => "28503"}}
+        elsif @body[:method].eql? '4'
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/vng/resource.rb

@@ -1,42 +1,18 @@
-require 'vng/connection_error'
-require 'vng/error'
+require ENV['VNG_MOCK'] ? 'vng/mock_request' : 'vng/http_request'
 
 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 = instrument do |data|
-        data[:response] = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-          http.request request
-        end
+    def self.request(path:, body: {}, query: {}, include_security_token: true)
+      if query.none? && include_security_token
+        body = body.merge securityToken: Vng.configuration.security_token
       end
 
-      JSON(response.body).tap do |data|
-        raise Vng::Error, "#{data['errMsg']} #{data['Errors']}" unless data['errNo'].zero?
+      instrument do |data|
+        Request.new(host: host, path: path, query: query, body: body).run
       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
 
     def self.value_for_field(data, field_id)
@@ -44,12 +20,18 @@ module Vng
       field['fieldValue'] if field
     end
 
+    # @return [String] the Vonigo API host.
+    def self.host
+      Vng.configuration.host
+    end
+
+    # Provides instrumentation to ActiveSupport listeners
     def self.instrument(&block)
-      data = {class_name: name} # TODO: Add path, query, ...
+      data = { class_name: name }
       if defined?(ActiveSupport::Notifications)
         ActiveSupport::Notifications.instrument 'Vng.request', data, &block
       else
-        block.call(data)
+        block.call data
       end
     end
   end

data/lib/vng/security_token.rb

@@ -1,3 +1,4 @@
+require 'digest/md5'
 require 'vng/resource'
 
 module Vng
@@ -32,14 +33,14 @@ module Vng
       }
 
       self.class.request path: '/api/v1/security/session/', body: body, include_security_token: false
-    rescue Vng::Error => e
+    rescue Error => e
       raise unless e.message.include? 'Same franchise ID supplied'
     end
 
     def destroy
       query = { securityToken: @token }
       self.class.request path: '/api/v1/security/logout/', query: query
-    rescue Vng::Error => e
+    rescue Error => e
       raise unless e.message.include?('Session expired') || e.message.include?('Session does not exist')
     end
   end

data/lib/vng/version.rb

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

data/lib/vng/work_order.rb

@@ -32,6 +32,11 @@ module Vng
       new id: data['WorkOrder']['objectID']
     end
 
+    # Returns the URL to manage the work order in the Vonigo UI.
+    def url
+      "https://#{self.class.host}/Schedule/Job/Job_Main.aspx?woID=#{id}"
+    end
+
   private
 
     def self.charges_for(line_items)

data/lib/vng.rb

@@ -1,14 +1,13 @@
-require 'date'
-require 'digest/md5'
-require 'json'
-require 'net/http'
+# Used by multiple resources
 require 'uri'
+require_relative 'vng/error'
+require_relative 'vng/config'
 
+# Individual resources
 require_relative 'vng/asset'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -76,10 +76,11 @@ files:
 - lib/vng/contact.rb
 - lib/vng/error.rb
 - lib/vng/franchise.rb
+- lib/vng/http_request.rb
 - lib/vng/lead.rb
 - lib/vng/location.rb
 - lib/vng/lock.rb
-- lib/vng/mock_resource.rb
+- lib/vng/mock_request.rb
 - lib/vng/price_item.rb
 - lib/vng/resource.rb
 - lib/vng/route.rb

data/lib/vng/mock_resource.rb

@@ -1,107 +0,0 @@
-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)
-      if Vng.configuration.mock
-        mock_request(path:, body:, query:)
-      else
-        http_request(path:, body:, query:, include_security_token:)
-      end
-    end
-
-    def self.mock_request(path:, body:, query:)
-      case path
-      when '/api/v1/security/login/'
-        { "securityToken"=>"1234567" }
-      when '/api/v1/resources/zips/'
-        { "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 },
-        ] }
-      when '/api/v1/resources/availability/'
-        if body.key?(:zip)
-          { "Ids"=>{ "franchiseID"=>"172" } }
-        elsif body[:method] == '2'
-          { "Ids"=>{ "lockID"=>"1406328" } }
-        else
-          { "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 }] }
-      when '/api/v1/data/Leads/'
-        { "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" },
-        ] }
-      when '/api/v1/data/Locations/'
-        { "Location"=>{ "objectID"=>"995681" } }
-      when '/api/v1/data/Assets/'
-        { "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 },
-        ] }
-      when '/api/v1/resources/serviceTypes/'
-        { "ServiceTypes"=>[
-          { "serviceTypeID"=>14, "serviceType"=>"Pet Grooming", "duration"=>90, "isActive"=>true },
-        ] }
-      when '/api/v1/data/WorkOrders/'
-        { "WorkOrder"=>{ "objectID"=>"4138030" } }
-      when '/api/v1/data/Cases/'
-        { "Case"=>{ "objectID"=>"28460" } }
-      else
-        {}
-      end
-    end
-
-    def self.http_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