vnstat-ruby 1.0.0

data/spec/lib/vnstat/traffic/daily_spec.rb

@@ -0,0 +1,109 @@
+describe Vnstat::Traffic::Daily do
+  let :interface do
+    data = <<-XML
+      <vnstat version="1.12" xmlversion="1">
+        <interface id="eth0">
+          <traffic>
+            <days>
+              <day id="0">
+                <date><year>2015</year><month>01</month><day>01</day></date>
+                <rx>1000</rx><tx>2000</tx>
+              </day>
+              <day id="1">
+                <date><year>2015</year><month>01</month><day>02</day></date>
+                <rx>3000</rx><tx>4000</tx>
+              </day>
+            </days>
+          </traffic>
+        </interface>
+      </vnstat>
+    XML
+    Vnstat::Interface.new('eth0', data)
+  end
+
+  subject { described_class.new(interface) }
+
+  include_examples 'traffic collection'
+
+  describe '#[]' do
+    context 'with 1 argument' do
+      context 'for existing entry' do
+        let(:date) { Date.new(2015, 1, 1) }
+
+        it 'returns a Vnstat::Result::Day' do
+          expect(subject[date]).to be_a Vnstat::Result::Day
+        end
+
+        it 'returns an object with the expected #date' do
+          expect(subject[date].date).to eq date
+        end
+
+        it 'returns an object with the expected #bytes_received' do
+          expect(subject[date].bytes_received).to eq 1000 * 1024
+        end
+
+        it 'returns an object with the expected #bytes_sent' do
+          expect(subject[date].bytes_sent).to eq 2000 * 1024
+        end
+      end
+
+      context 'for not-existing entry' do
+        it 'returns nil' do
+          expect(subject[Date.new(2015, 1, 3)]).to be nil
+        end
+      end
+    end
+
+    context 'with 2 arguments' do
+      it 'fails' do
+        expect { subject[nil, nil] }.to(
+          raise_error(ArgumentError, 'wrong number of arguments (2 for 1 or 3)')
+        )
+      end
+    end
+
+    context 'with 3 arguments' do
+      context 'for existing entry' do
+        it 'returns a Vnstat::Result::Day' do
+          expect(subject[2015, 1, 1]).to be_a Vnstat::Result::Day
+        end
+
+        it 'returns an object with the expected #date' do
+          expect(subject[2015, 1, 1].date).to eq Date.new(2015, 1, 1)
+        end
+
+        it 'returns an object with the expected #bytes_received' do
+          expect(subject[2015, 1, 1].bytes_received).to eq 1000 * 1024
+        end
+
+        it 'returns an object with the expected #bytes_sent' do
+          expect(subject[2015, 1, 1].bytes_sent).to eq 2000 * 1024
+        end
+      end
+
+      context 'for not-existing entry' do
+        it 'returns nil' do
+          expect(subject[2015, 1, 3]).to be nil
+        end
+      end
+    end
+
+    context 'with more than 3 arguments' do
+      it 'fails' do
+        expect { subject[nil, nil, nil, nil] }.to(
+          raise_error(ArgumentError, 'wrong number of arguments (4 for 1 or 3)')
+        )
+      end
+    end
+  end
+
+  describe '#each' do
+    it 'yields successively with Vnstat::Result::Day as argument' do
+      first_result = subject[2015, 1, 1]
+      second_result = subject[2015, 1, 2]
+
+      expect { |block| subject.each(&block) }
+        .to yield_successive_args(first_result, second_result)
+    end
+  end
+end

data/spec/lib/vnstat/traffic/hourly_spec.rb

@@ -0,0 +1,153 @@
+describe Vnstat::Traffic::Hourly do
+  let :interface do
+    data = <<-XML
+      <vnstat version="1.12" xmlversion="1">
+        <interface id="eth0">
+          <traffic>
+            <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
+    Vnstat::Interface.new('eth0', data)
+  end
+
+  subject { described_class.new(interface) }
+
+  include_examples 'traffic collection'
+
+  describe '#[]' do
+    context 'with 1 argument' do
+      it 'fails' do
+        expect { subject[nil] }.to(
+          raise_error(ArgumentError, 'wrong number of arguments (1 for 2 or 4)')
+        )
+      end
+    end
+
+    context 'with 2 arguments' do
+      let(:date) { Date.new(2015, 10, 21) }
+      let(:hour) { 20 }
+
+      context 'for existing entry' do
+        it 'returns a Vnstat::Result::Day' do
+          expect(subject[date, hour]).to be_a Vnstat::Result::Hour
+        end
+
+        it 'returns an object with the expected #date' do
+          expect(subject[date, hour].date).to eq date
+        end
+
+        it 'returns an object with the expected #hour' do
+          expect(subject[date, hour].hour).to eq hour
+        end
+
+        it 'returns an object with the expected #bytes_received' do
+          expect(subject[date, hour].bytes_received).to eq 3000 * 1024
+        end
+
+        it 'returns an object with the expected #bytes_sent' do
+          expect(subject[date, hour].bytes_sent).to eq 4000 * 1024
+        end
+      end
+
+      context 'for entry with non-existing date' do
+        it 'returns nil' do
+          expect(subject[Date.new(2015, 10, 20), 19]).to be nil
+        end
+      end
+
+      context 'for entry with non-existing hour' do
+        it 'returns nil' do
+          expect(subject[date, 0]).to be nil
+        end
+      end
+
+      context 'for entry with non-existing date and hour' do
+        it 'returns nil' do
+          expect(subject[Date.new(2015, 10, 20), 0]).to be nil
+        end
+      end
+    end
+
+    context 'with 3 arguments' do
+      it 'fails' do
+        expect { subject[nil, nil, nil] }.to(
+          raise_error(ArgumentError, 'wrong number of arguments (3 for 2 or 4)')
+        )
+      end
+    end
+
+    context 'with 4 arguments' do
+      let(:date_args) { [2015, 10, 21] }
+      let(:hour) { 20 }
+
+      context 'for existing entry' do
+        it 'returns a Vnstat::Result::Day' do
+          expect(subject[*date_args, hour]).to be_a Vnstat::Result::Hour
+        end
+
+        it 'returns an object with the expected #date' do
+          expect(subject[*date_args, hour].date).to eq Date.new(*date_args)
+        end
+
+        it 'returns an object with the expected #hour' do
+          expect(subject[*date_args, hour].hour).to eq hour
+        end
+
+        it 'returns an object with the expected #bytes_received' do
+          expect(subject[*date_args, hour].bytes_received).to eq 3000 * 1024
+        end
+
+        it 'returns an object with the expected #bytes_sent' do
+          expect(subject[*date_args, hour].bytes_sent).to eq 4000 * 1024
+        end
+      end
+
+      context 'for entry with non-existing date' do
+        it 'returns nil' do
+          expect(subject[2015, 10, 20, 19]).to be nil
+        end
+      end
+
+      context 'for entry with non-existing hour' do
+        it 'returns nil' do
+          expect(subject[*date_args, 0]).to be nil
+        end
+      end
+
+      context 'for entry with non-existing date and hour' do
+        it 'returns nil' do
+          expect(subject[2015, 10, 20, 0]).to be nil
+        end
+      end
+    end
+
+    context 'with 5 or more arguments' do
+      it 'fails' do
+        expect { subject[nil, nil, nil, nil, nil] }.to(
+          raise_error(ArgumentError, 'wrong number of arguments (5 for 2 or 4)')
+        )
+      end
+    end
+  end
+
+  describe '#each' do
+    it 'yields successively with Vnstat::Result::Hour as argument' do
+      first_result = subject[2015, 10, 21, 19]
+      second_result = subject[2015, 10, 21, 20]
+
+      expect { |block| subject.each(&block) }
+        .to yield_successive_args(first_result, second_result)
+    end
+  end
+end

data/spec/lib/vnstat/traffic/monthly_spec.rb

@@ -0,0 +1,46 @@
+describe Vnstat::Traffic::Monthly do
+  let :interface do
+    data = <<-XML
+      <vnstat version="1.12" xmlversion="1">
+        <interface id="eth0">
+          <traffic>
+            <months>
+              <month id="0">
+                <date><year>2015</year><month>01</month></date>
+                <rx>1000</rx><tx>2000</tx>
+              </month>
+              <month id="1">
+                <date><year>2015</year><month>02</month></date>
+                <rx>3000</rx><tx>4000</tx>
+              </month>
+            </months>
+          </traffic>
+        </interface>
+      </vnstat>
+    XML
+    Vnstat::Interface.new('eth0', data)
+  end
+
+  subject { described_class.new(interface) }
+
+  include_examples 'traffic collection'
+
+  describe '#[]' do
+    it 'returns a Vntat::Result::Month' do
+      expect(subject[2015, 2]).to be_a Vnstat::Result::Month
+    end
+  end
+
+  describe '#each' do
+    it 'yields successively with Vnstat::Result::Month for all months' do
+      expect { |block| subject.each(&block) }
+        .to yield_successive_args(subject[2015, 1], subject[2015, 2])
+    end
+  end
+
+  describe '#to_a' do
+    it 'contains Vnstat::Result::Month for all months' do
+      expect(subject.to_a).to match_array [subject[2015, 1], subject[2015, 2]]
+    end
+  end
+end

data/spec/lib/vnstat/traffic/tops_spec.rb

@@ -0,0 +1,48 @@
+describe Vnstat::Traffic::Tops do
+  let :interface do
+    data = <<-XML
+      <vnstat version="1.12" xmlversion="1">
+        <interface id="eth0">
+          <traffic>
+            <tops>
+              <top id="0">
+                <date><year>2015</year><month>01</month><day>01</day></date>
+                <time><hour>12</hour><minute>34</minute></time>
+                <rx>1000</rx><tx>2000</tx>
+              </top>
+              <top id="1">
+                <date><year>2015</year><month>02</month><day>02</day></date>
+                <time><hour>23</hour><minute>45</minute></time>
+                <rx>3000</rx><tx>4000</tx>
+              </top>
+            </tops>
+          </traffic>
+        </interface>
+      </vnstat>
+    XML
+    Vnstat::Interface.new('eth0', data)
+  end
+
+  subject { described_class.new(interface) }
+
+  include_examples 'traffic collection'
+
+  describe '#[]' do
+    it 'returns the Vnstat::Result::Minute at the specified index' do
+      expect(subject[0]).to be_a Vnstat::Result::Minute
+    end
+  end
+
+  describe '#each' do
+    it 'yields successively with Vnstat::Result::Minute for all top entries' do
+      expect { |block| subject.each(&block) }
+        .to yield_successive_args(subject[0], subject[1])
+    end
+  end
+
+  describe '#to_a' do
+    it 'contains Vnstat::Result::Month for all months' do
+      expect(subject.to_a).to match_array [subject[0], subject[1]]
+    end
+  end
+end

data/spec/lib/vnstat/utils_spec.rb

@@ -0,0 +1,128 @@
+describe Vnstat::Utils do
+  let(:executable_path) { '/any/path' }
+
+  before :each do
+    allow(Vnstat.config).to receive(:executable_path).and_return(executable_path)
+  end
+
+  describe '.system_call' do
+    it 'calls Vnstat::SystemCall.call' do
+      expect(Vnstat::SystemCall).to receive(:call).with('test', 'test2') do
+        double(success?: true, success_result: 'success')
+      end
+
+      described_class.system_call('test', 'test2')
+    end
+
+    context 'when Vnstat::SystemCall#success? is true' do
+      let(:system_call) { Vnstat::SystemCall.new('test') }
+
+      before :each do
+        allow(system_call).to receive(:success?).and_return(true)
+        allow(system_call).to receive(:success_result).and_return('success')
+
+        allow(Vnstat::SystemCall).to receive(:call).with('test')
+          .and_return(system_call)
+      end
+
+      it 'returns Vnstat::SystemCall#success_result' do
+        expect(described_class.system_call('test')).to eq 'success'
+      end
+    end
+
+    context 'when Vnstat::SystemCall#success? is false' do
+      let(:system_call) { Vnstat::SystemCall.new('test') }
+
+      before :each do
+        allow(system_call).to receive(:success?).and_return(false)
+        allow(system_call).to receive(:error_result).and_return('error')
+
+        allow(Vnstat::SystemCall).to receive(:call).with('test')
+          .and_return(system_call)
+      end
+
+      context 'without block given' do
+        it 'returns Vnstat::SystemCall#error_result' do
+          expect(described_class.system_call('test')).to eq 'error'
+        end
+      end
+
+      context 'with block given' do
+        it 'yields with Vnstat::SystemCall#error_result' do
+          expect { |block| described_class.system_call('test', &block) }
+            .to yield_with_args(system_call.error_result)
+        end
+
+        it 'returns block result' do
+          expect(described_class.system_call('test') { 'failed' })
+            .to eq 'failed'
+        end
+      end
+    end
+  end
+
+  describe '.system_call_returning_status' do
+    it 'calls Vnstat::SystemCall.call' do
+      expect(Vnstat::SystemCall).to receive(:call).with('test')
+        .and_return(double(success?: true))
+
+      described_class.system_call_returning_status('test')
+    end
+
+    context 'when Vnstat::SystemCall#success? is true' do
+      before :each do
+        allow_any_instance_of(Vnstat::SystemCall)
+          .to receive(:success?).and_return(true)
+      end
+
+      it 'returns true' do
+        expect(described_class.system_call_returning_status('test')).to be true
+      end
+    end
+
+    context 'when vnstat::SystemCall#success? is false' do
+      before :each do
+        allow_any_instance_of(Vnstat::SystemCall)
+          .to receive(:success?).and_return(false)
+      end
+
+      it 'returns false' do
+        expect(described_class.system_call_returning_status('test')).to be false
+      end
+    end
+  end
+
+  describe '.call_executable' do
+    let(:block) { Proc.new {} }
+
+    it 'calls .system_call using vnstat executable' do
+      expect(described_class).to receive(:system_call)
+        .with(executable_path, 'test', &block)
+
+      described_class.call_executable('test', &block)
+    end
+
+    it 'returns the result returned by .system_call' do
+      allow(described_class).to receive(:system_call).and_return('result')
+
+      expect(described_class.call_executable('test')).to eq 'result'
+    end
+  end
+
+  describe '.call_executable_returning_status' do
+    it 'calls .system_call_returning_status using vnstat executable' do
+      expect(described_class).to receive(:system_call_returning_status)
+        .with(executable_path, 'test')
+
+      described_class.call_executable_returning_status('test')
+    end
+
+    it 'returns the result returned by .system_call_returning_status' do
+      allow(described_class).to receive(:system_call_returning_status)
+        .and_return(true)
+
+      expect(described_class.call_executable_returning_status('test'))
+        .to be true
+    end
+  end
+end