autoremote 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 556baa7cab3df31f1515bb062d933440923499b0
-  data.tar.gz: 8d2c4700f0ea3c49502f4928c38e8e5ad6494ed5
+  metadata.gz: f2b9cbfdd54c4ff05c1075eabe8b2ddf8ac1af82
+  data.tar.gz: 9d3f433333b4e827c8755a016bcc074e0ab02890
 SHA512:
-  metadata.gz: a621b850030b061cea9be09cd2f2a09106dc6f07029856276dbe0929ff86c99250104758e679c22ec45b62f8666861a981818ce9cfeeef417c28e948a6a96e1b
-  data.tar.gz: d42f3720da620411a193ca9c3aa385b3a436579548ca11d0ac5d7ce523f7081a13e2cd6008038938cf40ae2e0202c0094adda76fc30fd1cf2617871e0e7ba067
+  metadata.gz: c7f8e03824393a70fe0a5a6f4d329667c2b9a965149ff082555c816888d9c8264f0078e09c7827fa02b947ea4e472009489ff67f758f657b303d63924900297d
+  data.tar.gz: 67ab0febc0d4a344803dc6c4f2cf9c788b7511250d390c658523a36f2f7b2cb9c8a2ec6241b7ac1a0095e6250aadc145a364bc88d4e2afe8692f9ae2e3106a0b

data/.gitignore

@@ -9,6 +9,7 @@
 /tmp/
 *.gem
 *.bundle
+*.db
 *.so
 *.o
 *.a

data/.pullreview.yml

@@ -0,0 +1,5 @@
+---
+rules:
+  ignore:
+  - remove_trailing_whitespace
+  

data/.travis.yml

@@ -0,0 +1,35 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - rbx-2.1.1
+  - rbx-2.2.0
+  - rbx-2.3.0
+  - rbx
+  - jruby-19mode
+  - jruby
+  
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: rbx-2.1.1
+    - rvm: rbx-2.2.0
+    - rvm: rbx-2.3.0
+    - rvm: rbx
+    - rvm: jruby-19mode
+    - rvm: jruby
+    
+addons:
+  code_climate:
+    repo_token:
+      secure: "DUVG31yOL3GfE9FASaTXuTKWibxuGgiJItSXAFoSjQU3QYDcC/f/MH/58jfZnMy7Vrt36/RcuwBifCgBWNMkH0jHdYUtZyKkEyDxc98nKXD8R02uKFMhBVBvInakmDnAPfl75OO0A4peibZ+feHzv5NoK2wL4p3+eR3wLGWwLV4="
+
+before_install:
+  - gem update --system
+  - gem --version
+  
+bundler_args: --jobs=1 --retry=3
+
+script: bundle exec rspec

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in autoremote.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -40,25 +40,28 @@ Since version 0.1.0 you can use the goo.gl url instead of the key when adding de
 require 'autoremote'
 
 # Adding devices can be done either with the key
-AutoRemote.addDevice( name, "A VERY LONG STRING OF CHARACTERS" )
+AutoRemote.add_device( name, "A VERY LONG STRING OF CHARACTERS" )
 # Or with your 'goo.gl' address
-AutoRemote.addDevice( name, "http://goo.gl/XXXXXX" )
+AutoRemote.add_device( name, "http://goo.gl/XXXXXX" )
 
 # Removes a device
-AutoRemote.removeDevice( name )
+AutoRemote.remove_device( name )
 
 # List all saved devices
 AutoRemote.list
 
+# Get a specific device
+AutoRemote.get_device( name )
+
 # Send a message to a device
 # The parameter device can either be a Device object or the name of the device
-AutoRemote.sendMessage( device, message )
+AutoRemote.send_message( device, message )
 
 # Register on the device.
 # This has the same effect as following the guide on http://joaoapps.com/autoremote/linux/)
 # device can either be a Device object or the name of the device
 # host can be either a hostname or ip-address, but they have to be public (i.e. reachable from the internet)
-AutoRemote.registerOnDevice( device, host )
+AutoRemote.register_on_device( device, host )
 ```
 
 ## Contributing

data/bin/autoremote

@@ -8,6 +8,19 @@ def to_bool(string)
     raise ArgumentError, "Invalid value: #{string}"
 end
 
+# Prints the header for the list of devices
+def print_list_head(withkey)
+    puts 'Listing devices'
+
+    print 'Name'.rjust(18)
+    print '  Key' if withkey
+    puts
+
+    print '--------'.rjust(18)
+    print '  --------' if withkey
+    puts
+end
+
 ## Prints help
 def print_help
     puts 'AutoRemote v' + AutoRemote::VERSION
@@ -23,41 +36,58 @@ end
 
 arg0 = ARGV[0].downcase if ARGV[0]
 
+# Prints help
 if arg0 == 'help' || arg0 == '-h' || arg0 == '--help'
     print_help
+
+# Add device
 elsif arg0 == 'add' && ARGV[1] && ARGV[2]
+
     puts 'Adding device'
     begin
         AutoRemote.addDevice(ARGV[1], ARGV[2])
         puts 'Device added successfully'
-    rescue Exception => e
+    rescue StandardError => e
         puts "Error: #{e.message}"
     end
+
+# Remove device
 elsif ( arg0 == 'remove' || arg0 == 'delete' ) && ARGV[1]
+
     puts 'Removing device'
     begin
         AutoRemote.removeDevice(ARGV[1])
         puts 'Device removed successfully'
-    rescue Exception => e
+    rescue StandardError => e
         puts "Error: #{e.message}"
     end
+
+# List all devices
 elsif arg0 == 'list'
+
     withkey = to_bool(ARGV[1])
-    puts 'Listing devices'
-    
+    print_list_head(withkey)
+
     AutoRemote.listDevices.each do|device|
-        print "Name: #{device.name}"
-        print "    Key: #{device.key}" if withkey
+        print "#{device.name}".rjust(18)
+        print "  #{device.key}" if withkey
         puts
     end
+
+# Send a message to a device
 elsif arg0 == 'message' && ARGV[1] && ARGV[2]
+
     begin
         AutoRemote.sendMessage(ARGV[1], ARGV[2])
         puts 'Message sent successfully'
-    rescue Exception => e
+    rescue StandardError => e
         puts "Error: #{e.message}"
     end
+
+# Register on a device
 elsif arg0 == 'register' && ARGV[1] && ARGV[2]
+
+    # Display a prompt if registering on windows
     if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/i
         puts 'Are you sure you want to register a windows computer?'
         print 'You will need an SSH server on the computer. (y/n)'
@@ -66,13 +96,15 @@ elsif arg0 == 'register' && ARGV[1] && ARGV[2]
             exit
         end
     end
-    
+
     begin
         AutoRemote.registerOnDevice(ARGV[1], ARGV[2])
         puts 'Device registered successfully'
-    rescue Exception => e
+    rescue StandardError => e
         puts "Error: #{e.message}"
     end
+
+# Display help if arguments are invalid
 else
     print_help
 end

data/lib/autoremote.rb

@@ -1,10 +1,9 @@
+require 'autoremote/net'
 require 'autoremote/version'
 require 'autoremote/exceptions'
 require 'sqlite3'
 require 'active_record'
-require 'net/http'
 require 'socket'
-require 'httparty'
 
 ## Establish the database connection
 ActiveRecord::Base.establish_connection(
@@ -25,21 +24,17 @@ ActiveRecord::Schema.define do
 end
 
 module AutoRemote
-    REGURL = 'http://autoremotejoaomgcd.appspot.com/registerpc?key=%YOUR_KEY%&name=%DISPLAY_NAME%&id=%UNIQUE_ID%&type=linux&publicip=%PUBLIC_HOST%&localip=%IP_ADDRESS%'
-    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
     # @param name [String] The name of the device
     # @param input [String] Can either be the 'goo.gl' url or the personal key of the device
-    # @raise [AutoRemote::DeviceAlreadyExist] if the device already exits
     # @raise [AutoRemote::InvalidKey] if the key or url is invalid
-    # @return [void]
-    def AutoRemote::addDevice(name, input)
+    # @return [Device] the device that was was created
+    # @return [nil] if the device already exists
+    def AutoRemote::add_device(name, input)
         
         ## Validation if input is a 'goo.gl' url
         if input.match(/^(https?:\/{2})?(goo.gl\/[\S]*)$/i)
-            result = self.urlRequest(input)
+            result = AutoRemoteRequest.validate_url(input)
             
             ## Get the key from the resulting url
             begin
@@ -51,119 +46,148 @@ module AutoRemote
         ## If not a 'goo.gl' url, check if it is a valid key
         else
             ## Validate key
-            result = self.urlRequest(VALIDATIONURL.sub(/%YOUR_KEY%/, input))
+            result = AutoRemoteRequest.validate_key(input)
             
             ## Check result
-            if result.body != 'OK'
-                raise self::InvalidKey
-            end
+            raise self::InvalidKey if result.body != 'OK'
         end
         
         ## Check if the device already exist
-        if Device.find_by_name(name) || Device.find_by_key(input)
-            raise self::DeviceAlreadyExist
+        if Device.find_by_name(name)
+            return nil
+        else
+            ## Save the device
+            return Device.create(:name => name, :key => input)
         end
-        
-        ## Save the device
-        Device.create(:name => name, :key => input)
     end
     
     # Remove a specific device
     # @param name [String] The name of the device
-    # @raise [AutoRemote::DeviceNotFound] if the device didn't exist
-    # @return [void]
-    def AutoRemote::removeDevice(name)
+    # @return [true] if the device was deleted
+    # @return [false] if the device wasn't found
+    def AutoRemote::remove_device(name)
         if device = Device.find_by_name(name)
             ## Remove the device
             Device.delete(device.id)
+            return true
         else
-            raise self::DeviceNotFound
+            return false
         end
     end
     
     # Returns a list with all devices
     # @return [Device::ActiveRecord_Relation]
-    def AutoRemote::listDevices
+    def AutoRemote::list_devices
         return Device.order('name').all
     end
     
     # Returns one specific device
-    # @return [Device]
-    def AutoRemote::getDevice(name)
+    # @return [Device] if the device was found
+    # @return [nil] if the device wasn't found
+    def AutoRemote::get_device(name)
         return Device.find_by_name(name)
     end
     
     # 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
-    # @return [void]
-    def AutoRemote::sendMessage(device, message)
-        if ! device.kind_of?(Device) && ! (device = Device.find_by_name(device))
-            raise self::DeviceNotFound
-        elsif ! message.kind_of?(String)
-            raise TypeError, 'Message must be a string'
-        end
+    # @raise [ArgumentError] if message isn't a string
+    # @return [true] if the message was sent
+    # @return [false] if the message wasn't sent
+    def AutoRemote::send_message(device, message)
+        device = self.validate_device(device)
         
-        hostname = `hostname`.strip
+        if !device
+            return false
+        elsif ! message.is_a?(String)
+            raise ArgumentError, 'Message must be a string'
+        end
         
         ## Send the message
-        result = self.urlRequest(MSGURL.sub(/%YOUR_KEY%/, device.key).sub(/%MESSAGE%/, CGI.escape(message)).sub(/%SENDER_ID%/, hostname))
+        result = AutoRemoteRequest.message(device.key, `hostname`.strip, CGI.escape(message))
         
         ## Check result
-        if result.body != 'OK'
-            raise self::InvalidKey
+        if result.body == 'OK'
+            return true
+        else
+            return false
         end
     end
     
     # 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 [AutoRemote::UnsupportedAction] if running from windows
-    # @raise [TypeError] if message isn't a string or less than 5 characters
-    # @return [void]
-    def AutoRemote::registerOnDevice(device, remotehost)
-        if ! device.kind_of?(Device) && ! (device = Device.find_by_name(device))
-            raise self::DeviceNotFound
-        elsif ! remotehost.kind_of?(String) || remotehost.length < 5
+    # @raise [ArgumentError] if message isn't a string or less than 5 characters
+    # @return [true] if the registration was successful
+    # @return [false] if the registration failed
+    def AutoRemote::register_on_device(device, remotehost)
+        device = self.validate_device(device)
+        
+        if !device
+            return false
+        elsif ! remotehost.is_a?(String) || remotehost.length < 5
             raise ArgumentError, 'remotehost must be a string of 5 chars or more'
         end
         
         hostname = `hostname`.strip
-        ipAddress = AutoRemote::getIpAddress.ip_address
+        ipAddress = AutoRemote::get_ip_address.ip_address
         
         ## Perform the registration
-        result = self.urlRequest(REGURL.sub(/%YOUR_KEY%/, device.key).sub(/%DISPLAY_NAME%/, hostname).sub(/%UNIQUE_ID%/, hostname).sub(/%PUBLIC_HOST%/, remotehost).sub(/%IP_ADDRESS%/, ipAddress))
+        result = AutoRemoteRequest.register(device.key, hostname, hostname, remotehost, ipAddress)
         
         ## Check result
-        if result.body != 'OK'
-            raise self::AutoRemoteException, 'Something went wrong when registering on the device'
+        if result.body == 'OK'
+            return true
+        else
+            return false
         end
     end
     
     ## Define alases for some methods
     class << AutoRemote
-        alias :saveDevice :addDevice
-        alias :deleteDevice :removeDevice
-        alias :sendMsg :sendMessage
-        alias :regOnDevice :registerOnDevice
+        # Add
+        alias :addDevice :add_device
+        alias :saveDevice :add_device
+        alias :save_device :add_device
+        # Remove
+        alias :removeDevice :remove_device
+        alias :deleteDevice :remove_device
+        alias :delete_device :remove_device
+        # List
+        alias :listDevices :list_devices
+        # Get
+        alias :getDevice :get_device
+        # Message
+        alias :sendMessage :send_message
+        alias :sendMsg :send_message
+        alias :send_msg :send_message
+        # Register
+        alias :registerOnDevice :register_on_device
+        alias :regOnDevice :register_on_device
+        alias :reg_on_device :register_on_device
     end
     
     private
+    # Validates device
+    # @param input the input to validate
+    # @return [Device] if the input is valid
+    # @return [nil] if the input is not valid
+    def AutoRemote::validate_device(input)
+        if input.is_a?(Device)
+            return input
+        else
+            device = Device.find_by_name(input)
+            if device.kind_of?(Device)
+                return device
+            else
+                return nil
+            end
+        end
+    end
+    
     # Gets the ip address of the system
     # @return [String]
-    def AutoRemote::getIpAddress
+    def AutoRemote::get_ip_address
         return Socket.ip_address_list.detect { |ipInfo| ipInfo.ipv4_private? }
     end
-    
-    # Performs a http request
-    # @param url [String]
-    def AutoRemote::urlRequest(url)
-        ## Add http:// to the url if not present
-        url = 'http://' + url unless url.match(/^https?:\/{2}/i)
-        
-        return HTTParty.get(url)
-    end
 end

data/lib/autoremote/exceptions.rb

@@ -1,23 +1,11 @@
 module AutoRemote
     class AutoRemoteException < StandardError
     end
-    
-    class DeviceNotFound < AutoRemoteException
-        def message
-            "Device doesn't exist"
-        end
-    end
-    
-    class DeviceAlreadyExist < AutoRemoteException
-        def message
-            "Device already exist"
-        end
-    end
-    
+
     class InvalidKey < AutoRemoteException
         def message
             "The key is invalid"
         end
     end
-    
+
 end

data/lib/autoremote/net.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+
+class AutoRemoteRequest
+    include HTTParty
+    base_uri 'https://autoremotejoaomgcd.appspot.com'
+    
+    def self.register(key, id, name, publicip, localip)
+        get('/registerpc', query: { key: key, id: id, name: name, publicip: publicip, localip: localip })
+    end
+    
+    def self.message(key, sender, message)
+        get('/sendmessage', query: { key: key, sender: sender, message: message })
+    end
+    
+    def self.validate_key(key)
+        get('/sendmessage', query: { key: key })
+    end
+    
+    def self.validate_url(url)
+        ## Add https:// to the url if not present
+        url.prepend 'https://' unless url.match(/^https?:\/{2}/i)
+        get(url)
+    end
+    
+end

data/lib/autoremote/version.rb

@@ -1,3 +1,3 @@
 module AutoRemote
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/autoremote_spec.rb

@@ -1,38 +1,84 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 require 'spec_helper.rb'
 require 'autoremote'
 
 TEST_NAME = 'TestDevice'
 TEST_URL = 'http://goo.gl/CyA66h'
 TEST_KEY = 'APA91bFKEjtBfVU5WoJJ8KyfmR3LfmUpcVrePdQQ_T5oN1h8KcLptzhCvDE-FP1IQPimb9bk4Osm2FzTUvUT5YRylgjTMTHbS7HqbveHE-ZhgwtJEsfoKvo_JAN8Oh5NLpk-mvWEMBaZtpZVXqb3oP-G_7iKmY4UrNhXhrx9CNKOEWjhuluM0Js'
-TEST_MSG = 'This is a test message'
+TEST_MSG = 'This is a test message from the autoremote ruby gem'
 
 describe AutoRemote do
-    describe '#addDevice' do
-        it 'adds a device' do
-            AutoRemote.addDevice(TEST_NAME, TEST_URL)
+    describe '#add_device(key)' do
+        it 'adds a device with a key' do
+            device = AutoRemote.add_device(TEST_NAME, TEST_KEY)
+            expect(device).to be_instance_of(Device)
+            expect(device.name).to eq(TEST_NAME)
+            expect(device.key).to eq(TEST_KEY)
+        end
+    end
+
+    describe '#get_device' do
+        it 'returns a device' do
+            device = AutoRemote.get_device(TEST_NAME)
+            expect(device).to be_instance_of(Device)
+            expect(device.name).to eq(TEST_NAME)
+            expect(device.key).to eq(TEST_KEY)
+        end
+    end
+
+    describe '#remove_device' do
+        it 'removes a device after adding with key' do
+            result = AutoRemote.remove_device(TEST_NAME)
+            expect(result).to eq(true)
+        end
+    end
+
+    describe '#add_device(url)' do
+        it 'adds a device with url' do
+            device = AutoRemote.add_device(TEST_NAME, TEST_URL)
+            expect(device).to be_instance_of(Device)
+            expect(device.name).to eq(TEST_NAME)
+            expect(device.key).to eq(TEST_KEY)
         end
     end
 
-    describe '#listDevices' do
+    describe '#list_devices' do
         it 'returns a list of devices' do
-            list = AutoRemote.listDevices
+            list = AutoRemote.list_devices
             expect(list).not_to eq(nil)
             expect(list.count).to be > 0
         end
     end
 
-    describe '#getDevice' do
+    describe '#get_device' do
         it 'returns a device' do
-            device = AutoRemote.getDevice(TEST_NAME)
+            device = AutoRemote.get_device(TEST_NAME)
             expect(device).to be_instance_of(Device)
             expect(device.name).to eq(TEST_NAME)
             expect(device.key).to eq(TEST_KEY)
         end
     end
 
-    describe 'sends a message' do
-        it do
-            AutoRemote.sendMessage(TEST_NAME, TEST_MSG)
+    describe '#send_message' do
+        it 'sends a message to the device' do
+            result = AutoRemote.send_message(TEST_NAME, TEST_MSG)
+            expect(result).to eq(true)
+        end
+    end
+
+    describe '#register_on_device' do
+        it 'register computer on the device' do
+            result = AutoRemote.register_on_device(TEST_NAME, 'autoremote.example.test')
+            expect(result).to eq(true)
+        end
+    end
+
+    describe '#remove_device' do
+        it 'removes a device at the end of the test' do
+            result = AutoRemote.remove_device(TEST_NAME)
+            expect(result).to eq(true)
         end
     end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# Always use the expect syntax
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoremote
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Magnus Smedberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".pullreview.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,6 +113,7 @@ files:
 - bin/autoremote
 - lib/autoremote.rb
 - lib/autoremote/exceptions.rb
+- lib/autoremote/net.rb
 - lib/autoremote/version.rb
 - spec/autoremote_spec.rb
 - spec/spec_helper.rb