vnstat-ruby 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '09d872127c5d9034c7a218a15337d658e921bd2a'
-  data.tar.gz: 5016a6c59ca8e17b23d24da2f678c9de07088b2b
+SHA256:
+  metadata.gz: 1147fd1dc7aa2c9d3990b48e410a1a2f68e8ecd3e5dfc390116131f703050624
+  data.tar.gz: 5804a8055fc72e8f5dd9fefe888072524ebd8ee842fa26194b45130106dbc170
 SHA512:
-  metadata.gz: ddb82f9aa3612a655f0de2960e1d9d165e5abdb7cff76d4b48de780e29e09a4ecca03c6eb5cf06de060db30a6eaa1166d7931c52c79a8618abd25321eeb383df
-  data.tar.gz: e90d226876389a9f23251279ffd632cd7840d735012de903eb065987dfc8ce57f9b6716321bbb89cc4d838971a8def23e2055908b51f35cd05596d9bfa7e8d5e
+  metadata.gz: 9e2be0b328f5b8df0dea239b8c2554d812afc439c89798844fe80dc2edf4fb5f1841ffd1036c3470763fca10a2cc21d90a816043030e89bd250edf3151f3ccb6
+  data.tar.gz: b163535f90d28910ec626e7d3e997c426addb363dfa50b242f5d0a384b0e9b92ceeeadc000a3d4a1d3af52934125b0ecaab6b6409b7b088448c0f810713f1861

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.ruby-gemset

@@ -0,0 +1 @@
+vnstat-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -1,10 +1,12 @@
+sudo: false
 language: ruby
 rvm:
- - '2.0.0'
- - '2.1.7'
- - '2.2.3'
- - '2.3.1'
- - '2.4.1'
+ - '2.1.10'
+ - '2.2.8'
+ - '2.3.6'
+ - '2.4.3'
+ - '2.5.0'
+before_install: gem install bundler -v 1.14.6
 script: bundle exec rspec
 addons:
   code_climate:

data/Gemfile

@@ -1,12 +1,6 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
 
-gem 'nokogiri', '~> 1.6'
+source 'https://rubygems.org'
 
-group :development do
-  gem 'bundler', '~> 1.0'
-  gem 'codeclimate-test-reporter', '0.6.0', require: false
-  gem 'jeweler', '~> 2.0', '>= 2.0.1'
-  gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0'
-  gem 'yard', '~> 0'
-end
+# Specify your gem's dependencies in vnstat-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -1,62 +1,23 @@
+PATH
+  remote: .
+  specs:
+    vnstat-ruby (2.0.0)
+      nokogiri (~> 1.8)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
-    ast (2.3.0)
-    builder (3.2.3)
-    codeclimate-test-reporter (0.6.0)
-      simplecov (>= 0.7.1, < 1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    ast (2.4.0)
     diff-lcs (1.2.5)
-    docile (1.1.5)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.11.3)
-      addressable (~> 2.3)
-      descendants_tracker (~> 0.0.1)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 1.2)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.0)
-      oauth2
-    hashie (3.5.5)
-    highline (1.7.8)
-    jeweler (2.1.2)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api (~> 0.11.0)
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    json (2.1.0)
-    jwt (1.5.6)
-    mini_portile2 (2.1.0)
-    multi_json (1.12.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    oauth2 (1.3.1)
-      faraday (>= 0.8, < 0.12)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.0.4)
+      ast (~> 2.4.0)
     powerpack (0.1.1)
-    public_suffix (2.0.5)
-    rack (1.6.5)
-    rainbow (2.2.2)
-      rake
-    rake (12.0.0)
-    rdoc (5.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -70,34 +31,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    rubocop (0.48.1)
-      parser (>= 2.3.3.1, < 3.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.1)
-    semver (1.0.1)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.6)
-    unicode-display_width (1.2.1)
-    yard (0.9.9)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0)
-  codeclimate-test-reporter (= 0.6.0)
-  jeweler (~> 2.0, >= 2.0.1)
-  nokogiri (~> 1.6)
+  bundler (~> 1.14)
+  rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0)
-  yard (~> 0)
+  rubocop (~> 0.53)
+  vnstat-ruby!
+  yard (~> 0.9.12)
 
 BUNDLED WITH
