ruby-onfleet 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b3ca51aa521753c2c0d1e01e9153b5f0832e816c43c58f961db70c350673a8
-  data.tar.gz: 710bd72926af800c3e94350b2e674d35bb6cae9b9f92578a74a5e73eade6f4c4
+  metadata.gz: c913c4264901921e84ce53f8e1c24fbf755e62c69e2586309cc3eead7737a61d
+  data.tar.gz: f15218f9c46109307e8ee636721f6a0fe9bc5eba722c417bc3cd18daf0fb06d8
 SHA512:
-  metadata.gz: db1cfbddb4dbfe16e1b553f0c2c9e56abe23057f6ed73b25c3dacb6092005e8f9f7ad26f1fba501bb2aff8a982c7b2f479725dfe64e7f5debf01b2a9baa3f9ac
-  data.tar.gz: 6da180895c137aaa8fcb91628f49c65f06dd89ed0067c94e84ecec69d322cbbf8aec8832817dd12d78ecea41d92d14a7e4918ea276e54ef911fd65ab76b37300
+  metadata.gz: cfa7bdec5b10a83926a11215762f8dfa737007aa5f8ccd2e38d8106eeb529c71999edad46bc247a1332a88a6107af555852cd43ceeeaca01f8d6a0465f31007b
+  data.tar.gz: a67e5e08c0af7b704a06bed80272db30b9de42c50c52ae5a9242669b133b737b65f0703fbe0523fcbfeaf6a1808482995783054ca029222ca3e437d428b1d9ac

data/CHANGELOG.md

@@ -10,4 +10,10 @@ Added
 
 ## [1.0.1](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.1) - 2023-05-12
 Added
-* Refactored resources for module/class inheritance
+* Refactored resources for module/class inheritance
+
+## [1.0.2](https://github.com/onfleet/ruby-onfleet/releases/tag/v1.0.2) - 2023-05-19
+Added
+* Added README support for spanish
+* Included throttling constraints for 20 API requests per second using faraday-rate_limiter
+* Updated headers on initialization to allow for custom headers

data/Gemfile

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

data/README.es.md

@@ -0,0 +1,242 @@
+# Onfleet Ruby Wrapper
+
+> *Consulta este documento en otro idioma*:  
+> [English](https://github.com/onfleet/ruby-onfleet/blob/main/README.md)  
+
+Los invitamos a visitar nuestra publicación sobre el [proyecto de librerías para la API](https://onfleet.com/blog/api-wrappers-explained/) para conocer más sobre nuestras iniciativas.  
+En caso de preguntas, pueden contactarnos a través de un issue [aquí](https://github.com/onfleet/pyonfleet/issues) o escribirnos a support@onfleet.com.
+
+## Tabla de contenidos
+- [Onfleet Ruby Wrapper](#onfleet-ruby-wrapper)
+  - [Tabla de contenidos](#tabla-de-contenidos)
+  - [Sinopsis](#sinopsis)
+  - [Instalación](#instalación)
+  - [Requirements](#requirements)
+  - [Uso](#uso)
+    - [Autenticación](#autenticación)
+    - [Límites](#límites)
+    - [Operaciones CRUD soportadas](#operaciones-crud-soportadas)
+    - [Ejemplos de cómo utilizar las operaciones CRUD](#ejemplos-de-cómo-utilizar-las-operaciones-crud)
+  - [Errors](#errors)
+
+## Sinopsis
+La librería en Ruby de Onfleet nos permite un acceso fácil y cómodo a la API de Onfleet.
+
+## Instalación
+```
+gem install ruby-onfleet
+```
+
+# Requirements
+Puede encontrar una lista de las gemas de paquetes necesarias para instalar en el [Gemfile](#https://github.com/onfleet/ruby-onfleet/blob/main/gemfile).
+
+## Uso
+Antes de usar la librería, es indispensable obtener una llave para la API a través de alguno de los administradores de la organización a la que pertenecemos.
+
+La creación e integración de llaves se realiza a través del [panel principal de Onfleet](https://onfleet.com/dashboard#/manage).
+
+Para utilizar la librería sólo tenemos que crear uns instancia de `Onfleet` usando la llave:
+```
+config = Onfleet::Configuration.new("API_KEY")
+```
+
+Se pueden incluir dos parámetros opcionales al inicializar el módulo Onfleet - `base_url` y `headers`. 
+Si está ejecutando pruebas en el entorno sandbox, lo siguiente `base_url` debe ser definido - "https://staging.onfleet.com/api/v2". De lo contrario, la producción será la predeterminada.
+
+Los encabezados predeterminados requeridos se establecen en la inicialización de su configuración. También recomendamos incluir el siguiente encabezado personalizado para ayudarnos a identificar el tráfico de origen:
+
+```
+headers = {
+  "X-Onfleet-Organization": "ORGANIZATION_NAME-onfleet"
+}
+
+config = Onfleet::Configuration.new("API_KEY", "https://staging.onfleet.com/api/v2", headers)
+```
+
+Será necesario pasar una instancia de `Onfleet config` como argumento a cualquier llamada API posterior que contenga sus configuraciones.
+
+### Autenticación
+Cada solicitud de API a la plataforma Onfleet se autentica mediante autenticación básica. Al inicializar el objeto `Onfleet`, se ejecutará una prueba para validar sus credenciales de API con el siguiente método:
+
+```
+Onfleet.validate_authentication(@base_url, @api_key)
+```
+
+Si tiene éxito, esta variable se establecerá con su instancia `Onfleet`:
+
+```
+onfleet.auth_validated = true
+```
+
+De lo contrario, se generará un error o este valor será igual a `false` si no se realiza correctamente.
+
+### Límites
+La API impone un límite de 20 peticiones por segundo entre todas las peticiones de todas las llaves de la organización. Más detalles [aquí](https://docs.onfleet.com/reference/throttling).
+
+La librería también implementa un limitador para prevenir excesos accidentales de los límites y, eventualmente, posibles sanciones.
+
+### Operaciones CRUD soportadas
+Estas son las operaciones disponibles para cada endpoint:
+
+| Entidad | GET | POST | PUT | DELETE |
+| :-: | :-: | :-: | :-: | :-: |
+|[administrators](https://docs.onfleet.com/reference/administrators)|list()|create()|update(id, body={})|delete(id)|
+|[containers](https://docs.onfleet.com/reference/containers)|get('workers', id)<br />get('teams', id)<br />get('organizations', id)|x|update_tasks(workerId, body={})|x|
+|[destinations](https://docs.onfleet.com/reference/destinations)|get(id)|create(body={})<br />match_metadata(body={})|x|x|
+|[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|
+|[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)|
+
+### **Peticiones GET**
+Para obtener todos los objetos de entidad dentro de un endpoint, use `list`:
+
+```
+list()
+```
+
+Ejemplos de `list()`:
+
+```
+tasks = Onfleet::Tasks.new
+tasks.list(config)
+tasks.list(config, queryParameters{})
+```
+
+Opcionalmente, puede enviar un hash de parámetros de consulta para ciertos endpoints. El hash de Ruby se codificará en parámetros de consulta de URL utilizando la gema `uri`. Referirse de nuevo a [API documentation](https://docs.onfleet.com/) para endpoints que admiten parámetros de consulta.
+
+```
+tasks = Onfleet::Tasks.new
+tasks.list(config, queryParameters={'from': '1455072025000', 'state': '1, 2, 3'})
+```
+
+Para obtener un objeto de entidad dentro de un endpoint, especifique un `entity id`:
+
+```
+# obtener ejemplos con la búsqueda de entityId
+tasks = Onfleet::Tasks.new
+tasks.get(config, 'taskId')
+
+recipients = Onfleet::Recipients.new
+recipients.get(config, 'workerId')
+```
+
+Junto con la búsqueda de un objeto de entidad con un `id` asociado, los siguientes parámetros de consulta también están disponibles en un grupo selecto de endpoints:
+
+* `queryParameters` (hash)
+* `name`
+* `entity`
+* `phone`
+* `shortId`
+
+```
+# obtener ejemplos con argumentos adicionales
+workers = Onfleet::Workers.new
+workers.get(config, 'workerId', queryParameters={'analytics': 'true'})
+
+containers = Onfleet::Containers.new
+containers.get(config, 'workers', 'workerId')
+containers.get(config, 'teams', 'teamId')
+containers.get(config, 'organizations', 'organizationId')
+```
+
+Para obtener un controlador por ubicación, utilice el método `get_by_location`:
+```
+workers = Onfleet::Workers.new
+worker.get_by_location(config, 'longitude_value', 'latitude_value', 'radius_value')
+```
+El valor predeterminado del `radius` es 1000 metros si no se proporciona como argumento.
+
+### **Peticiones POST**
+Para crear un objeto de entidad dentro de un endpoint:
+```
+.create(config, body={})
+```
+
+Ejemplos de `create()`:
+```
+body = {
+  "name": "A Swartz",
+  "phone": "617-342-8853",
+  "teams": [
+    "nz1nG1Hpx9EHjQCJsT2VAs~o"
+  ],
+  "vehicle": {
+    "type": "CAR",
+    "description": "Tesla Model 3",
+    "licensePlate": "FKNS9A",
+    "color": "purple"
+  }
+}
+
+workers = Onfleet::Workers.new
+workers.create(config, body)
+```
+
+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:
+
+```
+tasks = Onfleet::Tasks.new
+tasks.clone(config, 'id')
+tasks.batch_create(config, body)
+tasks.auto_assign(config, body)
+
+workers = Onfleet::Workers.new
+workers.set_schedule(config, 'id', body)
+
+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).
+
+### **Peticiones PUT**
+Para actualizar un objeto de entidad dentro de un endpoint:
+```
+.update(config, entityId, 'body')
+```
+Ejemplos de `update()`:
+```
+body = {
+  "name": "Laura P",
+  "teams": [
+    "lHCUJFvh6v0YDURKjokZbvau"
+  ]
+}
+
+workers = Onfleet::Workers.new
+workers.update(config, 'workerId', body)
+```
+
+Ejemplos de `insert_task()`:
+```
+workers = Onfleet::Workers.new
+workers.insert_task(config, 'taskId', body)
+```
+
+### **Peticiones DELETE**
+Para eliminar un objeto de entidad dentro de un endpoint:
+```
+.delete(config, id)
+```
+
+Ejemplos de `delete()`:
+```
+workers = Onfleet::Workers.new
+workers.delete(config, id)
+```
+
+## Errors
+Se pueden producir los siguientes tipos de errores:
+1. errores HTTP
+2. errores de permisos
+3. errores de límite de velocidad
+4. errores de servicio
+5. errores de validación
+
+Actualmente, solo las clases `PermissionError`, `HttpError` y `ServiceError` están en uso según `status` de la API devuelto por la API de Onfleet. Este paquete maneja los errores de API devueltos en el método `handle_api_error` en el archivo `utils.rb`.
+
+*Ir al [inicio](#onfleet-ruby-wrapper)*.

data/README.md

@@ -1,4 +1,8 @@
 # ruby-onfleet
+
+> *Consulta este documento en otro idioma*:  
+> [Español](https://github.com/onfleet/ruby-onfleet/blob/main/README.es.md)  
+
 Visit our blog post on the [API wrapper project](https://onfleet.com/blog/api-wrappers-explained/) to learn more about our initiatives. If you have any questions, please reach us by submitting an issue [here](https://github.com/onfleet/ruby-onfleet/issues) or contact support@onfleet.com.
 
 ## Table of Contents
@@ -29,15 +33,22 @@ Before using the API wrapper, you will need to obtain an API key from one of you
 
 Creation and integration of API keys are performed through the [Onfleet dashboard](https://onfleet.com/dashboard#/manage).
 
-To start utilizing the library, you simply need to create an `Onfleet` object with your API key:
+To start utilizing the library, you simply need to create an `Onfleet` object and set your `Configuration` with your API key:
 ```
-config = Onfleet.new("YOUR_API_KEY")
+config = Onfleet::Configuration.new("API_KEY")
 ```
 
-An optional `base_url` can be included as a 2nd query parameter when initializing the Onfleet class if running testing in the sandbox environment - "https://staging.onfleet.com/api/v2". Otherwise, production will be the default.
+Two optional parameters can be included when initializing the Onfleet module - `base_url` and `headers`. 
+If you are running testing in the sandbox environment, the following `base_url` should be defined - "https://staging.onfleet.com/api/v2". Otherwise, production will be the default.
+
+The required default headers are set on your configuration initialization. We also recommend including the following custom header to help us identify source traffic:
 
 ```
-config = Onfleet.new("YOUR_API_KEY", "https://staging.onfleet.com/api/v2")
+headers = {
+  "X-Onfleet-Organization": "ORGANIZATION_NAME-onfleet"
+}
+
+config = Onfleet::Configuration.new("API_KEY", "https://staging.onfleet.com/api/v2", headers)
 ```
 
 An `Onfleet config` instance will need to be passed as an argument to any subsequent API calls that will contain your configurations.
@@ -52,7 +63,7 @@ Onfleet.validate_authentication(@base_url, @api_key)
 If successful, this variable will be set with your `Onfleet` instance:
 
 ```
-onfleet_instance.auth_validated = true
+onfleet.auth_validated = true
 ```
 
 Otherwise, an error will be raised or this value would equal `false` if unsuccessful.
@@ -65,18 +76,18 @@ We have also implemented a limiter on this library to avoid you from unintention
 ## Supported CRUD Operations
 Here are the operations available for each entity:
 
-|Entity|GET|POST|PUT|DELETE|
-|----|----|----|----|----|
-|administrators|list()|create()|update(id, body={})|delete(id)|
-|containers|get('workers', id), get('teams', id), get('organizations', id)|x|update_task(workerId, body={})|x|
-|destinations|get(id)|create(body={}), match_metadata(body={})|x|x|
-|hubs|list()|create(body={})|update(id, body={})|x|
-|organizations|get(delegateeId=nil)|x|insert_task(orgId, body={})|x|
-|recipients|get(id), get_by_name(name), get_by_phone(phone)|create(body={}), match_metadata(body={})|update(id, body={})|x|
-|tasks|get(id), list(queryParameters={}), get_by_short_id(shortId)|create(body={}), batch_create(body={}), batch_create_async(body={}), complete(id, body={}), clone(id), auto_assign(body={}), match_metadata(body={})|update(id, body={})|delete(id)|
-|teams|get(id), list(), driver_time_estimate(workerId, queryParameters={}), get_unassigned_tasks(id)|create(body={}), auto_dispatch(id, body={})|update(id, body={}), insert_task(teamId, body={})|delete(id)|
-|webhooks|list()|create(body={})|X|delete(id)|
-|workers|get(id=nil, queryParameters={}), get_tasks(id), get_by_location(longitude, latitude, radius), get_schedule(id)|create(body={}), set_schedule(id, body={}), match_metadata(body={})|update(id, body={}), insert_task(id, body={})|delete(id)|
+| Entity | GET | POST | PUT | DELETE |
+| :-: | :-: | :-: | :-: | :-: |
+|[administrators](https://docs.onfleet.com/reference/administrators)|list()|create()|update(id, body={})|delete(id)|
+|[containers](https://docs.onfleet.com/reference/containers)|get('workers', id)<br />get('teams', id)<br />get('organizations', id)|x|update_tasks(workerId, body={})|x|
+|[destinations](https://docs.onfleet.com/reference/destinations)|get(id)|create(body={})<br />match_metadata(body={})|x|x|
+|[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|
+|[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)|
 
 ### **GET Requests**
 To get all the entity objects within an endpoint use `list`:
@@ -88,13 +99,15 @@ list()
 Examples of `list()`:
 
 ```
+tasks = Onfleet::Tasks.new
 tasks.list(config)
 tasks.list(config, queryParameters{})
 ```
 
-Optionally you can send a hash of query parameters for certain endpoints. The Ruby hash will be encoded to url query parameters using the `uri` gem. to Refer back to [API documentation](https://docs.onfleet.com/) for endpoints that support query parameters.
+Optionally you can send a hash of query parameters for certain endpoints. The Ruby hash will be encoded to url query parameters using the `uri` gem. Refer back to [API documentation](https://docs.onfleet.com/) for endpoints that support query parameters.
 
 ```
+tasks = Onfleet::Tasks.new
 tasks.list(config, queryParameters={'from': '1455072025000', 'state': '1, 2, 3'})
 ```
 
@@ -102,7 +115,10 @@ To get one entity object within an endpoint, specify the an `entity id`:
 
 ```
 # get examples with entityId lookup
+tasks = Onfleet::Tasks.new
 tasks.get(config, 'taskId')
+
+recipients = Onfleet::Recipients.new
 recipients.get(config, 'workerId')
 ```
 
@@ -116,8 +132,10 @@ Along with searching for an entity object with an associated `id`, the following
 
 ```
 # get examples with additional arguments
+workers = Onfleet::Workers.new
 workers.get(config, 'workerId', queryParameters={'analytics': 'true'})
 
+containers = Onfleet::Containers.new
 containers.get(config, 'workers', 'workerId')
 containers.get(config, 'teams', 'teamId')
 containers.get(config, 'organizations', 'organizationId')
@@ -125,6 +143,7 @@ containers.get(config, 'organizations', 'organizationId')
 
 To get a driver by location, use the `get_by_location` method:
 ```
+workers = Onfleet::Workers.new
 worker.get_by_location(config, 'longitude_value', 'latitude_value', 'radius_value')
 ```
 The `radius` value defaults to 1000 meters if not provided as an argument.
@@ -151,18 +170,22 @@ body = {
   }
 }
 
+workers = Onfleet::Workers.new
 workers.create(config, body)
 ```
 
 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:
 
 ```
+tasks = Onfleet::Tasks.new
 tasks.clone(config, 'id')
 tasks.batch_create(config, body)
 tasks.auto_assign(config, body)
 
+workers = Onfleet::Workers.new
 workers.set_schedule(config, 'id', body)
 
+teams = Onfleet::Teams.new
 teams.auto_dispatch(config, 'id', body)
 ```
 
@@ -182,11 +205,13 @@ body = {
   ]
 }
 
+workers = Onfleet::Workers.new
 workers.update(config, 'workerId', body)
 ```
 
 Examples of `insert_task()`:
 ```
+workers = Onfleet::Workers.new
 workers.insert_task(config, 'taskId', body)
 ```
 
@@ -198,6 +223,7 @@ To delete an entity object within an endpoint:
 
 Examples of `delete()`:
 ```
+workers = Onfleet::Workers.new
 workers.delete(config, id)
 ```
 

data/lib/configuration.rb

@@ -2,9 +2,9 @@ require 'json'
 
 module Onfleet
   class Configuration
-    attr_reader :default_timeout, :api_key, :base_url, :version, :name
+    attr_reader :default_timeout, :api_key, :base_url, :headers, :version, :name
 
-    def initialize(api_key, base_url = nil)
+    def initialize(api_key, base_url = nil, headers = {})
       file = File.read('/Users/danmenza/onfleet/code/api_wrappers/ruby-onfleet/package.json')
       package_data = JSON.parse(file)
 
@@ -17,6 +17,11 @@ module Onfleet
       @version = package_data['version']
       @name = package_data['name']
 
+      # Default headers included in all API requests
+      headers['Content-Type'] = 'application/json'
+      headers['User-Agent'] = "#{@name}-#{@version}"
+      @headers = headers
+
       @auth_validated = Onfleet.validate_authentication(@base_url, @api_key)
     end
   end

data/lib/utils.rb

@@ -1,16 +1,21 @@
 require 'faraday'
+require 'faraday-rate_limiter'
 
 module Onfleet
-  def self.request(config, method, path, body = nil, headers = {})
+  def self.request(config, method, path, body = nil)
     response = nil
-    headers['Content-Type'] = 'application/json'
-    headers['User-Agent'] = "#{config.name}-#{config.version}"
-    request = Faraday.new
     url = "#{config.base_url}/#{path}"
 
+    # throttling configuration to match rate limiting enforced by the API
+    request = Faraday.new do |r|
+      # allow up to 20 API requests per second
+      r.request :rate_limiter, interval: 0.05
+      r.adapter :net_http
+    end
+
     begin
       request.set_basic_auth(config.api_key, config.api_key)
-      response = request.run_request(method, url, body, headers)
+      response = request.run_request(method, url, body, config.headers)
       handle_api_error(response)
     rescue Faraday::Response::RaiseError => e
       raise HttpError, "Received the following error when making HTTP request: #{e}"

data/package.json

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

data/ruby-onfleet.gemspec

@@ -1,15 +1,19 @@
 Gem::Specification.new do |s|
   s.name        = 'ruby-onfleet'
-  s.version     = '1.0.1'
-  s.date        = '2023-05-11'
+  s.version     = '1.0.2'
+  s.date        = '2023-05-19'
   s.summary     = 'Onfleet Ruby API wrapper package'
   s.description = 'The Onfleet Ruby library provides convenient access to the Onfleet API.'
   s.authors     = ['Dan Menza']
-  s.email       = 'dmenza@onfleet.com'
+  s.email       = 'support@onfleet.com'
   s.homepage    = 'https://rubygems.org/gems/ruby-onfleet'
   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-rate_limiter', '~> 0.0.4')
+  s.add_dependency('json', '~> 2.6.3')
+  s.add_dependency('uri', '~> 0.12.1')
 
   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.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Dan Menza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: faraday-rate_limiter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.18.1
 description: The Onfleet Ruby library provides convenient access to the Onfleet API.
-email: dmenza@onfleet.com
+email: support@onfleet.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,6 +104,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- README.es.md
 - README.md
 - lib/configuration.rb
 - lib/errors/http_error.rb
@@ -89,7 +132,8 @@ files:
 homepage: https://rubygems.org/gems/ruby-onfleet
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/onfleet/ruby-onfleet
 post_install_message:
 rdoc_options: []
 require_paths: