vnstat-ruby 1.0.0

data/spec/lib/vnstat/result/day_spec.rb

@@ -0,0 +1,39 @@
+describe Vnstat::Result::Day do
+  it 'includes Comparable' do
+    expect(described_class).to include Comparable
+  end
+
+  describe '.extract_from_xml_element' do
+    let :element do
+      data = <<-XML
+        <day id="0">
+          <date><year>2015</year><month>7</month><day>14</day></date>
+          <rx>1000</rx><tx>2000</tx>
+        </day>
+      XML
+      Nokogiri::XML.parse(data).xpath('day')
+    end
+
+    subject do
+      described_class.extract_from_xml_element(element)
+    end
+
+    it { is_expected.to be_a described_class }
+
+    it 'initializes with the correct #date' do
+      expect(subject.date).to eq Date.new(2015, 7, 14)
+    end
+
+    it 'initializes with the correct #bytes_received' do
+      expect(subject.bytes_received).to eq 1000 * 1024
+    end
+
+    it 'initializes with the correct #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000 * 1024
+    end
+  end
+
+  include_examples 'date delegation' do
+    subject { described_class.new(Date.today, 0, 0) }
+  end
+end

data/spec/lib/vnstat/result/hour_spec.rb

@@ -0,0 +1,43 @@
+describe Vnstat::Result::Hour do
+  it 'includes Comparable' do
+    expect(described_class).to include Comparable
+  end
+
+  describe '.extract_from_xml_element' do
+    let :element do
+      data = <<-XML
+        <hour id="19">
+          <date><year>2015</year><month>10</month><day>21</day></date>
+          <rx>1000</rx><tx>2000</tx>
+        </hour>
+      XML
+      Nokogiri::XML.parse(data).xpath('hour')
+    end
+
+    subject do
+      described_class.extract_from_xml_element(element)
+    end
+
+    it { is_expected.to be_a described_class }
+
+    it 'initializes with the correct #date' do
+      expect(subject.date).to eq Date.new(2015, 10, 21)
+    end
+
+    it 'initializes with the correct #hour' do
+      expect(subject.hour).to eq 19
+    end
+
+    it 'initializes with the correct #bytes_received' do
+      expect(subject.bytes_received).to eq 1000 * 1024
+    end
+
+    it 'initializes with the correct #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000 * 1024
+    end
+  end
+
+  include_examples 'date delegation' do
+    subject { described_class.new(Date.today, 12, 0, 0) }
+  end
+end

data/spec/lib/vnstat/result/minute_spec.rb

@@ -0,0 +1,52 @@
+describe Vnstat::Result::Minute do
+  it 'includes Comparable' do
+    expect(described_class).to include Comparable
+  end
+
+  describe '.extract_from_xml_element' do
+    let :element do
+      data = <<-XML
+        <top id="0">
+          <date><year>2015</year><month>2</month><day>3</day></date>
+          <time><hour>12</hour><minute>34</minute></time>
+          <rx>1000</rx><tx>2000</tx>
+        </top>
+      XML
+      Nokogiri::XML.parse(data).xpath('top')
+    end
+
+    subject do
+      described_class.extract_from_xml_element(element)
+    end
+
+    it { is_expected.to be_a described_class }
+
+    it 'initializes with the correct #time' do
+      expect(subject.time).to eq DateTime.new(2015, 2, 3, 12, 34)
+    end
+
+    it 'initializes with the correct #date' do
+      expect(subject.date).to eq Date.new(2015, 2, 3)
+    end
+
+    it 'initializes with the correct #hour' do
+      expect(subject.hour).to eq 12
+    end
+
+    it 'initialized with the correct #minute' do
+      expect(subject.minute).to eq 34
+    end
+
+    it 'initializes with the correct #bytes_received' do
+      expect(subject.bytes_received).to eq 1000 * 1024
+    end
+
+    it 'initializes with the correct #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000 * 1024
+    end
+  end
+
+  include_examples 'date delegation' do
+    subject { described_class.new(DateTime.now, 0, 0) }
+  end
+end

data/spec/lib/vnstat/result/month_spec.rb

