Class: Viddler::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/viddler/client.rb

Overview

Base class for accessing the Viddler API.

For more information about the Viddler API, check out the documentation: developers.viddler.com/documentation/api-v2/

Examples

# Initialize a client with just an API key
viddler = Viddler::Client.new 'your api key'

Constant Summary collapse

DEFAULT_ENDPOINT = 
'http://api.viddler.com/api/v2/'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key) ⇒ Client

Sets the API key and sessionid if needed for the given arguments

api_key - The String API Key from Viddler

Examples

# Initialize a client with just an API key
viddler = Viddler::Client.new 'your api key'

Returns an instance of Viddler::Client



27
28
29
 
# File 'lib/viddler/client.rb', line 27

def initialize(api_key)
  self.api_key = api_key
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.



15
16
17
 
# File 'lib/viddler/client.rb', line 15

def api_key
  @api_key
end

#record_token ⇒ Object

Returns the value of attribute record_token.



15
16
17
 
# File 'lib/viddler/client.rb', line 15

def record_token
  @record_token
end

#sessionid ⇒ Object

Returns the value of attribute sessionid.



15
16
17
 
# File 'lib/viddler/client.rb', line 15

def sessionid
  @sessionid
end

Instance Method Details

#authenticate!(username, password, get_record_token = false) ⇒ Object

Public: Authenticate the client using a username and password. Any

subsequent calls will be made using the session.

username - The String Viddler username password - The String Viddler password

Examples

viddler.authenticate! 'username', 'password'

Returns a String sessionid



60
61
62
63
64
 
# File 'lib/viddler/client.rb', line 60

def authenticate!(username, password, get_record_token=false)
  auth = get 'viddler.users.auth', :user => username, :password => password, :get_record_token => (get_record_token ? 1 : 0)
  self.record_token = auth['auth']['record_token'] if get_record_token
  self.sessionid = auth['auth']['sessionid']
end

#authenticated? ⇒ Boolean

Public: Simple method to determine if this is an authenticated client

Examples

viddler = Viddler::Client.new 'abc123'
viddler.authenticated?
# => false

viddler = Viddler::Client.new 'abc123'
viddler.authenticate! 'user', 'pass'
viddler.authenticated?
# => true

Returns Boolean

Returns:

  • (Boolean) 


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

def authenticated?
  !sessionid.nil?
end

#get(method, arguments = {}) ⇒ Object

Public: Make a GET call to the Viddler API.

method - The String API method you’d like to call. arguments - The Hash of arguments to the API method (default: {}).

Examples

viddler.get 'viddler.videos.getDetails', :video_id => 'abc123'

Returns a Hash containing the API response. Raises ApiException if an error is returned from the API.



77
78
79
80
81
82
83
 
# File 'lib/viddler/client.rb', line 77

def get(method, arguments={})
  arguments[:api_key]   = api_key
  arguments[:sessionid] = sessionid if authenticated?
  JSON.parse RestClient.get(DEFAULT_ENDPOINT + method + '.json', :params => arguments)
rescue RestClient::ExceptionWithResponse => e
  raise_api_exception e
end

#post(method, arguments = {}) ⇒ Object

Public: Make a POST call to the Viddler API.

method - The String API method you’d like to call. arguments - The Hash of arguments to the API method (default: {}).

Examples

viddler.post 'viddler.videos.setDetails', :video_id => 'abc123',
                                          :title    => 'new title'

Returns a Hash containing the API response. Raises ApiException if an error is returned from the API.



97
98
99
100
101
102
103
 
# File 'lib/viddler/client.rb', line 97

def post(method, arguments={})
  arguments[:api_key]   = api_key
  arguments[:sessionid] = sessionid if authenticated?
  JSON.parse RestClient.post(DEFAULT_ENDPOINT + method + '.json', arguments)
rescue RestClient::ExceptionWithResponse => e
  raise_api_exception e
end

#upload(file, arguments) ⇒ Object

Public: Upload a video to the Viddler API.

file - The File you are uploading arguments - The Hash of arguments for the video

:title       - The String title of the video
:tags        - The String of tags for the video
:description - The String description of the video
:make_public - The Boolean to make the video public on
               upload. Please note that if set to false, it
               will not make your video private.

Examples

viddler.upload File.open('myvideo.avi'), :title       => "My Video",
                                         :tags        => "viddler, ruby",
                                         :description => "This is cool"

Returns a Hash containing the API response. Raises ApiException if an error is returned from the API



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/viddler/client.rb', line 124

def upload(file, arguments)
  # Call prepareUpload first, to get upload endpoint
  endpoint = get('viddler.videos.prepareUpload')["upload"]["endpoint"]
  
  # Need to use OrderedHash, because the API needs the file argument last
  ordered_arguments = ActiveSupport::OrderedHash.new
  
  arguments.each {|k,v| ordered_arguments[k] = v}
  
  ordered_arguments[:api_key]   = api_key
  ordered_arguments[:sessionid] = sessionid
  ordered_arguments[:file]      = file
  
  JSON.parse RestClient.post(endpoint, ordered_arguments)
rescue RestClient::ExceptionWithResponse => e
  raise_api_exception e
end