active_zuora 1.3.0

data/lib/zuora/ZuoraServiceClient.rb

@@ -0,0 +1,124 @@
+module ZUORA
+
+endpoint_url = ARGV.shift
+obj = Soap.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   login(parameters)
+#
+# ARGS
+#   parameters      Login - {http://api.zuora.com/}login
+#
+# RETURNS
+#   parameters      LoginResponse - {http://api.zuora.com/}loginResponse
+#
+# RAISES
+#   fault           LoginFault - {http://fault.api.zuora.com/}LoginFault
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.login(parameters)
+
+# SYNOPSIS
+#   subscribe(parameters)
+#
+# ARGS
+#   parameters      Subscribe - {http://api.zuora.com/}subscribe
+#
+# RETURNS
+#   parameters      SubscribeResponse - {http://api.zuora.com/}subscribeResponse
+#
+# RAISES
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.subscribe(parameters)
+
+# SYNOPSIS
+#   subscribeWithExistingAccount(parameters)
+#
+# ARGS
+#   parameters      SubscribeWithExistingAccount - {http://api.zuora.com/}subscribeWithExistingAccount
+#
+# RETURNS
+#   parameters      SubscribeResponse - {http://api.zuora.com/}subscribeResponse
+#
+# RAISES
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.subscribeWithExistingAccount(parameters)
+
+# SYNOPSIS
+#   create(parameters)
+#
+# ARGS
+#   parameters      Create - {http://api.zuora.com/}create
+#
+# RETURNS
+#   parameters      CreateResponse - {http://api.zuora.com/}createResponse
+#
+# RAISES
+#   fault           InvalidTypeFault - {http://fault.api.zuora.com/}InvalidTypeFault
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.create(parameters)
+
+# SYNOPSIS
+#   update(parameters)
+#
+# ARGS
+#   parameters      Update - {http://api.zuora.com/}update
+#
+# RETURNS
+#   parameters      UpdateResponse - {http://api.zuora.com/}updateResponse
+#
+# RAISES
+#   fault           InvalidTypeFault - {http://fault.api.zuora.com/}InvalidTypeFault
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.update(parameters)
+
+# SYNOPSIS
+#   delete(parameters)
+#
+# ARGS
+#   parameters      Delete - {http://api.zuora.com/}delete
+#
+# RETURNS
+#   parameters      DeleteResponse - {http://api.zuora.com/}deleteResponse
+#
+# RAISES
+#   fault           InvalidTypeFault - {http://fault.api.zuora.com/}InvalidTypeFault
+#   fault           InvalidValueFault - {http://fault.api.zuora.com/}InvalidValueFault
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.delete(parameters)
+
+# SYNOPSIS
+#   query(parameters)
+#
+# ARGS
+#   parameters      Query - {http://api.zuora.com/}query
+#
+# RETURNS
+#   parameters      QueryResponse - {http://api.zuora.com/}queryResponse
+#
+# RAISES
+#   fault           MalformedQueryFault - {http://fault.api.zuora.com/}MalformedQueryFault
+#   fault           InvalidQueryLocatorFault - {http://fault.api.zuora.com/}InvalidQueryLocatorFault
+#   fault           UnexpectedErrorFault - {http://fault.api.zuora.com/}UnexpectedErrorFault
+#
+parameters = nil
+puts obj.query(parameters)
+
+
+
+
+end

data/lib/zuora/account.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class Account < ZObject
+  end
+end

data/lib/zuora/api.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+
+require 'zuora/ZUORA'
+require 'zuora/ZUORADriver'
+require 'zuora/ZUORAMappingRegistry'
+
+module Zuora
+  module Billing
+    class Api
+      include Singleton
+      def initialize
+        @driver = ZUORA::Soap.new
+      end
+
+      attr_reader :driver
+    end
+  end
+end

data/lib/zuora/contact.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class Contact < ZObject
+  end
+end

data/lib/zuora/rate_plan.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class RatePlan < ZObject
+  end
+end

