Class: DropletKit::BaseModel

Inherits:

Object

• Object
• DropletKit::BaseModel

Defined in:

lib/droplet_kit/models/base_model.rb

Direct Known Subclasses

Account, Action, CDN, Certificate, ContainerRegistry, ContainerRegistryRepository, ContainerRegistryRepositoryTag, Database, DatabaseBackup, DatabaseCluster, DatabaseConnection, DatabaseConnectionPool, DatabaseEvictionPolicy, DatabaseFirewallRule, DatabaseMaintenanceWindow, DatabaseReplica, DatabaseSQLMode, DatabaseUser, DatabaseUserMySQLSettings, DatabaseUserResetAuth, Domain, DomainRecord, Droplet, DropletUpgrade, Firewall, FirewallInboundRule, FirewallOutboundRule, FirewallPendingChange, FirewallRule, FloatingIp, ForwardingRule, HealthCheck, Image, Kernel, KubernetesCluster, KubernetesMaintenancePolicy, KubernetesNode, KubernetesNodePool, KubernetesOptions, Links, LoadBalancer, MetaInformation, PaginationInformation, Project, ProjectAssignment, Region, SSHKey, Size, Snapshot, StickySession, Tag, TaggedDropletsResources, TaggedImagesResources, TaggedResources, VPC, VPCMember, Volume

Constant Summary

DO_NAMESPACE =

'do'

UNSUPPORTED_COLLECTIONS =

['space']

Class Method Summary

• .from_identifier(identifier) ⇒ Object
• .from_urn(urn) ⇒ Object
• .valid_urn?(urn) ⇒ Boolean

Instance Method Summary

• #collection_name ⇒ Object
• #identifier ⇒ Object
• #inspect ⇒ Object
• #urn ⇒ Object

Class Method Details

.from_identifier(identifier) ⇒ Object

# File 'lib/droplet_kit/models/base_model.rb', line 61

def self.from_identifier(identifier)
  new(id: identifier)
end

.from_urn(urn) ⇒ Object

# File 'lib/droplet_kit/models/base_model.rb', line 48

def self.from_urn(urn)
  DropletKit::Error.new("Invalid urn: #{urn}") unless valid_urn?(urn)

  parts = urn.split(':')
  collection = parts[1]
  identifier = parts[2]

  return nil if UNSUPPORTED_COLLECTIONS.include?(collection)

  klass = const_get("DropletKit::#{DropletKit::Utils.camelize(collection)}")
  klass.from_identifier(identifier)
end

.valid_urn?(urn) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/droplet_kit/models/base_model.rb', line 32

def self.valid_urn?(urn)
  parts = urn.split(':')
  return false if parts.size != 3 || parts[0] != DO_NAMESPACE

  collection = parts[1]
  return true if UNSUPPORTED_COLLECTIONS.include?(collection)

  begin
    const_get "DropletKit::#{DropletKit::Utils.camelize(collection)}"
  rescue NameError
    return false
  end

  true
end

Instance Method Details

#collection_name ⇒ Object

# File 'lib/droplet_kit/models/base_model.rb', line 21

def collection_name
  DropletKit::Utils.underscore self.class.name.split('::').last
end

#identifier ⇒ Object

Raises:

• (DropletKit::Error)

# File 'lib/droplet_kit/models/base_model.rb', line 25

def identifier
  identifier = attributes[:id] || attributes[:uuid] || attributes[:slug]
  raise DropletKit::Error.new("#{self.class.name} doesn't support URNs") if identifier.nil?

  identifier
end

#inspect ⇒ Object

# File 'lib/droplet_kit/models/base_model.rb', line 12

def inspect
  values = Hash[instance_variables.map { |name| [name, instance_variable_get(name)] } ]
  "<#{self.class.name} #{values}>"
end

#urn ⇒ Object

# File 'lib/droplet_kit/models/base_model.rb', line 17

def urn
  "#{DO_NAMESPACE}:#{collection_name}:#{identifier}"
end