ruby-dovado 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00da334c3de14089a89e7dd33787879ca4f59440
-  data.tar.gz: b138d5e2a2ffa2b9075b9509535a138b466f8eb6
+  metadata.gz: b3d3a3bde16c3723672ddac0e2d50778259e9a20
+  data.tar.gz: e6fde4e985f7208770b782754c8d0fbe83f4028a
 SHA512:
-  metadata.gz: bacfb7aac3dcf237dc7d5a75286d94814a9d3618dfecc2a7e9852cc4be3a49608ed31b25376109a30df53b2eb837707be888dd94d2dc8f3f9af3b0c5ace5c71a
-  data.tar.gz: 5a2605658f78bf55b34a5cc55d94ad859e1d81f4a06e44118b4a47b0f957c440f40ecd28d0e302987c52f8a71f1fb81698a647b410ad27a4bd3dbc1e2faff168
+  metadata.gz: 3b98ebd1cddb85bf4d4128cb7b172a4f272dfa6abda5c7027469a73c5d19a0bce138740982d9454dcd42cf70b6bb13e8f3cb622987479163a2c894703cab4c22
+  data.tar.gz: b255461df8495cb18c79bb6972e64f9b1d6cc020f94d5015bfcc0d10969eefc684b3b97cca3fa04a48bc14f64ae3149c2e88726215c708af57b7067429137aa0

data/lib/dovado.rb

@@ -3,7 +3,7 @@ require 'celluloid/current'
 # The Ruby-Dovado library.
 # 
 # @author Jan Lindblom <janlindblom@fastmail.fm>
-# @version 1.0.3
+# @version 1.0.4a
 module Dovado
 end
 

data/lib/dovado/router.rb

@@ -40,20 +40,15 @@ module Dovado
     # @return [Services] The {Services} object
     # @see {Services}
     def services
-      supervise_services
+      Services.setup_supervision!
       client = Actor[:client]
       router_services = Actor[:router_services]
 
-      unless router_services.valid?
-        client.connect unless client.connected?
-        client.authenticate unless client.authenticated?
-        string = client.command('services')
-        router_services.create_from_string string
-      end
+      router_services.update! unless router_services.valid?
 
       if router_services[:sms] == 'enabled'
         
-        Sms.supervise as: :sms, size: 1 unless Actor[:sms]
+        Sms.setup_supervision!
         sms.enabled = true
       end
       router_services
@@ -69,7 +64,7 @@ module Dovado
     # @return [Internet] the Internet Connection object.
     # @see {Internet}
     def internet
-      Internet.supervise as: :internet, size: 1 unless Actor[:internet]
+      Internet.setup_supervision!
       Actor[:internet]
     end
 
@@ -78,7 +73,7 @@ module Dovado
     # @return [Traffic] the Data Traffic object
     # @see {Traffic}
     def traffic
-      Traffic.supervise as: :traffic, size: 1 unless Actor[:traffic]
+      Traffic.setup_supervision!
       Actor[:traffic]
     end
 
@@ -87,16 +82,11 @@ module Dovado
     # @return [Info] The {Info} object.
     # @see {Info}
     def info
-      supervise_info
-      router_info = Actor[:router_info]
+      Info.setup_supervision!
       client = Actor[:client]
       router_info = Actor[:router_info]
-      unless router_info.valid?
-        client.connect unless client.connected?
-        client.authenticate unless client.authenticated?
-        info = client.command('info')
-        router_info.create_from_string info
-      end
+      router_info.update! unless router_info.valid?
+
       services
       router_info
     rescue ConnectionError => ex
@@ -117,11 +107,6 @@ module Dovado
 
     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,
@@ -134,10 +119,5 @@ module Dovado
       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/router/info.rb

@@ -124,9 +124,22 @@ module Dovado
         end
       end
 
+      # Update the data in this {Info} object.
+      def update!
+        client = Actor[:client]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        info = client.command('info')
+        create_from_string info
+      rescue ConnectionError => ex
+        Actor[:client].terminate
+        raise ex
+      end
+
       # Create a new {Info} object from a +String+.
       # 
       # @param [String] data_string router information string from the router.
+      # @api private
       def create_from_string(data_string=nil)
         unless Actor[:sms]
           Sms.supervise as: :sms, size: 1
@@ -265,6 +278,12 @@ module Dovado
         omni_method
       end
 
+      # @api private
+      def self.setup_supervision!
+        return supervise as: :router_info, size: 1 unless Actor[:router_info]
+        return supervise as: :router_info, size: 1 if Actor[:router_info] and Actor[:router_info].dead?
+      end
+
       private
 
       def omni_method

data/lib/dovado/router/internet.rb

@@ -58,6 +58,10 @@ module Dovado
         @state[:status] = value
       end
 
+      def self.setup_supervision!
+        supervise as: :internet, size: 1 unless Actor[:internet]
+      end
+
     end
   end
 end

data/lib/dovado/router/services.rb

@@ -35,6 +35,15 @@ module Dovado
         end
       end
 
+      # Update the data in this {Services} object.
+      def update!
+        client = Actor[:client]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        string = client.command('services')
+        create_from_string string
+      end
+
       # Create a new {Services} object from a string with values from the router
       # API.
       # 
@@ -109,6 +118,12 @@ module Dovado
         home_automation ? (home_automation == "enabled") : false
       end
 
+      # @api private
+      def self.setup_supervision!
+        return supervise as: :router_services, size: 1 unless Actor[:router_services]
+        return supervise as: :router_services, size: 1 if Actor[:router_services] and Actor[:router_services].dead?
+      end
+
       private
 
       def touch!

data/lib/dovado/router/sms.rb

@@ -63,6 +63,7 @@ module Dovado
       # 
       # @param [String] data_string String with text message data from the
       # router.
+      # @api private
       def create_from_string(data_string=nil)
         data_array = data_string.split("\n")
         data_array.each do |data_entry|
@@ -92,6 +93,10 @@ module Dovado
         end
       end
 
+      def self.setup_supervision!
+        supervise as: :sms, size: 1 unless Actor[:sms]
+      end
+
     end
   end
 end

data/lib/dovado/router/sms/messages.rb

@@ -29,6 +29,10 @@ module Dovado
           @messages[id] unless id.nil?
         end
 
+        def [](id)
+          get_message(id)
+        end
+
         def ids
           @messages.keys
         end

data/lib/dovado/router/traffic.rb

@@ -4,22 +4,45 @@ module Dovado
   class Router
     # Traffic Counters.
     # 
+    # Returns the traffic counters from the router. The developer will have to
+    # check the return values to determine if there is traffic for multiple
+    # modems available, see {#up} and {#down}, this can be done by checking the
+    # type of the return value of these commands.
+    # 
+    # @example Single modem
+    #   single_modem_amount = @router.traffic.down
+    # 
+    # @example Two modems
+    #   first_modem_amount = @router.traffic.down.first
+    #   second_modem_amount = @router.traffic.down.last
+    # 
+    # @example Checking the return value to see if there are multiple modems
+    #   traffic_down = @router.traffic.down
+    #   if traffic_down.is_a? Dovado::Router::Traffic::Amount
+    #     return traffic_down.gigabytes
+    #   elsif traffic_down.is_a? Array
+    #     return traffic_down.first.gb + traffic_down.last.gb
+    #   end
+    # 
     # @since 1.0.3
     class Traffic
       include Celluloid
 
-      # Create a new {Internet} object.
+      # Create a new {Traffic} 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)
+        @data[:down] = Traffic::Amount.new
+        @data[:up] = Traffic::Amount.new
       end
 
       # Data upload traffic amount.
       # 
-      # @return [Amount] amount of uploaded data.
+      # If two modems are used, the returned value is an array with {Amount}
+      # objects.
+      # 
+      # @return [Amount, Array<Amount>] amount of uploaded data.
       def up
         update!
         @data[:up]
@@ -27,22 +50,39 @@ module Dovado
 
       # Data download traffic amount.
       # 
-      # @return [Amount] amount of downloaded data.
+      # If two modems are used, the returned value is an array with {Amount}
+      # objects.
+      # 
+      # @return [Amount, Array<Amount>] amount of downloaded data.
       def down
         update!
         @data[:down]
       end
 
-      # Update this {Traffic} object.
+      # Data download total traffic amount. Useful with multiple modems.
+      # 
+      # @return [Amount] total amount of downloaded data.
+      def down_total
+        up, down = update_total_traffic_from_router_info
+        Traffic::Amount.new down
+      end
+
+      # Data upload total traffic amount. Useful with multiple modems.
+      # 
+      # @return [Amount] total amount of uploaded data.
+      def up_total
+        up, down = update_total_traffic_from_router_info
+        Traffic::Amount.new up
+      end
+
+      # Update the data in this {Traffic} object.
       def update!
         unless valid?
           begin
-            up, down = fetch_from_router
+            fetch_from_router
           rescue
-            up, down = fetch_from_router_info
+            @data[:up], @data[:down] = fetch_from_router_info
           end
-          @data[:down] = Traffic::Amount.new(down)
-          @data[:up] = Traffic::Amount.new(up)
           touch!
         end
       end
@@ -55,6 +95,11 @@ module Dovado
         (@last_update + SecureRandom.random_number(9) + 1 <= Time.now.to_i)
       end
 
+      # @api private
+      def self.setup_supervision!
+        supervise as: :traffic, size: 1 unless Actor[:traffic]
+      end
+
       private
 
       def touch!
@@ -67,22 +112,59 @@ module Dovado
         client.connect unless client.connected?
         client.authenticate unless client.authenticated?
         string = client.command('traffic')
+        # Two Modems
+        multiple = string.match(/(\d+)\W(\d+)\W\/\W(\d+)\n(\d+)\W(\d+)\W\/\W(\d+)/)
+        # One Modem
         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
+        if multiple # Two modems found
+          if multiple[2]
+            down1 = Traffic::Amount.new matched[2].to_i
+            down1.sim_id = matched[1]
+          end
+          if multiple[3]
+            up1 = Traffic::Amount.new matched[3].to_i
+            up1.sim_id = matched[1]
+          end
+          if multiple[5]
+            down2 = Traffic::Amount.new matched[5].to_i
+            down2.sim_id = matched[4]
+          end
+          if multiple[6]
+            up2 = Traffic::Amount.new matched[6].to_i
+            up2.sim_id = matched[4]
+          end
+          @data[:up] = [up1, up2]
+          @data[:down] = [down1, down2]
+        elsif matched # only one modem found
+          if matched[2]
+            @data[:down] = Traffic::Amount.new matched[2].to_i
+            @data[:down].sim_id = matched[1]
+          end
+          if matched[3]
+            @data[:up] = Traffic::Amount.new matched[3].to_i
+            @data[:up].sim_id = matched[1]
+          end
+        else # Nothing found(?) return data from the Router::Info object
+          @data[:up], @data[:down] = fetch_from_router_info
         end
-        [up, down]
+        [@data[:up], @data[:down]]
       end
 
       def fetch_from_router_info
         up, down = [@data[:up], @data[:down]]
-        Info.supervise as: :router_info, size: 1 unless Actor[:router_info]
+        begin
+          up, down = update_total_traffic_from_router_info
+        rescue Exception
+        end
+        [up, down]
+      end
+
+      def update_total_traffic_from_router_info
+        Info.setup_supervision! 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
+        router_info.update! unless router_info.valid?
+        down = router_info.traffic_modem_rx
+        up = router_info.traffic_modem_tx
         [up, down]
       end
 

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

@@ -11,43 +11,70 @@ module Dovado
         # The default base of a kilobyte.
         DEFAULT_KILO_BASE = 1024
 
+        attr_accessor :sim_id
+
         # Create a new Amount object.
         # 
-        # @param [Numeric] value value of this {Amount}.
+        # Note: You can set the default base for a kilobyte in the router
+        # admin interface to +1000+ or +1024+, you should use the same base here
+        # to get the right figures. The base can differ from one operator to
+        # another.
+        # 
+        # @param [Numeric] value value of this {Amount}, defaults to +0+.
         # @param [Integer] base the base of a kilobyte.
-        def initialize(value, base=DEFAULT_KILO_BASE)
+        def initialize(value=0, 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
+        # The {Amount} in bytes.
         def bytes
           @value * @base
         end
 
-        # The {Amount} in kilobytes
+        # Shortcut to {#bytes}.
+        def b
+          bytes
+        end
+
+        # The {Amount} in kilobytes.
         def kilobytes
           @value
         end
 
-        # The {Amount} in megabytes
+        # Shortcut to {#kilobytes}.
+        def kb
+          kilobytes
+        end
+
+        # The {Amount} in megabytes.
         def megabytes
           (kilobytes / @base.to_f).round(2)
         end
 
-        # The {Amount} in gigabytes
+        # Shortcut to {#megabytes}.
+        def mb
+          megabytes
+        end
+
+        # The {Amount} in gigabytes.
         def gigabytes
           (megabytes / @base.to_f).round(2)
         end
 
+        # Shortcut to {#gigabytes}.
+        def gb
+          gigabytes
+        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)
+      def Amount(value=0, base=DEFAULT_KILO_BASE)
         Amount.new(value, base)
       end
     end

data/lib/dovado/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dovado
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jan Lindblom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid