ruby-dovado 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e7c4e1e5304745d859175e5a713dd34a1cf0ded
-  data.tar.gz: 928808f3fb205fa3eb4f6850603dfc2fe04f04f1
+  metadata.gz: 00da334c3de14089a89e7dd33787879ca4f59440
+  data.tar.gz: b138d5e2a2ffa2b9075b9509535a138b466f8eb6
 SHA512:
-  metadata.gz: 05c59b4500d3a2e9866d0b05c16b89dd043e33daf464ae7f7ce91bfcce7e9d1202380659caad73843976040a38170bb8243028639955641de9d7fb76de9b44b2
-  data.tar.gz: 8da24c1d83c61cd4e4c8ada42617ec5416146fe7a800fb68c6e586954ecd9c545c899d92adcf57fb1d29b33190e9e1cff11aa8771442ae1f1082a5494183825c
+  metadata.gz: bacfb7aac3dcf237dc7d5a75286d94814a9d3618dfecc2a7e9852cc4be3a49608ed31b25376109a30df53b2eb837707be888dd94d2dc8f3f9af3b0c5ace5c71a
+  data.tar.gz: 5a2605658f78bf55b34a5cc55d94ad859e1d81f4a06e44118b4a47b0f957c440f40ecd28d0e302987c52f8a71f1fb81698a647b410ad27a4bd3dbc1e2faff168

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env

data/README.md

@@ -7,12 +7,14 @@ A Dovado Router API for Ruby.
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat-square)](http://www.rubydoc.info/gems/ruby-dovado/frames)
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg?style=flat-square)](#copyright)
 
-This library serves to enable easy access to the built in, Telnet-based, rudimentary API of the [routers from Dovado](http://www.dovado.com/en/products) running software version 6 and 7 (applies to the original Tiny and Go routers, among others). It might work with software version 8 routers (the Tiny AC) too but I have no means to test against that since I don't have one of the later routers.
+This library serves to enable easy access to the built in, Telnet-based, rudimentary API of the [routers from Dovado](http://www.dovado.com/en/products) running software version 7 and 8 (applies to the original Tiny, Go and Pro routers). It might work with the Tiny AC too but I have no means to test against that.
 
 ## Purpose
 
 The original purpose of this library was to enable addition of router information about connection state, mobile data connection quality and data quota usage on a wall-mounted TV or a small touch screen connected to a Raspberry Pi, accessing a dashboard implemented using [Dashing](https://shopify.github.io/dashing/).
 
+See this blog entry for some discussion on usage and background: "[A Ruby API for Dovado routers](http://www.janlindblom.se/blog/programming/2015/10/22/ruby-dovado-library.html)".
+
 ## Usage
 
 Add it to your Gemfile:
@@ -32,6 +34,16 @@ router.sms.load_messages
 message = router.sms.get_message 12
 ```
 
+The main elements available on the `router` object are:
+
+* `info` - [Dovado::Router::Info](http://www.rubydoc.info/gems/ruby-dovado/Dovado/Router/Info)
+* `services` - [Dovado::Router::Services](http://www.rubydoc.info/gems/ruby-dovado/Dovado/Router/Services)
+* `internet` - [Dovado::Router::Internet](http://www.rubydoc.info/gems/ruby-dovado/Dovado/Router/Internet)
+* `sms` - [Dovado::Router::Sms](http://www.rubydoc.info/gems/ruby-dovado/Dovado/Router/Sms)
+* `traffic` - [Dovado::Router::Traffic](http://www.rubydoc.info/gems/ruby-dovado/Dovado/Router/Traffic)
+
+For the full documentation, head over to [rubydoc.info](http://www.rubydoc.info/gems/ruby-dovado/frames).
+
 ## Design Considerations
 
 Since the API published by these routers is Telnet-based, it stands to reason to limit simultaneous connections. This is achieved by a single client object implemented as a Celluloid Actor. The reason for this is because Celluloid Actor objects can be supervised, block threads and be accessed from multiple threads simultaneously without the need to implement any special locking or waiting mechanisms.

data/Rakefile

@@ -16,12 +16,14 @@ namespace :spec do
     t.rspec_opts = "--tag online"
   end
 
-  desc "Run all RSpec code examples"
   RSpec::Core::RakeTask.new(:all) do |t|
     t.rspec_opts = "--tag offline --tag online"
   end
 end
 
+desc "Run all RSpec code examples"
+task :spec => 'spec:all'
+
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']
   t.stats_options = ['--list-undoc']

data/lib/dovado/client.rb

@@ -66,7 +66,9 @@ module Dovado
           'Telnetmode' => false,
           'Prompt' => />>\s/)
       end
-    rescue IOError
+    rescue Net::OpenTimeout => ex
+      raise ConnectionError.new "Error connecting to router: #{ex.message}"
+    rescue IOError => ex
       disconnect
       raise ConnectionError.new "Error connecting to router: #{ex.message}"
     rescue Net::ReadTimeout => ex
@@ -135,7 +137,7 @@ module Dovado
         unless authenticated?
           raise ArgumentError.new "Username cannot be nil" if @user.nil?
           raise ArgumentError.new "Password cannot be nil" if @password.nil?
-        
+
           @server.cmd "user #{@user}"
           @server.waitfor />>\s/
           @server.cmd "pass #{@password}"

data/lib/dovado/router/info/signal.rb

@@ -0,0 +1,38 @@
+module Dovado
+  class Router
+    class Info
+      # Signal Strength object
+      # 
+      # @since 1.0.3
+      class Signal
+
+        # Strength as a percentage
+        # 
+        # @return [Integer] an integer from +0+ to +100+
+        attr_reader :strength
+
+        # Signal noise level in dBm
+        # 
+        # @return [Integer] noise level (dBm)
+        attr_reader :noise
+
+        # Network type
+        # 
+        # One of:
+        # - 2G
+        # - 3G
+        # - 4G
+        # 
+        # @return [String] current network type
+        attr_reader :network
+
+        def initialize(args)
+          @strength = args[:strength].to_i
+          @noise = args[:noise].to_i
+          @network = args[:network]
+        end
+
+      end
+    end
+  end
+end

data/lib/dovado/router/info.rb

@@ -1,6 +1,7 @@
 require 'date'
 require 'time'
 require 'socket'
+require 'ipaddr'
 require 'thread_safe'
 
 module Dovado
@@ -11,6 +12,105 @@ module Dovado
     class Info
       include Celluloid
 
+      # Get the product name
+      # 
+      # @return [String] product name
+      # @since 1.0.3
+      attr_reader :product_name
+
+      # Get the current signal strength information
+      # 
+      # @return [Info::Signal] current signal strength information
+      # @since 1.0.3
+      # @see {Info::Signal}
+      attr_reader :signal_strength
+
+      # Get the number of kilobytes sent to the internet since last traffic
+      # counter reset.
+      # 
+      # @return [Integer] number of kilobytes sent to the internet
+      # @since 1.0.3
+      attr_reader :traffic_modem_tx
+
+      # Get the number of kilobytes read from the internet since last traffic
+      # counter reset.
+      # 
+      # @return [Integer] number of kilobytes read from the internet
+      # @since 1.0.3
+      attr_reader :traffic_modem_rx
+
+      # Get the currently active connection
+      # 
+      # @return [String] the port currently active as internet connection
+      # @since 1.0.3
+      attr_reader :connection
+
+      # Get the current state of the connected modem
+      # 
+      # @return [String] current state of the connected modem
+      # @since 1.0.3
+      attr_reader :modem_status
+
+      # Get the external IP address of the router
+      # 
+      # @return [IPAddr] external IP address
+      # @since 1.0.3
+      attr_reader :external_ip
+
+      # Get the current date on the router
+      # 
+      # @return [Date] current date
+      # @since 1.0.3
+      attr_reader :date
+
+      # Get the current time on the router
+      # 
+      # @return [Time] current time
+      # @since 1.0.3
+      attr_reader :time
+
+      # Get the GPS type
+      # 
+      # @return [String] the type of GPS
+      # @since 1.0.3
+      attr_reader :gps_type
+
+      # Get the GPS latitude
+      # 
+      # @return [Float] GPS latitude
+      # @since 1.0.3
+      attr_reader :gps_lat
+
+      # Get the GPS longitude
+      # 
+      # @return [Float] GPS longitude
+      # @since 1.0.3
+      attr_reader :gps_long
+
+      # Get the sunrise at the current location
+      # 
+      # @return [Time] sunrise at the current location
+      # @since 1.0.3
+      attr_reader :sunrise
+
+      # Get sunset at the current location
+      # 
+      # @return [Time] sunset at the current location
+      # @since 1.0.3
+      attr_reader :sunset
+
+      # Get the sms object
+      # 
+      # @return [Sms] the sms object
+      # @since 1.0.3
+      attr_reader :sms
+
+      # Get connected devices
+      # 
+      # @return [Array<String>] an array with connected devices
+      # @since 1.0.3
+      attr_reader :connected_devices
+
       # Create a new {Info} object.
       # 
       # @param [Hash] args optional hash to initialize with.
@@ -40,25 +140,31 @@ module Dovado
             val = entry_array[1]
             keysym = Utilities.name_to_sym(key)
             case key
-            when 'traffic_modem_tx'
-              @data[:traffic_modem_tx] = val.strip.to_i
-            when 'traffic_modem_rx'
-              @data[:traffic_modem_rx] = val.strip.to_i
-            when 'time'
-              @data[:time] = Time.parse(val)
+            when 'traffic_modem_tx', 'traffic_modem_rx'
+              @data[keysym] = val.strip.to_i
+            when 'time', 'sunset', 'sunrise'
+              @data[keysym] = Time.parse(val.strip)
             when 'date'
-              @data[:date] = Date.parse(val)
+              @data[:date] = Date.parse(val.strip)
             when 'sms_unread'
               @data[:sms] = sms if @data[:sms].nil?
-              @data[:sms].unread = val.to_i
+              @data[:sms].unread = val.strip.to_i
             when 'sms_total'
               @data[:sms] = sms if @data[:sms].nil?
-              @data[:sms].total = val.to_i
+              @data[:sms].total = val.strip.to_i
             when 'connected_devices'
-              val = val.split(',')
+              val = val.strip.split(',')
               @data[keysym] = val
+            when 'gps_lat', 'gps_long'
+              @data[keysym] = val.to_f
+            when 'external_ip'
+              @data[keysym] = IPAddr.new val.strip
+            when 'signal_strength'
+              match = val.strip.match(/(\d+)\W\%\W(\-?\d+)\WdBm\W\((\d\w)\)/)
+              so = Info::Signal.new(strength: match[1], noise: match[2], network: match[3])
+              @data[keysym] = so
             else
-              @data[keysym] = val
+              @data[keysym] = val.strip
             end
           end
         end
@@ -95,8 +201,77 @@ module Dovado
         keys.member?(key)
       end
 
+      def product_name
+        omni_method
+      end
+
+      def signal_strength
+        omni_method
+      end
+
+      def traffic_modem_tx
+        omni_method
+      end
+
+      def traffic_modem_rx
+        omni_method
+      end
+
+      def connection
+        omni_method
+      end
+
+      def modem_status
+        omni_method
+      end
+
+      def external_ip
+        omni_method
+      end
+
+      def date
+        omni_method
+      end
+
+      def time
+        omni_method
+      end
+
+      def gps_type
+        omni_method
+      end
+
+      def gps_lat
+        omni_method
+      end
+
+      def gps_long
+        omni_method
+      end
+
+      def sunrise
+        omni_method
+      end
+
+      def sunset
+        omni_method
+      end
+
+      def sms
+        omni_method
+      end
+
+      def connected_devices
+        omni_method
+      end
+
       private
 
+      def omni_method
+        this_method = caller[0][/`([^']*)'/, 1]
+        @data[this_method.to_sym]
+      end
+
       def touch!
         @last_update = Time.now.to_i
       end

data/lib/dovado/router/internet.rb

@@ -2,7 +2,7 @@ module Dovado
   class Router
     # Internet Connection.
     # 
-    # @since 1.0.2
+    # @since 1.0.3
     class Internet
       include Celluloid
 

data/lib/dovado/router/services.rb

@@ -9,6 +9,18 @@ module Dovado
     class Services
       include Celluloid
 
+      # Get status of sms service
+      # 
+      # @return [String] a string with "enabled" or "disabled"
+      # @since 1.0.3
+      attr_reader :sms
+
+      # Get status of home automation service
+      # 
+      # @return [String] a string with "enabled" or "disabled"
+      # @since 1.0.3
+      attr_reader :home_automation
+
       # Create a new {Services} object.
       # 
       # @param [Hash] args optional argiments
@@ -73,6 +85,30 @@ module Dovado
         (@last_update + SecureRandom.random_number(9) + 1 <= Time.now.to_i)
       end
 
+      def sms
+        @list[:sms] if has_key? :sms
+      end
+
+      # Boolean check if sms service is enabled
+      # 
+      # @return [Boolean] +true+ or +false+
+      # @since 1.0.3
+      def sms?
+        sms ? (sms == "enabled") : false
+      end
+
+      def home_automation
+        @list[:homeautomation] if has_key? :homeautomation
+      end
+
+      # Boolean check if home automation is enabled
+      # 
+      # @return [Boolean] +true+ or +false+
+      # @since 1.0.3
+      def home_automation?
+        home_automation ? (home_automation == "enabled") : false
+      end
+
       private
 
       def touch!

data/lib/dovado/router/traffic.rb

@@ -4,7 +4,7 @@ module Dovado
   class Router
     # Traffic Counters.
     # 
-    # @since 1.0.2
+    # @since 1.0.3
     class Traffic
       include Celluloid
 

data/lib/dovado/router.rb

@@ -22,22 +22,17 @@ module Dovado
     def initialize(args=nil)
       @address    = '192.168.0.1' # Default address
       @port       = 6435
-      user        = "admin"       # Default username
-      password    = "password"    # Default password
+      @user        = "admin"       # Default username
+      @password    = "password"    # Default password
       @connected  = false
       unless args.nil?
-        @address  = args[:address]  if args.has_key? :address and !args[:address].nil?
-        @port     = args[:port]     if args.has_key? :port and !args[:port].nil?
-        user      = args[:user]     if args.has_key? :user and !args[:user].nil?
-        password  = args[:password] if args.has_key? :password and !args[:password].nil?
+        @address  = args[:address]  if args.has_key? :address
+        @port     = args[:port]     if args.has_key? :port
+        @user      = args[:user]     if args.has_key? :user
+        @password  = args[:password] if args.has_key? :password
       end
 
-      Client.supervise as: :client, size: 1, args: [{
-        server:     @address,
-        port:       @port,
-        user:       user,
-        password:   password
-      }]
+      supervise_client
     end
 
     # Fetch services information from the router.
@@ -45,7 +40,7 @@ module Dovado
     # @return [Services] The {Services} object
     # @see {Services}
     def services
-      Services.supervise as: :router_services, size: 1 unless Actor[:router_services]
+      supervise_services
       client = Actor[:client]
       router_services = Actor[:router_services]
 
@@ -62,6 +57,11 @@ module Dovado
         sms.enabled = true
       end
       router_services
+    rescue ConnectionError => ex
+      Actor[:client].terminate
+      supervise_client
+      supervise_services
+      raise ex
     end
 
     # Get the Internet Connection object.
@@ -87,7 +87,7 @@ module Dovado
     # @return [Info] The {Info} object.
     # @see {Info}
     def info
-      Info.supervise as: :router_info, size: 1 unless Actor[:router_info]
+      supervise_info
       router_info = Actor[:router_info]
       client = Actor[:client]
       router_info = Actor[:router_info]
@@ -99,6 +99,11 @@ module Dovado
       end
       services
       router_info
+    rescue ConnectionError => ex
+      Actor[:client].terminate
+      supervise_client
+      supervise_info
+      raise ex
     end
 
     # Fetch text messages from the router.
@@ -110,5 +115,29 @@ module Dovado
       Actor[:sms]
     end
 
+    private
+
+    def supervise_services
+      return Services.supervise as: :router_services, size: 1 unless Actor[:router_services]
+      return Services.supervise as: :router_services, size: 1 if Actor[:router_services] and Actor[:router_services].dead?
+    end
+
+    def supervise_client
+      args = [{
+        server:     @address,
+        port:       @port,
+        user:       @user,
+        password:   @password
+      }]
+
+      return Client.supervise as: :client, size: 1, args: args unless Actor[:client]
+      return Client.supervise as: :client, size: 1, args: args if Actor[:router_services] and Actor[:router_services].dead?
+    end
+
+    def supervise_info
+      return Info.supervise as: :router_info, size: 1 unless Actor[:router_info]
+      return Info.supervise as: :router_info, size: 1 if Actor[:router_info] and Actor[:router_info].dead?
+    end
+
   end
 end

data/lib/dovado/version.rb

@@ -1,4 +1,4 @@
 module Dovado
   # Current version of the library.
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/dovado.rb

@@ -3,7 +3,7 @@ require 'celluloid/current'
 # The Ruby-Dovado library.
 # 
 # @author Jan Lindblom <janlindblom@fastmail.fm>
-# @version 1.0.2
+# @version 1.0.3
 module Dovado
 end
 
@@ -16,6 +16,7 @@ require 'dovado/router'
 require 'dovado/router/services'
 
 require 'dovado/router/info'
+require 'dovado/router/info/signal'
 require 'dovado/router/info/operator'
 require 'dovado/router/info/operator/telia'
 

data/ruby-dovado.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "dotenv", "~> 2.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dovado
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jan Lindblom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
 description: 
 email:
 - janlindblom@fastmail.fm
@@ -133,6 +147,7 @@ files:
 - lib/dovado/router/info.rb
 - lib/dovado/router/info/operator.rb
 - lib/dovado/router/info/operator/telia.rb
+- lib/dovado/router/info/signal.rb
 - lib/dovado/router/internet.rb
 - lib/dovado/router/services.rb
 - lib/dovado/router/sms.rb