Skip to content

Operator | Introduce StationState endpoint #692

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.

Sign up for GitHub

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
tom-ioki merged 5 commits into from
Mar 30, 2026
Merged

Operator | Introduce StationState endpoint #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57d3e9e
Add deactivation and station_category to station model
tom-ioki Mar 10, 2026
06be8f0
Add StationState model
tom-ioki Mar 10, 2026
005d574
Add station_state endpoint to OperatorApi and corresponding spec
tom-ioki Mar 10, 2026
676aca3
Adjust station state model to include station categories and deactiva…
tom-ioki Mar 12, 2026
cc56ffe
Add product_id to path of station_state endpoint
tom-ioki Mar 24, 2026
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
5 changes: 5 additions & 0 deletions lib/ioki/apis/operator_api.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,11 @@ class OperatorApi
base_path: [API_BASE_PATH],
model_class: Ioki::Model::Operator::FleetState
),
Endpoints::ShowSingular.new(
:station_state,
base_path: [API_BASE_PATH, 'products', :id],
model_class: Ioki::Model::Operator::StationState
),
Endpoints.crud_endpoints(
:zone,
base_path: [API_BASE_PATH, 'products', :id],
Expand Down
4 changes: 4 additions & 0 deletions lib/ioki/model/operator/station.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ class Station < Base
on: :read,
type: :boolean

attribute :active_deactivation_id,
Copy link
Copy Markdown
Collaborator

@phylor phylor Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen it in other places as well, and I probably have done it before as well: we are starting to use the same class for different things. The API knows a Station and a StationState::Station, which are different classes. We use the same Station class for both though.

This leads to confusing bugs, where you have a Station object, call active_deactivation_id on it, and it's always nil. You then wonder and eventually figure out that depending on the API you call, different attributes are set. I had this exact flow last week with the User class - the autocomplete endpoint returns different attributes than users#show, but both use the same class.

If I had a wish, it'd be for stronger typing and different classes here 😀

Copy link
Copy Markdown
Contributor Author

@tom-ioki tom-ioki Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel you. It didn't feel good to add the active_deactivation_id attribute to the station model. And I agree, I'd prefer different classes as well.

on: :read,
type: :string

attribute :approach,
on: [:read, :create, :update],
type: :string
Expand Down
32 changes: 32 additions & 0 deletions lib/ioki/model/operator/station_state.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# frozen_string_literal: true

module Ioki
module Model
module Operator
class StationState < Base
attribute :type,
on: :read,
type: :string

attribute :limit_reached,
on: :read,
type: :boolean

attribute :stations,
on: :read,
type: :array,
class_name: 'Station'

attribute :station_categories,
on: :read,
type: :array,
class_name: 'StationCategory'

attribute :station_deactivations,
on: :read,
type: :array,
class_name: 'Deactivation'
end
end
end
end
11 changes: 11 additions & 0 deletions spec/ioki/operator_api_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3039,4 +3039,15 @@
.to be_a(Ioki::Model::Operator::Purchase)
end
end

describe '#station_state(product_id)' do
it 'calls request on the client with expected params' do
expect(operator_client).to receive(:request) do |params|
expect(params[:url].to_s).to eq('operator/products/0815/station_state')
[result_with_data, full_response]
end

expect(operator_client.station_state('0815', options)).to be_a Ioki::Model::Operator::StationState
end
end
end