ruby-dovado 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 493334755f4182fb4c6ffbf010747a6212f48352
+  data.tar.gz: 67798f1509b7ad86e95dd321a92267a0fd8a80f4
+SHA512:
+  metadata.gz: 9ffe73cdf1b1a4b89f85c006d7597ad0fb0410614fc542c3bce3dfb62a917b031194a955be6aa26f2c06fb63bbc78762732f3c6e160f9aa072b0bd0f71b80dfd
+  data.tar.gz: bbf0eed5cd3ee58b89cc52642eb1b7d6a7a35eaf9158d1587cf09f1e0b9bcfcd0f1239505963cd830e9c971b3de48fa2548c95ec559cfffbe0a3025be4c31d9b

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jan Lindblom
+
+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,60 @@
+# Ruby-Dovado
+
+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)
+
+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.
+
+## 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/).
+
+## Usage
+
+Add it to your Gemfile:
+
+```ruby
+gem "ruby-dovado"
+```
+
+They load it in your code:
+
+```ruby
+require "dovado"
+
+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
+```
+
+## 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.
+
+Additionally, all replies are cached internally to limit the number of calls to the router API. This is done because the API is rather slow which would make any calls using this library wait for several seconds for a reply. These replies are cached inside Celluloid actors so that multiple, seemingly parallel requests will get the same response object. Caching can be overridden by forcing the call through to the router. Otherwise, the reply becomes invalid within a couple of seconds so that the next call will go through to the router and fetch any updates. Think of it as a cheap rate-limiter.
+
+## Copyright
+
+Ruby-Dovado © 2015 by [Jan Lindblom](mailto:janlindblom@fastmail.fm).
+Ruby-Dovado is licensed under the MIT license. Please see the
+{file:LICENSE.txt} file for more information.
+
+The Dovado, Dovado Tiny, Dovado Go, Dovado Tiny AC et.al brands are © 2004 - 2015 Dovado FZ-LLC.
+
+This library is neither endorsed nor supported by Dovado.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://bitbucket.org/janlindblom/ruby-dovado/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,30 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require "yard"
+require "yard/rake/yardoc_task"
+require "rspec/core/rake_task"
+
+desc "Run RSpec code examples"
+namespace :spec do
+  desc "Run offline RSpec code examples"
+  RSpec::Core::RakeTask.new(:offline) do |t|
+    t.rspec_opts = "--tag offline"
+  end
+
+  desc "Run online RSpec code examples"
+  RSpec::Core::RakeTask.new(:online) do |t|
+    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
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.stats_options = ['--list-undoc']
+end
+
+task :default => "spec:offline"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/dovado.rb

@@ -0,0 +1,22 @@
+require 'celluloid/current'
+
+require 'dovado/connection_error'
+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/sms'
+require 'dovado/router/sms/messages'
+require 'dovado/router/sms/message'
+
+# The Ruby-Dovado library.
+# 
+# @author Jan Lindblom <janlindblom@fastmail.fm>
+# @version 1.0.0
+module Dovado
+end

data/lib/dovado/client.rb

@@ -0,0 +1,154 @@
+require 'net/telnet'
+
+module Dovado
+  # Internal API client.
+  # 
+  # @api private
+  # @since 1.0.0
+  class Client
+    include Celluloid
+
+    # Create a new {Client} object.
+    # 
+    # The default options are:
+    # - Address: 192.168.0.1
+    # - Port: 6435
+    # - User: admin
+    # - Password: password
+    # 
+    # @param [Hash] args option arguments.
+    # @option args [String] :server The server (router) address.
+    # @option args [Integer] :port The server (router) port.
+    # @option args [String] :user The user name.
+    # @option args [String] :password The user password.
+    def initialize(args=nil)
+      # Defaults
+      @address  = '192.168.0.1'
+      @user     = 'admin'
+      @password = 'password'
+      @port     = 6435
+      unless args.nil?
+        @address  = args[:server]   if args.has_key? :server
+        @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
+    end
+
+    # Run a command on the router.
+    # 
+    # @param [String] text the command to run.
+    # @raise [ConnectionError] if there is an error in the communication with
+    #   the router.
+    def command(text=nil)
+      perform_command text
+    rescue IOError
+      disconnect
+      connect unless connected?
+      authenticate unless authenticated?
+      perform_command text
+    rescue Net::ReadTimeout => ex
+      disconnect
+      connect unless connected?
+      authenticate unless authenticated?
+      perform_command text
+      #raise ConnectionError.new "Error connecting to router: #{ex.message}"
+    end
+
+    # Connect to the router.
+    # @raise [ConnectionError] if there is an error in the communication with
+    #   the router.
+    def connect
+      if @server.nil?
+        @server = Net::Telnet.new(
+          'Host' => @address,
+          'Port' => @port,
+          'Telnetmode' => false,
+          'Prompt' => />>\s/)
+      end
+    rescue IOError
+      disconnect
+      raise ConnectionError.new "Error connecting to router: #{ex.message}"
+    rescue Net::ReadTimeout => ex
+      disconnect
+      raise ConnectionError.new "Error connecting to router: #{ex.message}"
+    end
+
+    # Disconnect from the router.
+    def disconnect
+      unless @server.nil?
+        @server.cmd "quit"
+        @server.close
+      end
+      @authenticated = false
+      @server = nil
+    end
+
+    # Check if we are connected to the router.
+    # 
+    # @return [Boolean] +true+ or +false+.
+    def connected?
+      unless @server.nil?
+        true
+      else
+        false
+      end
+    end
+
+    # Authenticate user.
+    # 
+    # @todo Verify authentication properly.
+    # @raise [ConnectionError] if there is an error in the communication with
+    #   the router.
+    def authenticate
+      perform_authentication
+    rescue IOError
+      disconnect
+      connect unless connected?
+      perform_authentication
+    rescue Net::ReadTimeout => ex
+      disconnect
+      connect unless connected?
+      perform_authentication
+      #raise ConnectionError.new "Error connecting to router: #{ex.message}"
+    end
+
+    # Check if we're authenticated.
+    # 
+    # @return [Boolean] +true+ or +false+.
+    def authenticated?
+      @authenticated
+    end
+
+    private
+
+    def perform_command(text)
+      unless text.nil?
+        res = @server.puts(text)
+        res = @server.waitfor(/>>\s/)
+        res
+      end
+    end
+
+    def perform_authentication
+      if connected?
+        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}"
+        
+          # TODO: verify authentication for real.
+          @authenticated = true
+        else
+          @authenticated = false
+        end
+      else
+        @authenticated = false
+      end
+    end
+
+  end
+end

data/lib/dovado/connection_error.rb

@@ -0,0 +1,5 @@
+# Custom error for failed connections.
+# 
+# @since 1.0.0
+class Dovado::ConnectionError < StandardError
+end

data/lib/dovado/router.rb

@@ -0,0 +1,96 @@
+module Dovado
+  # A Dovado Router.
+  # 
+  # @since 1.0.0
+  class Router
+    include Celluloid
+
+    # Create a new {Router} object representing an actual Dovado router on the local
+    # network.
+    # 
+    # The default router options are:
+    # - Address: 192.168.0.1
+    # - Port: 6435
+    # - User: admin
+    # - Password: password
+    # 
+    # @param [Hash] args optional arguments.
+    # @option args [String] :address IP address or DNS name
+    # @option args [Integer] :port Port which the router is listening on
+    # @option args [String] :user User name
+    # @option args [String] :password Password
+    def initialize(args=nil)
+      @address    = '192.168.0.1' # Default address
+      @port       = 6435
+      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?
+      end
+
+      Client.supervise as: :client, size: 1, args: [{
+        server:     @address,
+        port:       @port,
+        user:       user,
+        password:   password
+      }]
+    end
+
+    # Fetch services information from the router.
+    # 
+    # @return [Services] The {Services} object
+    # @see {Services}
+    def services
+      Services.supervise as: :router_services, size: 1 unless Actor[:router_services]
+      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
+
+      if router_services[:sms] == 'enabled'
+        
+        Sms.supervise as: :sms, size: 1 unless Actor[:sms]
+        sms.enabled = true
+      end
+      router_services
+    end
+
+    # Fetch information from the router.
+    # 
+    # @return [Info] The {Info} object.
+    # @see {Info}
+    def info
+      Info.supervise as: :router_info, size: 1 unless Actor[:router_info]
+      router_info = Actor[:router_info]
+      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
+      services
+      router_info
+    end
+
+    # Fetch text messages from the router.
+    # 
+    # @return [Sms] The {Sms} object.
+    # @see {Sms}
+    def sms
+      Sms.supervise as: :sms, size: 1 unless Actor[:sms]
+      Actor[:sms]
+    end
+
+  end
+end

data/lib/dovado/router/info.rb

@@ -0,0 +1,98 @@
+require 'date'
+require 'time'
+require 'socket'
+require 'thread_safe'
+
+module Dovado
+  class Router
+    # Router information.
+    # 
+    # @since 1.0.0
+    class Info
+      include Celluloid
+
+      # Create a new {Info} object.
+      # 
+      # @param [Hash] args optional hash to initialize with.
+      def initialize(args=nil)
+        # Defaults
+        @data = ThreadSafe::Cache.new
+
+        @last_update = nil
+        unless args.nil?
+          @data = args
+        end
+      end
+
+      # Create a new {Info} object from a +String+.
+      # 
+      # @param [String] data_string router information string from the router.
+      def create_from_string(data_string=nil)
+        unless Actor[:sms]
+          Sms.supervise as: :sms, size: 1
+        end
+        sms = Actor[:sms]
+        data_array = data_string.split("\n")
+        data_array.each do |data_entry|
+          entry_array = data_entry.split('=')
+          if entry_array.length == 2
+            key = entry_array[0].downcase
+            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 'date'
+              @data[:date] = Date.parse(val)
+            when 'sms_unread'
+              @data[:sms] = sms if @data[:sms].nil?
+              @data[:sms].unread = val.to_i
+            when 'sms_total'
+              @data[:sms] = sms if @data[:sms].nil?
+              @data[:sms].total = val.to_i
+            when 'connected_devices'
+              val = val.split(',')
+              @data[keysym] = val
+            else
+              @data[keysym] = val
+            end
+          end
+        end
+        touch!
+      end
+
+      # Determine if this info 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
+
+      # Fetch an entry from the {Info} object.
+      # 
+      # @param [Symbol] key The key to fetch.
+      def [](key)
+        @data[key]
+      end
+
+      # Fetch the list of entries in the {Info} object.
+      # 
+      # @return [Array<Symbol>]
+      def keys
+        @data.keys
+      end
+
+      private
+
+      def touch!
+        @last_update = Time.now.to_i
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module Dovado
+  class Router
+    class Info
+      # An ISP/operator.
+      # 
+      # Extend this class to create a new operator or use it as it is.
+      # 
+      # @example Extending the Operator class
+      #   class MyOperator < Dovado::Router::Info::Operator
+      #     def initialize
+      #       super(name: "MyOperator", number: "s1234", commands: {data_remaining: "quota"})
+      #     end
+      #   end
+      # 
+      # @example Using the Operator class as it is
+      #   my_operator = Dovado::Router::Info::Operator.new(name: "MyOperator", number: "s1234", commands: {data_remaining: "quota"})
+      # 
+      # @since 1.0.0
+      class Operator
+        include Celluloid
+
+        # Number to send messages to for the operator.
+        # @return [String]
+        attr_accessor :number
+        # Name of the operator.
+        # @return [String]
+        attr_accessor :name
+        # List of commands supported by the operator.
+        # @return [Hash]
+        attr_accessor :commands
+        
+        # Create a new Operator object.
+        # 
+        # @example Initializing with custom commands
+        #   my_commands = { data_remaining: "datamängd".encode("UTF-8") }
+        #   my_operator = Operator.new(name: "MyOperator", number: "s1234", commands: my_commands)
+        # 
+        # @param [Hash] args optional arguments
+        # @option args [String] :number The recipient number for this operator.
+        #   Use the prefix +s+ to indicate a "short" number, e.g "s4466".
+        # @option args [String] :name Name of the operator.
+        # @option args [Hash] :commands Supported commands.
+        def initialize(args=nil)
+          self.name = "Unknown"
+          unless args.nil?
+            @number = ""
+            @name = "NoOperator"
+            @commands = Operator.default_commands
+            @number =   args[:number]   unless args[:number].nil?
+            @name =     args[:name]     unless args[:name].nil?
+            unless args[:commands].nil?
+              missing_keys = []
+              Operator.required_commands.each do |req|
+                missing_keys << req unless args[:commands].has_key?(req)
+              end
+              raise ArgumentError.new "Missing required keys in hash: #{Utilities.array_to_sentence(missing_keys)}" unless missing_keys.empty?
+              @commands = args[:commands]
+            end
+          end
+        end
+
+        # Default commands for an operator.
+        def self.default_commands
+          commands = {}
+          required_commands.each do |command|
+            commands[command] = ""
+          end
+          commands
+        end
+
+        private
+
+        def self.required_commands
+          [
+            :data_remaining
+          ]
+        end
+
+      end
+    end
+  end
+end

data/lib/dovado/router/info/operator/telia.rb

@@ -0,0 +1,23 @@
+require "thread_safe"
+
+module Dovado
+  class Router
+    class Info
+      class Operator
+        # The Swedish operator Telia.
+        # 
+        # @since 1.0.0
+        class Telia < Operator
+        
+          # Create a new Telia Operator object.
+          def initialize
+            super(name: "Telia", number: "s4466", commands: {
+              data_remaining: 'datamängd'.encode('UTF-8')
+              })
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/dovado/router/services.rb

@@ -0,0 +1,76 @@
+require "time"
+require "thread_safe"
+
+module Dovado
+  class Router
+    # Router Services.
+    # 
+    # @since 1.0.0
+    class Services
+      include Celluloid
+
+      # Create a new {Services} object.
+      # 
+      # @param [Hash] args optional argiments
+      def initialize(args=nil)
+        @list = ThreadSafe::Cache.new
+        @last_update = nil
+        unless args.nil?
+          args.each do |k,v|
+            @list[Utilities.name_to_sym(k)] = v
+          end
+          touch!
+        end
+      end
+
+      # Create a new {Services} object from a string with values from the router
+      # API.
+      # 
+      # @param [String] data_string +String+ with data from fetched from the
+      #   router.
+      # @return [Services] a new {Services} object.
+      def create_from_string(data_string=nil)
+        data_array = data_string.split("\n")
+        data_array.each do |data_entry|
+          entry_array = data_entry.split('=')
+          if entry_array.length == 2
+            key = entry_array[0].downcase
+            val = entry_array[1]
+            keysym = Utilities.name_to_sym(key)
+            @list[keysym] = val
+          end
+        end
+        touch!
+      end
+
+      # Fetch an entry from the {Services} object.
+      # 
+      # @param [Symbol] key The key to fetch.
+      def [](key)
+        @list[key]
+      end
+
+      # Fetch the list of entries in the {Services} object.
+      # 
+      # @return [Array<Symbol>]
+      def keys
+        @list.keys
+      end
+
+      # Checks if this {Services} object is still 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
+
+    end
+  end
+end

data/lib/dovado/router/sms.rb

@@ -0,0 +1,97 @@
+module Dovado
+  class Router
+    # Text messages.
+    # 
+    # @since 1.0.0
+    class Sms
+      include Celluloid
+
+      # Unread messages.
+      # @return [Integer] number of unread
+      attr_accessor :unread
+      # Total number of messages.
+      # @return [Integer] total number of messages
+      attr_accessor :total
+      # Is the SMS handler enabled?
+      # @return [Boolean] +true+ or +false+
+      attr_accessor :enabled
+      # Message Id's.
+      # @return [Array] list of message Id's
+      attr_accessor :ids
+
+      # Create a new {Sms} object.
+      # 
+      # @param [Hash] args optional arguments.
+      # @option args [Integer] :unread number of unread messages
+      # @option args [Integer] :total total number of messages
+      def initialize(args=nil)
+        Messages.supervise as: :messages, size: 1
+        messages = Actor[:messages]
+        @enabled = false
+        @ids = ThreadSafe::Array.new
+        unless args.nil?
+          @unread = args[:unread] unless args[:unread].nil?
+          @total = args[:total] unless args[:total].nil?
+        end
+        client = Actor[:client]
+        create_from_string(client.command('sms list'))
+      end
+
+      # Text messages.
+      # 
+      # @return [Sms::Messages]
+      def messages
+        Actor[:messages]
+      end
+
+      # Number of read messages.
+      # 
+      # @return [Integer] the number of read messages.
+      def read
+        (@total - @unread)
+      end
+
+      # Assign number of read messages.
+      # 
+      # @param [Integer] read Number of read messages.
+      def read=(read=nil)
+        @unread = (@total - read) unless read.nil?
+      end
+
+      # Create a new {Sms} object from a +String+ with data fetched from the
+      # router.
+      # 
+      # @param [String] data_string String with text message data from the
+      # router.
+      def create_from_string(data_string=nil)
+        data_array = data_string.split("\n")
+        data_array.each do |data_entry|
+          entry_array = data_entry.split(':')
+          if entry_array.length == 2
+            key = entry_array[0].downcase
+            val = entry_array[1]
+            if key.downcase.tr(' ', '_') == 'stored_ids'
+              idlist = val.split(' ')
+              idlist.each do |id|
+                @ids << id
+              end
+            end
+          end
+        end
+        @ids.map! { |id| id.to_i }.sort!
+      end
+
+      # Load text messages.
+      def load_messages
+        client = Actor[:client]
+        messages = Actor[:messages]
+        client.connect unless client.connected?
+        client.authenticate unless client.authenticated?
+        @ids.each do |id|
+          messages.add_message Message.from_string(client.command("sms recvtxt #{id}"))
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require 'date'
+
+module Dovado
+  class Router
+    class Sms
+      # A text message (SMS).
+      # 
+      # @since 1.0.0
+      class Message
+        include Celluloid
+
+        # Message Id.
+        # @return [String,Integer,Symbol]
+        attr_reader :id
+        # Message body.
+        # @return [String]
+        attr_reader :body
+        # Message PDU's.
+        # @return [Array]
+        attr_reader :pdus
+        # Message sender.
+        # @return [String]
+        attr_reader :from
+        # Message send timestamp.
+        # @return [DateTime]
+        attr_reader :sent
+        # Message text encoding.
+        # @return [Encoding]
+        attr_reader :encoding
+
+        # Create a new {Message} object.
+        # 
+        # @param [Hash] args arguments.
+        # @option args [Integer,String,Symbol] :id Message Id.
+        # @option args [String] :body Message body.
+        # @option args [Array] :pdus Message PDU's.
+        # @option args [String] :from Message sender.
+        # @option args [DateTime] :sent Message send timestamp.
+        # @option args [Encoding] :encoding Message text encoding.
+        def initialize(args=nil)
+          unless args.nil?
+            @id = args[:id] unless args[:id].nil?
+            @body = args[:body] unless args[:body].nil?
+            @pdus = args[:pdus] unless args[:pdus].nil?
+            @from = args[:from] unless args[:from].nil?
+            @sent = args[:sent] unless args[:sent].nil?
+            @encoding = args[:encoding] unless args[:encoding].nil?
+          end
+        end
+
+        # Create a new {Message} object from a +String+.
+        # 
+        # @param [String] string message data to create object from.
+        # @return [Message] a new {Message} object.
+        def self.from_string(string=nil)
+          hash = ThreadSafe::Cache.new
+          message_body = ""
+          array = string.split("\n")
+          array.each do |row|
+            row_array = row.split(':')
+            if row_array.length == 2
+              key = row_array[0].downcase
+              val = row_array[1]
+              case key.strip
+              when 'from'
+                hash[:from] = val.strip
+              when 'alphabet'
+                begin
+                  hash[:encoding] = Encoding.find(val.strip)
+                rescue ArgumentError
+                  hash[:encoding] = Encoding::UTF_8
+                end
+              when 'id'
+                hash[:id] = val.strip.to_i
+              end
+            elsif row_array.length > 2
+              sent = row.match(/[Ss]ent\:\W(.*)/)
+              hash[:sent] = DateTime.parse(sent[1].strip)
+            else
+              unless row.downcase =~ /end of sms/
+                message_body += "#{row}\n"
+              end
+            end
+          end
+          hash[:body] = message_body.tr(">>", "").tr("\x17", "").strip.force_encoding(hash[:encoding])
+    
+          Message.new(hash)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'thread_safe'
+
+module Dovado
+  class Router
+    class Sms
+      # Text messages.
+      # 
+      # @since 1.0.0
+      class Messages
+        include Celluloid
+
+        # Create a new {Messages} object.
+        def initialize
+          @messages = ThreadSafe::Cache.new
+        end
+
+        # Add a message to the local cache.
+        # @param [Message] message
+        def add_message(message)
+          @messages[message.id] = message unless message.nil?
+        end
+
+        # Fetch a {Message} from the cache.
+        # 
+        # @param [String,Integer,Symbol] id Id of the message.
+        # @return [Message] message object.
+        # @see {Message}
+        def get_message(id)
+          @messages[id] unless id.nil?
+        end
+
+        def ids
+          @messages.keys
+        end
+
+      end
+    end
+  end
+end

