ruby-dovado 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c269ddd9eff2fa5106fa286c8498b084622003c4
-  data.tar.gz: c51e6186541f708b122c5161138cbb6dd89c52aa
+  metadata.gz: 5e7c4e1e5304745d859175e5a713dd34a1cf0ded
+  data.tar.gz: 928808f3fb205fa3eb4f6850603dfc2fe04f04f1
 SHA512:
-  metadata.gz: 905cdbe46e78f7d5765014a4a3e7d5b08c71505e9c83e987e439b46a7b6974779804b8a872e064410d4f2bb20c50aae98db0cf904c18140cf49b0592c54cc443
-  data.tar.gz: d15460a40263fdf2f296caa06b852cc00de0ab26b6b212ad55ed6e2c76fa1d42bca8b0bfecc972bc032ca8a51ee3f9bc884e22c13f9763d50b28301c60e1b941
+  metadata.gz: 05c59b4500d3a2e9866d0b05c16b89dd043e33daf464ae7f7ce91bfcce7e9d1202380659caad73843976040a38170bb8243028639955641de9d7fb76de9b44b2
+  data.tar.gz: 8da24c1d83c61cd4e4c8ada42617ec5416146fe7a800fb68c6e586954ecd9c545c899d92adcf57fb1d29b33190e9e1cff11aa8771442ae1f1082a5494183825c

data/README.md

@@ -3,6 +3,9 @@
 A Dovado Router API for Ruby.
 
 [![Build Status](https://drone.io/bitbucket.org/janlindblom/ruby-dovado/status.png)](https://drone.io/bitbucket.org/janlindblom/ruby-dovado/latest)
+[![Gem](https://img.shields.io/gem/v/ruby-dovado.svg?style=flat-square)](https://rubygems.org/gems/ruby-dovado)
+[![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.
 
@@ -21,9 +24,9 @@ gem "ruby-dovado"
 They load it in your code:
 
 ```ruby
-require “dovado”
+require "dovado"
 
-router = Dovado::Router.new(address: “192.168.0.1”, user: “admin”, password: “password”)
+router = Dovado::Router.new(address: "192.168.0.1", user: "admin", password: "password")
 router.info
 router.sms.load_messages
 message = router.sms.get_message 12

data/lib/dovado.rb

@@ -3,7 +3,7 @@ require 'celluloid/current'
 # The Ruby-Dovado library.
 # 
 # @author Jan Lindblom <janlindblom@fastmail.fm>
-# @version 1.0.1
+# @version 1.0.2
 module Dovado
 end
 
@@ -12,11 +12,18 @@ require 'dovado/utilities'
 require 'dovado/client'
 
 require 'dovado/router'
+
 require 'dovado/router/services'
+
 require 'dovado/router/info'
 require 'dovado/router/info/operator'
 require 'dovado/router/info/operator/telia'
 
+require 'dovado/router/internet'
+
+require 'dovado/router/traffic/amount'
+require 'dovado/router/traffic'
+
 require 'dovado/router/sms'
 require 'dovado/router/sms/messages'
 require 'dovado/router/sms/message'

data/lib/dovado/router.rb

@@ -64,6 +64,24 @@ module Dovado
       router_services
     end
 
+    # Get the Internet Connection object.
+    # @since 1.0.2
+    # @return [Internet] the Internet Connection object.
+    # @see {Internet}
+    def internet
+      Internet.supervise as: :internet, size: 1 unless Actor[:internet]
+      Actor[:internet]
+    end
+
+    # Get the Data Traffic object.
+    # @since 1.0.2
+    # @return [Traffic] the Data Traffic object
+    # @see {Traffic}
+    def traffic
+      Traffic.supervise as: :traffic, size: 1 unless Actor[:traffic]
+      Actor[:traffic]
+    end
+
     # Fetch information from the router.
     # 
     # @return [Info] The {Info} object.

data/lib/dovado/router/info.rb

@@ -87,6 +87,14 @@ module Dovado
         @data.keys
       end
 
+      # Check if the {Info} object has a given key.
+      # 
+      # @param [Symbol] key the key to check for.
+      # @return [Boolean] +true+ or +false+
+      def has_key?(key)
+        keys.member?(key)
+      end
+
       private
 
       def touch!

data/lib/dovado/router/internet.rb

@@ -0,0 +1,63 @@
+module Dovado
+  class Router
+    # Internet Connection.
+    # 
+    # @since 1.0.2
+    class Internet
+      include Celluloid
+
+      # Create a new {Internet} object.
+      def initialize
+        @state = ThreadSafe::Cache.new
+        @state[:status] = :offline
+      end
+
+      # Enable internet connection.
+      def on!
+        client = Actor[:client]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        client.command("internet on")
+        status = :online
+      end
+
+      # Disable internet connection.
+      def off!
+        client = Actor[:client]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        client.command("internet off")
+        status = :offline
+      end
+
+      # Check if the internet connection is up.
+      # 
+      # @return [Boolean] +true+ if internet was enabled, false otherwise.
+      def on?
+        status == :online
+      end
+
+      # Check if the internet connection is down.
+      # 
+      # @return [Boolean] +true+ if internet was disabled, false otherwise.
+      def off?
+        status == :offline
+      end
+
+      # Return the current status of the internet connection.
+      # 
+      # @return [Symbol] one of: +:online+ or +:offline+
+      def status
+        @state[:status]
+      end
+
+      # Set the current status of the internet connection.
+      # 
+      # @param [Symbol] value one of: +:online+ or +:offline+
+      def status=(value)
+        @state[:status] = value
+      end
+
+    end
+  end
+end

data/lib/dovado/router/services.rb

@@ -57,6 +57,14 @@ module Dovado
         @list.keys
       end
 
+      # Check if the {Services} object has a given key.
+      # 
+      # @param [Symbol] key the key to check for.
+      # @return [Boolean] +true+ or +false+
+      def has_key?(key)
+        keys.member?(key)
+      end
+
       # Checks if this {Services} object is still valid.
       # 
       # @return [Boolean] +true+ or +false+.

data/lib/dovado/router/traffic.rb

@@ -0,0 +1,91 @@
+require 'dovado/router/traffic/amount'
+
+module Dovado
+  class Router
+    # Traffic Counters.
+    # 
+    # @since 1.0.2
+    class Traffic
+      include Celluloid
+
+      # Create a new {Internet} object.
+      def initialize
+        @data = ThreadSafe::Cache.new
+        @client = Actor[:client] unless @client
+        @last_update = nil
+        @data[:down] = Traffic::Amount.new(0)
+        @data[:up] = Traffic::Amount.new(0)
+      end
+
+      # Data upload traffic amount.
+      # 
+      # @return [Amount] amount of uploaded data.
+      def up
+        update!
+        @data[:up]
+      end
+
+      # Data download traffic amount.
+      # 
+      # @return [Amount] amount of downloaded data.
+      def down
+        update!
+        @data[:down]
+      end
+
+      # Update this {Traffic} object.
+      def update!
+        unless valid?
+          begin
+            up, down = fetch_from_router
+          rescue
+            up, down = fetch_from_router_info
+          end
+          @data[:down] = Traffic::Amount.new(down)
+          @data[:up] = Traffic::Amount.new(up)
+          touch!
+        end
+      end
+
+      # Determine if this traffic object is valid.
+      #
+      # @return [Boolean] true or false.
+      def valid?
+        return false if @last_update.nil?
+        (@last_update + SecureRandom.random_number(9) + 1 <= Time.now.to_i)
+      end
+
+      private
+
+      def touch!
+        @last_update = Time.now.to_i
+      end
+
+      def fetch_from_router
+        up, down = [@data[:up], @data[:down]]
+        client = Actor[:client]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        string = client.command('traffic')
+        matched = string.match(/(\d+)\W(\d+)\W\/\W(\d+)/)
+        if matched
+          up = matched[3].to_i if matched[3]
+          down = matched[2].to_i if matched[2]
+        else
+          up, down = fetch_from_router_info
+        end
+        [up, down]
+      end
+
+      def fetch_from_router_info
+        up, down = [@data[:up], @data[:down]]
+        Info.supervise as: :router_info, size: 1 unless Actor[:router_info]
+        router_info = Actor[:router_info]
+        down = router_info[:traffic_modem_rx].to_i if router_info.has_key? :traffic_modem_rx
+        up = router_info[:traffic_modem_rx].to_i if router_info.has_key? :traffic_modem_tx
+        [up, down]
+      end
+
+    end
+  end
+end

data/lib/dovado/router/traffic/amount.rb

@@ -0,0 +1,55 @@
+module Dovado
+  class Router
+    class Traffic
+      # Data amount data type. Extends Numeric and can be used as an Integer
+      # with the addition of getting the amount as bytes, kilobytes, megabytes
+      # or gigabytes.
+      # 
+      # @since 1.0.2
+      class Amount < Numeric
+
+        # The default base of a kilobyte.
+        DEFAULT_KILO_BASE = 1024
+
+        # Create a new Amount object.
+        # 
+        # @param [Numeric] value value of this {Amount}.
+        # @param [Integer] base the base of a kilobyte.
+        def initialize(value, base=DEFAULT_KILO_BASE)
+          raise ArgumentError.new "Argument is not numeric: #{value}" unless value.is_a? Numeric
+          @value = value
+          @base = base
+        end
+
+        # The {Amount} in bytes
+        def bytes
+          @value * @base
+        end
+
+        # The {Amount} in kilobytes
+        def kilobytes
+          @value
+        end
+
+        # The {Amount} in megabytes
+        def megabytes
+          (kilobytes / @base.to_f).round(2)
+        end
+
+        # The {Amount} in gigabytes
+        def gigabytes
+          (megabytes / @base.to_f).round(2)
+        end
+
+      end
+
+      # Create a new {Amount} object.
+      # 
+      # @param [Numeric] value initial value of the {Amount}.
+      # @param [Integer] base the base of a kilobyte.
+      def Amount(value, base=DEFAULT_KILO_BASE)
+        Amount.new(value, base)
+      end
+    end
+  end
+end

data/lib/dovado/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dovado
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jan Lindblom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -133,10 +133,13 @@ files:
 - lib/dovado/router/info.rb
 - lib/dovado/router/info/operator.rb
 - lib/dovado/router/info/operator/telia.rb
+- lib/dovado/router/internet.rb
 - lib/dovado/router/services.rb
 - lib/dovado/router/sms.rb
 - lib/dovado/router/sms/message.rb
 - lib/dovado/router/sms/messages.rb
+- lib/dovado/router/traffic.rb
+- lib/dovado/router/traffic/amount.rb
 - lib/dovado/utilities.rb
 - lib/dovado/version.rb
 - ruby-dovado.gemspec