rockette 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2866e9216bcc77870fb829a23f4da29fbd89f74a0295a4ca4f65f7f555cd5c
-  data.tar.gz: 3e4c48b3266e2c701b398b7f485b19570c559488f7cd5262a06ae5e8a3b1f6ad
+  metadata.gz: 2870c274fb8f46b67ff9590364eeb0b68936e046a2a33c162de7410542c735af
+  data.tar.gz: b2932d43fbd1562c79b86408afb907b1db2bf4c2fb8d072fdd36d61393dccd92
 SHA512:
-  metadata.gz: a5d48288aa8a6c1c40ddf2cd3c13126053ced38e04fc76545195be38ab3f5dd67c50d35e7a1f74f0b679f4d720188b6138173b70719844c0a0bf1b21ff7c7a40
-  data.tar.gz: 2da2d82b7ac75cc3e3d53e7f6b13f5d4152309fa907e172f6f221407751a4f24666cd3e3c37e2a870738c6f3534772a1b97860de1037c492f6c4b3ec57adb4fe
+  metadata.gz: c214dc82ce832ae90d328447062ba8ac98a56ff3ab1056d7724123c8ae0da01bb3909845671b45ce2f869f6c2d880b326d8b7105f2a42c7069ac3618c3aad357
+  data.tar.gz: 1b9b8d76c9e547d8af19382d5b0eed3800f4e914f8f5dbe34933c75fdd1c766042ef289af4f0fd4f59167e8d71422a68edf35d88a71693cdba45e1c6781747f6

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.0.0] - 2021-02-08
 
 - Initial release
+
+
+## [0.0.1] - 2021-03-15
+
+- Unify rest calls into Rester class
+- Improve exception handling including socket errors
+- Switch to yaml for config
+- Use ~/.rockette as consistent location for config and exports

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rockette (0.0.0)
+    rockette (0.0.1)
       rest-client (~> 2.0)
       thor (~> 1.0)
 
@@ -9,11 +9,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.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)
+    method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0212)
@@ -22,6 +24,9 @@ GEM
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -55,6 +60,7 @@ PLATFORMS
 
 DEPENDENCIES
   minitest (~> 5.0)
+  pry (~> 0.0)
   rake (~> 13.0)
   rockette!
   rubocop (~> 1.7)

data/exe/rockette

@@ -1,21 +1,33 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib_path = File.expand_path('../lib', __dir__)
-$:.unshift(lib_path) if !$:.include?(lib_path)
-require 'rockette/cli'
+require "rockette"
 
