class WebService
Public Class Methods
new( secret )
click to toggle source
Constructor method for WebService
.
@param [String] secret A secret identifier for an application obtained by the user during the registration process.
Without this, the app will not have access to Thingdom.
# File lib/webService.rb, line 14 def initialize( secret ) @httpHelper = HttpHelper.new() @apiSecret = secret @applicationToken = '' @deviceSecret = 'none' end
Public Instance Methods
add_feed( thing, category, message, feedOptions )
click to toggle source
Add a feed message to a thing.
@param [Thing] thing The thing to which the feed message is applied. @param [String] category The feed category. @param [String] message The feed message. @param [FeedOption] feedOptions Additional feed options (icon, progress bar, etc)
# File lib/webService.rb, line 91 def add_feed( thing, category, message, feedOptions ) data = { token: @applicationToken, thing_id: thing.id, feed_category: category, message: message, options: feedOptions } @httpHelper.post_data( 'feed', data ) end
add_status( thing, statusArray )
click to toggle source
Add or update a status item for a thing.
@param [Thing] thing The thing to which the status item is attached. @param [Array] statusArray An array of status item updates (name, value, unit).
# File lib/webService.rb, line 73 def add_status( thing, statusArray ) data = { token: @applicationToken, thing_id: thing.id, id: 'null', status_array: statusArray } @httpHelper.post_data( 'status', data ) end
add_thing( thing )
click to toggle source
Retrieve a thing. If it doesn't exist, then add it.
@param [Thing] thing The thing to get or add.
# File lib/webService.rb, line 54 def add_thing( thing ) data = { token: @applicationToken, name: thing.name, display_name: thing.display_name } if( thing.product_type.length > 0 ) data[:product_type] = thing.product_type end @httpHelper.post_data( 'thing', data ) end
ping_server()
click to toggle source
Ping Thingdom
.
# File lib/webService.rb, line 24 def ping_server() @httpHelper.get_data( 'ping' ) end