kong-client 0.4.0

data/spec/kong/plugin_spec.rb

@@ -0,0 +1,62 @@
+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
+
+  describe '#create' do
+    it 'transforms config keys to config.key format' do
+      headers = { 'Content-Type' => 'application/json' }
+      attributes = { 'api_id' => ':api_id', 'config.anonymous' => '12345' }
+      expect(Kong::Client.instance).to receive(:post).with('/apis/:api_id/plugins/', attributes, nil, headers).and_return(attributes)
+      subject = described_class.new({ api_id: ':api_id', config: { 'anonymous' => '12345' } })
+      subject.create
+    end
+
+    it 'transforms nested config keys to config.key format' do
+      headers = { 'Content-Type' => 'application/json' }
+      attributes = { 'api_id' => ':api_id', 'config.anonymous' => '12345', 'config.first.second' => '1' }
+      expect(Kong::Client.instance).to receive(:post).with('/apis/:api_id/plugins/', attributes, nil, headers).and_return(attributes)
+      subject = described_class.new({ api_id: ':api_id', config: { 'anonymous' => '12345', 'first' => { 'second' => '1' } } })
+      subject.create
+    end
+  end
+
+  describe '#update' do
+    it 'transforms config keys to config.key format' do
+      headers = { 'Content-Type' => 'application/json' }
+      attributes = { 'api_id' => ':api_id', 'config.anonymous' => '12345' }
+      expect(Kong::Client.instance).to receive(:patch).with('/apis/:api_id/plugins/', attributes, nil, headers).and_return(attributes)
+      subject = described_class.new({ api_id: ':api_id', config: { 'anonymous' => '12345' } })
+      subject.update
+    end
+
+    it 'transforms nested config keys to config.key format' do
+      headers = { 'Content-Type' => 'application/json' }
+      attributes = { 'api_id' => ':api_id', 'config.anonymous' => '12345', 'config.first.second' => '1' }
+      expect(Kong::Client.instance).to receive(:patch).with('/apis/:api_id/plugins/', attributes, nil, headers).and_return(attributes)
+      subject = described_class.new({ api_id: ':api_id', config: { 'anonymous' => '12345', 'first' => { 'second' => '1' } } })
+      subject.update
+    end
+  end
+end

data/spec/kong/server_spec.rb

@@ -0,0 +1,39 @@
+require_relative "../spec_helper"
+
+describe Kong::Server do
+  describe '.info' do
+    it 'makes GET / request' do
+      expect(Kong::Client.instance).to receive(:get).with('/')
+      described_class.info
+    end
+  end
+
+  describe '.version' do
+    it 'returns version information' do
+      allow(Kong::Client.instance).to receive(:get).with('/')
+        .and_return({ 'version' => '0.10.0' })
+      expect(described_class.version).to eq('0.10.0')
+    end
+  end
+
+  describe '.status' do
+    it 'makes GET /status request' do
+      expect(Kong::Client.instance).to receive(:get).with('/status')
+      described_class.status
+    end
+  end
+
+  describe '.cluster' do
+    it 'makes GET /cluster request' do
+      expect(Kong::Client.instance).to receive(:get).with('/cluster')
+      described_class.cluster
+    end
+  end
+
+  describe '.remove_node' do
+    it 'makes DELETE /cluster/nodes/:name request' do
+      expect(Kong::Client.instance).to receive(:delete).with('/cluster/nodes/:name')
+      described_class.remove_node(':name')
+    end
+  end
+end

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

data/spec/kong/util_spec.rb

@@ -0,0 +1,29 @@
+require_relative "../spec_helper"
+
+describe Kong::Util do
+  describe '.flatten' do
+    subject { described_class.method(:flatten) }
+
+    it 'works' do
+      expect(subject[{
+        a: {
+          b: 1,
+          c: {
+            d: 3
+          }
+        },
+        b: 2
+      }]).to include({
+        "a.b" => 1,
+        "a.c.d" => 3,
+        "b" => 2,
+      })
+    end
+
+    it 'accepts a scope' do
+      expect(subject[{ a: "1" }, 'config']).to eq({
+        "config.a" => "1"
+      })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -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

data/tasks/rspec.rake

@@ -0,0 +1,5 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: kong-client
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Ecosystem API Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for the Kong API
+email:
+- ecosystem-apis@rdstation.com
+- renan.porto@rdstation.com
+- rogerio.angeliski@rdstation.com
+executables: []
+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
+- lib/kong/belongs_to_api.rb
+- lib/kong/belongs_to_consumer.rb
+- lib/kong/client.rb
+- lib/kong/consumer.rb
+- lib/kong/error.rb
+- lib/kong/hmac_auth.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/server.rb
+- lib/kong/target.rb
+- lib/kong/upstream.rb
+- lib/kong/util.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
+- spec/kong/client_spec.rb
+- spec/kong/consumer_spec.rb
+- spec/kong/error_spec.rb
+- spec/kong/hmac_auth_spec.rb
+- spec/kong/key_auth_spec.rb
+- spec/kong/oauth2_token_spec.rb
+- 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/kong/util_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/ResultadosDigitais/kong-client-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.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
+- spec/kong/client_spec.rb
+- spec/kong/consumer_spec.rb
+- spec/kong/error_spec.rb
+- spec/kong/hmac_auth_spec.rb
+- spec/kong/key_auth_spec.rb
+- spec/kong/oauth2_token_spec.rb
+- 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/kong/util_spec.rb
+- spec/spec_helper.rb