data/lib/zuora/rate_plan_data.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class RatePlanData < ZObject
+  end
+end

data/lib/zuora/subscribe_options.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class SubscribeOptions < ZObject
+  end
+end

data/lib/zuora/subscribe_request.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class SubscribeRequest < ZObject
+  end
+end

data/lib/zuora/subscribe_with_existing_account_request.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class SubscribeWithExistingAccountRequest < ZObject
+  end
+end

data/lib/zuora/subscription.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class Subscription < ZObject
+  end
+end

data/lib/zuora/subscription_data.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class SubscriptionData < ZObject
+  end
+end

data/lib/zuora/zobject.rb

@@ -0,0 +1,52 @@
+module Zuora
+  class ZObject < SimpleDelegator
+    def initialize(attributes={})
+      super(self.class.zobject_class.new).tap do |zobject|
+        attributes.each do |attr, value|
+          zobject.send("#{attr}=", value)
+        end
+      end
+    end
+
+    def to_zobject
+      __getobj__
+    end
+
+    def self.zobject_class
+      return @zobject_class if @zobject_class
+      klass_name = name.match(/(\w+)::(\w+)/)
+      @zobject_class = "#{klass_name[1].upcase}::#{klass_name[2]}".constantize
+    end
+
+    #TODO: This sucks attributes need to be clearly defined
+    def self.attribute_names
+      @attribute_names ||= zobject_class.instance_variable_get("@attributes").reject{|name| name == :fieldsToNull }
+    end
+
+    def self.where(conditions={})
+      zobjects = self.client.query("select #{self.attribute_names.join(", ")} from #{self.name.gsub(/Zuora::/,"")} where #{build_filter_statments(conditions)}")
+      zobjects.map{|zobject| self.new zobject }
+    end
+
+    def self.build_filter_statments(filter_statments)
+      filter_statments.map{|key, value|
+        value = "'#{value}'" if value.kind_of?(String)
+        "#{key} = #{value}"
+      }.join(" and ")
+    end
+
+    def self.find(id)
+      zobject = client.query("select #{attribute_names.join(", ")} from #{self.name.gsub(/Zuora::/,"")} where Id = '#{id}'").first
+      self.new zobject if zobject
+    end
+
+    def self.all
+      zobjects = client.query("select #{attribute_names.join(", ")} from #{self.name.gsub(/Zuora::/,"")}")
+      zobjects.map{|zobject| self.new zobject }
+    end
+
+    def self.client
+      @client ||= Zuora::Client.new
+    end
+  end
+end

data/lib/zuora_client.rb

@@ -0,0 +1,181 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2010 Ning
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# if you get this error:
+#
+# 'uninitialized constant SOAP::Mapping::EncodedRegistry (NameError)'
+#
+# you need to follow the bellow steps to work around it
+#
+# gem uninstall soap4r
+# curl -O http://dev.ctor.org/download/soap4r-1.5.8.tar.gz
+# tar zxvf soap4r-1.5.8.tar.gz
+# cd soap4r-1.5.8
+# sudo ruby install.rb
+
+require 'zuora_interface'
+require 'zuora/api'
+require 'yaml'
+
+class SOAP::Header::HandlerSet
+  def reset
+    @store = XSD::NamedElements.new
+  end
+
+  def set(header)
+    reset
+    add header
+  end
+end
+
+module Zuora
+  class Client
+    PROD_URL = 'https://www.zuora.com/apps/services/a/36.0'
+    SANDBOX_URL = 'https://apisandbox.zuora.com/apps/services/a/36.0'
+
+    def self.config
+      return @config_hash if @config_hash
+      @config_hash = YAML.load_file(Zuora::CONFIG_FILE) if File.exist?(Zuora::CONFIG_FILE)
+      @config_hash ||= {}
+    end
+
+    def self.parse_custom_fields
+      if self.custom_fields
+        self.custom_fields.each do |zobject, field_names|
+          fields = field_names.map { |e| "#{e.strip}__c" }
+          type_class = Object.const_get('ZUORA').const_get(zobject)
+          fields.each do |field|
+            custom_field = field.gsub(/^\w/) { |i| i.downcase }
+            type_class.send :attr_accessor, custom_field
+          end
+        end
+      end
+      custom_fields
+    end
+
+    def self.custom_fields
+      @custom_fields = YAML.load_file(File.dirname(__FILE__) + '/../custom_fields.yml')
+    end
+
+    def initialize(url=SANDBOX_URL)
+      $ZUORA_USER = self.class.config["username"]
+      $ZUORA_PASSWORD = self.class.config["password"]
+      $ZUORA_ENDPOINT = url
+
+      @client = ZuoraInterface.new
+
+      # add custom fields, if any
+      custom_fields = self.class.parse_custom_fields
+      @client.session_start(custom_fields)
+    end
+
+    def query(query_string)
+
+      query_string =~ /select\s+(.+)\s+from/i
+      fields = ($1.split /,\s+/).map do |f|
+        f.gsub!(/\b\w/) { $&.downcase }
+      end
+
+      begin
+        response = @client.query(query_string)
+      rescue Exception => e
+        puts e.message
+      end
+
+      result = []
+      if response && response.result && response.result.size > 0
+        response.result.records.each do |record|
+          row = {}
+          fields.each do |f|
+            row[f] = record.send(f)
+          end
+          result << row
+        end
+      end
+      result
+    end
+
+    def subscribe(obj)
+      begin
+        response = @client.subscribe(obj)
+        return response
+      rescue Exception => e
+        puts e.message
+      end
+    end
+
+    def create(obj)
+      begin
+        response = @client.create(obj)
+        result = save_results_to_hash(response)
+      rescue Exception => e
+        puts e.message
+      end
+      result || []
+    end
+
+    def generate(obj)
+      begin
+        response = @client.generate(obj)
+        result = save_results_to_hash(response)
+      rescue Exception => e
+        puts e.message
+      end
+      result || []
+    end
+
+    def update(obj)
+      begin
+        response = @client.update(obj)
+        result = save_results_to_hash(response)
+      rescue Exception => e
+        puts e.message
+      end
+      result || []
+    end
+
+    def delete(type, ids)
+      begin
+        response = @client.delete(type, ids)
+        result = save_results_to_hash(response)
+      rescue Exception => e
+        puts e.message
+      end
+      result || []
+    end
+
+    private
+
+    def save_results_to_hash(save_results)
+      result = []
+      save_results.each do |record|
+        row = {:success => record.success}
+        if record.success
+          row[:id] = record.id
+        else
+          row[:errors] = []
+          record.errors.each do |error|
+            row[:errors] << {:message => error.message, :code => error.code}
+          end
+        end
+        result << row
+      end
+      result
+    end
+  end
+
+end

data/lib/zuora_interface.rb

@@ -0,0 +1,199 @@
+require 'zuora/api'
+
+class ZuoraInterface
+
+  def make_account(accountName)
+    acc = ZUORA::Account.new
+    acc.allowInvoiceEdit = 0
+    acc.name = accountName
+    acc.currency = "USD"
+    acc.autoPay = 0
+    acc.status = "Draft"
+    acc.paymentTerm = "Due Upon Receipt"
+    acc.batch = "Batch1"
+    acc.billCycleDay = "01"
+    return acc
+  end
+
+  def make_contact(accountId)
+    con = ZUORA::Contact.new
+    con.accountId = accountId
+    con.address1 = '4901 Morena Blvd';
+    con.city = 'San Diego';
+    con.country = 'United States';
+    con.firstName = 'Robert';
+    con.lastName = 'Smith';
+    con.postalCode = '92117';
+    con.state = 'Virginia';
+    con.workEmail = 'robert@smith.com';
+    return con
+  end
+
+  def make_payment_method(accountId)
+    pmt = ZUORA::PaymentMethod.new
+    pmt.accountId = accountId
+    pmt.creditCardAddress1 = '52 Vexford Lane';
+    pmt.creditCardCity = 'Anaheim';
+    pmt.creditCardCountry = 'United States';
+    pmt.creditCardExpirationMonth = '12';
+    pmt.creditCardExpirationYear = '2010';
+    pmt.creditCardHolderName = 'Firstly Lastly';
+    pmt.creditCardNumber = '4111111111111111';
+    pmt.creditCardPostalCode = '22042';
+    pmt.creditCardState = 'California';
+    pmt.creditCardType = 'Visa';
+    pmt.type = 'CreditCard';
+    return pmt
+  end
+
+  def create_active_account(name)
+
+    val = false
+    session_start
+    account = make_account(name)
+    result = create([account])
+#    puts result.first.inspect
+
+    if result.first.success
+
+      accountId = result.first.id
+      payment = make_payment_method(accountId)
+      result = create([payment])
+
+      if result.first.success
+
+        paymentId = result.first.id
+        con = make_contact(accountId)
+        result = create([con])
+
+        if result.first.success
+          conId = result.first.id
+
+          account.id = accountId
+          account.status = 'Active'
+          account.billToId = conId
+          account.soldToId = conId
+          result = update([account])
+
+          if result.first.success
+            val = account
+          else
+            add_errors(result)
+          end
+
+        else
+          add_errors(result)
+        end
+      else
+        add_errors(result)
+      end
+    else
+      add_errors(result)
+    end
+    return val
+  end
+
+  def query(query)
+    q = ZUORA::Query.new
+    q.queryString = query
+    results = @z.query(q)
+    return results
+  end
+
+  def create(objs)
+    return @z.create(objs)
+  end
+
+  def generate(objs)
+    return @z.generate(objs)
+  end
+
+  def update(objs)
+    return @z.update(objs)
+  end
+
+  def delete(type, ids)
+    d = ZUORA::Delete.new
+    d.type = type
+    d.ids = ids
+    return @z.delete(d)
+  end
+
+  def subscribe(sub)
+    return @z.subscribe(sub)
+  end
+
+  def get_object(query)
+    object = lookup(query)
+    unless object.result.size == 0
+      return object.result.records.first
+    else
+      return nil
+    end
+  end
+
+  def get_object_array(query)
+    object = lookup(query)
+    unless object.result.size == 0
+      return object.result.records
+    else
+      return []
+    end
+  end
+
+  def get_driver
+    @z ||= Zuora::Billing::Api.instance.driver
+  end
+
+  def driver
+    get_driver
+  end
+
+  def login
+    loginargs = ZUORA::Login.new
+    loginargs.username = $ZUORA_USER
+    loginargs.password = $ZUORA_PASSWORD
+    @session = ZUORA::SessionHeader.new
+    @session.session = @z.login(loginargs).result.session
+  end
+
+  def session_start(custom_fields={})
+    get_driver
+    @z.do_init(custom_fields)
+    session_cleanup
+    login
+    @z.headerhandler.set @session
+    @z.wiredump_dev = STDERR if $ZUORA_VERBOSE
+  end
+
+  def session_cleanup
+    @z.headerhandler.delete(@session) if @session
+  end
+end
+
+public
+
+def run_tests
+
+  t = ZuoraInterface.new
+  t.session_start
+
+  # create active account
+  e = t.create_active_account("name" + String(Time.now.to_f))
+  puts "Created Account: " + e.id
+
+  # query it
+  r = t.query("SELECT Id, Name FROM Account WHERE Name = '#{e.name}' and status = 'Active'")
+  e = r.result.records[0]
+  puts "Queried Account: " + e.to_s
+
+  # delete it
+  r = t.delete("Account", [e.id])
+  puts "Deleted Account? " + r[0].success.to_s
+
+  t.session_cleanup
+
+end
+
+if __FILE__ == $0
+end