voxbone 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "savon"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "bluecloth"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.1.0)
+    builder (2.1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    gyoku (0.3.1)
+      builder (>= 2.1.2)
+    httpi (0.9.0)
+      ntlm-http (>= 0.1.1)
+      rack
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    ntlm-http (0.1.1)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    savon (0.8.6)
+      builder (>= 2.1.2)
+      crack (~> 0.1.8)
+      gyoku (>= 0.3.0)
+      httpi (>= 0.7.8)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)
+  savon
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jason Goecke
+
+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,99 @@
+Voxbone
+=======
+
+Ruby gem for consuming the [Voxbone SOAP API](http://voxbone.com/APIGettingStarted.jsf).
+
+Installation
+------------
+
+	gem install voxbone
+
+Example
+-------
+
+[API Docs](http://jsgoecke.github.com/voxbone)
+
+	require 'rubygems'
+	require 'voxbone'
+	voxbone = Voxbone.new(:username   => 'test', 
+	                      :password   => 'test')
+	voxbone.get_countries_list(:type => 'GEOGRAPHIC')
+
+Returns (using awesome_print gem):
+
+	{
+	    :get_countries_list_response => {
+	        :array_of_countries => {
+	            :country => [
+	                [ 0] {
+	                    :country_name => "ARGENTINA",
+	                    :country_code => "54",
+	                      :country_id => "10",
+	                      :has_states => false,
+	                         :code_a2 => "AR"
+	                },
+	                [ 1] {
+	                    :country_name => "AUSTRALIA",
+	                    :country_code => "61",
+	                      :country_id => "13",
+	                      :has_states => false,
+	                         :code_a2 => "AU"
+	                }	
+               	]
+	        },
+	    :xmlns => "http://www.voxbone.com/VoxAPI"
+	    }
+	}
+
+Available Methods
+-----------------
+
+Full details of available methods [here](http://sourceforge.net/apps/mediawiki/voxbone-client/index.php?title=VoxAPI.Methods).
+
+	[ 0] :place_order_for_lock
+	[ 1] :remove_did_from_capacity_group
+	[ 2] :create_address_for_regulation
+	[ 3] :configure_dnis
+	[ 4] :configure_cpc
+	[ 5] :remove_di_ds_from_trunk
+	[ 6] :link_dids_to_address
+	[ 7] :get_purchase_info_data
+	[ 8] :get_trunk_list
+	[ 9] :map_did_to_capacity_group
+	[10] :get_order_status
+	[11] :cancel_did
+	[12] :get_regulation_address_list
+	[13] :get_did_group_purchase_lock
+	[14] :place_di_ds_on_trunk
+	[15] :configure_codecs
+	[16] :create_capacity_group
+	[17] :get_capacity_group_list
+	[18] :place_di_ds_order
+	[19] :get_di_ds_info
+	[20] :map_did
+	[21] :delete_capacity_group
+	[22] :get_features_list
+	[23] :configure_dtmf_mode
+	[24] :get_did_group_list
+	[25] :is_purchase_info_valid
+	[26] :purchase_tollfree_credit
+	[27] :get_did_group_pricing
+	[28] :get_pop_list
+	[29] :request_address_verification
+	[30] :limit_did_channels
+	[31] :get_states_list
+	[32] :configure_t38
+	[33] :delete_regulation_address
+	[34] :get_countries_list
+	[35] :get_did_group_info
+	[36] :update_capacity_group
+	[37] :get_tollfree_credit_package_list
+	[38] :map_did_checking_status
+	[39] :update_delivery
+	[40] :get_account_balance
+
+Copyright
+---------
+
+Copyright (c) 2011 Jason Goecke. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "voxbone"
+  gem.homepage = "http://github.com/jsgoecke/voxbone"
+  gem.license = "MIT"
+  gem.summary = "Library for the Voxbone API"
+  gem.description = "Ruby library wrapping the Voxbone SOAP API"
+  gem.email = "jason@goecke.net"
+  gem.authors = ["Jason Goecke"]
+  gem.add_runtime_dependency 'savon'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/example.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'awesome_print'
+require 'lib/voxbone'
+
+voxbone = Voxbone.new(:username   => 'test', 
+                      :password   => 'test',
+                      :base_uri   => 'http://sandbox.voxbone.com/VoxAPI/services/VoxAPI?wsdl',
+                      :log_level  => :debug)
+
+ap voxbone.get_countries_list(:type => 'GEOGRAPHIC')

data/lib/voxbone.rb

@@ -0,0 +1,2 @@
+$: << File.expand_path(File.dirname(__FILE__))
+%w(savon digest/sha1 voxbone/voxbone).each { |lib| require lib }

data/lib/voxbone/voxbone.rb

@@ -0,0 +1,106 @@
+class Voxbone
+  attr_reader :methods
+  
+  ##
+  # Instantiate a Voxbone object
+  #
+  # @param [required, Hash] params 
+  # @option params [required, String] :username for your Voxbone account
+  # @option params [required, String] :password for your Voxbone password
+  # @option params [optional, String] :base_uri for using an alternative URI, such as the Voxbone sandbox
+  # @option params [optional, String] :log_level for changing the Savon log levels
+  # @return [Object] the instantiated Voxbone object
+  # @raise ArgumentError when the :username or :password is not present
+  # @example Instantiate a Voxbone object
+  #   require 'rubygems'
+  #   require 'voxbone'
+  #   voxbone = Voxbone.new(:username   => 'test', 
+  #                         :password   => 'test')
+  def initialize(params)
+    raise ArgumentError, ":username required" if params[:username].nil?
+    raise ArgumentError, ":password required" if params[:password].nil?
+    
+    config_savon(params)
+    @user_token = create_user_token(params)
+    
+    @client = Savon::Client.new do
+      wsdl.document  = params[:base_uri] || 'http://www.voxbone.com/VoxAPI/services/VoxAPI?WSDL'
+      wsdl.namespace = 'http://www.voxbone.com/VoxAPI'
+    end
+    
+    @methods = @client.wsdl.soap_actions
+  end
+  
+  ##
+  # Provides the dispatcher to the available SOAP methods defined in the WSDL
+  #
+  # @param [required, Symbol] the method name to invoke on the SOAP API
+  # @param [optional, Hash] the parameters to pass to the method, should be symbols and may be all lowercase with underscores
+  # @return [Hash] containing the results of the SOAP call
+  # @raise NoMethodError if the method requested is not defined in the WSDL
+  # @example Retrieve a country list
+  #   voxbone.get_countries_list(:type => 'GEOGRAPHIC')
+  def method_missing(method_name, params={})
+    if @methods.include? method_name
+      response = @client.request :vox, method_name do
+        prepare_soap(soap, capitalize_params(params))
+      end
+      response.to_hash
+    else
+      raise NoMethodError, "The method #{method_name.to_s} does not exist."
+    end
+  end
+  
+  private 
+  
+  ##
+  # Configures Savon
+  #
+  # @param [required, Hash] params 
+  # @option params [optional, String] :log_level to set for Savon
+  def config_savon(params)
+    Savon.configure do |config|
+      if params[:log_level]
+        config.log = true
+        config.log_level = params[:log_level]
+      else
+        config.log = false
+      end
+    end
+  end
+  
+  ##
+  # Builds the user token required by the Voxbone SOAP API
+  #
+  # @param [required, Hash] params 
+  # @option params [required, String] :username for your Voxbone account
+  # @option params [required, String] :password for your Voxbone password
+  # @return [Hash] the user token
+  def create_user_token(params)
+    key = Time.now.strftime("%Y-%m-%d %H:%M:%S:") + '%012d' % rand(10_000_000_000)
+    { :User_token => { :Username => params[:username],
+                       :Key      => key,
+                       :Hash     => Digest::SHA1.hexdigest(params[:password] + key) } }
+  end
+  
+  ##
+  # Builds the SOAP body for Savon
+  #
+  # 
+  # @param [required, Object] the Savon SOAP object
+  # @param [required, Hash] params used to invoke the SOAP method
+  def prepare_soap(soap, params)
+    soap.body = params.merge(@user_token)
+  end
+  
+  ##
+  # Capitalize all of the attributes in a hash
+  #
+  # @param [required, Hash] params 
+  # @return [Hash] with keys capitalized
+  def capitalize_params(params)
+    new_params= {}
+    params.each { |k,v| new_params[k.to_s.capitalize.to_sym] = v }
+    new_params
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'voxbone'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/voxbone_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Voxbone" do
+  before(:each) do
+    # You will need to set the username/password to valid ones in order to run a test
+    @voxbone = Voxbone.new({ :username  => 'test', 
+                             :password  => 'test',
+                             :log_level => :debug,
+                             :base_uri  => 'http://sandbox.voxbone.com/VoxAPI/services/VoxAPI?wsdl' })
+  end
+  
+  it "should instantiate a Voxbone class" do
+    @voxbone.instance_of?(Voxbone).should == true
+  end
+  
+  it "should raise a no method error if an unknown method is called" do
+    begin
+      @voxbone.foobar
+    rescue => error
+      error.class.should == NoMethodError
+      error.to_s.should  == "The method foobar does not exist."
+    end
+  end
+  
+  it "should get the trunk list" do
+    trunks = @voxbone.get_trunk_list
+    trunks[:get_trunk_list_response].nil?.should == false
+  end
+  
+  it "should return a list of countries based on geography" do
+    countries = @voxbone.get_countries_list(:type => 'GEOGRAPHIC')
+    countries[:get_countries_list_response][:array_of_countries][:country].nil?.should == false
+  end
+  
+  it "should create a capacity group" do
+    result = @voxbone.create_capacity_group(:name_capacity_group => 'Foobar', :capacity => '100')
+    result[:create_capacity_group_response][:capacity_group][:name].should == 'Foobar'
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification 
+name: voxbone
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Goecke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: savon
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: bluecloth
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: savon
+  version_requirements: *id008
+  prerelease: false
+description: Ruby library wrapping the Voxbone SOAP API
+email: jason@goecke.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- examples/example.rb
+- lib/voxbone.rb
+- lib/voxbone/voxbone.rb
+- spec/spec_helper.rb
+- spec/voxbone_spec.rb
+has_rdoc: true
+homepage: http://github.com/jsgoecke/voxbone
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Library for the Voxbone API
+test_files: 
+- examples/example.rb
+- spec/spec_helper.rb
+- spec/voxbone_spec.rb