business-central 1.0.3 → 1.0.7

data/lib/business_central/object/base.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Base
-      attr_reader :client,
-                  :parent_path,
-                  :path
+      include ArgumentHelper
+
+      attr_reader :client, :parent_path, :path
 
       attr_writer :id, :company_id
 
@@ -19,71 +21,107 @@ module BusinessCentral
         ]
       end
 
-      def id(argument)
-        return @id if !@id.nil?
-        return argument.fetch(:id, '') if !argument.nil?
-        return nil
-      end
-
-      def company_id(argument)
-        return @client.default_company_id if !@client.default_company_id.nil?
-        return @company_id if !@company_id.nil?
-        return argument.fetch(:company_id, '') if !argument.nil?
-        return nil
-      end
-
       def find_all
-        if method_supported?(:get)
-          Request.get(@client, build_url(parent_path: @parent_path, child_path: object_name))
-        else
+        if !method_supported?(:get)
           raise BusinessCentral::NoSupportedMethod.new(:get, object_methods)
         end
+
+        Request.get(@client, build_url(parent_path: @parent_path, child_path: object_name))
       end
+      alias all find_all
 
       def find_by_id(id)
-        if method_supported?(:get)
-          Request.get(@client, build_url(parent_path: @parent_path, child_path: object_name, child_id: id))
-        else
+        if !method_supported?(:get)
           raise BusinessCentral::NoSupportedMethod.new(:get, object_methods)
         end
+
+        Request.get(
+          @client,
+          build_url(
+            parent_path: @parent_path,
+            child_path: object_name,
+            child_id: id
+          )
+        )
       end
+      alias find find_by_id
 
-      def where(query = '')
-        if method_supported?(:get)
-          Request.get(@client, build_url(parent_path: @parent_path, child_path: object_name, filter: query))
-        else
+      def where(query = '', *values)
+        if !method_supported?(:get)
           raise BusinessCentral::NoSupportedMethod.new(:get, object_methods)
         end
+
+        Request.get(
+          @client,
+          build_url(
+            parent_path: @parent_path,
+            child_path: object_name,
+            filter: FilterQuery.sanitize(query, values)
+          )
+        )
       end
 
       def create(params = {})
-        if method_supported?(:post)
-          if Validation.new(object_validation, params).valid?
-            Request.post(@client, build_url(parent_path: @parent_path, child_path: object_name), params)
-          end
-        else
+        if !method_supported?(:post)
           raise BusinessCentral::NoSupportedMethod.new(:post, object_methods)
         end
+
+        Validation.new(object_validation, params).valid?
+        Request.post(@client, build_url(parent_path: @parent_path, child_path: object_name), params)
       end
 
       def update(id, params = {})
-        if method_supported?(:patch)
-          object = find_by_id(id).merge(params)
-          if Validation.new(object_validation, object).valid?
-            Request.patch(@client, build_url(parent_path: @parent_path, child_path: object_name, child_id: id), object[:etag], object)
-          end
-        else
+        if !method_supported?(:patch)
           raise BusinessCentral::NoSupportedMethod.new(:patch, object_methods)
         end
+
+        object = find_by_id(id).merge(params)
+        Validation.new(object_validation, object).valid?
+        Request.patch(
+          @client,
+          build_url(
+            parent_path: @parent_path,
+            child_path: object_name,
+            child_id: id
+          ),
+          object[:etag],
+          params
+        )
       end
 
       def destroy(id)
-        if method_supported?(:delete)
-          object = find_by_id(id)
-          Request.delete(@client, build_url(parent_path: @parent_path, child_path: object_name, child_id: id), object[:etag])
-        else
+        if !method_supported?(:delete)
           raise BusinessCentral::NoSupportedMethod.new(:delete, object_methods)
         end
+
+        object = find_by_id(id)
+        Request.delete(
+          @client,
+          build_url(
+            parent_path: @parent_path,
+            child_path: object_name,
+            child_id: id
+          ),
+          object[:etag]
+        )
+      end
+
+      protected
+
+      def valid_parent?(parent)
+        return true if object_parent_name.map(&:downcase).include?(parent.downcase)
+
+        raise InvalidArgumentException, "parents allowed: #{object_parent_name.join(', ')}"
+      end
+
+      def build_url(parent_path: [], child_path: '', child_id: '', filter: '')
+        URLBuilder.new(
+          base_url: client.url,
+          parent_path: parent_path,
+          child_path: child_path,
+          child_id: child_id,
+          filter: filter
+        ).build
       end
 
       private
@@ -93,30 +131,26 @@ module BusinessCentral
       end
 
       def object_validation
-        self.class.const_defined?(:OBJECT_VALIDATION) ? self.class.const_get(:OBJECT_VALIDATION) : []
+        if self.class.const_defined?(:OBJECT_VALIDATION)
+          self.class.const_get(:OBJECT_VALIDATION)
+        else
+          []
+        end
       end
 
       def object_methods
         self.class.const_get(:OBJECT_METHODS)
       end
 
-      def method_supported?(method)
-        return true if object_methods.include?(method)
-        return false
+      def object_parent_name
+        self.class.const_get(:OBJECT_PARENTS)
       end
 
-      def build_url(parent_path: [], child_path: '', child_id: '', filter: '')
-        url_builder(parent_path, child_path, child_id, filter)
-      end
+      def method_supported?(method)
+        return true if object_methods.include?(method)
 
-      def url_builder(parent_path = [], child_path = '', child_id = '', filter = '')
-        url = @client.url
-        url += parent_path.map { |parent| "/#{parent[:path]}(#{parent[:id]})" }.join('') if !parent_path.empty?
-        url += "/#{child_path}" if !child_path.to_s.blank?
-        url += "(#{child_id})" if !child_id.to_s.blank?
-        url += "?$filter=#{CGI::escape(filter)}" if !filter.to_s.blank?
-        return url
+        false
       end
     end
   end
-end
+end

data/lib/business_central/object/cash_flow_statement.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CashFlowStatement < Base
-      OBJECT = 'cashFlowStatement'.freeze
+      OBJECT = 'cashFlowStatement'
 
       OBJECT_METHODS = [
         :get
       ].freeze
     end
   end
-end
+end

data/lib/business_central/object/company.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Company < Base
-      OBJECT = 'companies'.freeze
+      OBJECT = 'companies'
 
       OBJECT_METHODS = [
         :get
       ].freeze
 
-      def initialize(client, args)
+      def initialize(client, _args)
         super(client)
         @parent_path = []
       end
     end
   end
-end
+end

data/lib/business_central/object/company_information.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CompanyInformation < Base
-      OBJECT = 'companyInformation'.freeze
+      OBJECT = 'companyInformation'
 
-      OBJECT_METHODS = [
-        :get,
-        :patch
+      OBJECT_METHODS = %i[
+        get
+        patch
       ].freeze
     end
   end
-end
+end

data/lib/business_central/object/country_region.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CountryRegion < Base
-      OBJECT = 'countriesRegions'.freeze
+      OBJECT = 'countriesRegions'
 
       OBJECT_VALIDATION = {
         code: {
@@ -13,11 +15,11 @@ module BusinessCentral
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
     end
   end

data/lib/business_central/object/currency.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Currency < Base
-      OBJECT = 'currencies'.freeze
+      OBJECT = 'currencies'
 
       OBJECT_VALIDATION = {
         code: {
@@ -16,11 +18,11 @@ module BusinessCentral
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
     end
   end

data/lib/business_central/object/customer.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Customer < Base
-      OBJECT = 'customers'.freeze
+      extend BusinessCentral::Object::ObjectHelper
+
+      OBJECT = 'customers'
 
       OBJECT_VALIDATION = {
         display_name: {
@@ -9,19 +13,22 @@ module BusinessCentral
           maximum_length: 100
         },
         type: {
-          inclusion_of: [
-            'Company',
-            'Person'
+          inclusion_of: %w[
+            Company
+            Person
           ]
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
+
+      navigation :default_dimension
+      navigation :picture
     end
   end
 end

data/lib/business_central/object/customer_financial_detail.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CustomerFinancialDetail < Base
-      OBJECT = 'customerFinancialDetails'.freeze
+      OBJECT = 'customerFinancialDetails'
 
       OBJECT_METHODS = [
         :get

data/lib/business_central/object/customer_payment.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CustomerPayment < Base
-      OBJECT = 'customerPayments'.freeze
+      OBJECT = 'customerPayments'
 
       OBJECT_VALIDATION = {
         customer_number: {
@@ -30,11 +32,11 @@ module BusinessCentral
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
     end
   end

data/lib/business_central/object/customer_payment_journal.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CustomerPaymentJournal < Base
-      OBJECT = 'customerPaymentJournals'.freeze
+      OBJECT = 'customerPaymentJournals'
 
       OBJECT_VALIDATION = {
         code: {
@@ -12,11 +14,11 @@ module BusinessCentral
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
     end
   end

data/lib/business_central/object/customer_sale.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class CustomerSale < Base
-      OBJECT = 'customerSales'.freeze
+      OBJECT = 'customerSales'
 
       OBJECT_METHODS = [
         :get

data/lib/business_central/object/default_dimension.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class DefaultDimension < Base
-      OBJECT = 'defaultDimensions'.freeze
+      OBJECT = 'defaultDimensions'
 
       OBJECT_VALIDATION = {
         parent_id: {
@@ -15,25 +17,26 @@ module BusinessCentral
         }
       }.freeze
 
-      OBJECT_METHODS = [
-        :get,
-        :post,
-        :patch,
-        :delete
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
       ].freeze
 
-      OBJECT_PARENTS = [
-        'items',
-        'customers',
-        'vendors',
-        'employees'
+      OBJECT_PARENTS = %w[
+        items
+        customers
+        vendors
+        employees
       ].freeze
 
-      def initialize(client, company_id:, parent:, parent_id:)
-        raise InvalidArgumentException.new("parents allowed: #{OBJECT_PARENTS.join(', ')}") if !valid_parent?(parent)
-        super(client, company_id: company_id)
+      def initialize(client, parent:, parent_id:, **args)
+        return if !valid_parent?(parent)
+
+        super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
         @parent_id = parent_id
@@ -43,12 +46,6 @@ module BusinessCentral
         params[:parent_id] = @parent_id
         super(params)
       end
-
-      private
-
-      def valid_parent?(parent)
-        OBJECT_PARENTS.include?(parent.downcase)
-      end
     end
   end
 end

data/lib/business_central/object/dimension.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class Dimension < Base
+      OBJECT = 'dimensions'
+
+      OBJECT_VALIDATION = {
+        code: {
+          required: true,
+          maximum_length: 20
+        }
+      }.freeze
+
+      OBJECT_METHODS = %i[
+        get
+      ].freeze
+    end
+  end
+end

data/lib/business_central/object/dimension_line.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class DimensionLine < Base
+      OBJECT = 'dimensionLines'
+
+      OBJECT_VALIDATION = {
+        parent_id: {
+          required: true
+        },
+        code: {
+          maximum_length: 20
+        },
+        display_name: {
+          maximum_length: 30
+        },
+        value_id: {
+          required: true
+        },
+        value_code: {
+          maximum_length: 20
+        },
+        value_display_name: {
+          maximum_length: 50
+        }
+      }.freeze
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+    end
+  end
+end

data/lib/business_central/object/dimension_value.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class DimensionValue < Base
+      OBJECT = 'dimensionValues'
+
+      OBJECT_VALIDATION = {
+        code: {
+          required: true,
+          maximum_length: 20
+        }
+      }.freeze
+
+      OBJECT_METHODS = %i[
+        get
+      ].freeze
+
+      def initialize(client, dimension_id:, **args)
+        super(client, args)
+        @parent_path << {
+          path: 'dimensions',
+          id: dimension_id
+        }
+      end
+    end
+  end
+end

data/lib/business_central/object/employee.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class Employee < Base
+      extend BusinessCentral::Object::ObjectHelper
+
+      OBJECT = 'employees'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      navigation :default_dimension
+      navigation :picture
+    end
+  end
+end

data/lib/business_central/object/filter_query.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class FilterQuery
+      extend URLHelper
+
+      class << self
+        def sanitize(query = '', values = [])
+          return encode_url_params(query) if values.length.zero?
+
+          query = replace_template_with_value(query, values)
+          encode_url_params(query)
+        end
+      end
+    end
+  end
+end

data/lib/business_central/object/general_ledger_entry.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class GeneralLedgerEntry < Base
+      OBJECT = 'generalLedgerEntries'
+
+      OBJECT_METHODS = %i[
+        get
+      ].freeze
+    end
+  end
+end

data/lib/business_central/object/income_statement.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class IncomeStatement < Base
+      OBJECT = 'incomeStatement'
+
+      OBJECT_METHODS = %i[
+        get
+      ].freeze
+    end
+  end
+end

data/lib/business_central/object/irs1099_code.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class Irs1099Code < Base
+      OBJECT = 'irs1099Codes'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+    end
+  end
+end