RubyGems - kong - Versions diffs - 0.1.0 - Mend

kong 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

checksums.yaml +7 -0
data/.gitignore +15 -0
data/.rubocop.yml +360 -0
data/.travis.yml +8 -0
data/Gemfile +8 -0
data/LICENSE +191 -0
data/README.md +210 -0
data/Rakefile +5 -0
data/kong.gemspec +24 -0
data/lib/kong.rb +13 -0
data/lib/kong/api.rb +14 -0
data/lib/kong/base.rb +153 -0
data/lib/kong/basic_auth.rb +8 -0
data/lib/kong/belongs_to_api.rb +30 -0
data/lib/kong/belongs_to_consumer.rb +30 -0
data/lib/kong/client.rb +226 -0
data/lib/kong/consumer.rb +71 -0
data/lib/kong/error.rb +8 -0
data/lib/kong/key_auth.rb +8 -0
data/lib/kong/oauth2_token.rb +14 -0
data/lib/kong/oauth_app.rb +8 -0
data/lib/kong/plugin.rb +9 -0
data/lib/kong/version.rb +3 -0
data/spec/kong/api_spec.rb +27 -0
data/spec/kong/base_spec.rb +147 -0
data/spec/kong/basic_auth_spec.rb +26 -0
data/spec/kong/client_spec.rb +267 -0
data/spec/kong/consumer_spec.rb +44 -0
data/spec/kong/key_auth_spec.rb +26 -0
data/spec/kong/oauth2_token_spec.rb +19 -0
data/spec/kong/oauth_app_spec.rb +19 -0
data/spec/kong/plugin_spec.rb +26 -0
data/spec/spec_helper.rb +19 -0
data/tasks/rspec.rake +5 -0
metadata +129 -0

data/spec/kong/basic_auth_spec.rb ADDED

@@ -0,0 +1,26 @@
+require_relative "../spec_helper"
+describe Kong::BasicAuth do
+  let(:valid_attribute_names) do
+    %w(id username password 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('/basic-auth/')
+    end
+  end
+  describe '#init_attributes' do
+    it 'uses correct api end point if api_id is present' do
+      subject = described_class.new({ consumer_id: ':consumer_id' })
+      expect(subject.api_end_point).to eq('/consumers/:consumer_id/basic-auth/')
+    end
+  end
+end

data/spec/kong/client_spec.rb ADDED

@@ -0,0 +1,267 @@
+require_relative "../spec_helper"
+describe Kong::Client do
+  let(:subject) do
+    described_class.instance
+  end
+  let(:http_client) do
+    spy
+  end
+  describe '#initialize' do
+    it 'initializes Excon with Kong URI' do
+      expect(Excon).to receive(:new).with('http://localhost:8001', { omit_default_port: true })
+      described_class.send(:new)
+    end
+    it 'initializes default headers' do
+      expect(described_class.instance.default_headers).to eq({ 'Accept' => 'application/json' })
+      described_class.send(:new)
+    end
+  end
+  describe '#api_url' do
+    it 'returns localhost as default' do
+      expect(subject.api_url).to eq('http://localhost:8001')
+    end
+    it 'returns value from environment variable' do
+      allow(ENV).to receive(:[]).with('NO_PROXY')
+      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')
+      subject = described_class.send(:new)
+      expect(subject.api_url).to eq('http://kong-api:8001')
+    end
+  end
+  describe '#get' do
+    before(:each) do
+      allow(subject).to receive(:http_client).and_return(http_client)
+    end
+    it 'creates HTTP GET request with given params' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      expect(http_client).to receive(:get).and_return(response)
+      subject.get('path', { key: 'value' })
+    end
+    it 'raises Kong::Error if request returns error' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(403)
+      expect(http_client).to receive(:get).and_return(response)
+      expect {
+        subject.get('path', { key: 'value' })
+      }.to raise_error(Kong::Error)
+    end
+    it 'parses response JSON' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      allow(response).to receive(:body).and_return({ id: '12345' }.to_json)
+      allow(response).to receive(:headers).and_return({ 'Content-Type' => 'application/json' })
+      allow(http_client).to receive(:get).and_return(response)
+      expect(subject.get('path', { key: 'value' })).to eq({ 'id' => '12345' })
+    end
+    it 'returns response text' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      allow(response).to receive(:body).and_return('<html></html>')
+      allow(response).to receive(:headers).and_return({ 'Content-Type' => 'text/html' })
+      allow(http_client).to receive(:get).and_return(response)
+      expect(subject.get('path', { key: 'value' })).to eq('<html></html>')
+    end
+  end
+  describe '#post' do
+    before(:each) do
+      allow(subject).to receive(:http_client).and_return(http_client)
+    end
+    it 'creates HTTP POST request with given params' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      expect(http_client).to receive(:post).and_return(response)
+      subject.post('path', nil, { key: 'value' })
+    end
+    it 'raises Kong::Error if request returns error' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(403)
+      expect(http_client).to receive(:post).and_return(response)
+      expect {
+        subject.post('path', nil, { key: 'value' })
+      }.to raise_error(Kong::Error)
+    end
+    it 'parses response JSON' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      allow(response).to receive(:body).and_return({ id: '12345' }.to_json)
+      allow(response).to receive(:headers).and_return({ 'Content-Type' => 'application/json' })
+      allow(http_client).to receive(:post).and_return(response)
+      expect(subject.post('path', nil, { key: 'value' })).to eq({ 'id' => '12345' })
+    end
+  end
+  describe '#patch' do
+    before(:each) do
+      allow(subject).to receive(:http_client).and_return(http_client)
+    end
+    it 'creates HTTP PATCH request with given params' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      expect(http_client).to receive(:patch).and_return(response)
+      subject.patch('path', nil, { key: 'value' })
+    end
+    it 'raises Kong::Error if request returns error' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(403)
+      expect(http_client).to receive(:patch).and_return(response)
+      expect {
+        subject.patch('path', nil, { key: 'value' })
+      }.to raise_error(Kong::Error)
+    end
+    it 'parses response JSON' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      allow(response).to receive(:body).and_return({ id: '12345' }.to_json)
+      allow(response).to receive(:headers).and_return({ 'Content-Type' => 'application/json' })
+      allow(http_client).to receive(:patch).and_return(response)
+      expect(subject.patch('path', nil, { key: 'value' })).to eq({ 'id' => '12345' })
+    end
+  end
+  describe '#put' do
+    before(:each) do
+      allow(subject).to receive(:http_client).and_return(http_client)
+    end
+    it 'creates HTTP PUT request with given params' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      expect(http_client).to receive(:put).and_return(response)
+      subject.put('path', nil, { key: 'value' })
+    end
+    it 'raises Kong::Error if request returns error' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(403)
+      expect(http_client).to receive(:put).and_return(response)
+      expect {
+        subject.put('path', nil, { key: 'value' })
+      }.to raise_error(Kong::Error)
+    end
+    it 'parses response JSON' do
+      http_client_params = {
+        path: 'path',
+        query: { key: 'value' },
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(200)
+      allow(response).to receive(:body).and_return({ id: '12345' }.to_json)
+      allow(response).to receive(:headers).and_return({ 'Content-Type' => 'application/json' })
+      allow(http_client).to receive(:put).and_return(response)
+      expect(subject.put('path', nil, { key: 'value' })).to eq({ 'id' => '12345' })
+    end
+  end
+  describe '#delete' do
+    before(:each) do
+      allow(subject).to receive(:http_client).and_return(http_client)
+    end
+    it 'creates HTTP DELETE request with given params' do
+      http_client_params = {
+        path: 'path',
+        query: {},
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(204)
+      expect(http_client).to receive(:delete).and_return(response)
+      subject.delete('path', nil, {})
+    end
+    it 'raises Kong::Error if request returns other than 204' do
+      http_client_params = {
+        path: 'path',
+        query: {},
+        headers: {}
+      }
+      response = spy
+      allow(response).to receive(:status).and_return(403)
+      expect(http_client).to receive(:delete).and_return(response)
+      expect {
+        subject.delete('path', nil, {})
+      }.to raise_error(Kong::Error)
+    end
+  end
+end

data/spec/kong/consumer_spec.rb ADDED

@@ -0,0 +1,44 @@
+require_relative "../spec_helper"
+describe Kong::Consumer do
+  let(:valid_attribute_names) do
+    %w(id custom_id username created_at)
+  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('/consumers/')
+    end
+  end
+  describe '#oauth_apps' do
+    it 'requests consumer\'s oauth_apps' do
+      subject.username = ':username'
+      expect(Kong::Client.instance).to receive(:get).with("/consumers/:username/oauth2")
+        .and_return({ 'data' => [{ 'id' => '123456', 'name' => 'my app' }] })
+      subject.oauth_apps
+    end
+    it 'returns list of OAuthApp' do
+      subject.username = ':username'
+      allow(Kong::Client.instance).to receive(:get).with("/consumers/:username/oauth2")
+        .and_return({ 'data' => [{ 'id' => '123456', 'name' => 'my app' }] })
+      result = subject.oauth_apps
+      expect(result.first.is_a?(Kong::OAuthApp)).to be_truthy
+    end
+  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
+    end
+  end
+end

data/spec/kong/key_auth_spec.rb ADDED

@@ -0,0 +1,26 @@
+require_relative "../spec_helper"
+describe Kong::KeyAuth do
+  let(:valid_attribute_names) do
+    %w(id key 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('/key-auth/')
+    end
+  end
+  describe '#init_attributes' do
+    it 'uses correct api end point if api_id is present' do
+      subject = described_class.new({ consumer_id: ':consumer_id' })
+      expect(subject.api_end_point).to eq('/consumers/:consumer_id/key-auth/')
+    end
+  end
+end

data/spec/kong/oauth2_token_spec.rb ADDED

@@ -0,0 +1,19 @@
+require_relative "../spec_helper"
+describe Kong::OAuth2Token do
+  let(:valid_attribute_names) do
+    %w(id credential_id expires_in created_at token_type access_token refresh_token scope authenticated_userid)
+  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('/oauth2_tokens/')
+    end
+  end
+end

data/spec/kong/oauth_app_spec.rb ADDED

@@ -0,0 +1,19 @@
+require_relative "../spec_helper"
+describe Kong::OAuthApp do
+  let(:valid_attribute_names) do
+    %w(id name client_id client_secret redirect_uri 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('/oauth2/')
+    end
+  end
+end

data/spec/kong/plugin_spec.rb ADDED

@@ -0,0 +1,26 @@
+require_relative "../spec_helper"
+describe Kong::Plugin do
+  let(:valid_attribute_names) do
+    %w(id api_id name config enabled 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('/plugins/')
+    end
+  end
+  describe '#init_attributes' do
+    it 'uses correct api end point if api_id is present' do
+      subject = described_class.new({ api_id: ':api_id' })
+      expect(subject.api_end_point).to eq('/apis/:api_id/plugins/')
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'kong'
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end