vnstat-ruby 1.0.0

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+ - '1.9.3'
+ - '2.0.0'
+ - '2.1.7'
+ - '2.2.3'
+ - ruby-head
+ - jruby
+ - jruby-head
+ - rbx-2
+script: bundle exec rspec
+addons:
+  code_climate:
+    repo_token: 06a44082b0f5a5114eec226952c45443a4ac8c86e59e098869b5c07e420505ab

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'nokogiri'
+
+group :development do
+  gem 'rspec', '~> 3.0'
+  gem 'yard'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+  gem 'codeclimate-test-reporter', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.8)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile (0.6.2)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  codeclimate-test-reporter
+  jeweler (~> 2.0.1)
+  nokogiri
+  rspec (~> 3.0)
+  yard
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Tobias Casper
+
+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,81 @@
+# vnstat-ruby
+
+[![Code Climate](https://codeclimate.com/github/tlux/vnstat-ruby/badges/gpa.svg)](https://codeclimate.com/github/tlux/vnstat-ruby) [![Test Coverage](https://codeclimate.com/github/tlux/vnstat-ruby/badges/coverage.svg)](https://codeclimate.com/github/tlux/vnstat-ruby/coverage) [![Build Status](https://travis-ci.org/tlux/vnstat-ruby.svg?branch=master)](https://travis-ci.org/tlux/vnstat-ruby)
+
+Vnstat is a tool that tracks the traffic on your network interfaces.
+This tiny library dependends on the `vnstat` command line utility to provide
+network traffic information through an easy-to-use API.
+
+
+### Prerequisites
+
+You need one of the following Ruby versions installed to run the gem:
+
+* Ruby >= 1.9.3
+* JRuby
+* Rubinius >= 2
+
+Also make sure you have the vnstat CLI installed by running `which vnstat`.
+
+If the executable was not found, you are able to obtain the vnstat package
+via aptitude (or a similar package manager):
+
+```bash
+apt-get install vnstat
+```
+
+
+### Getting Started
+
+#### Setup
+
+Once the dependent package is installed, you are ready to install the
+vnstat-ruby gem.
+
+```bash
+gem install vnstat-ruby
+```
+
+Or, add the following line to the Gemfile of your project and run the
+`bundle install` command:
+
+```ruby
+gem 'vnstat-ruby'
+```
+
+#### Configuration
+
+By default, vnstat-ruby tries to automatically determine the location of your
+vnstat executable. If you need to change this path for some reason, you can
+override the default:
+
+```ruby
+Vnstat.configure do |config|
+  config.executable_path = '/usr/bin/vnstat'
+end
+```
+
+### Usage
+
+TODO
+
+
+### Contributing to vnstat-ruby
+
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
+
+### Copyright
+
+Copyright (c) 2015 Tobias Casper. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'vnstat-ruby'
+  gem.homepage = 'http://github.com/tlux/vnstat-ruby'
+  gem.license = 'MIT'
+  gem.summary = 'A Ruby wrapper for vnstat'
+  gem.description = gem.summary
+  gem.email = 'tobias.casper@gmail.com'
+  gem.authors = ['Tobias Casper']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/vnstat-ruby.rb

@@ -0,0 +1 @@
+require 'vnstat'

data/lib/vnstat.rb

@@ -0,0 +1,65 @@
+require 'date'
+require 'nokogiri'
+
+##
+# The Vnstat namespace.
+module Vnstat
+  autoload :Configuration, 'vnstat/configuration'
+  autoload :Document, 'vnstat/document'
+  autoload :Interface, 'vnstat/interface'
+  autoload :InterfaceCollection, 'vnstat/interface_collection'
+  autoload :Parser, 'vnstat/parser'
+  autoload :Result, 'vnstat/result'
+  autoload :SystemCall, 'vnstat/system_call'
+  autoload :Traffic, 'vnstat/traffic'
+  autoload :Utils, 'vnstat/utils'
+
+  autoload :Error, 'vnstat/error'
+  autoload :ExecutableNotFound, 'vnstat/errors/executable_not_found'
+  autoload :UnknownInterface, 'vnstat/errors/unknown_interface'
+
+  module_function
+
+  ##
+  # The configuration of the Vnstat environment.
+  #
+  # @return [Configuration]
+  def config
+    @config ||= Configuration.new
+  end
+
+  ##
+  # Configures the Vnstat environment.
+  #
+  # @yieldparam [Configuration] config The environment configuration.
+  # @return [Configuration]
+  def configure
+    yield(config)
+    config
+  end
+
+  ##
+  # Returns traffic information for the given interface.
+  #
+  # @param [String] id The network interface identifier.
+  # @return [Interface]
+  def [](id)
+    interfaces[id]
+  end
+
+  ##
+  # Returns traffic information for all known interfaces.
+  #
+  # @return [InterfaceCollection]
+  def interfaces
+    InterfaceCollection.open
+  end
+
+  ##
+  # Returns information for the currently installed version of vnstat.
+  #
+  # @return [String]
+  def version
+    Utils.call_executable('-v')
+  end
+end

data/lib/vnstat/configuration.rb

@@ -0,0 +1,35 @@
+module Vnstat
+  ##
+  # A class encapsulating configurations of the Vnstat environment.
+  #
+  # @attr_writer [String] executable_path Sets the location of the vnstat
+  #   executable.
+  class Configuration
+    ##
+    # Initializes the {Configuration}.
+    def initialize
+      reset
+    end
+
+    ##
+    # Restores the configuration defaults.
+    #
+    # @return [Configuration]
+    def reset
+      @executable_path = nil
+      self
+    end
+
+    ##
+    # Returns the location of the vnstat executable.
+    #
+    # @return [String]
+    def executable_path
+      @executable_path ||= Utils.system_call('which', 'vnstat') do
+        fail ExecutableNotFound, 'Unable to locate vnstat executable'
+      end
+    end
+
+    attr_writer :executable_path
+  end
+end

data/lib/vnstat/document.rb

@@ -0,0 +1,56 @@
+module Vnstat
+  # A class encapsulating document data.
+  #
+  # @attr_reader [Nokogiri::XML::Document] data The underlying XML document.
+  class Document
+    ##
+    # Initializes the document.
+    #
+    # @param [String] data The raw XML data.
+    def initialize(data)
+      self.data = data
+    end
+
+    ##
+    # @return [Document]
+    def self.open(*args)
+      new(*args, load_data(*args))
+    end
+
+    ##
+    # A hook used by {.open} that is intended to be overridden by subclasses.
+    #
+    # @raise [NotImplementedError]
+    def self.load_data(*args)
+      fail NotImplementedError, "Please override #{name}.#{__method__}"
+    end
+
+    attr_reader :data
+
+    ##
+    # Sets the raw XML data for the {Document}.
+    #
+    # @param [String] data A string representing the document.
+    # @raise [ArgumentError] Raised if the specified data was nil.
+    def data=(data)
+      fail ArgumentError, 'No document data specified' if data.nil?
+      @data = Nokogiri::XML.parse(data.to_s)
+    end
+
+    ##
+    # Returns the version as specified in the vnstat element.
+    #
+    # @return [String]
+    def version
+      data.xpath('vnstat').attr('version').text
+    end
+
+    ##
+    # Returns the XML version as specified in the vnstat element.
+    #
+    # @return [String]
+    def xml_version
+      data.xpath('vnstat').attr('xmlversion').text
+    end
+  end
+end

data/lib/vnstat/error.rb

@@ -0,0 +1,6 @@
+module Vnstat
+  ##
+  # An exception that hints at a generic error with vnstat.
+  class Error < StandardError
+  end
+end

data/lib/vnstat/errors/executable_not_found.rb

@@ -0,0 +1,7 @@
+module Vnstat
+  ##
+  # An exception that is raised when the vnstat CLI could not be found on the
+  # machine.
+  class ExecutableNotFound < Error
+  end
+end

data/lib/vnstat/errors/unknown_interface.rb

@@ -0,0 +1,12 @@
+module Vnstat
+  #
+  # An exception that is raised when the specified interface could not be found
+  # among the known ones.
+  class UnknownInterface < Error
+    attr_reader :interface_id
+
+    def initialize(interface_id)
+      @interface_id = interface_id
+    end
+  end
+end