kaui 0.6.6 → 0.7.0

data/app/helpers/kaui/subscription_helper.rb

@@ -0,0 +1,115 @@
+module Kaui
+  module SubscriptionHelper
+
+    def humanized_product_category(sub)
+      if !sub.present? or !sub.product_category.present?
+        nil
+      elsif sub.product_category == 'BASE'
+        'Base'
+      elsif sub.product_category == 'ADD_ON'
+        'Add-on'
+      else
+        sub.product_category.downcase.capitalize
+      end
+    end
+
+    def humanized_product_name(sub)
+      if !sub.present? or !sub.product_name.present?
+        nil
+      else
+        sub.product_name.downcase.capitalize
+      end
+    end
+
+    def humanized_billing_period(sub)
+      if !sub.present? or !sub.billing_period.present?
+        nil
+      elsif sub.billing_period == 'NO_BILLING_PERIOD'
+        'No billing period'
+      else
+        sub.billing_period.downcase.capitalize
+      end
+    end
+
+    def humanized_price_list(sub, show_default=true)
+      if !sub.present? or !sub.price_list.present? or (!show_default and sub.price_list.upcase == 'DEFAULT')
+        nil
+      else
+        sub.price_list.downcase.capitalize
+      end
+    end
+
+    def humanized_full_product_name(sub)
+      humanized_product_name   = humanized_product_name(sub)
+      humanized_billing_period = humanized_billing_period(sub)
+      humanized_price_list     = humanized_price_list(sub, false)
+
+      if humanized_billing_period.nil?
+        if humanized_price_list.nil?
+          humanized_product_name
+        else
+          humanized_product_name+ ' (' + humanized_price_list.downcase + ')'
+        end
+      else
+        if humanized_price_list.nil?
+          humanized_product_name + ' (' + humanized_billing_period.downcase + ')'
+        else
+          humanized_product_name+ ' (' + humanized_billing_period.downcase + ', ' + humanized_price_list.downcase + ')'
+        end
+      end
+    end
+
+    def humanized_start_date(sub, account)
+      if !sub.present? or !sub.start_date.present? or !account.present? or !account.time_zone.present?
+        nil
+      else
+        format_date(sub.start_date, account.time_zone).html_safe
+      end
+    end
+
+    def humanized_charged_through_date(sub, account)
+      if !sub.present? or !sub.charged_through_date.present? or !account.present? or !account.time_zone.present?
+        nil
+      else
+        format_date(sub.charged_through_date, account.time_zone).html_safe
+      end
+    end
+
+    def humanized_cancelled_date(sub, account)
+      if !sub.present? or !sub.cancelled_date.present? or !account.present? or !account.time_zone.present?
+        nil
+      else
+        cancelled_date = format_date(sub.cancelled_date, account.time_zone).html_safe
+        if Time.parse(sub.cancelled_date) > Time.now
+          'Pending cancellation on ' + cancelled_date
+        else
+          'Canceled on ' + cancelled_date
+        end
+      end
+    end
+
+    def humanized_billing_start_date(sub, account)
+      if !sub.present? or !sub.billing_start_date.present? or !account.present? or !account.time_zone.present?
+        nil
+      else
+        format_date(sub.billing_start_date, account.time_zone).html_safe
+      end
+    end
+
+    def humanized_billing_end_date(sub, account)
+      if !sub.present? or !sub.billing_end_date.present? or !account.present? or !account.time_zone.present?
+        nil
+      else
+        format_date(sub.billing_end_date, account.time_zone).html_safe
+      end
+    end
+
+    def is_future_cancelled?(sub)
+      sub.present? and sub.billing_end_date.present? and Time.parse(sub.billing_end_date) > Time.now
+    end
+
+    def is_cancelled?(sub)
+      sub.present? and !sub.billing_end_date.present?
+    end
+  end
+end

data/app/helpers/kaui/uuid_helper.rb

@@ -0,0 +1,9 @@
+module Kaui
+  module UuidHelper
+
+    def truncate_uuid(uuid)
+      split = uuid.split('-')
+      split[0] + '-...-' + split[4]
+    end
+  end
+end

data/app/models/kaui/ability.rb

@@ -14,9 +14,9 @@ module Kaui
         elsif model == '*' and action != '*'
           # TODO
         elsif action == '*'
-          can :all, ('Kaui::' + model.capitalize).constantize
+          can :all, ('Kaui::' + model.capitalize).constantize rescue nil
         else
-          can action.to_sym, ('Kaui::' + model.capitalize).constantize
+          can action.to_sym, ('Kaui::' + model.capitalize).constantize rescue nil
         end
       end
     rescue KillBillClient::API::Unauthorized => e

data/app/models/kaui/account.rb

@@ -1,53 +1,36 @@
-class Kaui::Account < Kaui::Base
-  define_attr :account_id
-  define_attr :external_key
-  define_attr :name
-  define_attr :first_name_length
-  define_attr :email
-  define_attr :currency
-  define_attr :payment_method_id
-  define_attr :timezone
-  define_attr :address1
-  define_attr :address2
-  define_attr :company
-  define_attr :state
-  define_attr :country
-  define_attr :phone
-  define_attr :balance
-  define_attr :cba
-  define_attr :is_notified_for_invoices
-  define_attr :bill_cycle_day
+class Kaui::Account < KillBillClient::Model::Account
 
-  def initialize(data = {})
-    super(:account_id => data['accountId'],
-          :external_key => data['externalKey'],
-          :name => data['name'] || "#{data['firstName'] || ''}#{data.has_key?('firstName') ? ' ' : ''}#{data['lastName'] || ''}",
-          :first_name_length => data['length'] || (data.has_key?('firstName') ? data['firstName'].length : 0),
-          :email => data['email'],
-          :currency => data['currency'],
-          :payment_method_id => data['paymentMethodId'],
-          :timezone => data['timeZone'] || data['time_zone'] || data['timezone'],
-          :address1 => data['address1'],
-          :address2 => data['address2'],
-          :company =>  data['company'],
-          :state => data['state'],
-          :country => data['country'],
-          :phone => data['phone'],
-          :bill_cycle_day => data['billCycleDayLocal'],
-          :balance => data['accountBalance'],
-          :cba => data['accountCBA'],
-          :is_notified_for_invoices => data['isNotifiedForInvoices'])
+  def self.find_by_id_or_key(account_id_or_key, with_balance = false, with_balance_and_cba = false, options = {})
+    if account_id_or_key =~ /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}/
+      begin
+        find_by_id(account_id_or_key, with_balance, with_balance_and_cba, options)
+      rescue => e
+        begin
+          # account_id_or_key looked like an id, but maybe it's an external key (this will happen in tests)?
+          find_by_external_key(account_id_or_key, with_balance, with_balance_and_cba, options)
+        rescue => f
+          # Nope - raise the initial exception
+          raise e
+        end
+      end
+    else
+      find_by_external_key(account_id_or_key, with_balance, with_balance_and_cba, options)
+    end
   end
 
-  def to_param
-    @account_id
+  def self.list_or_search(search_key = nil, offset = 0, limit = 10, options = {})
+    if search_key.present?
+      find_in_batches_by_search_key(search_key, offset, limit, false, false, options)
+    else
+      find_in_batches(offset, limit, false, false, options)
+    end
   end
 
   def balance_to_money
-    Kaui::Base.to_money(balance.abs, currency)
+    Kaui::Base.to_money(account_balance.abs, currency)
   end
 
   def cba_to_money
-    Kaui::Base.to_money(cba.abs, currency)
+    Kaui::Base.to_money(account_cba.abs, currency)
   end
 end

data/app/models/kaui/account_email.rb

@@ -1,54 +1,17 @@
-class Kaui::AccountEmail < Kaui::Base
-  define_attr :account_id
-  define_attr :email
+class Kaui::AccountEmail < KillBillClient::Model::AccountEmailAttributes
 
-  def initialize(attributes = {})
-    super(attributes)
-
-    # We make Rails believe the id for the AccountEmail is actually the account_id
-    # (this is handy for routes and form_for helpers). Make sure though to mark it as not persisted
-    # (even though @id is not nil)
-    @persisted = false
-  end
-
-  def self.where(conditions, options_for_klient = {})
-    account_emails = Kaui::KillbillHelper.get_account_emails(conditions[:account_id], options_for_klient) || []
-    return account_emails.sort unless conditions[:email].present?
-
-    account_emails.each do |account_email|
-      return account_email if account_email.email == conditions[:email]
-    end
-    []
-  end
-
-  def save(user = nil, reason = nil, comment = nil, options_for_klient = {})
-    begin
-      Kaui::KillbillHelper.add_account_email(self, user, reason, comment, options_for_klient)
-      true
-    rescue => e
-      @errors.add(:save, "Error while trying to add an account email: #{e}")
-      false
-    end
-  end
-
-  def destroy(user = nil, reason = nil, comment = nil, options_for_klient = {})
-    begin
-      Kaui::KillbillHelper.remove_account_email(self, user, reason, comment, options_for_klient)
-      true
-    rescue => e
-      @errors.add(:destroy, "Error while trying to delete an account email: #{e}")
-    end
-  end
-
-  def id
-    to_param
-  end
-
-  def to_param
-    @account_id
+  def self.find_all_sorted_by_account_id(account_id, audit = 'NONE', options = {})
+    emails = Kaui::Account.new(:account_id => account_id).emails(audit, options)
+    emails.map { |email| Kaui::AccountEmail.new(email.to_hash) }.sort
   end
 
   def <=>(account_email)
-    @email <=> account_email.email
+    if account_email.nil?
+      -1
+    elsif account_email.email.nil?
+      email.nil? ? 0 : 1
+    else
+      email.to_s <=> account_email.email.to_s
+    end
   end
 end

data/app/models/kaui/account_timeline.rb

@@ -1,6 +1,2 @@
-class Kaui::AccountTimeline < Kaui::Base
-  has_one :account, Kaui::Account
-  has_many :payments, Kaui::Payment
-  has_many :bundles, Kaui::Bundle
-  has_many :invoices, Kaui::Invoice
+class Kaui::AccountTimeline < KillBillClient::Model::AccountTimeline
 end

data/app/models/kaui/audit_log.rb

@@ -1,17 +1,4 @@
-class Kaui::AuditLog < Kaui::Base
-  define_attr :change_date
-  define_attr :change_type
-  define_attr :changed_by
-  define_attr :comments
-  define_attr :reason_code
-
-  def initialize(data = {})
-    super(:change_date => data['changeDate'],
-          :change_type => data['changeType'],
-          :changed_by => data['changedBy'],
-          :comments => data['comments'],
-          :reason_code => data['reasonCode'])
-  end
+class Kaui::AuditLog
 
   def self.description(log)
     if log.changed_by.present?
@@ -25,5 +12,4 @@ class Kaui::AuditLog < Kaui::Base
       end
     end
   end
-
 end

data/app/models/kaui/base.rb

@@ -1,135 +1,10 @@
 class Kaui::Base
-  include Kaui::RailsMethods
-
-  attr_reader :errors
-
-  @@attribute_names = {}
-
-  def self.define_attr(*args)
-    send("attr_accessor".to_sym, *args)
-    args.each do |attr_name|
-      @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
-      @@attribute_names[self.name][attr_name.to_sym] = { :cardinality => :one }
-    end
-  end
-  define_attr :audit_logs
-
-  def self.has_one(attr_name, type = nil)
-    send("attr_accessor".to_sym, attr_name)
-    @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
-    @@attribute_names[self.name][attr_name.to_sym] = { :type => type, :cardinality => :one }
-  end
-
-  def self.has_many(attr_name, type = nil)
-    send("attr_accessor".to_sym, attr_name)
-    @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
-    @@attribute_names[self.name][attr_name.to_sym] = { :type => type, :cardinality => :many }
-  end
-
-  def self.from_json(json_text)
-    json_hash = ActiveSupport::JSON.decode(json_text)
-    return self.new(json_hash)
-  end
-
-  def initialize(attributes = {})
-    # We can come here either from the Killbill API (attributes will be a JSON hash,
-    # with camel cased keys) or from e.g. Rails forms (attributes will be a hash with
-    # snake cased keys).
-    # Either way, convert the keys to snake case as our attributes are snake cased.
-    self.attributes = Kaui::Base.convert_hash_keys(attributes)
-
-    # Make has_many associations return [] instead of nil by default
-    @@attribute_names[self.class.name].each do |name, type_desc|
-      val = send("#{name}")
-      send("#{name}=", []) if val.nil? and !type_desc.nil? and type_desc[:cardinality] == :many
-    end
-
-    # Mark the record as persisted if we have an id
-    @persisted = to_param.present?
-
-    # Errors for form validations
-    @errors = ActiveModel::Errors.new(self)
-  end
-
-  def attributes=(values)
-    values.each do |name, value|
-      type_desc = @@attribute_names[self.class.name][name.to_sym]
-      unless type_desc.nil?
-        type = type_desc[:type]
-        if type_desc[:cardinality] == :many && !type.nil? && value.is_a?(Array)
-          newValue = []
-          value.each do |val|
-            if val.is_a?(Hash)
-              newValue << type.to_s.constantize.new(val)
-            else
-              newValue << val
-            end
-          end
-          value = newValue
-        elsif type_desc[:cardinality] == :one && !type.nil? && value.is_a?(Hash)
-          value = type.to_s.constantize.new(value)
-        end
-      end
-      begin
-        send("#{name}=", value)
-      rescue NoMethodError => e
-        # Ignore new API fields
-      end
-    end
-  end
-
-  def to_hash
-    result = {}
-    @@attribute_names[self.class.name].each do |name, type_desc|
-      val = send("#{name}")
-      unless val.nil? || type_desc.nil?
-        type = type_desc[:type]
-        if type_desc[:cardinality] == :many && !type.nil? && val.is_a?(Array)
-          newVal = []
-          val.each do |curVal|
-            newVal << curVal.as_json(:root => false)
-          end
-          val = newVal
-        elsif type_desc[:cardinality] == :one && !type.nil?
-          val = val.as_json(:root => false)
-        end
-        result[name.to_s] = val
-      end
-    end
-    result
-  end
 
   def self.to_money(amount, currency)
     begin
       return Money.new(amount.to_f * 100, currency)
     rescue => e
     end if currency.present?
-    Money.new(amount.to_f * 100, "USD")
+    Money.new(amount.to_f * 100, 'USD')
   end
-
-  def self.camelize(value)
-    case value
-      when Array
-        value.map {|v| camelize(v) }
-      when Hash
-        value.inject({}) {|result, (k, v)| result.merge!(k.to_s.camelize(:lower).to_sym => camelize(v)) }
-      else
-        value
-    end
-  end
-
-  # Convert a hash with camel cased keys into a hash with snake cased keys:
-  #
-  #   { :accountId => 12 } becomes { :account_id => 12 }
-  #
-  def self.convert_hash_keys(value)
-    case value
-      when Hash
-        Hash[value.map { |k, v| [k.to_s.underscore.to_sym, convert_hash_keys(v)] }]
-      else
-        value
-     end
-  end
-
-
 end

data/app/models/kaui/bundle.rb

@@ -1,16 +1,49 @@
-class Kaui::Bundle < Kaui::Base
-  define_attr :account_id
-  define_attr :external_key
-  define_attr :bundle_id
-
-  has_many :subscriptions, Kaui::Subscription
-  has_many :audit_logs, Kaui::AuditLog
-
-  def initialize(data = {})
-    super(:external_key => data['externalKey'],
-          :bundle_id => data['bundleId'],
-          :account_id => data['accountId'],
-          :subscriptions => data['subscriptions'],
-          :audit_logs => data['auditLogs'])
+class Kaui::Bundle < KillBillClient::Model::Bundle
+
+  def self.find_by_id_or_key(bundle_id_or_key, account_id = nil, options = {})
+    if bundle_id_or_key =~ /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}/
+      find_by_id(bundle_id_or_key, options)
+    else
+      if account_id.blank?
+        # Return the active one
+        find_by_external_key(bundle_id_or_key, options)
+      else
+        # Return active and inactive ones
+        bundles = find_all_by_account_id_and_external_key(account_id, bundle_id_or_key, options)
+        get_active_bundle_or_latest_created(bundles)
+      end
+    end
+  end
+
+  def self.list_or_search(search_key = nil, offset = 0, limit = 10, options = {})
+    if search_key.present?
+      find_in_batches_by_search_key(search_key, offset, limit, options)
+    else
+      find_in_batches(offset, limit, options)
+    end
+  end
+
+  private
+
+  def self.get_active_bundle_or_latest_created(bundles)
+    return nil if bundles.empty?
+
+    latest_start_date = nil
+    latest_bundle     = nil
+
+    bundles.each do |b|
+      b.subscriptions.each do |s|
+        if s.product_category != 'ADD_ON'
+          if latest_start_date.nil? || latest_start_date < s.start_date
+            latest_start_date = s.start_date
+            latest_bundle     = b
+          end
+
+          return b if s.cancelled_date.nil? || s.cancelled_date > Time.now
+        end
+      end
+    end
+
+    latest_bundle
   end
 end

data/app/models/kaui/catalog.rb

@@ -0,0 +1,2 @@
+class Kaui::Catalog < KillBillClient::Model::Catalog
+end

data/app/models/kaui/chargeback.rb

@@ -1,37 +1,25 @@
-class Kaui::Chargeback < Kaui::Base
-  SAMPLE_REASON_CODES = [  "400 - Canceled Recurring Transaction",
-                    "401 - Cardholder Disputes Quality of Goods or Services",
-                    "402 - Cardholder Does Not Recognize Transaction",
-                    "403 - Cardholder Request Due to Dispute",
-                    "404 - Credit Not Processed",
-                    "405 - Duplicate Processing",
-                    "406 - Fraud Investigation",
-                    "407 - Fraudulent Transaction - Card Absent Environment",
-                    "408 - Incorrect Transaction Amount or Account Number",
-                    "409 - No Cardholder Authorization",
-                    "410 - Non receipt of Merchandise",
-                    "411 - Not as Described or Defective Merchandise",
-                    "412 - Recurring Payment",
-                    "413 - Request for Copy Bearing Signature",
-                    "414 - Requested Transaction Data Not Received",
-                    "415 - Services Not Provided or Merchandise not Received",
-                    "416 - Transaction Amount Differs",
-                    "417 - Validity Challenged",
-                    "418 - Unauthorized Payment",
-                    "419 - Unauthorized Claim",
-                    "420 - Not as Described",
-                    "499 - OTHER" ]
+class Kaui::Chargeback < KillBillClient::Model::Transaction
 
-  define_attr :payment_id
-  define_attr :chargeback_amount
-  define_attr :requested_date
-  define_attr :effective_date
-  define_attr :reason
-
-  has_many :audit_logs, Kaui::AuditLog
-
-  # TODO - fix chargeback json to return the currency
-  def chargeback_amount_to_money(currency)
-    Kaui::Base.to_money(chargeback_amount, currency)
-  end
-end
+  SAMPLE_REASON_CODES = ['400 - Canceled Recurring Transaction',
+                         '401 - Cardholder Disputes Quality of Goods or Services',
+                         '402 - Cardholder Does Not Recognize Transaction',
+                         '403 - Cardholder Request Due to Dispute',
+                         '404 - Credit Not Processed',
+                         '405 - Duplicate Processing',
+                         '406 - Fraud Investigation',
+                         '407 - Fraudulent Transaction - Card Absent Environment',
+                         '408 - Incorrect Transaction Amount or Account Number',
+                         '409 - No Cardholder Authorization',
+                         '410 - Non receipt of Merchandise',
+                         '411 - Not as Described or Defective Merchandise',
+                         '412 - Recurring Payment',
+                         '413 - Request for Copy Bearing Signature',
+                         '414 - Requested Transaction Data Not Received',
+                         '415 - Services Not Provided or Merchandise not Received',
+                         '416 - Transaction Amount Differs',
+                         '417 - Validity Challenged',
+                         '418 - Unauthorized Payment',
+                         '419 - Unauthorized Claim',
+                         '420 - Not as Described',
+                         '499 - OTHER']
+end

data/app/models/kaui/credit.rb

@@ -1,21 +1,6 @@
-class Kaui::Credit < Kaui::Base
-  SAMPLE_REASON_CODES = [ "100 - Courtesy",
-                          "101 - Billing Error",
-                          "199 - OTHER" ]
+class Kaui::Credit < KillBillClient::Model::Credit
 
-  define_attr :account_id
-  define_attr :invoice_id
-  define_attr :credit_amount
-  define_attr :requested_date
-  define_attr :effective_date
-  define_attr :comment
-  define_attr :reason
-
-  def initialize(data = {})
-    super(:account_id => data['accountId'] || data['account_id'],
-          :invoice_id => data['invoiceId'] || data['invoice_id'],
-          :credit_amount => data['creditAmount'] || data['credit_amount'],
-          :requested_date => data['requestedDate'] || data['requested_date'],
-          :effective_date => data['effectiveDate'] || data['effective_date'])
-  end
-end
+  SAMPLE_REASON_CODES = ['100 - Courtesy',
+                         '101 - Billing Error',
+                         '199 - OTHER']
+end

data/app/models/kaui/custom_field.rb

@@ -1,6 +1,10 @@
-class Kaui::CustomField < Kaui::Base
+class Kaui::CustomField < KillBillClient::Model::CustomField
 
-  define_attr :name
-  define_attr :value
-
-end
+  def self.list_or_search(search_key = nil, offset = 0, limit = 10, options = {})
+    if search_key.present?
+      find_in_batches_by_search_key(search_key, offset, limit, options)
+    else
+      find_in_batches(offset, limit, options)
+    end
+  end
+end