vnstat-ruby 1.0.0

data/spec/lib/vnstat_spec.rb

@@ -0,0 +1,61 @@
+describe Vnstat do
+  describe '.config' do
+    subject { described_class.config }
+
+    it { is_expected.to be_a Vnstat::Configuration }
+
+    it 'is only instantiated once' do
+      expect(subject).to be described_class.config
+    end
+  end
+
+  describe '.configure' do
+    it 'returns .config' do
+      expect(described_class.configure { 'test' }).to eq described_class.config
+    end
+
+    context 'when no block given' do
+      it 'raises' do
+        expect { described_class.configure }.to raise_error LocalJumpError
+      end
+    end
+
+    context 'when block given' do
+      it 'yields once' do
+        expect { |block| described_class.configure(&block) }
+          .to yield_control.exactly(1).times
+      end
+
+      it 'yields with configuration' do
+        expect { |block| described_class.configure(&block) }
+          .to yield_with_args(described_class.config)
+      end
+    end
+  end
+
+  describe '.interfaces' do
+    it 'calls Vnstat::InterfaceCollection.open' do
+      expect(Vnstat::InterfaceCollection).to receive(:open)
+
+      described_class.interfaces
+    end
+  end
+
+  describe '.[]' do
+    it 'delegates to #interfaces' do
+      allow(described_class).to receive(:interfaces) do
+        { 'eth0' => 'test' }
+      end
+
+      expect(described_class['eth0']).to eq 'test'
+    end
+  end
+
+  describe '.version' do
+    it 'calls Utils.call_executable with -v argument' do
+      expect(Vnstat::Utils).to receive(:call_executable).with('-v')
+
+      described_class.version
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+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 'vnstat'
+
+Dir.glob(File.join(File.dirname(__FILE__), 'support', '**', '*.rb')).each do |file|
+  require file
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  # config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   # Use the documentation formatter for detailed output,
+  #   # unless a formatter has already been configured
+  #   # (e.g. via a command-line flag).
+  #   config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/shared_examples/shared_examples_for_date_delegation.rb

@@ -0,0 +1,19 @@
+shared_examples 'date delegation' do
+  describe '#year' do
+    it 'matches the year from #date' do
+      expect(subject.year).to eq subject.date.year
+    end
+  end
+
+  describe '#month' do
+    it 'matches the month from #date' do
+      expect(subject.month).to eq subject.date.month
+    end
+  end
+
+  describe '#day' do
+    it 'matches the day from #date' do
+      expect(subject.day).to eq subject.date.day
+    end
+  end
+end

data/spec/support/shared_examples/shared_examples_for_traffic_collection.rb

@@ -0,0 +1,19 @@
+shared_examples 'traffic collection' do
+  it 'includes Enumerable' do
+    expect(described_class).to include Enumerable
+  end
+
+  describe '#each' do
+    context 'when block given' do
+      it 'returns an Array' do
+        expect(subject.each {}).to be_an Array
+      end
+    end
+
+    context 'when no block given' do
+      it 'returns an Enumerator' do
+        expect(subject.each).to be_an Enumerator
+      end
+    end
+  end
+end

data/vnstat-ruby.gemspec

@@ -0,0 +1,113 @@
+# 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.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "vnstat-ruby"
+  s.version = "1.0.0"
+
+  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.email = "tobias.casper@gmail.com"
+  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"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  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_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<rspec>, ["~> 3.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<codeclimate-test-reporter>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: vnstat-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tobias Casper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for vnstat
+email: tobias.casper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+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
+homepage: http://github.com/tlux/vnstat-ruby
+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.1
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for vnstat
+test_files: []