class Oceanarium::Image

Attributes

distribution[RW]
id[RW]
name[RW]
slug[RW]

Public Class Methods

all() click to toggle source

Core API

# File lib/oceanarium/resources/image.rb, line 37
def self.all
  # Returns all avaliable images in Array
  @request = Oceanarium::Request.new
  @get = @request.get('/images/')
  if @get.parsed_response['status'] == 'OK'
    @get.parsed_response['images']
  end
end
destroy(id) click to toggle source
# File lib/oceanarium/resources/image.rb, line 77
def self.destroy(id)
  @request = Oceanarium::Request.new
  @get = @request.get("/images/#{id}/destroy/")
  @get.parsed_response['status']
end
find(id) click to toggle source
# File lib/oceanarium/resources/image.rb, line 64
def self.find(id)
  @request = Oceanarium::Request.new
  @get = @request.get("/images/#{id}/")
  if @get.parsed_response['status'] == 'OK'
    @get.parsed_response['image']
  end
end
find_by_name(string) click to toggle source
# File lib/oceanarium/resources/image.rb, line 72
def self.find_by_name(string)
  # Returns Array of images which name matching string.
  self.all.select { |i| i['name'].include? string }
end
global() click to toggle source
# File lib/oceanarium/resources/image.rb, line 46
def self.global
  # Returns all global images in Array
  @request = Oceanarium::Request.new
  @get = @request.get('/images/?filter=global')
  if @get.parsed_response['status'] == 'OK'
    @get.parsed_response['images']
  end
end
local() click to toggle source
# File lib/oceanarium/resources/image.rb, line 55
def self.local
  # Returns all user's images in Array
  @request = Oceanarium::Request.new
  @get = @request.get('/images/?filter=my_images')
  if @get.parsed_response['status'] == 'OK'
    @get.parsed_response['images']
  end
end
new(option, api_key, client_id) click to toggle source
# File lib/oceanarium/resources/image.rb, line 5
def initialize(option, api_key, client_id)
  if api_key.nil? || client_id.nil?
    raise 'No API key/client ID!'
  else
    if option.is_a?(Hash)
      @object = option
    else
      @object = Oceanarium::Image.find(option)
    end
    if @object.nil?
      self.id = nil
    else
      self.id = @object['id']
      self.name = @object['name']
      self.slug = @object['slug']
      self.distribution = @object['distribution']
    end
  end
end
transfer(id, region_id) click to toggle source
# File lib/oceanarium/resources/image.rb, line 83
def self.transfer(id, region_id)
  @request = Oceanarium::Request.new
  @get = @request.get("/images/#{id}/transfer/?region_id=#{region_id}")
  [@get.parsed_response['status'], @get.parsed_response['event_id']]
end

Public Instance Methods

destroy() click to toggle source

User API

# File lib/oceanarium/resources/image.rb, line 27
def destroy
  Oceanarium::Image.destroy(self.id)
end
transfer(region_id) click to toggle source
# File lib/oceanarium/resources/image.rb, line 31
def transfer(region_id)
  Oceanarium::Image.transfer(self.id, region_id)
end