vng 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a0ac30382d544a23cf237ceaed3b8d1ca72a91c1886126d007475bf8b5ee2b
-  data.tar.gz: 62843a64cc58e6b21788d5fc87969fad1335e89740cd564247920df83620058c
+  metadata.gz: 706982b8a7566e56016073d4d5a0e049ed351da4cebab7ca002d7b52b49e46a8
+  data.tar.gz: 15f60eb8f382d6d4d48903dec324b2251617ae46d28ba0c14fef5471a1060d35
 SHA512:
-  metadata.gz: e516c0ab8fa41d444e923227ac3c2c4393a1451710e8ff10ac02dd2444c67c0423b3125471b290aa6b68b8a5e63c618c323df8ba41272e48361bf8e9c66151c2
-  data.tar.gz: 8b236c7ad8f41302f1d5ff6de2ed222e1780217942c4bbdfdc441ecc3cbf2d43ed4ed8014946a7b200eef9e612affd77bfff4d3358211905eef3dd6caae8dd15
+  metadata.gz: 2a1b3bab28a45018a6a3876c066c9a1d95c376c1d336e83f607c822cbd5bb84b11222f36ce8ca22a9198bca7d0f67a90fd476e61b99601a10a021dc5115fec90
+  data.tar.gz: 578f75157f4e0e326ec427cf64bc7c42b84dcecbcd37eaeec20cec7f4a6254b44c0eaaa1b69e4e614c64f9a183859041bbeb85b606a5b488daf75ce4cc850c18

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.1.19] - 2024-11-19
+
+- Adds Route
+
 ## [0.1.18] - 2024-11-19
 
 - Ensure a plus sign in the email is not translated into a space

data/README.md

@@ -84,6 +84,8 @@ To run tests:
 rspec
 ```
 
+Set `VNG_MOCK=1` to test against HTTP mocks.
+
 How to release new versions
 ===========================
 

data/lib/vng/configuration.rb

@@ -40,12 +40,16 @@ module Vng
     # @return [String] the password for the API calls.
     attr_accessor :password
 
+    # @return [Boolean] whether to mock the HTTP calls to Vonigo
+    attr_accessor :mock
+
     # Initialize the global configuration settings, using the values of
     # the specified following environment variables by default.
     def initialize
       @host = ENV['VNG_HOST']
       @username = ENV['VNG_USERNAME']
       @password = ENV['VNG_PASSWORD']
+      @mock = ENV['VNG_MOCK'] == '1'
     end
   end
 end

data/lib/vng/mock_resource.rb

@@ -0,0 +1,107 @@
+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

data/lib/vng/route.rb

@@ -0,0 +1,29 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo ZIP routes.
+  class Route < Resource
+    PATH = '/api/v1/resources/Routes/'
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    # TODO: Needs pagination
+    def self.all
+      data = request path: PATH
+
+      data['Routes'].filter do |route|
+        route['isActive']
+      end.map do |body|
+        id = body['routeID']
+        name = body['routeName']
+
+        new id: id, name: name
+      end
+    end
+  end
+end

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '0.1.18'
+  VERSION = '0.1.19'
 end

data/lib/vng.rb

@@ -16,6 +16,7 @@ require_relative 'vng/lead'
 require_relative 'vng/location'
 require_relative 'vng/lock'
 require_relative 'vng/price_item'
+require_relative 'vng/route'
 require_relative 'vng/security_token'
 require_relative 'vng/service_type'
 require_relative 'vng/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -50,8 +50,10 @@ files:
 - lib/vng/lead.rb
 - lib/vng/location.rb
 - lib/vng/lock.rb
+- lib/vng/mock_resource.rb
 - lib/vng/price_item.rb
 - lib/vng/resource.rb
+- lib/vng/route.rb
 - lib/vng/security_token.rb
 - lib/vng/service_type.rb
 - lib/vng/version.rb