xapixctl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f36513c3a71e1c789c1438f4aca2aa84b5c21a15fc5a415e0d048ec24342a35
+  data.tar.gz: '08fe973118fec5ac856092f1e6588d7b0ff3fefbe48843e6b739e33dec8e3d67'
+SHA512:
+  metadata.gz: a305bf7036a9f2a562750cd6bcb0ca4aa8e75017d4b21dbbacbd82580857890438af8162e0779bc4d3d35e0c7e131a0e0616bf1c9cdbf6a56afa819bbfa87f1d
+  data.tar.gz: dda3172f38b678db380907b828c4813091219b264e5d4f38b084691eb1efb88f05d755216234a6a12e97cdb432fbd5983df62f64f842d226864ffcd95c06ef49

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rvm and other tools
+.ruby-gemset
+.envrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  DisplayCopNames: true
+  Exclude:
+    - bin/*
+
+inherit_gem:
+  relaxed-rubocop: .rubocop.yml
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/OptionHash:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in xapixctl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    xapixctl (1.0.0)
+      activesupport (~> 5.2.3)
+      rest-client (~> 2.1.0)
+      thor (~> 0.20.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.0)
+    netrc (0.11.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    relaxed-rubocop (2.5)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17.3)
+  rake (~> 10.0)
+  relaxed-rubocop (~> 2.5)
+  rspec (~> 3.0)
+  rubocop (~> 0.79.0)
+  xapixctl!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,277 @@
+Eclipse Public License - v 2.0
+
+    THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
+    PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
+    OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+  a) in the case of the initial Contributor, the initial content
+     Distributed under this Agreement, and
+
+  b) in the case of each subsequent Contributor:
+     i) changes to the Program, and
+     ii) additions to the Program;
+  where such changes and/or additions to the Program originate from
+  and are Distributed by that particular Contributor. A Contribution
+  "originates" from a Contributor if it was added to the Program by
+  such Contributor itself or anyone acting on such Contributor's behalf.
+  Contributions do not include changes or additions to the Program that
+  are not Modified Works.
+
+"Contributor" means any person or entity that Distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which
+are necessarily infringed by the use or sale of its Contribution alone
+or when combined with the Program.
+
+"Program" means the Contributions Distributed in accordance with this
+Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement
+or any Secondary License (as applicable), including Contributors.
+
+"Derivative Works" shall mean any work, whether in Source Code or other
+form, that is based on (or derived from) the Program and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship.
+
+"Modified Works" shall mean any work in Source Code or other form that
+results from an addition to, deletion from, or modification of the
+contents of the Program, including, for purposes of clarity any new file
+in Source Code form that contains any contents of the Program. Modified
+Works shall not include works that contain only declarations,
+interfaces, types, classes, structures, or files of the Program solely
+in each case in order to link to, bind by name, or subclass the Program
+or Modified Works thereof.
+
+"Distribute" means the acts of a) distributing or b) making available
+in any manner that enables the transfer of a copy.
+
+"Source Code" means the form of a Program preferred for making
+modifications, including but not limited to software source code,
+documentation source, and configuration files.
+
+"Secondary License" means either the GNU General Public License,
+Version 2.0, or any later versions of that license, including any
+exceptions or additional permissions as identified by the initial
+Contributor.
+
+2. GRANT OF RIGHTS
+
+  a) Subject to the terms of this Agreement, each Contributor hereby
+  grants Recipient a non-exclusive, worldwide, royalty-free copyright
+  license to reproduce, prepare Derivative Works of, publicly display,
+  publicly perform, Distribute and sublicense the Contribution of such
+  Contributor, if any, and such Derivative Works.
+
+  b) Subject to the terms of this Agreement, each Contributor hereby
+  grants Recipient a non-exclusive, worldwide, royalty-free patent
+  license under Licensed Patents to make, use, sell, offer to sell,
+  import and otherwise transfer the Contribution of such Contributor,
+  if any, in Source Code or other form. This patent license shall
+  apply to the combination of the Contribution and the Program if, at
+  the time the Contribution is added by the Contributor, such addition
+  of the Contribution causes such combination to be covered by the
+  Licensed Patents. The patent license shall not apply to any other
+  combinations which include the Contribution. No hardware per se is
+  licensed hereunder.
+
+  c) Recipient understands that although each Contributor grants the
+  licenses to its Contributions set forth herein, no assurances are
+  provided by any Contributor that the Program does not infringe the
+  patent or other intellectual property rights of any other entity.
+  Each Contributor disclaims any liability to Recipient for claims
+  brought by any other entity based on infringement of intellectual
+  property rights or otherwise. As a condition to exercising the
+  rights and licenses granted hereunder, each Recipient hereby
+  assumes sole responsibility to secure any other intellectual
+  property rights needed, if any. For example, if a third party
+  patent license is required to allow Recipient to Distribute the
+  Program, it is Recipient's responsibility to acquire that license
+  before distributing the Program.
+
+  d) Each Contributor represents that to its knowledge it has
+  sufficient copyright rights in its Contribution, if any, to grant
+  the copyright license set forth in this Agreement.
+
+  e) Notwithstanding the terms of any Secondary License, no
+  Contributor makes additional grants to any Recipient (other than
+  those set forth in this Agreement) as a result of such Recipient's
+  receipt of the Program under the terms of a Secondary License
+  (if permitted under the terms of Section 3).
+
+3. REQUIREMENTS
+
+3.1 If a Contributor Distributes the Program in any form, then:
+
+  a) the Program must also be made available as Source Code, in
+  accordance with section 3.2, and the Contributor must accompany
+  the Program with a statement that the Source Code for the Program
+  is available under this Agreement, and informs Recipients how to
+  obtain it in a reasonable manner on or through a medium customarily
+  used for software exchange; and
+
+  b) the Contributor may Distribute the Program under a license
+  different than this Agreement, provided that such license:
+     i) effectively disclaims on behalf of all other Contributors all
+     warranties and conditions, express and implied, including
+     warranties or conditions of title and non-infringement, and
+     implied warranties or conditions of merchantability and fitness
+     for a particular purpose;
+
+     ii) effectively excludes on behalf of all other Contributors all
+     liability for damages, including direct, indirect, special,
+     incidental and consequential damages, such as lost profits;
+
+     iii) does not attempt to limit or alter the recipients' rights
+     in the Source Code under section 3.2; and
+
+     iv) requires any subsequent distribution of the Program by any
+     party to be under a license that satisfies the requirements
+     of this section 3.
+
+3.2 When the Program is Distributed as Source Code:
+
+  a) it must be made available under this Agreement, or if the
+  Program (i) is combined with other material in a separate file or
+  files made available under a Secondary License, and (ii) the initial
+  Contributor attached to the Source Code the notice described in
+  Exhibit A of this Agreement, then the Program may be made available
+  under the terms of such Secondary Licenses, and
+
+  b) a copy of this Agreement must be included with each copy of
+  the Program.
+
+3.3 Contributors may not remove or alter any copyright, patent,
+trademark, attribution notices, disclaimers of warranty, or limitations
+of liability ("notices") contained within the Program from any copy of
+the Program which they Distribute, provided that Contributors may add
+their own appropriate notices.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities
+with respect to end users, business partners and the like. While this
+license is intended to facilitate the commercial use of the Program,
+the Contributor who includes the Program in a commercial product
+offering should do so in a manner which does not create potential
+liability for other Contributors. Therefore, if a Contributor includes
+the Program in a commercial product offering, such Contributor
+("Commercial Contributor") hereby agrees to defend and indemnify every
+other Contributor ("Indemnified Contributor") against any losses,
+damages and costs (collectively "Losses") arising from claims, lawsuits
+and other legal actions brought by a third party against the Indemnified
+Contributor to the extent caused by the acts or omissions of such
+Commercial Contributor in connection with its distribution of the Program
+in a commercial product offering. The obligations in this section do not
+apply to any claims or Losses relating to any actual or alleged
+intellectual property infringement. In order to qualify, an Indemnified
+Contributor must: a) promptly notify the Commercial Contributor in
+writing of such claim, and b) allow the Commercial Contributor to control,
+and cooperate with the Commercial Contributor in, the defense and any
+related settlement negotiations. The Indemnified Contributor may
+participate in any such claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial
+product offering, Product X. That Contributor is then a Commercial
+Contributor. If that Commercial Contributor then makes performance
+claims, or offers warranties related to Product X, those performance
+claims and warranties are such Commercial Contributor's responsibility
+alone. Under this section, the Commercial Contributor would have to
+defend claims against the other Contributors related to those performance
+claims and warranties, and if a court requires any other Contributor to
+pay any damages as a result, the Commercial Contributor must pay
+those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
+BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
+TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
+PURPOSE. Each Recipient is solely responsible for determining the
+appropriateness of using and distributing the Program and assumes all
+risks associated with its exercise of rights under this Agreement,
+including but not limited to the risks and costs of program errors,
+compliance with applicable laws, damage to or loss of data, programs
+or equipment, and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
+PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
+SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
+EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under
+applicable law, it shall not affect the validity or enforceability of
+the remainder of the terms of this Agreement, and without further
+action by the parties hereto, such provision shall be reformed to the
+minimum extent necessary to make such provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity
+(including a cross-claim or counterclaim in a lawsuit) alleging that the
+Program itself (excluding combinations of the Program with other software
+or hardware) infringes such Recipient's patent(s), then such Recipient's
+rights granted under Section 2(b) shall terminate as of the date such
+litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it
+fails to comply with any of the material terms or conditions of this
+Agreement and does not cure such failure in a reasonable period of
+time after becoming aware of such noncompliance. If all Recipient's
+rights under this Agreement terminate, Recipient agrees to cease use
+and distribution of the Program as soon as reasonably practicable.
+However, Recipient's obligations under this Agreement and any licenses
+granted by Recipient relating to the Program shall continue and survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement,
+but in order to avoid inconsistency the Agreement is copyrighted and
+may only be modified in the following manner. The Agreement Steward
+reserves the right to publish new versions (including revisions) of
+this Agreement from time to time. No one other than the Agreement
+Steward has the right to modify this Agreement. The Eclipse Foundation
+is the initial Agreement Steward. The Eclipse Foundation may assign the
+responsibility to serve as the Agreement Steward to a suitable separate
+entity. Each new version of the Agreement will be given a distinguishing
+version number. The Program (including Contributions) may always be
+Distributed subject to the version of the Agreement under which it was
+received. In addition, after a new version of the Agreement is published,
+Contributor may elect to Distribute the Program (including its
+Contributions) under the new version.
+
+Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
+receives no rights or licenses to the intellectual property of any
+Contributor under this Agreement, whether expressly, by implication,
+estoppel or otherwise. All rights in the Program not expressly granted
+under this Agreement are reserved. Nothing in this Agreement is intended
+to be enforceable by any entity that is not a Contributor or Recipient.
+No third-party beneficiary rights are created under this Agreement.
+
+Exhibit A - Form of Secondary Licenses Notice
+
+"This Source Code may also be made available under the following 
+Secondary Licenses when the conditions for such availability set forth 
+in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
+version(s), and exceptions or additional permissions here}."
+
+  Simply including a copy of this Agreement, including this Exhibit A
+  is not sufficient to license the Source Code under Secondary Licenses.
+
+  If it is not possible or desirable to put the notice in a particular
+  file, then You may include the notice in a location (such as a LICENSE
+  file in a relevant directory) where a recipient would be likely to
+  look for such a notice.
+
+  You may add additional accurate notices of copyright ownership.

data/README.md

@@ -0,0 +1,48 @@
+# xapixctl
+
+Xapix client library and command line tool
+
+## Installation
+
+Install it via:
+
+    $ gem install xapixctl
+
+## Usage
+
+To see more details on how to run xapixctl, use:
+
+```
+$ xapixctl help
+
+Commands:
+  xapixctl api-resources                                            # retrieves a list of all available resource types
+  xapixctl apply -f, --file=FILE -o, --org=ORG                      # Create or update a resource from a file
+  xapixctl delete [TYPE ID] [-f FILE] -o, --org=ORG                 # delete the resources in the file
+  xapixctl export -o, --org=ORG -p, --project=PROJECT               # retrieves all resources within a project
+  xapixctl get TYPE [ID] -o, --org=ORG                              # retrieve either all resources of given TYPE or just the resource of given TYPE and ID
+  xapixctl help [COMMAND]                                           # Describe available commands or one specific command
+  xapixctl logs CORRELATION_ID -o, --org=ORG -p, --project=PROJECT  # Retrieves the execution logs for the given correlation ID
+  xapixctl publish -o, --org=ORG -p, --project=PROJECT              # Publishes the current version of the given project
+
+Options:
+  -v, [--verbose], [--no-verbose]
+      [--xapix-url=XAPIX_URL]      # Fallback: environment variable XAPIX_URL. URL to Xapix. Default: https://cloud.xapix.io/
+      [--xapix-token=XAPIX_TOKEN]  # Fallback: environment variable XAPIX_TOKEN. Your access token.
+```
+
+The main commands to interact with Xapix are:
+* `xapixctl get TYPE` to list all the resources of a specific type. You can get the supported types with `xapixctl api-resources`. To see the complete resource definition instead of an overview use the `-f yaml` switch. Use `xapixctl help get` for more details.
+* `xapixctl apply` to create a new resource or update existing ones. Resources are matched using their type and id. If a resource with the same type and id already exists it is updated, otherwise a new one is created.
+* `xapixctl publish` to publish the current status of a project.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xapix-io/xapixctl.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xapixctl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/xapixctl

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "xapixctl"
+require "xapixctl/cli"
+
+Xapixctl::Cli.start(ARGV)

data/lib/xapixctl/cli.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Xapixctl
+  class Cli < Thor
+    def self.exit_on_failure?; true; end
+
+    class_option :verbose, type: :boolean, aliases: "-v"
+    class_option :xapix_url, desc: "Fallback: environment variable XAPIX_URL. URL to Xapix. Default: https://cloud.xapix.io/"
+    class_option :xapix_token, desc: "Fallback: environment variable XAPIX_TOKEN. Your access token."
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project"
+    option :format, aliases: "-f", default: 'text', enum: ['text', 'yaml', 'json'], desc: "Output format"
+    desc "get TYPE [ID]", "retrieve either all resources of given TYPE or just the resource of given TYPE and ID"
+    long_desc <<-LONGDESC
+      `xapctl get TYPE` will retrieve the list of all resources of given type.
+
+      If requested on an organization (i.e. no project given), the following types are available:
+      \x5 Project
+
+      If requested on an a project (i.e. organization and project are given), the following types are available:
+      \x5 Ambassador, AuthScheme, CacheConnection, Credential, DataSource, Endpoint, EndpointGroup, Proxy, Schema, Stream, StreamGroup
+
+      Use the format to switch between the different output formats.
+
+      Examples:
+      \x5> $ xapctl get -o xapix Project
+      \x5> $ xapctl get -o xapix Project some-project
+      \x5> $ xapctl get -o xapix -p some-project DataSource
+      \x5> $ xapctl get -o xapix -p some-project DataSource get-a-list
+    LONGDESC
+    def get(resource_type, resource_id = nil)
+      if resource_id
+        connection.resource(resource_type, resource_id, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
+          res.on_success { |resource| puts resource }
+          res.on_error { |err, result| warn_api_error("could not get", err, result) }
+        end
+      else
+        connection.resource_ids(resource_type, org: options[:org], project: options[:project]) do |res|
+          res.on_success do |resource_ids|
+            resource_ids.each do |resource_id|
+              connection.resource(resource_type, resource_id, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
+                res.on_success { |resource| puts resource }
+                res.on_error { |err, result| warn_api_error("could not get", err, result) }
+              end
+            end
+          end
+          res.on_error { |err, result| warn_api_error("could not get", err, result) }
+        end
+      end
+    end
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project", required: true
+    option :format, aliases: "-f", default: 'text', enum: ['text', 'yaml', 'json'], desc: "Output format"
+    desc "export", "retrieves all resources within a project"
+    long_desc <<-LONGDESC
+      `xapctl export` will retrieve the list of all resources of given type.
+
+      Use the format to switch between the different output formats.
+
+      Examples:
+      \x5> $ xapctl export -o xapix -p some-project
+      \x5> $ xapctl export -o xapix -p some-project -f yaml > some_project.yaml
+    LONGDESC
+    def export
+      connection.resource('Project', options[:project], org: options[:org], format: options[:format].to_sym) do |res|
+        res.on_success { |resource| puts resource }
+        res.on_error { |err, result| warn_api_error("could not get", err, result) }
+      end
+      (connection.resource_types_for_export - ['Project']).each { |type| get(type) }
+    end
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project"
+    option :file, aliases: "-f", required: true
+    desc "apply", "Create or update a resource from a file"
+    long_desc <<-LONGDESC
+      `xapctl apply -f FILE` will apply the given resource description.
+
+      If applied on an organization (i.e. no project given), the project is taken from the resource description.
+
+      If applied on a project (i.e. organization and project are given), the given project is used.
+
+      The given file should be in YAML format and can contain multiple resource definitions, each as it's own YAML document.
+      You can also read from stdin by using '-'.
+
+      Examples:
+      \x5> $ xapctl apply -o xapix -f get_a_list.yaml
+      \x5> $ xapctl apply -o xapix -p some-project -f get_a_list.yaml
+
+      To copy over all data sources from one project to another:
+      \x5> $ xapctl get -o xapix-old -p some-project DataSource -f yaml | xapctl apply -o xapix-new -f -
+    LONGDESC
+    def apply
+      resources_from_file(options[:file]) do |desc|
+        puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')}"
+        connection.apply(desc, org: options[:org], project: options[:project]) do |res|
+          res.on_success { puts 'OK' }
+          res.on_error { |err, result| warn_api_error("could not apply changes", err, result); break }
+        end
+      end
+    end
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project"
+    option :file, aliases: "-f"
+    desc "delete [TYPE ID] [-f FILE]", "delete the resources in the file"
+    long_desc <<-LONGDESC
+      `xapctl delete -f FILE` will delete all the resources listed in the file.
+      \x5`xapctl delete TYPE ID` will delete the resource by given TYPE and ID.
+
+      The given file should be in YAML format and can contain multiple resource definitions, each as it's own YAML document.
+      You can also read from stdin by using '-'.
+
+      Examples:
+      \x5> $ xapctl delete -o xapix -p some-project -f get_a_list.yaml
+      \x5> $ xapctl delete -o xapix -p some-project DataSource get-a-list
+      \x5> $ xapctl delete -o xapix Project some-project
+    LONGDESC
+    def delete(resource_type = nil, resource_id = nil)
+      if resource_type && resource_id
+        connection.delete(resource_type, resource_id, org: options[:org], project: options[:project]) do |res|
+          res.on_success { puts 'DELETED' }
+          res.on_error { |err, result| warn_api_error("could not delete", err, result) }
+        end
+      elsif options[:file]
+        resources_from_file(options[:file]) do |desc|
+          type = desc.dig('kind')
+          id = desc.dig('metadata', 'id')
+          puts "deleting #{type} #{id}"
+          connection.delete(type, id, org: options[:org], project: options[:project]) do |res|
+            res.on_success { puts "DELETED #{type} #{id}" }
+            res.on_error { |err, result| warn_api_error("could not delete", err, result); break }
+          end
+        end
+      else
+        warn "need TYPE and ID or --file option"
+      end
+    end
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project", required: true
+    desc "publish", "Publishes the current version of the given project"
+    long_desc <<-LONGDESC
+      `xapctl publish` will publish the given project.
+
+      Examples:
+      \x5> $ xapctl publish -o xapix -p some-project
+    LONGDESC
+    def publish
+      connection.publish(org: options[:org], project: options[:project]) do |res|
+        res.on_success { |result| show_deployment_status(result) }
+        res.on_error { |err, result| show_deployment_status(result); warn_api_error('errors', err, result) }
+      end
+    end
+
+    option :org, aliases: "-o", desc: "Organization", required: true
+    option :project, aliases: "-p", desc: "Project", required: true
+    desc "logs CORRELATION_ID", "Retrieves the execution logs for the given correlation ID"
+    long_desc <<-LONGDESC
+      `xapctl logs CORRELATION_ID` will retrieve execution logs for the given correlation ID.
+
+      The correlation ID is included as X-Correlation-Id header in the response of each request.
+
+      Examples:
+      \x5> $ xapctl logs be9c8608-e291-460d-bc20-5a394c4079d4 -o xapix -p some-project
+    LONGDESC
+    def logs(correlation_id)
+      connection.logs(correlation_id, org: options[:org], project: options[:project]) do |res|
+        res.on_success { |result| puts result['logs'].to_yaml }
+        res.on_error { |err, result| warn_api_error('could not get logs', err, result) }
+      end
+    end
+
+    SUPPORTED_CONTEXTS = ['Project', 'Organization'].freeze
+    desc "api-resources", "retrieves a list of all available resource types"
+    def api_resources
+      connection.available_resource_types do |res|
+        res.on_success do |available_types|
+          format_str = "%20.20s %20.20s"
+          puts format_str % ['Type', 'Required Context']
+          available_types.sort_by { |desc| desc['type'] }.each do |desc|
+            next unless SUPPORTED_CONTEXTS.include?(desc['context'])
+            puts format_str % [desc['type'], desc['context']]
+          end
+        end
+        res.on_error { |err, result| warn_api_error("could not get", err, result) }
+      end
+    end
+
+    private
+
+    def warn_api_error(text, err, result)
+      details = "\n " + result['errors'].map { |k| k['detail'] }.join("\n ") rescue err.to_s
+      warn "#{text}: #{details}"
+      exit 1
+    end
+
+    def show_deployment_status(result)
+      return unless result && result['project_publication']
+      puts "deployment: #{result.dig('project_publication', 'deployment')}"
+      puts " data api: #{result.dig('project_publication', 'data_api')} (version: #{result.dig('project_publication', 'data_api_version').presence || 'n/a'})"
+      puts " user management: #{result.dig('project_publication', 'user_management')}"
+      if result.dig('project_publication', 'deployment') == 'success'
+        puts " base URL: #{result.dig('project_publication', 'base_url')}"
+      end
+    end
+
+    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
+    def resources_from_file(filename)
+      yaml_string = filename == '-' ? $stdin.read : IO.read(filename)
+      yaml_string.split(/^---\s*\n/).map { |yml| Psych.safe_load(yml) }.compact.each do |doc|
+        unless (DOCUMENT_STRUCTURE - doc.keys.map(&:to_s)).empty?
+          warn "does not look like a correct resource definition:"
+          warn doc.inspect
+          exit 1
+        end
+        yield doc
+      end
+    end
+
+    def connection
+      url = options[:xapix_url] || ENV['XAPIX_URL'] || 'https://cloud.xapix.io/'
+      token = options[:xapix_token] || ENV['XAPIX_TOKEN']
+      raise Thor::RequiredArgumentMissingError, "no XAPIX_TOKEN given. Either use --xapix_token [TOKEN] or set environment variable XAPIX_TOKEN (recommended)" if !token
+      PhoenixClient::Connection.new(url, token)
+    end
+  end
+end

data/lib/xapixctl/phoenix_client.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Xapixctl
+  module PhoenixClient
+
+    class ResultHandler
+      def initialize(default_success_handler:, default_error_handler:)
+        @success_handler = default_success_handler
+        @error_handler = default_error_handler
+        @result_handler = nil
+        yield self if block_given?
+      end
+
+      def on_success(&block); @success_handler = block; self; end
+
+      def on_error(&block); @error_handler = block; self; end
+
+      def prepare_data(proc); @result_handler = proc; self; end
+
+      def formatter(proc); @formatter = proc; self; end
+
+      def run
+        res = yield
+        res = res.present? ? JSON.parse(res) : res
+        res = @result_handler ? @result_handler.call(res) : res
+        res = @formatter ? @formatter.call(res) : res
+        @success_handler.call(res)
+      rescue RestClient::Exception => err
+        response = JSON.parse(err.response) rescue {}
+        @error_handler.call(err, response)
+      rescue SocketError, Errno::ECONNREFUSED => err
+        @error_handler.call(err, nil)
+      end
+    end
+
+    TEXT_FORMATTERS = {
+      all: ->(data) { "id  : %{id}\nkind: %{kind}\nname: %{name}\n\n" % { id: data.dig('metadata', 'id'), kind: data.dig('kind'), name: data.dig('definition', 'name') } }
+    }.freeze
+
+    FORMATTERS = {
+      json: ->(data) { JSON.pretty_generate(data) },
+      yaml: ->(data) { Psych.dump(data.deep_transform_keys! { |k| k.to_s.camelize(:lower) }) },
+      text: ->(data) { (TEXT_FORMATTERS[data.dig('metadata', 'type')] || TEXT_FORMATTERS[:all]).call(data) }
+    }.freeze
+
+    class Connection
+      DEFAULT_SUCCESS_HANDLER = ->(result) { result }
+      DEFAULT_ERROR_HANDLER = ->(err, _response) { warn "Could not get data: #{err}" }
+
+      # sorting is intentional to reflect dependencies when exporting
+      SUPPORTED_RESOURCE_TYPES = %w[
+        Project
+        Ambassador
+        AuthScheme
+        Credential
+        Proxy
+        CacheConnection
+        Schema
+        DataSource
+        Pipeline
+        EndpointGroup
+        Endpoint
+        StreamGroup
+        Stream
+        ApiPublishing
+        ApiPublishingRole
+      ].freeze
+
+      def initialize(url, token)
+        @client = RestClient::Resource.new(File.join(url, 'api/v1'), verify_ssl: false, accept: :json, content_type: :json, headers: { Authorization: "Bearer #{token}" })
+        @default_success_handler = DEFAULT_SUCCESS_HANDLER
+        @default_error_handler = DEFAULT_ERROR_HANDLER
+      end
+
+      def on_success(&block); @default_success_handler = block; self; end
+
+      def on_error(&block); @default_error_handler = block; self; end
+
+      def resource(resource_type, resource_id, org:, project: nil, format: :hash, &block)
+        result_handler(block).
+          formatter(FORMATTERS[format]).
+          run { @client[resource_path(org, project, resource_type, resource_id)].get }
+      end
+
+      def resource_ids(resource_type, org:, project: nil, &block)
+        result_handler(block).
+          prepare_data(->(data) { data['resource_ids'] }).
+          run { @client[resources_path(org, project, resource_type)].get }
+      end
+
+      def apply(resource_description, org:, project: nil, &block)
+        result_handler(block).
+          run { @client[generic_resource_path(org, project)].put(resource_description.to_json) }
+      end
+
+      def delete(resource_type, resource_id, org:, project: nil, &block)
+        result_handler(block).
+          run { @client[resource_path(org, project, resource_type, resource_id)].delete }
+      end
+
+      def publish(org:, project:, &block)
+        result_handler(block).
+          run { @client[project_publications_path(org, project)].post('') }
+      end
+
+      def logs(correlation_id, org:, project:, &block)
+        result_handler(block).
+          run { @client[project_logss_path(org, project, correlation_id)].get }
+      end
+
+      def available_resource_types(&block)
+        result_handler(block).
+          prepare_data(->(data) { data['resource_types'] }).
+          run { @client[resource_types_path].get }
+      end
+
+      def resource_types_for_export
+        @resource_types_for_export ||=
+          available_resource_types do |res|
+            res.on_success { |available_types| SUPPORTED_RESOURCE_TYPES & available_types.map { |desc| desc['type'] } }
+            res.on_error { |err, _response| raise err }
+          end
+      end
+
+      private
+
+      def result_handler(block)
+        ResultHandler.new(default_success_handler: @default_success_handler, default_error_handler: @default_error_handler, &block)
+      end
+
+      def resource_path(org, project, type, id)
+        type = translate_type(type)
+        project ? "/projects/#{org}/#{project}/#{type}/#{id}" : "/orgs/#{org}/#{type}/#{id}"
+      end
+
+      def resources_path(org, project, type)
+        type = translate_type(type)
+        project ? "/projects/#{org}/#{project}/#{type}" : "/orgs/#{org}/#{type}"
+      end
+
+      def generic_resource_path(org, project)
+        project ? "projects/#{org}/#{project}/resource" : "orgs/#{org}/resource"
+      end
+
+      def project_publications_path(org, project)
+        "/projects/#{org}/#{project}/publications"
+      end
+
+      def project_logss_path(org, project, correlation_id)
+        "/projects/#{org}/#{project}/logs/#{correlation_id}"
+      end
+
+      def resource_types_path
+        "/resource_types"
+      end
+
+      def translate_type(resource_type)
+        return 'ApiPublishingRole' if resource_type == 'ApiPublishing/Role'
+        resource_type.sub(%r[/.*], '') # cut off everything after first slash
+      end
+    end
+  end
+end

data/lib/xapixctl/version.rb

@@ -0,0 +1,3 @@
+module Xapixctl
+  VERSION = "1.0.0"
+end

data/lib/xapixctl.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+require 'rest_client'
+require 'json'
+require 'psych'
+require 'xapixctl/version'
+require 'xapixctl/phoenix_client'
+
+module Xapixctl
+end

data/xapixctl.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xapixctl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xapixctl"
+  spec.version       = Xapixctl::VERSION
+  spec.authors       = ["Michael Reinsch"]
+  spec.email         = ["michael@xapix.io"]
+
+  spec.summary       = %q{xapix client library and command line tool}
+  spec.homepage      = "https://github.com/xapix-io/xapixctl"
+  spec.license       = "EPL-2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5.2.3"
+  spec.add_dependency "rest-client", "~> 2.1.0"
+  spec.add_dependency "thor", "~> 0.20.3"
+
+  spec.add_development_dependency "bundler", "~> 1.17.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "relaxed-rubocop", "~> 2.5"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.79.0"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: xapixctl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michael Reinsch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: relaxed-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+description: 
+email:
+- michael@xapix.io
+executables:
+- xapixctl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/xapixctl
+- lib/xapixctl.rb
+- lib/xapixctl/cli.rb
+- lib/xapixctl/phoenix_client.rb
+- lib/xapixctl/version.rb
+- xapixctl.gemspec
+homepage: https://github.com/xapix-io/xapixctl
+licenses:
+- EPL-2.0
+metadata:
+  homepage_uri: https://github.com/xapix-io/xapixctl
+  source_code_uri: https://github.com/xapix-io/xapixctl
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: xapix client library and command line tool
+test_files: []