module Kongkit::Client::Consumer

Public Instance Methods

consumer(identifier) click to toggle source

Retrieve consumer

@see getkong.org/docs/0.8.x/admin-api/#retrieve-consumer @param identifier [String] The unique identifier or the username of the consumer to retrieve @return [Kongkit::Client::Resource] Consumer

# File lib/kongkit/client/consumer.rb, line 22
def consumer(identifier)
  get(consumer_path(identifier))
end
consumers(options = {}) click to toggle source

List consumers

@see getkong.org/docs/0.8.x/admin-api/#list-consumers @option options [String] :id A filter on the list based on the consumer `id` field @option options [String] :custom_id A filter on the list based on the consumer `custom_id` field @option options [String] :username A filter on the list based on the consumer `username` field @option options [Integer] :size A limit on the number of objects to be returned, default: 100 @option options [String] :offset A cursor used for pagination. Offset is an object identifier that defines a place in the list. @return [Kongkit::Client::Resource] API Objects

# File lib/kongkit/client/consumer.rb, line 13
def consumers(options = {})
  get('/consumers', query: options)
end
create_consumer(attributes) click to toggle source

Create consumer

@note At least username or custom_id should be specified.

@see getkong.org/docs/0.8.x/admin-api/#create-consumer @option attributes [String] :username The username of the consumer (semi-optional) @option attributes [String] :custom_id Field for storing an existing ID for the consumer, useful for mapping Kong with users in your existing database (semi-optional) @return [Kongkit::Client::Resource] Consumer

# File lib/kongkit/client/consumer.rb, line 34
def create_consumer(attributes)
  post('/consumers', body: attributes)
end
delete_consumer(identifier) click to toggle source

Delete Consumer

@see getkong.org/docs/0.8.x/admin-api/#delete-consumer @param identifier [String] The unique identifier or the name of the consumer to delete @return [Boolean] `true` if successfully deleted

# File lib/kongkit/client/consumer.rb, line 56
def delete_consumer(identifier)
  delete(consumer_path(identifier))
end
edit_consumer(identifier, attributes) click to toggle source

Edit consumer

@note At least username or custom_id should be specified.

@see getkong.org/docs/0.8.x/admin-api/#update-consumer @param identifier [String] The unique identifier or the name of the consumer to update @option attributes [String] :username The username of the consumer (semi-optional) @option attributes [String] :custom_id Field for storing an existing ID for the consumer, useful for mapping Kong with users in your existing database (semi-optional) @return [Kongkit::Client::Resource] Consumer

# File lib/kongkit/client/consumer.rb, line 47
def edit_consumer(identifier, attributes)
  patch(consumer_path(identifier), body: attributes)
end

Private Instance Methods

consumer_path(identifier) click to toggle source
# File lib/kongkit/client/consumer.rb, line 62
def consumer_path(identifier)
  "/consumers/#{identifier}"
end