bvr 0.0.1 → 0.1.0

data/lib/bvr/version.rb

@@ -1,3 +1,3 @@
 module Bvr
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/changepassword.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<!DOCTYPE ChangePassword>
+<ChangePassword>
+  <Customer>foo*provider</Customer>
+  <Result>Success</Result>
+  <Reason>User/Password combination unknown</Reason>
+</ChangePassword>

data/spec/fixtures/changeuserinfo.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!DOCTYPE ChangeUserInfo>
+<ChangeUserInfo>
+  <Customer>foo*provider</Customer>
+  <Result>Success</Result>
+  <Reason>GeoCallCLI Changed</Reason>
+  <Result>Success</Result>
+  <Reason>Request completely succeeded</Reason>
+</ChangeUserInfo>

data/spec/fixtures/createcustomer_response.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<!DOCTYPE CreateAccount>
+<CreateAccount>
+  <Customer>foo</Customer>
+  <Result>Failed</Result>
+  <Reason>Request completely or partially failed.</Reason>
+</CreateAccount>

data/spec/fixtures/customerblocked.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!DOCTYPE ChangeUserInfo>
+<ChangeUserInfo>
+  <Customer>foo*provider</Customer>
+  <Result>Success</Result>
+  <Reason>CustomerBlocked Changed</Reason>
+  <Result>Success</Result>
+  <Reason>Request completely succeeded</Reason>
+</ChangeUserInfo>

data/spec/fixtures/getuserinfo.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!DOCTYPE GetUserInfo>
+<GetUserInfo>
+  <Customer>foo*provider</Customer>
+  <Balance>1.86</Balance>
+  <SpecificBalance>1.86828</SpecificBalance>
+  <Blocked>False</Blocked>
+  <EmailAddress>JohnDoe@gmail.com</EmailAddress>
+  <GeocallCLI>+4412345678</GeocallCLI>
+  <GeocallCLI>+4412345679</GeocallCLI>
+</GetUserInfo>

data/spec/fixtures/settransaction.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<!DOCTYPE Transaction>
+<Transaction>
+  <Customer>foo</Customer>
+  <Amount>1</Amount>
+  <DateTime>2013-12-29 01:22:28 (UTC)</DateTime>
+  <Result>Success</Result>
+</Transaction>

data/spec/fixtures/settransaction_failed.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<!DOCTYPE Transaction>
+<Transaction>
+  <Result>Failed</Result>
+  <Reason>Invalid format: Amount </Reason>
+</Transaction>

data/spec/fixtures/validateuser.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<!DOCTYPE ValidateUser>
+<ValidateUser>
+  <Customer>foo*provider</Customer>
+  <Result>Success</Result>
+</ValidateUser>

data/spec/helpers/faraday_stub.rb

@@ -0,0 +1,10 @@
+class Module
+  include Minitest::Spec::DSL
+end
+module FaradayStub
+  let(:faraday_adapter) { Faraday::Adapter::Test::Stubs.new }
+
+  before do
+    Bvr.connection = Bvr::Connection.new.tap{ |con| con.faraday_connection = Faraday.new{|b| b.adapter :test, faraday_adapter} }
+  end
+end

data/spec/lib/bvr/call_collection_spec.rb

@@ -0,0 +1,120 @@
+require_relative '../../spec_helper'
+require_relative "../../helpers/faraday_stub"
+
+describe Bvr::CallCollection do
+
+  describe '.find(customer_id, options={})' do
+    let(:customer_id) { 'john' }
+    let(:params) { { command: Bvr::CallCollection::API_COMMANDS[:find_by_customer_id], customer: customer_id } }
+    let(:connection) { Minitest::Mock.new }
+
+    before { Bvr.connection = connection }
+
+    subject{ Bvr::CallCollection.find_by_customer_id(customer_id) }
+
+    it 'sets the right command and the customer_id' do
+      connection.expect :get, {},  [params] #.merge({username: Bvr.config.username, password: Bvr.config.password})]
+      subject
+      connection.verify
+    end
+
+    describe 'when options are provided' do
+      let(:options) { { recordcount: 'bar', callid: 'foo' }.merge(params) }
+
+      subject{ Bvr::CallCollection.find_by_customer_id(customer_id, options) }
+
+      it 'merges the CallOverview command and the customer_id with options' do
+        connection.expect :get, {},  [options]
+        subject
+        connection.verify
+      end
+    end
+
+    describe 'when wrong options are provided' do
+      let(:options) { { foo: 'bar', john: 'Doe' }.merge(params) }
+
+      subject{ Bvr::CallCollection.find_by_customer_id(customer_id, options) }
+
+      it 'raise an ArgumentError' do
+        proc {subject}.must_raise ArgumentError
+      end
+    end
+
+    describe 'when there is a response' do
+      include FaradayStub
+
+      let(:response) do
+        File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/calloverview.xml'))
+      end
+
+      subject{ Bvr::CallCollection.find_by_customer_id(customer_id) }
+
+      before do
+        faraday_adapter.get(Bvr::Connection.uri_from_h(params)) { [200, {}, response] }
+      end
+
+      it 'created a new Bvr::CallCollection from the response' do
+        subject.must_be_instance_of Bvr::CallCollection
+      end
+
+      it 'sets the total calls' do
+        subject.count.must_equal 10
+      end
+
+      it 'can tell if there is more data' do
+        subject.next?.must_equal false
+      end
+
+      it 'sets a collection of Call' do
+        subject.collection.must_be_instance_of Array
+        subject.collection.size.must_equal 5
+      end
+    end
+
+    describe 'when there is not response' do
+      let(:connection) { Minitest::Mock.new }
+      let(:customer_id) { 'foo' }
+      let(:params) { { command: Bvr::CallCollection::API_COMMANDS[:find_by_customer_id], customer: customer_id } }
+
+      subject { Bvr::CallCollection.find_by_customer_id(customer_id) }
+
+      before do
+        Bvr.connection = connection
+      end
+
+      it 'returns empty array' do
+        connection.expect(:get, {}, [params])
+        subject.must_equal []
+        connection.verify
+      end
+    end
+  end
+
+  describe '#count' do
+    let(:raw_count) { '20' }
+    let(:call_collection) {Bvr::CallCollection.new}
+
+    subject { call_collection.count }
+
+    it 'returns the number of counts' do
+      call_collection.stub(:raw_count, raw_count) do
+        subject.must_equal Integer(raw_count)
+      end
+    end
+  end
+
+  describe '#next?' do
+    let(:raw_more_data) { 'True' }
+    let(:call_collection) {Bvr::CallCollection.new}
+
+    subject { call_collection.next? }
+
+    it 'says if there is more data' do
+      call_collection.stub(:raw_more_data, raw_more_data) do
+        subject.must_equal true
+      end
+    end
+  end
+end
+
+

data/spec/lib/bvr/call_spec.rb