-   1.14.6
+   1.16.1

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2015 Tobias Casper
+The MIT License (MIT)
 
-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:
+Copyright (c) 2018 Tobias Casper
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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

@@ -1,7 +1,5 @@
 # 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)
 [![Gem Version](https://badge.fury.io/rb/vnstat-ruby.svg)](https://badge.fury.io/rb/vnstat-ruby)
 
@@ -15,7 +13,7 @@ maintained by Teemu Toivola.
 
 ### Prerequisites
 
-* Ruby 2.0.0 or greater
+* Ruby 2.1.0 or greater
 * Make sure you have `vnstat` CLI installed by running `which vnstat`.
 
 On Ubuntu you can get the vnstat package via `apt-get install vnstat`.

data/Rakefile

@@ -1,27 +1,6 @@
-# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-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'
+RSpec::Core::RakeTask.new(:spec)
 
-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 = 'Uses the the vnstat CLI to track your network traffic.'
-  gem.email = 'tobias.casper@gmail.com'
-  gem.authors = ['Tobias Casper']
-  # dependencies defined in Gemfile
-end
-
-Jeweler::RubygemsDotOrgTasks.new
+task default: :spec

data/lib/vnstat-ruby.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'vnstat'

data/lib/vnstat.rb

@@ -1,5 +1,9 @@
-require 'date'
-require 'nokogiri'
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rubygems'
+require 'vnstat/version'
+require 'time'
 
 ##
 # The Vnstat namespace.
@@ -58,8 +62,19 @@ module Vnstat
   ##
   # Returns information for the currently installed version of vnstat.
   #
+  # @deprecated Please use {#cli_version} instead.
   # @return [String]
   def version
+    warn '[DEPRECATION] `Vnstat.version` is deprecated. Please use ' \
+         '`Vnstat.cli_version` instead.'
+    cli_version
+  end
+
+  ##
+  # Returns information for the currently installed version of vnstat.
+  #
+  # @return [String]
+  def cli_version
     Utils.call_executable('-v')
   end
 end

data/lib/vnstat/configuration.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A class encapsulating configurations of the Vnstat environment.
   #
-  # @attr_writer [String] executable_path Sets the location of the vnstat
-  #   executable.
+  # @!attribute executable_path
+  #   @return The location of the vnstat executable.
   class Configuration
     ##
     # Initializes the {Configuration}.

data/lib/vnstat/document.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
 module Vnstat
   # A class encapsulating document data.
   #
-  # @attr_reader [Nokogiri::XML::Document] data The underlying XML document.
+  # @!attribute [r] data
+  #   @return [Nokogiri::XML::Document] The underlying XML document.
   class Document
     ##
     # Initializes the document.

data/lib/vnstat/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # An exception that hints at a generic error with vnstat.

data/lib/vnstat/errors/executable_not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # An exception that is raised when the vnstat CLI could not be found on the

data/lib/vnstat/errors/unknown_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   #
   # An exception that is raised when the specified interface could not be found

data/lib/vnstat/interface.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A class encapsulating traffic information for a specific network interface.
   #
-  # @attr_reader [String] id The network interface identifier.
+  # @!attribute [r] id
+  #   @return [String] The network interface identifier.
   class Interface < Document
     attr_reader :id
 

data/lib/vnstat/interface_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A class encapsulating traffic information for all known network interfaces.

data/lib/vnstat/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A module containing several utility methods responsible for document
@@ -36,8 +38,8 @@ module Vnstat
       date = extract_date_from_xml_element(element)
       hour = element.xpath('time/hour').text.to_i
       minute = element.xpath('time/minute').text.to_i
-      DateTime.new(date.year, date.month, date.day, hour, minute, 0,
-                   DateTime.now.offset)
+      offset = Time.now.strftime('%:z')
+      Time.new(date.year, date.month, date.day, hour, minute, 0, offset)
     end
 
     ##