skull_island 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8321e31b43685f8bcf071f1cbcfc227bbcf29f18f4e3f1da1377ec3cc7538ef9
-  data.tar.gz: 9e3c1f19171ec4d3c45c2f074374bba6249f03884741cffd3b16df7ea2862f57
+  metadata.gz: 7b1ddcc4d39d09012c127f337b438f83c2e5397f8e05ecfb87d696872bd57544
+  data.tar.gz: f096c22899ea60a9f35053b22f9cd628c2f7677dd3065417aee2d83404ba7f90
 SHA512:
-  metadata.gz: eb3422efbea9ac46ec54ac1ecf8ba11ef161327719032411e2cc2e0caf3dcb12703963523ffa253afe9ff5006f0ab5874b2a87de906c15068214cf928dd0bd3c
-  data.tar.gz: 78956b6591c0d8de32b084ede4d1a9f73160bb6fff2a94f0f23792a3cdbfc6371e1c96a9800c2c590bb6e089bb4d2b4b273ec7398e559b9bd45707f1411eca7c
+  metadata.gz: 100b4cd19f08fd8499e8c13fab6871faf1c635edc1968f34d280c56b0f1d665244e29dbe52ef4a583a6762ab8bdaa7f2e86a0717f06277a2d51f8a29316b0e29
+  data.tar.gz: 21bf5f772e7be86408fae7b0e6791a2c698e8bc8b1aee6815d00a4cb5c30e4235b4720519fc99239044961d62ed08f69aabcb4d891faa981435fd5fcb642b8ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    skull_island (0.2.3)
+    skull_island (0.2.4)
       deepsort (~> 0.4)
       erubi (~> 1.8)
       json (~> 2.1)
@@ -40,7 +40,7 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     jaro_winkler (1.5.2)
-    json (2.1.0)
+    json (2.2.0)
     launchy (2.4.3)
       addressable (~> 2.3)
     linguistics (2.1.0)
@@ -54,7 +54,7 @@ GEM
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
     netrc (0.11.0)
-    parallel (1.13.0)
+    parallel (1.14.0)
     parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)

data/README.md

@@ -111,6 +111,73 @@ KONG_ADMIN_URL='https://api-admin.mydomain.com' \
 skull_island import --verbose --test /path/to/export.yml
 ```
 
+### File Format
+
+The import/export CLI functions produce YAML with support for embedded Ruby ([ERB](https://ruby-doc.org/stdlib-2.5.3/libdoc/erb/rdoc/ERB.html)). The file is structured like this (as an example):
+
+```yaml
+---
+version: '0.14'
+consumers:
+- username: foo
+  custom_id: foo
+  credentials:
+    key-auth:
+    - key: q90r8908w09rqw9jfj09jq0f8y389
+    basic-auth:
+    - username: foo
+      password: bar
+services:
+- name: apidocs
+  protocol: https
+  host: api.example.com
+  port: 443
+  path: "/v2/api-docs"
+  routes:
+  - paths:
+    - "/api-docs"
+    protocols:
+    - http
+    - https
+    strip_path: true
+    preserve_host: false
+- name: search_api
+  retries: 5
+  protocol: https
+  host: api.example.com
+  port: 3737
+  connect_timeout: 30000
+  write_timeout: 30000
+  read_timeout: 30000
+  routes:
+  - methods:
+    - POST
+    paths:
+    - "/v2/search"
+    protocols:
+    - http
+    - https
+    regex_priority: 0
+    strip_path: true
+    preserve_host: false
+upstreams: []
+plugins:
+- name: key-auth
+  enabled: true
+  config:
+    anonymous: ''
+    hide_credentials: false
+    key_in_body: false
+    key_names:
+    - x-api-key
+    run_on_preflight: true
+  service_id: "<%= lookup :service, 'search_api' %>"
+```
+
+All top-level keys (other than `version`) require an Array as a parameter, either by providing a list of entries or an empty Array (`[]`). The above shows how to use the `lookup()` function to refer to another resource. This "looks up" the resource type (`service` in this case) by `name` (`search_api` in this case) and resolves its `id`. This function can also be used to lookup a `route` or `upstream` by its `name`, or a `consumer` by its `username`. Note that Kong itself doesn't _require_ `route` resources to have unique names, so you'll need to enforce that practice yourself for `lookup` to be useful for Routes.
+
+
+
 ## SDK Usage
 
 The API Client requires configuration before it can be used. For now, this is a matter of calling `APIClient.configure()`, passing a Hash, with Symbols for keys:

data/lib/skull_island/version.rb

@@ -4,6 +4,6 @@ module SkullIsland
   VERSION = [
     0, # Major
     2, # Minor
-    3  # Patch
+    4  # Patch
   ].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skull_island
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-11 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepsort