vnstat-ruby 1.1.0 → 2.0.0

data/.codeclimate.yml

@@ -1,14 +0,0 @@
----
-engines:
-  bundler-audit:
-    enabled: true
-  fixme:
-    enabled: true
-  rubocop:
-    enabled: true
-ratings:
-  paths:
-  - Gemfile.lock
-  - "**.rb"
-exclude_paths:
-- spec/**/*

data/spec/lib/vnstat/configuration_spec.rb

@@ -1,72 +0,0 @@
-describe Vnstat::Configuration do
-  describe '#reset' do
-    before :each do
-      subject.executable_path = '/test/path/vnstat'
-    end
-
-    it 'returns self' do
-      expect(subject.reset).to eq subject
-    end
-
-    it 'sets #executable_path to nil' do
-      expect { subject.reset }
-        .to change { subject.instance_variable_get(:@executable_path) }
-        .from('/test/path/vnstat').to(nil)
-    end
-  end
-
-  describe '#executable_path' do
-    context 'when configured' do
-      before :each do
-        subject.executable_path = '/test/path/vnstat'
-      end
-
-      it 'returns configured path' do
-        expect(subject.executable_path).to eq '/test/path/vnstat'
-      end
-    end
-
-    context 'when not configured' do
-      it 'calls Utils.system_call to invoke `which vnstat`' do
-        expect(Vnstat::Utils).to receive(:system_call)
-          .with('which', 'vnstat')
-          .and_return('/test/other_path/vnstat')
-
-        subject.executable_path
-      end
-
-      context 'with path detected by `which vnstat`' do
-        before :each do
-          allow(Vnstat::Utils).to receive(:system_call)
-            .with('which', 'vnstat')
-            .and_return('/test/other_path/vnstat')
-        end
-
-        it 'returns detected path' do
-          expect(subject.executable_path).to eq '/test/other_path/vnstat'
-        end
-      end
-
-      context 'with path not detectable by `which vnstat`' do
-        before :each do
-          allow(Vnstat::Utils).to receive(:system_call)
-            .with('which', 'vnstat').and_yield
-        end
-
-        it 'raises Vnstat::ExecutableNotFound' do
-          expect { subject.executable_path }
-            .to raise_error(Vnstat::ExecutableNotFound,
-                            'Unable to locate vnstat executable')
-        end
-      end
-    end
-  end
-
-  describe '#executable_path=' do
-    it 'sets instance variable @executable_path' do
-      expect { subject.executable_path = '/test/path/vnstat' }
-        .to change { subject.instance_variable_get(:@executable_path) }
-        .from(nil).to('/test/path/vnstat')
-    end
-  end
-end

data/spec/lib/vnstat/document_spec.rb

@@ -1,54 +0,0 @@
-describe Vnstat::Document do
-  subject do
-    described_class.new('<vnstat version="1.23" xmlversion="1"></vnstat>')
-  end
-
-  describe '#initialize' do
-    it 'invokes #data= forwarding the first argument' do
-      expect_any_instance_of(described_class)
-        .to receive(:data=).with('test')
-
-      described_class.new('test')
-    end
-  end
-
-  describe '#data=' do
-    context 'when setting nil' do
-      subject { described_class.new('<vnstat />') }
-
-      it 'raises ArgumentError' do
-        expect { subject.data = nil }
-          .to raise_error(ArgumentError, 'No document data specified')
-      end
-    end
-
-    context 'when setting a String' do
-      subject { described_class.new('<old />') }
-
-      before :each do
-      end
-
-      it 'changes #data' do
-        expect { subject.data = '<vnstat />' }.to(change { subject.data })
-      end
-
-      it 'stores the XML fragment in #data' do
-        subject.data = '<vnstat />'
-
-        expect(subject.data).to be_a Nokogiri::XML::Document
-      end
-    end
-  end
-
-  describe '#version' do
-    it 'returns the version attribute value from the vnstat element' do
-      expect(subject.version).to eq '1.23'
-    end
-  end
-
-  describe '#xml_version' do
-    it 'returns the xmlversion attribute value from the vnstat element' do
-      expect(subject.xml_version).to eq '1'
-    end
-  end
-end

data/spec/lib/vnstat/errors/executable_not_found_spec.rb

@@ -1,5 +0,0 @@
-describe Vnstat::ExecutableNotFound do
-  it 'inherits from Vnstat::Error' do
-    expect(described_class).to be < Vnstat::Error
-  end
-end

data/spec/lib/vnstat/errors/unknown_interface_spec.rb

@@ -1,5 +0,0 @@
-describe Vnstat::UnknownInterface do
-  it 'inherits from Vnstat::Error' do
-    expect(described_class).to be < Vnstat::Error
-  end
-end

data/spec/lib/vnstat/interface_collection_spec.rb

@@ -1,194 +0,0 @@
-describe Vnstat::InterfaceCollection do
-  let :data do
-    <<-XML
-      <vnstat version="0.00" xmlversion="1">
-        <interface id="eth0"></interface>
-        <interface id="wlan0"></interface>
-      </vnstat>
-    XML
-  end
-
-  subject { described_class.new(data) }
-
-  it { is_expected.to be_a Vnstat::Document }
-
-  describe '.open' do
-    it 'calls .new' do
-      allow(described_class).to receive(:load_data).and_return('test data')
-
-      expect(described_class).to receive(:new).with('test data')
-
-      described_class.open
-    end
-
-    it 'calls .load_data' do
-      expect(described_class).to receive(:load_data).and_return('<vnstat />')
-
-      described_class.open
-    end
-  end
-
-  describe '.load_data' do
-    it 'calls Vnstat::Utils.call_executable' do
-      expect(Vnstat::Utils).to receive(:call_executable).with('--xml')
-
-      described_class.load_data
-    end
-
-    it 'returns result of Vnstat::Utils.call_executable' do
-      allow(Vnstat::Utils).to receive(:call_executable).with(any_args)
-        .and_return('test')
-
-      expect(described_class.load_data).to eq 'test'
-    end
-  end
-
-  describe '#ids' do
-    it 'returns interface names from the data' do
-      expect(subject.ids).to eq %w[eth0 wlan0]
-    end
-  end
-
-  describe '#[]' do
-    context 'when existing interface given' do
-      context 'with String argument' do
-        it 'returns Vnstat::Interface' do
-          expect(subject['eth0']).to be_a Vnstat::Interface
-        end
-
-        it 'returns object with id matching the given argument' do
-          expect(subject['eth0'].id).to eq 'eth0'
-        end
-      end
-
-      context 'with symbolic argument' do
-        it 'returns Vnstat::Interface' do
-          expect(subject[:eth0]).to be_a Vnstat::Interface
-        end
-
-        it 'returns object with id matching the given argument' do
-          expect(subject[:eth0].id).to eq 'eth0'
-        end
-      end
-    end
-
-    context 'when non-existing interface given' do
-      it 'raises Vnstat::UnknownInterface' do
-        expect { subject['eth1'] }.to raise_error(Vnstat::UnknownInterface)
-      end
-    end
-  end
-
-  describe '#create' do
-    it 'calls Vnstat::Utils.call_executable_returning_status' do
-      expect(Vnstat::Utils).to receive(:call_executable_returning_status)
-        .with('--create', '-i', 'test').and_return(false)
-
-      subject.create('test')
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns true' do
-      before :each do
-        allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-          .and_return(true)
-      end
-
-      it 'calls #[] with first arg' do
-        allow(subject).to receive(:reload)
-
-        expect(subject).to receive(:[]).with('test')
-
-        subject.create('test')
-      end
-
-      it 'returns result of #[] with first arg' do
-        allow(subject).to receive(:reload)
-
-        allow(subject).to receive(:[]).and_return('test')
-
-        expect(subject.create('eth1')).to eq 'test'
-      end
-
-      it 'calls #reload' do
-        allow(subject).to receive(:[]).with('test')
-
-        expect(subject).to receive(:reload)
-
-        subject.create('test')
-      end
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns false' do
-      before :each do
-        allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-          .and_return(false)
-      end
-
-      it 'returns nil' do
-        expect(subject.create('test')).to be nil
-      end
-    end
-  end
-
-  describe '#reload' do
-    before :each do
-      allow(described_class).to receive(:load_data).and_return('<test />')
-    end
-
-    it 'sets #data using .load_data' do
-      expect(subject).to receive(:data=).with('<test />')
-
-      subject.reload
-    end
-
-    it 'returns self' do
-      expect(subject.reload).to eq subject
-    end
-  end
-
-  describe '#rebuild' do
-    before :each do
-      allow(described_class).to receive(:load_data).and_return('<test />')
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns true' do
-      before :each do
-        allow(Vnstat::Utils)
-          .to receive(:call_executable_returning_status)
-          .with('--rebuildtotal').and_return(true)
-      end
-
-      it 'returns self' do
-        expect(subject.rebuild).to eq subject
-      end
-
-      it 'calls #reload' do
-        expect(subject).to receive(:reload)
-
-        subject.rebuild
-      end
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns false' do
-      before :each do
-        allow(Vnstat::Utils)
-          .to receive(:call_executable_returning_status)
-          .with('--rebuildtotal').and_return(false)
-      end
-
-      it 'returns self' do
-        expect(subject.rebuild).to eq subject
-      end
-
-      it 'does not call #reload' do
-        expect(subject).not_to receive(:reload)
-
-        subject.rebuild
-      end
-    end
-  end
-end

data/spec/lib/vnstat/interface_spec.rb

@@ -1,327 +0,0 @@
-describe Vnstat::Interface do
-  let :data do
-    <<-XML
-      <vnstat version="1.12" xmlversion="1">
-        <interface id="eth0">
-          <id>eth0-test</id>
-          <nick>Ethernet</nick>
-          <created>
-            <date><year>2015</year><month>10</month><day>21</day></date>
-          </created>
-          <updated>
-            <date><year>2015</year><month>10</month><day>21</day></date>
-            <time><hour>22</hour><minute>58</minute></time>
-          </updated>
-          <traffic>
-            <total><rx>1000</rx><tx>2000</tx></total>
-            <days>
-              <day id="0">
-                <date><year>2015</year><month>1</month><day>1</day></date>
-                <rx>1000</rx><tx>2000</tx>
-              </day>
-              <day id="1">
-                <date><year>2015</year><month>1</month><day>2</day></date>
-                <rx>3000</rx><tx>4000</tx>
-              </day>
-            </days>
-            <months>
-              <month id="0">
-                <date><year>2015</year><month>1</month></date>
-                <rx>1000</rx><tx>2000</tx>
-              </month>
-              <month id="1">
-                <date><year>2015</year><month>2</month></date>
-                <rx>3000</rx><tx>4000</tx>
-              </month>
-            </months>
-            <tops>
-              <top id="0">
-                <date><year>2015</year><month>10</month><day>22</day></date>
-                <time><hour>00</hour><minute>00</minute></time>
-                <rx>1000</rx><tx>2000</tx>
-              </top>
-              <top id="1">
-                <date><year>2015</year><month>10</month><day>21</day></date>
-                <time><hour>19</hour><minute>53</minute></time>
-                <rx>3000</rx><tx>4000</tx>
-              </top>
-            </tops>
-            <hours>
-              <hour id="19">
-                <date><year>2015</year><month>10</month><day>21</day></date>
-                <rx>1000</rx><tx>2000</tx>
-              </hour>
-              <hour id="20">
-                <date><year>2015</year><month>10</month><day>21</day></date>
-                <rx>3000</rx><tx>4000</tx>
-              </hour>
-            </hours>
-          </traffic>
-        </interface>
-      </vnstat>
-    XML
-  end
-
-  subject { described_class.new('eth0', data) }
-
-  it { is_expected.to be_a Vnstat::Document }
-
-  describe '.open' do
-    it 'calls .new forwarding the first argument' do
-      allow(described_class).to receive(:load_data).with('test')
-        .and_return('test data')
-
-      expect(described_class).to receive(:new).with('test', 'test data')
-
-      described_class.open('test')
-    end
-
-    it 'calls .load_data forwarding the argument' do
-      expect(described_class).to receive(:load_data).with('test')
-        .and_return('<vnstat />')
-
-      described_class.open('test')
-    end
-  end
-
-  describe '.load_data' do
-    it 'calls Vnstat::Utils.call_executable' do
-      expect(Vnstat::Utils).to receive(:call_executable)
-        .with('-i', 'test', '--xml')
-
-      described_class.load_data('test')
-    end
-
-    it 'returns result of Vnstat::Utils.call_executable' do
-      allow(Vnstat::Utils).to receive(:call_executable).with(any_args)
-        .and_return('test')
-
-      expect(described_class.load_data('eth0')).to eq 'test'
-    end
-  end
-
-  describe '#id' do
-    it 'returns id from the interface node' do
-      expect(subject.id).to eq 'eth0'
-    end
-  end
-
-  %w[nick name].each do |method_name|
-    describe "##{method_name}" do
-      it 'returns value from the nick node' do
-        expect(subject.public_send(method_name)).to eq 'Ethernet'
-      end
-    end
-
-    describe "##{method_name}=" do
-      context 'when nickname can be set by vnstat' do
-        before :each do
-          allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-            .and_return(true)
-        end
-
-        it 'sets #nick to argument' do
-          expect { subject.nick = 'test' }.to change { subject.nick }.to('test')
-        end
-      end
-
-      context 'when nickname cannot be set by vnstat' do
-        before :each do
-          allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-            .and_return(false)
-        end
-
-        it 'raises Vnstat::Error' do
-          expect { subject.nick = 'test' }.to raise_error(
-            Vnstat::Error, 'Unable to set nickname for interface (eth0). ' \
-                           'Please make sure the vnstat daemon is not ' \
-                           'running while performing this operation.'
-          )
-        end
-      end
-    end
-  end
-
-  describe '#created_on' do
-    it 'returns the Date from the created node' do
-      date = Date.new(2015, 10, 21)
-      expect(subject.created_on).to eq date
-    end
-  end
-
-  describe '#updated_at' do
-    it 'returns the DateTime from the updated node in the correct time zone' do
-      time = DateTime.new(2015, 10, 21, 22, 58, 0o0, DateTime.now.offset)
-
-      expect(subject.updated_at).to eq time
-    end
-  end
-
-  describe '#total' do
-    it 'returns a Vnstat::Result' do
-      expect(subject.total).to be_a Vnstat::Result
-    end
-
-    it 'returns a result with the correct bytes received' do
-      expect(subject.total.bytes_received).to eq(1000 * 1024)
-    end
-
-    it 'returns a result with the correct bytes sent' do
-      expect(subject.total.bytes_sent).to eq(2000 * 1024)
-    end
-  end
-
-  describe '#hours' do
-    it 'returns a Vnstat::Traffic::Hourly' do
-      expect(subject.hours).to be_a Vnstat::Traffic::Hourly
-    end
-
-    it 'stores subject in Vnstat::Traffic::Hourly#interface' do
-      expect(subject.hours.interface).to eq subject
-    end
-  end
-
-  describe '#days' do
-    it 'returns a Vnstat::Traffic::Daily' do
-      expect(subject.days).to be_a Vnstat::Traffic::Daily
-    end
-
-    it 'stores subject in Vnstat::Traffic::Daily#interface' do
-      expect(subject.days.interface).to eq subject
-    end
-  end
-
-  describe '#months' do
-    it 'returns a Vnstat::Traffic::Monthly' do
-      expect(subject.months).to be_a Vnstat::Traffic::Monthly
-    end
-
-    it 'stores subject in Vnstat::Traffic::Monthly#interface' do
-      expect(subject.months.interface).to eq subject
-    end
-  end
-
-  describe '#tops' do
-    it 'returns a Vnstat::Traffic::Tops' do
-      expect(subject.tops).to be_a Vnstat::Traffic::Tops
-    end
-
-    it 'stores subject in Vnstat::Traffic::Tops#interface' do
-      expect(subject.tops.interface).to eq subject
-    end
-  end
-
-  describe '#reload' do
-    let :reloaded_data do
-      <<-XML
-        <vnstat version="1.12" xmlversion="1">
-          <interface id="eth0">
-            <id>eth0</id>
-            <nick>New Ethernet</nick>
-          </interface>
-        </vnstat>
-      XML
-    end
-
-    before :each do
-      allow(described_class).to receive(:load_data).and_return('<test />')
-    end
-
-    it 'returns self' do
-      expect(subject.reload).to eq subject
-    end
-
-    it 'calls .load_data with #id as argument' do
-      expect(described_class).to receive(:load_data).with('eth0')
-        .and_return(reloaded_data)
-
-      subject.reload
-    end
-
-    it 'calls #data= with the result from .load_data' do
-      allow(described_class).to receive(:load_data).and_return('<vnstat />')
-
-      expect(subject).to receive(:data=).with('<vnstat />')
-
-      subject.reload
-    end
-
-    it 'resets #nick from reloaded data' do
-      allow(described_class).to receive(:load_data).with('eth0')
-        .and_return(reloaded_data)
-
-      expect { subject.reload }
-        .to change { subject.nick }.from('Ethernet').to('New Ethernet')
-    end
-  end
-
-  describe '#delete' do
-    it 'calls Vnstat::Utils.call_executable_returning_status' do
-      expect(Vnstat::Utils).to receive(:call_executable_returning_status)
-        .with('--delete', '-i', subject.id)
-
-      subject.delete
-    end
-
-    [true, false].each do |expected|
-      context 'when Vnstat::Utils.call_executable_returning_status ' \
-              "returns #{expected}" do
-        before :each do
-          allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-            .with(any_args).and_return(expected)
-        end
-
-        it 'returns true' do
-          expect(subject.delete).to be expected
-        end
-      end
-    end
-  end
-
-  describe '#reset' do
-    it 'calls Vnstat::Utils.call_executable_returning_status' do
-      expect(Vnstat::Utils).to receive(:call_executable_returning_status)
-        .with('--reset', '-i', subject.id)
-
-      subject.reset
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns true' do
-      before :each do
-        allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-          .with(any_args).and_return(true)
-      end
-
-      it 'returns self' do
-        allow(subject).to receive(:reload)
-
-        expect(subject.reset).to eq subject
-      end
-
-      it 'calls #reload' do
-        expect(subject).to receive(:reload)
-
-        subject.reset
-      end
-    end
-
-    context 'when Vnstat::Utils.call_executable_returning_status ' \
-            'returns false' do
-      before :each do
-        allow(Vnstat::Utils).to receive(:call_executable_returning_status)
-          .with(any_args).and_return(false)
-      end
-
-      it 'returns self' do
-        expect(subject.reset).to eq subject
-      end
-
-      it 'does not call #reload' do
-        expect(subject).not_to receive(:reload)
-
-        subject.reset
-      end
-    end
-  end
-end