data/lib/dovado/utilities.rb

@@ -0,0 +1,41 @@
+module Dovado
+  # Library utilities.
+  # 
+  # @api private
+  # @since 1.0.0
+  class Utilities
+    include Celluloid
+    
+    # Convert a key name to symbol.
+    # 
+    # @param name [String] the key name to convert.
+    # @return [Symbol] the key name converted to a symbol.
+    def self.name_to_sym(name=nil)
+      name.downcase.tr(' ', '_').to_sym
+    end
+
+    # Build a sentence from an array.
+    # 
+    # Ported from ActiveSupport:
+    # - File activesupport/lib/active_support/core_ext/array/conversions.rb, line 59
+    # 
+    # @param [Array] ary the +Array+ to make a sentence of.
+    # @param [Hash] options optional settings.
+    # @option options [String] :words_connector
+    # @option options [String] :two_words_connector
+    # @option options [String] :last_word_connector
+    def self.array_to_sentence(ary, options = {:words_connector     => ', ', :two_words_connector => ' and ', :last_word_connector => ' and '})
+      case ary.length
+      when 0
+        ''
+      when 1
+        ary[0].to_s.dup
+      when 2
+        "#{ary[0]}#{options[:two_words_connector]}#{ary[1]}"
+      else
+        "#{ary[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{ary[-1]}"
+      end
+    end
+
+  end
+end

data/lib/dovado/version.rb

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

data/ruby-dovado.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dovado/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-dovado"
+  spec.version       = Dovado::VERSION
+  spec.authors       = ["Jan Lindblom"]
+  spec.email         = ["janlindblom@fastmail.fm"]
+
+  spec.summary       = %q{Dovado Router API for Ruby.}
+  spec.homepage      = "https://bitbucket.org/janlindblom/ruby-dovado"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "celluloid", "~> 0.17"
+  spec.add_runtime_dependency "thread_safe", "~> 0.3"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: ruby-dovado
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Lindblom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- janlindblom@fastmail.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/dovado.rb
+- lib/dovado/client.rb
+- lib/dovado/connection_error.rb
+- lib/dovado/router.rb
+- lib/dovado/router/info.rb
+- lib/dovado/router/info/operator.rb
+- lib/dovado/router/info/operator/telia.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/utilities.rb
+- lib/dovado/version.rb
+- ruby-dovado.gemspec
+homepage: https://bitbucket.org/janlindblom/ruby-dovado
+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: Dovado Router API for Ruby.
+test_files: []
+has_rdoc: