autoremote 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7b2d0b7620a21484db8c002d2a295eebd59bda
-  data.tar.gz: 2825fff65839f16ce93cd35134185e22ebdec542
+  metadata.gz: 556baa7cab3df31f1515bb062d933440923499b0
+  data.tar.gz: 8d2c4700f0ea3c49502f4928c38e8e5ad6494ed5
 SHA512:
-  metadata.gz: f522bfb3c914254549b6f2bfcb1697098b7ec8d5575e3c539fcc08d5b9c7f3bd24bd17c0ab71d09ff0ba5022575c4500f578235263f5ddad7156a962419a5e8c
-  data.tar.gz: 9e06942d9472ea015fc22007920cc3fdafccb14cdee8a6f2fc32dc5c8cb4c55082bc69ecf45184bd19f0ecf5c16ae1f75fbfcb3550e845de8fed3258499dcc03
+  metadata.gz: a621b850030b061cea9be09cd2f2a09106dc6f07029856276dbe0929ff86c99250104758e679c22ec45b62f8666861a981818ce9cfeeef417c28e948a6a96e1b
+  data.tar.gz: d42f3720da620411a193ca9c3aa385b3a436579548ca11d0ac5d7ce523f7081a13e2cd6008038938cf40ae2e0202c0094adda76fc30fd1cf2617871e0e7ba067

data/README.md

@@ -4,12 +4,13 @@
 [![Dependency Status](http://img.shields.io/gemnasium/AltonV/autoremote.svg)][gemnasium]
 [![Gem Downloads](https://img.shields.io/gem/dt/autoremote.svg)][gem]
 [![Code Climate](https://codeclimate.com/github/AltonV/autoremote/badges/gpa.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/AltonV/autoremote.svg?branch=master&style=shields)][inch-ci]
 
 [licence]: http://choosealicense.com/licenses/mit/
 [gem]: https://rubygems.org/gems/autoremote
 [gemnasium]: https://gemnasium.com/AltonV/autoremote
-[bitdeli]: https://bitdeli.com/free "Bitdeli Badge"
 [codeclimate]: https://codeclimate.com/github/AltonV/autoremote
+[inch-ci]: http://inch-ci.org/github/AltonV/autoremote
 
 A library that makes it easier to interact with your other autoremote devices.  
 This project incudes both a library and an executable that uses the library.

data/Rakefile

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/autoremote.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
     spec.authors       = [ "Magnus Smedberg" ]
     spec.email         = [ "magnus.smedberg@yurijware.com" ]
     spec.summary       = %q{A library for interacting with autoremote devices http://joaoapps.com/autoremote/}
-    spec.homepage      = "https://github.com/AltonV/autoremote"
+    spec.homepage      = "http://altonv.github.io/autoremote/"
     spec.license       = "MIT"
     
     spec.files         = `git ls-files -z`.split("\x0")
@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
     spec.require_paths = ["lib"]
     
     spec.add_development_dependency "bundler", "~> 1.7"
-    spec.add_development_dependency "rake", "~> 10.0"
+    spec.add_development_dependency "rake", "~> 10"
+    spec.add_development_dependency "rspec", "~> 3"
     
     spec.add_runtime_dependency 'activerecord', '~> 4.2', '~> 4.2'
     spec.add_runtime_dependency 'sqlite3', '~> 1.3', '~> 1.3'

data/bin/autoremote

@@ -2,7 +2,7 @@
 require 'autoremote'
 require 'rbconfig'
 
-def to_bool( string )
+def to_bool(string)
     return false if string.class == NilClass || string.empty? || string.downcase =~ (/^(false|f|no|n|nej|0)$/i)
     return true if string.downcase =~ (/^(true|t|yes|y|ja|j|1)$/i)
     raise ArgumentError, "Invalid value: #{string}"
@@ -10,75 +10,69 @@ end
 
 ## Prints help
 def print_help
-    puts "AutoRemote v" + AutoRemote::VERSION
+    puts 'AutoRemote v' + AutoRemote::VERSION
     puts "\nArguments:"
-    puts "    add DEVICE KEY|URL         Save device either with a 'goo.gl' url or personal key"
-    puts "    remove DEVICE              Removes device"
-    puts "    delete DEVICE              Same as above"
-    puts "    list [WITHKEY]             Lists all devices"
-    puts "    message DEVICE MESSAGE     Send a message to a device"
-    puts "    register DEVICE HOST       Register this computer to the device"
+    puts '    add DEVICE KEY|URL         Save device either with a \'goo.gl\' url or personal key'
+    puts '    remove DEVICE              Removes device'
+    puts '    delete DEVICE              Same as above'
+    puts '    list [WITHKEY]             Lists all devices'
+    puts '    message DEVICE MESSAGE     Send a message to a device'
+    puts '    register DEVICE HOST       Register this computer to the device'
     exit()
 end
 
 arg0 = ARGV[0].downcase if ARGV[0]
 
-if arg0 == "help" || arg0 == "-h" || arg0 == "--help"
+if arg0 == 'help' || arg0 == '-h' || arg0 == '--help'
     print_help
-    
-elsif arg0 == "add" && ARGV[1] && ARGV[2]
-    puts "Adding device"
+elsif arg0 == 'add' && ARGV[1] && ARGV[2]
+    puts 'Adding device'
     begin
-        AutoRemote.addDevice( ARGV[1], ARGV[2] )
-        puts "Device added successfully"
+        AutoRemote.addDevice(ARGV[1], ARGV[2])
+        puts 'Device added successfully'
     rescue Exception => e
         puts "Error: #{e.message}"
     end
-    
-elsif ( arg0 == "remove" || arg0 == "delete" ) && ARGV[1]
-    puts "Removing device"
+elsif ( arg0 == 'remove' || arg0 == 'delete' ) && ARGV[1]
+    puts 'Removing device'
     begin
-        AutoRemote.removeDevice( ARGV[1] )
-        puts "Device removed successfully"
+        AutoRemote.removeDevice(ARGV[1])
+        puts 'Device removed successfully'
     rescue Exception => e
         puts "Error: #{e.message}"
     end
-    
-elsif arg0 == "list"
+elsif arg0 == 'list'
     withkey = to_bool(ARGV[1])
-    puts "Listing devices"
+    puts 'Listing devices'
     
     AutoRemote.listDevices.each do|device|
         print "Name: #{device.name}"
         print "    Key: #{device.key}" if withkey
         puts
     end
-    
-elsif arg0 == "message" && ARGV[1] && ARGV[2]
+elsif arg0 == 'message' && ARGV[1] && ARGV[2]
     begin
-        AutoRemote::sendMessage( ARGV[1], ARGV[2] )
-        puts "Message sent successfully"
+        AutoRemote.sendMessage(ARGV[1], ARGV[2])
+        puts 'Message sent successfully'
     rescue Exception => e
         puts "Error: #{e.message}"
     end
-    
-elsif arg0 == "register" && ARGV[1] && ARGV[2]
+elsif arg0 == 'register' && ARGV[1] && ARGV[2]
     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)"
-        if ! to_bool($stdin.gets.chomp)
-            puts "Registering interrupted"
+        puts 'Are you sure you want to register a windows computer?'
+        print 'You will need an SSH server on the computer. (y/n)'
+        unless to_bool($stdin.gets.chomp)
+            puts 'Registering interrupted'
             exit
         end
     end
     
     begin
-        AutoRemote::registerOnDevice( ARGV[1], ARGV[2] )
-        puts "Device registered successfully"
+        AutoRemote.registerOnDevice(ARGV[1], ARGV[2])
+        puts 'Device registered successfully'
     rescue Exception => e
         puts "Error: #{e.message}"
     end
-    
 else
     print_help
 end

data/lib/autoremote.rb

@@ -1,5 +1,5 @@
-require "autoremote/version"
-require "autoremote/exceptions"
+require 'autoremote/version'
+require 'autoremote/exceptions'
 require 'sqlite3'
 require 'active_record'
 require 'net/http'
@@ -25,9 +25,9 @@ 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%"
+    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
@@ -35,15 +35,15 @@ module AutoRemote
     # @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 )
+    def AutoRemote::addDevice(name, input)
         
         ## Validation if input is a 'goo.gl' url
-        if input.match( /^(https?:\/{2})?(goo.gl\/[\S]*)$/i )
-            result = self.urlRequest( input )
+        if input.match(/^(https?:\/{2})?(goo.gl\/[\S]*)$/i)
+            result = self.urlRequest(input)
             
             ## Get the key from the resulting url
             begin
-                input = CGI.parse( result.request.last_uri.query )['key'][0]
+                input = CGI.parse(result.request.last_uri.query)['key'][0]
             rescue
                 raise self::InvalidKey
             end
@@ -51,16 +51,16 @@ 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 = self.urlRequest(VALIDATIONURL.sub(/%YOUR_KEY%/, input))
             
             ## Check result
-            if result.body != "OK"
+            if result.body != 'OK'
                 raise self::InvalidKey
             end
         end
         
         ## Check if the device already exist
-        if Device.find_by_name( name ) || Device.find_by_key( input )
+        if Device.find_by_name(name) || Device.find_by_key(input)
             raise self::DeviceAlreadyExist
         end
         
@@ -72,9 +72,8 @@ module AutoRemote
     # @param name [String] The name of the device
     # @raise [AutoRemote::DeviceNotFound] if the device didn't exist
     # @return [void]
-    def AutoRemote::removeDevice( name )
+    def AutoRemote::removeDevice(name)
         if device = Device.find_by_name(name)
-            
             ## Remove the device
             Device.delete(device.id)
         else
@@ -85,13 +84,13 @@ module AutoRemote
     # Returns a list with all devices
     # @return [Device::ActiveRecord_Relation]
     def AutoRemote::listDevices
-        return Device.order("name").all
+        return Device.order('name').all
     end
     
     # Returns one specific device
     # @return [Device]
-    def AutoRemote::getDevice( name )
-        return Device.find_by_name( name )
+    def AutoRemote::getDevice(name)
+        return Device.find_by_name(name)
     end
     
     # Sends a message to a device
@@ -100,20 +99,20 @@ module AutoRemote
     # @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 ) )
+    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"
+        elsif ! message.kind_of?(String)
+            raise TypeError, 'Message must be a string'
         end
         
         hostname = `hostname`.strip
         
         ## Send the message
-        result = self.urlRequest( MSGURL.sub( /%YOUR_KEY%/, device.key ).sub( /%MESSAGE%/, message ).sub( /%SENDER_ID%/, hostname ) )
+        result = self.urlRequest(MSGURL.sub(/%YOUR_KEY%/, device.key).sub(/%MESSAGE%/, CGI.escape(message)).sub(/%SENDER_ID%/, hostname))
         
         ## Check result
-        if result.body != "OK"
+        if result.body != 'OK'
             raise self::InvalidKey
         end
     end
@@ -125,22 +124,22 @@ module AutoRemote
     # @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 ) )
+    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, "remotehost must be a string of 5 chars or more"
+        elsif ! remotehost.kind_of?(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
         
         ## 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 = self.urlRequest(REGURL.sub(/%YOUR_KEY%/, device.key).sub(/%DISPLAY_NAME%/, hostname).sub(/%UNIQUE_ID%/, hostname).sub(/%PUBLIC_HOST%/, remotehost).sub(/%IP_ADDRESS%/, ipAddress))
         
         ## Check result
-        if result.body != "OK"
-            raise self::AutoRemoteException, "Something went wrong when registering on the device"
+        if result.body != 'OK'
+            raise self::AutoRemoteException, 'Something went wrong when registering on the device'
         end
     end
     
@@ -156,17 +155,15 @@ module AutoRemote
     # Gets the ip address of the system
     # @return [String]
     def AutoRemote::getIpAddress
-        return Socket.ip_address_list.detect{|ipInfo| ipInfo.ipv4_private?}
+        return Socket.ip_address_list.detect { |ipInfo| ipInfo.ipv4_private? }
     end
     
     # Performs a http request
     # @param url [String]
-    def AutoRemote::urlRequest( url )
+    def AutoRemote::urlRequest(url)
         ## Add http:// to the url if not present
-        if ! url.match( /^https?:\/{2}/i )
-            url = "http://" + url
-        end
+        url = 'http://' + url unless url.match(/^https?:\/{2}/i)
         
-        return HTTParty.get( url )
+        return HTTParty.get(url)
     end
 end

data/lib/autoremote/exceptions.rb

@@ -1,23 +1,23 @@
-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
+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/version.rb

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

data/spec/autoremote_spec.rb

@@ -0,0 +1,38 @@
+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'
+
+describe AutoRemote do
+    describe '#addDevice' do
+        it 'adds a device' do
+            AutoRemote.addDevice(TEST_NAME, TEST_URL)
+        end
+    end
+
+    describe '#listDevices' do
+        it 'returns a list of devices' do
+            list = AutoRemote.listDevices
+            expect(list).not_to eq(nil)
+            expect(list.count).to be > 0
+        end
+    end
+
+    describe '#getDevice' do
+        it 'returns a device' do
+            device = AutoRemote.getDevice(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)
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoremote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Magnus Smedberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +112,9 @@ files:
 - lib/autoremote.rb
 - lib/autoremote/exceptions.rb
 - lib/autoremote/version.rb
-homepage: https://github.com/AltonV/autoremote
+- spec/autoremote_spec.rb
+- spec/spec_helper.rb
+homepage: http://altonv.github.io/autoremote/
 licenses:
 - MIT
 metadata: {}
@@ -122,5 +138,7 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A library for interacting with autoremote devices http://joaoapps.com/autoremote/
-test_files: []
+test_files:
+- spec/autoremote_spec.rb
+- spec/spec_helper.rb
 has_rdoc: