billwise4r 0.1.1 → 0.2.2

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -1,11 +1,4 @@
 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
+# Specify your gem's dependencies in billwise4r.gemspec
+gemspec

data/Gemfile.lock

@@ -1,41 +1,51 @@
+PATH
+  remote: .
+  specs:
+    billwise4r (0.2.2)
+      multi_xml
+      savon
+
 GEM
   remote: http://rubygems.org/
   specs:
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
     awesome_print (0.4.0)
     builder (3.0.0)
-    git (1.2.5)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
     gyoku (0.4.4)
       builder (>= 2.1.2)
-    httpi (0.9.4)
-      pyu-ntlm-http (>= 0.1.3.1)
+    httpi (0.9.5)
       rack
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    multi_xml (0.2.2)
-    nokogiri (1.4.4)
-    nori (0.2.3)
-    pyu-ntlm-http (0.1.3.1)
-    rack (1.3.0)
-    rake (0.9.2)
-    rcov (0.9.9)
-    savon (0.9.2)
+    multi_xml (0.4.1)
+    nokogiri (1.5.0)
+    nori (1.0.2)
+    rack (1.3.5)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    savon (0.9.7)
+      akami (~> 1.0)
       builder (>= 2.1.2)
       gyoku (>= 0.4.0)
-      httpi (>= 0.7.8)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.0)
+      wasabi (~> 2.0)
+    wasabi (2.0.0)
       nokogiri (>= 1.4.0)
-      nori (>= 0.2.0)
-    shoulda (2.11.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   awesome_print
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
-  multi_xml
-  rcov
-  savon
-  shoulda
+  billwise4r!
+  fakeweb
+  rspec

data/README.md

@@ -1,7 +1,7 @@
 billwise4r
 ==========
 
-Gem for working with the Billwise SOAP/XML API.
+Gem for working with the Billwise SOAP/XML API. Ruby 1.9.x + 
 
 Examples
 --------

data/Rakefile

@@ -1,51 +1 @@
-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
+require "bundler/gem_tasks"

data/billwise4r.gemspec

@@ -1,82 +1,35 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "billwise4r/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{billwise4r}
-  s.version = "0.1.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jason Goecke"]
-  s.date = %q{2011-06-07}
+  s.name        = "billwise4r"
+  s.version     = Billwise4r::VERSION
+  s.authors     = ["Jason Goecke","John Dyer"]
+  s.email       = ["jason@goecke.net","john@krumpt.com"]
+  s.homepage    = %q{http://github.com/jsgoecke/billwise4r}
+  s.summary     = %q{Ruby lib for consuming the Billwise SOAP/XML API}
   s.description = %q{Ruby lib for consuming the Billwise SOAP/XML API}
-  s.email = %q{jason@goecke.net}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "billwise4r.gemspec",
-    "lib/billwise4r.rb",
-    "lib/billwise4r/billwise4r.rb",
-    "spec/billwise4r_spec.rb",
-    "spec/config/.gitignore",
-    "spec/config/config.yml",
-    "spec/connect_sm_service.wsdl",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/tropo/billwise4r}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
   s.rubygems_version = %q{1.5.0}
+  s.required_ruby_version = '>= 1.9'
   s.summary = %q{Ruby lib for consuming the Billwise SOAP/XML API}
   s.test_files = [
     "spec/billwise4r_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/connect_sm_service.wsdl",
+    "spec/config/config.yml"
   ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.rubyforge_project = "billwise4r"
 
-    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<multi_xml>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<awesome_print>, [">= 0"])
-      s.add_runtime_dependency(%q<savon>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<savon>, [">= 0"])
-      s.add_dependency(%q<multi_xml>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<awesome_print>, [">= 0"])
-      s.add_dependency(%q<savon>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<savon>, [">= 0"])
-    s.add_dependency(%q<multi_xml>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<awesome_print>, [">= 0"])
-    s.add_dependency(%q<savon>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib","spec"]
 
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "awesome_print"
+  s.add_runtime_dependency "savon"
+  s.add_runtime_dependency "multi_xml"
+end

data/lib/billwise4r/version.rb

@@ -0,0 +1,3 @@
+module Billwise4r
+  VERSION = "0.2.2"
+end

data/lib/billwise4r.rb

@@ -1,4 +1,120 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'savon'
-require 'multi_xml'
-require 'billwise4r/billwise4r'
+class Billwise
+  require "billwise4r/version"
+  require 'savon'
+  require 'multi_xml'
+
+  ##
+  # 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]     || :info
+    @httpi_log   = params[:httpi_log]   || false
+
+    Savon.configure do |config|
+      config.log       = log
+      config.log_level = log_level
+      config.env_namespace = :soap
+    end
+
+    @soap_endpoint  = URI.parse params[:endpoint] || 'https://cwa021.connect4billing.com:8443/axis2/services/ConnectSmService.ConnectSmServiceHttpSoap12Endpoint/'
+    @soap_namespace = params[:namespace] || 'http://connectsm.ws.bwse.com/xsd'
+
+    @soap_version   = 2
+
+    # Build our SOAP driver
+    @soap_driver = Savon::Client.new do
+      wsse.credentials '290connectsm','ZgntS40r'
+      wsdl.document =  'https://cwa021.connect4billing.com:8443/axis2/services/ConnectSmService?wsdl'
+
+    end
+    @soap_driver.http.read_timeout = 300
+
+    @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)
+    begin
+      HTTPI.log = @httpi_log
+      response = @soap_driver.request :wsdl, method do |soap, wsse|
+        soap.version    = @soap_version
+        soap.endpoint   = @soap_endpoint
+        soap.namespaces = Hash.new
+        soap.namespaces["xmlns:soap"] = "http://www.w3.org/2003/05/soap-envelope"
+        soap.namespaces["xmlns:ins0"] = @soap_namespace
+
+        fields = { :companyCd => @companyCd }.merge!(params)
+
+        fields = order_hash(:method=>method, :fields=>fields)
+
+        soap.body = fields
+
+      end
+      response.to_hash["#{method}_response".to_sym][:return]
+    rescue Savon::SOAP::Fault => fault
+      response = {'error' => 'soapfault', 'message' => fault}
+    end
+  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
+
+  ##
+  # 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
+
+  ##
+  # Order has correctly since billwise requires soap parameters be in correct order.
+  # Savon provides this functionality thru gyoku but it doesnt seem to be working in 1.9.
+  # This being the case I decided to roll my own
+  def order_hash(opts={})
+    ordered_hash={}
+    @tag_order[opts[:method].to_sym].each do |o|
+      ordered_hash.merge!(o.to_sym=>opts[:fields][o.to_sym])
+    end
+    ordered_hash
+  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.xml)['definitions']['types']['schema'][3]['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
+end

data/spec/billwise4r_spec.rb

@@ -4,43 +4,62 @@ describe "Billwise" do
   before(:all) do
     config = YAML.load(File.open('spec/config/config.yml'))
     @options = config.merge!({ :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 order the hash correctly" do
+    @billwise = Billwise.new @options
+    result = @billwise.find_invoices({:serviceId  => 'A000000000046590',:customerCd => '000155', :status     => 'A' })
+    result[0][:invoice_number].should == "STMNT-201005"
+  end
+
+  it "should find customer usage" do
+    result = @billwise.get_usage({:customerCd => '000404', :invoiceMonth => "20111101",:serviceId  => 'A000000000051238'})
+    puts result
+  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 honor timeout" do
+    begin
+      Billwise.new @options.merge!({ :timeout => 1 })
+    rescue => e
+      e.to_s.should == "Timeout was reached"
+    end
+  end
+
   it "should find a valid customer" do
-    result = @billwise.find_customer({ :customerCd => '000155' })
+    result = @billwise.find_customer_entity({ :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' })
+      :serviceId  => 'A000000000046590',
+    :status     => 'A' })
     result[:service_id].should == 'A000000000046590'
   end
-end
+end

data/spec/config/config.yml

@@ -1,3 +1,3 @@
-:companyCd: 123
+:companyCd: 290
 :username: username
 :password: password