bmc-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1e5d542a5466d08fe7c79b45c4d1a318153873c44d67e8b813e0d00fe371647
+  data.tar.gz: c0fbeef4be689e9c1290d3d2e2c8cef956db9b92bd4296ff0ec56087527937c6
+SHA512:
+  metadata.gz: 5ea5ce3b12fc00a83eaea18790a20f0b04aa176507a9c83b88b112230ed4fc0c50c28a54fd6b71ebfdb6d7907509884605417a6f779df06219e12f127db279f1
+  data.tar.gz: 4661731d08c7d774af649c8c4d448ef1577886864753698d1d42a62ae94a3c3a7baf6c8490d95e3e993a9da1db606ba6a1daedfbf989a4a4954d8fcd1a97042e

data/lib/bmc-sdk.rb

@@ -0,0 +1,73 @@
+require 'os'
+require 'oauth2'
+require 'yaml'
+
+module Bmc
+end
+
+##
+# This module provides commands and DTOs for working with the BMC API documented at https://developers.phoenixnap.com/docs/bmc/1/overview. 
+# Module functions provided here which load configuration assume that client credentials are located in a YAML file at $HOME/.pnap/config.
+#
+
+module Bmc::Sdk
+
+  ##
+  # The API entrypoint URL.
+  Entrypoint = "https://api.phoenixnap.com/bmc/v1/"
+
+  ##
+  # The OIDC token URL
+  TokenURL = "https://auth.phoenixnap.com/auth/realms/BMC/protocol/openid-connect/token"
+
+  ##
+  # The default configuration file location on POSIX systems
+  POSIXPath = "/.pnap/config"
+
+  ##
+  # The default configuration file location on Windows systems
+  WindowsPath = '\\AppData\\Roaming\\pnap\\config'
+
+  ##
+  # The computed configuration file location based on the current system
+  ConfigPath = OS.windows? ? Dir.home + WindowsPath : Dir.home + POSIXPath
+
+  require 'commands.rb'
+  require 'dtos.rb'
+
+  ##
+  # This function creates a new HTTP client with integrated OAuth2 with the provided configuration.
+  #
+
+  def new_client(config)
+    cfg = config.dup
+    client = OAuth2::Client.new(
+      cfg[:client_id],
+      cfg[:client_secret],
+      token_url: TokenURL)
+    return client.client_credentials.get_token
+  end
+  module_function :new_client
+
+  ##
+  # load_client is a shortcut function which loads configuration from the expected location and uses that configuration to produce a new client.
+  #
+
+  def load_client
+    cfg = load_config
+    return new_client({
+      client_id: cfg['client_id'],
+      client_secret: cfg['client_secret']
+    })
+  end
+  module_function :load_client
+
+  ##
+  # load_config loads a YAML file from the expected file path.
+
+  def load_config
+    return YAML.load_file(ConfigPath)
+  end
+  module_function :load_config
+
+end

data/lib/commands.rb

@@ -0,0 +1,283 @@
+require 'json'
+
+module Bmc::Sdk
+
+  ##
+  # CreateServer command create (request) a new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8.
+  #
+
+  class CreateServer
+    attr_accessor :server
+
+    # server is a ProvisionedServer
+    def initialize(client, server)
+      @client = client
+      @server = server
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers",
+        headers: {'Content-Type': 'application/json'},
+        body: @server.to_json)
+    end
+  end
+
+  ##
+  # DeleteServer command will deprovision specific server with the given server ID.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/delete
+
+  class DeleteServer
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.delete(
+        "#{Entrypoint}servers/#{serverID}",
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # GetServer command will get server properties for a given server ID.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/get
+
+  class GetServer
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.get(
+        "#{Entrypoint}servers/#{serverID}", 
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # GetServers command will get server properties for all servers in an account.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/get
+
+  class GetServers
+    def initialize(client)
+      @client = client
+    end
+
+    def execute
+      return @client.get(
+        "#{Entrypoint}servers",
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # PowerOff command will power off a specific server.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/actions/power-off/post
+
+  class PowerOff
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers/#{serverID}/actions/power-off", 
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # PowerOn command will power on a specific server.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/actions/power-on/post
+
+  class PowerOn
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers/#{serverID}/actions/power-on", 
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # Reboot command will reboot a specific server.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/actions/reboot/post
+
+  class Reboot
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers/#{serverID}/actions/reboot", 
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # Reset command will reset the configuration for a specific server.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/actions/reset/post
+
+  class Reset
+    attr_accessor :server
+
+    # server is a ProvisionedServer
+    def initialize(client, server)
+      @client = client
+      @server = server
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers/#{@server.id}/actions/reset",
+        headers: {'Content-Type': 'application/json'},
+        body: @server.to_json)
+    end
+  end
+
+  ##
+  # Shutdown command will shutdown a specific server
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/servers/%7Bserver_id%7D/actions/shutdown/post
+
+  class Shutdown
+    attr_accessor :serverID
+
+    def initialize(client, serverID)
+      @client = client
+      @serverID = serverID
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}servers/#{serverID}/actions/shutdown", 
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # GetSSHKeys command will list all SSH keys associated with an account
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/get
+
+  class GetSSHKeys
+   def initialize(client)
+     @client = client
+   end
+
+   def execute
+     return @client.get(
+       "#{Entrypoint}ssh-keys",
+       headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # CreateSSHKey command will create a new SSH key with the provided properties.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/post
+
+  class CreateSSHKey
+    attr_accessor :sshKey
+
+    def initialize(client, sshKey)
+      @client = client
+      @sshKey = sshKey
+    end
+
+    def execute
+      return @client.post(
+        "#{Entrypoint}ssh-keys",
+        headers: {'Content-Type': 'application/json'},
+        body: @sshKey.to_json)
+    end
+  end
+
+  ##
+  # DeleteSSHKey command will delete the SSH key with the specified ID.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/%7Bssh_key_id%7D/delete
+
+  class DeleteSSHKey
+    attr_accessor :sshKeyID
+
+    def initialize(client, sshKeyID)
+      @client = client
+      @sshKeyID = sshKeyID
+    end
+
+    def execute
+      return @client.delete(
+        "#{Entrypoint}ssh-keys/#{sshKeyID}",
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # GetSSHKey command will retrieve the SSH key with the specified ID.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/%7Bssh_key_id%7D/get
+
+  class GetSSHKey
+    attr_accessor :sshKeyID
+
+    def initialize(client, sshKeyID)
+      @client = client
+      @sshKeyID = sshKeyID
+    end
+
+    def execute
+      return @client.get(
+        "#{Entrypoint}ssh-keys/#{sshKeyID}",
+        headers: {'Content-Type': 'application/json'})
+    end
+  end
+
+  ##
+  # GetSSHKey command will update the SSH key with the specified ID.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/%7Bssh_key_id%7D/put
+
+  class EditSSHKey
+    attr_accessor :sshKey
+
+    def initialize(client, sshKey)
+      @client = client
+      @sshKey = sshKey
+    end
+
+    def execute
+      return @client.put(
+        "#{Entrypoint}ssh-keys/#{@sshKey.id}",
+        headers: {'Content-Type': 'application/json'},
+        body: @sshKey.to_json)
+    end
+  end
+end

data/lib/dtos.rb

@@ -0,0 +1,106 @@
+module Bmc::Sdk
+
+  ##
+  # ErrorMessage is used to transmit details on error responses.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/types/Error
+
+  class ErrorMessage
+    attr_accessor :message, :validationErrors
+    def initialize(message, validationErrors)
+      @message = message
+      @validationErrors = validationErrors
+    end
+    def to_json(*a)
+      {message: @message, validationErrors: @validationErrors}.to_json(*a)
+    end
+  end
+
+  ##
+  # LongServer is used to transmit details on fully specified server responses.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/types/Server
+
+  class LongServer
+    attr_accessor :id, :status, :hostname, :description, :privateIPAddresses, :publicIPAddresses, :os, :type, :location, :cpu, :ram, :storage
+    def initialize(id, status, hostname, description, privateIPAddresses, publicIPAddresses, os, type, location, cpu, ram, storage)
+      @id = id
+      @status = status
+      @hostname = hostname
+      @description = description
+      @privateIPAddresses = privateIPAddresses
+      @publicIPAddresses = publicIPAddresses
+      @os = os
+      @type = type
+      @location = location
+      @cpu = cpu
+      @ram = ram
+      @storage = storage
+    end
+    def to_json(*a)
+      {id: @id, status: @status, hostname: @hostname, description: @description, privateIpAddresses: @privateIPAddresses, publicIPAddresses: @publicIpAddresses, os: @os, type: @type, location: @location, cpu: @cpu, ram: @ram, storage: @storage }.to_json(*a)
+    end
+  end
+
+  ##
+  # ProvisionedServer is used to transmit details on CreateServer commands.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/types/ServerCreate
+
+  class ProvisionedServer
+    attr_accessor :id, :status, :hostname, :description, :os, :type, :location, :sshKeys, :sshKeyIds
+    def initialize(id, status, hostname, description, os, type, location, sshKeys, sshKeyIds)
+      @id = id
+      @status = status
+      @hostname = hostname
+      @description = description
+      @os = os
+      @type = type
+      @location = location
+      @sshKeys = sshKeys
+      @sshKeyIds = sshKeyIds
+    end
+    def to_json(*a)
+      {id: @id, status: @status, hostname: @hostname, description: @description, os: @os, type: @type, location: @location, sshKeys: @sshKeys, sshKeyIds: @sshKeyIds}.to_json(*a)
+    end
+  end
+
+  ##
+  # ServerResetSpec is used to transmit details on ServerReset commands.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/types/ServerReset
+
+  class ServerResetSpec
+    attr_accessor :id, :sshKeys, :sshKeyIds, :installDefaultSshKeys
+    def initialize(id, sshKeys, sshKeyIds, installDefaultSshKeys)
+      @id = id
+      @sshKeys = sshKeys
+      @sshKeyIds = sshKeyIds
+      @installDefaultSshKeys = installDefaultSshKeys
+    end
+    def to_json(*a)
+      {id: @id, status: @status, sshKeys: @sshKeys, sshKeyIds: @sshKeyIds, installDefaultSshKeys: @installDefaultSshKeys}.to_json(*a)
+    end
+  end
+
+  ##
+  # SSHKeySpec is used to transmit details for BMC SSH Key objects.
+  #
+  # @see https://developers.phoenixnap.com/docs/bmc/1/types/SshKey
+
+  class SSHKeySpec
+    attr_accessor :id, :default, :name, :key, :fingerprint, :createdOn, :lastUpdatedOn
+    def initialize(id, default, name, key, fingerprint, createdOn, lastUpdatedOn)
+      @id = id
+      @default = default
+      @name = name
+      @key = key
+      @fingerprint = fingerprint
+      @createdOn = createdOn
+      @lastUpdatedOn = lastUpdatedOn
+    end
+    def to_json(*a)
+      {id: @id, default: @default, name: @name, key: @key, fingerprint: @fingerprint, createdOn: @createdOn, lastUpdatedOn: @lastUpdatedOn}.to_json(*a)
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: bmc-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PhoenixNAP
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+description: An SDK for interacting with the BMC API. See https://developers.phoenixnap.com/docs/bmc/1/overview
+email: support@phoenixnap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bmc-sdk.rb
+- lib/commands.rb
+- lib/dtos.rb
+homepage: https://github.com/phoenixnap/bmc-sdk-ruby
+licenses:
+- MPL-2.0
+metadata: {}
+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.8
+signing_key: 
+specification_version: 4
+summary: An SDK for interacting with the BMC API.
+test_files: []