ruby-onfleet 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471ca6ebbd3bc9644207244c2b19d8d60ff9221e6c3e19a50e53e9e1411db11d
-  data.tar.gz: 5e7c98f994113bd8ce492770398868e786522630bd0b222d3a9d9fae986b47cc
+  metadata.gz: 255756c91bf47c71619555d33e379c62da3f860352bdad2fb7f14c0d61c78171
+  data.tar.gz: 4cc8ee7a255e12669f40b7b4c74977b0e15774ee04a9ba2ae7236f74899b2529
 SHA512:
-  metadata.gz: 743882b728bfcdecd669d8d72799705a16dceaa89947c6eafaf83791d04913221f557e78abac56129f599c38f5ed434798854b3ea2ba1660b7acc355444d77ea
-  data.tar.gz: f276fe5e4e1c895c95cb78151dd8514a6e10a5a854efd5b4e5bb7704714e0d9e9625c98e7cb1a6b2904076e8e3e4f86468fe6d3dac15bad6a777cf34ac367a9c
+  metadata.gz: f9b69f6a007f3343cb257e0ec1b6b581567a499a2e47c66775d9e62a6290ec5a044e28ef82b44c7e21205af7ad3ef3f68ed72d419491d3deebff59b4f7a949fd
+  data.tar.gz: 9f6bae5ca0e0c69c0d3e47eda842a8747ec465fe60244a9564eb5c482efec669a1a34b0e2004fbe843026f5e51bc0d46fb9a0c0a9ffa14787d70da2fccd3f7bd

data/CHANGELOG.md

@@ -4,13 +4,28 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.0) - 2023-05-11
+## [Unreleased]
+## [1.1.0](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.1.0) - 2025-10-16
 Added
-* Initial release on RubyGems
+* New CRUD operations for Route Plans
+* New `create` endpoint
+* New `get` endpoint(s) that support both id and query
+* New `update` endpoint
+* New `delete_one` endpoint
+* New `add_tasks_to_route_plan` endpoint
 
-## [1.0.1](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.1) - 2023-05-12
+## [1.0.5](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.5) - 2024-06-26
 Added
-* Refactored resources for module/class inheritance
+* Update to RubyGems release
+
+## [1.0.4](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.4) - 2024-05-29
+Added
+* Added support for Worker's Route Delivery Manifest
+
+## [1.0.3](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.3) - 2023-06-05
+Added
+* Updated package.json to reference relative path
+* Updated utils.rb to require error classes
 
 ## [1.0.2](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.2) - 2023-05-19
 Added
@@ -18,11 +33,13 @@ Added
 * Included throttling constraints for 20 API requests per second using faraday-rate_limiter
 * Updated headers on initialization to allow for custom headers
 
-## [1.0.3](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.3) - 2023-06-05
+## [1.0.1](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.1) - 2023-05-12
 Added
-* Updated package.json to reference relative path
-* Updated utils.rb to require error classes
+* Refactored resources for module/class inheritance
 
-## [1.0.4](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.4) - 2024-05-29
+## [1.0.0](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.0) - 2023-05-11
 Added
-* Added support for Worker's Route Delivery Manifest
+* Initial release on RubyGems
+
+[Unreleased]: https://github.com/onfleet/ruby-onfleet/compare/v1.1.0...HEAD
+[1.0.0]: https://github.com/onfleet/ruby-onfleet/releases/tag/v1.1.0

data/Gemfile

@@ -1,11 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'faraday'
-gem 'faraday-net_http'
-gem 'faraday-rate_limiter'
-gem 'json'
-gem 'rspec'
-gem 'uri'
-gem 'webmock'
-
-gemspec
+gem "uri", "~> 1.0"
+gem "faraday"
+gem "faraday-net_http"
+gem "faraday-rate_limiter"
+gem "json"
+gem "rspec"
+gem "webmock"

data/README.es.md

@@ -86,6 +86,7 @@ Estas son las operaciones disponibles para cada endpoint:
 |[hubs](https://docs.onfleet.com/reference/hubs)|list()|create(body={})|update(id, body={})|x|
 |[organizations](https://docs.onfleet.com/reference/organizations)|get(delegateeId=nil)|x|insert_task(orgId, body={})|x|
 |[recipients](https://docs.onfleet.com/reference/recipients)|get(id)<br />get_by_name(name)<br />get_by_phone(phone)|create(body={})<br />match_metadata(body={})|update(id, body={})|x|
+|[routeplans](https://docs.onfleet.com/reference/routeplan#/) | get(id)<br />get(body={}) | create(body={}) | update(id, body={})<br />add_tasks_to_routeplan(id, body={}) | delete_one(id) |
 |[tasks](https://docs.onfleet.com/reference/tasks)|get(id)<br />list(queryParameters={})<br />get_by_short_id(shortId)|create(body={})<br />batch_create(body={})<br />batch_create_async(body={})<br />complete(id, body={})<br />clone(id)<br />auto_assign(body={})<br />match_metadata(body={})|update(id, body={})|delete(id)|
 |[teams](https://docs.onfleet.com/reference/teams)|get(id)<br />list()<br />driver_time_estimate(workerId, queryParameters={})<br />get_unassigned_tasks(id)|create(body={})<br />auto_dispatch(id, body={})|update(id, body={})<br />insert_task(teamId, body={})|delete(id)|
 |[webhooks](https://docs.onfleet.com/reference/webhooks)|list()|create(body={})|X|delete(id)|

data/README.md

@@ -84,6 +84,7 @@ Here are the operations available for each entity:
 |[hubs](https://docs.onfleet.com/reference/hubs)|list()|create(body={})|update(id, body={})|x|
 |[organizations](https://docs.onfleet.com/reference/organizations)|get(delegateeId=nil)|x|insert_task(orgId, body={})|x|
 |[recipients](https://docs.onfleet.com/reference/recipients)|get(id)<br />get_by_name(name)<br />get_by_phone(phone)|create(body={})<br />match_metadata(body={})|update(id, body={})|x|
+|[routeplans](https://docs.onfleet.com/reference/routeplan#/) | get(id)<br />get(body={}) | create(body={}) | update(id, body={})<br />add_tasks_to_routeplan(id, body={}) | delete_one(id) |
 |[tasks](https://docs.onfleet.com/reference/tasks)|get(id)<br />list(queryParameters={})<br />get_by_short_id(shortId)|create(body={})<br />batch_create(body={})<br />batch_create_async(body={})<br />complete(id, body={})<br />clone(id)<br />auto_assign(body={})<br />match_metadata(body={})|update(id, body={})|delete(id)|
 |[teams](https://docs.onfleet.com/reference/teams)|get(id)<br />list()<br />driver_time_estimate(workerId, queryParameters={})<br />get_unassigned_tasks(id)|create(body={})<br />auto_dispatch(id, body={})|update(id, body={})<br />insert_task(teamId, body={})|delete(id)|
 |[webhooks](https://docs.onfleet.com/reference/webhooks)|list()|create(body={})|X|delete(id)|

data/lib/onfleet.rb

@@ -10,6 +10,7 @@ require_relative './resources/destinations'
 require_relative './resources/hubs'
 require_relative './resources/organizations'
 require_relative './resources/recipients'
+require_relative './resources/routeplans'
 require_relative './resources/tasks'
 require_relative './resources/teams'
 require_relative './resources/webhooks'

data/lib/resources/destinations.rb

@@ -17,7 +17,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def match_metadata(config, body)
       method = 'post'
       path = 'destinations/metadata'

data/lib/resources/organizations.rb

@@ -17,7 +17,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def insert_task(config, org_id, body)
       method = 'put'
       path = "containers/organizations/#{org_id}"

data/lib/resources/recipients.rb

@@ -39,7 +39,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def match_metadata(config, body)
       method = 'post'
       path = 'recipients/metadata'

data/lib/resources/routeplans.rb

@@ -0,0 +1,53 @@
+require 'uri'
+
+require_relative '../onfleet'
+
+module Onfleet
+  class Routeplans
+    def create(config, body)
+      method = 'post'
+      path = 'routePlans'
+
+      Onfleet.request(config, method.to_sym, path, body.to_json)
+    end
+
+    def get(config, query_parameters_hash)
+      method = 'get'
+      # NOTE: parameters included here must be a hash object that is translated to URL query parameters
+      # The from parameter is the only required query parameter for this API call - must be formatted in Unix time.
+      query_parameters = URI.encode_www_form(query_parameters_hash)
+      path = "routePlans?#{query_parameters}"
+
+      Onfleet.request(config, method.to_sym, path)
+    end
+
+    def get_by_id(config, id)
+      method = 'get'
+      path = "routePlans/#{id}"
+
+      Onfleet.request(config, method.to_sym, path)
+    end
+
+    def update(config, id, body)
+      method = 'put'
+      path = "routePlans/#{id}"
+
+      Onfleet.request(config, method.to_sym, path, body.to_json)
+    end
+
+    def add_tasks_to_routeplan(config, id, body)
+        method = 'put'
+        path = "routePlans/#{id}/tasks"
+       
+        Onfleet.request(config, method.to_sym, path, body.to_json)
+    end
+
+    def delete_one(config, id)
+      method = 'delete'
+      path = "routePlans/#{id}"
+
+      Onfleet.request(config, method.to_sym, path)
+    end
+
+  end
+end

data/lib/resources/tasks.rb

@@ -15,7 +15,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def batch_create(config, body)
       method = 'post'
       path = 'tasks/batch'
@@ -23,7 +22,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def batch_create_async(config, body)
       method = 'post'
       path = 'tasks/batch-async'
@@ -62,7 +60,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def complete(config, id, body)
       method = 'post'
       path = "tasks/#{id}/complete"
@@ -84,7 +81,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def auto_assign(config, body)
       method = 'post'
       path = 'tasks/autoAssign'
@@ -92,7 +88,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def match_metadata(config, body)
       method = 'post'
       path = 'tasks/metadata'

data/lib/resources/teams.rb

@@ -41,7 +41,7 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
+
     def auto_dispatch(config, id, body)
       method = 'post'
       path = "teams/#{id}/dispatch"
@@ -49,7 +49,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def driver_time_estimate(config, worker_id, query_parameters_hash = nil)
       method = 'get'
 
@@ -63,15 +62,20 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
-    def get_unassigned_tasks(config, id)
+    # ACTION: still needs to be tested - need to include query_parameters
+    def get_unassigned_tasks(config, id, query_parameters_hash = nil)
       method = 'get'
-      path = "teams/#{id}/tasks"
+
+      # NOTE: parameters included here must be a hash object that is translated to URL query parameters
+      query_parameters = nil
+      if query_parameters_hash
+        query_parameters = URI.encode_www_form(query_parameters_hash)
+      end
+      path = "teams/#{id}/tasks?#{query_parameters}"
 
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def insert_task(config, team_id, body)
       method = 'put'
       path = "containers/teams/#{team_id}"

data/lib/resources/webhooks.rb

@@ -10,7 +10,7 @@ module Onfleet
   # Any failed requests will be retried in 30-minute cycles, up to one full day.
   # A failed request is any non-200 response that a webhook request gets from your application.
   class Webhooks
-    # ACTION: still needs to be tested
+    
     def create(config, body)
       method = 'post'
       path = 'webhooks'
@@ -18,7 +18,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def list(config)
       method = 'get'
       path = 'webhooks'
@@ -26,7 +25,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def delete(config, id)
       method = 'delete'
       path = "webhooks/#{id}"

data/lib/resources/workers.rb

@@ -51,7 +51,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path)
     end
 
-    # ACTION: still needs to be tested
     def get_by_location(config, longitude, latitude, radius = 1000)
       method = 'get'
       path = "workers/location?longitude=#{longitude}&latitude=#{latitude}&radius=#{radius}"
@@ -73,7 +72,7 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    def get_delivery_manifest(config, body, google_api_key, query_parameters_hash)
+    def get_delivery_manifest(config, body, google_api_key = nil, query_parameters_hash = nil)
       method = 'post'
       query_parameters = nil
       
@@ -89,7 +88,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def insert_task(config, worker_id, body)
       method = 'put'
       path = "containers/workers/#{worker_id}"
@@ -97,7 +95,6 @@ module Onfleet
       Onfleet.request(config, method.to_sym, path, body.to_json)
     end
 
-    # ACTION: still needs to be tested
     def match_metadata(config, body)
       method = 'post'
       path = 'workers/metadata'

data/lib/test/test_data.json

@@ -1997,9 +1997,9 @@
                 ]
             }
         },
-        "getManifestProvider": {
+        "get_delivery_manifest": {
             "request": {
-                "path": "providers/manifest/generate?hubId=<hubId>&workerId=<workerId>",
+                "path": "providers/manifest/generate?hubId=kyfYe*wyVbqfomP2HTn5dAe1&workerId=kBUZAb7pREtRn*8wIUCpjnPu",
                 "method": "GET"
             },
             "response": {

data/lib/test/test_onfleet.rb

@@ -15,6 +15,9 @@ require_relative '../resources/teams'
 require_relative '../resources/webhooks'
 require_relative '../resources/workers'
 
+# WebMock blocks HTTP requests in integration tests, but you can either stub the request or call WebMock.allow_net_connect! to configure the tests to run as normal.
+WebMock.allow_net_connect!
+
 # RSpec configuration setup for unit tests
 RSpec.configure do |config|
   file = File.read('./test_data.json')
@@ -22,7 +25,7 @@ RSpec.configure do |config|
   config.test_data = JSON.parse(file)
 
   config.add_setting :api_variables
-  config.api_variables = Onfleet::Configuration.new("f70dd381f0366c721677fb7e088b83bd","https://staging.onfleet.com/api/v2")
+  config.api_variables = Onfleet::Configuration.new("f70dd381f0366c721677fb7e088b83bd","https://stable1.onfleet.com/api/v2")
 end
 
 # Administrator entity tests

data/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@onfleet/ruby-onfleet",
-    "version": "1.0.4",
+    "version": "1.1.0",
     "description": "Onfleet's Ruby API wrapper package",
     "main": "onfleet.rb",
     "scripts": {

data/ruby-onfleet.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'ruby-onfleet'
-  s.version     = '1.0.4'
-  s.date        = '2024-06-10'
+  s.version     = '1.1.0'
+  s.date        = '2025-10-16'
   s.summary     = 'Onfleet Ruby API wrapper package'
   s.description = 'The Onfleet Ruby library provides convenient access to the Onfleet API.'
   s.authors     = ['Dan Menza']
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.add_dependency('faraday-net_http', '~> 3.1.0')
   s.add_dependency('faraday-rate_limiter', '~> 0.0.4')
   s.add_dependency('json', '~> 2.6.3')
-  s.add_dependency('uri', '~> 0.12.1')
+  s.add_dependency('uri', '~> 1.0')
 
   s.add_development_dependency('rspec', '~> 3.12.0')
   s.add_development_dependency('webmock', '~> 3.18.1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-onfleet
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Dan Menza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2025-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ files:
 - lib/resources/hubs.rb
 - lib/resources/organizations.rb
 - lib/resources/recipients.rb
+- lib/resources/routeplans.rb
 - lib/resources/tasks.rb
 - lib/resources/teams.rb
 - lib/resources/webhooks.rb
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Onfleet Ruby API wrapper package