morpheus-cli 4.2.16 → 4.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3481d47679761310fbffd07ad968588ace4b92d9f428f68983f90a3ef4e13799
-  data.tar.gz: 5c900c15f68c14d5ab10d89b148e2bee5216653c123004b528f3d8bf1c1740cb
+  metadata.gz: 5ca98cbe4891f98ca85702bb9794a0f255e8208a22b30189220bbec1a48dd3b0
+  data.tar.gz: 5c46ca8fc5d4944d7e5f363731652f1933e7a07226904d4b1c3829d9456ba64c
 SHA512:
-  metadata.gz: 384148f22d822c664456d5de65813d8ff6e4ea07b9a26a68ab8803131aa43247e093f4cae9304cb591d58f6f075bebccdbbdd2ca614f615b33ebc46b242a8cf2
-  data.tar.gz: 8ae2af56264a5bb3163ae5b8bb04747f58ef4e96f3ecdfed5b3a66e14ebce5147ef73623624fc22ab16536d4834a21b7de8a7b57952b86a9ad128abb712cf37f
+  metadata.gz: 5f8b8ead51a8d5953f51b3543e293eff03b329a5ec1f8194a5956426f7f38716a210c99d4114c5e14feff24f74f9756c88db71be0dd094db279a40122ef115f4
+  data.tar.gz: bf432f7ec48ea911a36029ae66f58339627e34a3548f60f36d7a49f7cc018728f3f77556d6abec53f1cff8490a6354db14b1664e3c546cf625dc2c637b573271

data/Dockerfile

@@ -1,5 +1,5 @@
 FROM ruby:2.5.1
 
-RUN gem install morpheus-cli -v 4.2.16
+RUN gem install morpheus-cli -v 4.2.17
 
 ENTRYPOINT ["morpheus"]

data/README.md

@@ -11,7 +11,11 @@ This library is a Ruby gem that provides a command line interface for interactin
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it using rubygems
+
+    $ gem install morpheus-cli
+
+Or add this line to your application's Gemfile:
 
     gem 'morpheus-cli'
 
@@ -19,15 +23,13 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
 
-    $ gem install morpheus-cli
 
 ## Usage
 
-### morpheus binary
+### morpheus command
 
-This gem installs the [morpheus](https://github.com/gomorpheus/morpheus-cli/wiki/CLI-Manual) binary for executing commands in your shell environment. 
+This gem installs the [morpheus](https://github.com/gomorpheus/morpheus-cli/wiki/CLI-Manual) binary for running commands in your terminal shell. 
 
 ```sh
 morpheus remote add demo https://demo.mymorpheus.com
@@ -36,6 +38,6 @@ morpheus instances list
 
 ### ruby code
 
-If you want to interface with your Morpheus appliance via ruby directly, you can use [Morpheus::APIClient](https://github.com/gomorpheus/morpheus-cli/wiki/APIClient) or [Morpheus::Terminal](https://github.com/gomorpheus/morpheus-cli/wiki/Terminal).
+If you are interested in interfacing with the Morpheus appliance in ruby directly, you can use [Morpheus::APIClient](https://github.com/gomorpheus/morpheus-cli/wiki/APIClient) or [Morpheus::Terminal](https://github.com/gomorpheus/morpheus-cli/wiki/Terminal).
 
 For more detailed usage information, visit the [Morpheus CLI Wiki](https://github.com/gomorpheus/morpheus-cli/wiki).

data/lib/morpheus/api/api_client.rb

@@ -173,6 +173,9 @@ class Morpheus::APIClient
 
     # apply default headers
     opts[:headers] ||= {}
+
+    is_multipart = (opts[:payload].is_a?(Hash) && opts[:payload][:multipart])
+
     # Authorization: apply our access token
     if authorization_required?
       if @access_token
@@ -184,16 +187,16 @@ class Morpheus::APIClient
       end
     end
 
-    # Content-Type: apply interface default
-    if opts[:headers]['Content-Type'].nil? && default_content_type
-      opts[:headers]['Content-Type'] = default_content_type
-    end
-    
-    # default Content-Type to application/json if you pass a payload.
-    if opts[:headers]['Content-Type'].nil? && options[:payload]
-      opts[:headers]['Content-Type'] = 'application/json'
+    # Content-Type default is application/json
+    if opts[:headers]['Content-Type'].nil? && opts[:payload] && is_multipart == false
+      opts[:headers]['Content-Type'] = (default_content_type || 'application/json')
     end
 
+    # this could be nice too..
+    # if opts[:headers]['Content-Type'] == 'application/json' && opts[:payload].is_a?(Hash)
+    #   opts[:payload] = opts[:payload].to_json
+    # end
+
     # always use custom timeout eg. from --timeout option
     # or use default_timeout for GET requests only.
     if opts[:timeout].nil?
@@ -213,9 +216,9 @@ class Morpheus::APIClient
     # this is confusing, but RestClient expects :params inside the headers...?
     # move/copy params to headers.params for simplification.
     # remove this if issues arise
-    if opts[:params] && (opts[:headers][:params].nil? || opts[:headers][:params].empty?)
-      opts[:headers][:params] = opts[:params] # .delete(:params) maybe?
-    end
+    # if opts[:params] && (opts[:headers][:params].nil? || opts[:headers][:params].empty?)
+    #   opts[:headers][:params] = opts.delete(:params) # .delete(:params) maybe?
+    # end
 
     # :command_options for these
     # if options[:curl]
@@ -287,11 +290,14 @@ class Morpheus::APIClient
     return self
   end
 
-  def refresh_token()
-    if @refresh_token.nil?
+  def use_refresh_token(t=nil)
+    if t.nil?
+      t = @refresh_token
+    end
+    if t.nil?
       raise "#{self.class} does not currently have a refresh_token"
     end
-    response = auth.use_refresh_token(@refresh_token, self.client_id)
+    response = auth.use_refresh_token(t, self.client_id)
     @access_token = response['access_token']
     @refresh_token = response['refresh_token']
     if response['expires_in'] != nil
@@ -319,6 +325,10 @@ class Morpheus::APIClient
     }
   end
 
+  def doc
+    Morpheus::DocInterface.new(common_interface_options).setopts(@options)
+  end
+
   def ping
     Morpheus::PingInterface.new(common_interface_options).setopts(@options)
   end
@@ -746,6 +756,14 @@ class Morpheus::APIClient
     Morpheus::ProjectsInterface.new(common_interface_options).setopts(@options)
   end
 
+  def backups
+    Morpheus::BackupsInterface.new(common_interface_options).setopts(@options)
+  end
+
+  def backup_jobs
+    Morpheus::BackupJobsInterface.new(common_interface_options).setopts(@options)
+  end
+
   # add new interfaces here
 
 end

data/lib/morpheus/api/auth_interface.rb

@@ -15,7 +15,8 @@ class Morpheus::AuthInterface < Morpheus::APIClient
     url = "#{@base_url}/oauth/token"
     params = {grant_type: 'password', scope:'write', client_id: self.client_id, username: username}
     payload = {password: password}
-    opts = {method: :post, url: url, headers:{ params: params}, payload: payload, timeout: 5}
+    headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+    opts = {method: :post, url: url, headers: headers, params: params, payload: payload, timeout: 5}
     response = execute(opts)
     return response if @dry_run
     @access_token = response['access_token']
@@ -35,7 +36,8 @@ class Morpheus::AuthInterface < Morpheus::APIClient
     url = "#{@base_url}/oauth/token"
     params = {grant_type: 'refresh_token', scope:'write', client_id: self.client_id}
     payload = {refresh_token: refresh_token}
-    opts = {method: :post, url: url, headers:{ params: params}, payload: payload}
+    headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+    opts = {method: :post, url: url, headers: headers, params: params, payload: payload, timeout: 5}
     response = execute(opts)
     return response if @dry_run
     @access_token = response['access_token']

data/lib/morpheus/api/backup_jobs_interface.rb

@@ -0,0 +1,9 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::BackupJobsInterface < Morpheus::RestInterface
+
+  def base_path
+    "/api/backups/jobs"
+  end
+
+end

data/lib/morpheus/api/backups_interface.rb

@@ -0,0 +1,16 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::BackupsInterface < Morpheus::RestInterface
+
+  def base_path
+    "/api/backups"
+  end
+
+  def summary(params={})
+    execute(method: :get, url: "#{base_path}/summary", params: params)
+  end
+
+  def history(params={})
+    execute(method: :get, url: "#{base_path}/history", params: params)
+  end
+end

data/lib/morpheus/api/deploy_interface.rb

@@ -10,71 +10,40 @@ class Morpheus::DeployInterface < Morpheus::APIClient
     @expires_at = expires_at
   end
 
-
-  def get(instanceId, options=nil)
-    url = "#{@base_url}/api/instances/#{instanceId}/deploy"
-    headers = { params: {}, authorization: "Bearer #{@access_token}" }
-
-    if options.is_a?(Hash)
-      headers[:params].merge!(options)
-    elsif options.is_a?(String)
-      headers[:params]['name'] = options
-    end
-    execute(method: :get, url: url, headers: headers)
+  def base_path
+    # /api/deploys is now available in 5.0, switch to that eventually...
+    "/api/deploy"
   end
-
-
-  def create(instanceId, options=nil)
-    url = "#{@base_url}/api/instances/#{instanceId}/deploy"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    payload = options || {}
-    execute(method: :post, url: url, headers: headers, payload: payload.to_json)
+  def list(params={})
+    execute(method: :get, url: "#{base_path}", params: params)
   end
 
-  def list_files(id)
-    url = "#{@base_url}/api/deploy/#{id}/files"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    payload = options
-    execute(method: :get, url: url, headers: headers)
+  def get(instance_id, id, params={})
+    validate_id!(id)
+    execute(method: :get, url: "#{base_path}/#{id}", params: params)
   end
 
-  # todo: use execute() to support @dry_run?
-  def upload_file(id,path,destination=nil)
-    url = "#{@base_url}/api/deploy/#{id}/files"
-    if !destination.empty?
-      url += "/#{destination}"
-    end
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/octet-stream' }
-    opts = { method: :post, url: url, headers: headers, payload: File.new(path,'rb')}
-    if @dry_run
-      return opts
+  def create(instance_id, payload, params={})
+    if instance_id
+      execute(method: :post, url: "/api/instances/#{instance_id}/deploy", params: params, payload: payload.to_json)
+    else
+      execute(method: :post, url: "#{base_path}", params: params, payload: payload.to_json)
     end
-    uri = URI.parse(url)
-    req = Net::HTTP::Post::Multipart.new uri.path,
-    "file" => UploadIO.new(File.new(path,'rb'), "image/jpeg", File.basename(path))
-    # todo: iterate headers and abstract th :upload_io to execute() too.
-    req['Authorization'] = "Bearer #{@access_token}"
-    res = Net::HTTP.start(uri.host, uri.port) do |http|
-      http.request(req)
-    end
-    res
   end
 
-  def destroy(id)
-    url = "#{@base_url}/api/deploy/#{id}"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    execute(method: :delete, url: url, headers: headers)
+  def update(id, payload, params={})
+    validate_id!(id)
+    execute(url: "#{base_path}/#{id}", params: params, payload: payload.to_json, method: :put)
   end
 
-  def deploy(id, options)
-    url = "#{@base_url}/api/deploy/#{id}/deploy"
-    payload = options
-    if !options[:appDeploy].nil?
-      if !options[:appDeploy][:config].nil?
-        options[:appDeploy][:config] = options[:appDeploy][:config].to_json
-      end
-    end
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    execute(method: :post, url: url, headers: headers, timeout: nil, payload: payload.to_json)
+  def destroy(id, params = {})
+    validate_id!(id)
+    execute(url: "#{base_path}/#{id}", params: params, method: :delete)
   end
+
+  def deploy(id, payload, params = {})
+    validate_id!(id)
+    execute(url: "#{base_path}/#{id}/deploy", params: params, payload: payload.to_json, method: :post)
+  end
+
 end

data/lib/morpheus/api/deployments_interface.rb

@@ -1,71 +1,60 @@
 require 'morpheus/api/api_client'
 
-class Morpheus::DeploymentsInterface < Morpheus::APIClient
-  def initialize(access_token, refresh_token,expires_at = nil, base_url=nil) 
-    @access_token = access_token
-    @refresh_token = refresh_token
-    @base_url = base_url
-    @expires_at = expires_at
-  end
+class Morpheus::DeploymentsInterface < Morpheus::RestInterface
 
-  def list(params={})
-    url = "#{@base_url}/api/deployments"
-    headers = { params: params, authorization: "Bearer #{@access_token}" }
-    opts = {method: :get, url: url, headers: headers}
-    execute(opts)
-  end
-  
-  def get(options=nil)
-    url = "#{@base_url}/api/deployments"
-    headers = { params: {}, authorization: "Bearer #{@access_token}" }
-    if options.is_a?(Hash)
-      headers[:params].merge!(options)
-    elsif options.is_a?(Numeric)
-      url = "#{@base_url}/api/deployments/#{options}"
-    elsif options.is_a?(String)
-      headers[:params]['name'] = options
-    end
-    execute(method: :get, url: url, headers: headers)
+  def base_path
+    "/api/deployments"
   end
 
-  def list_versions(deployment_id,options=nil)
-    url = "#{@base_url}/api/deployments/#{deployment_id}/versions"
-    headers = { params: {}, authorization: "Bearer #{@access_token}" }
+  def list_versions(deployment_id, params={})
+    execute(method: :get, url: "#{base_path}/#{deployment_id}/versions", params: params)
+  end
 
-    if options.is_a?(Hash)
-      headers[:params].merge!(options)
-    elsif options.is_a?(Numeric)
-      url = "#{@base_url}/api/deployments/#{deployment_id}/versions/#{options}"
-    elsif options.is_a?(String)
-      headers[:params]['name'] = options
-    end
-    execute(method: :get, url: url, headers: headers)
+  def get_version(deployment_id, id, params={})
+    validate_id!(id)
+    execute(method: :get, url: "#{base_path}/#{deployment_id}/versions/#{id}", params: params)
   end
 
-  def get_version(deployment_id,version_id)
-    url = "#{@base_url}/api/deployments/#{deployment_id}/versions/#{version_id}"
-    headers = { params: {}, authorization: "Bearer #{@access_token}" }
-    execute(method: :get, url: url, headers: headers)
+  def create_version(deployment_id, payload, params={})
+    execute(method: :post, url: "#{base_path}/#{deployment_id}/versions", params: params, payload: payload.to_json)
   end
 
+  def update_version(deployment_id, id, payload, params={})
+    validate_id!(id)
+    execute(method: :put, url: "#{base_path}/#{deployment_id}/versions/#{id}", params: params, payload: payload.to_json)
+  end
 
-  def create(options)
-    url = "#{@base_url}/api/deployments"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    payload = options
-    execute(method: :post, url: url, headers: headers, payload: payload.to_json)
+  def destroy_version(deployment_id, id, params = {})
+    validate_id!(id)
+    execute(method: :delete, url: "#{base_path}/#{deployment_id}/versions/#{id}", params: params)
   end
 
-  def update(id, options)
-    url = "#{@base_url}/api/deployments/#{id}"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    payload = options
-    execute(method: :put, url: url, headers: headers, payload: payload.to_json)
+  def list_files(deployment_id, id, params={})
+    execute(method: :get, url: "#{base_path}/#{deployment_id}/versions/#{id}/files", params: params)
   end
 
-  def destroy(id)
-    url = "#{@base_url}/api/deployments/#{id}"
-    headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
-    execute(method: :delete, url: url, headers: headers)
+  # upload a file without multipart
+  # local_file is the full absolute local filename
+  # destination should be the full remote file path, including the file name.
+  def upload_file(deployment_id, id, local_file, destination, params={})
+    if destination.empty? || destination == "/" || destination == "." || destination.include?("../")
+      raise "#{self.class}.upload_file() passed a bad destination: '#{destination}'"
+    end
+    url = "#{@base_url}/#{base_path}/#{deployment_id}/versions/#{id}/files"
+    if !destination.to_s.empty?
+      url += "/#{destination}"
+    end
+    # use URI to escape path
+    uri = URI.parse(url)
+    url = uri.path
+    # params[:filename] = File.basename(destination)
+    if !local_file.kind_of?(File)
+      local_file = File.new(local_file, 'rb')
+    end
+    payload = local_file
+    headers = {'Content-Type' => 'application/octet-stream'}
+    headers['Content-Length'] = local_file.size # File.size(local_file)
+    execute(method: :post, url: url, headers: headers, payload: payload, params: params, timeout: 172800)
   end
+
 end

data/lib/morpheus/api/doc_interface.rb

@@ -0,0 +1,57 @@
+require 'morpheus/api/api_client'
+
+class Morpheus::DocInterface < Morpheus::APIClient
+  
+  # no Authorization header is required
+  def authorization_required?
+    false
+  end
+
+  def list(params={})
+    url = "/api/doc"
+    headers = {params: params}
+    execute(method: :get, url: url, headers: headers)
+  end
+
+  def swagger(params={})
+    url = "/api/doc/swagger"
+    # prefer /swagger.yml instead of /swagger?format=yml
+    fmt = params.delete('format')
+    if fmt
+      url = url + "." + fmt
+    end
+    is_yaml = fmt == "yml" || fmt == "yaml"
+    headers = {params: params}
+    execute(method: :get, url: url, headers: headers, timeout: 172800, parse_json: !is_yaml)
+  end
+
+  def download_swagger(outfile, params={})
+    # note that RestClient.execute still requires the full path with base_url
+    url = "#{@base_url}/api/doc/swagger"
+    # prefer /swagger.yml instead of /swagger?format=yml
+    fmt = params.delete('format')
+    if fmt
+      url = url + "." + fmt
+    end
+    headers = {params: params}
+    opts = {method: :get, url: url, headers: headers, timeout: 172800, parse_json: false}
+
+    if @dry_run
+      return opts
+    end
+
+    http_response = nil
+    File.open(File.expand_path(outfile), 'w') {|f|
+      block = proc { |response|
+        response.read_body do |chunk|
+          # writing to #{outfile} ..."
+          f.write chunk
+        end
+      }
+      opts[:block_response] = block
+      http_response = Morpheus::RestClient.execute(opts)
+    }
+    http_response
+  end
+
+end