kong 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aee0b2fdf56d12d85778e534f4c8165ff537938
-  data.tar.gz: 2ef60a6ddadc60cb9f29ca6dfef80bb881815556
+  metadata.gz: 16715f84192ef0b86892c41bd5a64233f14bd1f9
+  data.tar.gz: 140668cf943e425c3ddc7d68bd8b498eba655805
 SHA512:
-  metadata.gz: 4ab2f7efcd3f83b0213ac1e414ccb5de86284b40316518d9e7bb00e21e591b11f761c748a873ccdced21cb83f02d8b2c56f7e66d053e0f765c0663b0c80a21d0
-  data.tar.gz: fd7c4e700bd2869cfbfe88ef9090a41cd18e96d784cca01c9a61167b8d4ddc0f9f4b9c727c1655b47f96af2f12b5224df5cf0fecff7347792be4cc2dbb0c5b31
+  metadata.gz: 071e6c144db8b6b556e03c49eb5f1e5747d289284164cacafd9802ebcde59f4d66927eb1460877a6fb54d851beb47a0411d3d5f7c68d580da3e693c40a6402b5
+  data.tar.gz: 0a0bb5ee564595b160910c2d325fe4ae0c67d67bf65dd5c6be60804b2874047060ccc69f23badae923f5e24ac940dc56643335f401607242fd66abcd3d66c97a

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.2 (2017-01-12)
+- Add JWT support ([#2](https://github.com/kontena/kong-client-ruby/pull/2))
+- Allow to properly set a custom api_url ([#4](https://github.com/kontena/kong-client-ruby/pull/4))
+- Allow to redefine api_url
+([#6](https://github.com/kontena/kong-client-ruby/pull/6))
+- Add ACL support
+([#9](https://github.com/kontena/kong-client-ruby/pull/9))
+
+# 0.1.1 (2016-10-10)
+- Fix Kong::Base.respond_to? to return true for find_by_* methods

data/README.md

@@ -203,6 +203,24 @@ token.delete
 token.oauth_app
 ```
 
+#### 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
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/kontena/kong-client-ruby/fork )

data/lib/kong/acl.rb

@@ -0,0 +1,8 @@
+module Kong
+  class Acl
+    include Base
+    include BelongsToConsumer
+    ATTRIBUTE_NAMES = %w(id group consumer_id).freeze
+    API_END_POINT = "/acls/".freeze
+  end
+end

data/lib/kong/base.rb

@@ -49,7 +49,7 @@ module Kong
             return true
           else
             super
-          end          
+          end
         else
           super
         end

data/lib/kong/client.rb

@@ -5,33 +5,41 @@ require_relative './error'
 
 module Kong
   class Client
+    class << self
+      attr_accessor :http_client
+    end
+
     include Singleton
 
     attr_accessor :default_headers
-    attr_reader :http_client
 
     # Initialize api client
     #
     def initialize
       Excon.defaults[:ssl_verify_peer] = false if ignore_ssl_errors?
       @api_url = api_url
-      @http_client = Excon.new(@api_url, omit_default_port: true)
+      self.class.http_client = Excon.new(@api_url, omit_default_port: true)
       @default_headers = { 'Accept' => 'application/json' }
     end
 
     def self.api_url
-      self.instance.api_url
+      @api_url || ENV['KONG_URI'] || 'http://localhost:8001'
     end
 
     def self.api_url=(url)
-      self.instance.api_url = url
+      @api_url = url
+      @http_client = Excon.new(self.api_url, omit_default_port: true)
+    end
+
+    def http_client
+      self.class.http_client
     end
 
     # Kong Admin API URL
     #
     # @return [String]
-    def api_url      
-      @api_url ||= ENV['KONG_URI'] || 'http://localhost:8001'
+    def api_url
+      self.class.api_url
     end
 
     def api_url=(url)

data/lib/kong/consumer.rb

@@ -65,7 +65,39 @@ module Kong
     #
     # @return [Array<Kong::OAuth2Token>]
     def oauth2_tokens
-      OAuth2Token.list({ authenticated_userid: self.custom_id })
+      if self.custom_id
+        OAuth2Token.list({ authenticated_userid: self.custom_id })
+      else
+        []
+      end
+    end
+
+    # List Acls
+    #
+    # @return [Array<Kong::Acl>]
+    def acls
+      acls = []
+      response = client.get("#{@api_end_point}#{self.username}/acls") rescue nil
+      if response
+        response['data'].each do |attributes|
+          acls << Kong::Acl.new(attributes)
+        end
+      end
+      acls
+    end
+
+    # List JWTs
+    #
+    # @return [Array<Kong::JWT>]
+    def jwts
+      apps = []
+      response = client.get("#{@api_end_point}#{self.username}/jwt") rescue nil
+      if response
+        response['data'].each do |attributes|
+          apps << Kong::JWT.new(attributes)
+        end
+      end
+      apps
     end
   end
 end

data/lib/kong/jwt.rb

@@ -0,0 +1,8 @@
+module Kong
+  class JWT
+    include Base
+    include BelongsToConsumer
+    ATTRIBUTE_NAMES = %w(id key secret consumer_id).freeze
+    API_END_POINT = '/jwt/'.freeze
+  end
+end

data/lib/kong/version.rb

@@ -1,3 +1,3 @@
 module Kong
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/kong.rb

@@ -1,13 +1,15 @@
 require 'kong/version'
-require 'kong/base'
-require 'kong/api'
-require 'kong/belongs_to_api'
-require 'kong/client'
-require 'kong/consumer'
-require 'kong/belongs_to_consumer'
-require 'kong/plugin'
-require 'kong/error'
-require 'kong/oauth_app'
-require 'kong/oauth2_token'
-require 'kong/basic_auth'
-require 'kong/key_auth'
+require_relative 'kong/base'
+require_relative 'kong/api'
+require_relative 'kong/belongs_to_api'
+require_relative 'kong/client'
+require_relative 'kong/consumer'
+require_relative 'kong/belongs_to_consumer'
+require_relative 'kong/plugin'
+require_relative 'kong/error'
+require_relative 'kong/oauth_app'
+require_relative 'kong/oauth2_token'
+require_relative 'kong/basic_auth'
+require_relative 'kong/key_auth'
+require_relative 'kong/jwt'
+require_relative 'kong/acl'

data/spec/kong/acl_spec.rb

@@ -0,0 +1,19 @@
+require_relative "../spec_helper"
+
+describe Kong::Acl do
+  let(:valid_attribute_names) do
+    %w(id group consumer_id)
+  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('/acls/')
+    end
+  end
+end

data/spec/kong/client_spec.rb

@@ -12,6 +12,7 @@ describe Kong::Client do
 
   describe '#initialize' do
     it 'initializes Excon with Kong URI' do
+      described_class.api_url = nil
       expect(Excon).to receive(:new).with('http://localhost:8001', { omit_default_port: true })
       described_class.send(:new)
     end
@@ -23,7 +24,22 @@ describe Kong::Client do
   end
 
   describe '#api_url' do
+
+    def client_params
+      uri = URI.parse described_class.api_url
+      params = {
+        host: uri.host,
+        hostname: uri.hostname,
+        path: uri.path,
+        port: uri.port,
+        query: uri.query,
+        scheme: uri.scheme
+      }
+      described_class.instance.http_client.params.merge(params)
+    end
+
     it 'returns localhost as default' do
+      described_class.api_url = nil
       expect(subject.api_url).to eq('http://localhost:8001')
     end
 
@@ -32,9 +48,23 @@ describe Kong::Client do
       allow(ENV).to receive(:[]).with('no_proxy')
       allow(ENV).to receive(:[]).with('SSL_IGNORE_ERRORS')
       allow(ENV).to receive(:[]).with('KONG_URI').and_return('http://kong-api:8001')
+      described_class.api_url = nil
       subject = described_class.send(:new)
       expect(subject.api_url).to eq('http://kong-api:8001')
     end
+
+    it 'returns custom api_url if set' do
+      url = 'http://foo.bar:1337'
+      described_class.api_url = url
+      expect(described_class.send(:new).api_url).to eq(url)
+    end
+
+    it 'can edit api_url' do
+      described_class.api_url = nil
+      expect(described_class.instance.http_client.params).to eq(client_params)
+      described_class.api_url = 'http://foo.bar:1337'
+      expect(described_class.instance.http_client.params).to eq(client_params)
+    end
   end
 
   describe '#get' do

data/spec/kong/consumer_spec.rb

@@ -35,10 +35,38 @@ describe Kong::Consumer do
   end
 
   describe '#oauth2_tokens' do
-    it 'requests oauth2_tokens assigned to consumer' do
-      subject.custom_id = 'custom_id'
-      expect(Kong::OAuth2Token).to receive(:list).with({ authenticated_userid: subject.custom_id })
-      subject.oauth2_tokens
+    context 'when custom_id is set' do
+      it 'requests oauth2_tokens assigned to consumer' do
+        subject.custom_id = 'custom_id'
+        expect(Kong::OAuth2Token).to receive(:list).with({ authenticated_userid: subject.custom_id })
+        subject.oauth2_tokens
+      end
+    end
+    context 'when custom_id is not set' do
+      it 'requests oauth2_tokens assigned to consumer' do
+        expect(Kong::OAuth2Token).not_to receive(:list)
+        subject.oauth2_tokens
+      end
+      it 'returns empty array' do
+        expect(subject.oauth2_tokens).to eq([])
+      end
+    end
+  end
+
+  describe '#acls' do
+    it 'requests consumer\'s acls' do
+      subject.username = ':username'
+      expect(Kong::Client.instance).to receive(:get).with("/consumers/:username/acls")
+        .and_return({ 'data' => [{ 'id' => '123456', 'group' => 'group1' }] })
+      subject.acls
+    end
+
+    it 'returns list of Acls' do
+      subject.username = ':username'
+      allow(Kong::Client.instance).to receive(:get).with("/consumers/:username/acls")
+        .and_return({ 'data' => [{ 'id' => '123456', 'group' => 'group1' }] })
+      result = subject.acls
+      expect(result.first.is_a?(Kong::Acl)).to be_truthy
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kong
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lauri Nevala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,14 +60,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - kong.gemspec
 - lib/kong.rb
+- lib/kong/acl.rb
 - lib/kong/api.rb
 - lib/kong/base.rb
 - lib/kong/basic_auth.rb
@@ -76,11 +79,13 @@ files:
 - lib/kong/client.rb
 - lib/kong/consumer.rb
 - lib/kong/error.rb
+- lib/kong/jwt.rb
 - lib/kong/key_auth.rb
 - lib/kong/oauth2_token.rb
 - lib/kong/oauth_app.rb
 - lib/kong/plugin.rb
 - lib/kong/version.rb
+- spec/kong/acl_spec.rb
 - spec/kong/api_spec.rb
 - spec/kong/base_spec.rb
 - spec/kong/basic_auth_spec.rb
@@ -112,11 +117,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A Ruby client for the Kong API
 test_files:
+- spec/kong/acl_spec.rb
 - spec/kong/api_spec.rb
 - spec/kong/base_spec.rb
 - spec/kong/basic_auth_spec.rb