@@ -0,0 +1,60 @@
+require_relative '../../spec_helper'
+
+describe Bvr::Call do
+  let(:h) do
+    customer_h = ::XmlSimple.xml_in File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/calloverview.xml'))
+    customer_h['Calls'][0]['Call'][0]
+  end
+
+  describe '.new_from_response(h)' do
+    subject { Bvr::Call.new_from_response(h) }
+
+    it 'Creates a new Call with the right params' do
+      start_time = "2013-12-24 18:05:26  (UTC)"
+      subject.must_be_instance_of Bvr::Call
+      subject.id.must_equal "1234567890"
+      subject.calltype.must_equal "PSTNOutSip"
+      subject.raw_start_time.must_equal start_time
+      subject.raw_dest.must_equal "+32123456788"
+      subject.raw_duration.must_equal "00:02:21"
+      subject.charge.must_equal "0.0705"
+    end
+  end
+
+  describe '#duration' do
+    let(:raw_duration) { '00:02:21' }
+    let(:raw_start_time)   { "2013-12-24 18:05:26  (UTC)" }
+    let(:call) { Bvr::Call.new.tap{ |call| call.raw_duration = raw_duration; call.raw_start_time = raw_start_time } }
+
+    subject { call.duration }
+
+    it 'returns the relative time duration' do
+      subject.must_be_instance_of Time
+      subject.must_equal Time.parse(raw_duration, call.start_time)
+    end
+  end
+
+  describe '#start_time' do
+    let(:raw_start_time)   { "2013-12-24 18:05:26  (UTC)" }
+    let(:call) { Bvr::Call.new.tap{ |call| call.raw_start_time = raw_start_time } }
+
+    subject { call.start_time }
+
+    it 'return the time' do
+      subject.must_be_instance_of Time
+      subject.must_equal Time.parse(raw_start_time)
+    end
+  end
+
+  describe '#dest' do
+    let(:raw_dest) { "+32123456788" }
+    let(:call) { Bvr::Call.new.tap{ |call| call.raw_dest = raw_dest } }
+
+    subject { call.dest }
+
+    it 'returns a phone' do
+      subject.must_be_instance_of Bvr::Phone
+      subject.number.must_equal raw_dest
+    end
+  end
+end

data/spec/lib/bvr/connection_spec.rb

@@ -1,4 +1,5 @@
 require_relative '../../spec_helper'
+require_relative "../../helpers/faraday_stub"
 
 describe Bvr::Connection do
   describe '.new(faraday_adapter)' do
@@ -32,36 +33,22 @@ describe Bvr::Connection do
       end
     end
 
-    before do
-      Bvr.configure do |config|
-        config.username = username
-        config.password = password
-      end
-    end
-
     subject { connection.get(params) }
 
     it 'calls connection.get with the right uri' do
         response =  Minitest::Mock.new
-        faraday_connection.expect :get, response, [connection.uri(params)]
-        response.expect :body, nil
+        faraday_connection.expect :get, response, [Bvr::Connection.uri_from_h(params)]
+        response.expect :body, ::XmlSimple.xml_out({})
         subject
         faraday_connection.verify
         response.verify
     end
-
   end
 
-  describe 'uri(queryH)' do
+  describe 'self.uri_from_h(queryH)' do
     let(:queryH) { { foo: 'bar', bar: 'foo'} }
     let(:username) { 'username' }
-    let(:faraday_connection) { Minitest::Mock.new }
     let(:password) { 'password' }
-    let(:connection) do
-      Bvr::Connection.new.tap do |connection|
-        connection.faraday_connection = faraday_connection
-      end
-    end
 
     before do
       Bvr.configure do |config|
@@ -70,7 +57,7 @@ describe Bvr::Connection do
       end
     end
 
-    subject { connection.uri(queryH) }
+    subject { Bvr::Connection.uri_from_h(queryH) }
 
     it 'match the api path' do
       subject.must_match Regexp.new(Bvr::Connection::API_PATH)

data/spec/lib/bvr/credit_spec.rb

@@ -0,0 +1,166 @@
+require_relative '../../spec_helper'
+require_relative "../../helpers/faraday_stub"
+
+describe Bvr::Credit do
+  describe '.add(customer_id, amount)' do
+    include FaradayStub
+    let(:customer_id) { 'foo' }
+    let(:amount)   { 10    }
+    let(:options) do
+      {
+        command: Bvr::Credit::API_COMMANDS[:add],
+        customer: customer_id,
+        amount: amount
+      }
+    end
+    let(:response) do
+      File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/settransaction.xml'))
+    end
+
+    subject { Bvr::Credit.add(customer_id, amount) }
+
+    before do
+      faraday_adapter.get(Bvr::Connection.uri_from_h(options)) { [200, {}, response] }
+    end
+
+    it 'returns a result' do
+      subject['Result'].must_be_instance_of String
+    end
+  end
+
+
+  describe '#add(amount)' do
+    include FaradayStub
+    let(:raw_specific_balance) { 10.12345 }
+    let(:raw_balance) { 10.12 }
+    let(:amount) { 1 }
+    let(:customer) { Bvr::Customer.new(customer_id) }
+    let(:credit)   { Bvr::Credit.new(raw_specific_balance, raw_balance, customer) }
+    let(:customer_id) { 'foo' }
+    let(:options) do
+      {
+        command: Bvr::Credit::API_COMMANDS[:add],
+        customer: customer_id,
+        amount: amount
+      }
+    end
+    let(:response) do
+      File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/settransaction.xml'))
+    end
+
+    subject { credit.add(amount) }
+
+    before do
+      faraday_adapter.get(Bvr::Connection.uri_from_h(options)) { [200, {}, response] }
+    end
+
+    it 'increase the amout' do
+      customer.stub(:id, customer_id) do
+        credit.specific_balance.must_equal raw_specific_balance
+        credit.balance.must_equal raw_balance
+
+        subject.must_equal true
+
+        credit.specific_balance.must_equal raw_specific_balance + amount
+        credit.balance.must_equal raw_balance + amount
+      end
+    end
+
+    describe 'when the amount if more than .5f' do
+      let(:amount) { 1.000001 }
+
+      it 'round up' do
+        customer.id = customer_id
+
+        credit.specific_balance.must_equal raw_specific_balance
+        credit.balance.must_equal raw_balance
+
+        subject.must_equal true
+
+        credit.specific_balance.must_equal raw_specific_balance + Float("%.5f" % amount)
+        credit.balance.must_equal          raw_balance          + Float("%.2f" % amount)
+      end
+    end
+
+    describe 'when there is an error' do
+      let(:response) do
+        File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/settransaction_failed.xml'))
+      end
+
+      it 'does not change the amout and return false' do
+        customer.stub(:id, customer_id) do
+          credit.raw_specific_balance.must_equal raw_specific_balance
+          credit.raw_balance.must_equal raw_balance
+
+          subject.must_equal false
+
+          credit.raw_specific_balance.must_equal raw_specific_balance
+          credit.raw_balance.must_equal raw_balance
+        end
+      end
+    end
+  end
+
+  describe '#rm(amount)' do
+    include FaradayStub
+    let(:raw_specific_balance) { 10.12345 }
+    let(:raw_balance) { 10.12 }
+    let(:amount) { 1 }
+    let(:customer) { Bvr::Customer.new(customer_id) }
+    let(:credit)   { Bvr::Credit.new(raw_specific_balance, raw_balance, customer) }
+    let(:customer_id) { 'foo' }
+    let(:options) do
+      {
+        command: Bvr::Credit::API_COMMANDS[:add],
+        customer: customer_id,
+        amount: - amount
+      }
+    end
+    let(:response) do
+      File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/settransaction.xml'))
+    end
+
+    subject { credit.rm(amount) }
+
+    before do
+      faraday_adapter.get(Bvr::Connection.uri_from_h(options)) { [200, {}, response] }
+    end
+
+    it 'decrease the amout' do
+      customer.stub(:id, customer_id) do
+        credit.specific_balance.must_equal raw_specific_balance
+        credit.balance.must_equal raw_balance
+
+        subject.must_equal true
+
+        credit.specific_balance.must_equal raw_specific_balance -  amount
+        credit.balance.must_equal raw_balance - amount
+      end
+    end
+
+  end
+
+  describe '#balance' do
+    let(:raw_balance) { "10.12" }
+    let(:credit) { Bvr::Credit.new(nil, raw_balance) }
+
+    subject { credit.balance }
+
+    it 'return a float out of the balance' do
+      subject.must_be_instance_of Float
+      subject.must_equal Float(raw_balance)
+    end
+  end
+
+  describe '#specific_balance' do
+    let(:raw_specific_balance) { "10.12345" }
+    let(:credit) { Bvr::Credit.new(raw_specific_balance) }
+
+    subject { credit.specific_balance }
+
+    it 'return a float out of the balance' do
+      subject.must_be_instance_of Float
+      subject.must_equal Float(raw_specific_balance)
+    end
+  end
+end