Module: Giraffi::Client::Media

Included in:
Giraffi::Client
Defined in:
lib/giraffi/client/media.rb

Overview

Defines methods related to the media

Instance Method Summary collapse

Instance Method Details

#create_medium(options = {}) ⇒ HTTParty::Response

Creates a new medium

Parameters:

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

    A set of attributes to create a new medium

Returns:

  • (HTTParty::Response) 


45
46
47
 
# File 'lib/giraffi/client/media.rb', line 45

def create_medium(options={})
  self.class.post("/media.json?apikey=#{apikey}", :query => { :medium => options })
end

#destroy_medium(id) ⇒ HTTParty::Response

Deletes the medium

Parameters:

  • id (String) —

    The numerical ID of the desired medium

Returns:

  • (HTTParty::Response) 


62
63
64
 
# File 'lib/giraffi/client/media.rb', line 62

def destroy_medium(id)
  self.class.delete("/media/#{id}?apikey=#{apikey}")
end

#find_media(options = {}) ⇒ HTTParty::Response

Returns the desired media

Parameters:

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

    The request params to retrieve the desired media

Returns:

  • (HTTParty::Response) 


10
11
12
 
# File 'lib/giraffi/client/media.rb', line 10

def find_media(options={})
  self.class.get("/media.json?apikey=#{apikey}", :query => options)
end

#find_medium(id) ⇒ HTTParty::Response

Returns the desired medium

Parameters:

  • id (String) —

    The numerical ID of the desired medium

Returns:

  • (HTTParty::Response) 


18
19
20
 
# File 'lib/giraffi/client/media.rb', line 18

def find_medium(id)
  self.class.get("/media/#{id}.json?apikey=#{apikey}")
end

#find_oauth_by_medium(id) ⇒ HTTParty::Response

Returns the desired oauth

Parameters:

  • id (String) —

    The numerical ID of the desired medium

Returns:

  • (HTTParty::Response) 


26
27
28
 
# File 'lib/giraffi/client/media.rb', line 26

def find_oauth_by_medium(id)
  self.class.get("/media/#{id}/oauth.json?apikey=#{apikey}")
end

#find_oauth_callback_by_medium(*args) ⇒ HTTParty::Response

Returns the oauth-callbacks related to the medium

Parameters:

  • args (Array) —

    A set of params to retrieve the desired oauth-callback

Options Hash (*args):

  • The (String) —

    numerical ID of the desired medium

  • The (String) —

    oauth verifier related to the callback

Returns:

  • (HTTParty::Response)

Raises:

  • (ArgumentError) 


36
37
38
39
 
# File 'lib/giraffi/client/media.rb', line 36

def find_oauth_callback_by_medium(*args)
  raise ArgumentError.new('The method `find_oauth_callback_by_medium` requires 2 arguments(medium-id and oauth-token)') if args.size != 2
  self.class.get("/media/#{args[0]}/oauth_callback.json?apikey=#{apikey}", :query => {:oauth_verifier => args[-1]})
end

#update_medium(id, options = {}) ⇒ HTTParty::Response

Updates the desired medium

Parameters:

  • id (String) —

    The numerical ID of the desired medium

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

    A set of attributes to update the medium

Returns:

  • (HTTParty::Response) 


54
55
56
 
# File 'lib/giraffi/client/media.rb', line 54

def update_medium(id, options={})
  self.class.put("/media/#{id}.json?apikey=#{apikey}", :query => {:medium => options}, :body => {})
end