rconomic 0.4 → 0.4.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTMxZDg2MjQyNWQ5ZmY1MWIzZmI3YmFhNWZkYmJkODBjOTJkMTc1OQ==
+  data.tar.gz: !binary |-
+    ZGYxYjM4MjI1N2E1MmM4ZWY4ZWJhZTVlMWRkOWZmM2E4MmVkNWNlMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGFlMzg5YTc1MDZhOTA2NjdjMmJlYWFjMGQzZWE4NjlkY2Y4OTJjYTQ1Yzkx
+    MWQ0OTY2YjRlNmZjODljZjk2ZDBiOTg0N2U1OTgwZGZhYjM2MzkyY2ExM2Nk
+    ZGE1NTkyZjg2NWEyNzM0MTJiMmE0NzVhOTY1ZDI0ZjhjOWNiYmU=
+  data.tar.gz: !binary |-
+    NmJkOTk0MmExOTgwYmIwMGQyMGNkMjdhODUwZTY5MWY1OGQwYzNlNGJmMGNh
+    NjU1ZjdkYWVmNTNmYjJlYzcyZjRiZmMxYTRiNzUzZWRhODZlNWE5MzAwY2Rh
+    NDA3YTFlODExYjM0NjFiZGUyNjM3MDk4YjNmNTM3M2FlNWNkZGM=

data/.travis.yml

@@ -4,9 +4,8 @@ rvm:
   - 1.9.2
   - 1.9.3
   - ree
-  - rbx
 
 # Specify the recipients for email notification
 notifications:
   recipients:
-    - jakob@mentalized.net
+    - jakob@mentalized.net

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec
 

data/README.md

@@ -3,7 +3,7 @@ r-conomic
 
 Ruby wrapper for the [e-conomic](http://www.e-conomic.co.uk) SOAP API, that aims at making working with the API bearable.
 
-E-conomic is a web-based accounting system. For their marketing speak, see [http://www.e-conomic.co.uk/about/](). More details about their API at [http://www.e-conomic.co.uk/integration/integration-partner/]().
+E-conomic is a web-based accounting system. For their marketing speak, see [http://www.e-conomic.co.uk/about/](). More details about their API at [http://www.e-conomic.com/developer]().
 
 [![Build Status](https://secure.travis-ci.org/lokalebasen/rconomic.png?branch=master)](http://travis-ci.org/lokalebasen/rconomic)
 

data/lib/economic/account.rb

@@ -6,7 +6,7 @@ module Economic
     
     
     def handle
-      Handle.new({:name => @name})
+      Handle.build({:name => @name})
     end
     
     
@@ -22,4 +22,4 @@ module Economic
       return data
     end
   end
-end
+end

data/lib/economic/cash_book.rb

@@ -9,7 +9,7 @@ module Economic
     has_properties :name, :number
 
     def handle
-      Handle.new({:number => @number})
+      @handle ||= Handle.new({:number => @number})
     end
 
     def entries

data/lib/economic/cash_book_entry.rb

@@ -1,7 +1,6 @@
 require 'economic/entity'
 
 module Economic
-
   # Represents a cash book in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICashBook.html
@@ -37,8 +36,39 @@ module Economic
                    :vat_account_handle,
                    :voucher_number
 
+    defaults(
+     :account_handle => nil,
+     :amount => 0,
+     :amount_default_currency => 0,
+     :bank_payment_creditor_id => nil,
+     :bank_payment_creditor_invoice_id => nil,
+     :bank_payment_type_handle => nil,
+     :capitalise_handle => nil,
+     :cash_book_handle => nil,
+     :contra_account_handle => nil,
+     :contra_vat_account_handle => nil,
+     :cost_type_handle => nil,
+     :creditor_handle => nil,
+     :creditor_invoice_number => nil,
+     :currency_handle => nil,
+     :date => Time.now,
+     :debtor_handle => nil,
+     :debtor_invoice_number => nil,
+     :department_handle => nil,
+     :distribution_key_handle => nil,
+     :due_date => nil,
+     :employee_handle => nil,
+     :end_date => nil,
+     :project_handle => nil,
+     :start_date => Time.now,
+     :text => "",
+     :type => "",
+     :vat_account_handle => nil,
+     :voucher_number => 0
+    )
+
     def handle
-      Handle.new(:id1 => @id1, :id2 => @id2)
+      @handle ||= Handle.new(:id1 => @id1, :id2 => @id2)
     end
 
     protected
@@ -46,7 +76,7 @@ module Economic
     def build_soap_data
       data = ActiveSupport::OrderedHash.new
 
-      data['Handle'] = handle.to_hash unless handle.to_hash.empty?
+      data['Handle'] = handle.to_hash unless handle.empty?
       data['Id1'] = id1 unless id1.blank?
       data['Id2'] = id2 unless id2.blank?
       data['Type'] = type unless type.blank?
@@ -80,38 +110,5 @@ module Economic
 
       return data
     end
-
-    def initialize_defaults
-      self.account_handle = nil
-      self.amount = 0
-      self.amount_default_currency = 0
-      self.bank_payment_creditor_id = nil
-      self.bank_payment_creditor_invoice_id = nil
-      self.bank_payment_type_handle = nil
-      self.capitalise_handle = nil
-      self.cash_book_handle = nil
-      self.contra_account_handle = nil
-      self.contra_vat_account_handle = nil
-      self.cost_type_handle = nil
-      self.creditor_handle = nil
-      self.creditor_invoice_number = nil
-      self.currency_handle = nil
-      self.date = Time.now
-      self.debtor_handle = nil
-      self.debtor_invoice_number = nil
-      self.department_handle = nil
-      self.distribution_key_handle = nil
-      self.due_date = nil
-      self.employee_handle = nil
-      self.end_date = nil
-      self.project_handle = nil
-      self.start_date = Time.now
-      self.text = ""
-      self.type = ""
-      self.vat_account_handle = nil
-      self.voucher_number = 0
-    end
-
-
   end
 end

data/lib/economic/creditor.rb

@@ -22,10 +22,10 @@ module Economic
   #   creditor.term_of_payment = 1
   #   creditor.save
   class Creditor < Entity
-    has_properties :handle, :number, :creditor_group_handle, :name, :vat_zone, :currency_handle, :term_of_payment_handle, :is_accessible, :ci_number, :email, :address, :postal_code, :city, :country, :bank_account, :attention_handle, :your_reference_handle, :our_reference_handle, :default_payment_type_handle, :default_payment_creditor_id, :county, :auto_contra_account_handle
+    has_properties :number, :creditor_group_handle, :name, :vat_zone, :currency_handle, :term_of_payment_handle, :is_accessible, :ci_number, :email, :address, :postal_code, :city, :country, :bank_account, :attention_handle, :your_reference_handle, :our_reference_handle, :default_payment_type_handle, :default_payment_creditor_id, :county, :auto_contra_account_handle
 
     def handle
-      Handle.new({:number => @number})
+      @handle ||= Handle.build({:number => @number})
     end
 
     # Returns the Creditors contacts

data/lib/economic/creditor_contact.rb

@@ -18,10 +18,10 @@ module Economic
   #   contact.name = 'John Appleseed'
   #   contact.save
   class CreditorContact < Entity
-    has_properties :handle, :id, :creditor_handle, :name, :number, :telephone_number, :email, :comments, :external_id
+    has_properties :id, :creditor_handle, :name, :number, :telephone_number, :email, :comments, :external_id
 
     def creditor
-      return nil if creditor_handle.blank?
+      return nil if creditor_handle.nil?
       @creditor ||= session.creditors.find(creditor_handle[:number])
     end
 
@@ -36,7 +36,7 @@ module Economic
     end
 
     def handle
-      Handle.new({:id => @id})
+      @handle ||= Handle.build({:id => @id})
     end
 
     protected

data/lib/economic/current_invoice.rb

@@ -28,12 +28,30 @@ module Economic
   class CurrentInvoice < Entity
     has_properties :id, :debtor_handle, :debtor_name, :debtor_address, :debtor_postal_code, :debtor_city, :debtor_country, :attention_handle, :date, :term_of_payment_handle, :due_date, :currency_handle, :exchange_rate, :is_vat_included, :layout_handle, :delivery_date, :net_amount, :vat_amount, :gross_amount, :margin, :margin_as_percent, :heading
 
+    defaults(
+      :id => 0,
+      :date => Time.now,
+      :term_of_payment_handle => nil,
+      :due_date => nil,
+      :currency_handle => nil,
+      :exchange_rate => 100, # Why am _I_ inputting this?
+      :is_vat_included => nil,
+      :layout_handle => nil,
+      :delivery_date => nil,
+      :heading => nil,
+      :net_amount => 0,
+      :vat_amount => 0,
+      :gross_amount => 0,
+      :margin => 0,
+      :margin_as_percent => 0 # Why do I have to input both Margin and MarginAsPercent? Shouldn't powerful Windows machines running ASP.NET be able to compute this?
+    )
+
     def initialize(properties = {})
       super
     end
 
     def attention
-      return nil if attention_handle.blank?
+      return nil if attention_handle.nil?
       @attention ||= session.contacts.find(attention_handle)
     end
 
@@ -78,7 +96,7 @@ module Economic
     end
 
     def debtor
-      return nil if debtor_handle.blank?
+      return nil if debtor_handle.nil?
       @debtor ||= session.debtors.find(debtor_handle)
     end
 
@@ -93,19 +111,21 @@ module Economic
     end
 
     def handle
-      Handle.new(:id => @id)
+      @handle ||= Handle.new(:id => @id)
     end
 
-    # Returns the current invoice lines of CurrentInvoice
     def lines
       @lines ||= CurrentInvoiceLineProxy.new(self)
     end
 
     def save
+      lines = self.lines
+
       result = super
-      id = result[:id]
+      self.id = result[:id].to_i
+      @handle = nil # Reset a memoized handle, leaving it up to #handle to recreate it with correct id
 
-      self.lines.each do |invoice_line|
+      lines.each do |invoice_line|
         invoice_line.session = session
         invoice_line.invoice = self
         invoice_line.save
@@ -114,24 +134,6 @@ module Economic
 
     protected
 
-    def initialize_defaults
-      self.id = 0
-      self.date = Time.now
-      self.term_of_payment_handle = nil
-      self.due_date = nil
-      self.currency_handle = nil
-      self.exchange_rate = 100 # Why am _I_ inputting this?
-      self.is_vat_included = nil
-      self.layout_handle = nil
-      self.delivery_date = nil
-      self.heading = nil
-      self.net_amount = 0
-      self.vat_amount = 0
-      self.gross_amount = 0
-      self.margin = 0
-      self.margin_as_percent = 0 # Why do I have to input both Margin and MarginAsPercent? Shouldn't powerful Windows machines running ASP.NET be able to compute this?
-    end
-
     # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
     # to be sent via SOAP
     def build_soap_data
@@ -162,7 +164,6 @@ module Economic
 
       return data
     end
-
   end
 
 end

data/lib/economic/current_invoice_line.rb

@@ -9,10 +9,25 @@ module Economic
   #
   # See Economic::CurrentInvoice for usage example
   class CurrentInvoiceLine < Entity
-    has_properties :invoice_handle, :description, :delivery_date, :unit_handle, :product_handle, :quantity, :unit_net_price, :discount_as_percent, :unit_cost_price, :total_net_amount, :total_margin, :margin_as_percent
+    has_properties :number, :invoice_handle, :description, :delivery_date, :unit_handle, :product_handle, :quantity, :unit_net_price, :discount_as_percent, :unit_cost_price, :total_net_amount, :total_margin, :margin_as_percent
+
+    defaults(
+      :invoice_handle => nil,
+      :description => nil,
+      :delivery_date => nil,
+      :unit_handle => nil,
+      :product_handle => nil,
+      :quantity => nil,
+      :unit_net_price => nil,
+      :discount_as_percent => 0,
+      :unit_cost_price => 0,
+      :total_net_amount => nil,
+      :total_margin => 0,
+      :margin_as_percent => 0
+    )
 
     def handle
-      Handle.new(:number => number)
+      @handle ||= Handle.build(:number => number)
     end
 
     def invoice
@@ -32,21 +47,6 @@ module Economic
 
     protected
 
-    def initialize_defaults
-      self.invoice_handle = nil
-      self.description = nil
-      self.delivery_date = nil
-      self.unit_handle = nil
-      self.product_handle = nil
-      self.quantity = nil
-      self.unit_net_price = nil
-      self.discount_as_percent = 0
-      self.unit_cost_price = 0
-      self.total_net_amount = nil
-      self.total_margin = 0
-      self.margin_as_percent = 0
-    end
-
     # Returns OrderedHash with the properties of CurrentInvoice in the correct order, camelcased and ready
     # to be sent via SOAP
     def build_soap_data

data/lib/economic/debtor.rb

@@ -25,10 +25,10 @@ module Economic
   #   debtor.layout_handle = { :id => 16 }
   #   debtor.save
   class Debtor < Entity
-    has_properties :handle, :number, :debtor_group_handle, :name, :vat_zone, :currency_handle, :price_group_handle, :is_accessible, :ean, :public_entry_number, :email, :telephone_and_fax_number, :website, :address, :postal_code, :city, :country, :credit_maximum, :vat_number, :county, :ci_number, :term_of_payment_handle, :layout_handle, :attention_handle, :your_reference_handle, :our_reference_handle, :balance
+    has_properties :number, :debtor_group_handle, :name, :vat_zone, :currency_handle, :price_group_handle, :is_accessible, :ean, :public_entry_number, :email, :telephone_and_fax_number, :website, :address, :postal_code, :city, :country, :credit_maximum, :vat_number, :county, :ci_number, :term_of_payment_handle, :layout_handle, :attention_handle, :your_reference_handle, :our_reference_handle, :balance
 
     def handle
-      Handle.new({:number => @number})
+      @handle ||= Handle.new({:number => @number})
     end
 
     # Returns the Debtors contacts
@@ -79,4 +79,4 @@ module Economic
 
   end
 
-end
+end

data/lib/economic/debtor_contact.rb

@@ -18,10 +18,10 @@ module Economic
   #   contact.name = 'John Appleseed'
   #   contact.save
   class DebtorContact < Entity
-    has_properties :handle, :id, :debtor_handle, :name, :number, :telephone_number, :email, :comments, :external_id, :is_to_receive_email_copy_of_order, :is_to_receive_email_copy_of_invoice
+    has_properties :id, :debtor_handle, :name, :number, :telephone_number, :email, :comments, :external_id, :is_to_receive_email_copy_of_order, :is_to_receive_email_copy_of_invoice
 
     def debtor
-      return nil if debtor_handle.blank?
+      return nil if debtor_handle.nil?
       @debtor ||= session.debtors.find(debtor_handle[:number])
     end
 
@@ -36,7 +36,7 @@ module Economic
     end
 
     def handle
-      Handle.new({:id => @id})
+      @handle ||= Handle.new({:id => @id})
     end
 
     protected
@@ -61,4 +61,4 @@ module Economic
 
   end
 
-end
+end

data/lib/economic/debtor_entry.rb

@@ -7,8 +7,7 @@ module Economic
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IDebtorEntry.html
 
   class DebtorEntry < Entity
-    has_properties :handle,
-      :serial_number,
+    has_properties :serial_number,
       :type,
       :date,
       :debtor_handle,

data/lib/economic/entity/handle.rb

@@ -1,6 +1,19 @@
 class Economic::Entity
   class Handle
-    attr_accessor :id, :id1, :id2, :number
+    attr_accessor :id, :id1, :id2, :number, :serial_number
+
+    def self.build(options)
+      return options if options.is_a?(Handle)
+      return nil if options.nil?
+      new(options)
+    end
+
+    # Returns true if Handle hasn't been initialized with any values yet. This
+    # usually happens when the handle is constructed for an entity whose id
+    # properties (id, number, etc) haven't been set yet.
+    def empty?
+      to_hash.empty?
+    end
 
     def initialize(hash)
       verify_sanity_of_arguments!(hash)
@@ -10,29 +23,38 @@ class Economic::Entity
       @id1 = hash[:id1].to_i if hash[:id1]
       @id2 = hash[:id2].to_i if hash[:id2]
       @number = hash[:number].to_i if hash[:number]
+      @serial_number = hash[:serial_number].to_i if hash[:serial_number]
     end
 
-    def to_hash
+    def to_hash(only_keys = id_properties.keys)
+      only_keys = [only_keys].flatten
       hash = {}
-      hash['Id'] = id unless id.blank?
-      hash['Id1'] = id1 unless id1.blank?
-      hash['Id2'] = id2 unless id2.blank?
-      hash['Number'] = number unless number.blank?
+      hash['Id'] = id if only_keys.include?(:id) && !id.blank?
+      hash['Id1'] = id1 unless id1.blank? if only_keys.include?(:id1)
+      hash['Id2'] = id2 unless id2.blank? if only_keys.include?(:id2)
+      hash['Number'] = number unless number.blank? if only_keys.include?(:number)
+      hash['SerialNumber'] = serial_number unless serial_number.blank? if only_keys.include?(:serial_number)
       hash
     end
 
     def [](key)
-      {:id => @id, :id1 => @id1, :id2 => @id2, :number => @number}[key]
+      {:id => @id, :id1 => @id1, :id2 => @id2, :number => @number, :serial_number => @serial_number}[key]
     end
 
     def ==(other)
+      return true if self.object_id == other.object_id
       return false if other.nil?
+      return false if empty? || (other.respond_to?(:empty?) && other.empty?)
       return false unless other.respond_to?(:id) && other.respond_to?(:number)
       self.id == other.id && self.number == other.number && self.id1 == other.id1 && self.id2 == other.id2
     end
 
   private
 
+    def id_properties
+      {:id => 'Id', :id1 => 'Id1', :id2 => 'Id2', :number => 'Number', :serial_number => 'SerialNumber'}
+    end
+
     # Raises exceptions if hash doesn't contain values we can use to construct a new handle
     def verify_sanity_of_arguments!(hash)
       return if hash.is_a?(self.class)
@@ -42,7 +64,7 @@ class Economic::Entity
       end
 
       if hash.respond_to?(:keys)
-        unknown_keys = hash.keys - [:id, :id1, :id2, :number, "Number", "Id", "Id1", "Id2"]
+        unknown_keys = hash.keys - id_properties.keys - id_properties.values
         raise ArgumentError.new("Unknown keys in handle: #{unknown_keys.inspect}") unless unknown_keys.empty?
 
         not_to_iable = hash.select { |k, v| !v.respond_to?(:to_i) }

data/lib/economic/entity.rb

@@ -6,6 +6,16 @@ module Economic
     attr_accessor :persisted, :session, :partial
 
     class << self
+      # Sets default property values that an entity should be initialized with
+      def defaults(default_values)
+        @default_values = default_values
+      end
+
+      # Returns the default values for properties
+      def default_values
+        @default_values || {}
+      end
+
       def properties_not_triggering_full_load
         [:id, :number, :handle]
       end
@@ -13,7 +23,7 @@ module Economic
       def has_properties(*properties)
         @properties = properties
         properties.each do |property|
-          unless properties_not_triggering_full_load.include?(property) || instance_methods.collect(&:to_s).include?(property.to_s)
+          unless properties_not_triggering_full_load.include?(property)
             # Create property accessors that loads the full Entity from the API if necessary
             define_method "#{property}" do
               value = instance_variable_get("@#{property}")
@@ -61,7 +71,11 @@ module Economic
     end
 
     def handle
-      Handle.new({:number => @number, :id => @id})
+      @handle ||= Handle.build({:number => @number, :id => @id})
+    end
+
+    def handle=(handle)
+      @handle = Handle.build(handle)
     end
 
     def initialize(properties = {})
@@ -173,6 +187,10 @@ module Economic
       return response
     end
 
+    def defaults
+      self.class.default_values
+    end
+
     def update
       response = session.request soap_action(:update_from_data) do
         soap.body = {'data' => build_soap_data}
@@ -201,7 +219,9 @@ module Economic
     end
 
     def initialize_defaults
-      nil
+      defaults.each do |property_name, default_value|
+        self.send("#{property_name}=", default_value)
+      end
     end
   end
 

data/lib/economic/entry.rb

@@ -7,8 +7,7 @@ module Economic
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IEntry.html
 
   class Entry < Entity
-    has_properties :handle,
-      :serial_number,
+    has_properties :serial_number,
       :account_handle,
       :amount,
       :amount_default_currency,

data/lib/economic/invoice.rb

@@ -5,7 +5,7 @@ module Economic
     has_properties :number, :net_amount, :vat_amount, :due_date, :debtor_handle, :debtor_name, :debtor_name, :debtor_address, :debtor_postal_code, :debtor_city, :debtor_country, :debtor_ean, :attention_handle, :heading
 
     def attention
-      return nil if attention_handle.blank?
+      return nil if attention_handle.nil?
       @attention ||= session.contacts.find(attention_handle)
     end
 
@@ -20,7 +20,7 @@ module Economic
     end
 
     def debtor
-      return nil if debtor_handle.blank?
+      return nil if debtor_handle.nil?
       @debtor ||= session.debtors.find(debtor_handle)
     end
 

data/lib/economic/proxies/actions/find_by_ci_number.rb

@@ -0,0 +1,25 @@
+module FindByCiNumber
+  # Returns Debtors that have the given ci_number. The Debtor objects will only be partially loaded
+  def find_by_ci_number(ci_number)
+    # Get a list of handles from e-conomic
+    response = session.request entity_class.soap_action('FindByCINumber') do
+      soap.body = {
+        'ciNumber' => ci_number
+      }
+    end
+
+    # Make sure we always have an array of handles even if the result only contains one
+    handle_key = "#{entity_class_name.downcase}_handle".intern
+    handles = [response[handle_key]].flatten.reject(&:blank?)
+
+    # Create partial Debtor entities
+    handles.collect do |handle|
+      entity = build
+      entity.partial = true
+      entity.persisted = true
+      entity.handle = handle
+      entity.number = handle[:number]
+      entity
+    end
+  end
+end

data/lib/economic/proxies/actions/find_by_date_interval.rb

@@ -0,0 +1,27 @@
+module Economic
+  module FindByDateInterval
+
+    # Returns entity objects for a given interval of days.
+    def find_by_date_interval(from, unto)
+      response = session.request entity_class.soap_action("FindByDateInterval") do
+        soap.body = {
+          'first' => from.iso8601,
+          'last' => unto.iso8601,
+          :order! => ['first', 'last']
+        }
+      end
+
+      handle_key = "#{Support::String.underscore(entity_class_name)}_handle".intern
+      handles = [ response[handle_key] ].flatten.reject(&:blank?).collect do |handle|
+        Entity::Handle.build(handle)
+      end
+
+      get_data_array(handles).collect do |entity_hash|
+        entity = build(entity_hash)
+        entity.persisted = true
+        entity
+      end
+    end
+
+  end
+end

data/lib/economic/proxies/actions/find_by_handle_with_number.rb

@@ -0,0 +1,12 @@
+# Use FindByHandleWithNumber when the SOAP action to find entity requires
+# `Number` to be passed rather than the default `Id`
+module FindByHandleWithNumber
+  def find(handle)
+    handle = if handle.respond_to?(:to_i)
+      Economic::Entity::Handle.build(:number => handle.to_i)
+    else
+      Economic::Entity::Handle.build(handle)
+    end
+    super(handle)
+  end
+end

data/lib/economic/proxies/actions/find_by_number.rb

@@ -0,0 +1,21 @@
+module FindByNumber
+  # Returns handle with a given number.
+  def find_by_number(number)
+    response = session.request(entity_class.soap_action('FindByNumber')) do
+      soap.body = {
+        'number' => number
+      }
+    end
+
+    if response == {}
+      nil
+    else
+      entity = build
+      entity.partial = true
+      entity.persisted = true
+      entity.handle = response
+      entity.number = response[:number].to_i
+      entity
+    end
+  end
+end

data/lib/economic/proxies/creditor_contact_proxy.rb

@@ -12,7 +12,7 @@ module Economic
 
     # Gets data for CreditorContact from the API
     def find(handle)
-      handle = Entity::Handle.new(:id => handle) unless handle.is_a?(Entity::Handle)
+      handle = Entity::Handle.build(:id => handle) unless handle.is_a?(Entity::Handle)
       super(handle)
     end