Class: Zype::BaseModel

Inherits:

Object

• Object
• Zype::BaseModel

Defined in:

lib/zype/base_model.rb

Direct Known Subclasses

AdTags, Apps, Zype::Base::Categories, Zype::Base::Consumers, Zype::Base::Playlists, Zype::Base::Videos, Categories, Consumers, DeviceCategories, Devices, Encoders, GeoIp, LiveEvents, LiveManifests, Manifests, Oauth, Pin, Plans, Players, Playlists, ProgramGuides, RedemptionCodes, RevenueModels, Subscriptions, Subtitles, Transactions, Users, VideoImports, VideoSources, Videos, ZobjectTypes, Zobjects

Defined Under Namespace

Classes: InvalidKey

Constant Summary

ACCEPTED_KEYS =

%i(api_key app_key)

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

• #path ⇒ Object readonly

  Returns the value of attribute path.

Instance Method Summary

• #all(params: {}) ⇒ Array<Hash>

  Returns all objects for given class.

• #auth=(auth_method) ⇒ Object

  Sets the authentication method for calling the API.

• #create(params:) ⇒ Hash

  Creates a new object via the API.

• #delete(id:) ⇒ Hash

  Deletes an existing object via the API.

• #find(id:) ⇒ Hash

  Returns object matching ID.

• #initialize(auth_method = 'api_key') ⇒ BaseModel constructor

  A new instance of BaseModel.

• #update(id:, params:) ⇒ Hash

  Updates an existing object via the API.

Constructor Details

#initialize(auth_method = 'api_key') ⇒ BaseModel

Returns a new instance of BaseModel.

# File 'lib/zype/base_model.rb', line 7

def initialize(auth_method='api_key')
  @client = client_class.new(auth_method)
  @path = generate_path
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/zype/base_model.rb', line 3

def client
  @client
end

#path ⇒ Object (readonly)

Returns the value of attribute path.

# File 'lib/zype/base_model.rb', line 3

def path
  @path
end

Instance Method Details

#all(params: {}) ⇒ Array<Hash>

Returns all objects for given class

Parameters:

• params (Hash) (defaults to: {}) —

  the metadata to filter objects by

Returns:

• (Array<Hash>) —

  the objects returned from the API

# File 'lib/zype/base_model.rb', line 16

def all(params: {})
  client.execute(method: :get, path: "/#{path}", params: params)
end

#auth=(auth_method) ⇒ Object

Sets the authentication method for calling the API

Parameters:

• auth_method (String) —

  one of ‘api_key’ or ‘app_key’

Raises:

• (InvalidKey)

# File 'lib/zype/base_model.rb', line 56

def auth=(auth_method)
  raise InvalidKey unless ACCEPTED_KEYS.include?(auth_method.to_sym)

  @client = client_class.new(auth_method)
end

#create(params:) ⇒ Hash

Creates a new object via the API

Parameters:

• params (Hash) —

  the properties of the object

Returns:

• (Hash) —

  the newly created object

# File 'lib/zype/base_model.rb', line 32

def create(params:)
  client.execute(method: :post, path: "/#{path}", params: params)
end

#delete(id:) ⇒ Hash

Deletes an existing object via the API

Parameters:

• id (String) —

  the ID of the object

Returns:

• (Hash) —

  the deleted object

# File 'lib/zype/base_model.rb', line 49

def delete(id:)
  client.execute(method: :delete, path: "/#{path}/#{id}")
end

#find(id:) ⇒ Hash

Returns object matching ID

Parameters:

• id (String) —

  the ID of the object

Returns:

• (Hash) —

  the object returned from the API

# File 'lib/zype/base_model.rb', line 24

def find(id:)
  client.execute(method: :get, path: "/#{path}/#{id}")
end

#update(id:, params:) ⇒ Hash

Updates an existing object via the API

Parameters:

• id (String) —

  the ID of the object

• params (Hash) —

  the properties to be updated

Returns:

• (Hash) —

  the updated object

# File 'lib/zype/base_model.rb', line 41

def update(id:, params:)
  client.execute(method: :put, path: "/#{path}/#{id}", params: params)
end