latitude-api 0.2.0

data/lib/latitude/api/resources/virtual_machine.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    module Resources
+      # @!attribute [rw] name
+      #   @return [String]
+      # @!attribute [rw] status
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [rw] primary_ipv4
+      #   @return [String]
+      # @!attribute [rw] operating_system
+      #   @return [OperatingSystem]
+      # @!attribute [rw] site
+      #   @return [String]
+      # @!attribute [rw] billing
+      #   @return [String]
+      # @!attribute [rw] plan
+      #   @return [Plan]
+      # @!attribute [rw] specs
+      #   @return [Spec]
+      # @!attribute [rw] team
+      #   @return [Latitude::API::Objects::Team]
+      # @!attribute [rw] project
+      #   @return [Latitude::API::Objects::Project]
+      # @!attribute [rw] credentials
+      #   @return [Credential]
+      class VirtualMachine < APIResource
+          # @!attribute [r] raid
+          #   @return [Boolean]
+          # @!attribute [r] ssh_keys
+          #   @return [Boolean]
+          # @!attribute [r] user_data
+          #   @return [Boolean]
+        class Feature < APIObject
+          attribute :raid, :boolean, read_only: true
+          attribute :ssh_keys, :boolean, read_only: true
+          attribute :user_data, :boolean, read_only: true
+        end
+
+          # @!attribute [r] name
+          #   @return [String]
+          # @!attribute [r] slug
+          #   @return [String]
+          # @!attribute [r] series
+          #   @return [String]
+        class Distro < APIObject
+          attribute :name, :string, read_only: true
+          attribute :slug, :string, read_only: true
+          attribute :series, :string, read_only: true
+        end
+
+          # @!attribute [r] name
+          #   @return [String]
+          # @!attribute [r] slug
+          #   @return [String]
+          # @!attribute [r] version
+          #   @return [String]
+          # @!attribute [r] features
+          #   @return [Feature]
+          # @!attribute [r] distro
+          #   @return [Distro]
+        class OperatingSystem < APIObject
+          attribute :name, :string, read_only: true
+          attribute :slug, :string, read_only: true
+          attribute :version, :string, read_only: true
+          attribute :features, Feature, read_only: true
+          attribute :distro, Distro, read_only: true
+        end
+
+          # @!attribute [r] id
+          #   @return [String]
+          # @!attribute [r] name
+          #   @return [String]
+        class Plan < APIObject
+          attribute :id, :string, read_only: true
+          attribute :name, :string, read_only: true
+        end
+
+          # @!attribute [r] vcpu
+          #   @return [Integer]
+          # @!attribute [r] ram
+          #   @return [String]
+          # @!attribute [r] storage
+          #   @return [String]
+          # @!attribute [r] nic
+          #   @return [String]
+          # @!attribute [r] gpu
+          #   @return [String]
+        class Spec < APIObject
+          attribute :vcpu, :integer, read_only: true
+          attribute :ram, :string, read_only: true
+          attribute :storage, :string, read_only: true
+          attribute :nic, :string, read_only: true
+          attribute :gpu, :string, read_only: true
+        end
+
+          # @!attribute [r] username
+          #   @return [String]
+          # @!attribute [r] host
+          #   @return [String]
+          # @!attribute [r] password
+          #   @return [String]
+          # @!attribute [r] ssh_keys
+          #   @return [Array]
+        class Credential < APIObject
+          attribute :username, :string, read_only: true
+          attribute :host, :string, read_only: true
+          attribute :password, :string, read_only: true
+          attribute :ssh_keys, :array, read_only: true
+        end
+
+        attribute :name, :string
+        attribute :status, :string
+        attribute :created_at, :time, read_only: true
+        attribute :primary_ipv4, :string
+        attribute :operating_system, OperatingSystem
+        attribute :site, :string
+        attribute :billing, :string
+        attribute :plan, Plan
+        attribute :specs, Spec
+        attribute :team, Objects::Team
+        attribute :project, Objects::Project
+        attribute :credentials, Credential
+
+        resource_type "virtual_machines"
+        resource_path "/virtual_machines"
+        id_prefix     "vm_"
+
+        extend Operations::List
+        extend Operations::Create
+        extend Operations::Retrieve
+        extend Operations::Update
+        extend Operations::Delete
+        extend Operations::Action
+
+        action :power_action, path: "actions", type: "actions", accepts: %i[action]
+        action :reboot,       path: "actions", type: "actions", attributes: { action: "reboot" }
+        action :power_on,     path: "actions", type: "actions", attributes: { action: "power_on" }
+        action :power_off,    path: "actions", type: "actions", attributes: { action: "power_off" }
+      end
+    end
+  end
+end

