xapixctl 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd8ba6213479cad5bf20ea1e07db40e09dd375f58ccfb12d6183f31707db480
-  data.tar.gz: 1056d41e4dfc798aa86d7a9f3bff136cc145c7dd0803c77d47c91440a481b75e
+  metadata.gz: eb39c7aace95b6c10168b43e536b404a8d5edcdfc48d12890b296708199dccda
+  data.tar.gz: 5db98915dd0ac3f1c02b64ceee8ba7497a72fe4ccd65c09c2543aa108a4a1b95
 SHA512:
-  metadata.gz: 61a99b2b54e627228d20edb639fceee90d7a93bb503237f69f877a746e20826cd43f60d7ddc66910e94c1596aeee14f5e5cc6359e81ca5c3db3fa5d46d0caaab
-  data.tar.gz: d09d9ccd590a01d06cf6509ae0f44a1f44a5f205ef48f3032d997da6fbf64d5f61d785145512cd06f483d40ec976c5e34db4a030719b5e667fccd04b346f4619
+  metadata.gz: d67fe8ecd7b977fd05c7f8f8fb9b2b0fdbd4b1153405f0419f93bf05eea7dcb77d4314f4a635d77cb8472c50fcdef9c92df5fae1e361a8874b33401968dfaa35
+  data.tar.gz: e44e46596d4b155a5e3e5c08772de09fdbac68d1b5de23c6377a448f75af35c3701e59cf25498491d57c1c5418b3340ec7098939d168063f0c18bbe929c532d7

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  NewCops: enable
+  TargetRubyVersion: 2.6
   DisplayCopNames: true
   Exclude:
     - bin/*
@@ -25,3 +26,6 @@ Style/OptionHash:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: 'err'

data/Gemfile.lock

@@ -1,40 +1,40 @@
 PATH
   remote: .
   specs:
-    xapixctl (1.0.1)
+    xapixctl (1.1.1)
       activesupport (>= 5.2.3, < 6.0.0)
       rest-client (>= 2.1.0, < 3.0.0)
-      thor (>= 0.20.3, < 1.0.0)
+      thor (>= 1.0.0, < 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.3)
+    activesupport (5.2.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     ast (2.4.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     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.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
-    minitest (5.14.1)
+    minitest (5.14.2)
     netrc (0.11.0)
     parallel (1.19.2)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.0)
     relaxed-rubocop (2.5)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -55,19 +55,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.85.1)
+    rubocop (0.91.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.4.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.4.2)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    thor (0.20.3)
+    thor (1.0.1)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
@@ -84,7 +84,7 @@ DEPENDENCIES
   rake (~> 13.0)
   relaxed-rubocop (~> 2.5)
   rspec (~> 3.0)
-  rubocop (~> 0.85.0)
+  rubocop (~> 0.89)
   xapixctl!
 
 BUNDLED WITH

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/xapixctl/base_cli.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Xapixctl
+  class BaseCli < 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."
+
+    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/cli.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'thor'
+require 'xapixctl/base_cli'
+require 'xapixctl/preview_cli'
 
 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."
+  class Cli < BaseCli
+    desc "preview SUBCOMMAND ...ARGS", "Request preview for resources"
+    subcommand "preview", Preview
 
     option :org, aliases: "-o", desc: "Organization", required: true
     option :project, aliases: "-p", desc: "Project"
@@ -128,7 +126,7 @@ module Xapixctl
         end
       elsif options[:file]
         resources_from_file(options[:file]) do |desc|
-          type = desc.dig('kind')
+          type = desc['kind']
           id = desc.dig('metadata', 'id')
           puts "deleting #{type} #{id}"
           connection.delete(type, id, org: options[:org], project: options[:project]) do |res|
@@ -141,46 +139,6 @@ module Xapixctl
       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 "preview ID", "Preview a pipeline"
-    long_desc <<-LONGDESC
-      `xapixctl preview` will return a preview of the given pipeline.
-
-      The preview function will not call any external data sources but calculate a preview based on the provided sample data.
-
-      To preview a pipeline attached to an endpoint, please use `xapixctl preview-ep` to see the correct preview.
-
-      Examples:
-      \x5> $ xapixctl preview -o xapix -p some-project pipeline
-    LONGDESC
-    def preview(pipeline)
-      connection.pipeline_preview(pipeline, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
-        res.on_success { |preview| puts preview }
-        res.on_error { |err, result| warn_api_error('could not fetch preview', err, result) }
-      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 "preview-ep ID", "Preview an endpoint"
-    long_desc <<-LONGDESC
-      `xapixctl preview-ep` will return a preview of the given endpoint.
-
-      The preview function will not call any external data sources but calculate a preview based on the provided sample data.
-
-      Examples:
-      \x5> $ xapixctl preview-ep -o xapix -p some-project endpoint
-    LONGDESC
-    def preview_ep(endpoint)
-      connection.endpoint_preview(endpoint, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
-        res.on_success { |preview| puts preview }
-        res.on_error { |err, result| warn_api_error('could not fetch preview', err, result) }
-      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"
@@ -230,43 +188,5 @@ module Xapixctl
         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

@@ -2,7 +2,6 @@
 
 module Xapixctl
   module PhoenixClient
-
     class ResultHandler
       def initialize(default_success_handler:, default_error_handler:)
         @success_handler = default_success_handler
@@ -34,12 +33,12 @@ module Xapixctl
     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') } }
+      all: ->(data) { "id  : %<id>s\nkind: %<kind>s\nname: %<name>s\n\n" % { id: data.dig('metadata', 'id'), kind: data['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) }) },
+      yaml: ->(data) { Psych.dump(data) },
       text: ->(data) { (TEXT_FORMATTERS[data.dig('metadata', 'type')] || TEXT_FORMATTERS[:all]).call(data) }
     }.freeze
 
@@ -80,10 +79,13 @@ module Xapixctl
         Schema
         DataSource
         Pipeline
+        Service
         EndpointGroup
         Endpoint
         StreamGroup
         Stream
+        Scheduler
+        StreamProcessor
         ApiPublishing
         ApiPublishingRole
       ].freeze
@@ -134,6 +136,13 @@ module Xapixctl
           run { @client[endpoint_preview_path(org, project, endpoint_id)].get }
       end
 
+      def stream_processor_preview(stream_processor_id, org:, project:, format: :hash, &block)
+        result_handler(block).
+          prepare_data(->(data) { data['stream_processor_preview'] }).
+          formatter(PREVIEW_FORMATTERS[format]).
+          run { @client[stream_processor_preview_path(org, project, stream_processor_id)].get }
+      end
+
       def publish(org:, project:, &block)
         result_handler(block).
           run { @client[project_publications_path(org, project)].post('') }
@@ -190,6 +199,10 @@ module Xapixctl
         "/projects/#{org}/#{project}/endpoints/#{endpoint}/preview"
       end
 
+      def stream_processor_preview_path(org, project, stream_processor)
+        "/projects/#{org}/#{project}/stream_processors/#{stream_processor}/preview"
+      end
+
       def project_publications_path(org, project)
         "/projects/#{org}/#{project}/publications"
       end

data/lib/xapixctl/preview_cli.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'xapixctl/base_cli'
+
+module Xapixctl
+  class Preview < BaseCli
+    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 "pipeline ID", "Preview a pipeline"
+    long_desc <<-LONGDESC
+      `xapixctl preview pipeline` will return a preview of the given pipeline.
+
+      The preview function will not call any external data sources but calculate a preview based on the provided sample data.
+
+      To preview a pipeline attached to an endpoint, please use `xapixctl preview endpoint` to see the correct preview.
+
+      Examples:
+      \x5> $ xapixctl preview pipeline -o xapix -p some-project pipeline
+    LONGDESC
+    def pipeline(pipeline)
+      connection.pipeline_preview(pipeline, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
+        res.on_success { |preview| puts preview }
+        res.on_error { |err, result| warn_api_error('could not fetch preview', err, result) }
+      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 "endpoint ID", "Preview an endpoint"
+    long_desc <<-LONGDESC
+      `xapixctl preview endpoint` will return a preview of the given endpoint.
+
+      The preview function will not call any external data sources but calculate a preview based on the provided sample data.
+
+      Examples:
+      \x5> $ xapixctl preview endpoint -o xapix -p some-project endpoint
+    LONGDESC
+    def endpoint(endpoint)
+      connection.endpoint_preview(endpoint, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
+        res.on_success { |preview| puts preview }
+        res.on_error { |err, result| warn_api_error('could not fetch preview', err, result) }
+      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 "stream-processor ID", "Preview a stream processor"
+    long_desc <<-LONGDESC
+      `xapixctl preview stream-processor` will return a preview of the given stream processor.
+
+      The preview function will not call any external data sources but calculate a preview based on the provided sample data.
+
+      Examples:
+      \x5> $ xapixctl preview stream-processor -o xapix -p some-project processor
+    LONGDESC
+    def stream_processor(stream_processor)
+      connection.stream_processor_preview(stream_processor, org: options[:org], project: options[:project], format: options[:format].to_sym) do |res|
+        res.on_success { |preview| puts preview }
+        res.on_error { |err, result| warn_api_error('could not fetch preview', err, result) }
+      end
+    end
+  end
+end

data/lib/xapixctl/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Xapixctl
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/xapixctl.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Michael Reinsch"]
   spec.email         = ["michael@xapix.io"]
 
-  spec.summary       = %q{xapix client library and command line tool}
+  spec.summary       = 'xapix client library and command line tool'
   spec.homepage      = "https://github.com/xapix-io/xapixctl"
   spec.license       = "EPL-2.0"
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -26,11 +26,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport", ">= 5.2.3", "< 6.0.0"
   spec.add_dependency "rest-client", ">= 2.1.0", "< 3.0.0"
-  spec.add_dependency "thor", ">= 0.20.3", "< 1.0.0"
+  spec.add_dependency "thor", ">= 1.0.0", "< 1.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "relaxed-rubocop", "~> 2.5"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 0.85.0"
+  spec.add_development_dependency "rubocop", "~> 0.89"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapixctl
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Michael Reinsch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -132,14 +132,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.0
+        version: '0.89'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.85.0
+        version: '0.89'
 description:
 email:
 - michael@xapix.io
@@ -161,8 +161,10 @@ files:
 - bin/setup
 - exe/xapixctl
 - lib/xapixctl.rb
+- lib/xapixctl/base_cli.rb
 - lib/xapixctl/cli.rb
 - lib/xapixctl/phoenix_client.rb
+- lib/xapixctl/preview_cli.rb
 - lib/xapixctl/version.rb
 - xapixctl.gemspec
 homepage: https://github.com/xapix-io/xapixctl