kaui 0.6.6 → 0.7.0

data/app/models/kaui/invoice.rb

@@ -1,60 +1,16 @@
-class Kaui::Invoice < Kaui::Base
-  define_attr :amount
-  define_attr :balance
-  define_attr :invoice_id
-  define_attr :account_id
-  define_attr :invoice_number
-  define_attr :payment_amount
-  define_attr :refund_adjustment
-  define_attr :credit_balance_adjustment
-  define_attr :credit_adjustment
-  define_attr :invoice_date
-  define_attr :payment_dt
-  define_attr :target_date
-  define_attr :bundle_keys
+class Kaui::Invoice < KillBillClient::Model::Invoice
 
-  has_many :items, Kaui::InvoiceItem
-  has_many :audit_logs, Kaui::AuditLog
-
-  def initialize(data = {})
-    super(:account_id => data['accountId'],
-          :amount => data['amount'],
-          :balance => data['balance'],
-          :credit_balance_adjustment => data['cba'],
-          :credit_adjustment => data['creditAdj'],
-          :invoice_date => data['invoiceDate'],
-          :invoice_id => data['invoiceId'],
-          :invoice_number => data['invoiceNumber'],
-          :refund_adjustment => data['refundAdj'],
-          :target_date => data['targetDate'],
-          :items => data['items'] || [],
-          :bundle_keys => data['bundleKeys'],
-          :audit_logs => data['auditLogs'])
-  end
-
-  # TODO - fix invoice json to return the currency
-
-  def amount_to_money(currency)
-    Kaui::Base.to_money(amount, currency)
-  end
-
-  def balance_to_money(currency)
-    Kaui::Base.to_money(balance, currency)
-  end
-
-  def payment_amount_to_money(currency)
-    Kaui::Base.to_money(payment_amount, currency)
-  end
-
-  def refund_adjustment_to_money(currency)
-    Kaui::Base.to_money(refund_adjustment, currency)
+  [:amount, :balance, :credits].each do |type|
+    define_method "#{type}_to_money" do
+      Kaui::Base.to_money(send(type), currency)
+    end
   end
 
-  def credit_balance_adjustment_to_money(currency)
-    Kaui::Base.to_money(credit_balance_adjustment, currency)
+  def refund_adjustment_to_money
+    Kaui::Base.to_money(refund_adj, currency)
   end
 
-  def credit_adjustment_to_money(currency)
-    Kaui::Base.to_money(credit_adjustment, currency)
+  def credit_adjustment_to_money
+    Kaui::Base.to_money(credit_adj, currency)
   end
 end

data/app/models/kaui/invoice_item.rb

@@ -1,24 +1,14 @@
-class Kaui::InvoiceItem < Kaui::Base
-  SAMPLE_REASON_CODES = [ "100 - Courtesy",
-                          "101 - Billing Error",
-                          "199 - OTHER" ]
+class Kaui::InvoiceItem < KillBillClient::Model::InvoiceItem
 
-  define_attr :invoice_item_id
-  define_attr :invoice_id
-  define_attr :account_id
-  define_attr :bundle_id
-  define_attr :subscription_id
-  define_attr :plan_name
-  define_attr :phase_name
-  define_attr :description
-  define_attr :start_date
-  define_attr :end_date
-  define_attr :amount
-  define_attr :currency
-  define_attr :linked_invoice_item_id
-  define_attr :audit_logs
+  SAMPLE_REASON_CODES = ['100 - Courtesy',
+                         '101 - Billing Error',
+                         '199 - OTHER']
 
   def amount_to_money
     Kaui::Base.to_money(amount, currency)
   end
+
+  def self.amount_to_money(invoice_item)
+    self.new(:amount => invoice_item.amount, :currency => invoice_item.currency).amount_to_money
+  end
 end

data/app/models/kaui/invoice_payment.rb

@@ -0,0 +1,24 @@
+class Kaui::InvoicePayment < KillBillClient::Model::InvoicePayment
+
+  SAMPLE_REASON_CODES = ['600 - Alt payment method',
+                         '699 - OTHER']
+
+  [:auth, :captured, :purchased, :refunded, :credited].each do |type|
+    define_method "#{type}_amount_to_money" do
+      Kaui::Base.to_money(send("#{type}_amount"), currency)
+    end
+  end
+
+  def paid_amount_to_money
+    captured_amount_to_money + purchased_amount_to_money
+  end
+
+  # TODO Better name?
+  def returned_amount_to_money
+    refunded_amount_to_money + credited_amount_to_money
+  end
+
+  def is_fully_refunded?
+    refunded_amount == captured_amount || refunded_amount == purchased_amount
+  end
+end

data/app/models/kaui/payment.rb

@@ -1,42 +1,24 @@
-class Kaui::Payment < Kaui::Base
+class Kaui::Payment < KillBillClient::Model::Payment
 
-  SAMPLE_REASON_CODES = [ "600 - Alt payment method",
-                          "699 - OTHER" ]
+  SAMPLE_REASON_CODES = ['600 - Alt payment method',
+                         '699 - OTHER']
 
-  define_attr :account_id
-  define_attr :amount
-  define_attr :currency
-  define_attr :invoice_id
-  define_attr :effective_date
-  define_attr :paid_amount
-  define_attr :payment_id
-  define_attr :payment_method_id
-  # TODO - is this used?
-  define_attr :refund_amount
-  define_attr :requested_date
-  define_attr :retry_count
-  define_attr :status
-  define_attr :bundle_keys
-  define_attr :ext_first_payment_id_ref
-  define_attr :ext_second_payment_id_ref
-  define_attr :gateway_error_code
-  define_attr :gateway_error_msg
-  define_attr :external
-
-  has_many :refunds, Kaui::Refund
-  has_many :chargebacks, Kaui::Chargeback
-  has_many :audit_logs, Kaui::AuditLog
-
-  def amount_to_money
-    Kaui::Base.to_money(amount, currency)
+  [:auth, :captured, :purchased, :refunded, :credited].each do |type|
+    define_method "#{type}_amount_to_money" do
+      Kaui::Base.to_money(send("#{type}_amount"), currency)
+    end
   end
 
   def paid_amount_to_money
-    Kaui::Base.to_money(paid_amount, currency)
+    captured_amount_to_money + purchased_amount_to_money
+  end
+
+  # TODO Better name?
+  def returned_amount_to_money
+    refunded_amount_to_money + credited_amount_to_money
   end
 
   def is_fully_refunded?
-    # paid_amount is the original payment amount minus the refunds
-    paid_amount == 0
+    refunded_amount == captured_amount || refunded_amount == purchased_amount
   end
 end

data/app/models/kaui/payment_method.rb

@@ -0,0 +1,36 @@
+class Kaui::PaymentMethod < KillBillClient::Model::PaymentMethod
+
+  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
+
+  def self.find_non_external_by_account_id(account_id, with_plugin_info = false, options = {})
+    payment_methods = find_all_by_account_id(account_id, with_plugin_info, options)
+    payment_methods.reject { |x| x.plugin_name == '__EXTERNAL_PAYMENT__' }
+  end
+
+  def self.payment_methods_for_payments(payments = [], options = {})
+    payment_method_per_payment = {}
+    payment_methods_cache      = {}
+    deleted_payment_methods    = Set.new
+
+    payments.each do |payment|
+      next if deleted_payment_methods.include?(payment.payment_method_id)
+
+      # The payment method may have been deleted
+      payment_methods_cache[payment.payment_method_id] ||= Kaui::PaymentMethod.find_by_id(payment.payment_method_id, true, options) rescue nil
+
+      if payment_methods_cache[payment.payment_method_id].nil?
+        deleted_payment_methods.add(payment.payment_method_id)
+      else
+        payment_method_per_payment[payment.payment_id] = payment_methods_cache[payment.payment_method_id]
+      end
+    end
+
+    payment_method_per_payment
+  end
+end

data/app/models/kaui/rails_methods.rb

@@ -1,11 +1,12 @@
 module Kaui
   module RailsMethods
-    
-    # let all the rails mocks and overrides be here
+
     def self.included(base_class)
       base_class.class_eval do
+        # Required to build urls in views
         extend  ActiveModel::Naming
         include ActiveModel::Validations
+        # Required to make form_for work
         include ActiveModel::Conversion
 
         def ==(other)
@@ -13,7 +14,8 @@ module Kaui
         end
 
         def persisted?
-          @persisted
+          # Hard to know...
+          false
         end
 
         def new_record?
@@ -21,8 +23,8 @@ module Kaui
         end
 
         def to_param
-          # id is a string (killbill UUID)
-          @id
+          # Hard to know (depends on the model)...
+          nil
         end
 
         def read_attribute_for_validation(attr)
@@ -66,11 +68,7 @@ module Kaui
         def self.find(id)
           nil
         end
-
       end # end class methods
-
     end # end def included
-
-
   end
 end

data/app/models/kaui/refund.rb

@@ -1,22 +1,7 @@
-class Kaui::Refund < Kaui::Base
-  SAMPLE_REASON_CODES = [ "500 - Courtesy",
-                          "501 - Billing Error",
-                          "502 - Alt payment method",
-                          "599 - OTHER" ]
+class Kaui::Refund
 
-  define_attr :refund_id
-  define_attr :payment_id
-  define_attr :adjusted
-  define_attr :amount
-  define_attr :currency
-  define_attr :requested_date
-  define_attr :effective_date
-  define_attr :adjustment_type
-
-  has_many :audit_logs, Kaui::AuditLog
-  has_many :adjustments, Kaui::InvoiceItem
-
-  def amount_to_money
-    Kaui::Base.to_money(amount, currency)
-  end
+  SAMPLE_REASON_CODES = ['500 - Courtesy',
+                         '501 - Billing Error',
+                         '502 - Alt payment method',
+                         '599 - OTHER']
 end

data/app/models/kaui/subscription.rb

@@ -1,30 +1,10 @@
-class Kaui::Subscription < Kaui::Base
-  define_attr :account_id
-  define_attr :subscription_id
-  define_attr :bundle_id
-  define_attr :external_key
-  define_attr :product_category
-  define_attr :product_name
-  define_attr :billing_period
-  define_attr :charged_through_date
-  define_attr :price_list
-  define_attr :start_date
-  define_attr :canceled_date
+class Kaui::Subscription < KillBillClient::Model::Subscription
 
-  has_many :events, Kaui::Event
-
-  def initialize(data = {})
-    super(:account_id =>  data['accountId'] || data['account_id'],
-          :subscription_id => data['subscriptionId'] || data['subscription_id'],
-          :bundle_id => data['bundleId'] || data['bundle_id'],
-          :external_key => data['externalKey'] || data['external_key'],
-          :product_category => data['productCategory'] || data['product_category'],
-          :product_name => data['productName'] || data['product_name'],
-          :billing_period => data['billingPeriod'] || data['billing_period'],
-          :charged_through_date => data['chargedThroughDate'] || data['charged_through_date'],
-          :price_list => data['priceList'] || data['price_list'],
-          :start_date => data['startDate'] || data['start_date'],
-          :canceled_date => data['cancelledDate'] || data['canceled_date'],
-          :events => data['events'])
+  def cancel_entitlement_immediately(user = nil, reason = nil, comment = nil, options = {})
+    requested_date                 = nil
+    entitlement_policy             = 'IMMEDIATE'
+    billing_policy                 = nil
+    use_requested_date_for_billing = true
+    cancel(user, reason, comment, requested_date, entitlement_policy, billing_policy, use_requested_date_for_billing, options)
   end
 end

data/app/models/kaui/tag.rb

@@ -1,14 +1,18 @@
-class Kaui::Tag < Kaui::Base
+class Kaui::Tag < KillBillClient::Model::Tag
 
-  define_attr :tag_definition_id
-  define_attr :tag_definition_name
-  define_attr :audit_logs
+  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
 
   def is_system_tag?
     Kaui::TagDefinition(:id => tag_definition_id).is_system_tag?
   end
 
   def <=>(tag)
-    @tag_definition_name <=> tag.tag_definition_name
+    tag_definition_name.downcase <=> tag.tag_definition_name.downcase
   end
-end
+end

data/app/models/kaui/tag_definition.rb

@@ -1,36 +1,28 @@
-class Kaui::TagDefinition < Kaui::Base
-
-  define_attr :id
-  define_attr :name
-  define_attr :description
-  define_attr :is_control_tag
-  define_attr :applicable_object_types
-
-  def self.all(options_for_klient = {})
-    Kaui::KillbillHelper.get_tag_definitions(options_for_klient)
-  end
-
-  def self.find(tag_definition_id, options_for_klient = {})
-    Kaui::KillbillHelper.get_tag_definition(tag_definition_id, options_for_klient)
-  end
-
-  # See com.ning.billing.util.dao.ObjectType in killbill-api
-  %w(ACCOUNT ACCOUNT_EMAIL BUNDLE INVOICE PAYMENT INVOICE_ITEM INVOICE_PAYMENT
-     SUBSCRIPTION SUBSCRIPTION_EVENT PAYMENT_METHOD REFUND TAG_DEFINITION).each do |object_type|
-       define_singleton_method "all_for_#{object_type.downcase}" do |options_for_klient|
-         self.all(options_for_klient).delete_if { |tag_definition| !tag_definition.applicable_object_types.include? object_type }
-       end
-  end
-
-  def save(user = nil, reason = nil, comment = nil, options_for_klient = {})
-    Kaui::KillbillHelper.create_tag_definition(self, user, reason, comment, options_for_klient)
-    # TODO - we should return the newly created id and update the model
-    # @persisted = true
-  end
-
-  def destroy(user = nil, reason = nil, comment = nil, options_for_klient = {})
-    Kaui::KillbillHelper.delete_tag_definition(@id, user, reason, comment, options_for_klient)
-    @persisted = false
+class Kaui::TagDefinition < KillBillClient::Model::TagDefinition
+
+  # See org.killbill.billing.ObjectType in killbill-api
+  %w(ACCOUNT
+     ACCOUNT_EMAIL
+     BLOCKING_STATES
+     BUNDLE
+     CUSTOM_FIELD
+     INVOICE
+     PAYMENT
+     TRANSACTION
+     INVOICE_ITEM
+     INVOICE_PAYMENT
+     SUBSCRIPTION
+     SUBSCRIPTION_EVENT
+     PAYMENT_ATTEMPT
+     PAYMENT_METHOD
+     REFUND
+     TAG
+     TAG_DEFINITION
+     TENANT
+     TENANT_KVS).each do |object_type|
+    define_singleton_method "all_for_#{object_type.downcase}" do |options_for_klient|
+      (self.all('NONE', options_for_klient).delete_if { |tag_definition| !tag_definition.applicable_object_types.include? object_type }).sort
+    end
   end
 
   def is_system_tag?
@@ -51,6 +43,6 @@ class Kaui::TagDefinition < Kaui::Base
     # System tags last
     return 1 if is_system_tag? and !tag_definition.is_system_tag?
     return -1 if !is_system_tag? and tag_definition.is_system_tag?
-    @name <=> tag_definition.name
+    name <=> tag_definition.name
   end
 end

data/app/models/kaui/transaction.rb

@@ -0,0 +1,30 @@
+class Kaui::Transaction < KillBillClient::Model::Transaction
+
+  def create(account_id = nil, payment_method_id = nil, user = nil, reason = nil, comment = nil, options = {})
+    if transaction_type == 'AUTHORIZE'
+      auth(account_id, payment_method_id, user, reason, comment, options)
+    elsif transaction_type == 'CAPTURE'
+      capture(user, reason, comment, options)
+    elsif transaction_type == 'CHARGEBACK'
+      chargeback(user, reason, comment, options)
+    elsif transaction_type == 'CREDIT'
+      credit(account_id, payment_method_id, user, reason, comment, options)
+    elsif transaction_type == 'PURCHASE'
+      purchase(account_id, payment_method_id, user, reason, comment, options)
+    elsif transaction_type == 'REFUND'
+      refund(user, reason, comment, options)
+    elsif transaction_type == 'VOID'
+      void(user, reason, comment, options)
+    else
+      raise ArgumentError.new("Unknown transaction type #{transaction_type}")
+    end
+  end
+
+  def amount_to_money
+    Kaui::Base.to_money(amount, currency)
+  end
+
+  def self.amount_to_money(transaction)
+    self.new(:amount => transaction.amount, :currency => transaction.currency).amount_to_money
+  end
+end

data/app/models/kaui/user.rb

@@ -33,6 +33,8 @@ module Kaui
                                                              :api_key => api_key,
                                                              :api_secret => api_secret
       subject.is_authenticated
+    rescue KillBillClient::API::Unauthorized => e
+      false
     end
 
     private

data/app/views/kaui/account_emails/_form.html.erb

@@ -1,33 +1,13 @@
 <%= form_for(@account_email) do |f| %>
-  <% if @account_email.errors.any? %>
-    <div class='alert alert-error'>
-      <h2><%= pluralize(@account_email.errors.count, 'error') %> prohibited this account email from being saved:</h2>
-
-      <ul>
-      <% @account_email.errors.full_messages.each do |msg| %>
-        <li><%= msg %></li>
-      <% end %>
-      </ul>
+    <%= f.hidden_field :account_id %>
+    <div class='control-group'>
+      <%= f.label :email, 'Email *', :class => 'control-label' %>
+      <div class='controls'>
+        <%= f.text_field :email, :required => true %>
+      </div>
     </div>
-  <% end %>
 
-  <div class='control-group'>
-    <%= f.label :account_id, 'Account Id:', :class => 'control-label' %>
-    <div class='controls'>
-      <%= f.text_field :account_id, :class => 'input-xlarge' %>
-    </div>
-  </div>
-  <div class='control-group'>
-    <%= f.label :email, 'Email:', :class => 'control-label' %>
-    <div class='controls'>
-        <%= f.text_field :email %>
+    <div class="form-actions">
+      <%= button_tag 'Create email', :class => 'btn btn-primary' %>
     </div>
-  </div>
-  <div class='form-actions'>
-    <%= f.submit @account_email.new_record? ? 'Create' : 'Update', :class => 'btn btn-primary' %>
-    <% unless @account_email.new_record? %>
-      <%= link_to 'Show', @account_email, :class => 'btn' %>
-    <% end %>
-    <%= link_to 'Back', :back, :class => 'btn' %>
-  </div>
 <% end %>

data/app/views/kaui/account_emails/show.html.erb

@@ -2,24 +2,24 @@
 
 <table id='invoice_table' class='table table-condensed data-table'>
   <thead>
-    <tr>
-      <th style='width: 45%'>Account id</th>
-      <th style='width: 45%'>Email</th>
-      <th style='width: 10%'></th>
-    </tr>
+  <tr>
+    <th style='width: 45%'>Account id</th>
+    <th style='width: 45%'>Email</th>
+    <th style='width: 10%'></th>
+  </tr>
   </thead>
   <tbody>
-    <% @account_emails.each do |account_email| %>
+  <% @account_emails.each do |account_email| %>
       <tr>
-        <td><%= link_to account_email.account_id, kaui_engine.account_path(account_email.account_id) %></td>
+        <td><%= link_to truncate_uuid(account_email.account_id), kaui_engine.account_path(account_email.account_id) %></td>
         <td><%= account_email.email %></td>
         <td><%= link_to 'Destroy', kaui_engine.account_email_path(account_email.account_id, :email => account_email.email), :confirm => 'Are you sure?', :method => :delete %></td>
       </tr>
-    <% end %>
+  <% end %>
   </tbody>
 </table>
 
-<br />
+<br/>
 
 <%= link_to 'New account email', kaui_engine.new_account_email_path(:account_id => @account_id), :class => 'btn btn-primary' %>
-<%= link_to 'Back to account', kaui_engine.account_path(@account_id), :class => 'btn' %>
+<%= link_to 'Back to account', kaui_engine.account_path(@account_id), :class => 'btn' %>

data/app/views/kaui/account_tags/_account_tags_table.html.erb

@@ -3,28 +3,30 @@
 </div>
 <table class="table table-condensed table-striped data-table">
   <thead>
-    <tr>
-      <th>Tag Name</th>
-      <th>Executed date</th>
-      <th>Execution type</th>
-      <th>Executed by</th>
-      <th>Comments</th>
-    </tr>
+  <tr>
+    <th>Tag Name</th>
+    <th>Executed date</th>
+    <th>Execution type</th>
+    <th>Executed by</th>
+    <th>Comments</th>
+  </tr>
   </thead>
   <tbody>
-    <% if @tags.present? %>
+  <% if @tags.present? %>
       <% @tags.each do |tag| %>
-        <% tag.audit_logs.each do |log| %>
-          <tr>
-            <td><%= link_to tag.tag_definition_name, tag_definition_path(:id => tag.tag_definition_id) %></td>
-            <td><%= format_date(log.change_date, @account.timezone).html_safe if log.change_date.present? %></td>
-            <td><span <% if log.change_type != 'INSERT' %>class='alert-error' <% else %>class='alert-success' <% end %>><%= log.change_type %></span></td>
-            <td><%= log.changed_by %></td>
-            <td><%= log.reason_code %> <%= log.comments %></td>
-          </tr>
-        <% end %>
+          <% tag.audit_logs.each do |log| %>
+              <tr>
+                <td><%= link_to tag.tag_definition_name, tag_definition_path(:id => tag.tag_definition_id) %></td>
+                <td><%= format_date(log.change_date, @account.time_zone).html_safe if log.change_date.present? %></td>
+                <td><span
+                <% if log.change_type != 'INSERT' %>class='alert-error'
+                <% else %>class='alert-success' <% end %>><%= log.change_type %></span></td>
+                <td><%= log.changed_by %></td>
+                <td><%= log.reason_code %> <%= log.comments %></td>
+              </tr>
+          <% end %>
       <% end %>
-    <% end %>
+  <% end %>
   </tbody>
 </table>
 

data/app/views/kaui/account_tags/_form.html.erb

@@ -0,0 +1,42 @@
+<%= form_tag update_account_tags_path, :class => 'form-horizontal' do %>
+    <%= hidden_field_tag :account_id, @account.account_id %>
+    <fieldset>
+      <div class='control-group'>
+        <label class='control-label'>Account name</label>
+
+        <div class='controls'>
+          <label class='checkbox'>
+            <%= link_to @account.name, @account %><br/>
+            <%= @account.email %>
+          </label>
+        </div>
+      </div>
+      <div class='control-group'>
+        <%= label_tag :name, 'Tag', :class => 'control-label' %>
+        <div class='controls'>
+          <% @available_tags.each do |tag| %>
+              <label class='checkbox'>
+                <%= check_box_tag "tag_#{tag.id}", tag.name, @tag_names.include?(tag.name) %>
+                <span href='#' class='tag-description' rel='tooltip' title='<%= tag.description %>'><%= tag.name %></span>
+              </label>
+          <% end %>
+        </div>
+      </div>
+
+      <div class='control-group'>
+        <%= label_tag :comment, 'Comment', :class => "control-label" %>
+        <div class="controls">
+          <%= text_area_tag :comment, '', :rows => 3, :class => 'input-xlarge' %>
+        </div>
+      </div>
+
+      <div class='form-actions'>
+        <%= button_tag 'Update', :class => 'btn btn-primary' %>
+      </div>
+    </fieldset>
+<% end %>
+<%= javascript_tag do %>
+$(function() {
+  $('.tag-description').tooltip();
+});
+<% end %>