kong 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb96feeae50f935d3faf48b18bffde840ad3ca0
-  data.tar.gz: bc4e0aa0c3125d227135ff82db8168a154b773cf
+  metadata.gz: 65344f942e47dd8c8607a2c59df13230abeff63d
+  data.tar.gz: b0e5d1f544da750dc29e73fe64162185e87435e3
 SHA512:
-  metadata.gz: 20914d65262adc1f8592ed02eb689aeba49b5b9b3aca132bf7cd4b9e5bdd1899e0556b1463fea60d3e7ad8dcab16ea8456876086ab94a54d8cf80952c92ff5c0
-  data.tar.gz: 5be4a32b52ec29a31a5fcda2d40784881fc9f0ac009bb68eeaf132e1831062822eb76e6554b1d1317326e800f2e8ff25fe2b90770ef6806d1993808daf87d1d2
+  metadata.gz: e0e3bb31a1d6b3236e56f449f6ee98cd05492081dcf5504a7b3715ec72cfe24d5b0da360a07925ec5bd5befdbf6af2826bffd4fc913159024bbd6a2e2f691ac8
+  data.tar.gz: b51843df1c0d1962d7db7928cb042a286a3d6ad897a658341c59e9f0bb605e38283e06d10626a5fadcaa989ddaae4e121f5c01485d00fc05a247a546f5dea588

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.3.0 (2017-07-31)
+- Add support for Upstream and Target resources ([#15](https://github.com/kontena/kong-client-ruby/pull/15))
+
 # 0.2.0 (2017-04-20)
 - Add Server information support ([#14](https://github.com/kontena/kong-client-ruby/pull/14))
 - Add optional attributes to Api

data/README.md

@@ -53,6 +53,8 @@ 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.10.x/admin-api/
+
 #### Consumer
 
 ```ruby
@@ -87,9 +89,9 @@ Kong::Api.create(attributes)
 
 api = Kong::Api.new({
   name: 'Mockbin',
-  request_host: 'mockbin.com',
-  request_path: '/someservice',
-  strip_request_path: false,
+  hosts: ['mockbin.com'],
+  uris: ['/someservice'],
+  strip_uri: false,
   preserve_host: false,
   upstream_url: 'https://mockbin.com'
 })
@@ -118,7 +120,7 @@ plugin = Kong::Plugin.new({
   config: {
     minute: 20,
     hour: 500
-  }  
+  }
 })
 
 plugin.get # reloads resource
@@ -128,6 +130,36 @@ plugin.save # requests create_or_update action
 plugin.delete
 ```
 
+#### Upstream and Targets (for load-balanced APIs)
+
+```
+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
@@ -137,8 +169,8 @@ 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',  
+app = Kong::OAuthApp.new({
+  consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
   redirect_uri: 'http://some-domain/endpoint/'
 })
 
@@ -154,8 +186,8 @@ app.delete
 ```ruby
 Kong::KeyAuth.create(attributes)
 
-auth = Kong::KeyAuth.new({  
-  consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',    
+auth = Kong::KeyAuth.new({
+  consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
 })
 
 auth.create
@@ -170,7 +202,7 @@ auth.delete
 ```ruby
 Kong::BasicAuth.create(attributes)
 
-auth = Kong::BasicAuth.new({  
+auth = Kong::BasicAuth.new({
   consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
   username: 'user123',
   password: 'secret'
@@ -188,7 +220,7 @@ auth.delete
 ```ruby
 token = Kong::OAuth2Token.find_by_access_token('SOME-TOKEN')
 
-token = Kong::OAuth2Token.new({  
+token = Kong::OAuth2Token.new({
   credential_id: 'KONG-APPLICATION-ID',
   token_type: 'bearer',
   access_token: 'SOME-TOKEN',
@@ -208,7 +240,7 @@ token.oauth_app
 
 ```ruby
 
-jwt = Kong::JWT.new({  
+jwt = Kong::JWT.new({
   consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
   key: 'a36c3049b36249a3c9f8891cb127243c',
   secret: 'e71829c351aa4242c2719cbfbe671c09'
@@ -227,7 +259,7 @@ consumer.jwts
 
 ```ruby
 
-acl = Kong::Acl.new({  
+acl = Kong::Acl.new({
   consumer_id: 'a3dX2dh2-1adb-40a5-c042-63b19dbx83hF4',
   group: 'group1'
 })

data/lib/kong/base.rb

@@ -161,6 +161,7 @@ module Kong
       end
       use_consumer_end_point if respond_to?(:use_consumer_end_point)
       use_api_end_point if respond_to?(:use_api_end_point)
+      use_upstream_end_point if respond_to?(:use_upstream_end_point)
     end
   end
 end

data/lib/kong/target.rb

@@ -0,0 +1,61 @@
+module Kong
+  class Target
+    include Base
+
+    ATTRIBUTE_NAMES = %w(id upstream_id target weight).freeze
+    API_END_POINT = '/targets/'.freeze
+
+    def self.find(id)
+      raise NotImplementedError, 'Kong does not support direct access to targets, you must go via an upstream'
+    end
+
+    def self.list(params = {})
+      raise NotImplementedError, 'Kong does not support direct access to targets, you must go via an upstream'
+    end
+
+    def initialize(attributes = {})
+      super(attributes)
+      raise ArgumentError, 'You must specify an upstream_id' unless self.upstream_id
+    end
+
+    def active?
+      self.weight > 0
+    end
+
+    def save
+      create
+    end
+
+    def create_or_update
+      raise NotImplementedError, 'Kong does not support updating targets, you must delete and re-create'
+    end
+
+    def update
+      raise NotImplementedError, 'Kong does not support updating targets, you must delete and re-create'
+    end
+
+    def use_upstream_end_point
+      self.api_end_point = "/upstreams/#{self.upstream_id}#{self.class::API_END_POINT}" if self.upstream_id
+    end
+
+    # Get Upstream resource
+    # @return [Kong::Upstream]
+    def upstream
+      @upstream ||= Upstream.find(self.upstream_id)
+    end
+
+    # Set Upstream resource
+    # @param [Kong::Upstream] upstream
+    def upstream=(upstream)
+      @upstream = upstream
+      self.upstream_id = upstream.id
+    end
+
+    # Set Upstream id
+    # @param [String] id
+    def upstream_id=(id)
+      super(id)
+      use_upstream_end_point
+    end
+  end
+end

data/lib/kong/upstream.rb

@@ -0,0 +1,24 @@
+module Kong
+  class Upstream
+    include Base
+
+    ATTRIBUTE_NAMES = %w(id name slots orderlist).freeze
+    API_END_POINT = '/upstreams/'.freeze
+
+    ##
+    # @return [Array<Kong::Target>]
+    def targets
+      targets   = []
+      json_data = Client.instance.get("#{API_END_POINT}#{self.id}/targets")
+
+      if json_data['data']
+        json_data['data'].each do |target_data|
+          target = Target.new(target_data)
+          targets << target if target.active?
+        end
+      end
+
+      targets
+    end
+  end
+end

data/lib/kong/version.rb

@@ -1,3 +1,3 @@
 module Kong
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/kong.rb

@@ -13,4 +13,6 @@ require_relative 'kong/basic_auth'
 require_relative 'kong/key_auth'
 require_relative 'kong/jwt'
 require_relative 'kong/acl'
+require_relative 'kong/target'
+require_relative 'kong/upstream'
 require_relative 'kong/server'

data/spec/kong/target_spec.rb

@@ -0,0 +1,53 @@
+require_relative "../spec_helper"
+
+describe Kong::Target do
+  let(:upstream_id) { '1234' }
+
+  let(:valid_attribute_names) do
+    %w(id upstream_id target weight)
+  end
+
+  subject { described_class.new(upstream_id: upstream_id) }
+
+  context 'without an upstream_id' do
+    it 'raises an ArgumentError' do
+      expect { described_class.new }
+        .to raise_error(ArgumentError)
+    end
+  end
+
+  describe 'ATTRIBUTE_NAMES' do
+    it 'contains valid names' do
+      expect(subject.class::ATTRIBUTE_NAMES).to eq(valid_attribute_names)
+    end
+  end
+
+  describe 'API_END_POINT' do
+    it 'contains valid end point' do
+      expect(subject.class::API_END_POINT).to eq('/targets/')
+    end
+  end
+
+  describe '#init_attributes' do
+    it 'uses the correct api end point if the upstream_id is present' do
+      expect(subject.api_end_point).to eq("/upstreams/#{upstream_id}/targets/")
+    end
+  end
+
+  describe '.upstream' do
+    it 'requests the attached Upstream' do
+      expect(Kong::Upstream).to receive(:find).with(upstream_id)
+      subject.upstream
+    end
+  end
+
+  describe '.active?' do
+    it 'returns true if the weight is > 0' do
+      target1 = described_class.new(upstream_id: upstream_id, target: 'google.com', weight: 100)
+      target2 = described_class.new(upstream_id: upstream_id, target: 'google.com', weight: 0)
+
+      expect(target1).to be_active
+      expect(target2).to_not be_active
+    end
+  end
+end

data/spec/kong/upstream_spec.rb

@@ -0,0 +1,37 @@
+require_relative "../spec_helper"
+
+describe Kong::Upstream do
+  let(:valid_attribute_names) do
+    %w(id name slots orderlist)
+  end
+
+  describe 'ATTRIBUTE_NAMES' do
+    it 'contains valid names' do
+      expect(subject.class::ATTRIBUTE_NAMES).to eq(valid_attribute_names)
+    end
+  end
+
+  describe 'API_END_POINT' do
+    it 'contains a valid end point' do
+      expect(subject.class::API_END_POINT).to eq('/upstreams/')
+    end
+  end
+
+  describe '.targets' do
+    it 'requests targets attached to the Upstream' do
+      subject.id = '12345'
+
+      expect(Kong::Client.instance)
+        .to receive(:get).with("/upstreams/12345/targets")
+        .and_return({
+          'data'  => [{ 'upstream_id' => 12345, 'target' => 'google.com:80', 'weight' => 100 }],
+          'total' => 1
+        })
+
+      targets = subject.targets
+
+      expect(targets.size).to eq(1)
+      expect(targets.first).to be_a(Kong::Target)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kong
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lauri Nevala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-20 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,8 @@ files:
 - lib/kong/oauth_app.rb
 - lib/kong/plugin.rb
 - lib/kong/server.rb
+- lib/kong/target.rb
+- lib/kong/upstream.rb
 - lib/kong/version.rb
 - spec/kong/acl_spec.rb
 - spec/kong/api_spec.rb
@@ -97,6 +99,8 @@ files:
 - spec/kong/oauth_app_spec.rb
 - spec/kong/plugin_spec.rb
 - spec/kong/server_spec.rb
+- spec/kong/target_spec.rb
+- spec/kong/upstream_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.rake
 homepage: https://github.com/kontena/kong-client-ruby
@@ -119,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the Kong API
@@ -135,4 +139,6 @@ test_files:
 - spec/kong/oauth_app_spec.rb
 - spec/kong/plugin_spec.rb
 - spec/kong/server_spec.rb
+- spec/kong/target_spec.rb
+- spec/kong/upstream_spec.rb
 - spec/spec_helper.rb