versafleet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ddde324fb63af2273c9141dc2e0eb5e7125aac77ff4445c7bafa7d831a42e6
-  data.tar.gz: 102437b0f17c395bc7925a3f0f411a6b2ac8f06241564143e8ed01798be94bf4
+  metadata.gz: 61b2baeddbc3c2bc46e3b1db2f923466777d6dc4e482535908349405bcfdb266
+  data.tar.gz: d142bb0973d0684977dec5ebe9a9d3985d6b4c74504e4cc44af4392a7ce1de1e
 SHA512:
-  metadata.gz: 3bafe01ca74150bf2f02e8a6eb0f8f87b79aa28d72e63e5d444ecd92427dfc25688d7755ff3ed91a33cf648981af6ddf95fc115a8da41f0865c9529a0f148845
-  data.tar.gz: 5fc7fc2ff39a0bcfb76435d027a1ce5b9b132f8debf45db63798f6f0c6e93c8de452caa36c782dcbdf73bf57115fa358b4a60256f88c45d00423f4c93d0fed97
+  metadata.gz: eb8e9582b7e37eecda4031ab1a9de3451226c382528aba5d4281ea62a0da4283b76004c3d2994bfe7a888b81fe50b6f506a4ac9b6af8ef02cb0f7e85e2189ab7
+  data.tar.gz: faf0192a080f5c3379e36028210c17addaa675a81720b86d8b1fd8e8aeb235730fbc5dfc4c7d9d3055c4f657f9ab6590ef5b8b22360db766340fa3964c0bc4a6

data/Gemfile

@@ -1,12 +1,7 @@
-# frozen_string_literal: true
-
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in versafleet.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "minitest", "~> 5.0"
-
 gem "standard", "~> 1.3"

data/README.md

@@ -102,11 +102,56 @@ client.drivers.create(driver: {name: "Yolo", dob: "1990-09-09"})
 client.drivers.update(driver_id: driver_id, driver: {name: "Yolo update"})
 ```
 
+### Vehicles
+
+```ruby
+# list vehicles
+client.vehicles.list
+# get a vehicle details
+client.vehicles.retrieve(vehicle_id: vehicle_id)
+# create vehicle
+client.vehicles.create(vehicle: {plate_number: "SK1212", model: "Honda", speed: 50})
+# update vehicle
+client.vehicles.update(vehicle_id: vehicle_id, vehicle: {model: "Mercedes", speed: 70})
+```
+
+### Runsheets
+
+```ruby
+# list runsheets by driver
+client.runsheets.drivers_tasks(driver_id: driver_id)
+# filter runsheets by date
+client.runsheets.drivers_tasks(driver_id: driver_id, date: "2021-10-14")
+# filter by date and state of the tasks
+client.runsheets.drivers_tasks(driver_id: driver_id, date: "2021-10-14", state: "successful")
+```
+
+### Customers
+
+```ruby
+# list customers
+client.customers.list
+# get a customer details
+client.customers.retrieve(customer_id: customer_id)
+# create customer
+client.customers.create(customer: {name: "John Doe", email: "well@example.com"})
+# update customer
+client.customers.update(customer_id: customer_id, customer: {name: "Bourne"})
+```
+
 ## TO DO
 
 - [x] Add API Documentation ([#2](https://github.com/maful/versafleet-ruby/pull/2))
 - [ ] Add Docker support
 - [ ] Support to All VersaFleet API endpoints.
+	- [x] Add Jobs V2 API
+	- [x] Add Tasks API
+	- [ ] Non-Authenticated Tracking API
+	- [x] Add Runsheets API ([#5](https://github.com/maful/versafleet-ruby/pull/5))
+	- [x] Add Drivers API ([#1](https://github.com/maful/versafleet-ruby/pull/1))
+	- [x] Add Vehicles API ([#4](https://github.com/maful/versafleet-ruby/pull/4))
+	- [x] Add Customers API ([#6](https://github.com/maful/versafleet-ruby/pull/6))
+	- [ ] Add Account API
 
 ## 🙏 Contributing
 

data/lib/versafleet/client.rb

@@ -9,6 +9,9 @@ module Versafleet
     # @return [String] Gets the VersaFleet Secret Key
     attr_reader :client_secret
 
+    # @return [Symbol] Gets the Symbol key identifying a default Adapter to use
+    attr_reader :adapter
+
     # Initialize a new VersaFlet client
     #
     # == Example:
@@ -19,9 +22,13 @@ module Versafleet
     #
     # @param client_id [String] VersaFleet API Key
     # @param client_secret [String] VersaFleet Secret Key
-    def initialize(client_id:, client_secret:)
+    def initialize(client_id:, client_secret:, adapter: Faraday.default_adapter, stubs: nil)
       @client_id = client_id
       @client_secret = client_secret
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
     end
 
     # Jobs Resource instance
@@ -45,6 +52,27 @@ module Versafleet
       DriversResource.new(self)
     end
 
+    # Vehicles Resource instance
+    #
+    # @return [VehiclesResource]
+    def vehicles
+      VehiclesResource.new(self)
+    end
+
+    # Runsheets Resource instance
+    #
+    # @return [RunsheetsResource]
+    def runsheets
+      RunsheetsResource.new(self)
+    end
+
+    # Customers Resource instance
+    #
+    # @return [CustomersResource]
+    def customers
+      CustomersResource.new(self)
+    end
+
     # Initializes a new Faraday connection
     #
     # @return [Faraday::Connection]
@@ -53,7 +81,7 @@ module Versafleet
         conn.url_prefix = BASE_URL
         conn.request :json
         conn.response :json, content_type: "application/json"
-        conn.adapter Faraday.default_adapter
+        conn.adapter adapter, @stubs
       end
     end
 

data/lib/versafleet/objects/customer.rb

@@ -0,0 +1,4 @@
+module Versafleet
+  class Customer < Object
+  end
+end

data/lib/versafleet/objects/runsheet.rb

@@ -0,0 +1,4 @@
+module Versafleet
+  class Runsheet < Object
+  end
+end

data/lib/versafleet/objects/vehicle.rb

@@ -0,0 +1,4 @@
+module Versafleet
+  class Vehicle < Object
+  end
+end

data/lib/versafleet/resources/customers.rb

@@ -0,0 +1,67 @@
+module Versafleet
+  class CustomersResource < Resource
+    # List All Customers
+    #
+    # == Examples:
+    #
+    #   client.customers.list
+    #   # set per page to 20
+    #   client.customers.list(per_page: 20)
+    #   # move to page 2
+    #   client.customers.list(page: 2, per_page: 20)
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/customer-api/list-all-customers VersaFleet API}
+    #
+    # @param params [Hash] the filter query
+    # @return [Collection]
+    def list(**params)
+      response = get_request("customers", params: params)
+      Collection.from_response(response, key: "customers", type: Customer)
+    end
+
+    # Get Customer details
+    #
+    # == Example:
+    #
+    #   client.customers.retrieve(customer_id: 123)
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/customer-api/show-a-customer-detail VersaFleet API}
+    #
+    # @param customer_id [Integer|String] Customer ID or Customer GUID
+    # @return [Customer]
+    def retrieve(customer_id:)
+      Customer.new get_request("customers/#{customer_id}").body.dig("customer")
+    end
+
+    # Create a Customer
+    #
+    # == Example:
+    #
+    #   client.customers.create(customer: {name: "John Doe", email: "well@example.com"})
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/customer-api/create-a-customer-detail VersaFleet API}
+    #
+    # @param customer [Hash] Customer request payload
+    # @return [Customer]
+    def create(customer:)
+      payload = {customer: customer}
+      Customer.new post_request("customers", body: payload).body.dig("customer")
+    end
+
+    # Update Customer
+    #
+    # == Example:
+    #
+    #   client.customers.update(customer_id: 123, customer: {name: "Bourne"})
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/customer-api/update-a-customer-detail VersaFleet API}
+    #
+    # @param customer_id [Integer|String] Customer ID or Customer GUID
+    # @param customer [Hash] Customer request payload
+    # @return [Customer]
+    def update(customer_id:, customer:)
+      payload = {customer: customer}
+      Customer.new put_request("customers/#{customer_id}", body: payload).body.dig("customer")
+    end
+  end
+end

data/lib/versafleet/resources/jobs.rb

@@ -76,8 +76,7 @@ module Versafleet
     #
     # @param job_id [Integer] Job ID
     def cancel(job_id:)
-      # TODO: Remove Job object return
-      Job.new put_request("v2/jobs/#{job_id}/cancel", body: {}).body
+      put_request("v2/jobs/#{job_id}/cancel", body: {}).body
     end
 
     # List Tasks of Job

data/lib/versafleet/resources/runsheets.rb

@@ -0,0 +1,22 @@
+module Versafleet
+  class RunsheetsResource < Resource
+    # View Driver Info and related Tasks
+    #
+    # == Examples:
+    #
+    #   client.runsheets.drivers_tasks(driver_id: 1)
+    #   # filter runsheets by date
+    #   client.runsheets.drivers_tasks(driver_id: 1, date: "2021-10-14")
+    #   # filter by date and state of the tasks
+    #   client.runsheets.drivers_tasks(driver_id: 1, date: "2021-10-14", state: "successful")
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/runsheet-api/view-driver-info-and-related-tasks VersaFleet API}
+    #
+    # @param driver_id [Integer] Driver ID
+    # @param params [Hash] the filter query
+    # @return [Runsheet]
+    def drivers_tasks(driver_id:, **params)
+      Runsheet.new get_request("runsheets/drivers/#{driver_id}", params: params).body.dig("driver")
+    end
+  end
+end

data/lib/versafleet/resources/vehicles.rb

@@ -0,0 +1,67 @@
+module Versafleet
+  class VehiclesResource < Resource
+    # List All Vehicles
+    #
+    # == Examples:
+    #
+    #   client.vehicles.list
+    #   # set per page to 20
+    #   client.vehicles.list(per_page: 20)
+    #   # move to page 2
+    #   client.vehicles.list(page: 2, per_page: 20)
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/vehicles-api/list-all-vehicles VersaFleet API}
+    #
+    # @param params [Hash] the filter query
+    # @return [Collection]
+    def list(**params)
+      response = get_request("vehicles", params: params)
+      Collection.from_response(response, key: "vehicles", type: Vehicle)
+    end
+
+    # Get Vehicle details
+    #
+    # == Examples:
+    #
+    #   client.vehicles.retrieve(vehicle_id: 123)
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/vehicles-api/show-a-vehicle VersaFleet API}
+    #
+    # @param vehicle_id [Integer] Vehicle ID
+    # @return [Vehicle]
+    def retrieve(vehicle_id:)
+      Vehicle.new get_request("vehicles/#{vehicle_id}").body.dig("vehicle")
+    end
+
+    # Create a Vehicle
+    #
+    # == Examples:
+    #
+    #   client.vehicles.create(vehicle: {plate_number: "SK1212", model: "Honda", speed: 50})
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/vehicles-api/create-a-vehicle VersaFleet API}
+    #
+    # @param vehicle [Hash] Vehicle request payload
+    # @return [Vehicle]
+    def create(vehicle:)
+      payload = {vehicle: vehicle}
+      Vehicle.new post_request("vehicles", body: payload).body.dig("vehicle")
+    end
+
+    # Update Vehicle
+    #
+    # == Examples:
+    #
+    #   client.vehicles.update(vehicle_id: 123, vehicle: {model: "Mercedes", speed: 70})
+    #
+    # {https://versafleet.docs.apiary.io/#reference/0/vehicles-api/update-a-vehicle VersaFleet API}
+    #
+    # @param vehicle_id [Integer] Vehicle ID
+    # @param vehicle [Hash] Vehicle request payload
+    # @return [Vehicle]
+    def update(vehicle_id:, vehicle:)
+      payload = {vehicle: vehicle}
+      Vehicle.new put_request("vehicles/#{vehicle_id}", body: payload).body.dig("vehicle")
+    end
+  end
+end

data/lib/versafleet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Versafleet
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/versafleet.rb

@@ -13,9 +13,15 @@ module Versafleet
   autoload :JobsResource, "versafleet/resources/jobs"
   autoload :TasksResource, "versafleet/resources/tasks"
   autoload :DriversResource, "versafleet/resources/drivers"
+  autoload :VehiclesResource, "versafleet/resources/vehicles"
+  autoload :RunsheetsResource, "versafleet/resources/runsheets"
+  autoload :CustomersResource, "versafleet/resources/customers"
 
   # Classes used to return a nicer object wrapping the response data
   autoload :Job, "versafleet/objects/job"
   autoload :Task, "versafleet/objects/task"
   autoload :Driver, "versafleet/objects/driver"
+  autoload :Vehicle, "versafleet/objects/vehicle"
+  autoload :Runsheet, "versafleet/objects/runsheet"
+  autoload :Customer, "versafleet/objects/customer"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versafleet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Maful Prayoga A
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,13 +59,19 @@ files:
 - lib/versafleet/collection.rb
 - lib/versafleet/error.rb
 - lib/versafleet/object.rb
+- lib/versafleet/objects/customer.rb
 - lib/versafleet/objects/driver.rb
 - lib/versafleet/objects/job.rb
+- lib/versafleet/objects/runsheet.rb
 - lib/versafleet/objects/task.rb
+- lib/versafleet/objects/vehicle.rb
 - lib/versafleet/resource.rb
+- lib/versafleet/resources/customers.rb
 - lib/versafleet/resources/drivers.rb
 - lib/versafleet/resources/jobs.rb
+- lib/versafleet/resources/runsheets.rb
 - lib/versafleet/resources/tasks.rb
+- lib/versafleet/resources/vehicles.rb
 - lib/versafleet/version.rb
 - versafleet.gemspec
 homepage: https://versafleet.co