billwise4r 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+gem "savon"
+gem "multi_xml"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+  gem "awesome_print"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (0.3.1)
+    builder (3.0.0)
+    crack (0.1.8)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    multi_xml (0.2.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    savon (0.7.9)
+      builder (>= 2.1.2)
+      crack (>= 0.1.4)
+    shoulda (2.11.3)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  multi_xml
+  rcov
+  savon
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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,28 @@
+billwise4r
+==========
+
+Gem for working with the Billwise SOAP/XML API.
+
+Examples
+--------
+
+	require 'billwise4r'
+	
+	billwise = Billwise.new({ :company_id => 123,
+   				              :username   => 'user',
+				              :password   => 'pass',
+				              :wsdl_url   => 'https://cwa021.connect4billing.com/axis2/services/ConnectSmService?wsdl',
+				              :endpoint   => 'https://cwa021.connect4billing.com/axis2/services/ConnectSmService.ConnectSmServiceHttpSoap12Endpoint/',
+				              :namespace  => 'http://connectsm.ws.bwse.com/xsd',
+				              :log        => true})
+	
+	customer = billwise.find_customer(987)
+	services = billwise.find_services({ :customerCd => '000123',
+                                        :serviceId  => 'A000000000000456',
+                                        :status     => 'A' })
+
+Copyright
+---------
+
+Copyright (c) 2010 Jason Goecke. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+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 is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "billwise4r"
+  gem.homepage = "http://github.com/tropo/billwise4r"
+  gem.license = "MIT"
+  gem.summary = "Ruby lib for consuming the Billwise SOAP/XML API"
+  gem.description = "Ruby lib for consuming the Billwise SOAP/XML API"
+  gem.email = "jason@goecke.net"
+  gem.authors = ["Jason Goecke"]
+  gem.add_runtime_dependency 'savon'
+  gem.add_development_dependency 'rspec'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "billwise4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/billwise4r/billwise4r.rb

@@ -0,0 +1,85 @@
+class Billwise
+  ##
+  # Instantiates a new Billwise class
+  #
+  def initialize(params={})
+    # Make sure all params we need are here or raise an error
+    check_initialization_params(params)
+    
+    @companyCd = params[:companyCd]    
+    log        = params[:log]       || false
+    log_level  = params[:log_level] || false
+     
+    #Build our SOAP driver
+    Savon::SOAP.version      = 2
+    Savon::WSSE.username     = params[:username] 
+    Savon::WSSE.password     = params[:password] 
+    Savon::Request.log       = log
+    Savon::Request.log_level = log_level
+    
+    @soap_driver    = Savon::Client.new params[:wsdlUrl] || 'https://cwa021.connect4billing.com/axis2/services/ConnectSmService?wsdl'
+    @soap_endpoint  = URI.parse params[:endpoint] || 'https://cwa021.connect4billing.com/axis2/services/ConnectSmService.ConnectSmServiceHttpSoap12Endpoint/'
+    @soap_namespace = namespace  = params[:namespace] || 'http://connectsm.ws.bwse.com/xsd'
+    
+    @tag_order  = tag_order
+    
+    MultiXml.parser = :nokogiri
+  end
+  
+  ##
+  # A catch all for the methods defined by the WSDL
+  # refer to the Billwise API documentation for details
+  #
+  # @return [Hash] the Billwise response
+  def method_missing(method, params)
+    response = @soap_driver.send(method) do |soap, wsse|
+      soap.endpoint = @soap_endpoint
+      soap.namespaces["xmlns:wsdl"] = @soap_namespace
+      
+      fields = { :companyCd => @companyCd }.merge!(params)
+      fields.merge!({ :order! => @tag_order[method] }) if @tag_order[method]
+      
+      soap.body = fields
+    end
+    response.to_hash["#{method}_response".to_sym][:return]
+  end
+    
+  private
+  
+  ##
+  # Checks that the required params have been provided, or rasies an error
+  def check_initialization_params(params={})
+    raise ArgumentError, "You must provide Billwise connection parameters." if params.length == 0
+    %w(companyCd username password).each { |param| raise ArgumentError, "You must provide a valid #{param}." if params[param.to_sym].nil? }
+  end
+  
+  ##
+  # Traverses the WSDL to create a hash of methods and their ordered parameters
+  # only necessary since the Billwise SOAP/XML API requires attributes in order
+  # and the Ruby MRI likes to alphabetize, so Savon allows us to set a specific
+  # order when building the XML
+  #
+  # @return [Hash] the methods and their ordered parameters
+  def tag_order
+    actions = {}
+    MultiXml.parse(@soap_driver.wsdl.to_s)['definitions']['types']['schema'][2]['element'].each do |action|
+      attributes = []
+      if action['complexType']['sequence']['element'].instance_of?(Hash)
+        attributes << action['complexType']['sequence']['element']['name'].to_sym
+      else
+        action['complexType']['sequence']['element'].each { |item| attributes << item['name'].to_sym }
+      end
+      actions[decamelize(action['name']).to_sym] = attributes
+    end
+    actions
+  end
+  
+  ##
+  # Decamelizes a string
+  #
+  # @param [required, String] the string to be decamelized
+  # @return [String] the decamelized string
+  def decamelize(string)
+    string.gsub(/[A-Z]/) { |p| '_' + p.downcase }
+  end
+end

data/lib/billwise4r.rb

@@ -0,0 +1,3 @@
+require 'savon'
+require 'multi_xml'
+require 'billwise4r/billwise4r'

data/spec/billwise4r_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Billwise" do
+  before(:all) do
+    @options = { :companyCd => 124,
+                 :username  => 'user',
+                 :password  => 'pass',
+                 :log       => false }
+                               
+    @billwise = Billwise.new @options
+  end
+  
+  it "should create a Billwise object" do
+    @billwise = Billwise.new @options
+    @billwise.instance_of?(Billwise).should == true
+  end
+  
+  it "should raise errors if required params are not passed" do
+    begin
+      Billwise.new
+    rescue => e
+      e.to_s.should == "You must provide Billwise connection parameters."
+    end
+    
+    begin
+      Billwise.new({ :companyCd => 100 })
+    rescue => e
+      e.to_s.should == "You must provide a valid username."
+    end
+  end
+  
+  it "should find a valid customer" do
+    result = @billwise.find_customer({ :customerCd => '000155' })
+    result[:customer_cd].should == "000155"
+  end
+  
+  it "should find that customers invoices" do
+    result = @billwise.find_invoices({ :customerCd => '000155' })
+    result[0][:invoice_number].should == "STMNT-201005"
+  end
+  
+  it "should find services" do
+    result = @billwise.find_services({ :customerCd => '000155',
+                                       :serviceId  => 'A000000000046590',
+                                       :status     => 'A' })
+    result[:service_id].should == 'A000000000046590'
+  end
+end