data/lib/latitude/api/resources/virtual_network.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    module Resources
+      # @!attribute [rw] tags
+      #   @return [Array<Latitude::API::Objects::Tag>]
+      # @!attribute [rw] vid
+      #   @return [Integer]
+      # @!attribute [rw] name
+      #   @return [String]
+      # @!attribute [rw] description
+      #   @return [String]
+      # @!attribute [rw] site
+      #   @return [String]
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [rw] region
+      #   @return [Region]
+      # @!attribute [rw] project
+      #   @return [Latitude::API::Objects::Project]
+      # @!attribute [rw] assignments_count
+      #   @return [Integer]
+      class VirtualNetwork < APIResource
+          # @!attribute [r] id
+          #   @return [String]
+          # @!attribute [r] name
+          #   @return [String]
+          # @!attribute [r] slug
+          #   @return [String]
+          # @!attribute [r] facility
+          #   @return [String]
+        class Site < APIObject
+          attribute :id, :string, read_only: true
+          attribute :name, :string, read_only: true
+          attribute :slug, :string, read_only: true
+          attribute :facility, :string, read_only: true
+        end
+
+          # @!attribute [r] city
+          #   @return [String]
+          # @!attribute [r] country
+          #   @return [String]
+          # @!attribute [r] site
+          #   @return [Site]
+        class Region < APIObject
+          attribute :city, :string, read_only: true
+          attribute :country, :string, read_only: true
+          attribute :site, Site, read_only: true
+        end
+
+        attribute :tags, [Objects::Tag]
+        attribute :vid, :integer
+        attribute :name, :string
+        attribute :description, :string
+        attribute :site, :string
+        attribute :created_at, :time, read_only: true
+        attribute :region, Region
+        attribute :project, Objects::Project
+        attribute :assignments_count, :integer
+
+        resource_type "virtual_networks"
+        resource_path "/virtual_networks"
+        id_prefix     "vlan_"
+
+        extend Operations::List
+        extend Operations::Create
+        extend Operations::Retrieve
+        extend Operations::Update
+        extend Operations::Delete
+
+        # @!attribute [rw] virtual_network_id
+
+        #   @return [String]
+
+        # @!attribute [rw] vid
+
+        #   @return [Integer]
+
+        # @!attribute [rw] description
+
+        #   @return [String]
+
+        # @!attribute [rw] status
+
+        #   @return [String]
+
+        # @!attribute [rw] server
+
+        #   @return [Server]
+
+        # @!attribute [rw] server_id
+
+        #   @return [String]
+
+        class Assignment < APIResource
+
+            # @!attribute [r] id
+
+            #   @return [String]
+
+            # @!attribute [r] hostname
+
+            #   @return [String]
+
+            # @!attribute [r] label
+
+            #   @return [String]
+
+            # @!attribute [r] locked
+
+            #   @return [Boolean]
+
+            # @!attribute [r] status
+
+            #   @return [String]
+
+          class Server < APIObject
+
+            attribute :id, :string, read_only: true
+
+            attribute :hostname, :string, read_only: true
+
+            attribute :label, :string, read_only: true
+
+            attribute :locked, :boolean, read_only: true
+
+            attribute :status, :string, read_only: true
+
+          end
+
+
+          attribute :virtual_network_id, :string
+
+          attribute :vid, :integer
+
+          attribute :description, :string
+
+          attribute :status, :string
+
+          attribute :server, Server
+
+          attribute :server_id, :string
+
+          resource_type "virtual_network_assignment"
+          resource_path "/virtual_networks/assignments"
+
+          extend Operations::List
+          extend Operations::Delete
+
+          class << self
+            def create(params = {}, opts = {})
+              body = JSONAPI.encode(type: resource_type, attributes: params)
+              parsed = execute_request(method: :post, path: resource_path, body: body, opts: opts)
+              construct_from(parsed, opts: opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/latitude/api/resources/vpn_session.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    module Resources
+      # @!attribute [rw] user_name
+      #   @return [String]
+      # @!attribute [rw] password
+      #   @return [String]
+      # @!attribute [rw] port
+      #   @return [String]
+      # @!attribute [rw] host
+      #   @return [String]
+      # @!attribute [rw] region
+      #   @return [Region]
+      # @!attribute [rw] expires_at
+      #   @return [Time]
+      # @!attribute [r] created_at
+      #   @return [Time]
+      # @!attribute [r] updated_at
+      #   @return [Time]
+      class VPNSession < APIResource
+          # @!attribute [r] id
+          #   @return [String]
+          # @!attribute [r] name
+          #   @return [String]
+          # @!attribute [r] slug
+          #   @return [String]
+          # @!attribute [r] facility
+          #   @return [String]
+        class Site < APIObject
+          attribute :id, :string, read_only: true
+          attribute :name, :string, read_only: true
+          attribute :slug, :string, read_only: true
+          attribute :facility, :string, read_only: true
+        end
+
+          # @!attribute [r] city
+          #   @return [String]
+          # @!attribute [r] country
+          #   @return [String]
+          # @!attribute [r] site
+          #   @return [Site]
+        class Region < APIObject
+          attribute :city, :string, read_only: true
+          attribute :country, :string, read_only: true
+          attribute :site, Site, read_only: true
+        end
+
+        attribute :user_name, :string
+        attribute :password, :string
+        attribute :port, :string
+        attribute :host, :string
+        attribute :region, Region
+        attribute :expires_at, :time
+        attribute :created_at, :time, read_only: true
+        attribute :updated_at, :time, read_only: true
+
+        resource_type "vpn_sessions"
+        resource_path "/vpn_sessions"
+        id_prefix     "vpn_"
+
+        extend Operations::List
+        extend Operations::Create
+        extend Operations::Delete
+
+        class << self
+          def refresh_password(id, opts = {})
+            parsed = execute_request(method: :patch, path: "#{instance_url(id)}/refresh_password", opts: opts)
+            construct_from(parsed, opts: opts)
+          end
+        end
+
+        def refresh_password(opts = {})
+          self.class.refresh_password(id, opts)
+        end
+      end
+    end
+  end
+end

data/lib/latitude/api/singleton_api_resource.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    class SingletonAPIResource < APIResource
+      class << self
+        def retrieve(opts = {})
+          parsed = execute_request(method: :get, path: resource_path, opts: opts)
+          construct_from(parsed, opts: opts)
+        end
+
+        def instance_url(_id = nil, path_params: {})
+          class_url(path_params: path_params)
+        end
+      end
+
+      def resource_url
+        self.class.resource_path
+      end
+    end
+  end
+end

data/lib/latitude/api/util.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    module Util
+      module_function
+
+      def symbolize_keys(obj)
+        case obj
+        when Hash
+          obj.each_with_object({}) { |(k, v), h| h[k.to_sym] = symbolize_keys(v) }
+        when Array
+          obj.map { |v| symbolize_keys(v) }
+        else
+          obj
+        end
+      end
+
+      def stringify_keys(obj)
+        case obj
+        when Hash
+          obj.each_with_object({}) { |(k, v), h| h[k.to_s] = stringify_keys(v) }
+        when Array
+          obj.map { |v| stringify_keys(v) }
+        else
+          obj
+        end
+      end
+
+      def deep_merge(a, b)
+        a.merge(b) do |_key, av, bv|
+          if av.is_a?(Hash) && bv.is_a?(Hash)
+            deep_merge(av, bv)
+          else
+            bv
+          end
+        end
+      end
+
+      def present?(value)
+        !blank?(value)
+      end
+
+      def blank?(value)
+        value.nil? || (value.respond_to?(:empty?) && value.empty?)
+      end
+
+      def redact(hash, sensitive_fields)
+        return hash unless hash.is_a?(Hash)
+
+        keys = sensitive_fields.map { |k| k.to_s.downcase }
+        hash.each_with_object({}) do |(k, v), out|
+          out[k] = if keys.include?(k.to_s.downcase)
+                     "[FILTERED]"
+                   elsif v.is_a?(Hash)
+                     redact(v, sensitive_fields)
+                   else
+                     v
+                   end
+        end
+      end
+    end
+  end
+end

data/lib/latitude/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Latitude
+  module API
+    VERSION = "0.2.0"
+  end
+end

data/lib/latitude/api.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "openssl"
+require "securerandom"
+require "time"
+require "uri"
+require "forwardable"
+require "logger"
+
+require "latitude/api/version"
+require "latitude/api/errors"
+require "latitude/api/util"
+require "latitude/api/configuration"
+require "latitude/api/request_params"
+require "latitude/api/request_options"
+require "latitude/api/json_api"
+require "latitude/api/attributes"
+require "latitude/api/api_object"
+require "latitude/api/objects"
+require "latitude/api/list_object"
+require "latitude/api/request_executor"
+require "latitude/api/operations/list"
+require "latitude/api/operations/create"
+require "latitude/api/operations/retrieve"
+require "latitude/api/operations/update"
+require "latitude/api/operations/delete"
+require "latitude/api/operations/action"
+require "latitude/api/operations/nested"
+require "latitude/api/api_resource"
+require "latitude/api/singleton_api_resource"
+require "latitude/api/client"
+
+require "latitude/api/resources/server"
+require "latitude/api/resources/region"
+require "latitude/api/resources/role"
+require "latitude/api/resources/event"
+require "latitude/api/resources/ip"
+require "latitude/api/resources/plan"
+require "latitude/api/resources/billing_usage"
+require "latitude/api/resources/traffic"
+require "latitude/api/resources/user_profile"
+require "latitude/api/resources/user_team"
+require "latitude/api/resources/project"
+require "latitude/api/resources/ssh_key"
+require "latitude/api/resources/user_data"
+require "latitude/api/resources/tag"
+require "latitude/api/resources/team"
+require "latitude/api/resources/api_key"
+require "latitude/api/resources/elastic_ip"
+require "latitude/api/resources/virtual_network"
+require "latitude/api/resources/firewall"
+require "latitude/api/resources/vpn_session"
+require "latitude/api/resources/storage_filesystem"
+require "latitude/api/resources/storage_volume"
+require "latitude/api/resources/storage_object"
+require "latitude/api/resources/virtual_machine"
+require "latitude/api/resources/kubernetes_cluster"
+
+module Latitude
+  class << self
+    extend Forwardable
+
+    def config
+      @config ||= API::Configuration.new
+    end
+
+    def configure
+      yield config
+      config
+    end
+
+    def reset_config!
+      @config = API::Configuration.new
+    end
+
+    def_delegators :config,
+                   :api_key, :api_key=,
+                   :api_base, :api_base=,
+                   :api_version, :api_version=,
+                   :open_timeout, :open_timeout=,
+                   :read_timeout, :read_timeout=,
+                   :write_timeout, :write_timeout=,
+                   :max_network_retries, :max_network_retries=,
+                   :initial_network_retry_delay, :initial_network_retry_delay=,
+                   :max_network_retry_delay, :max_network_retry_delay=,
+                   :proxy, :proxy=,
+                   :verify_ssl_certs, :verify_ssl_certs=,
+                   :ca_bundle_path, :ca_bundle_path=,
+                   :ca_store, :ca_store=,
+                   :logger, :logger=,
+                   :log_level, :log_level=,
+                   :app_info, :app_info=,
+                   :enable_telemetry, :enable_telemetry=,
+                   :sensitive_fields, :sensitive_fields=
+  end
+
+  module API
+    Error                     = Latitude::Error
+    ConfigurationError        = Latitude::ConfigurationError
+    ConnectionError           = Latitude::ConnectionError
+    APIError                  = Latitude::APIError
+    BadRequestError           = Latitude::BadRequestError
+    AuthenticationError       = Latitude::AuthenticationError
+    PermissionError           = Latitude::PermissionError
+    NotFoundError             = Latitude::NotFoundError
+    ConflictError             = Latitude::ConflictError
+    UnprocessableEntityError  = Latitude::UnprocessableEntityError
+    RateLimitError            = Latitude::RateLimitError
+    ServerError               = Latitude::ServerError
+  end
+
+  Server       = API::Resources::Server
+  Region       = API::Resources::Region
+  Role         = API::Resources::Role
+  Event        = API::Resources::Event
+  IP           = API::Resources::IP
+  Plan         = API::Resources::Plan
+  BillingUsage = API::Resources::BillingUsage
+  Traffic      = API::Resources::Traffic
+  UserProfile  = API::Resources::UserProfile
+  UserTeam     = API::Resources::UserTeam
+  Project      = API::Resources::Project
+  SSHKey       = API::Resources::SSHKey
+  UserData     = API::Resources::UserData
+  Tag          = API::Resources::Tag
+  Team         = API::Resources::Team
+  APIKey          = API::Resources::APIKey
+  ElasticIP       = API::Resources::ElasticIP
+  VirtualNetwork  = API::Resources::VirtualNetwork
+  Firewall        = API::Resources::Firewall
+  VPNSession      = API::Resources::VPNSession
+  VirtualMachine  = API::Resources::VirtualMachine
+  KubernetesCluster = API::Resources::KubernetesCluster
+
+  module Storage
+    Filesystem = API::Resources::Storage::Filesystem
+    Volume     = API::Resources::Storage::Volume
+    Object     = API::Resources::Storage::Object
+  end
+
+  module User
+    Profile = API::Resources::UserProfile
+    Team    = API::Resources::UserTeam
+  end
+end

data/lib/latitude/metadata/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Latitude
+  module Metadata
+    class Error < StandardError; end
+    class Unavailable < Error; end
+    class TokenError < Error; end
+    class RequestError < Error
+      attr_reader :http_status, :http_body
+
+      def initialize(message = nil, http_status: nil, http_body: nil)
+        super(message)
+        @http_status = http_status
+        @http_body = http_body
+      end
+    end
+  end
+end