ruby-onfleet 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1429934d40b07829fc9b2e869ff4e56e0863150ed386e03fe55a0cd9c0ac8ae8
-  data.tar.gz: 8633c462b796a88063bc108e6f87b65c3bc63e5c6c8ee906719858e1fb62a9af
+  metadata.gz: 471ca6ebbd3bc9644207244c2b19d8d60ff9221e6c3e19a50e53e9e1411db11d
+  data.tar.gz: 5e7c98f994113bd8ce492770398868e786522630bd0b222d3a9d9fae986b47cc
 SHA512:
-  metadata.gz: f596880437d92765c5016c912ddbe6d5277d6a0cda1e0ad53e5f44ccf1d010f720aff669adfbbf177ae85aaa470372eb49b96a8e245123824fae9a3d0d88cb05
-  data.tar.gz: b218461e936100d35630c3d2a5e96aa36eafec2dc2ac21f5f23b18bc6fe9da4163cd90f934dfeda5c0e559a62cc29cf2f7ca5cc8ec6e0be5d24ead9d38796808
+  metadata.gz: 743882b728bfcdecd669d8d72799705a16dceaa89947c6eafaf83791d04913221f557e78abac56129f599c38f5ed434798854b3ea2ba1660b7acc355444d77ea
+  data.tar.gz: f276fe5e4e1c895c95cb78151dd8514a6e10a5a854efd5b4e5bb7704714e0d9e9625c98e7cb1a6b2904076e8e3e4f86468fe6d3dac15bad6a777cf34ac367a9c

data/CHANGELOG.md

@@ -21,4 +21,8 @@ Added
 ## [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
+* Updated utils.rb to require error classes
+
+## [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

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'faraday'
+gem 'faraday-net_http'
 gem 'faraday-rate_limiter'
 gem 'json'
 gem 'rspec'

data/README.es.md

@@ -89,7 +89,7 @@ Estas son las operaciones disponibles para cada endpoint:
 |[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)|
-|[workers](https://docs.onfleet.com/reference/workers)|get(id=nil, queryParameters={})<br />get_tasks(id)<br />get_by_location(longitude, latitude, radius)<br />get_schedule(id)|create(body={})<br />set_schedule(id, body={})<br />match_metadata(body={})|update(id, body={})<br />insert_task(id, body={})|delete(id)|
+|[workers](https://docs.onfleet.com/reference/workers)|get(id=nil, queryParameters={})<br />get_tasks(id)<br />get_by_location(longitude, latitude, radius)<br />get_schedule(id)|create(body={})<br />set_schedule(id, body={})<br />match_metadata(body={})<br />get_delivery_manifest(body={}, googleApiKey, queryParameters={})|update(id, body={})<br />insert_task(id, body={})|delete(id)|
 
 ### **Peticiones GET**
 Para obtener todos los objetos de entidad dentro de un endpoint, use `list`:
@@ -176,6 +176,17 @@ workers = Onfleet::Workers.new
 workers.create(config, body)
 ```
 
+Examples of `get_delivery_manifest()`:
+```
+body = {
+  "path": "providers/manifest/generate?hubId=<workerId>&workerId=<workerId>",
+  "method": "GET"
+}
+
+workers = Onfleet::Workers.new
+workers.create(config, body, 'google_api_key', queryParameters={'startDate': '1455072025000', 'endDate': '1455072025000'})
+```
+
 Las solicitudes POST extendidas incluyen clon, batch_create, auto_assign en el endpoint de las tareas; set_schedule en el endpoint de los trabajadores; y auto_dispatch en el endpoint de los equipos. A continuación, se muestran ejemplos de estos endpoints:
 
 ```
@@ -186,12 +197,13 @@ tasks.auto_assign(config, body)
 
 workers = Onfleet::Workers.new
 workers.set_schedule(config, 'id', body)
+workers.get_delivery_manfiest(config, body, 'google_api_key', queryParameters={})
 
 teams = Onfleet::Teams.new
 teams.auto_dispatch(config, 'id', body)
 ```
 
-Para más detalles, consulte nuestra documentación en [clone](https://docs.onfleet.com/reference#clone-task), [batch_create](https://docs.onfleet.com/reference#create-tasks-in-batch), [auto_assign](https://docs.onfleet.com/reference#automatically-assign-list-of-tasks), [set_schedule](https://docs.onfleet.com/reference#set-workers-schedule), y [auto_dispatch](https://docs.onfleet.com/reference#team-auto-dispatch).
+Para más detalles, consulte nuestra documentación en [clone](https://docs.onfleet.com/reference#clone-task), [batch_create](https://docs.onfleet.com/reference#create-tasks-in-batch), [auto_assign](https://docs.onfleet.com/reference#automatically-assign-list-of-tasks), [set_schedule](https://docs.onfleet.com/reference#set-workers-schedule), [get_delivery_manifest](https://docs.onfleet.com/reference/delivery-manifest) y [auto_dispatch](https://docs.onfleet.com/reference#team-auto-dispatch).
 
 ### **Peticiones PUT**
 Para actualizar un objeto de entidad dentro de un endpoint:

data/README.md

@@ -87,7 +87,7 @@ Here are the operations available for each entity:
 |[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)|
-|[workers](https://docs.onfleet.com/reference/workers)|get(id=nil, queryParameters={})<br />get_tasks(id)<br />get_by_location(longitude, latitude, radius)<br />get_schedule(id)|create(body={})<br />set_schedule(id, body={})<br />match_metadata(body={})|update(id, body={})<br />insert_task(id, body={})|delete(id)|
+|[workers](https://docs.onfleet.com/reference/workers)|get(id=nil, queryParameters={})<br />get_tasks(id)<br />get_by_location(longitude, latitude, radius)<br />get_schedule(id)|create(body={})<br />set_schedule(id, body={})<br />match_metadata(body={})<br />get_delivery_manifest(body={}, googleApiKey, queryParameters={})|update(id, body={})<br />insert_task(id, body={})|delete(id)|
 
 ### **GET Requests**
 To get all the entity objects within an endpoint use `list`:
@@ -174,6 +174,17 @@ workers = Onfleet::Workers.new
 workers.create(config, body)
 ```
 
+Examples of `get_delivery_manifest()`:
+```
+body = {
+  "path": "providers/manifest/generate?hubId=<workerId>&workerId=<workerId>",
+  "method": "GET"
+}
+
+workers = Onfleet::Workers.new
+workers.create(config, body, 'google_api_key', queryParameters={'startDate': '1455072025000', 'endDate': '1455072025000'})
+```
+
 Extended POST requests include clone, batch_create, auto_assign on the tasks endpoint; set_schedule on the workers endpoint; and auto_dispatch on the teams endpoint. Examples of these endpoints are below:
 
 ```
@@ -184,12 +195,13 @@ tasks.auto_assign(config, body)
 
 workers = Onfleet::Workers.new
 workers.set_schedule(config, 'id', body)
+workers.get_delivery_manfiest(config, body, 'google_api_key', queryParameters={})
 
 teams = Onfleet::Teams.new
 teams.auto_dispatch(config, 'id', body)
 ```
 
-For more details, check our documentation on [clone](https://docs.onfleet.com/reference#clone-task), [batch_create](https://docs.onfleet.com/reference#create-tasks-in-batch), [auto_assign](https://docs.onfleet.com/reference#automatically-assign-list-of-tasks), [set_schedule](https://docs.onfleet.com/reference#set-workers-schedule), and [auto_dispatch](https://docs.onfleet.com/reference#team-auto-dispatch).
+For more details, check our documentation on [clone](https://docs.onfleet.com/reference#clone-task), [batch_create](https://docs.onfleet.com/reference#create-tasks-in-batch), [auto_assign](https://docs.onfleet.com/reference#automatically-assign-list-of-tasks), [set_schedule](https://docs.onfleet.com/reference#set-workers-schedule), [get_delivery_manifest](https://docs.onfleet.com/reference/delivery-manifest) and [auto_dispatch](https://docs.onfleet.com/reference#team-auto-dispatch).
 
 ### **PUT Requests**
 To update an entity object within an endpoint:

data/lib/resources/workers.rb

@@ -73,6 +73,22 @@ 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)
+      method = 'post'
+      query_parameters = nil
+      
+      if google_api_key
+        config.headers['X-Api-Key'] = "Google #{google_api_key}"
+      end
+      
+      if query_parameters_hash
+        query_parameters = URI.encode_www_form(query_parameters_hash)
+      end
+      path = "integrations/marketplace?#{query_parameters}"
+
+      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'

data/lib/test/test_data.json

@@ -1996,6 +1996,49 @@
                     }
                 ]
             }
+        },
+        "getManifestProvider": {
+            "request": {
+                "path": "providers/manifest/generate?hubId=<hubId>&workerId=<workerId>",
+                "method": "GET"
+            },
+            "response": {
+                "manifestDate": 1694199600000,
+                "departureTime": 1694199600000,
+                "driver": {
+                "name": "Test One",
+                "phone": "+16265555768"
+                },
+                "vehicle": {
+                "type": "CAR",
+                "description": "Honda",
+                "licensePlate": "12345687",
+                "color": "Purple",
+                "timeLastModified": 1692746334342
+                },
+                "hubAddress": "1111 South Figueroa Street, Los Angeles, California 90015",
+                "turnByTurn": [
+                    {
+                    "start_address": "1403 W Pico Blvd, Los Angeles, CA 90015, USA",
+                    "end_address": "2695 E Katella Ave, Anaheim, CA 92806, USA",
+                    "eta": 1692992466000,
+                    "driving_distance": "30.6 mi",
+                        "steps": [
+                            "Head southeast on 12th St E toward S Figueroa StPartial restricted usage road",
+                            "Turn right onto Flower St",
+                            "Turn left onto the Interstate 10 E ramp to 18th St",
+                            "Merge onto I-10 E",
+                            "Take the exit onto I-5 S toward Santa Ana",
+                            "Take exit 109A for Katella Ave",
+                            "Turn right onto E Katella AvePass by Comerica Bank (on the right in 1.3 mi)",
+                            "Turn left onto S Douglass Rd",
+                            "Turn right onto Stanley Cup Wy",
+                            "Turn right"
+                        ]
+                    }
+                ],
+                "totalDistance": null
+            }
         }
     }
 }

data/lib/test/test_onfleet.rb

@@ -1004,4 +1004,30 @@ describe Onfleet::Workers do
     expect(response.status).to eq 200
     expect(response.body).to include('entries')
   end
+
+  it 'can get Delivery Manifest by calling POST /integrations/marketplace' do
+    # request data
+    config = RSpec.configuration.api_variables
+    request_data = RSpec.configuration.test_data['workers']['get_delivery_manifest']['request']
+    path = "integrations/marketplace"
+    method = 'post'
+    headers = {}
+    headers['Content-Type'] = 'application/json'
+    headers['User-Agent'] = '@onfleet/ruby-onfleet-1.0'
+    headers['X-Api-Key'] = 'Google <google_api_key>'
+
+    # response data
+    response_data = RSpec.configuration.test_data['workers']['get_delivery_manifest']['response']
+
+    stub_request(method.to_sym, "#{config.base_url}/#{path}")
+      .with(basic_auth: [config.api_key, config.api_key], body: request_data, headers: headers)
+      .to_return(status: 200, body: response_data.to_json)
+
+    worker = Onfleet::Workers.new
+    response = worker.get_delivery_manifest(config, request_data, 'google_api_key', queryParameters={'startDate': '1455072025000', 'endDate': '1455072025000'})
+
+    expect(response.status).to eq 200
+    expect(response.body).to include('manifestDate')
+    expect(response.body).to include('turnByTurn')
+  end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@onfleet/ruby-onfleet",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "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.3'
-  s.date        = '2023-06-05'
+  s.version     = '1.0.4'
+  s.date        = '2024-06-10'
   s.summary     = 'Onfleet Ruby API wrapper package'
   s.description = 'The Onfleet Ruby library provides convenient access to the Onfleet API.'
   s.authors     = ['Dan Menza']
@@ -10,7 +10,8 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
   s.metadata    = { 'source_code_uri' => 'https://github.com/onfleet/ruby-onfleet' }
 
-  s.add_dependency('faraday', '~> 1.10.0')
+  s.add_dependency('faraday', '~> 2.9.0')
+  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')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-onfleet
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Dan Menza
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: faraday-rate_limiter
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +148,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/onfleet/ruby-onfleet
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Onfleet Ruby API wrapper package
 test_files: []