zuora-ruby 0.2.0 → 0.3.0

data/lib/zuora.rb

@@ -3,82 +3,40 @@
 # Dependencies
 require 'faraday'
 require 'json'
-require 'active_model'
-require 'active_model_serializers'
 require 'active_support'
+require 'active_support/core_ext/string'
+require 'hashie'
 
 module Zuora
-  API_URL = 'https://api.zuora.com/rest/v1/'
-  SANDBOX_URL = 'https://apisandbox-api.zuora.com/rest/v1/'
-
-  STATE_ABBREVIATIONS = %w(AA AE AP AK AL AR AZ CA CO CT DC DE FL
-                           GA GU HI IA ID IL IN KS KY LA MA MD ME
-                           MI MN MO MS MT NC ND NE NH NJ NM NV NY
-                           OH OK OR PA PR RI SC SD TN TX UT VA VI
-                           VT WA WI WV WY)
-
-  CREDIT_CARD_TYPES = %w(Visa MasterCard Amex Discover)
-
-  MONTHS = %w(01 02 03 04 05 06 07 08 09 10 11 12)
-
-  PAYMENT_TERMS = ['Due Upon Receipt', 'Net 30', 'Net 60', 'Net 90']
-
-  # SUBSCRIPTION
-
-  SUBSCRIPTION_TERM_TYPES = %w(TERMED EVERGREEN)
-
-  DISCOUNT_TYPES = %w(ONETIME
-                      RECURRING
-                      USAGE
-                      ONETIMERECURRING
-                      ONETIMEUSAGE
-                      RECURRINGUSAGE
-                      ONETIMERECURRINGUSAG) # typo in zuora docs?
-
-  DISCOUNT_LEVELS = %w(rateplan subscription account)
-
-  LIST_PRICE_BASES = %w(Per_Billing_Period
-                        Per_Month
-                        Per_Week)
-
-  TRIGGER_EVENTS = %w(UCE USA UCA USD)
-
-  END_DATE_CONDITIONS = %w(Subscription_End
-                           Fixed_Period
-                           Specific_End_Date)
-
-  UP_TO_PERIODS = %w(Days Weeks Months Years)
-
-  BILLING_PERIODS = %w(Month
-                       Quarter
-                       Semi_Annual
-                       Annual
-                       Eighteen_Months
-                       Two_Years
-                       Three_Years
-                       Five_Years
-                       Specific_Months
-                       Subscription_Term
-                       Week
-                       Specific_Weeks)
-
-  BILLING_TIMINGS = %w(IN_ADVANCE IN_ARREARS)
-
-  BILL_CYCLE_TYPES = %w(DefaultFromCustomer
-                        SpecificDayofMonth
-                        SubscriptionStartDay
-                        ChargeTriggerDay
-                        SpecificDayOfWeek)
-
-  PRICE_CHANGE_OPTIONS = %w(NoChange
-                            SpecificPercentageValue
-                            UseLatestProductCatalogPricing)
-
-  WEEKDAYS = %w(Sunday Monday Tuesday Wednesday Thursday Friday Saturday)
+  API_URL = 'https://api.zuora.com/rest/v1/'.freeze
+  SANDBOX_URL = 'https://apisandbox-api.zuora.com/rest/v1/'.freeze
+  NAMESPACES = {
+    'xmlns:soapenv' => 'http://schemas.xmlsoap.org/soap/envelope/',
+    'xmlns:api' => 'http://api.zuora.com/',
+    'xmlns:obj' => 'http://object.api.zuora.com/',
+    'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+  }.freeze
+
+  RESPONSE_NAMESPACES = NAMESPACES.merge(
+    'xmlns:ns1' => 'http://api.zuora.com/',
+    'xmlns:ns2' => 'http://object.api.zuora.com/'
+  ).freeze
 end
 
 require_relative 'zuora/version'
+require_relative 'zuora/utils/envelope'
 require_relative 'zuora/client'
-require_relative 'zuora/models'
-require_relative 'zuora/serializers'
-require_relative 'zuora/resources'
+require_relative 'zuora/object'
+require_relative 'zuora/dispatcher'
+require_relative 'zuora/response'
+
+require_relative 'zuora/calls/upsert'
+
+require_relative 'zuora/calls/amend'
+require_relative 'zuora/calls/create'
+require_relative 'zuora/calls/delete'
+require_relative 'zuora/calls/generate'
+require_relative 'zuora/calls/login'
+require_relative 'zuora/calls/query'
+require_relative 'zuora/calls/subscribe'
+require_relative 'zuora/calls/update'

data/lib/zuora/calls/amend.rb

@@ -0,0 +1,68 @@
+module Zuora
+  module Calls
+    class Amend < Hashie::Dash
+      property :amendments, required: true
+      property :amend_options
+      property :preview_options
+
+      # Returns a function that given a builder, constructs an Ammendment
+      # @return [Callable] function of builder
+      def xml_builder
+        lambda do |builder|
+          builder[:api].amend do
+            builder[:api].requests do
+              build_object builder, :amendments, :obj
+              build_object builder, :amend_options, :api
+              build_object builder, :preview_options, :api
+            end
+          end
+        end
+      end
+
+      private
+
+      # Builds one node. Behavior differs based on whether value is a hash
+      # If value is a hash, a parent node is rendered and the call is applied
+      # to its children.
+      # If it is a child node, a child node is rendered.
+      # @param [Nokogiri::XML::Builder] builder
+      # @param [Symbol] child_ns - child namespace
+      # @param [Symbol] field - snake case name of a Zuora object or field
+      # @param [Enumerable or Object] - parent or child node
+      # @return nil
+      def build_node(builder, child_ns, field, value)
+        field = Zuora::Utils::Envelope.to_zuora_key field
+        if value.respond_to?(:each)
+          # Parent
+          builder[:api].send(field) { build_nodes builder, value, child_ns }
+        else
+          # Child
+          builder[child_ns].send(field, value)
+        end
+      end
+
+      # Takes a hash and builds SOAP XML nodes. See build_node for behavior.
+      # @param [Nokogiri::XML::Builder] builder
+      # @param [Enumerable] root
+      # @param [Symbol] child_ns - child node namespace
+      # @return nil
+      def build_nodes(builder, root, child_ns)
+        root.each(&->(k, v) { build_node builder, child_ns, k, v })
+      end
+
+      # Helper to recursively build XML from nested objects.
+      # @param [Nokogiri::XML::Builder] builder
+      # @param [Symbol] property_name - name of a property on this object
+      # @param [Symbol] child_ns - namespace of child node fields
+      # @return nil
+      def build_object(builder, property_name, child_ns)
+        object = send property_name
+        fail 'Objects must respond to each' unless object.respond_to?(:each)
+        object_name = Zuora::Utils::Envelope.to_zuora_key property_name
+        builder[:api].send(object_name) do
+          build_nodes builder, object, child_ns
+        end
+      end
+    end
+  end
+end

data/lib/zuora/calls/create.rb

@@ -0,0 +1,9 @@
+module Zuora
+  module Calls
+    class Create < Zuora::Calls::Upsert
+      def call_name
+        :create
+      end
+    end
+  end
+end

data/lib/zuora/calls/delete.rb

@@ -0,0 +1,20 @@
+module Zuora
+  module Calls
+    class Delete < Hashie::Dash
+      property :type, required: true
+      property :ids, required: true
+
+      def xml_builder
+        fail 'Must be Enumerable' unless ids.respond_to? :each
+        lambda do |builder|
+          builder[:api].delete do
+            builder[:api].type type
+            ids.each do |id|
+              builder[:api].ids id
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zuora/calls/generate.rb

@@ -0,0 +1,22 @@
+module Zuora
+  module Calls
+    class Generate < Hashie::Dash
+      property :objects, required: true
+
+      OBJECT_TYPE = :Invoice
+
+      # Generates a function that takes a builder
+      # and updates object(s) of type.
+      # @return [Callable] - function of builder
+      def xml_builder
+        fail 'objects must respond to :each' unless objects.respond_to?(:each)
+
+        lambda do |builder|
+          builder[:api].generate do
+            Zuora::Utils::Envelope.build_objects builder, OBJECT_TYPE, objects
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zuora/calls/login.rb

@@ -0,0 +1,21 @@
+module Zuora
+  module Calls
+    class Login < Hashie::Dash
+      # @params [String] username
+      # @params [String] password
+      property :username, required: true
+      property :password, required: true
+
+      # Generates a function that adds login fields to a buidler
+      # @return [Callable] builder - a function of builder
+      def xml_builder
+        lambda do |builder|
+          builder[:api].login do
+            builder[:api].username(username)
+            builder[:api].password(password)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zuora/calls/query.rb

@@ -0,0 +1,15 @@
+module Zuora
+  module Calls
+    class Query < Hashie::Dash
+      def initialize(query_string)
+        @query_string = query_string
+      end
+
+      def xml_builder
+        lambda do |builder|
+          builder[:api].query { builder[:api].queryString(@query_string) }
+        end
+      end
+    end
+  end
+end

data/lib/zuora/calls/subscribe.rb

@@ -0,0 +1,75 @@
+module Zuora
+  module Calls
+    class Subscribe < Hashie::Dash
+      property :account, required: true
+      property :payment_method
+      property :bill_to_contact, required: true
+      property :sold_to_contact
+      property :subscribe_options
+      property :subscription
+      property :rate_plan
+
+      SIMPLE_OBJECTS = [:account, :payment_method, :bill_to_contact].freeze
+
+      # Generates a function that adds login fields to a buidler
+      # @return [Callable] function of builder
+      def xml_builder
+        lambda do |builder|
+          builder[:api].subscribe do
+            builder[:api].subscribes do
+              build_simple_objects builder
+              build_complex_objects builder
+            end
+          end
+        end
+      end
+
+      private
+
+      # Builds the non-complex / non-nested part of the subscribe request
+      # @param [Nokogiri::XML::Builder] builder
+      def build_simple_objects(builder)
+        SIMPLE_OBJECTS.each do |obj_name|
+          obj = send obj_name
+          next unless obj
+          zuora_name = Zuora::Utils::Envelope.to_zuora_key obj_name
+          builder[:api].send(zuora_name) do
+            Zuora::Utils::Envelope.build_fields(builder, :obj, obj)
+          end
+        end
+      end
+
+      # Builds the complex, nested part of the subscribe request
+      # @param [Nokogiri::XML::Builder] builder
+      def build_complex_objects(builder)
+        builder[:api].SubscribeOptions do
+          Zuora::Utils::Envelope.build_fields(builder, :api, subscribe_options)
+        end if subscribe_options
+
+        builder[:api].SubscriptionData do
+          build_object(builder, :Subscription, subscription)
+          builder[:api].RatePlanData do
+            build_object(builder, :RatePlan, rate_plan)
+          end
+        end
+      end
+
+      # Helper for building one object
+      # [Nokogiri::XML::Builder] builder
+      # [Symbol] type
+      # [Hash] data
+      def build_object(builder, type, data)
+        builder[:api].send(type) do
+          build_fields builder, data
+        end if data
+      end
+
+      # [Nokogiri::XML::Builder] builder
+      # [Nokogiri::XML::Builder] builder
+      # [Hash] data
+      def build_fields(builder, data)
+        Zuora::Utils::Envelope.build_fields(builder, :obj, data)
+      end
+    end
+  end
+end

data/lib/zuora/calls/update.rb

@@ -0,0 +1,9 @@
+module Zuora
+  module Calls
+    class Update < Zuora::Calls::Upsert
+      def call_name
+        :update
+      end
+    end
+  end
+end

data/lib/zuora/calls/upsert.rb

@@ -0,0 +1,29 @@
+module Zuora
+  module Calls
+    class Upsert < Hashie::Dash
+      # Base class for Create and Update
+
+      # @params [Symbol] type e.g. :BillRun, :Refund
+      # @params [Array] objects - collection of objects of type `type`
+      property :type, required: true
+      property :objects, required: true
+
+      def call_name
+        fail 'This class is abstract. Subclassers must def :call_name'
+      end
+
+      # Generates a function that takes a builder
+      # adds call of call_name and z-object(s) ogit rf type
+      # @return [Callable] - function of builder
+      def xml_builder
+        fail 'objects must respond to :each' unless objects.respond_to?(:each)
+
+        lambda do |builder|
+          builder[:api].send(call_name) do
+            Zuora::Utils::Envelope.build_objects builder, type, objects
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zuora/client.rb

@@ -1,138 +1,128 @@
-# encoding: utf-8
 require 'faraday'
 require 'faraday_middleware'
-require 'json'
+require 'nokogiri'
 
 module Zuora
   # Unable to connect. Check username / password
-  ConnectionError = Class.new StandardError
+  SoapConnectionError = Class.new StandardError
 
   # Non-success response
-  ErrorResponse = Class.new StandardError
+  SoapErrorResponse = Class.new StandardError
 
   class Client
-    attr_reader :connection
+    attr_accessor :session_token
+
+    SOAP_API_URI = '/apps/services/a/74.0'.freeze
+    SESSION_TOKEN_XPATH =
+      %w(//soapenv:Envelope soapenv:Body api:loginResponse
+         api:result api:Session).join('/').freeze
 
     # Creates a connection instance.
-    # Makes an initial HTTP request to fetch session token.
-    # Subsequent requests made with .get, .post, and .put
-    # contain the authenticated session id in their headers.
+    # Makes an initial SOAP request to fetch session token.
+    # Subsequent requests contain the authenticated session id
+    # in headers.
     # @param [String] username
     # @param [String] password
     # @param [Boolean] sandbox
-    # @return [Zuora::Client] with .connection, .put, .post
-    def initialize(username, password, sandbox = false)
-      base_url = api_url sandbox
-      conn = connection base_url
+    # @return [Zuora::SoapClient]
+    def initialize(username, password, sandbox = true)
+      @username = username
+      @password = password
+      @sandbox = sandbox
+    end
 
-      response = auth_request conn, username, password
+    # Makes auth request, handles response
+    # @return [Faraday::Response]
+    def authenticate!
+      auth_response = call! :login,
+        username: @username,
+        password: @password
 
-      handle_response response, conn
+      handle_auth_response auth_response
+    rescue Object => e
+      raise SoapConnectionError, e
     end
 
-    # @param [String] url - URL of request
-    # @return [Faraday::Response] A response, with .headers, .status & .body
-    def get(url)
-      @connection.get do |req|
-        set_request_headers! req, url
-      end
-    end
+    # Fire a request
+    # @param [Xml] body - an object responding to .xml
+    # @return [Zuora::Response]
+    def request!(body)
+      fail 'body must support .to_xml' unless body.respond_to? :to_xml
 
-    # @param [String] url - URL for HTTP POST request
-    # @param [Params] params - Data to be sent in request body
-    # @return [Faraday::Response] A response, with .headers, .status & .body
-    def post(url, params)
-      response = @connection.post do |req|
-        set_request_headers! req, url
-        req.body = JSON.generate params
+      raw_response = connection.post do |request|
+        request.url SOAP_API_URI
+        request.headers['Content-Type'] = 'text/xml'
+        request.body = body.to_xml
       end
 
-      response
-      # if response.body['success']
-      #  return response
-      # else
-      #  raise ErrorResponse.new(response)
-      # end
+      Zuora::Response.new(raw_response)
     end
 
-    # @param [String] url - URL for HTTP PUT request
-    # @param [Params] params - Data to be sent in request body
-    # @return [Faraday::Response] A response, with .headers, .status & .body
-    def put(url, params)
-      response = @connection.put do |request|
-        set_request_headers! request, url
-        request.body = JSON.generate params
-      end
-
-      response
-      # if response.body['success']
-      #  return response
-      # else
-      #  raise ErrorResponse.new(response)
-      # end
+    # The primary interface via which users should make SOAP requests.
+    # client.call :create, object_name: :BillRun, data: {...}
+    # client.call :subscribe, account: {...}, sold_to_contact: {...}
+    # @param [Symbol] call_name - one of :create, :subscribe, :amend, :update
+    # @return [Faraday:Response] - response
+    def call!(call_name, *args)
+      factory = Zuora::Dispatcher.send call_name
+      xml_builder = factory.new(*args).xml_builder
+      request_data = envelope_for call_name, xml_builder
+      request! request_data
     end
 
     private
 
-    # Make connection attempt
-    # @param [Faraday::Connection] conn
-    # @param [String] username
-    # @param [String] password
-    def auth_request(conn, username, password)
-      conn.post do |request|
-        set_auth_request_headers! request, username, password
+    # Generate envelope for request
+    # @param [Symbol] call name - one of the supported calls (see #call)
+    # @param [Callable] builder_modifier - function taking a builder
+    # @return [Nokogiri::XML::Builder]
+    def envelope_for(call_name, xml_builder_modifier)
+      if call_name == :login
+        Zuora::Utils::Envelope.xml(nil, xml_builder_modifier)
+      else
+        Zuora::Utils::Envelope.authenticated_xml(@session_token) do |b|
+          xml_builder_modifier.call b
+        end
       end
     end
 
-    # Sets instance variables or throws Connection error
-    # @param [Faraday::Response] response
-    # @param [Faraday::Connection] conn
-    def handle_response(response, conn)
-      if response.status == 200
-        @auth_cookie = response.headers['set-cookie'].split(' ')[0]
-        @connection = conn
+    # Handle auth response, setting session
+    # @params [Faraday::Response]
+    # @return [Faraday::Response]
+    # @throw [SoapErrorResponse]
+    def handle_auth_response(response)
+      if response.raw.status == 200
+        @session_token = extract_session_token response
       else
-        fail ConnectionError, response.body['reasons']
+        message = 'Unable to connect with provided credentials'
+        fail SoapErrorResponse, message
       end
+      response
     end
 
-    # @param [Faraday::Request] request - Faraday::Request builder
-    # @param [String] username - Zuora username
-    # @param [String] password - Zuora password
-    def set_auth_request_headers!(request, username, password)
-      request.url '/rest/v1/connections'
-      request.headers['apiAccessKeyId'] = username
-      request.headers['apiSecretAccessKey'] = password
-      request.headers['Content-Type'] = 'application/json'
-    end
-
-    # @param [Faraday::Request] request - Faraday Request builder
-    # @param [String] url - Relative URL for HTTP request
-    # @return [Nil]
-    def set_request_headers!(request, url)
-      request.url url
-      request.headers['Content-Type'] = 'application/json'
-      request.headers['Cookie'] = @auth_cookie
+    # Extracts session token from response and sets instance variable
+    # for use in subsequent requests
+    # @param [Faraday::Response] response - response to auth request
+    def extract_session_token(response)
+      Nokogiri::XML(response.raw.body).xpath(
+        SESSION_TOKEN_XPATH, Zuora::NAMESPACES
+      ).text
     end
 
-    # @param [String] url
-    # @return [Faraday::Client]
-    def connection(url)
-      Faraday.new(url, ssl: { verify: false }) do |conn|
-        conn.request :json
-        conn.response :json, content_type: /\bjson$/
-        conn.use :instrumentation
+    # Initializes a connection using api_url
+    # @return [Faraday::Connection]
+    def connection
+      Faraday.new(api_url, ssl: { verify: false }) do |conn|
         conn.adapter Faraday.default_adapter
       end
     end
 
-    # @param [Boolean] sandbox - Use the sandbox url?
-    # @return [String] the API url
-    def api_url(sandbox)
-      if sandbox
-        Zuora::SANDBOX_URL
+    # @return [String] - SOAP url based on @sandbox
+    def api_url
+      if @sandbox
+        'https://apisandbox.zuora.com/apps/services/a/74.0'
       else
-        Zuora::API_URL
+        'https://api.zuora.com/apps/services/a/74.0'
       end
     end
   end