vnstat-ruby 1.0.0

data/lib/vnstat/traffic/tops.rb

@@ -0,0 +1,39 @@
+module Vnstat
+  module Traffic
+    ##
+    # A class representing a collection of tracked tops.
+    class Tops < Base
+      ##
+      # Iterates over all results in the collection.
+      #
+      # @overload each
+      #   @return [Enumerator]
+      #
+      # @overload each(&block)
+      #   @yield [result]
+      #   @yieldparam [Result::Minute] result
+      #   @return [Tops]
+      def each(&block)
+        to_a.each(&block)
+      end
+
+      ##
+      # Fetches a single {Result::Minute} from the collection.
+      #
+      # @param [Integer] index The index of the entry in the collection.
+      # @return [Result::Minute]
+      def [](index)
+        to_a[index]
+      end
+
+      ##
+      # @return [Array<Result::Minute>]
+      def to_a
+        elements = traffic_data.xpath('tops/top')
+        elements.map do |element|
+          Result::Minute.extract_from_xml_element(element)
+        end
+      end
+    end
+  end
+end

data/lib/vnstat/utils.rb

@@ -0,0 +1,68 @@
+module Vnstat
+  ##
+  # A module containing several utility methods.
+  module Utils
+    module_function
+
+    ##
+    # Initiates a system call with the given arguments.
+    #
+    # @param [Array<String>] args The arguments for the system call.
+    #
+    # @overload system_call(*args)
+    #   @return [String] The output of STDOUT or STDERR, depending of the exit
+    #     status of the called command.
+    #
+    # @overload system_call(*args, &block)
+    #   @yield [error_result] A block yielded when the called command exited
+    #     unsuccessfully.
+    #   @yieldparam [String] error_result The STDERR output.
+    #   @return [Object] The value the called block returns.
+    def system_call(*args)
+      system_call = SystemCall.call(*args)
+      return system_call.success_result if system_call.success?
+      return yield(system_call.error_result) if block_given?
+      system_call.error_result
+    end
+
+    ##
+    # Initiates a system call with the given arguments and returning whether the
+    # command has been executed successfully.
+    #
+    # @param [Array<String>] args The arguments for the system call.
+    # @return [true, false] Indicates whether the command has been executed
+    #   successfully (true), or not (false).
+    def system_call_returning_status(*args)
+      SystemCall.call(*args).success?
+    end
+
+    ##
+    # Calls the vnstat CLI with the given arguments.
+    #
+    # @param [Array<String>] args The arguments for the system call.
+    #
+    # @overload call_executable(*args)
+    #   @return [String] The output of STDOUT or STDERR, depending of the exit
+    #     status of the called command.
+    #
+    # @overload call_executable(*args, &block)
+    #   @yield [error_result] A block yielded when the called command exited
+    #     unsuccessfully.
+    #   @yieldparam [String] error_result The STDERR output.
+    #   @return [Object] The value the called block returns.
+    def call_executable(*args, &block)
+      system_call(Vnstat.config.executable_path, *args, &block)
+    end
+
+    ##
+    # Calls the vnstat CLI with the given arguments and returning whether the
+    # command has been executed successfully.
+    #
+    # @param [Array<String>] args The arguments for the system call.
+    # @return [true, false] Indicates whether the command has been executed
+    #   successfully (true), or not (false).
+    def call_executable_returning_status(*args)
+      system_call_returning_status(Vnstat.config.executable_path, *args)
+    end
+  end
+end

data/spec/lib/vnstat/configuration_spec.rb

@@ -0,0 +1,72 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,124 @@
+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 '#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 '#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

@@ -0,0 +1,213 @@
+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 '#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 '#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
+  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' do
+      datetime = DateTime.new(2015, 10, 21, 22, 58)
+      expect(subject.updated_at).to eq datetime
+    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
+end