thingdom 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,7 @@
 Thingdom Ruby Module
 ===========
 
-Ruby module for v1.1 of the [Thingdom.io API](https://thingdom.io/).
+The official Ruby wrapper for the [Thingdom API](https://thingdom.io/).
 
 ## What is Thingdom?
 

data/lib/tasks/baseTask.rb

@@ -1,6 +1,17 @@
-
+#
+# A psuedo abstract class that provides common functionality for performing Thing tasks.
+# These are: retrieving a thing, updating status and sending a feed.
+#
 class BaseTask
 
+  #
+  # Constructor method for base task.  Initialize web service and the thing for which
+  # tasks will be performed.
+  #
+  # @param [WebService] webService A web service to be used by the task.
+  # @param [Thing] thing The thing for which the task is being performed.
+  # @param [boolean] isThingTask True if the task is retrieving or creating a thing.
+  #
   def initialize( webService, thing, isThingTask )
     @web = webService
     @thing = thing

data/lib/tasks/feedTask.rb

@@ -1,7 +1,13 @@
+#
+# A class that does the work for adding a feed to a thing.
+#
 require_relative( 'baseTask' )
 
 class FeedTask < BaseTask
 
+  #
+  # Constructor method for feed task.  Initialize feed attributes.
+  #
   def initialize( webService, thing, category, message, feedOptions )
     super( webService, thing, false )
     @web = webService
@@ -11,6 +17,9 @@ class FeedTask < BaseTask
     @feedOptions = feedOptions
   end
 
+  #
+  # Do the work for the feed task.
+  #
   def do_task_work
     @web.add_feed( @thing, @category, @message, @feedOptions )
   end

data/lib/tasks/statusTask.rb

@@ -1,7 +1,13 @@
+#
+# A class that does the work for updating the status for a thing.
+#
 require_relative( 'baseTask' )
 
 class StatusTask < BaseTask
 
+  #
+  # Constructor method for status task.  Initialize status update array.
+  #
   def initialize( webService, thing, *args )
     super( webService, thing, false )
     @web = webService
@@ -9,6 +15,9 @@ class StatusTask < BaseTask
     @statusUpdates = statusArgsToArray( *args )
   end
 
+  #
+  # Do the work for the status task.
+  #
   def do_task_work
     @web.add_status( @thing, @statusUpdates )
   end

data/lib/tasks/thingTask.rb

@@ -1,13 +1,22 @@
+#
+# A class that does the work for creating or retrieving a thing.
+#
 require_relative ( 'baseTask' )
 
 class ThingTask < BaseTask
 
+  #
+  # The constructor method for thing task.
+  #
   def initialize( webService, thing )
     super( webService, thing, true )
     @web = webService
-    @thing = @thing
+    @thing = thing
   end
 
+  #
+  # Do the work for the thing task.
+  #
   def do_task_work
     @web.add_thing( @thing )
   end

data/lib/thingdom/version.rb

@@ -1,3 +1,3 @@
 module Thingdom
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/webService.rb

@@ -32,7 +32,8 @@ class WebService
   # @return [Hash] A hash containing the authorization response:
   #                  application_token - The token used in subsequent communications with Thingdom
   #                  expires_in - The number of seconds remaining before above token expires.
-  #                  device_secret - A unique identifier for device running this application (always ruby in this case)
+  #                  device_secret - A unique identifier for device running this application
+  #                                 (always "none" for the Ruby wrapper)
   #
   def get_authorization()
     data = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thingdom
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: