vng 0.1.0 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5db1598d18b48ee1c31a7e367c907bc8ba6c224623dc0590d573889812f27322
-  data.tar.gz: 3384c1b42509e05a31c85b5335792c9796a9e20bb4985a0ecb0879d7c8f031c5
+  metadata.gz: de1ec03096db648933db7f9886eaa72b6c4af73e614e475bc0ad26126f35015e
+  data.tar.gz: 0adb9f129d030b78ec726f6a2a1cedd61ebc37c88a88df524aca23ff4d2583ca
 SHA512:
-  metadata.gz: c9b6bdd93b8627c1512915dd353a08485047356a7cb7835c7a55dc587ce6eb27193fb4404dad08918e5e291cf22cd1380acf6544279a198eb593305232501f80
-  data.tar.gz: 115ff16da1a5d29c4fb3a39404da2123332021df2d8bc1b809ce42126483010c4215c1030d1361120bea9943ee0c4e96eca8f0175f3b09e3b95f001d73bc8260
+  metadata.gz: ce83ddaea6c34121333fdaf15b5600b2486e51c2803b82a71826ca464b7c18f79f1c5d39e0837a0483ecda73512abae325fda7aea0b6ec7b4f8fac3ebcc201c4
+  data.tar.gz: 7efd6a2bc16eae79b5ecde44d85ec4ce4de4366a9c735bebc99350d1c743ccc4a6320d47a834e84a92205524761222d07e43a02b06878ff413ca5ff8219e7962

data/CHANGELOG.md

@@ -1,5 +1,61 @@
 ## [Unreleased]
 
+## [0.1.14] - 2024-11-17
+
+- Adds Vng::Error
+
+## [0.1.13] - 2024-11-15
+
+- Enable Vng.configuration.security_token
+
+## [0.1.12] - 2024-11-15
+
+- Adds ServiceType.where(zip:)
+
+## [0.1.11] - 2024-11-15
+
+- Adds Zip
+
+## [0.1.10] - 2024-11-14
+
+- Adds Service Type
+
+## [0.1.9] - 2024-11-13
+
+- Adds Franchise
+
+## [0.1.8] - 2024-11-13
+
+- Adds Security Token
+
+## [0.1.7] - 2024-11-12
+
+- Adds Case
+
+## [0.1.6] - 2024-11-12
+
+- Adds WorkOrder
+
+## [0.1.5] - 2024-11-11
+
+- Adds Availability
+
+## [0.1.4] - 2024-11-11
+
+- Adds Price Item
+
+## [0.1.3] - 2024-11-10
+
+- Adds Location
+
+## [0.1.2] - 2024-11-10
+
+- Adds Breed
+
+## [0.1.1] - 2024-11-10
+
+- Adds Lead.create, Lead#destroy, Contact.create, Contact#destroy
+
 ## [0.1.0] - 2024-11-10
 
 - Initial release

data/README.md

@@ -1,3 +1,109 @@
-# Vng
+Vng - a Ruby client for the Vonigo API
+======================================================
 
-A Ruby API Client for the Vonigo API
+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
+Vng::ServiceType.where zip:
+Vng::SecurityToken.create host:, usename:, password:
+Vng::Lead.create email:, phone:, name: full_name
+Vng::Contact.create first_name:, last_name:, email:, phone:, client_id:
+Vng::Location.create address:, city:, zip:, state: state, client_id:
+Vng::Breed.all
+Vng::Asset.create name:, weight:, breed_option_id:, client_id:
+Vng::PriceItem.where location_id:, asset_id:
+Vng::Availability.where(location_id:, duration:, from_time:, to_time:
+Vng::Lock.create date:, duration: location_id: 
+Vng::WorkOrder.create lock_id:, client_id:, contact_id:, location_id:, duration:, summary:, line_items:
+Vng::Case.create client_id:, summary:, comments:
+```
+
+The **full documentation** is available at [rubydoc.info](http://www.rubydoc.info/gems/vng/frames).
+
+How to install
+==============
+
+To install on your system, run
+
+    gem install vng
+
+To use inside a bundled Ruby project, add this line to the Gemfile:
+
+    gem 'vng', '~> 0.1.13'
+
+Since the gem follows [Semantic Versioning](http://semver.org),
+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.
+
+Configuring your app
+====================
+
+In order to use Vng you must have credentials to the [Vonigo](https://www.vonigo.com/) API.
+
+Add them to your code with the following snippet of code (replacing with your own credentials):
+
+```ruby
+Vng.configure do |config|
+  config.host = 'subdomain.vonigo.com'
+  config.username = 'VonigoUser'
+  config.password = 'VonigoPassword'
+end
+```
+
+Configuring with environment variables
+--------------------------------------
+
+As an alternative to the approach above, you can configure your app with
+variables. Setting the following environment variables:
+
+```bash
+export VNG_HOST="subdomain.vonigo.com"
+export VNG_USERNAME="VonigoUser"
+export VNG_PASSWORD="VonigoPassword"
+```
+
+is equivalent to the previous approach so pick the one you prefer.
+If a variable is set in both places, then `Vng.configure` takes precedence.
+
+How to test
+===========
+
+To run tests:
+
+```bash
+rspec
+```
+
+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 and the code is 100% test-covered.
+Document the changes in CHANGELOG.md and README.md, bump the version, then run:
+
+    rake release
+
+Remember that the vng gem follows [Semantic Versioning](http://semver.org).
+Any new release that is fully backward-compatible should bump the *patch* version (0.0.x).
+Any new version that breaks compatibility should bump the *minor* version (0.x.0)
+
+How to contribute
+=================
+
+Vng needs your support!
+The goal of Vng is to provide a Ruby interface for all the methods exposed by the Vonigo API.
+
+If you find that a method is missing, fork the project, add the missing code,
+write the appropriate tests, then submit a pull request, and it will gladly
+be merged!

data/Rakefile

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/vng/asset.rb

@@ -0,0 +1,48 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo assets.
+  class Asset < Resource
+    PATH = '/api/v1/data/Assets/'
+
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def self.create(name:, weight:, breed_option_id:, client_id:)
+      body = {
+        method: '3',
+        clientID: client_id,
+        Fields: [
+           {fieldID: 1013, fieldValue: name},
+           {fieldID: 1017, fieldValue: weight},
+           {fieldID: 1014, optionID: breed_option_id},
+        ]
+      }
+
+      data = request path: PATH, body: body
+
+      # curl = 'curl'.tap do |curl|
+      #   curl <<  ' -X POST'
+      #   request.each_header{|k, v| curl << %Q{ -H "#{k}: #{v}"}}
+      #   curl << %Q{ -d '#{request.body}'} if request.body
+      #   curl << %Q{ "#{uri.to_s}"}
+      # end
+      # puts curl
+
+      new id: data['Asset']['objectID']
+    end
+
+    def destroy
+      body = {
+        method: '4',
+        objectID: id,
+      }
+
+      data = self.class.request path: PATH, body: body
+    end
+  end
+end
+

data/lib/vng/availability.rb

@@ -0,0 +1,37 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo availabilities.
+  class Availability < Resource
+    PATH = '/api/v1/resources/availability/'
+
+    attr_reader :route_id, :date, :minutes
+
+    def initialize(route_id:, date:, minutes:)
+      @route_id = route_id
+      @date = date
+      @minutes = minutes
+    end
+
+    def self.where(location_id:, duration:, from_time:, to_time:)
+      body = {
+        method: '0',
+        serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
+        locationID: location_id,
+        duration: [duration.to_i, 30].max, # or 'duration is not provided'
+        dateStart: from_time.to_i,
+        dateEnd: to_time.to_i,
+      }
+
+      data = request path: PATH, body: body
+
+      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
+    end
+  end
+end

data/lib/vng/breed.rb

@@ -0,0 +1,35 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo breeds.
+  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:)
+      @id = id
+      @name = name
+      @species = species
+      @option_id = option_id
+      @low_weight = low_weight
+      @high_weight = high_weight
+    end
+
+    # TODO: Needs pagination
+    def self.all
+      data = request path: PATH
+
+      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
+    end
+  end
+end

data/lib/vng/case.rb

@@ -0,0 +1,45 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo cases.
+  class Case < Resource
+    PATH = '/api/v1/data/Cases/'
+
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def self.create(client_id:, summary:, comments:, phone:, email:, zip:)
+      body = {
+        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:
+        ]
+      }
+
+      data = request path: PATH, body: body
+
+      new id: data['Case']['objectID']
+    end
+
+    def destroy
+      body = {
+        method: '4',
+        objectID: id,
+      }
+
+      self.class.request path: PATH, body: body
+    end
+  end
+end
+

data/lib/vng/config.rb

@@ -0,0 +1,45 @@
+require 'vng/configuration'
+
+# An object-oriented Ruby client for Voonigo.
+# @see http://www.rubydoc.info/gems/vng/
+module Vng
+  # Provides methods to read and write global configuration settings.
+  #
+  # A typical usage is to set the Security Token for the API calls.
+  #
+  # @example Set the Security Token for the API client:
+  #   Vng.configure do |config|
+  #     config.security_token = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  module Config
+    # Yields the global configuration to the given block.
+    #
+    # @example
+    #   Vng.configure do |config|
+    #     config.security_token = 'ABCDEFGHIJ1234567890'
+    #   end
+    #
+    # @yield [Vng::Models::Configuration] The global configuration.
+    def configure
+      yield configuration if block_given?
+    end
+
+    # Returns the global {Vng::Models::Configuration} object.
+    #
+    # While this method _can_ be used to read and write configuration settings,
+    # it is easier to use {Vng::Config#configure} Vng.configure}.
+    #
+    # @example
+    #     Vng.configuration.security_token = 'ABCDEFGHIJ1234567890'
+    #
+    # @return [Vng::Models::Configuration] The global configuration.
+    def configuration
+      @configuration ||= Vng::Configuration.new
+    end
+  end
+
+  # @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

data/lib/vng/configuration.rb

@@ -0,0 +1,51 @@
+module Vng
+  # Provides an object to store global configuration settings.
+  #
+  # This class is typically not used directly, but by calling
+  # {Vng::Config#configure Vng.configure}, which creates and updates a single
+  # instance of {Vng::Models::Configuration}.
+  #
+  # @example Set the Security Token for the API client:
+  #   Vng.configure do |config|
+  #     config.security_token = 'ABCDEFGHIJ1234567890'
+  #   end
+  #
+  # @see Vng::Config for more examples.
+  #
+  # An alternative way to set global configuration settings is by storing
+  # them in the following environment variables:
+  #
+  # * +VNG_HOST+ to store the host for the Vonigo API
+  # * +VNG_USERNAME+ to store the username for the Vonigo API
+  # * +VNG_PASSWORD+ to store the password for the Vonigo API
+  #
+  # In case both methods are used together,
+  # {Vng::Config#configure Vng.configure} takes precedence.
+  #
+  # @example Set the API credentials
+  #   ENV['VNG_HOST'] = 'subdomain.vonigo.com'
+  #   ENV['VNG_USERNAME'] = 'VonigoUser'
+  #   ENV['VNG_Password'] = 'VonigoPassword'
+  #
+  class Configuration
+    # @return [String] the Security Token for the API calls.
+    attr_accessor :security_token
+
+    # @return [String] the URI host for the API calls.
+    attr_accessor :host
+
+    # @return [String] the username for the API calls.
+    attr_accessor :username
+
+    # @return [String] the password for the API calls.
+    attr_accessor :password
+
+    # 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']
+    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

@@ -0,0 +1,52 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo contacts.
+  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:)
+      @id = id
+      @first_name = first_name
+      @last_name = last_name
+      @email = email
+      @phone = phone
+    end
+
+    def self.create(first_name:, last_name:, email:, phone:, client_id:)
+      body = {
+        method: '3',
+        clientID: client_id,
+        Fields: [
+           {fieldID: 127, fieldValue: first_name},
+           {fieldID: 128, fieldValue: last_name},
+           {fieldID: 97, fieldValue: 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']
+
+      new id: id, first_name: first_name, last_name: last_name, email: email, phone: phone
+    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

@@ -0,0 +1,43 @@
+require 'vng/availability'
+
+module Vng
+  # Provides methods to interact with Vonigo franchises.
+  class Franchise < Resource
+    PATH = '/api/v1/resources/franchises/'
+
+    attr_reader :id, :name, :gmt_offset
+
+    def initialize(id:, name: nil, gmt_offset: nil)
+      @id = id
+      @name = name
+      @gmt_offset = gmt_offset
+    end
+
+
+    def self.find_by(zip:)
+      body = {
+        method: '1',
+        zip: zip,
+      }
+
+      data = request path: Vng::Availability::PATH, body: body
+
+      franchise_id = data['Ids']['franchiseID']
+      new(id: franchise_id) unless franchise_id == '0'
+    end
+
+    def self.all
+      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
+    end
+  end
+end

data/lib/vng/lead.rb

@@ -0,0 +1,49 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo leads.
+  class Lead < Resource
+    PATH = '/api/v1/data/Leads/'
+
+    attr_reader :id, :name, :email, :phone
+
+    def initialize(id:, name:, email:, phone:)
+      @id = id
+      @name = name
+      @email = email
+      @phone = phone
+    end
+
+    def self.create(name:, email:, phone:)
+      body = {
+        method: '3',
+        Fields: [
+           {fieldID: 121, optionID: '59'},
+           {fieldID: 126, fieldValue: name},
+           {fieldID: 238, fieldValue: 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']
+
+      new id: id, name: name, email: email, phone: phone
+    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

@@ -0,0 +1,55 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo locations.
+  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,
+      DC: 9874, DE: 9873, FL: 9872, GA: 9871, HI: 9870, IA: 9869, ID: 9868,
+      IL: 9867, IN: 9866, KS: 9865, KY: 9864, LA: 9863, MA: 9862, MD: 9861,
+      ME: 9860, MI: 9859, MN: 9858, MO: 9857, MS: 9856, MT: 9855, NC: 9854,
+      ND: 9853, NE: 9852, NH: 9851, NJ: 9850, NM: 9849, NV: 9829, NY: 9848,
+      OH: 9847, OK: 9846, OR: 9881, PA: 9845, RI: 9843, SC: 9841, SD: 9842,
+      TN: 9840, TX: 9839, UT: 9838, VA: 9837, VT: 9836, WA: 9882, WI: 9828,
+      WV: 9835, WY: 9834,
+    }
+
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def self.create(address:, city:, zip:, state:, client_id:)
+      body = {
+        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},
+        ]
+      }
+
+      data = request path: PATH, body: body
+
+      new id: data['Location']['objectID']
+    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

@@ -0,0 +1,39 @@
+require 'vng/availability'
+
+module Vng
+  # Provides methods to interact with Vonigo locks.
+  class Lock < Resource
+    PATH = '/api/v1/resources/availability/'
+
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def self.create(duration:, location_id:, date:, minutes:, route_id:)
+      body = {
+        method: '2',
+        serviceTypeID: '14', # only create items of serviceType 'Pet Grooming'
+        duration: duration.to_i,
+        locationID: location_id,
+        dayID: date.strftime('%Y%m%d'),
+        routeID: route_id,
+        startTime: minutes,
+      }
+
+      data = request path: Vng::Availability::PATH, body: body
+
+      new id: data['Ids']['lockID']
+    end
+
+    # def destroy
+    #   body = {
+    #     method: '4',
+    #     lockID: id,
+    #   }
+    #
+    #   self.class.request path: PATH, body: body
+    # end
+  end
+end

data/lib/vng/price_item.rb

@@ -0,0 +1,45 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo price items.
+  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:)
+      @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
+    end
+
+    def self.where(location_id:, asset_id:)
+      body = {
+        method: '2',
+        serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
+        locationID: location_id,
+        assetID: asset_id,
+      }
+
+      data = request path: PATH, body: body
+
+      data['PriceItems'].filter do |body|
+        body['isOnline'] && body['isActive']
+      end.map do |body|
+        id = body['priceItemID']
+        price_item = body['priceItem']
+        value = body['value']
+        tax_id = body['taxID']
+        duration_per_unit = body['durationPerUnit']
+        service_badge = body['serviceBadge']
+        service_category = body['serviceCategory']
+
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo work security tokens.
+  class SecurityToken < Resource
+    PATH = '/api/v1/security/login/'
+
+    attr_reader :token
+
+    def initialize(token:)
+      @token = token
+    end
+
+    def self.create
+      body = {
+        app_version: '1',
+        company: 'Vonigo',
+        username: Vng.configuration.username,
+        password: Digest::MD5.hexdigest(Vng.configuration.password),
+      }
+
+      data = request path: PATH, body: body, include_security_token: false
+
+      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,
+        method: "2",
+        franchiseID: franchise_id,
+      }
+
+      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
+
+    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

@@ -0,0 +1,47 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo service types.
+  class ServiceType < Resource
+    PATH = '/api/v1/resources/serviceTypes/'
+
+    attr_reader :id, :type, :duration
+
+    def initialize(id:, type:, duration:)
+      @id = id
+      @type = type
+      @duration = duration
+    end
+
+    # TODO: Needs pagination
+    def self.all
+      data = request path: PATH
+
+      data['ServiceTypes'].map do |body|
+        id = body['serviceTypeID']
+        type = body['serviceType']
+        duration = body['duration']
+
+        new id: id, type: type, duration: duration
+      end
+    end
+
+    def self.where(zip:)
+      body = {
+        zip: zip,
+      }
+
+      data = request path: PATH, body: body
+
+      data.fetch('ServiceTypes', []).filter do |body|
+        body['isActive']
+      end.map do |body|
+        id = body['serviceTypeID']
+        type = body['serviceType']
+        duration = body['duration']
+
+        new id: id, type: type, duration: duration
+      end
+    end
+  end
+end

data/lib/vng/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Vng
-  VERSION = "0.1.0"
+  VERSION = '0.1.14'
 end

data/lib/vng/work_order.rb

@@ -0,0 +1,70 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo work orders.
+  class WorkOrder < Resource
+    PATH = '/api/v1/data/WorkOrders/'
+
+    attr_reader :id
+
+    def initialize(id:)
+      @id = id
+    end
+
+    def self.create(lock_id:, client_id:, contact_id:, location_id:, duration:, summary:, line_items:)
+      body = {
+        method: '3',
+        serviceTypeID: '14', # only return items of serviceType 'Pet Grooming'
+        lockID: lock_id,
+        clientID: client_id,
+        contactID: contact_id,
+        locationID: location_id,
+        Fields: [
+          {fieldID: 200, fieldValue: summary},
+          {fieldID: 186, fieldValue: duration.to_i},
+          {fieldID: 201, optionID: '9537'} # label: Online Tentative
+        ],
+        Charges: charges_for(line_items)
+      }
+
+      data = request path: PATH, body: body
+
+      new id: data['WorkOrder']['objectID']
+    end
+
+    # 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
+
+  private
+
+    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

@@ -0,0 +1,29 @@
+require 'vng/resource'
+
+module Vng
+  # Provides methods to interact with Vonigo ZIP codes.
+  class Zip < Resource
+    PATH = '/api/v1/resources/zips/'
+
+    attr_reader :zip, :state, :zone_name
+
+    def initialize(zip:, state:, zone_name:)
+      @zip = zip
+      @state = state
+      @zone_name = zone_name
+    end
+
+    # TODO: Needs pagination
+    def self.all
+      data = request path: PATH
+
+      data['Zips'].map do |body|
+        zip = body['zip']
+        state = body['state']
+        zone_name = body['zoneName']
+
+        new zip: zip, state: state, zone_name: zone_name
+      end
+    end
+  end
+end

data/lib/vng.rb

@@ -1,8 +1,23 @@
-# frozen_string_literal: true
+require 'date'
+require 'digest/md5'
+require 'json'
+require 'net/http'
+require 'uri'
 
-require_relative "vng/version"
-
-module Vng
-  class Error < StandardError; end
-  # Your code goes here...
-end
+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'
+require_relative 'vng/lead'
+require_relative 'vng/location'
+require_relative 'vng/lock'
+require_relative 'vng/price_item'
+require_relative 'vng/security_token'
+require_relative 'vng/service_type'
+require_relative 'vng/version'
+require_relative 'vng/work_order'
+require_relative 'vng/zip'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vng
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.14
 platform: ruby
 authors:
 - claudiob
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
-dependencies: []
+date: 2024-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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
@@ -23,12 +37,31 @@ files:
 - README.md
 - Rakefile
 - lib/vng.rb
+- lib/vng/asset.rb
+- lib/vng/availability.rb
+- lib/vng/breed.rb
+- 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
-homepage: https://github.com/HouseAccountEng/vng
+- lib/vng/work_order.rb
+- lib/vng/zip.rb
+homepage: https://rubygems.org/gems/vng
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/HouseAccountEng/vng
+  homepage_uri: https://rubygems.org/gems/vng
   source_code_uri: https://github.com/HouseAccountEng/vng
   changelog_uri: https://github.com/HouseAccountEng/vng/blob/main/CHANGELOG.md
 post_install_message: