rconomic 0.5.2 → 0.6.0

data/lib/economic/debtor.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a debtor in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IDebtor.html
@@ -53,7 +52,7 @@ module Economic
       :balance
 
     def handle
-      @handle || Handle.new({:number => @number})
+      @handle || Handle.new(:number => @number)
     end
 
     # Provides access to the current invoices for Debtor - ie invoices that
@@ -64,27 +63,27 @@ module Economic
 
     # Returns the Debtors contacts
     def contacts
-      return [] if self.handle.empty?
-      @contacts ||= DebtorProxy.new(self).get_debtor_contacts(self.handle)
+      return [] if handle.empty?
+      @contacts ||= DebtorProxy.new(self).get_debtor_contacts(handle)
     end
 
     def invoices
-      return [] if self.handle.empty?
-      @invoices ||= DebtorProxy.new(self).get_invoices(self.handle)
+      return [] if handle.empty?
+      @invoices ||= DebtorProxy.new(self).get_invoices(handle)
     end
 
     def orders
-      return [] if self.handle.empty?
-      @orders ||= DebtorProxy.new(self).get_orders(self.handle)
+      return [] if handle.empty?
+      @orders ||= DebtorProxy.new(self).get_orders(handle)
     end
 
     protected
 
     def fields
-      to_hash = Proc.new { |handle| handle.to_hash }
+      to_hash = proc { |handle| handle.to_hash }
       [
         ["Handle", :handle, to_hash, :required],
-        ["Number", :handle, Proc.new { |h| h.number }, :required],
+        ["Number", :handle, proc { |h| h.number }, :required],
         ["DebtorGroupHandle", :debtor_group_handle, to_hash],
         ["Name", :name, nil, :required],
         ["VatZone", :vat_zone, nil, :required],

data/lib/economic/debtor_contact.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a debtor contact.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IDebtorContact.html
@@ -45,7 +44,7 @@ module Economic
     end
 
     def handle
-      @handle || Handle.new({:id => @id})
+      @handle || Handle.new(:id => @id)
     end
 
     protected
@@ -53,17 +52,17 @@ module Economic
     # Returns the field rules to use when mapping to SOAP data
     def fields
       [
-        ["Handle", :handle, Proc.new { |v| v.to_hash }, :required],
-        ["Id", :handle, Proc.new { |v| v.id }, :required],
-        ["DebtorHandle", :debtor, Proc.new { |v| v.handle.to_hash }],
+        ["Handle", :handle, proc { |v| v.to_hash }, :required],
+        ["Id", :handle, proc { |v| v.id }, :required],
+        ["DebtorHandle", :debtor, proc { |v| v.handle.to_hash }],
         ["Name", :name, nil, :required],
         ["Number", :number],
         ["TelephoneNumber", :telephone_number],
         ["Email", :email],
         ["Comments", :comments],
         ["ExternalId", :external_id],
-        ["IsToReceiveEmailCopyOfOrder", :is_to_receive_email_copy_of_order, Proc.new { |v| v || false }, :required],
-        ["IsToReceiveEmailCopyOfInvoice", :is_to_receive_email_copy_of_invoice, Proc.new { |v| v || false }, :required]
+        ["IsToReceiveEmailCopyOfOrder", :is_to_receive_email_copy_of_order, proc { |v| v || false }, :required],
+        ["IsToReceiveEmailCopyOfInvoice", :is_to_receive_email_copy_of_invoice, proc { |v| v || false }, :required]
       ]
     end
   end

data/lib/economic/debtor_entry.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents a debtor entry in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IDebtorEntry.html
@@ -22,5 +21,4 @@ module Economic
       :remainder,
       :remainder_default_currency
   end
-
 end

data/lib/economic/endpoint.rb

@@ -8,6 +8,18 @@ class Economic::Endpoint
   def_delegator "client.globals", :log_level, :log_level=
   def_delegator "client.globals", :log, :log=
 
+  # Create a new Endpoint
+  #
+  # Economic::Session uses this internally
+  #
+  # ==== Attributes
+  #
+  # * +app_identifier+ - A string identifiying your application, as described in http://techtalk.e-conomic.com/e-conomic-soap-api-now-requires-you-to-specify-a-custom-x-economicappidentifier-header/
+  #
+  def initialize(app_identifier = nil)
+    @app_identifier = app_identifier
+  end
+
   # Invokes soap_action on the API endpoint with the given data.
   #
   # Returns a Hash with the resulting response from the endpoint as a Hash.
@@ -30,12 +42,16 @@ class Economic::Endpoint
   #
   # Cached on class-level to avoid loading the big WSDL file more than once (can
   # take several hundred megabytes of RAM after a while...)
-  def client
-    @@client ||= Savon.client do
-      wsdl      File.expand_path(File.join(File.dirname(__FILE__), "economic.wsdl"))
-      log       false
-      log_level :info
+  #
+  # If you need to refresh the cached client and return a newly built instance,
+  # set force_new_instance to true
+  def client(force_new_instance: false)
+    reset_client if force_new_instance
+    options = client_options
+    if @app_identifier
+      options[:headers] = {"X-EconomicAppIdentifier" => @app_identifier}
     end
+    @@client ||= Savon.client(options)
   end
 
   # Returns the E-conomic API action name to call
@@ -50,7 +66,17 @@ class Economic::Endpoint
 
   def class_name_without_modules(entity_class)
     class_name = entity_class.to_s
-    class_name.split('::').last
+    class_name.split("::").last
+  end
+
+  def client_options
+    {
+      :wsdl => File.expand_path(
+        File.join(File.dirname(__FILE__), "economic.wsdl")
+      ),
+      :log => false,
+      :log_level => :info
+    }
   end
 
   def extract_result_from_response(response, soap_action)
@@ -76,4 +102,8 @@ class Economic::Endpoint
       locals
     )
   end
+
+  def reset_client
+    @@client = nil
+  end
 end

data/lib/economic/entity/handle.rb

@@ -8,14 +8,14 @@ class Economic::Entity
 
     def self.id_properties
       {
-        :code => 'Code',
-        :id => 'Id',
-        :id1 => 'Id1',
-        :id2 => 'Id2',
-        :name => 'Name',
-        :number => 'Number',
-        :serial_number => 'SerialNumber',
-        :vat_code => 'VatCode'
+        :code => "Code",
+        :id => "Id",
+        :id1 => "Id1",
+        :id2 => "Id2",
+        :name => "Name",
+        :number => "Number",
+        :serial_number => "SerialNumber",
+        :vat_code => "VatCode"
       }
     end
 
@@ -23,7 +23,7 @@ class Economic::Entity
       id_properties.keys
     end
 
-    attr_accessor *supported_keys
+    attr_accessor(*supported_keys)
 
     # 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
@@ -36,10 +36,10 @@ class Economic::Entity
       verify_sanity_of_arguments!(hash)
       hash = prepare_hash_argument(hash) unless hash.is_a?(self.class)
 
-      [:code, :name, :vat_code].each do |key|
+      [:code, :name, :vat_code, :number].each do |key|
         instance_variable_set("@#{key}", hash[key]) if hash[key]
       end
-      [:id, :id1, :id2, :number, :serial_number].each do |key|
+      [:id, :id1, :id2, :serial_number].each do |key|
         instance_variable_set("@#{key}", hash[key].to_i) if hash[key]
       end
     end
@@ -48,7 +48,7 @@ class Economic::Entity
       only_keys = [only_keys].flatten
       only_keys.each_with_object({}) do |key, hash|
         property = id_properties[key]
-        value = self.send(key)
+        value = send(key)
         next if value.blank?
         hash[property] = value
       end
@@ -59,44 +59,69 @@ class Economic::Entity
     end
 
     def ==(other)
-      return true if self.object_id == other.object_id
+      return true if 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
+      id == other.id &&
+        number == other.number &&
+        id1 == other.id1 &&
+        id2 == other.id2 &&
+        name == other.name
     end
 
     private
 
+    def handleish?(object)
+      return false if object.nil?
+      return true if object.is_a?(self.class)
+      return true if object.is_a?(Hash)
+      false
+    end
+
     def id_properties
       self.class.id_properties
     end
 
+    def verify_all_keys_are_known(hash)
+      if hash.respond_to?(:keys)
+        unknown_keys = hash.keys - id_properties.keys - id_properties.values
+        raise(
+          ArgumentError,
+          "Unknown keys in handle: #{unknown_keys.inspect}"
+        ) unless unknown_keys.empty?
+      end
+    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)
+      verify_usability_for_handle(hash)
+      verify_all_keys_are_known(hash)
+    end
 
-      if hash.nil? || (!hash.respond_to?(:to_i) && (!hash.respond_to?(:keys) && !hash.respond_to?(:values)))
-        raise ArgumentError.new("Expected Number, Hash or Economic::Entity::Handle - got #{hash.inspect}")
-      end
+    def verify_usability_for_handle(hash)
+      return if handleish?(hash)
 
-      if hash.respond_to?(:keys)
-        unknown_keys = hash.keys - id_properties.keys - id_properties.values
-        raise ArgumentError.new("Unknown keys in handle: #{unknown_keys.inspect}") unless unknown_keys.empty?
-      end
+      raise(
+        ArgumentError,
+        "Expected Hash or Economic::Entity::Handle - got #{hash.inspect}"
+      )
     end
 
     # Examples
     #
-    #   prepare_hash_argument(12) #=> {:id => 12}
-    #   prepare_hash_argument(:id => 12) #=> {:id => 12}
-    #   prepare_hash_argument('Id' => 12) #=> {:id => 12}
-    #   prepare_hash_argument('Id' => 12, 'Number' => 13) #=> {:id => 12, :number => 13}
+    #   prepare_hash_argument(:id => 12)
+    #   #=> {:id => 12}
+    #
+    #   prepare_hash_argument('Id' => 12)
+    #   #=> {:id => 12}
+    #
+    #   prepare_hash_argument('Id' => 12, 'Number' => 13)
+    #   #=> {:id => 12, :number => 13}
     def prepare_hash_argument(hash)
-      hash = {:id => hash.to_i} if hash.respond_to?(:to_i) unless hash.blank?
-      hash[:id] ||= hash['Id']
-      hash[:number] ||= hash['Number']
+      hash[:id] ||= hash["Id"]
+      hash[:number] ||= hash["Number"]
       hash
     end
   end

data/lib/economic/entity/mapper.rb

@@ -26,7 +26,7 @@ module Economic
         end
       end
 
-      return data
+      data
     end
 
     private

data/lib/economic/entity.rb

@@ -1,6 +1,6 @@
-require 'economic/endpoint'
-require 'economic/entity/handle'
-require 'economic/entity/mapper'
+require "economic/endpoint"
+require "economic/entity/handle"
+require "economic/entity/mapper"
 
 module Economic
   class Entity
@@ -33,7 +33,7 @@ module Economic
       # Create a property getter that loads the full Entity from the API if
       # necessary
       def property_reader(property)
-        define_method "#{property}" do
+        define_method property.to_s do
           value = instance_variable_get("@#{property}")
           if value.nil? && partial? && persisted?
             instance_variable_get("@#{property}")
@@ -72,7 +72,7 @@ module Economic
 
       # Returns the class used to instantiate a proxy for Entity
       def proxy
-        class_name = name.split('::').last
+        class_name = name.split("::").last
         proxy_class_name = "#{class_name}Proxy"
         Economic.const_get(proxy_class_name)
       end
@@ -83,7 +83,7 @@ module Economic
       #   Entity.key #=> :entity
       #   CurrentInvoice.key #=> :current_invoice
       def key
-        key = self.name
+        key = name
         key = Economic::Support::String.demodulize(key)
         key = Economic::Support::String.underscore(key)
         key.intern
@@ -91,7 +91,7 @@ module Economic
     end
 
     def handle
-      @handle || Handle.build({:number => @number, :id => @id})
+      @handle || Handle.build(:number => @number, :id => @id)
     end
 
     def handle=(handle)
@@ -108,22 +108,23 @@ module Economic
     # Updates Entity with its data from the API
     def get_data
       response = proxy.get_data(handle)
-      self.update_properties(response)
+      update_properties(response)
       self.partial = false
       self.persisted = true
     end
 
+    # Get default Entity with its number from the API
+    def get
+      proxy.get
+    end
+
     # Returns the number of Entity. This does not trigger a load from the API
     # even if Entity is partial
-    def number
-      @number
-    end
+    attr_reader :number
 
     # Returns the id of Entity. This does not trigger a load from the API even
     # if Entity is partial
-    def id
-      @id
-    end
+    attr_reader :id
 
     # Returns true if CurrentInvoiceLine has been persisted in e-conomic
     def persisted?
@@ -144,8 +145,8 @@ module Economic
     end
 
     def inspect
-      props = self.class.properties.collect { |p| "#{p}=#{self.send(p).inspect}" }
-      "#<#{self.class}:#{self.object_id} partial=#{partial?}, persisted=#{persisted?}, #{props.join(', ')}>"
+      props = self.class.properties.collect { |p| "#{p}=#{send(p).inspect}" }
+      "#<#{self.class}:#{object_id} partial=#{partial?}, persisted=#{persisted?}, #{props.join(', ')}>"
     end
 
     # Persist the Entity to the API
@@ -156,7 +157,7 @@ module Economic
     # Deletes entity permanently from E-conomic.
     def destroy
       handleKey = "#{Support::String.camel_back(class_name)}Handle"
-      response = request(:delete, {handleKey => handle.to_hash})
+      response = request(:delete, handleKey => handle.to_hash)
 
       @persisted = false
       @partial = true
@@ -168,15 +169,15 @@ module Economic
     def update_properties(hash)
       hash.each do |key, value|
         setter_method = "#{key}="
-        if self.respond_to?(setter_method)
-          self.send(setter_method, value)
+        if respond_to?(setter_method)
+          send(setter_method, value)
         end
       end
     end
 
     def ==(other)
       return false if other.nil?
-      self.handle == other.handle && other.is_a?(self.class)
+      handle == other.handle && other.is_a?(self.class)
     end
 
     protected
@@ -190,9 +191,7 @@ module Economic
     end
 
     def create
-      response = request(:create_from_data, {
-        'data' => build_soap_data
-      })
+      response = request(:create_from_data, "data" => build_soap_data)
 
       if response
         @number = response[:number]
@@ -204,7 +203,7 @@ module Economic
       @persisted = true
       @partial = false
 
-      return response
+      response
     end
 
     def defaults
@@ -212,14 +211,12 @@ module Economic
     end
 
     def update
-      response = request(:update_from_data, {
-        'data' => build_soap_data
-      })
+      response = request(:update_from_data, "data" => build_soap_data)
 
       @persisted = true
       @partial = false
 
-      return response
+      response
     end
 
     # Returns Hash with the data structure to send to the API
@@ -245,7 +242,7 @@ module Economic
 
     def initialize_defaults
       defaults.each do |property_name, default_value|
-        self.send("#{property_name}=", default_value)
+        send("#{property_name}=", default_value)
       end
     end
   end

data/lib/economic/entry.rb

@@ -1,7 +1,6 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
-
   # Represents an entry in E-conomic.
   #
   # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IEntry.html

data/lib/economic/invoice.rb

@@ -1,4 +1,4 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
   class Invoice < Entity
@@ -6,10 +6,10 @@ module Economic
       :net_amount,
       :vat_amount,
       :gross_amount,
+      :date,
       :due_date,
       :debtor_handle,
       :debtor_name,
-      :debtor_name,
       :debtor_address,
       :debtor_postal_code,
       :debtor_city,
@@ -49,9 +49,18 @@ module Economic
     end
 
     def remainder
-      request(:get_remainder, {
-        "invoiceHandle" => handle.to_hash
-      })
+      @remainder ||= request(:get_remainder, "invoiceHandle" => handle.to_hash).to_f
+    end
+
+    def days_past_due
+      days = Date.today - due_date.to_date
+      days > 0 ? days : 0
+    end
+
+    # Returns true if the due date has expired, and there is a remainder
+    # left on the invoice
+    def past_due?
+      days_past_due > 0 && remainder > 0
     end
 
     # Returns the PDF version of Invoice as a String.
@@ -62,9 +71,7 @@ module Economic
     #     file << invoice.pdf
     #   end
     def pdf
-      response = request(:get_pdf, {
-                           "invoiceHandle" => handle.to_hash
-      })
+      response = request(:get_pdf, "invoiceHandle" => handle.to_hash)
 
       Base64.decode64(response)
     end

data/lib/economic/order.rb

@@ -1,4 +1,4 @@
-require 'economic/entity'
+require "economic/entity"
 
 module Economic
   class Order < Entity
@@ -56,9 +56,7 @@ module Economic
     #     file << invoice.pdf
     #   end
     def pdf
-      response = request(:get_pdf, {
-                           "orderHandle" => handle.to_hash
-      })
+      response = request(:get_pdf, "orderHandle" => handle.to_hash)
 
       Base64.decode64(response)
     end

data/lib/economic/product.rb

@@ -0,0 +1,73 @@
+require "economic/entity"
+
+module Economic
+  # Represents a product in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IProduct.html
+  #
+  # Examples
+  #
+  #   # Find a product:
+  #   product = economic.products.find(1234)
+  #
+  #   # Creating a product:
+  #   product = economic.products.build
+  #   product.number = 'ESC2014-LED-DISPLAY'
+  #   product.product_group_handle = { :number => 1 }
+  #   product.name = '100 meter LED display'
+  #   product.sales_price = 999999
+  #   product.cost_price = 100000
+  #   product.recommended_price = 999999
+  #   product.is_accessible = true
+  #   product.volume = 1
+  #   product.save
+  class Product < Entity
+    has_properties :number,
+      :product_group_handle,
+      :name,
+      :description,
+      :bar_code,
+      :sales_price,
+      :cost_price,
+      :recommended_price,
+      :unit_handle,
+      :is_accessible,
+      :volume,
+      :department_handle,
+      :distribution_key_handle,
+      :in_stock,
+      :on_order,
+      :ordered,
+      :available
+
+    def handle
+      @handle ||= Handle.new(:number => @number)
+    end
+
+    protected
+
+    def fields
+      to_hash = proc { |handle| handle.to_hash }
+      [
+        ["Handle", :handle, to_hash, :required],
+        ["Number", :handle, proc { |h| h.number }, :required],
+        ["ProductGroupHandle", :product_group_handle, to_hash],
+        ["Name", :name, nil, :required],
+        ["Description", :description, nil],
+        ["BarCode", :bar_code, nil],
+        ["SalesPrice", :sales_price, nil, :required],
+        ["CostPrice", :cost_price, nil, :required],
+        ["RecommendedPrice", :recommended_price, nil, :required],
+        ["UnitHandle", :unit_handle, to_hash],
+        ["IsAccessible", :is_accessible, nil, :required],
+        ["Volume", :volume, nil, :required],
+        ["DepartmentHandle", :department_handle, to_hash],
+        ["DistributionKeyHandle", :distribution_key_handle, to_hash],
+        ["InStock", :in_stock],
+        ["OnOrder", :on_order],
+        ["Ordered", :ordered],
+        ["Available", :available]
+      ]
+    end
+  end
+end

data/lib/economic/proxies/account_proxy.rb

@@ -1,11 +1,9 @@
-require 'economic/proxies/entity_proxy'
+require "economic/proxies/entity_proxy"
 
 module Economic
   class AccountProxy < EntityProxy
     def find_by_name(name)
-      response = request('FindByName', {
-        'name' => name
-      })
+      response = request("FindByName", "name" => name)
 
       handle = response[:account_handle]