bandwidth 0.0.3 → 0.0.4

data/Gemfile

@@ -1,6 +1,8 @@
 source "http://rubygems.org"
-gem "savon"
+gem "nokogiri"
+gem "crack"
 gem "hashie"
+gem "httpi"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -1,12 +1,9 @@
 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)
@@ -15,6 +12,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    nokogiri (1.4.4)
     ntlm-http (0.1.1)
     rack (1.2.1)
     rake (0.8.7)
@@ -27,11 +25,6 @@ GEM
     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
@@ -39,9 +32,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0.0)
+  crack
   hashie
+  httpi
   jeweler (~> 1.5.2)
+  nokogiri
   rcov
   rspec (~> 2.3.0)
-  savon
   yard (~> 0.6.0)

data/README.md

@@ -89,6 +89,11 @@ Full details of available methods [here](https://my.bandwidth.com/portal/apidoc/
 	[2.x] Restricted Operations, Numbers - getRateCenterBlockOrder
 	[2.x] Restricted Operations, Numbers - getRateCenterBlockOrders
 
+Notes
+-----
+
+When calling the 'basic_number_order' method, be sure to use ':number_IDs' & ':ext_ref_ID' as the correct options, given that the Bandwidth API is not following camelCase standards in this case.
+
 Copyright
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bandwidth.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bandwidth}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "examples/example.rb",
     "lib/bandwidth.rb",
     "lib/bandwidth/bandwidth.rb",
+    "lib/bandwidth/string_patch.rb",
     "spec/bandwidth_spec.rb",
     "spec/spec_helper.rb"
   ]
@@ -47,16 +48,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<savon>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<crack>, [">= 0"])
       s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<httpi>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<savon>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<crack>, [">= 0"])
       s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<httpi>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -64,8 +69,10 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<savon>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<crack>, [">= 0"])
     s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<httpi>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/bandwidth.rb

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

data/lib/bandwidth/bandwidth.rb

@@ -61,17 +61,14 @@ class Bandwidth
     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) })
+      @cdrs_request.body = build_xml(method_name, params)
                                                                    
       response = HTTPI.post @cdrs_request
       Hashie::Mash.new({ :code    => response.code,
                          :body    => response.raw_body,
                          :headers => response.headers })
     else
-      @numbers_request.body = Gyoku.xml({ method_name => params.merge({ :developer_key => @developer_key }),
-                                          :attributes! => xml_namespaces(method_name) })
-                                                                   
+      @numbers_request.body = build_xml(method_name, params)                                  
       response = HTTPI.post @numbers_request
       Hashie::Mash.new({ :code    => response.code,
                          :body    => Crack::XML.parse(response.raw_body),
@@ -79,6 +76,36 @@ class Bandwidth
     end
   end
   
+  ##
+  # Builds the XML document for the method call
+  #
+  # @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 [String] the resulting XML document
+  def build_xml(method_name, params)
+    builder_params = params.merge({ :developer_key => @developer_key })
+    
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.send(method_name.to_s.camelize.uncapitalize.to_sym, xml_namespaces) do
+        builder_params.each do |parent_k, parent_v|
+          if parent_v.instance_of?(Array)
+            xml.send(parent_k.to_s.camelize.uncapitalize.to_sym) do
+              parent_v.each do |item|
+                item.each do |item_k, item_v|
+                  symbol = (item_k.to_s + '_').to_sym
+                  xml.send(symbol, item_v)
+                end
+              end
+            end
+          else
+            xml.send(parent_k.to_s.camelize.uncapitalize.to_sym, parent_v)
+          end
+        end
+      end
+    end
+    builder.to_xml
+  end
+  
   private
   
   ##
@@ -121,9 +148,9 @@ class Bandwidth
   #
   # @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/' } }
+  def xml_namespaces
+    { '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/lib/bandwidth/string_patch.rb

@@ -0,0 +1,9 @@
+class String
+  def camelize
+    self.split(/[^a-z0-9]/i).map{ |w| w[0, 1].upcase + w[1..-1] }.join
+  end
+  
+  def uncapitalize
+    self.sub(/^(.)/) { |m| m.downcase }
+  end
+end

data/spec/bandwidth_spec.rb

@@ -8,6 +8,24 @@ describe "Bandwidth" do
                                  :log_level     => :debug })
   end
   
+  describe "string patch" do
+    it 'should camelize a string' do
+      "foo_bar".camelize.should == 'FooBar'
+    end
+    
+    it 'should uncapitalize a string' do
+      "FooBar".uncapitalize.should == 'fooBar'
+    end
+    
+    it 'should camelize and uncapitlize a string' do
+      "foo_bar".camelize.uncapitalize.should == 'fooBar'
+    end
+    
+    it 'should leave the ID alone' do
+      "foobar_IDs".camelize.uncapitalize.should == 'foobarIDs'
+    end
+  end
+  
   describe "numbers" do
     it "should instantiate a Bandwidth::Numbers class" do
       @bandwidth.instance_of?(Bandwidth).should == true
@@ -55,9 +73,55 @@ describe "Bandwidth" do
   
   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['Content-Type'].should == nil
+      result['headers']['Content-Type'].should == 'application/zip'
+    end
+  end
+  
+  describe "xml builder" do
+    it "should build a valid area code search XML document" do
+      params = { :npa_nxx => '303', :max_quantity => '3' } 
+      result = @bandwidth.build_xml(:area_code_number_search, params)
+      Crack::XML.parse(result).should == {
+                                              "areaCodeNumberSearch" => {
+                                                  "developerKey" => ENV['BANDWIDTH_DEVELOPER_KEY'],
+                                                     "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+                                                   "maxQuantity" => "3",
+                                                        "npaNxx" => "303",
+                                                     "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+                                                         "xmlns" => "http://www.bandwidth.com/api/"
+                                              }
+                                          }
+    end
+    
+    it "should build a valid basic number order document" do
+      params = { :order_name => 'Foobar 0',
+                 :ext_ref_ID => 'Foobar 1',
+                 :number_IDs => [ { :id => '1' }, { :id => '2' }],
+                 :subscriber => 'Tropo',
+                 :end_points => { :host => 'sip.tropo.com' } } 
+      result = @bandwidth.build_xml(:basic_number_order, params)
+
+      Crack::XML.parse(result).should == {
+                                             "basicNumberOrder" => {
+                                                 "developerKey" => ENV['BANDWIDTH_DEVELOPER_KEY'],
+                                                   "subscriber" => "Tropo",
+                                                    "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
+                                                     "extRefID" => "Foobar 1",
+                                                    "orderName" => "Foobar 0",
+                                                    "numberIDs" => {
+                                                     "id" => [
+                                                         "1",
+                                                         "2"
+                                                     ]
+                                                 },
+                                                    "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+                                                        "xmlns" => "http://www.bandwidth.com/api/",
+                                                    "endPoints" => {
+                                                     "host" => "sip.tropo.com"
+                                                 }
+                                             }
+                                          }
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'bandwidth'
+require 'awesome_print'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bandwidth
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jason Goecke
@@ -29,7 +29,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: savon
+  name: nokogiri
   version_requirements: *id001
   prerelease: false
 - !ruby/object:Gem::Dependency 
@@ -43,12 +43,40 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: hashie
+  name: crack
   version_requirements: *id002
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: hashie
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: httpi
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -60,11 +88,11 @@ dependencies:
         - 0
         version: 2.3.0
   name: rspec
-  version_requirements: *id003
+  version_requirements: *id005
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,11 +104,11 @@ dependencies:
         - 0
         version: 0.6.0
   name: yard
-  version_requirements: *id004
+  version_requirements: *id006
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -92,11 +120,11 @@ dependencies:
         - 0
         version: 1.0.0
   name: bundler
-  version_requirements: *id005
+  version_requirements: *id007
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -108,11 +136,11 @@ dependencies:
         - 2
         version: 1.5.2
   name: jeweler
-  version_requirements: *id006
+  version_requirements: *id008
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,7 +150,7 @@ dependencies:
         - 0
         version: "0"
   name: rcov
-  version_requirements: *id007
+  version_requirements: *id009
   prerelease: false
 description: "More detail here: https://my.bandwidth.com/portal/apidoc/welcome.htm"
 email: jason@goecke.net
@@ -146,6 +174,7 @@ files:
 - examples/example.rb
 - lib/bandwidth.rb
 - lib/bandwidth/bandwidth.rb
+- lib/bandwidth/string_patch.rb
 - spec/bandwidth_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true