vnstat-ruby 1.1.0 → 2.0.0

data/lib/vnstat/result.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A class representing a tracking result.
   #
-  # @attr_reader [Integer] bytes_received The received bytes.
-  # @attr_reader [Integer] bytes_sent The sent bytes.
+  # @!attribute [r] bytes_received
+  #   @return [Integer] The received bytes.
+  # @!attribute [r] bytes_sent
+  #   @return [Integer] The sent bytes.
   class Result
-    autoload :Minute, 'vnstat/result/minute'
+    autoload :DateDelegation, 'vnstat/result/date_delegation'
     autoload :Day, 'vnstat/result/day'
     autoload :Hour, 'vnstat/result/hour'
+    autoload :Minute, 'vnstat/result/minute'
     autoload :Month, 'vnstat/result/month'
-
-    autoload :DateDelegation, 'vnstat/result/date_delegation'
     autoload :TimeComparable, 'vnstat/result/time_comparable'
 
     include Comparable

data/lib/vnstat/result/date_delegation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##

data/lib/vnstat/result/day.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##
     # A class representing a tracking result for a specific day.
     #
-    # @attr_reader [Date] date The date the result was captured on.
+    # @!attribute [r] date
+    #   @return [Date] The date the result was captured on.
     class Day < Result
       include DateDelegation
 

data/lib/vnstat/result/hour.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##
     # A class representing a tracking result for a specific hour.
     #
-    # @attr_reader [Date] date The date the result was captured on.
-    # @attr_reader [Integer] hour The hour the result was captured at.
+    # @!attribute [r] date
+    #   @return [Date] The date the result was captured on.
+    # @!attribute [r] hour
+    #   @return [Integer] The hour the result was captured at.
     class Hour < Result
       include DateDelegation
       include TimeComparable

data/lib/vnstat/result/minute.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##
     # A class representing a tracking result for a specific minute.
     #
-    # @attr_reader [DateTime] time The time the result was captured at.
+    # @!attribute [r] time
+    #  @return [DateTime] The time the result was captured at.
     class Minute < Result
       include DateDelegation
       include TimeComparable
@@ -55,7 +58,7 @@ module Vnstat
       #
       # @return [Integer]
       def minute
-        time.minute
+        time.min
       end
     end
   end

data/lib/vnstat/result/month.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##
     # A class representing a tracking result for a specific month.
     #
-    # @attr_reader [Integer] year The year the result was captured in.
-    # @attr_reader [Integer] month The month the result was captured in.
+    # @!attribute [r] year
+    #  @return [Integer] The year the result was captured in.
+    # @!attribute [r] month
+    #  @return [Integer] The month the result was captured in.
     class Month < Result
       attr_reader :year, :month
 

data/lib/vnstat/result/time_comparable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   class Result
     ##

data/lib/vnstat/system_call.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 require 'open3'
 
 module Vnstat
   ##
   # A class responsible for communication with command line interfaces.
   #
-  # @attr_reader [Array] args
-  # @attr_reader [String, nil] success_result The STDOUT output of the called
-  #   command.
-  # @attr_reader [String, nil] error_result The STDERR output of the called
-  #   command.
-  # @attr_reader [Process::Status, nil] exit_status The exit status of the
-  #   called command.
+  # @!attribute [r] args
+  #   @return [Array]
+  # @!attribute [r] success_result
+  #   @return [String, nil] The STDOUT output of the called command.
+  # @!attribute [r] error_result
+  #   @return [String, nil] The STDERR output of the called command.
+  # @!attribute [r] exit_status
+  #   @return [Process::Status, nil] The exit status of the called command.
   class SystemCall
     attr_reader :args, :success_result, :error_result, :exit_status
 

data/lib/vnstat/traffic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A namespace incorporating all kinds of traffic collections.

data/lib/vnstat/traffic/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   module Traffic
     ##

data/lib/vnstat/traffic/daily.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   module Traffic
     ##

data/lib/vnstat/traffic/hourly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   module Traffic
     ##

data/lib/vnstat/traffic/monthly.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   module Traffic
     ##

data/lib/vnstat/traffic/tops.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   module Traffic
     ##

data/lib/vnstat/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vnstat
   ##
   # A module containing several utility methods.

data/lib/vnstat/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vnstat
+  VERSION = '2.0.0'
+end

data/vnstat-ruby.gemspec

@@ -1,116 +1,43 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: vnstat-ruby 1.1.0 ruby lib
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name = "vnstat-ruby".freeze
-  s.version = "1.1.0"
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vnstat/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib".freeze]
-  s.authors = ["Tobias Casper".freeze]
-  s.date = "2017-04-27"
-  s.description = "Uses the the vnstat CLI to track your network traffic.".freeze
-  s.email = "tobias.casper@gmail.com".freeze
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".codeclimate.yml",
-    ".document",
-    ".rspec",
-    ".rubocop.yml",
-    ".travis.yml",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/vnstat-ruby.rb",
-    "lib/vnstat.rb",
-    "lib/vnstat/configuration.rb",
-    "lib/vnstat/document.rb",
-    "lib/vnstat/error.rb",
-    "lib/vnstat/errors/executable_not_found.rb",
-    "lib/vnstat/errors/unknown_interface.rb",
-    "lib/vnstat/interface.rb",
-    "lib/vnstat/interface_collection.rb",
-    "lib/vnstat/parser.rb",
-    "lib/vnstat/result.rb",
-    "lib/vnstat/result/date_delegation.rb",
-    "lib/vnstat/result/day.rb",
-    "lib/vnstat/result/hour.rb",
-    "lib/vnstat/result/minute.rb",
-    "lib/vnstat/result/month.rb",
-    "lib/vnstat/result/time_comparable.rb",
-    "lib/vnstat/system_call.rb",
-    "lib/vnstat/traffic.rb",
-    "lib/vnstat/traffic/base.rb",
-    "lib/vnstat/traffic/daily.rb",
-    "lib/vnstat/traffic/hourly.rb",
-    "lib/vnstat/traffic/monthly.rb",
-    "lib/vnstat/traffic/tops.rb",
-    "lib/vnstat/utils.rb",
-    "spec/lib/vnstat/configuration_spec.rb",
-    "spec/lib/vnstat/document_spec.rb",
-    "spec/lib/vnstat/errors/executable_not_found_spec.rb",
-    "spec/lib/vnstat/errors/unknown_interface_spec.rb",
-    "spec/lib/vnstat/interface_collection_spec.rb",
-    "spec/lib/vnstat/interface_spec.rb",
-    "spec/lib/vnstat/result/day_spec.rb",
-    "spec/lib/vnstat/result/hour_spec.rb",
-    "spec/lib/vnstat/result/minute_spec.rb",
-    "spec/lib/vnstat/result/month_spec.rb",
-    "spec/lib/vnstat/result_spec.rb",
-    "spec/lib/vnstat/system_call_spec.rb",
-    "spec/lib/vnstat/traffic/daily_spec.rb",
-    "spec/lib/vnstat/traffic/hourly_spec.rb",
-    "spec/lib/vnstat/traffic/monthly_spec.rb",
-    "spec/lib/vnstat/traffic/tops_spec.rb",
-    "spec/lib/vnstat/utils_spec.rb",
-    "spec/lib/vnstat_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/support/shared_examples/shared_examples_for_date_delegation.rb",
-    "spec/support/shared_examples/shared_examples_for_traffic_collection.rb",
-    "vnstat-ruby.gemspec"
-  ]
-  s.homepage = "http://github.com/tlux/vnstat-ruby".freeze
-  s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.11".freeze
-  s.summary = "A Ruby wrapper for vnstat.".freeze
+Gem::Specification.new do |spec|
+  spec.name = 'vnstat-ruby'
+  spec.version = Vnstat::VERSION
+  spec.authors = ['Tobias Casper']
+  spec.email = ['tobias.casper@gmail.com']
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  spec.summary = 'A library to track your network traffic using vnstat.'
+  spec.description =
+    'Utilizes the the vnstat CLI to track your network traffic.'
+  spec.homepage = 'https://github.com/tlux/vnstat-ruby'
+  spec.license = 'MIT'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.6"])
-      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
-      s.add_development_dependency(%q<codeclimate-test-reporter>.freeze, ["= 0.6.0"])
-      s.add_development_dependency(%q<jeweler>.freeze, [">= 2.0.1", "~> 2.0"])
-      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.0"])
-      s.add_development_dependency(%q<rubocop>.freeze, ["~> 0"])
-      s.add_development_dependency(%q<yard>.freeze, ["~> 0"])
-    else
-      s.add_dependency(%q<nokogiri>.freeze, ["~> 1.6"])
-      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
-      s.add_dependency(%q<codeclimate-test-reporter>.freeze, ["= 0.6.0"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 2.0.1", "~> 2.0"])
-      s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
-      s.add_dependency(%q<rubocop>.freeze, ["~> 0"])
-      s.add_dependency(%q<yard>.freeze, ["~> 0"])
-    end
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    s.add_dependency(%q<nokogiri>.freeze, ["~> 1.6"])
-    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
-    s.add_dependency(%q<codeclimate-test-reporter>.freeze, ["= 0.6.0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 2.0.1", "~> 2.0"])
-    s.add_dependency(%q<rspec>.freeze, ["~> 3.0"])
-    s.add_dependency(%q<rubocop>.freeze, ["~> 0"])
-    s.add_dependency(%q<yard>.freeze, ["~> 0"])
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
-end
 
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vnstat-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tobias Casper
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,62 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.1
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,40 +72,41 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.53'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.53'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Uses the the vnstat CLI to track your network traffic.
-email: tobias.casper@gmail.com
+        version: 0.9.12
+description: Utilizes the the vnstat CLI to track your network traffic.
+email:
+- tobias.casper@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".document"
+- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -158,32 +139,13 @@ files:
 - lib/vnstat/traffic/monthly.rb
 - lib/vnstat/traffic/tops.rb
 - lib/vnstat/utils.rb
-- spec/lib/vnstat/configuration_spec.rb
-- spec/lib/vnstat/document_spec.rb
-- spec/lib/vnstat/errors/executable_not_found_spec.rb
-- spec/lib/vnstat/errors/unknown_interface_spec.rb
-- spec/lib/vnstat/interface_collection_spec.rb
-- spec/lib/vnstat/interface_spec.rb
-- spec/lib/vnstat/result/day_spec.rb
-- spec/lib/vnstat/result/hour_spec.rb
-- spec/lib/vnstat/result/minute_spec.rb
-- spec/lib/vnstat/result/month_spec.rb
-- spec/lib/vnstat/result_spec.rb
-- spec/lib/vnstat/system_call_spec.rb
-- spec/lib/vnstat/traffic/daily_spec.rb
-- spec/lib/vnstat/traffic/hourly_spec.rb
-- spec/lib/vnstat/traffic/monthly_spec.rb
-- spec/lib/vnstat/traffic/tops_spec.rb
-- spec/lib/vnstat/utils_spec.rb
-- spec/lib/vnstat_spec.rb
-- spec/spec_helper.rb
-- spec/support/shared_examples/shared_examples_for_date_delegation.rb
-- spec/support/shared_examples/shared_examples_for_traffic_collection.rb
+- lib/vnstat/version.rb
 - vnstat-ruby.gemspec
-homepage: http://github.com/tlux/vnstat-ruby
+homepage: https://github.com/tlux/vnstat-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -200,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for vnstat.
+summary: A library to track your network traffic using vnstat.
 test_files: []