autoremote 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 921f9ecdee065814e56e078ba97cf74f1abdda64
-  data.tar.gz: efd98db7e06383c681c4ff08f702b44fce1569c4
+  metadata.gz: d9731d389f8581ca589e4c475195e809d40fe684
+  data.tar.gz: 7a1088fd196ed63d7f9574c0159b3ae76c14ae8a
 SHA512:
-  metadata.gz: 65aa38300a70f9e195d3c40ca8dc0c6872f8573a7ab67a0e6973b144981b6395dc7116fd570d30df5c7265a43f92c5c939aa740463af5de5ca8f64ee868a545a
-  data.tar.gz: 7683d2df10cd7dbee9ab8c24a09112b1871f86c309d10f200f039c0c06db67f8750c8357a3a9b36c5a1315252e2a17cdf78a68f6e36cda565b6a3d8605b0d0cb
+  metadata.gz: afed78c4605eefccd392e72e9ec91e1381d7bb4b1f836d9fd8858f98b051fd1cde59eb562f941d0a5770136f0ef0302ba86549a81aeaef066d987cc2eaabb6de
+  data.tar.gz: 42dadd06118f24ed4a18892ff9124b69c3a70566ff8dbeea80bbaa676871761459e20b7496559da1cea8fa9add5e4a2b9b0341f3372ef02e02b3d9fd2151806f

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 *.bundle
 *.so
 *.o

data/lib/autoremote.rb

@@ -27,11 +27,14 @@ module AutoRemote
     MSGURL = "http://autoremotejoaomgcd.appspot.com/sendmessage?key=%YOUR_KEY%&message=%MESSAGE%&sender=%SENDER_ID%"
     VALIDATIONURL = "http://autoremotejoaomgcd.appspot.com/sendmessage?key=%YOUR_KEY%"
     
-    ## Add a device
+    # Add a device
+    # @param name [String] The name of the device
+    # @param key [String] The personal key of the device
+    # @raise [AutoRemote::DeviceAlreadyExist] if the device already exits
     def AutoRemote::addDevice( name, key )
         ## Check if the name is taken
         if Device.find_by_name( name ) || Device.find_by_key(key)
-            raise self::DeviceAlreadyExist#
+            raise self::DeviceAlreadyExist
         end
         
         ## Validate key
@@ -45,31 +48,38 @@ module AutoRemote
         
         ## Save the device
         Device.create(:name => name, :key => key)
-        return true
     end
     
-    ## Remove a specific device
+    # Remove a specific device
+    # @param name [String] The name of the device
+    # @raise [AutoRemote::DeviceNotFound] if the device didn't exist
     def AutoRemote::removeDevice( name )
         if device = Device.find_by_name(name)
             
             ## Remove the device
-            return Device.delete(device.id)
+            Device.delete(device.id)
         else
             raise self::DeviceNotFound
         end
     end
     
-    ## Returns a list with all devices
+    # Returns a list with all devices
+    # @return [Device::ActiveRecord_Relation]
     def AutoRemote::listDevices
         return Device.order("name").all
     end
     
-    ## Returns one specific device
+    # Returns one specific device
+    # @return [Device]
     def AutoRemote::getDevice( name )
         return Device.find_by_name( name )
     end
     
-    ## Send a message to a device
+    # Sends a message to a device
+    # @param device [Device, String] A device object or the name of the device
+    # @param message [String] The message to send
+    # @raise [AutoRemote::DeviceNotFound] if the device didn't exits
+    # @raise [TypeError] if message isn't a string
     def AutoRemote::sendMessage( device, message )
         if ! device.kind_of?( Device ) && ! ( device = Device.find_by_name( device ) )
             raise self::DeviceNotFound
@@ -89,11 +99,13 @@ module AutoRemote
         if result.body != "OK"
             raise self::InvalidKey
         end
-        
-        return true
     end
     
-    ## Register on the device
+    # Register on the device
+    # @param device [Device, String] A device object or the name of the device
+    # @param remotehost [String] The public hostname or ip-address
+    # @raise [AutoRemote::DeviceNotFound] if the device didn't exits
+    # @raise [TypeError] if message isn't a string or less than 5 characters
     def AutoRemote::registerOnDevice( device, remotehost )
         
         if ! device.kind_of?( Device ) && ! ( device = Device.find_by_name( device ) )
@@ -113,8 +125,6 @@ module AutoRemote
         if ! result
             raise self::AutoRemoteException, "Something went wrong when registering on the device"
         end
-        
-        return true
     end
     
     ## Define alases for some methods

data/lib/autoremote/version.rb

@@ -1,3 +1,3 @@
 module AutoRemote
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoremote
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yurij
@@ -79,7 +79,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- autoremote-0.0.1.gem
 - autoremote-devices.db
 - autoremote.gemspec
 - bin/autoremote
@@ -111,3 +110,4 @@ signing_key:
 specification_version: 4
 summary: A library for interacting with autoremote devices http://joaoapps.com/autoremote/
 test_files: []
+has_rdoc: