https://github.com/kontena/kong-client-ruby
Kong API client for Ruby
https://github.com/kontena/kong-client-ruby
kong kong-client ruby
Last synced: 6 months ago
JSON representation
Kong API client for Ruby
- Host: GitHub
- URL: https://github.com/kontena/kong-client-ruby
- Owner: kontena
- License: apache-2.0
- Created: 2016-07-13T06:54:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T17:09:07.000Z (over 2 years ago)
- Last Synced: 2025-04-09T19:20:01.098Z (6 months ago)
- Topics: kong, kong-client, ruby
- Language: Ruby
- Homepage:
- Size: 64.5 KB
- Stars: 42
- Watchers: 7
- Forks: 34
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Kong Client for Ruby
[Kong](http://getkong.org) API client for Ruby
[](https://travis-ci.org/kontena/kong-client-ruby)
[](https://badge.fury.io/rb/kong)
## Installation
Add this line to your application's Gemfile:
gem 'kong'
And then execute:
$ bundle
Or install it yourself as:
$ gem install kong
## Usage
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:
```ruby
require 'kong'
Kong::Client.api_url = 'http://your-kong-url:8001'
```
### Design
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:
```ruby
consumer = Kong::Consumer.create({ username: 'testuser', custom_id: 'custom_id' })
```
OR
```ruby
consumer = Kong::Consumer.new({ username: 'testuser'})
consumer.custom_id = '12345'
consumer.save
```
To find existing consumer:
```ruby
consumer = Kong::Consumer.find_by_username('testuser')
consumer = Kong::Consumer.find_by_custom_id('custom_id')
```
### All Resources and Actions
To see the complete Kong Admin API documentation, please visit: https://getkong.org/docs/0.11.x/admin-api/
#### Consumer
```ruby
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
```
#### API
```ruby
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: ['example.com'],
uris: ['/someservice'],
methods: ['GET'],
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
```
#### Plugin
```ruby
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
```
#### Upstream and Targets (for load-balanced APIs)
```ruby
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
```
#### OAuthApp
```ruby
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
```
#### KeyAuth
```ruby
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
```
#### BasicAuth
```ruby
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
```
#### OAuth2Token
```ruby
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
```ruby
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
```ruby
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
```
#### Server Information
```ruby
Kong::Server.info
Kong::Server.version
Kong::Server.status
Kong::Server.cluster
Kong::Server.remove_node(node_name)
```
## Contributing
1. Fork it ( https://github.com/kontena/kong-client-ruby/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request