vng 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 129c6515837c1b7fa5f154615d612ca3cedd6bd320bb263a7fb735077f8b5d47
-  data.tar.gz: 18bb0decf0fe5898806be8d2c14a72922d81d088b911a635066f9c96412667b4
+  metadata.gz: ec68041442659731246003b523c47c70f41ac3127190c3f966a0c774274f9a2e
+  data.tar.gz: b34853bfd235358cb485ff8fbe84a090dd4104e01f6f01065d6269b20f7f9fbe
 SHA512:
-  metadata.gz: 552bd6911e893085333993d7b55abacc195ca9e279e2c081b357184a654ec8b748aac7186b4222aeca6363f315b7d43cfb7060c3b6e44b08590f2680211730a7
-  data.tar.gz: 43afeefdfce3d6a3603160cf6b3cfd8544c8fe3afd7f649f3a57d09a3aef904d848b04166858b5f7ffe03cfcf14da4cbac78bc51045060093f884981efc19654
+  metadata.gz: b2c9cb81c4ec152b7e98800ee01ba68b05617e5b5f85d6dee04607e9c3347faa402f0d3e8109d9579e3683bd7e8d234c5c209ef3e67e8e7d6dd8277e08930dd7
+  data.tar.gz: 91abf7c0f28cd38e7cd9151797eb3312ea6046db8c07af63ba53861b00cf6603f0b2e17c5a585bba9b75623fe2a58aa17c89df739437ee8de027893a25836d32

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.7.0] - 2024-12-26
+
+- Adds PriceItem.for_price_list_id
+- Adds PriceList.all
+- Adds PriceBlock.for_price_list_id
+
+## [1.6.0] - 2024-12-24
+
+- Adds Zip.find_by(zip:)
+
 ## [1.5.0] - 2024-12-20
 
 - Allow Case to be created without client_id

data/lib/vng/mock_request.rb

@@ -48,7 +48,14 @@ module Vng
           {}
         end
       when '/api/v1/resources/zips/'