@@ -0,0 +1,39 @@
+describe Vnstat::Result::Month do
+  it 'includes Comparable' do
+    expect(described_class).to include Comparable
+  end
+
+  describe '.extract_from_xml_element' do
+    let :element do
+      data = <<-XML
+        <month id="0">
+          <date><year>2015</year><month>9</month></date>
+          <rx>1000</rx><tx>2000</tx>
+        </month>
+      XML
+      Nokogiri::XML.parse(data).xpath('month')
+    end
+
+    subject do
+      described_class.extract_from_xml_element(element)
+    end
+
+    it { is_expected.to be_a described_class }
+
+    it 'initializes with the correct #year' do
+      expect(subject.year).to eq 2015
+    end
+
+    it 'initializes with the correct #month' do
+      expect(subject.month).to eq 9
+    end
+
+    it 'initializes with the correct #bytes_received' do
+      expect(subject.bytes_received).to eq 1000 * 1024
+    end
+
+    it 'initializes with the correct #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000 * 1024
+    end
+  end
+end

data/spec/lib/vnstat/result_spec.rb

@@ -0,0 +1,86 @@
+describe Vnstat::Result do
+  it 'includes Comparable' do
+    expect(described_class).to include Comparable
+  end
+
+  describe '.extract_from_xml_element' do
+    let :element do
+      data = <<-XML
+        <total>
+          <rx>1000</rx><tx>2000</tx>
+        </total>
+      XML
+      Nokogiri::XML.parse(data).xpath('total')
+    end
+
+    subject { described_class.extract_from_xml_element(element) }
+
+    it { is_expected.to be_a described_class }
+
+    it 'initializes with the correct #bytes_received' do
+      expect(subject.bytes_received).to eq 1000 * 1024
+    end
+
+    it 'initializes with the correct #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000 * 1024
+    end
+  end
+
+  describe '#initialize' do
+    subject { described_class.new(1000, 2000) }
+
+    it 'stores the first argument in #bytes_received' do
+      expect(subject.bytes_received).to eq 1000
+    end
+
+    it 'stores the second argument in #bytes_sent' do
+      expect(subject.bytes_sent).to eq 2000
+    end
+  end
+
+  describe '#bytes_transmitted' do
+    subject { described_class.new(1000, 2000) }
+
+    it 'returns sum of #bytes_received and #bytes_sent' do
+      expect(subject.bytes_transmitted).to eq 3000
+    end
+  end
+
+  describe '#<=>' do
+    subject { described_class.new(1000, 2000) }
+
+    context 'when argument does not respond to :bytes_transmitted' do
+      let(:other) { double }
+
+      it 'returns nil' do
+        expect(subject <=> other).to be nil
+      end
+    end
+
+    context 'when argument responds to :bytes_transmitted' do
+      context 'with other value being greater' do
+        let(:other) { double(bytes_transmitted: 4000) }
+
+        it 'returns -1' do
+          expect(subject <=> other).to eq -1
+        end
+      end
+
+      context 'with other value being equal' do
+        let(:other) { double(bytes_transmitted: 3000) }
+
+        it 'returns 0' do
+          expect(subject <=> other).to eq 0
+        end
+      end
+
+      context 'with other value being lower' do
+        let(:other) { double(bytes_transmitted: 2000) }
+
+        it 'returns 1' do
+          expect(subject <=> other).to eq 1
+        end
+      end
+    end
+  end
+end

data/spec/lib/vnstat/system_call_spec.rb

@@ -0,0 +1,209 @@
+describe Vnstat::SystemCall do
+  let(:args) { ['test', 'test2', 'test3'] }
+
+  describe '#initialize' do
+    context 'when arguments are anything' do
+      subject { described_class.new(*args) }
+
+      it 'stores args in #args' do
+        expect(subject.args).to eq args
+      end
+    end
+
+    context 'when first argument is an Array' do
+      subject { described_class.new(args) }
+
+      it 'stores args in #args' do
+        expect(subject.args).to eq args
+      end
+    end
+  end
+
+  describe '.call' do
+    it 'forwards args to .new' do
+      expect(described_class).to receive(:new).with('test').and_call_original
+
+      described_class.call('test')
+    end
+
+    it 'delegates to #call with no args' do
+      expect_any_instance_of(described_class).to receive(:call).with(no_args)
+
+      described_class.call('test')
+    end
+
+    it "returns result of #call" do
+      allow_any_instance_of(described_class)
+        .to receive(:call).and_return('test')
+
+      expect(described_class.call).to eq 'test'
+    end
+  end
+
+  describe '#call' do
+    subject { described_class.new(*args) }
+
+    it 'returns self' do
+      expect(subject.call).to eq subject
+    end
+
+    it 'calls Open3.popen with #args as arguments' do
+      expect(Open3).to receive(:popen3).with(*args)
+
+      subject.call
+    end
+
+    context 'when called' do
+      let(:success_result) { "success 1\nsuccess 2" }
+      let(:error_result) { "error 1\nerror 2" }
+      let(:exit_status) { double(value: 'test') }
+
+      before :each do
+        success_io = build_mock_io(success_result)
+        error_io = build_mock_io(error_result)
+
+        allow(Open3).to receive(:popen3)
+          .and_yield(nil, success_io, error_io, exit_status)
+
+        subject.call
+      end
+
+      it 'sets #exit_status' do
+        expect(subject.exit_status).to eq exit_status.value
+      end
+
+      it 'sets #success_result' do
+        expect(subject.success_result).to eq success_result
+      end
+
+      it 'sets #error_result' do
+        expect(subject.error_result).to eq error_result
+      end
+
+      def build_mock_io(*lines)
+        io = StringIO.new
+        lines.flatten.each { |line| io.puts(line) }
+        io.tap(&:rewind)
+      end
+    end
+  end
+
+  describe '#called?' do
+    context 'when #exit_status is nil' do
+      before :each do
+        allow(subject).to receive(:exit_status).and_return('something')
+      end
+
+      it 'returns true' do
+        expect(subject.called?).to be true
+      end
+    end
+
+    context 'when #exit_status is not nil' do
+      before :each do
+        allow(subject).to receive(:exit_status).and_return(nil)
+      end
+
+      it 'returns false' do
+        expect(subject.called?).to be false
+      end
+    end
+  end
+
+  describe '#success?' do
+    context 'when #called? is true' do
+      before :each do
+        allow(subject).to receive(:called?).and_return(true)
+      end
+
+      context 'when exited successfully' do
+        before :each do
+          allow(subject).to receive(:exit_status) do
+            double(success?: true)
+          end
+        end
+
+        it 'returns true' do
+          expect(subject.success?).to be true
+        end
+      end
+
+      context 'when not exited successfully' do
+        before :each do
+          allow(subject).to receive(:exit_status) do
+            double(success?: false)
+          end
+        end
+
+        it 'returns false' do
+          expect(subject.success?).to be false
+        end
+      end
+    end
+
+    context 'when #called? is false' do
+      before :each do
+        allow(subject).to receive(:called?).and_return(false)
+      end
+
+      it 'raises' do
+        expect { subject.success? }.to raise_error('Command not invoked')
+      end
+    end
+  end
+
+  describe '#error?' do
+    it 'calls #success?' do
+      expect(subject).to receive(:success?)
+
+      subject.error?
+    end
+
+    context 'when #success? is true' do
+      before :each do
+        allow(subject).to receive(:success?).and_return(true)
+      end
+
+      it 'returns false' do
+        expect(subject.error?).to be false
+      end
+    end
+
+    context 'when #success? is false' do
+      before :each do
+        allow(subject).to receive(:success?).and_return(false)
+      end
+
+      it 'returns true' do
+        expect(subject.error?).to be true
+      end
+    end
+  end
+
+  describe '#result' do
+    before :each do
+      allow(subject).to receive(:success_result).and_return('success')
+      allow(subject).to receive(:error_result).and_return('error')
+    end
+
+    context 'when #success? is true' do
+      before :each do
+        allow(subject).to receive(:success?).and_return(true)
+      end
+
+      it 'returns #success_result' do
+        expect(subject.result).to eq subject.success_result
+      end
+    end
+
+    context 'when #success? is false' do
+      before :each do
+        allow(subject).to receive(:success?).and_return(false)
+      end
+
+      it 'returns #error_result' do
+        expect(subject.result).to eq subject.error_result
+      end
+    end
+  end
+end