bandwidth 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,13 @@
+source "http://rubygems.org"
+gem "savon"
+gem "hashie"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+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"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    gyoku (0.3.1)
+      builder (>= 2.1.2)
+    hashie (1.0.0)
+    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
+  bundler (~> 1.0.0)
+  hashie
+  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,96 @@
+Bandwidth
+=========
+
+Ruby gem for consuming the [Bandwidth REST API](https://my.bandwidth.com/portal/apidoc/welcome.htm).
+
+Installation
+------------
+
+	gem install bandwidth
+
+Example
+-------
+
+[API Docs](http://jsgoecke.github.com/bandwdith)
+
+	require 'rubygems'
+	require 'bandwidth'
+	bandwidth = Bandwidth.new(:developer_key => 'your developer key')
+	bandwidth.area_code_number_search :area_code => '720', :max_quantity => 1
+
+Returns (using awesome_print gem):
+
+	{
+	       "body" => {
+	        "numberSearchResponse" => {
+	                   "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+	                    "quantity" => "1",
+	                   "requestID" => "463f5cd2-e75d-4cc2-9ab1-1235a3dd283c",
+	                "dateTimeSent" => "2011-03-18 19:48:04Z",
+	                    "warnings" => nil,
+	                      "errors" => nil,
+	                   "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+	            "telephoneNumbers" => {
+	                "telephoneNumber" => {
+	                               "e164" => "+17205551212",
+	                             "npaNxx" => "720555",
+	                           "tenDigit" => "7205551212",
+	                    "formattedNumber" => "1-720-555-1212",
+	                           "numberID" => "6f37a640-0d9d-45cc-b97b-d6ad77f220b2",
+	                             "status" => "Available",
+	                         "rateCenter" => {
+	                         "name" => "DENVERSLVN",
+	                         "lata" => "656",
+	                        "state" => "CO"
+	                    }
+	                }
+	            },
+	                     "message" => "Successfully executed specified number search.",
+	                      "status" => "success",
+	                       "xmlns" => "http://www.bandwidth.com/api/"
+	        }
+	    },
+	       "code" => 200,
+	    "headers" => {
+	              "X-Powered-By" => "Bandwidth.com",
+	        "X-API-SupportEmail" => "apifeedback@bandwidth.com",
+	              "Content-Type" => "text/xml; charset=utf-8",
+	                      "Date" => "Fri, 18 Mar 2011 19:48:04 GMT",
+	            "Content-Length" => "825",
+	                    "Server" => "Microsoft-IIS/7.0",
+	             "Cache-Control" => "private",
+	          "X-AspNet-Version" => "2.0.50727"
+	    }
+	}
+
+Available Methods
+-----------------
+
+Full details of available methods [here](https://my.bandwidth.com/portal/apidoc/2-x-supported-operations.htm).
+
+	[2.x] Supported Operations, Numbers - getTelephoneNumber
+	[2.x] Supported Operations, Numbers - getNumberOrder
+	[2.x] Supported Operations, Numbers - getNumberOrders (developer, account)
+	[2.x] Supported Operations, Numbers - areaCodeNumberSearch
+	[2.x] Supported Operations, Numbers - npaNxxNumberSearch
+	[2.x] Supported Operations, Numbers - rateCenterNumberSearch
+	[2.x] Supported Operations, Numbers - rateCenterNumberOrder
+	[2.x] Supported Operations, Numbers - tollfreeNumberSearch
+	[2.x] Supported Operations, Numbers - tollfreeNumberOrder
+	[2.x] Supported Operations, Numbers - basicNumberOrder
+	[2.x] Supported Operations, Numbers - changeNumber
+	[2.x] Supported Operations, Numbers - sipTrunkOrder
+	[2.x] Supported Operations, Cdr - getCdrArchive
+	(restricted use)
+	[2.x] Restricted Operations, Numbers - consumedNumbers
+	[2.x] Restricted Operations, Numbers - reserveNumbers
+	[2.x] Restricted Operations, Numbers - pbod
+	[2.x] Restricted Operations, Numbers - rateCenterBlockOrder
+	[2.x] Restricted Operations, Numbers - getRateCenterBlockOrder
+	[2.x] Restricted Operations, Numbers - getRateCenterBlockOrders
+
+Copyright
+---------
+
+Copyright (c) 2011 Jason Goecke. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,38 @@
+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 = "bandwidth"
+  gem.homepage = "http://github.com/jsgoecke/bandwidth"
+  gem.license = "MIT"
+  gem.summary = 'Ruby gem for consuming the Bandwidth REST API.'
+  gem.description = 'More detail here: https://my.bandwidth.com/portal/apidoc/welcome.htm'
+  gem.email = "jason@goecke.net"
+  gem.authors = ["Jason Goecke"]
+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,7 @@
+require 'rubygems'
+require 'lib/bandwidth'
+require 'awesome_print'
+
+bandwidth = Bandwidth.new(:developer_key   => 'your developer key', :use_lab_uris => true)
+
+ap bandwidth.area_code_number_search :area_code => '720', :max_quantity => 1

data/lib/bandwidth.rb

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

data/lib/bandwidth/bandwidth.rb

@@ -0,0 +1,127 @@
+class Bandwidth 
+  # Available REST API methods
+  API_METHODS = [ :get_telephone_number,
+                  :get_number_order,
+                  :get_number_orders,
+                  :area_code_number_search,
+                  :npa_nxx_number_search,
+                  :rate_center_number_search,
+                  :rate_center_number_order,
+                  :tollfree_number_search,
+                  :basic_number_order,
+                  :change_number,
+                  :sip_trunk_order,
+                  :consumed_numbers,
+                  :reserve_numbers,
+                  :pbod,
+                  :rate_center_block_order,
+                  :get_rate_center_block_order,
+                  :get_rate_center_block_orders,
+                  :get_cdr_archive ]
+
+  ##
+  # Instantiate a Bandwdith object
+  #
+  # @param [required, Hash] params 
+  # @option params [required, String] :developer_key assigned to you by Bandwidth
+  # @option params [optional, Boolean] :processing_type whether to 'process' the request or only 'validate', default is 'process'
+  # @option params [optional, Symbol] :log_level which level to set the logging at, off by default
+  # @option params [optional, Boolean] :use_lab_uris if true, will use the Bandwidth Lab URIs rather than production
+  # @return [Object] the instantiated Bandwdith object
+  # @raise ArgumentError when the :developer_key is not present
+  # @example Instantiate a Bandwdith object
+  #   require 'rubygems'
+  #   require 'bandwidth'
+  #   bandwdith = Bandwidth.new(:developer_key => 'test')
+  def initialize(params)
+    raise ArgumentError, ":developer_key required" if params[:developer_key].nil?      
+    
+    if params[:log_level]
+      HTTPI.log_level = params[:log_level]
+    else
+      HTTPI.log = false
+    end
+    
+    @use_labs_uris   = params[:use_lab_uris] || false
+    @developer_key   = params[:developer_key]
+    @numbers_request = create_request(:numbers, params)
+    @cdrs_request    = create_request(:cdrs, params)
+  end
+  
+  ##
+  # Provides the dispatcher to the available REST methods on the Bandwidth API
+  #
+  # @param [required, Symbol] the method name to invoke on the REST API
+  # @param [optional, Hash] the parameters to pass to the method, should be symbols and may be all lowercase with underscores or camelCase
+  # @return [Hashie::Mash Object] containing the results of the REST call
+  # @raise NoMethodError if the method requested is not defined in the API_METHODS constant
+  # @example Retrieve numbers available in an area code
+  #   bandwidth.area_code_number_search :area_code => '720', :max_quantity => 10
+  def method_missing(method_name, params={})
+    raise NoMethodError, "The method #{method_name.to_s} does not exist." if API_METHODS.include?(method_name) == false
+    
+    if method_name == :get_cdr_archive
+      @cdrs_request.body = Gyoku.xml({ method_name => params.merge({ :developer_key => @developer_key }),
+                                          :attributes! => xml_namespaces(method_name) })
+                                                                   
+      response = HTTPI.post @cdrs_request
+    else
+      @numbers_request.body = Gyoku.xml({ method_name => params.merge({ :developer_key => @developer_key }),
+                                          :attributes! => xml_namespaces(method_name) })
+                                                                   
+      response = HTTPI.post @numbers_request
+    end
+    
+    Hashie::Mash.new({ :code    => response.code,
+                       :body    => Crack::XML.parse(response.raw_body),
+                       :headers => response.headers })
+  end
+  
+  private
+  
+  ##
+  # Creates the request
+  #
+  # @param [required, Symbol] type indicates if it is to create a :numbers request or a :cdrs request
+  # @param [required, Hash] params to build the request with
+  # @return [Object] the resulting request object
+  def create_request(type, params)
+    request = HTTPI::Request.new
+    
+    # Right now Bandwidth's Lab does not support SSL, but their production does
+    if @use_labs_uris != true
+      request.ssl                  = true
+      request.auth.ssl.verify_mode = :none
+    end
+    
+    request.headers = { 'Content-Type'                     => 'text/xml',
+                        'X-BWC-IN-Control-Processing-Type' => params[:processing_type] || 'process' }
+    
+    if type == :numbers
+      if @use_labs_uris == true
+        request.url = 'http://labs.bandwidth.com/api/public/v2/numbers.api'
+      else
+        request.url = 'https://api.bandwidth.com/public/v2/numbers.api'
+      end
+    elsif type == :cdrs
+      if @use_labs_uris == true
+        request.url = 'http://labs.bandwidth.com/api/public/v2/cdrs.api'
+      else
+        request.url = 'https://api.bandwidth.com/public/v2/cdrs.api'
+      end
+    end
+    
+    request
+  end
+  
+  ##
+  # Provides the required XML namespace details for the Bandwidth API
+  #
+  # @param [required, Symbol] method_name to add the XML namespace details to
+  # @return [Hash] the resulting XML namespace attributes
+  def xml_namespaces(method_name)
+    { method_name => { 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                                       'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                                       'xmlns'     => 'http://www.bandwidth.com/api/' } }
+  end
+end

data/spec/bandwidth_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Bandwidth" do
+  before(:each) do
+    # You will need to set the developer_key to a valid one from Bandwidth in order to run a test
+    @bandwidth = Bandwidth.new({ :developer_key => 'your developer key',
+                                 :use_lab_uris  => true,
+                                 :log_level     => :debug })
+  end
+  
+  describe "numbers" do
+    it "should instantiate a Bandwidth::Numbers class" do
+      @bandwidth.instance_of?(Bandwidth).should == true
+    end
+    
+    it "should raise a no method error if an unknown method is called" do
+      begin
+        @bandwidth.foobar
+      rescue => error
+        error.class.should == NoMethodError
+        error.to_s.should  == "The method foobar does not exist."
+      end
+    end
+        
+    it "should get a response when searching for area codes" do
+      result = @bandwidth.area_code_number_search :area_code => '720', :max_quantity => 10
+      result[:body]['numberSearchResponse'].nil?.should == false 
+    end
+    
+    it "should get a response when searching for area codes when params passed as camelCase too" do
+      result = @bandwidth.area_code_number_search :areaCode => '720', :maxQuantity => 10
+      result[:body]['numberSearchResponse'].nil?.should == false 
+    end
+    
+    it "should return the result body as a Hashie::Mash class" do
+      result = @bandwidth.area_code_number_search :area_code => '720', :max_quantity => 10
+      result[:body].instance_of?(Hashie::Mash).should == true
+    end
+    
+    it "should get a response when searching by area code and prefix (aka - NPA and NXX)" do
+      result = @bandwidth.npa_nxx_number_search(:npa_nxx => '720263')
+      result[:body][:numberSearchResponse].nil? == false
+    end
+    
+    it "should get a response when searching for a toll free number" do
+      result = @bandwidth.tollfree_number_search :max_quantity => 10
+      result.body.numberSearchResponse.nil?.should == false
+    end
+    
+    it "should get a response when retrieving for a number order" do
+      result = @bandwidth.get_number_order(:get_type => 'orderID', :get_value => 'C2594E54-015A-4D4E-81A8-F05B76610877')
+      result.body.getResponse.nil?.should == false
+    end
+  end
+  
+  describe "cdrs" do
+    it "should get a resopnse when retrieving cdrs" do
+      pending('It appears Bandwidth has not provided access to this just yet.')
+      result = @bandwidth.get_cdr_archive(:get_type => 'Daily', :get_value => '20110221')
+      result.should == nil
+    end
+  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 'bandwidth'
+
+# 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

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: bandwidth
+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-18 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: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: hashie
+  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: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  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: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  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: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  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: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  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: rcov
+  version_requirements: *id007
+  prerelease: false
+description: "More detail here: https://my.bandwidth.com/portal/apidoc/welcome.htm"
+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/bandwidth.rb
+- lib/bandwidth/bandwidth.rb
+- spec/bandwidth_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jsgoecke/bandwidth
+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: Ruby gem for consuming the Bandwidth REST API.
+test_files: 
+- examples/example.rb
+- spec/bandwidth_spec.rb
+- spec/spec_helper.rb