Kong API client for Ruby
Add this line to your application's Gemfile:
gem 'kong'
And then execute:
$ bundle
Or install it yourself as:
$ gem install kong
By default Kong client tries to connect http://localhost:8001
or address provided by environment variable: KONG_URI='http://your-kong-url:8001'
.
You can set it also in your code:
require 'kong'
Kong::Client.api_url = 'http://your-kong-url:8001'
Kong client follows a design of resoures as Plain Old Ruby objects(tm). For examples to create a new Consumer resource you can do it like this:
consumer = Kong::Consumer.create({ username: 'testuser', custom_id: 'custom_id' })
OR
consumer = Kong::Consumer.new({ username: 'testuser'})
consumer.custom_id = '12345'
consumer.save
To find existing consumer:
consumer = Kong::Consumer.find_by_username('testuser')
consumer = Kong::Consumer.find_by_custom_id('custom_id')
To see the complete Kong Admin API documentation, please visit: https://getkong.org/docs/0.10.x/admin-api/
Kong::Consumer.list(filters)
Kong::Consumer.all()
Kong::Consumer.find(id)
Kong::Consumer.find_by_*(value)
Kong::Consumer.create(attributes)
consumer = Kong::Consumer.new({ username: 'test-user' })
consumer.get # reloads resource
consumer.create
consumer.update
consumer.save # requests create_or_update action
consumer.delete
consumer.plugins
consumer.oauth_apps
consumer.key_auths
consumer.basic_auths
consumer.oauth2_tokens
Kong::Api.list(filters)
Kong::Api.all()
Kong::Api.find(id)
Kong::Api.find_by_*(value)
Kong::Api.create(attributes)
api = Kong::Api.new({
name: 'Mockbin',
hosts: ['mockbin.com'],
uris: ['/someservice'],
strip_uri: false,
preserve_host: false,
upstream_url: 'https://mockbin.com'
})
api.get # reloads resource
api.create
api.update
api.save # requests create_or_update action
api.delete
api.plugins
Kong::Plugin.list(filters)
Kong::Plugin.all()
Kong::Plugin.find(id)
Kong::Plugin.find_by_*(value)
Kong::Plugin.create(attributes)
plugin = Kong::Plugin.new({
api_id: '5fd1z584-1adb-40a5-c042-63b19db49x21',
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
name: 'rate-limiting',
config: {
minute: 20,
hour: 500
}
})
plugin.get # reloads resource
plugin.create
plugin.update
plugin.save # requests create_or_update action
plugin.delete
Kong::Upstream.list(filters)
Kong::Upstream.all()
Kong::Upstream.find(id)
Kong::Upstream.find_by_*(value)
Kong::Upstream.create(attributes)
upstream = Kong::Upstream.new({ name: 'myservice' })
upstream.get # reloads resource
upstream.create
upstream.update
upstream.save # requests create_or_update action
upstream.delete
upstream.targets # lists active targets
# Add targets
Kong::Target.new({ upstream_id: upstream.id, target: 'appserver1:80' }).save
Kong::Target.new({ upstream_id: upstream.id, target: 'appserver2:80' }).save
# Add the API
Kong::Api.new({
...
upstream_url: 'http://myservice'
}).save
Kong::OAuthApp.list(filters)
Kong::OAuthApp.all()
Kong::OAuthApp.find(consumer_id)
Kong::OAuthApp.find_by_*(value)
Kong::OAuthApp.create(attributes)
app = Kong::OAuthApp.new({
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
redirect_uri: 'http://some-domain/endpoint/'
})
app.create
app.get # reloads resource
app.update
app.save # requests create_or_update action
app.delete
Kong::KeyAuth.create(attributes)
auth = Kong::KeyAuth.new({
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
})
auth.create
auth.get # reloads resource
auth.update
auth.save # requests create_or_update action
auth.delete
Kong::BasicAuth.create(attributes)
auth = Kong::BasicAuth.new({
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
username: 'user123',
password: 'secret'
})
auth.create
auth.get # reloads resource
auth.update
auth.save # requests create_or_update action
auth.delete
token = Kong::OAuth2Token.find_by_access_token('SOME-TOKEN')
token = Kong::OAuth2Token.new({
credential_id: 'KONG-APPLICATION-ID',
token_type: 'bearer',
access_token: 'SOME-TOKEN',
refresh_token: 'SOME-TOKEN',
expires_in: 3600
})
token.create
token.update
token.save # requests create_or_update action
token.delete
token.oauth_app
jwt = Kong::JWT.new({
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
key: 'a36c3049b36249a3c9f8891cb127243c',
secret: 'e71829c351aa4242c2719cbfbe671c09'
})
jwt.create
jwt.update
jwt.save # requests create_or_update action
jwt.delete
consumer = Kong::Consumer.find_by_username('testuser')
consumer.jwts
acl = Kong::Acl.new({
consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
group: 'group1'
})
acl.create
acl.update
acl.save # requests create_or_update action
acl.delete
consumer = Kong::Consumer.find_by_username('testuser')
consumer.acls
Kong::Server.info
Kong::Server.version
Kong::Server.status
Kong::Server.cluster
Kong::Server.remove_node(node_name)
- Fork it ( https://github.com/kontena/kong-client-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request