vnstat-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd659bd2efc22fe9934f7ae67abd8cfc093bdef0
-  data.tar.gz: 9b75a15b391906638f124f315af107ac7b6e7483
+  metadata.gz: 1715a5093d7a2a70bf97ff7fdba6841947b757fc
+  data.tar.gz: 36bb4148f065f37f5fddcc86cc030ca17cdb6540
 SHA512:
-  metadata.gz: 974c1bcf19acd33ebe3c5ba3b257a5da78c4ade4c683afa67c667209c09eb294eab48d26c112a353c42e29309fc4e4ca6cb3d03fc1ea582a15f00067b39c9160
-  data.tar.gz: 20260148918607aa6daaa89d60b43b71f334c42913af24468386dceb29f9bb878c19f6ed95efcb06c16f501f1d886ee4e18e93ea45f4cab9316fb08a353aebf2
+  metadata.gz: 1d4f1d8b0748d356bd2571c61ef35df7993b6ee02d1a5b2dbd755abd8b8b581fca6a700eedd3f856fb38c1fee21f39ce9dc2f7ad10ae488d5fbb31b08ca55f5e
+  data.tar.gz: be614eabb9d0398b3d6725225296dba0416214ba0ac823b79f8c403045efdb818bc7576b959bfd9b48e5cf9b629bd22fa801d11d3a98867a14b5656ba0bc4c1c

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'nokogiri'
+gem 'nokogiri', '~> 1.6'
 
 group :development do
   gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -76,7 +76,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   codeclimate-test-reporter
   jeweler (~> 2.0.1)
-  nokogiri
+  nokogiri (~> 1.6)
   rspec (~> 3.0)
   yard
 

data/README.md

@@ -50,15 +50,117 @@ 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
+Vnstat.config.executable_path = '/usr/bin/vnstat'
 ```
 
 ### Usage
 
-TODO
+#### Network Interfaces
+
+To retrieve a list of all known network interfaces:
+
+```ruby
+Vnstat.interfaces # => #<Vnstat::InterfaceCollection ...>
+Vnstat.interfaces.ids # => ['eth01', 'eth02']
+```
+
+To only retrieve traffic stats for a single interface:
+
+```ruby
+Vnstat.interfaces.first # => #<Vnstat::Interface id: "eth01">
+```
+
+If you know the name of a network interface, you can also retrieve the
+stats of that particular one:
+
+```ruby
+Vnstat['eth01'] # => #<Vnstat::Interface id: "eth01">
+```
+
+#### Traffic Information
+
+##### Total
+
+```ruby
+interface = Vnstat['eth01']
+```
+
+```ruby
+interface.total # => #<Vnstat::Result ...>
+interface.total.bytes_received # => 1024000
+interface.total.bytes_sent # => 2048000
+interface.total.bytes_transmitted # => 3072000
+```
+
+##### By Month
+
+```ruby
+interface.months # => #<Vnstat::Traffic::Monthly ...>
+```
+
+```ruby
+interface.months.first
+interface.months[2015, 9]
+# => #<Vnstat::Result::Month year: 2015, month: 9, ...>
+```
+
+```ruby
+interface.months[2015, 10].bytes_received # => 3072000
+```
 
+##### By Day
+
+```ruby
+interface.days # => #<Vnstat::Traffic::Daily ...>
+```
+
+```ruby
+interface.days.first
+interface.days[Date.new(2015, 11, 23)]
+interface.days[2015, 11, 23]
+# => #<Vnstat::Result::Day date: #<Date: 2015-11-23>, ...>
+```
+
+```ruby
+interface.days[2015, 11, 23].bytes_received # => 2048000
+```
+
+##### By Hour
+
+```ruby
+interface.hours # => #<Vnstat::Traffic::Hourly ...>
+```
+
+```ruby
+interface.hours.first
+interface.hours[Date.new(2015, 9, 22), 10]
+interface.hours[2015, 9, 22, 10]
+# => #<Vnstat::Result::Hour date: #<Date: 2015-11-23>, hour: 10>
+```
+
+```ruby
+interface.hours[2015, 9, 22, 10].bytes_received # => 2048000
+```
+
+##### Tops
+
+```ruby
+interface.tops #=> #<Vnstat::Traffic::Tops ...>
+interface.tops.count #=> 10
+interface.tops.each do |top|
+  # ...
+end
+```
+
+```ruby
+interface.tops.first
+interface.tops[2]
+# => #<Vnstat::Result::Minute time: #<DateTime: 2015-11-05T09:03:42+00:00>>
+```
+
+```ruby
+interface.tops[1].bytes_received # => 1024000
+```
 
 ### Contributing to vnstat-ruby
 

data/Rakefile

@@ -10,19 +10,18 @@ rescue Bundler::BundlerError => e
   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.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: :test
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/vnstat-ruby.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: vnstat-ruby 1.0.0 ruby lib
+# stub: vnstat-ruby 1.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "vnstat-ruby"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Tobias Casper"]
-  s.date = "2015-11-18"
-  s.description = "A Ruby wrapper for vnstat"
+  s.date = "2015-11-24"
+  s.description = "Uses the the vnstat CLI to track your network traffic."
   s.email = "tobias.casper@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -81,20 +81,20 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/tlux/vnstat-ruby"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.4.5.1"
-  s.summary = "A Ruby wrapper for vnstat"
+  s.summary = "A Ruby wrapper for vnstat."
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6"])
       s.add_development_dependency(%q<rspec>, ["~> 3.0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<codeclimate-test-reporter>, [">= 0"])
     else
-      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.6"])
       s.add_dependency(%q<rspec>, ["~> 3.0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -102,7 +102,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
     end
   else
-    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.6"])
     s.add_dependency(%q<rspec>, ["~> 3.0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vnstat-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tobias Casper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby wrapper for vnstat
+description: Uses the the vnstat CLI to track your network traffic.
 email: tobias.casper@gmail.com
 executables: []
 extensions: []
@@ -183,5 +183,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for vnstat
+summary: A Ruby wrapper for vnstat.
 test_files: []