zuora-ruby 0.1.0

data/lib/zuora/models.rb

@@ -0,0 +1,10 @@
+require_relative 'models/utils'
+
+require_relative 'models/account'
+require_relative 'models/card_holder'
+require_relative 'models/contact'
+require_relative 'models/payment_method'
+require_relative 'models/rate_plan'
+require_relative 'models/rate_plan_charge'
+require_relative 'models/subscription'
+require_relative 'models/tier'

data/lib/zuora/models/account.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class Account
+      include ActiveModel::Model
+      # See http://api.rubyonrails.org/classes/ActiveModel/Dirty.html
+
+      ATTRIBUTES = :account_number,
+                   :auto_pay,
+                   :bill_to_contact,
+                   :bill_cycle_day,
+                   :crm_id,
+                   :currency,
+                   :credit_card,
+                   :name,
+                   :hpm_credit_card_payment_method_id,
+                   :notes,
+                   :invoice_template_id,
+                   :communication_profile_id,
+                   :payment_gateway,
+                   :payment_term,
+                   :sold_to_contact,
+                   :subscription
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      Zuora::Models::Utils.validate_children self,
+                                             'contact',
+                                             :bill_to_contact,
+                                             :sold_to_contact
+
+      validates :auto_pay,
+                :bill_to_contact,
+                :credit_card,
+                :currency,
+                :name,
+                :payment_term,
+                :sold_to_contact,
+                presence: true
+
+      validates :currency,
+                length: { is: 3 }
+
+      validates :payment_term,
+                inclusion: { in: Zuora::PAYMENT_TERMS }
+    end
+  end
+end

data/lib/zuora/models/card_holder.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class CardHolder
+      include ActiveModel::Model
+
+      ATTRIBUTES = :card_holder_name,
+                   :address_line_1,
+                   :address_line_2,
+                   :city,
+                   :state,
+                   :zip_code,
+                   :country,
+                   :phone,
+                   :email
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :card_holder_name,
+                :address_line_1,
+                :city,
+                :state,
+                :zip_code,
+                :country,
+                presence: true
+
+      validates :card_holder_name,
+                length: { maximum: 50 }
+
+      validates :address_line_1,
+                length: { maximum: 255 }
+
+      validates :address_line_2,
+                length: { maximum: 255 },
+                allow_nil: true
+
+      validates :city,
+                length: { maximum: 40 }
+
+      validates :state,
+                inclusion: { in: Zuora::STATE_ABBREVIATIONS }
+
+      validates :zip_code,
+                length: { maximum: 20 }
+
+      validates :phone,
+                length: { maximum: 20 },
+                allow_nil: true
+
+      validates :email,
+                length: { maximum: 80 },
+                allow_nil: true
+    end
+  end
+end

data/lib/zuora/models/contact.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class Contact
+      include ActiveModel::Model
+
+      ATTRIBUTES = :address_1,
+                   :address_2,
+                   :city,
+                   :country,
+                   :county,
+                   :fax,
+                   :first_name,
+                   :home_phone,
+                   :last_name,
+                   :mobile_phone,
+                   :nickname,
+                   :other_phone,
+                   :other_phone_type,
+                   :personal_email,
+                   :zip_code,
+                   :state,
+                   :tax_region,
+                   :work_email,
+                   :work_phone
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :first_name,
+                :last_name,
+                :country,
+                presence: true
+
+      validates :first_name,
+                :last_name,
+                length: { maximum: 100 }
+    end
+  end
+end

data/lib/zuora/models/payment_method.rb

@@ -0,0 +1 @@
+require_relative 'payment_methods/credit_card'

data/lib/zuora/models/payment_methods/credit_card.rb

@@ -0,0 +1,37 @@
+module Zuora
+  module Models
+    module PaymentMethods
+      class CreditCard
+        include ActiveModel::Model
+
+        ATTRIBUTES = :card_type,
+                     :card_number,
+                     :expiration_month,
+                     :expiration_year,
+                     :security_code
+
+        attr_accessor(*ATTRIBUTES)
+
+        def attributes
+          ATTRIBUTES
+        end
+
+        validates :card_type,
+                  :card_number,
+                  :expiration_month,
+                  :expiration_year,
+                  :security_code,
+                  presence: true
+
+        validates :card_type,
+                  inclusion: { in: Zuora::CREDIT_CARD_TYPES }
+
+        validates :expiration_month,
+                  inclusion: { in: Zuora::MONTHS }
+
+        validates :expiration_year,
+                  length: { is: 4 }
+      end
+    end
+  end
+end

data/lib/zuora/models/rate_plan.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class RatePlan
+      include ActiveModel::Model
+
+      ATTRIBUTES = :product_rate_plan_id,
+                   :charge_overrides
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :product_rate_plan_id,
+                presence: true
+    end
+  end
+end

data/lib/zuora/models/rate_plan_charge.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class RatePlanCharge
+      include ActiveModel::Model
+
+      ATTRIBUTES = :product_rate_plan_charge_id,
+                   :number,
+                   :description,
+                   :price,
+                   :tiers,
+                   :included_units,
+                   :overage_price,
+                   :list_price_base,
+                   :quantity,
+                   :discounted_amount,
+                   :discount_percentage,
+                   :apply_discount_to,
+                   :discount_level,
+                   :trigger_event,
+                   :trigger_date,
+                   :end_date_condition,
+                   :up_to_periods_type,
+                   :up_to_periods,
+                   :specific_end_date,
+                   :billing_period,
+                   :specific_billing_period,
+                   :billing_period_alignment,
+                   :billing_timing,
+                   :rating_group,
+                   :bill_cycle_type,
+                   :bill_cycle_day,
+                   :number_of_periods,
+                   :overage_unused_units_credit_option,
+                   :unused_units_credit_rates,
+                   :price_change_option,
+                   :price_increase_percentage,
+                   :weekly_bill_cycle_day
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :product_rate_plan_charge_id,
+                presence: true
+
+      validates :number,
+                length: { maximum: 50 }
+
+      validates :description,
+                length: { maximum: 500 }
+    end
+  end
+end

data/lib/zuora/models/subscription.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+module Zuora
+  module Models
+    class Subscription
+      include ActiveModel::Model
+
+      ATTRIBUTES = :account_key,
+                   :invoice_owner_account_key,
+                   :term_type,
+                   :contract_effective_date,
+                   :service_activation_date,
+                   :customer_acceptance_date,
+                   :term_start_date,
+                   :initial_term,
+                   :initial_term_period_type,
+                   :auto_renew,
+                   :renewal_term,
+                   :renewal_term_period_type,
+                   :renewal_setting,
+                   :notes,
+                   :invoice_collect,
+                   :invoice,
+                   :collect,
+                   :invoice_separately,
+                   :apply_credit_balance,
+                   :invoice_target_date,
+                   :subscribe_to_rate_plans
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :account_key,
+                :term_type,
+                :contract_effective_date,
+                :subscribe_to_rate_plans,
+                presence: true
+
+      validates :term_type,
+                inclusion: { in: Zuora::SUBSCRIPTION_TERM_TYPES }
+
+      validates :initial_term,
+                presence: true,
+                if: proc { |sub| sub.term_type == 'EVERGREEN' }
+    end
+  end
+end

data/lib/zuora/models/tier.rb

@@ -0,0 +1,27 @@
+module Zuora
+  module Models
+    class RatePlanChargeTier
+      include ActiveModel::Model
+
+      ATTRIBUTES = :tier,
+                   :starting_unit,
+                   :ending_unit,
+                   :price,
+                   :price_format
+
+      attr_accessor(*ATTRIBUTES)
+
+      def attributes
+        ATTRIBUTES
+      end
+
+      validates :tier,
+                :price,
+                presence: true
+
+      validates :price_format,
+                inclusion: { in: %w(FlatFee PerUnit) },
+                allow_nil: true
+    end
+  end
+end

data/lib/zuora/models/utils.rb

@@ -0,0 +1,23 @@
+module Zuora
+  module Models
+    module Utils
+      # Calls `validate_each` on for each provided attribute.
+      # Attaches error generated via message fragment.
+      # e.g. 'invalid widget'
+      #
+      # @param [Object] sender;
+      # @param [String] message
+      # @param [Array<Symbol>] fields
+      # @return [Nil]
+      def self.validate_children(sender, message, *fields)
+        sender.validates_each fields do |record, attr, value|
+          if !value.respond_to?(:valid?) || !value.respond_to?(:errors)
+            record.errors.add attr, "invalid #{message}"
+          elsif value.invalid?
+            record.errors.add attr, value.errors.join(',')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zuora/resources.rb

@@ -0,0 +1,17 @@
+module Zuora
+  module Resources
+    InvalidModel = Class.new(StandardError)
+
+    def self.with_valid(model, &block)
+      if model.valid?
+        block.call model
+      else
+        fail InvalidModel, model
+      end
+    end
+  end
+end
+
+require_relative 'resources/accounts'
+require_relative 'resources/payment_methods'
+require_relative 'resources/subscriptions'

data/lib/zuora/resources/accounts.rb

@@ -0,0 +1,19 @@
+module Zuora
+  module Resources
+    module Accounts
+      RESOURCE_URI = '/rest/v1/accounts'
+
+      def self.create!(client, model, serializer = Zuora::Serializers::Noop)
+        Zuora::Resources.with_valid model do |mod|
+          client.post RESOURCE_URI, serializer.serialize(mod)
+        end
+      end
+
+      def self.update!(client, model, serializer = Zuora::Serializers::Noop)
+        Zuora::Resources.with_valid model do |mod|
+          client.post RESOURCE_URI, serializer.serialize(mod)
+        end
+      end
+    end
+  end
+end

data/lib/zuora/resources/payment_methods.rb

@@ -0,0 +1 @@
+require_relative 'payment_methods/credit_card'

data/lib/zuora/resources/payment_methods/credit_card.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+module Zuora
+  module Resources
+    module PaymentMethods
+      module CreditCards
+        RESOURCE_URI = '/rest/v1/credit_card/payment_account'
+
+        # Validates a model, and throws if invalid.
+        # Otherwise, makes an HTTP request, creating a credit card
+        # payment account.
+
+        # https://api.zuora.com/rest/v1/payment-methods/credit-cards
+
+        # @param [Zuora::Client] client
+        # @param [Zuora::Model::PaymentMethod] model: the credit card
+        # @param [Class] serializer: any object supporting .serialze(data)
+        # @return [Faraday::Response]
+        def self.create!(client, model, serializer = Zuora::Serializers::Noop)
+          Zuora::Resources.with_valid model do |mod|
+            client.post RESOURCE_URI, serializer.serialize(mod)
+          end
+        end
+      end
+    end
+  end
+end