bvr 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'minitest', '~> 4.7.5'
+  gem 'guard'
+  gem 'guard-minitest'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem 'turn'
+end
+# Specify your gem's dependencies in bvr.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :minitest do
+  ## with Minitest::Unit
+  #watch(%r{^test/(.*)\/?test_(.*)\.rb})
+  #watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r{^test/test_helper\.rb})      { 'test' }
+
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 gregory
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Bvr
+
+The BestVoipReselling Ruby Gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bvr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bvr
+
+## Usage
+
+### Configuration
+`
+Bvr.configure do |config|
+  config.username, config.password = ['username', 'password']
+end
+`
+### Retreiving Call Overview
+`
+Bvr::CallOverview.find('a customer id')
+`
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bvr.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bvr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bvr"
+  spec.version       = Bvr::VERSION
+  spec.authors       = ["gregory"]
+  spec.email         = ["greg2502@gmail.com"]
+  spec.description   = %q{A ruby interface to Bestvoipreselling API}
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "happymapper"
+end

data/lib/bvr.rb

@@ -0,0 +1,16 @@
+require 'happymapper'
+Dir[File.dirname(__FILE__) + '/bvr/*.rb'].each{ |file| require file }
+
+module Bvr
+  extend self
+
+  attr_accessor :config, :connection
+
+  def configure
+    @config = Bvr::Configuration.new.tap{ |configuration| yield(configuration) }
+  end
+
+  def connection
+    @connection ||= Bvr::Connection.new
+  end
+end

data/lib/bvr/call.rb

@@ -0,0 +1,18 @@
+require_relative 'phone'
+module Bvr
+  class Call
+    include HappyMapper
+
+    tag 'Call'
+    attribute :id, String, tag: 'CallId'
+    attribute :calltype, String, tag: 'CallType'
+    attribute :start_time, Time, tag: 'StartTime'
+    attribute :dest, Phone, tag: 'Destination', parser: :phone_number_parser
+    attribute :duration, String, tag: 'Duration'
+    attribute :charge, String, tag: 'Charge' #? currency
+
+    def relative_duration
+      Time.parse(self.duration, start_time)
+    end
+  end
+end

data/lib/bvr/call_overview.rb

@@ -0,0 +1,46 @@
+require_relative 'call'
+module Bvr
+  class CallOverview
+    API_COMMAND = 'CallOverview'
+    # Valid Options:
+    #  Variable  Value Option  Description
+    #  command calloverview  Mandatory
+    #  username  X..140  Mandatory the username of the reseller
+    #  password  X..100  Mandatory the password of the reseller
+    #  customer  X..140  Mandatory the username of the customer
+    #  date  YYYY-MM-DD hh:nn:ss Optional  the datetime from which to start retrieving the history, current datetime is default
+    #  callid  N..1000000  Optional  the callid from which to start retrieving the history, 0 is default
+    #  recordcount 1 - 500 Optional  the maximum number of records returned, 10 is default, 500 is maximum
+    #  direction forward / backward  Optional  the direction to search, backward is default
+    VALID_OPTIONS = [:date, :callid, :recordcount, :direction]
+
+    include ::HappyMapper
+
+    tag 'Calls'
+    has_many :calls, Bvr::Call
+    attribute :count, Integer, tag: 'Count'
+
+
+    def self.find(customer_id, options={})
+      raise ArgumentError.new('Unknown Argument') unless self.valid_options?(options)
+
+      params = {
+        command: API_COMMAND,
+        customer: customer_id
+      }
+
+      options.merge! params
+      self.parse(self.result(options)).first #only one <Calls> tag
+    end
+
+  private
+
+    def self.result(options)
+      Bvr.connection.get(options)
+    end
+
+    def self.valid_options?(options)
+      options.empty? ? true : options.keys.all? { |option| VALID_OPTIONS.include? option}
+    end
+  end
+end

data/lib/bvr/configuration.rb

@@ -0,0 +1,3 @@
+module Bvr
+  class Configuration < Struct.new(:username, :password); end
+end

data/lib/bvr/connection.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+require 'rack'
+
+module Bvr
+  class Connection
+    BASE_URI = 'https://www.voipinfocenter.com'
+    API_PATH = '/API/Request.ashx?'
+
+    attr_accessor :faraday_connection
+
+    def initialize(faraday_adapter=Faraday.default_adapter)
+      @faraday_connection = Faraday.new(url: self.base_uri) do |faraday|
+        faraday.response :logger
+        faraday.adapter faraday_adapter
+      end
+    end
+
+    def base_uri
+      BASE_URI
+    end
+
+    def get(params)
+      #TODO: prase body for 500
+      self.faraday_connection.get(uri(params)).body
+    end
+
+    def uri(queryH)
+      params = {
+        username: Bvr.config.username,
+        password: Bvr.config.password
+      }
+      queryH.merge! params
+      "#{API_PATH}#{::Rack::Utils.build_query queryH}"
+    end
+  end
+end

data/lib/bvr/phone.rb

@@ -0,0 +1,13 @@
+module Bvr
+  class Phone
+    attr_accessor :number
+
+    def initialize(phone_number)
+      @number = phone_number
+    end
+
+    def self.phone_number_parser(phone_number)
+      self.new(phone_number)
+    end
+  end
+end

data/lib/bvr/version.rb

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

data/spec/fixtures/CallOverview.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!DOCTYPE CallOverview>
+<CallOverview>
+  <Calls Count="10">
+    <Call CallType="PSTNOutSip" Customer="this account" StartTime="2013-12-24 18:05:26  (UTC)" Destination="+32123456788" Duration="00:02:21" Charge="0.0705" CallId="1234567890" />
+    <Call CallType="PSTNOutSip" Customer="this account" StartTime="2013-12-24 18:05:14  (UTC)" Destination="+49123456789" Duration="00:02:41" Charge="0.10734" CallId="1234567891" />
+    <Call CallType="PSTNOutSip" Customer="this account" StartTime="2013-12-01 23:02:38  (UTC)" Destination="+49123456790" Duration="00:00:20" Charge="0.01334" CallId="1234567892" />
+    <Call CallType="PSTNOutSip" Customer="this account" StartTime="2013-12-01 22:59:01  (UTC)" Destination="+49123456791" Duration="00:00:15" Charge="0.01" CallId="1234567893" />
+    <Call CallType="PSTNOutSip" Customer="this account" StartTime="2013-10-29 11:30:18  (UTC)" Destination="+49123456792" Duration="00:00:15" Charge="0.01" CallId="1234567894" />
+  </Calls>
+  <MoreData>False</MoreData>
+</CallOverview>

data/spec/lib/bvr/call_overview_spec.rb

@@ -0,0 +1,94 @@
+require_relative '../../spec_helper'
+
+describe Bvr::CallOverview do
+  describe '.find(customer_id, options)' do
+    let(:customer_id) { 'john' }
+    let(:connection)      { Minitest::Mock.new }
+    let(:body)        { 'response' }
+
+    def stub_connection
+      Bvr.stub(:connection, connection) { yield }
+    end
+
+    def stub_result(res)
+      Bvr::CallOverview.stub(:result, res) { yield }
+    end
+
+    def stub_parse(result)
+      Bvr::CallOverview.stub(:parse, result) { yield }
+    end
+
+    describe 'when options are omitted' do
+      subject{ Bvr::CallOverview.find(customer_id) }
+
+      it 'sets the right command and the customer_id' do
+        stub_connection do
+          stub_parse([]) do
+            connection.expect :get, [],  [{command: Bvr::CallOverview::API_COMMAND, customer: customer_id}]
+            subject
+            connection.verify
+          end
+        end
+      end
+    end
+
+    describe 'when options are provided, it merges the options with the command and customer_id' do
+      let(:options) { { recordcount: 'bar', callid: 'foo' } }
+
+      subject{ Bvr::CallOverview.find(customer_id, options) }
+
+      it 'merges the CallOverview command and the customer_id with options' do
+        stub_connection do
+          stub_parse([]) do
+            expected_options = options.merge({command: Bvr::CallOverview::API_COMMAND, customer: customer_id})
+            connection.expect :get, [],  [expected_options]
+            subject
+            connection.verify
+          end
+        end
+      end
+    end
+
+    describe 'when wrong options are provided, raise an argument error' do
+      let(:options) { { foo: 'bar', john: 'Doe' } }
+
+      subject{ Bvr::CallOverview.find(customer_id, options) }
+
+      it 'merges the CallOverview command and the customer_id with options' do
+        expected_options = options.merge({command: Bvr::CallOverview::API_COMMAND, customer: customer_id})
+        proc {subject}.must_raise ArgumentError
+      end
+    end
+
+
+    describe 'when there is a response' do
+      let(:response) do
+        File.read(File.join(File.dirname(__FILE__), '/..', '/..', '/fixtures/CallOverview.xml'))
+      end
+
+      subject{ Bvr::CallOverview.find(customer_id) }
+
+      it 'parse the response to objects' do
+        stub_result(response) do |connection|
+          subject.must_be_instance_of Bvr::CallOverview
+          subject.calls.size.must_equal 5
+          subject.count.must_equal 10
+
+          subject.calls[0].tap do |call|
+            start_time = Time.parse("2013-12-24 18:05:26  (UTC)")
+            call.id.must_equal "1234567890"
+            call.calltype.must_equal "PSTNOutSip"
+            call.start_time.must_equal start_time
+            call.dest.must_be_instance_of Bvr::Phone
+            call.dest.number.must_equal "+32123456788"
+            call.duration.must_equal "00:02:21"
+            call.relative_duration.must_equal Time.parse("00:02:21", start_time)
+            call.charge.must_equal "0.0705"
+          end
+        end
+      end
+    end
+  end
+end
+
+

data/spec/lib/bvr/configuration_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../../spec_helper'
+
+describe Bvr::Configuration do
+  describe '.new' do
+    subject{ Bvr::Configuration.new(username, password) }
+
+    let(:username) { 'foo' }
+    let(:password) { 'bar' }
+
+    it 'has username and password accessor' do
+      subject.username.must_equal username
+      subject.password.must_equal password
+    end
+  end
+end

data/spec/lib/bvr/connection_spec.rb

@@ -0,0 +1,95 @@
+require_relative '../../spec_helper'
+
+describe Bvr::Connection do
+  describe '.new(faraday_adapter)' do
+    let(:default_faraday_adapter) { Faraday::Adapter::NetHttp }
+    subject{ Bvr::Connection.new }
+
+    it 'returns a Faraday::Connection with the nethttp adapter' do
+      subject.faraday_connection.must_be_instance_of Faraday::Connection
+      subject.faraday_connection.builder.handlers.must_include default_faraday_adapter
+    end
+  end
+
+  describe 'base_uri' do
+    subject{ Bvr::Connection.new.base_uri }
+    let(:base_uri) { 'https://www.voipinfocenter.com' }
+
+    it "returns the base_uri of the api" do
+      subject.must_equal base_uri
+    end
+  end
+
+
+  describe 'get(params)' do
+    let(:params) { {foo: 'bar'} }
+    let(:faraday_connection) { Minitest::Mock.new }
+    let(:username) { 'username' }
+    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|
+        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
+        subject
+        faraday_connection.verify
+        response.verify
+    end
+
+  end
+
+  describe 'uri(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|
+        config.username = username
+        config.password = password
+      end
+    end
+
+    subject { connection.uri(queryH) }
+
+    it 'match the api path' do
+      subject.must_match Regexp.new(Bvr::Connection::API_PATH)
+    end
+
+    it 'transform queryH to valid GET params' do
+      subject.must_match Regexp.new("foo=#{queryH[:foo]}&bar=#{queryH[:bar]}")
+    end
+
+    it 'contain username and password from the config' do #This is pretty bad :(
+      subject.must_match Regexp.new("username=#{username}&password=#{password}")
+    end
+
+    describe 'when username and password are passed in the H' do
+      let(:queryH) { {username: 'foo', password: 'bar'} }
+
+      it 'overwrite username and password params' do
+        subject.must_match Regexp.new("username=#{username}&password=#{password}")
+      end
+    end
+  end
+end

data/spec/lib/bvr_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../spec_helper'
+
+describe Bvr do
+  subject { Bvr }
+
+  describe '.configure' do
+    let(:username) { 'foo' }
+    let(:password) { 'bar' }
+
+    before do
+      subject.configure do |config|
+        config.username = username
+        config.password = password
+      end
+    end
+
+    it 'has a username and password' do
+      subject.config.username.must_equal username
+      subject.config.password.must_equal password
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:test)
+
+require_relative '../lib/bvr'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+Turn.config do |c|
+  c.format  = :outline
+  c.natural = true
+end
+
+MiniTest::Spec.before :each do
+  Bvr.configure do |config|
+    config.username = 'default_username'
+    config.password = 'default_password'
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: bvr
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- gregory
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  name: bundler
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rack
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: faraday
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: happymapper
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: A ruby interface to Bestvoipreselling API
+email:
+- greg2502@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bvr.gemspec
+- lib/bvr.rb
+- lib/bvr/call.rb
+- lib/bvr/call_overview.rb
+- lib/bvr/configuration.rb
+- lib/bvr/connection.rb
+- lib/bvr/phone.rb
+- lib/bvr/version.rb
+- spec/fixtures/CallOverview.xml
+- spec/lib/bvr/call_overview_spec.rb
+- spec/lib/bvr/configuration_spec.rb
+- spec/lib/bvr/connection_spec.rb
+- spec/lib/bvr_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A ruby interface to Bestvoipreselling API
+test_files:
+- spec/fixtures/CallOverview.xml
+- spec/lib/bvr/call_overview_spec.rb
+- spec/lib/bvr/configuration_spec.rb
+- spec/lib/bvr/connection_spec.rb
+- spec/lib/bvr_spec.rb
+- spec/spec_helper.rb
+has_rdoc: