Skip to content

Add Drivers API #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,19 @@ client.tasks.completion_histories(task_id: task_id)
client.tasks.base_completion_histories(task_id: task_id)
```

### Tasks

```ruby
# list drivers
client.drivers.list
# get a driver details
client.drivers.retrieve(driver_id: driver_id)
# create driver
client.drivers.create(driver: {name: "Yolo", dob: "1990-09-09"})
# update driver
client.drivers.update(driver_id: driver_id, driver: {name: "Yolo update"})
```

## TO DO

- [ ] Add API Documentation
Expand Down
2 changes: 2 additions & 0 deletions lib/versafleet.rb
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ module Versafleet
# Resources (like high level API endpoints)
autoload :JobsResource, "versafleet/resources/jobs"
autoload :TasksResource, "versafleet/resources/tasks"
autoload :DriversResource, "versafleet/resources/drivers"

# 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"
end
4 changes: 4 additions & 0 deletions lib/versafleet/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ def tasks
TasksResource.new(self)
end

def drivers
DriversResource.new(self)
end

def connection
@connection ||= Faraday.new(params: default_params) do |conn|
conn.url_prefix = BASE_URL
Expand Down
4 changes: 4 additions & 0 deletions lib/versafleet/objects/driver.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module Versafleet
class Driver < Object
end
end
22 changes: 22 additions & 0 deletions lib/versafleet/resources/drivers.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
module Versafleet
class DriversResource < Resource
def list(**params)
response = get_request("drivers", params: params)
Collection.from_response(response, key: "drivers", type: Driver)
end

def retrieve(driver_id:)
Driver.new get_request("drivers/#{driver_id}").body.dig("driver")
end

def create(driver:)
payload = {driver: driver}
Driver.new post_request("drivers", body: payload).body.dig("driver")
end

def update(driver_id:, driver:)
payload = {driver: driver}
Driver.new put_request("drivers/#{driver_id}", body: payload).body.dig("driver")
end
end
end