-CONF = JSON.parse(File.read('config.json'))
+app_path = File.join(Dir.home, ".rockette")
+lib_path = File.expand_path("../lib", __dir__)
+tem_path = File.expand_path("../templates", __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+Dir.mkdir(app_path) unless File.exist?(app_path)
+unless File.exist?(File.join(app_path, "config.yml"))
+  template = File.read(File.join(tem_path, "config.yml.erb"))
+  data = ERB.new(template).result(binding)
+  File.write(File.join(app_path, "config.yml"), data)
+end
+Dir.mkdir(File.join(app_path, "exports")) unless File.exist?(File.join(app_path, "exports"))
+
+CONF = Psych.load(File.read(File.join(app_path, "config.yml")))
 ENV["THOR_SILENCE_DEPRECATION"] = "true"
+EXPORT_DIR = File.join(app_path, "exports")
 
-Signal.trap('INT') do
+Signal.trap("INT") do
   warn("\n#{caller.join("\n")}: interrupted")
   exit(1)
 end
 
 begin
   Rockette::CLI.start
-rescue Rockette::CLI::Error => err
-  puts "ERROR: #{err.message}"
+rescue Rockette::CLI::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
-end
+end

data/lib/rockette.rb

@@ -1,39 +1,91 @@
 # frozen_string_literal: true
 
-require_relative "rockette/version"
+require           "erb"
+require           "json"
+require           "psych"
+require           "rest-client"
+require           "thor"
+require_relative  "rockette/cli"
+require_relative  "rockette/text_helper"
+require_relative  "rockette/version"
 
+# APEX deployment
 module Rockette
   class Error < StandardError; end
-  # 
-  # # Export application on APEX instance
-  # def create_export(body, url)
-  #   response = RestClient.post url, body
-  #   response
-  # rescue StandardError => e
-  #   # change these, send back the error message, don't puts it!
-  #   puts "Unable to create export because #{e.message}" # puts error
-  # end
-
-  # # Grab application export from APEX instance
-  # def grab_export(url)
-  #   response = RestClient.get url
-  # rescue StandardError => e
-  #   puts "Unable to grab export because #{e.message}" # puts error
-  # end
-
-  # # Import application export into APEX instance
-  # def import_app(url, body)
-  #   response = RestClient.post url, body
-  # rescue StandardError => e
-  #   puts "Unable to import application because #{e.message}" # puts error
-  # end
-
-  # # Push attachment to api endpoint and show code
-  # def push_blob(filey, headers, url)
-  #   response = RestClient.post url, filey, headers
-  #   response
-  # rescue StandardError => e
-  #   puts "Unable to push file because #{e.message}" # puts error
-  # end
 
+  # rest-client calls with error handling and auto retries
+  class Rester
+    VERBS = {
+      "delete" => :Delete,
+      "get" => :Get,
+      "post" => :Post,
+      "put" => :Put
+    }.freeze
+
+    def initialize(headers: {}, meth: "Get", params: {}, url: "https://array/", config: {})
+      @headers = headers
+      @meth    = meth
+      @params  = params
+      @url     = url
+      @config = config
+      @config["timeout"] = @config["timeout"] ||= 30
+    end
+
+    def make_call
+      response = RestClient::Request.execute(headers: @headers,
+                                             method: VERBS[@meth.downcase], payload: @params,
+                                             timeout: @config["timeout"], url: @url, verify_ssl: false)
+    rescue SocketError => e
+      puts "#{e.class}: #{e.message}"
+      nil
+    rescue StandardError => e
+      e.response
+    else
+      response
+    end
+
+    def cookie
+      if @url =~ %r{auth/session}
+        response = make_call
+        raise "There was an issue getting a cookie!" unless response.code == 200
+
+        (response.cookies.map { |key, val| "#{key}=#{val}" })[0]
+      else
+        error_text("cookie", @url.to_s, "auth/session")
+      end
+    end
+
+    # use rest-client with retry
+    def rest_try
+      3.times do |i|
+        response = make_call
+        unless response.nil?
+          break response if (200..299).include? response.code
+          break response if i > 1
+        end
+        puts "Failed #{@meth} on #{@url}, retry...#{i + 1}"
+        sleep 3 unless i > 1
+        return nil if i > 1 # Handles socket errors, etc. where there is no response.
+      end
+    end
+
+    private
+
+    def error_text(method_name, url, wanted)
+      {
+        "response" =>
+          "ERROR: Wrong url for the #{method_name} method.\n"\
+          "Sent: #{url}\n"\
+          "Expected: \"#{wanted}\" as part of the url.",
+        "status" => 400
+      }
+    end
+
+    def responder(response)
+      {
+        "response" => JSON.parse(response.body),
+        "status" => response.code.to_i
+      }
+    end
+  end
 end

data/lib/rockette/cli.rb

@@ -1,65 +1,62 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'rest-client'
-require 'thor'
-
 module Rockette
   #
   # @api public
+  # Handle actions and parameters
   class CLI < Thor
     # Error raised by this runner
     Error = Class.new(StandardError)
 
-    desc 'version', 'rockette version'
+    desc "version", "rockette version"
     def version
-      require_relative 'version'
+      require_relative "version"
       puts "v#{Rockette::VERSION}"
     end
-    map %w(--version -v) => :version
+    map %w[--version -v] => :version
 
-    desc 'deploy', 'Deploy chosen export file to target APEX instance'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    option :app_id, aliases: '-a', :required => true,
-                        desc: 'Provide an APEX application ID'
-    option :file, aliases: '-f', :required => true,
-                        desc: 'Provide an APEX application export file (.sql)'
-    option :url, aliases: '-u', :required => true,
-                        desc: 'Provide a valid url'
+    desc "deploy", "Deploy chosen export file to target APEX instance"
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
+    option :app_id, aliases: "-a", required: true,
+                    desc: "Provide an APEX application ID"
+    option :file, aliases: "-f", required: true,
+                  desc: "Provide an APEX application export file (.sql)"
+    option :url, aliases: "-u", required: true,
+                 desc: "Provide a valid url"
     def deploy(*)
       if options[:help]
-        invoke :help, ['deploy']
+        invoke :help, ["deploy"]
       else
-        require_relative 'commands/deploy'
+        require_relative "commands/deploy"
         Rockette::Commands::Deploy.new(options).execute
       end
     end
 
-    desc 'export', 'Export and download application from target APEX environment'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
-    option :app_id, aliases: '-a', :required => true,
-                        desc: 'Provide an APEX application ID'
-    option :url, aliases: '-u', :required => true,
-                        desc: 'Provide a valid url'
+    desc "export", "Export and download application from target APEX environment"
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
+    option :app_id, aliases: "-a", required: true,
+                    desc: "Provide an APEX application ID"
+    option :url, aliases: "-u", required: true,
+                 desc: "Provide a valid url"
     def export(*)
       if options[:help]
-        invoke :help, ['export']
+        invoke :help, ["export"]
       else
-        require_relative 'commands/export'
+        require_relative "commands/export"
         Rockette::Commands::Export.new(options).execute
       end
     end
 
-    desc 'config', 'Command description...'
-    method_option :help, aliases: '-h', type: :boolean,
-                         desc: 'Display usage information'
+    desc "config", "Command description..."
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
     def config(*)
       if options[:help]
-        invoke :help, ['config']
+        invoke :help, ["config"]
       else
-        require_relative 'commands/config'
+        require_relative "commands/config"
         Rockette::Commands::Config.new(options).execute
       end
     end

data/lib/rockette/command.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
 module Rockette
+  # Enable tty- integration
   class Command
     extend Forwardable
 
@@ -24,7 +25,7 @@ module Rockette
     #
     # @api public
     def command(**options)
-      require 'tty-command'
+      require "tty-command"
       TTY::Command.new(options)
     end
 
@@ -34,7 +35,7 @@ module Rockette
     #
     # @api public
     def cursor
-      require 'tty-cursor'
+      require "tty-cursor"
       TTY::Cursor
     end
 
@@ -44,7 +45,7 @@ module Rockette
     #
     # @api public
     def editor
-      require 'tty-editor'
+      require "tty-editor"
       TTY::Editor
     end
 
@@ -54,7 +55,7 @@ module Rockette
     #
     # @api public
     def generator
-      require 'tty-file'
+      require "tty-file"
       TTY::File
     end
 
@@ -64,7 +65,7 @@ module Rockette
     #
     # @api public
     def pager(**options)
-      require 'tty-pager'
+      require "tty-pager"
       TTY::Pager.new(options)
     end
 
@@ -74,7 +75,7 @@ module Rockette
     #
     # @api public
     def platform
-      require 'tty-platform'
+      require "tty-platform"
       TTY::Platform.new
     end
 
@@ -84,7 +85,7 @@ module Rockette
     #
     # @api public
     def prompt(**options)
-      require 'tty-prompt'
+      require "tty-prompt"
       TTY::Prompt.new(options)
     end
 
@@ -94,7 +95,7 @@ module Rockette
     #
     # @api public
     def screen
-      require 'tty-screen'
+      require "tty-screen"
       TTY::Screen
     end
 
@@ -104,7 +105,7 @@ module Rockette
     #
     # @api public
     def which(*args)
-      require 'tty-which'
+      require "tty-which"
       TTY::Which.which(*args)
     end
 
@@ -114,7 +115,7 @@ module Rockette
     #
     # @api public
     def exec_exist?(*args)
-      require 'tty-which'
+      require "tty-which"
       TTY::Which.exist?(*args)
     end
   end

data/lib/rockette/commands/config.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Rockette
   module Commands
+    # Configure Rockette
     class Config < Rockette::Command
+      include TextHelper
+
       def initialize(options)
+        super()
         @options = options
       end
 
       def execute(input: $stdin, output: $stdout)
         # Command logic goes here ...
-        output.puts "OK"
+        output.puts "Coming soon..."
+        check_input(input)
       end
     end
   end

data/lib/rockette/commands/deploy.rb

@@ -1,51 +1,53 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Rockette
   module Commands
+    # Push export file and import into APEX
     class Deploy < Rockette::Command
+      include TextHelper
+
       def initialize(options)
+        super()
         @options = options
+        @filey = "f#{@options[:app_id]}.sql"
       end
 
-       # Import application export into APEX instance
-      def import_app(url, body)
-        response = RestClient.post url, body
-      rescue StandardError => e
-        puts "Unable to import application because #{e.message}" # puts error
+      def importer
+        body = CONF["deploy_body"]
+        body["app_id_src"] = @options[:app_id]
+        body["app_id_tgt"] = @options[:app_id]
+        # body["app_id_tgt"] = "0" #test app copy
+        url = "#{@options[:url]}deploy/app"
+        response = Rester.new(meth: "Post", params: body, url: url).rest_try
+        bail unless response
+        abort padder("Error. Got back response code: #{response.code}") unless (200..201).include? response.code
+        response
       end
 
-      # Push attachment to api endpoint and show code
-      def push_blob(filey, headers, url)
-        response = RestClient.post url, filey, headers
+      def pusher
+        push_hdrs = CONF["push_hdrs"]
+        push_hdrs["file_name"] = @filey
+        push_url = "#{@options[:url]}data_loader/blob"
+        # Push the chosen export file to the target system
+        filey = File.join(EXPORT_DIR, @filey)
+        response = Rester.new(headers: push_hdrs, meth: "Post", params: File.open(filey), url: push_url).rest_try
+        bail unless response
+        abort padder("Error. Got back response code: #{response.code}") unless (200..201).include? response.code
         response
-      rescue StandardError => e
-        puts "Unable to push file because #{e.message}" # puts error
       end
 
       def execute(input: $stdin, output: $stdout)
+        check_input(input)
         # Create and download export
-        output.puts "OK, deploying export file #{@options[:file]}"
-        filey = "f#{@options[:app_id]}.sql"
-        # First push the chosen export file to the target system.
-        push_hdrs = CONF["push_hdrs"]
-        push_hdrs["file_name"] = filey
-        push_url = @options[:url] + 'data_loader/blob'
-        pusher = push_blob(File.open(filey), push_hdrs, push_url)
+        output.puts padder("OK, deploying export file #{@filey}")
+        pusher
+        output.puts padder("Pushed #{@filey} to instance and attempting import now...")
         # If push was successful, request application import
-        if pusher.code == 200 || pusher.code == 201
-          sleep 1 # replace with check for file on server
-          puts "Pushed #{filey} and attempting import now..."
-          body = CONF["deploy_body"]
-          body["app_id_src"] = @options[:app_id]
-          body["app_id_tgt"] = @options[:app_id]
-          body["app_id_tgt"] = "0" #test app copy
-          deploy = import_app(@options[:url] + 'deploy/app', body)
-          puts deploy.code
-          puts deploy.headers
-          puts deploy.body
-        end
+        sleep 1
+        importer
+        output.puts padder("Deployed #{@filey} to target APEX instance: #{@options[:url]}")
       end
     end
   end

data/lib/rockette/commands/export.rb

@@ -1,50 +1,55 @@
 # frozen_string_literal: true
 
-require_relative '../command'
+require_relative "../command"
 
 module Rockette
   module Commands
+    # Export and download APEX application
     class Export < Rockette::Command
+      include TextHelper
+
       def initialize(options)
+        super()
         @options = options
+        @filey = "f#{@options[:app_id]}.sql"
+      end
+
+      def checker
+        app_url = "#{@options[:url]}deploy/apps/#{@options[:app_id]}"
+        response = Rester.new(url: app_url).rest_try
+        bail unless response
+        abort padder("App ID: #{@options[:app_id]}, not found. Received: #{response.code}") unless response.code == 200
       end
 
-      # Export application on APEX instance
-      def create_export(body, url)
-        response = RestClient.post url, body
+      def exporter
+        checker
+        puts padder("Found Application ID: #{@options[:app_id]}, proceeding...")
+        body = { "app_id" => @options[:app_id] }
+        export_url = "#{@options[:url]}deploy/app_export"
+        response = Rester.new(meth: "Post", params: body, url: export_url).rest_try
+        bail unless response
+        abort padder("Export failed for App ID: #{@options[:app_id]}.") unless (200..201).include? response.code
         response
-      rescue StandardError => e
-        # change these, send back the error message, don't puts it!
-        puts "Unable to create export because #{e.message}" # puts error
       end
 
-      # Grab application export from APEX instance
-      def grab_export(url)
-        response = RestClient.get url
-      rescue StandardError => e
-        puts "Unable to grab export because #{e.message}" # puts error
+      def grabber
+        export_url = "#{@options[:url]}deploy/app_export/#{@filey}"
+        response = Rester.new(url: export_url).rest_try
+        bail unless response
+        abort padder("Download failed for App ID: #{@options[:app_id]}.") unless (200..201).include? response.code
+        response
       end
 
       def execute(input: $stdin, output: $stdout)
+        check_input(input)
         # Create and download export
-        output.puts "OK, exporting App ID: #{@options[:app_id]}"
-        filey = "f#{@options[:app_id]}.sql"
-        body = {
-          "app_id" => @options[:app_id]
-        }
-        export_url = @options[:url] + 'deploy/app_export'
-        puts export_url
-        export = create_export(body, export_url)
-        if export.code == 201 # Check if export was successfully created first
-          sleep 1 # Change to query api to see if file is there
-          export_url = export_url + '/' + filey
-          response = grab_export(export_url)
-          # Now write file if export was grabbed.
-          if response.code == 200 || response.code == 201
-            File.open(filey, 'wb') {|file| file.write(response.body)}
-            puts "Downloaded #{filey} and all done here."
-          end
-        end
+        exporter
+        output.puts padder("Export created, downloading...")
+        sleep 1
+        response = grabber
+        # Write file if export was grabbed.
+        File.open(File.join(EXPORT_DIR, @filey), "wb") { |file| file.write(response.body) }
+        output.puts padder("Finished downloading #{@filey}. Have a good one!")
       end
     end
   end

data/lib/rockette/text_helper.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Add common methods to Rockette module
+module TextHelper
+  def bail
+    puts "Bailing, unable to check for application. Can you access the url from here?"
+    puts "Double check the url and make sure you have a network connection to the target."
+    exit
+  end
+
+  def check_input(input)
+    input unless input.nil?
+  end
+
+  def padder(str)
+    "\n#{str}\n"
+  end
+end

data/lib/rockette/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rockette
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/rockette.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   # Dev dependencies
   spec.add_development_dependency "pry", "~> 0.0"
-  
+
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "rest-client", "~> 2.0"
   spec.add_dependency "thor", "~> 1.0"

data/templates/config.yml.erb

@@ -0,0 +1,17 @@
+---
+push_hdrs:
+  Content-Type: application/json
+  created_by: dcs_automation
+  message_date: ''
+  msg_from_addr: ''
+  msg_from_name: ''
+  file_charset: UTF-8
+  file_mimetype: text/plain
+  file_name: ''
+  file_type: sql
+  tags: ''
+  target_use: push_deployment
+deploy_body:
+  app_id_src: ''
+  app_id_tgt: ''
+  blob_url: https://local.data_loader

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rockette
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Kody Wilson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,8 +80,10 @@ files:
 - lib/rockette/commands/config.rb
 - lib/rockette/commands/deploy.rb
 - lib/rockette/commands/export.rb
+- lib/rockette/text_helper.rb
 - lib/rockette/version.rb
 - rockette.gemspec
+- templates/config.yml.erb
 homepage: https://github.com/kodywilson/rockette
 licenses:
 - MIT