-        { "Zips"=>[{ "zip"=>"21765", "zoneName"=>"Brentwood", "state"=>"MD" }] }
+        if @body[:method] == '1'
+          # TODO: The response already includes the ServiceTypes so there
+          # is no need to ask for those in a separate API request:
+          { "Zip"=>{"zipCodeID"=>"1", "zipCode"=>"21765", "zoneName"=>"Brentwood", "defaultCity"=>"Los Angeles", "provinceAbbr"=>"CA", "franchiseID"=>"105"},
+            "ServiceTypes"=>[{"serviceTypeID"=>14, "serviceType"=>"Pet Grooming", "duration" => 45}]}
+        else
+          { "Zips"=>[{ "zip"=>"21765", "zoneName"=>"Brentwood", "state"=>"MD" }] }
+        end
       when '/api/v1/resources/franchises/'
         if @body.key?(:objectID)
           { "Franchise"=>{ "objectID"=>"2201007" }, "Fields"=>[
@@ -126,33 +133,71 @@ module Vng
         elsif @body[:method].eql? '4'
           {}
         end
+      when '/api/v1/resources/priceBlocks/'
+        if @body[:pageNo].eql? 1
+          { "PriceBlocks" => [
+            {"priceBlockID"=>329, "priceListID"=>455, "priceBlock"=>"Affenpinscher", "sequence"=>1, "isActive"=>true},
+            {"priceBlockID"=>331, "priceListID"=>455, "priceBlock"=>"Afghan", "sequence"=>2, "isActive"=>false},
+            {"priceBlockID"=>332, "priceListID"=>455, "priceBlock"=>"Airedale Terrier", "sequence"=>3, "isActive"=>true},
+            {"priceBlockID"=>333, "priceListID"=>455, "priceBlock"=>"Persian", "sequence"=>4, "isActive"=>true},
+          ]}
+        else
+          { }
+        end
+      when '/api/v1/resources/priceLists/'
+        { "PriceLists" => [
+          { "priceListID" => 145, "priceList": "Pet Grooming Default", "serviceTypeID" => 14, "isActive" => true },
+          { "priceListID" => 146, "priceList": "Pet Grooming Special", "serviceTypeID" => 14, "isActive" => true },
+          { "priceListID" => 147, "priceList": "Pet Grooming Old", "serviceTypeID" => 14, "isActive" => false },
+        ]}
+      when '/api/v1/resources/priceItems/'
+        if @body[:pageNo].eql? 1
+          { "PriceItems"=>[
+            { "priceItemID"=>275111, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>1, "priceItem"=>"Bulldog American - 15 Step SPA Grooming Service", "value"=>85.0, "taxID"=>256, "durationPerUnit"=>45.0, "serviceBadge"=>"Required", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275112, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>2, "priceItem"=>"Bulldog American - 15 Step SPA Super Grooming Service", "value"=>105.0, "taxID"=>256, "durationPerUnit"=>75.0, "serviceBadge"=>nil, "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+
+            { "priceItemID"=>275300, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>3, "priceItem"=>"Bulldog American - Shave Down", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Not Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275301, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>4, "priceItem"=>"Bulldog American - Puppy Cut", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+
+            { "priceItemID"=>275302, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>5, "priceItem"=>"De-Shedding Treatment inactive", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>false },
+            { "priceItemID"=>275303, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>6, "priceItem"=>"De-Shedding Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275304, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>7, "priceItem"=>"De-Shedding Treatment 60 - 100 lbs", "value"=>30.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275305, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>8, "priceItem"=>"De-shedding Treatment - 101 lbs and over", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+
+            { "priceItemID"=>275306, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>9, "priceItem"=>"Hot Aloe SPA Re- Moisturizing Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275307, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>10, "priceItem"=>"Aches & Pains Package", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275308, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>11, "priceItem"=>"Old Add On", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Not Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+          ] }
+        else
+          { }
+        end
       when '/api/v1/data/priceLists/'
-        if @body[:assetID].eql? 2201008
+        if @body[:assetID].eql?("2201008")
           { "PriceItems"=>[
-            { "priceItemID"=>275111, "priceItem"=>"Bulldog American - 15 Step SPA Grooming Service", "value"=>85.0, "taxID"=>256, "durationPerUnit"=>45.0, "serviceBadge"=>"Required", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275112, "priceItem"=>"Bulldog American - 15 Step SPA Super Grooming Service", "value"=>105.0, "taxID"=>256, "durationPerUnit"=>75.0, "serviceBadge"=>nil, "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275111, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>1, "priceItem"=>"Bulldog American - 15 Step SPA Grooming Service", "value"=>85.0, "taxID"=>256, "durationPerUnit"=>45.0, "serviceBadge"=>"Required", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275112, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>2, "priceItem"=>"Bulldog American - 15 Step SPA Super Grooming Service", "value"=>105.0, "taxID"=>256, "durationPerUnit"=>75.0, "serviceBadge"=>nil, "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
 
-            { "priceItemID"=>275300, "priceItem"=>"Bulldog American - Shave Down", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Not Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275301, "priceItem"=>"Bulldog American - Puppy Cut", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275300, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>3, "priceItem"=>"Bulldog American - Shave Down", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Not Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275301, "priceBlockID"=>329, "descriptionHelp"=>"A price item", "sequence"=>4, "priceItem"=>"Bulldog American - Puppy Cut", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Recommended", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
 
-            { "priceItemID"=>275302, "priceItem"=>"De-Shedding Treatment inactive", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>false },
-            { "priceItemID"=>275303, "priceItem"=>"De-Shedding Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275304, "priceItem"=>"De-Shedding Treatment 60 - 100 lbs", "value"=>30.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275305, "priceItem"=>"De-shedding Treatment - 101 lbs and over", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275302, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>5, "priceItem"=>"De-Shedding Treatment inactive", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>false },
+            { "priceItemID"=>275303, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>6, "priceItem"=>"De-Shedding Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275304, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>7, "priceItem"=>"De-Shedding Treatment 60 - 100 lbs", "value"=>30.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275305, "priceBlockID"=>331, "descriptionHelp"=>"A price item", "sequence"=>8, "priceItem"=>"De-shedding Treatment - 101 lbs and over", "value"=>40.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"De-Shed", "isOnline"=>true, "isActive"=>true },
 
-            { "priceItemID"=>275306, "priceItem"=>"Hot Aloe SPA Re- Moisturizing Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275307, "priceItem"=>"Aches & Pains Package", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>275308, "priceItem"=>"Old Add On", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Not Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275306, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>9, "priceItem"=>"Hot Aloe SPA Re- Moisturizing Treatment 0-30 lbs", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>20.0, "serviceBadge"=>nil, "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275307, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>10, "priceItem"=>"Aches & Pains Package", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>275308, "priceBlockID"=>332, "descriptionHelp"=>"A price item", "sequence"=>11, "priceItem"=>"Old Add On", "value"=>0.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Not Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
           ] }
-        elsif @body[:assetID].eql? 2201009
+        elsif @body[:assetID].eql? "2201009"
           { "PriceItems"=>[
-            { "priceItemID"=>276111, "priceItem"=>"Cat Short Hair - 15 Step SPA Grooming Service", "value"=>65.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Recommended", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>276111, "priceBlockID"=>333, "descriptionHelp"=>"A price item", "sequence"=>21, "priceItem"=>"Cat Short Hair - 15 Step SPA Grooming Service", "value"=>65.0, "taxID"=>256, "durationPerUnit"=>60.0, "serviceBadge"=>"Recommended", "serviceCategory"=>"15 Step Spa", "isOnline"=>true, "isActive"=>true },
 
-            { "priceItemID"=>276111, "priceItem"=>"Cat Short Hair - Lion Cut", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>276111, "priceItem"=>"Cat Short Hair - Shave Down", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>276111, "priceBlockID"=>333, "descriptionHelp"=>"A price item", "sequence"=>22, "priceItem"=>"Cat Short Hair - Lion Cut", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>276111, "priceBlockID"=>333, "descriptionHelp"=>"A price item", "sequence"=>23, "priceItem"=>"Cat Short Hair - Shave Down", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>30.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Cut", "isOnline"=>true, "isActive"=>true },
 
-            { "priceItemID"=>276111, "priceItem"=>"De-Matting - Light", "value"=>15.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
-            { "priceItemID"=>276111, "priceItem"=>"De-Matting - Moderate", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>276111, "priceBlockID"=>333, "descriptionHelp"=>"A price item", "sequence"=>24, "priceItem"=>"De-Matting - Light", "value"=>15.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
+            { "priceItemID"=>276111, "priceBlockID"=>333, "descriptionHelp"=>"A price item", "sequence"=>25, "priceItem"=>"De-Matting - Moderate", "value"=>20.0, "taxID"=>256, "durationPerUnit"=>15.0, "serviceBadge"=>"Offered", "serviceCategory"=>"Add Ons", "isOnline"=>true, "isActive"=>true },
           ] }
         end
       when '/api/v1/resources/serviceTypes/'

data/lib/vng/price_block.rb

@@ -0,0 +1,33 @@
+require 'vng/resource'
+require 'vng/price_list'
+
+module Vng
+  # Provides methods to interact with Vonigo price blocks.
+  class PriceBlock < Resource
+    PATH = '/api/v1/resources/priceBlocks/'
+
+    attr_reader :id, :name, :index
+
+    def initialize(id:, name:, index:)
+      @id = id
+      @name = name
+      @index = index
+    end
+
+    def self.for_price_list_id(price_list_id)
+      body = { priceListID: price_list_id }
+
+      data = request path: PATH, body: body, returning: 'PriceBlocks'
+
+      data.filter_map do |body|
+        next unless body['isActive']
+
+        id = body['priceBlockID']
+        name = body['priceBlock']
+        index = body['sequence']
+
+        new id: id, name: name, index: index
+      end
+    end
+  end
+end

data/lib/vng/price_item.rb

@@ -5,16 +5,45 @@ module Vng
   class PriceItem < Resource
     PATH = '/api/v1/data/priceLists/'
 
-    attr_reader :id, :price_item, :value, :tax_id, :duration_per_unit, :service_badge, :service_category
+    attr_reader :id, :price_item, :index, :description, :value, :tax_id, :duration_per_unit, :service_badge, :service_category, :price_block_id
 
-    def initialize(id:, price_item:, value:, tax_id:, duration_per_unit:, service_badge:, service_category:)
+    def initialize(id:, price_item:, index:, description:, value:, tax_id:, duration_per_unit:, service_badge:, service_category:, price_block_id:)
       @id = id
       @price_item = price_item
+      @index = index
+      @description = description
       @value = value
       @tax_id = tax_id
       @duration_per_unit = duration_per_unit
       @service_badge = service_badge
       @service_category = service_category
+      @price_block_id = price_block_id
+    end
+
+    def self.for_price_list_id(price_list_id)
+      body = {
+        method: '1',
+        priceListID: price_list_id,
+      }
+
+      data = request path: '/api/v1/resources/priceItems/', body: body, returning: 'PriceItems'
+
+      data.filter_map do |body|
+        next unless body['isOnline'] && body['isActive']
+
+        id = body['priceItemID']
+        price_item = body['priceItem']
+        index = body['sequence']
+        description = body['descriptionHelp']
+        value = body['value']
+        tax_id = body['taxID']
+        duration_per_unit = body['durationPerUnit']
+        service_badge = body['serviceBadge']
+        service_category = body['serviceCategory']
+        price_block_id = body['priceBlockID']
+
+        new id: id, price_item: price_item, index: index, description: description, value: value, tax_id: tax_id, duration_per_unit: duration_per_unit, service_badge: service_badge, service_category: service_category, price_block_id: price_block_id
+      end
     end
 
     def self.where(location_id:, asset_id:)
@@ -32,13 +61,16 @@ module Vng
       end.map do |body|
         id = body['priceItemID']
         price_item = body['priceItem']
+        index = body['sequence']
+        description = body['descriptionHelp']
         value = body['value']
         tax_id = body['taxID']
         duration_per_unit = body['durationPerUnit']
         service_badge = body['serviceBadge']
         service_category = body['serviceCategory']
+        price_block_id = body['priceBlockID']
 
-        new id: id, price_item: price_item, value: value, tax_id: tax_id, duration_per_unit: duration_per_unit, service_badge: service_badge, service_category: service_category
+        new id: id, price_item: price_item, index: index, description: description, value: value, tax_id: tax_id, duration_per_unit: duration_per_unit, service_badge: service_badge, service_category: service_category, price_block_id: price_block_id
       end
     end
   end

data/lib/vng/price_list.rb

@@ -0,0 +1,29 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo price lists.
+  class PriceList < Resource
+    PATH = '/api/v1/resources/priceLists/'
+
+    attr_reader :id, :name
+
+    def initialize(id:, name:)
+      @id = id
+      @name = name
+    end
+
+    def self.all
+      data = request path: PATH
+
+      data['PriceLists'].filter_map do |price_list|
+        next unless price_list['isActive']
+        next unless price_list['serviceTypeID'].eql?(14)
+
+        id = price_list['priceListID']
+        name = price_list['priceList']
+
+        new id: id, name: name
+      end
+    end
+  end
+end

data/lib/vng/resource.rb

@@ -5,11 +5,26 @@ module Vng
   class Resource
   private
 
-    def self.request(path:, body: {}, query: {}, include_security_token: true)
+    def self.request(path:, body: {}, query: {}, include_security_token: true, returning: nil)
       if query.none? && include_security_token
         body = body.merge securityToken: Vng.configuration.security_token
       end
 
+      if returning
+        [].tap do |response|
+          1.step do |page_number|
+            body = body.merge pageSize: 500, pageNo: page_number
+            batch = response_for(path:, body:, query:).fetch(returning, [])
+            break if batch.empty? || page_number > 20
+            response.concat batch
+          end
+        end
+      else
+        response_for path:, body:, query:
+      end
+    end
+
+    def self.response_for(path:, body: {}, query: {})
       instrument do |data|
         Request.new(host: host, path: path, query: query, body: body).run
       end

data/lib/vng/version.rb

@@ -1,3 +1,3 @@
 module Vng
-  VERSION = '1.5.0'
+  VERSION = '1.7.0'
 end

data/lib/vng/zip.rb

@@ -1,16 +1,19 @@
 require 'vng/resource'
+require 'vng/service_type'
 
 module Vng
   # Provides methods to interact with Vonigo ZIP codes.
   class Zip < Resource
     PATH = '/api/v1/resources/zips/'
 
-    attr_reader :zip, :state, :zone_name
+    attr_reader :zip, :state, :zone_name, :city, :service_types
 
-    def initialize(zip:, state:, zone_name:)
+    def initialize(zip:, state:, zone_name:, city: nil, service_types: [])
       @zip = zip
       @state = state
       @zone_name = zone_name
+      @city = city
+      @service_types = service_types
     end
 
     def self.all
@@ -26,5 +29,26 @@ module Vng
         new zip: zip, state: state, zone_name: zone_name
       end
     end
+
+    def self.find_by(zip:)
+      body = {
+        method: '1',
+        zip: zip,
+      }
+
+      data = request path: PATH, body: body
+      zip_data = data['Zip']
+
+      unless zip_data['zipCodeID'] == '0'
+        service_types = data['ServiceTypes'].map do |body|
+          id = body['serviceTypeID']
+          type = body['serviceType']
+          duration = body['duration']
+          ServiceType.new id: id, type: type, duration: duration
+        end
+
+        new zip: zip_data['zipCode'], state: zip_data['provinceAbbr'], zone_name: zip_data['zoneName'], city: zip_data['defaultCity'], service_types: service_types
+      end
+    end
   end
 end

data/lib/vng.rb

@@ -14,6 +14,7 @@ require_relative 'vng/franchise'
 require_relative 'vng/lead'
 require_relative 'vng/location'
 require_relative 'vng/lock'
+require_relative 'vng/price_block'
 require_relative 'vng/price_item'
 require_relative 'vng/route'
 require_relative 'vng/security_token'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -81,7 +81,9 @@ files:
 - lib/vng/location.rb
 - lib/vng/lock.rb
 - lib/vng/mock_request.rb
+- lib/vng/price_block.rb
 - lib/vng/price_item.rb
+- lib/vng/price_list.rb
 - lib/vng/resource.rb
 - lib/vng/route.rb
 - lib/vng/security_token.rb