kongrations 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 545381fabd1ab7b6df0c4bc5fb341a1ee96ec2b1
-  data.tar.gz: d0bbcc1e92fcb6c7a4ab792342be7e2ab0dbe467
+  metadata.gz: 0a6b4698c320f5a9ee42b313bb7222fca9dfd58e
+  data.tar.gz: 7b1005bfd77f063993db018c99ecc70af80c26a6
 SHA512:
-  metadata.gz: 0a095700de6afeca8fc6bf31ad638661845fa8add224e576219209a8db4a6f8629ad30ebe68be931f64a325dabd02aec2fe56b36f5fee4028dea53aee2630047
-  data.tar.gz: b34226c452f75a3cf5419aaaa859fee3d494c88d57857572fedda15a0c1545a026b340a1bba2335c6cb2d9d9951c8a4cf9470cb1be59519236863dfefd706f97
+  metadata.gz: 415697a6fc249d1930e7de92a84110ee2edf1a9c6ebdbb075ef85599b15e3e7ab2aa8c3304fe96ea6c9d55d466c8fff2934b2dfbb617c08aa62f07e401549cf9
+  data.tar.gz: 85884f80f4e7d461dd8ef7e18174e1edd7dd29190a97cc7c6b0c126c8c77ee9b8f4fee4541cd670622b417cf5a2c87163451d6035cea48261c3c4e569be95845

data/.gitignore

@@ -1,3 +1,5 @@
 .env
 migrations-data/
 kongrations.yml
+Gemfile.lock
+coverage

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   Exclude:
     - './spec/fixtures/migrations/**/*.rb'
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.2
   DisplayCopNames: true
 
 Style/Encoding:

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.3.7
+  - 2.4.4
+  - ruby-head
+
+before_install:
+  - gem update bundler
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,5 +1,9 @@
 # Kongrations
 
+[![Build Status](https://travis-ci.org/danilospa/kongrations.svg?branch=master)](https://travis-ci.org/danilospa/kongrations)
+[![Maintainability](https://api.codeclimate.com/v1/badges/90e3435368aaf9b4023a/maintainability)](https://codeclimate.com/github/danilospa/kongrations/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/90e3435368aaf9b4023a/test_coverage)](https://codeclimate.com/github/danilospa/kongrations/test_coverage)
+
 ## Description
 
 Kongrations is a migrations like for [Kong](https://github.com/Kong/kong) APIs and its associations like consumers and plugins.  
@@ -66,7 +70,7 @@ config_env 'production' do |env|
   env.retries = 2
 end
 
-create__api do |api|
+create_api do |api|
   api.payload = {
     name: 'my-api',
     uris: '/myapi',
@@ -86,6 +90,9 @@ Every request body described oh the Kong Admin API documentation must be set usi
 
 After running the migration, Kongrations create a file on `./migrations-data` for each Kong environment to store its state. This file should be commited into your version control system. Also, it's extremely important not to touch this file directly, since it's crucial for Kongrations to work normally.
 
+Place your migration files inside `./migrations` folder. You can change the default folder putting a `path` key on `kongrations.yml` file.  
+You also need to use `.rb` extension on them.
+
 To run the migrations, use Kongrations cli, passing an optional parameter to specify the environment name (default environment name is `default`).  
 Examples:
 ```shell
@@ -132,6 +139,41 @@ end
 delete_api 'api-name'
 ```
 
+#### Create consumer
+
+- [Kong Admin API Reference](https://getkong.org/docs/0.13.x/admin-api/#create-consumer)
+- Usage: pass the request body through `consumer.payload`.
+- Example:
+```ruby
+create_consumer do |consumer|
+  consumer.payload = {
+    username: 'my-username'
+  }
+end
+```
+
+#### Update Consumer
+
+- [Kong Admin API Reference](https://getkong.org/docs/0.13.x/admin-api/#update-consumer)
+- Usage: pass your consumer username or custom_id right after `change_consumer` method, then pass the request body through `consumer.payload`.
+- Example:
+```ruby
+change_consumer 'username' do |consumer|
+  consumer.payload = {
+    username: 'new-username'
+  }
+end
+```
+
+#### Delete Consumer
+
+- [Kong Admin API Reference](https://getkong.org/docs/0.13.x/admin-api/#delete-consumer)
+- Usage: pass your username or custom_id right after `delete_consumer` method.
+- Example:
+```ruby
+delete_consumer 'username'
+```
+
 #### Create Plugin
 
 - [Kong Admin API Reference](https://getkong.org/docs/0.13.x/admin-api/#add-plugin)

data/kongrations.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.executables << 'kongrations'
 
+  spec.required_ruby_version = '>= 2.2'
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -28,5 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '3.7.0'
   spec.add_development_dependency 'rubocop', '0.54.0'
+  spec.add_development_dependency 'simplecov', '0.16.1'
   spec.add_development_dependency 'webmock', '3.3.0'
 end

data/lib/kongrations/current_environment.rb

@@ -5,7 +5,7 @@ require 'erb'
 
 module Kongrations
   module CurrentEnvironment
-    FILE_NAME = 'kongrations.yml'
+    FILE_NAME = 'kongrations.yml'.freeze
 
     def self.load!(name)
       yaml = File.read(FILE_NAME)

data/lib/kongrations/migration.rb

@@ -43,6 +43,22 @@ module Kongrations
       DeleteApiRequest.new(name)
     end
 
+    def create_consumer
+      create_consumer_request = CreateConsumerRequest.new
+      yield(create_consumer_request)
+      create_consumer_request
+    end
+
+    def change_consumer(username)
+      change_consumer_request = ChangeConsumerRequest.new(username)
+      yield(change_consumer_request)
+      change_consumer_request
+    end
+
+    def delete_consumer(username)
+      DeleteConsumerRequest.new(username)
+    end
+
     def create_plugin_for_api(api_name)
       create_plugin_request = CreatePluginRequest.new(api_name)
       yield(create_plugin_request)

data/lib/kongrations/migration_data.rb

@@ -7,7 +7,7 @@ module Kongrations
   using HashExt
 
   module MigrationData
-    PATH = './migrations-data'
+    PATH = './migrations-data'.freeze
 
     def self.load!
       @data = File.exist?(file_name) ? JSON.parse(File.read(file_name)) : {}

data/lib/kongrations/requests/change_consumer_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kongrations/request'
+
+module Kongrations
+  class ChangeConsumerRequest < Request
+    attr_accessor :username
+
+    def initialize(username)
+      @username = username
+    end
+
+    def path
+      "/consumers/#{username}"
+    end
+
+    def method
+      :patch
+    end
+  end
+end

data/lib/kongrations/requests/change_plugin_request.rb

@@ -12,7 +12,7 @@ module Kongrations
     end
 
     def path
-      plugin_id = migration_data[api_name]['plugins'][plugin_name]
+      plugin_id = migration_data['apis'][api_name]['plugins'][plugin_name]
       "/apis/#{api_name}/plugins/#{plugin_id}"
     end
 

data/lib/kongrations/requests/create_consumer_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'kongrations/request'
+
+module Kongrations
+  class CreateConsumerRequest < Request
+    def path
+      '/consumers'
+    end
+
+    def method
+      :post
+    end
+  end
+end

data/lib/kongrations/requests/delete_consumer_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'kongrations/request'
+
+module Kongrations
+  class DeleteConsumerRequest < Request
+    attr_accessor :username
+
+    def initialize(username)
+      @username = username
+    end
+
+    def path
+      "/consumers/#{username}"
+    end
+
+    def method
+      :delete
+    end
+  end
+end

data/lib/kongrations/responses/create_plugin_response.rb

@@ -9,9 +9,11 @@ module Kongrations
       plugin_name = @request.payload[:name]
       plugin_id = body[:id]
       {
-        api_name => {
-          'plugins' => {
-            plugin_name => plugin_id
+        'apis' => {
+          api_name => {
+            'plugins' => {
+              plugin_name => plugin_id
+            }
           }
         }
       }

data/lib/kongrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kongrations
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kongrations
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Danilo Albuquerque
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.54.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -107,8 +121,8 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -122,10 +136,13 @@ files:
 - lib/kongrations/migration_data.rb
 - lib/kongrations/request.rb
 - lib/kongrations/requests/change_api_request.rb
+- lib/kongrations/requests/change_consumer_request.rb
 - lib/kongrations/requests/change_plugin_request.rb
 - lib/kongrations/requests/create_api_request.rb
+- lib/kongrations/requests/create_consumer_request.rb
 - lib/kongrations/requests/create_plugin_request.rb
 - lib/kongrations/requests/delete_api_request.rb
+- lib/kongrations/requests/delete_consumer_request.rb
 - lib/kongrations/requests/delete_plugin_request.rb
 - lib/kongrations/response.rb
 - lib/kongrations/responses/create_plugin_response.rb
@@ -142,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    kongrations (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hashdiff (0.3.7)
-    method_source (0.9.0)
-    parallel (1.12.1)
-    parser (2.5.0.4)
-      ast (~> 2.4.0)
-    powerpack (0.1.1)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (3.0.2)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.54.0)
-      parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
-    unicode-display_width (1.3.0)
-    webmock (3.3.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  kongrations!
-  pry (= 0.11.3)
-  rake (~> 10.0)
-  rspec (= 3.7.0)
-  rubocop (= 0.54.0)
-  webmock (= 3.3.0)
-
-BUNDLED WITH
-   1.16.0