xapixctl 1.0.0 → 1.2.1

data/lib/xapixctl/phoenix_client/result_handler.rb

@@ -0,0 +1,35 @@
+# 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
+  end
+end

data/lib/xapixctl/preview_cli.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'xapixctl/base_cli'
+
+module Xapixctl
+  class PreviewCli < BaseCli
+    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
+      \x5> $ xapixctl preview pipeline -p xapix/some-project pipeline
+    LONGDESC
+    def pipeline(pipeline)
+      puts prj_connection.pipeline_preview(pipeline, format: options[:format].to_sym)
+    end
+
+    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
+      \x5> $ xapixctl preview endpoint -p xapix/some-project endpoint
+    LONGDESC
+    def endpoint(endpoint)
+      puts prj_connection.endpoint_preview(endpoint, format: options[:format].to_sym)
+    end
+
+    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
+      \x5> $ xapixctl preview stream-processor -p xapix/some-project processor
+    LONGDESC
+    def stream_processor(stream_processor)
+      puts prj_connection.stream_processor_preview(stream_processor, format: options[:format].to_sym)
+    end
+  end
+end

data/lib/xapixctl/sync_cli.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'xapixctl/base_cli'
+require 'pathname'
+
+module Xapixctl
+  class SyncCli < BaseCli
+    class_option :credentials, desc: "Whether to include Credential resources in sync", type: :boolean, default: true
+    class_option :exclude_types, desc: "Resource types to exclude from sync", type: :array
+
+    desc "to-dir DIRECTORY", "Syncs resources in project to directory"
+    long_desc <<-LONGDESC
+      `xapixctl sync to-dir DIRECTORY` will export all resources of a given project and remove any additional resources from the directory.
+
+      With --no-credentials you can exclude all credentials from getting exported.
+
+      With --exclude-types you can specify any resource types besides Project you'd like to exclude.
+
+      When excluding types, the excluded types will be recorded in the sync directory in a file called .excluded_types, so that any future syncs will exclude those types.
+
+      Examples:
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project --no-credentials
+      \x5> $ xapixctl sync to-dir ./project_dir -p xapix/some-project --exclude-types=ApiPublishing ApiPublishingRole Credential
+    LONGDESC
+    def to_dir(dir)
+      sync_path = SyncPath.new(dir, prj_connection.resource_types_for_export, excluded_types)
+
+      res_details = prj_connection.project_resource
+      sync_path.write_file(generate_readme(res_details), 'README.md')
+      sync_path.write_resource_yaml(res_details, 'project')
+
+      sync_path.types_to_sync.each do |type|
+        res_path = sync_path.resource_path(type)
+        prj_connection.resource_ids(type).each do |res_id|
+          res_details = prj_connection.resource(type, res_id)
+          res_path.write_resource_yaml(res_details, res_id)
+        end
+        res_path.remove_outdated_resources
+      end
+      sync_path.update_excluded_types_file
+    end
+
+    desc "from-dir DIRECTORY", "Syncs resources in project from directory"
+    long_desc <<-LONGDESC
+      `xapixctl sync from-dir project dir` will import all resources into the given project from the directory and remove any additional resources which are not present in the directory.
+
+      With --no-credentials you can exclude all credentials from getting exported.
+
+      With --exclude-types you can specify any resource types besides Project you'd like to exclude.
+
+      Examples:
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project --no-credentials
+      \x5> $ xapixctl sync from-dir ./project_dir -p xapix/some-project --exclude-types=ApiPublishing ApiPublishingRole Credential
+    LONGDESC
+    def from_dir(dir)
+      sync_path = SyncPath.new(dir, prj_connection.resource_types_for_export, excluded_types)
+
+      sync_path.load_resource('project') do |desc|
+        puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')} to #{prj_connection.project}"
+        desc['metadata']['id'] = prj_connection.project
+        prj_connection.organization.apply(desc)
+      end
+
+      outdated_resources = {}
+      sync_path.types_to_sync.each do |type|
+        res_path = sync_path.resource_path(type)
+        updated_resource_ids = []
+        res_path.load_resources do |desc|
+          puts "applying #{desc['kind']} #{desc.dig('metadata', 'id')}"
+          updated_resource_ids += prj_connection.apply(desc)
+        end
+        outdated_resources[type] = prj_connection.resource_ids(type) - updated_resource_ids
+      end
+
+      outdated_resources.each do |type, resource_ids|
+        resource_ids.each do |resource_id|
+          puts "removing #{type} #{resource_id}"
+          prj_connection.delete(type, resource_id)
+        end
+      end
+    end
+
+    private
+
+    class ResourcePath
+      def initialize(path)
+        @path = path
+        @resource_files = []
+      end
+
+      def write_file(content, filename)
+        @path.mkpath
+        unless @path.directory? && @path.writable?
+          warn "Cannot write to #{@path}, please check directory exists and is writable"
+          exit 1
+        end
+        file = @path.join(filename)
+        file.write(content)
+        puts "updated #{file}..."
+        file
+      end
+
+      def write_resource_yaml(res_details, res_name)
+        file = write_file(res_details.to_yaml, "#{res_name}.yaml")
+        @resource_files << file
+        file
+      end
+
+      def load_resources(&block)
+        Util.resources_from_file(@path, ignore_missing: true, &block)
+      end
+
+      def load_resource(res_name, &block)
+        Util.resources_from_file(@path.join("#{res_name}.yaml"), ignore_missing: false, &block)
+      end
+
+      def remove_outdated_resources
+        (@path.glob('*.yaml') - @resource_files).each do |outdated_file|
+          outdated_file.delete
+          puts "removed #{outdated_file}"
+        end
+      end
+    end
+
+    class SyncPath < ResourcePath
+      attr_reader :types_to_sync
+
+      def initialize(dir, all_types, excluded_types)
+        super(Pathname.new(dir))
+        @all_types = all_types
+        @excluded_types_file = @path.join('.excluded_types')
+        @excluded_types = excluded_types || []
+        @excluded_types += @excluded_types_file.read.split if @excluded_types_file.exist?
+        @excluded_types &= @all_types
+        @excluded_types.sort!
+        @types_to_sync = @all_types - @excluded_types
+        puts "Resource types excluded from sync: #{@excluded_types.join(', ')}" if @excluded_types.any?
+      end
+
+      def resource_path(type)
+        ResourcePath.new(@path.join(type.underscore))
+      end
+
+      def update_excluded_types_file
+        @excluded_types_file.write(@excluded_types.join(" ") + "\n") if @excluded_types.any?
+      end
+    end
+
+    def excluded_types
+      excluded = options[:exclude_types]
+      excluded += ['Credential'] unless options[:credentials]
+      excluded
+    end
+
+    def generate_readme(res_details)
+      <<~EOREADME
+        # #{res_details.dig('definition', 'name')}
+        #{res_details.dig('definition', 'description')}
+
+        Project exported from #{File.join(prj_connection.public_project_url)} by xapixctl v#{Xapixctl::VERSION}.
+      EOREADME
+    end
+  end
+end

data/lib/xapixctl/util.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Xapixctl
+  module Util
+    extend self
+
+    class InvalidDocumentStructureError < StandardError
+      def initialize(file)
+        super("#{file} has invalid document structure")
+      end
+    end
+
+    DOCUMENT_STRUCTURE = %w[version kind metadata definition].freeze
+
+    def resources_from_file(filename, ignore_missing: false)
+      load_files(filename, ignore_missing) do |actual_file, yaml_string|
+        yaml_string.split(/^---\s*\n/).map { |yml| Psych.safe_load(yml) }.compact.each do |doc|
+          raise InvalidDocumentStructureError, actual_file unless (DOCUMENT_STRUCTURE - doc.keys.map(&:to_s)).empty?
+          yield doc
+        end
+      end
+    end
+
+    def load_files(filename, ignore_missing)
+      if filename == '-'
+        yield 'STDIN', $stdin.read
+      else
+        pn = filename.is_a?(Pathname) ? filename : Pathname.new(filename)
+        if pn.directory?
+          pn.glob(["**/*.yaml", "**/*.yml"]).sort.each { |dpn| yield dpn.to_s, dpn.read }
+        elsif pn.exist?
+          yield pn.to_s, pn.read
+        elsif !ignore_missing
+          warn "file not found: #{filename}"
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/xapixctl/version.rb

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

data/xapixctl.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "xapixctl/version"
@@ -8,7 +10,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,20 +19,25 @@ 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"
   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.required_ruby_version = '>= 2.6'
+
+  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", ">= 1.0.0", "< 1.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.17.3"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  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.79.0"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "~> 1.11.0"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2.0"
+  spec.add_development_dependency "webmock", "~> 3.11.0"
 end

metadata

@@ -1,85 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: xapixctl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Michael Reinsch
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2021-03-24 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: relaxed-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -100,29 +118,71 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
-description: 
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+description:
 email:
 - michael@xapix.io
 executables:
@@ -130,6 +190,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/cd.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -143,8 +204,16 @@ files:
 - bin/setup
 - exe/xapixctl
 - lib/xapixctl.rb
+- lib/xapixctl/base_cli.rb
 - lib/xapixctl/cli.rb
 - lib/xapixctl/phoenix_client.rb
+- lib/xapixctl/phoenix_client/connection.rb
+- lib/xapixctl/phoenix_client/organization_connection.rb
+- lib/xapixctl/phoenix_client/project_connection.rb
+- lib/xapixctl/phoenix_client/result_handler.rb
+- lib/xapixctl/preview_cli.rb
+- lib/xapixctl/sync_cli.rb
+- lib/xapixctl/util.rb
 - lib/xapixctl/version.rb
 - xapixctl.gemspec
 homepage: https://github.com/xapix-io/xapixctl
@@ -153,7 +222,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/xapix-io/xapixctl
   source_code_uri: https://github.com/xapix-io/xapixctl
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,15 +230,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: xapix client library and command line tool
 test_files: []