autoremote 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebe641cad96a7e7a75fd16bdaa9bbbec0405edb6
+  data.tar.gz: 79fe1ad622754f2e4de3f7d09e73a87b8590df03
+SHA512:
+  metadata.gz: cd3e45d529755266758d133c809e8aa53ea60636c345e1567678e207124f4efec68fed867dd01068ddb88b448d0aadbf8ba26d50d356bc69e2598507e21bd215
+  data.tar.gz: f37f8b79c77f40f2cc318cea425aeb89e71285ac9e62e6e63e164dd52ecbec69f0761eafe43613dfd0053feef1fbe73f7d62a03fc1d97e81b1b6ae8cf215eb45

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autoremote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# 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.
+
+Devices are saved with sqlite3 in ~/.autoremote/devices.db
+
+If you don't know how to get your personal key [follow this link](http://joaoapps.com/autoremote/personal/)
+
+## Installation
+
+    $ gem install autoremote
+
+## Usage
+
+### Executable
+    $ autoremote add NAME KEY            Save device"
+    $ autoremote remove NAME             Removes device"
+    $ autoremote list [WITHKEY]          Lists all devices"
+    $ autoremote message NAME MESSAGE    Send a message to a device"
+    $ autoremote register NAME HOST      Register this computer to the device"
+
+### Library
+
+```ruby
+require 'autoremote'
+
+# This will save a device for use later
+AutoRemote.addDevice( name, key )
+
+# Removes a device
+AutoRemote.removeDevice( name )
+
+# List all saved devices
+AutoRemote.list
+
+# 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 )
+
+# 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 )
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/autoremote/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/autoremote.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autoremote/version'
+
+Gem::Specification.new do |spec|
+    spec.name          = "autoremote"
+    spec.version       = AutoRemote::VERSION
+    spec.authors       = ["Yurij"]
+    spec.email         = ["yurij@yurijware.com"]
+    spec.summary       = %q{A library for interacting with autoremote devices http://joaoapps.com/autoremote/}
+    spec.homepage      = ""
+    spec.license       = "MIT"
+    
+    spec.files         = `git ls-files -z`.split("\x0")
+    spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+    spec.require_paths = ["lib"]
+    
+    spec.add_development_dependency "bundler", "~> 1.7"
+    spec.add_development_dependency "rake", "~> 10.0"
+    
+    spec.add_runtime_dependency 'activerecord', '~> 4.2', '~> 4.2'
+    spec.add_runtime_dependency 'sqlite3', '~> 1.3', '~> 1.3'
+end

data/bin/autoremote

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+require 'autoremote'
+
+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}"
+end
+
+## Prints help
+def print_help
+    puts "AutoRemote v" + AutoRemote::VERSION
+    puts "\nArguments:"
+    puts "    add DEVICE KEY             Save device"
+    puts "    remove DEVICE              Removes device"
+    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"
+    print_help
+    
+elsif arg0 == "add" && ARGV[1] && ARGV[2]
+    puts "Adding device"
+    begin
+        AutoRemote.addDevice( ARGV[1], ARGV[2] )
+        puts "Device added successfully"
+    rescue Exception => e
+        puts "Error: #{e.message}"
+    end
+    
+elsif arg0 == "remove" && ARGV[1]
+    puts "Removing device"
+    begin
+        AutoRemote.removeDevice( ARGV[1] )
+        puts "Device removed successfully"
+    rescue Exception => e
+        puts "Error: #{e.message}"
+    end
+    
+elsif arg0 == "list"
+    withkey = to_bool(ARGV[1])
+    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]
+    begin
+        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]
+    begin
+        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

@@ -0,0 +1,129 @@
+require "autoremote/version"
+require "autoremote/exceptions"
+# require File.expand_path( File.join( File.dirname( __FILE__ ), 'autoremote', 'version' ) )
+# require File.expand_path( File.join( File.dirname( __FILE__ ), 'autoremote', 'exceptions' ) )
+require 'sqlite3'
+require 'active_record'
+require 'net/http'
+
+## Establish the database connection
+ActiveRecord::Base.establish_connection(
+    :adapter  => 'sqlite3',
+    :database => ENV['HOME'] + '/.autoremote/devices.db'
+)
+
+class Device < ActiveRecord::Base
+end
+
+## Create the database table
+ActiveRecord::Schema.define do
+    break if ActiveRecord::Base.connection.table_exists? 'devices'
+    create_table :devices do |table|
+        table.column :name, :string
+        table.column :key, :string
+    end
+end
+
+module AutoRemote
+    REGCMD = "curl \"http://autoremotejoaomgcd.appspot.com/registerpc?key=%YOUR_KEY%&name=%DISPLAY_NAME%&id=%UNIQUE_ID%&type=linux&publicip=%PUBLIC_HOST%&localip=$(sudo ifconfig eth0 |grep \"inet addr\" |awk '{print $2}' |awk -F: '{print $2}')\""
+    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
+    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#
+        end
+        
+        ## Validate key
+        url = URI.parse( VALIDATIONURL.sub( /%YOUR_KEY%/, key ) )
+        result = Net::HTTP.start(url.host, url.port) {|http|
+            http.request( Net::HTTP::Get.new( url.to_s ) )
+        }
+        if result.body != "OK"
+            raise self::InvalidKey
+        end
+        
+        ## Save the device
+        Device.create(:name => name, :key => key)
+        return true
+    end
+    
+    ## Remove a specific device
+    def AutoRemote::removeDevice( name )
+        if device = Device.find_by_name(name)
+            
+            ## Remove the device
+            return Device.delete(device.id)
+        else
+            raise self::DeviceNotFound
+        end
+    end
+    
+    ## Returns a list with all devices
+    def AutoRemote::listDevices
+        return Device.order("name").all
+    end
+    
+    ## Returns one specific device
+    def AutoRemote::getDevice( name )
+        return Device.find_by_name( name )
+    end
+    
+    ## Send a message to a 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"
+        end
+        
+        hostname = `hostname`.strip
+        
+        ## Send the message
+        url = URI.parse( MSGURL.sub( /%YOUR_KEY%/, device.key ).sub( /%MESSAGE%/, message ).sub( /%SENDER_ID%/, hostname ) )
+        result = Net::HTTP.start(url.host, url.port) {|http|
+            http.request( Net::HTTP::Get.new( url.to_s ) )
+        }
+        
+        ## Check result
+        if result.body != "OK"
+            raise self::InvalidKey
+        end
+        
+        return true
+    end
+    
+    ## Register on the 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"
+        end
+        
+        hostname = `hostname`.strip
+        
+        ## Perform the registration
+        cmd = REGCMD.sub( /%YOUR_KEY%/, device.key ).sub(/%DISPLAY_NAME%/, hostname ).sub(/%UNIQUE_ID%/, hostname ).sub(/%PUBLIC_HOST%/, remotehost )
+        result = system(cmd)
+        puts
+        
+        ## Check result
+        if ! result
+            raise self::AutoRemoteException, "Something went wrong when registering on the device"
+        end
+        
+        return true
+    end
+    
+    ## Define alases for some methods
+    class << AutoRemote
+        alias :saveDevice :addDevice
+        alias :deleteDevice :removeDevice
+        alias :sendMsg :sendMessage
+        alias :regOnDevice :registerOnDevice
+    end
+end

data/lib/autoremote/exceptions.rb

@@ -0,0 +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

data/lib/autoremote/version.rb

@@ -0,0 +1,3 @@
+module AutoRemote
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: autoremote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yurij
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- yurij@yurijware.com
+executables:
+- autoremote
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoremote-devices.db
+- autoremote.gemspec
+- bin/autoremote
+- lib/autoremote.rb
+- lib/autoremote/exceptions.rb
+- lib/autoremote/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A library for interacting with autoremote devices http://joaoapps.com/autoremote/
+test_files: []