business-central 1.0.3 → 1.0.7

data/lib/business_central/object/sales_invoice.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesInvoice < Base
+      extend BusinessCentral::Object::ObjectHelper
+
+      OBJECT = 'salesInvoices'
+
+      OBJECT_VALIDATION = {
+        customer_purchase_order_reference: {
+          maximum_length: 10
+        },
+        customer_number: {
+          maximum_length: 20
+        },
+        contact_id: {
+          maximum_length: 250
+        },
+        currency_code: {
+          maximum_length: 10
+        },
+        email: {
+          maximum_length: 80
+        },
+        phone: {
+          maximum_length: 30
+        },
+        payment_terms: {
+          maximum_length: 10
+        },
+        shipment_method: {
+          maximum_length: 10
+        },
+        salesperson: {
+          maximum_length: 20
+        },
+        bill_to_name: {
+          maximum_length: 100
+        },
+        bill_to_customer_number: {
+          maximum_length: 20
+        },
+        ship_to_name: {
+          maximum_length: 100
+        },
+        ship_to_contact: {
+          maximum_length: 100
+        }
+      }.freeze
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      navigation :sales_invoice_line
+    end
+  end
+end

data/lib/business_central/object/sales_invoice_line.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesInvoiceLine < Base
+      OBJECT = 'salesInvoiceLines'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      OBJECT_PARENTS = %w[
+        salesInvoices
+      ].freeze
+
+      def initialize(client, parent: 'salesInvoices', parent_id:, **args)
+        return if !valid_parent?(parent)
+
+        super(client, args)
+        @parent_path << {
+          path: parent,
+          id: parent_id
+        }
+      end
+    end
+  end
+end

data/lib/business_central/object/sales_order.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesOrder < Base
+      extend BusinessCentral::Object::ObjectHelper
+
+      OBJECT = 'salesOrders'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      navigation :sales_order_line
+    end
+  end
+end

data/lib/business_central/object/sales_order_line.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesOrderLine < Base
+      OBJECT = 'salesOrderLines'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      OBJECT_PARENTS = %w[
+        salesOrders
+      ].freeze
+
+      def initialize(client, parent: 'salesOrders', parent_id:, **args)
+        return if !valid_parent?(parent)
+
+        super(client, args)
+        @parent_path << {
+          path: parent,
+          id: parent_id
+        }
+      end
+    end
+  end
+end

data/lib/business_central/object/sales_quote.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesQuote < Base
+      extend BusinessCentral::Object::ObjectHelper
+
+      OBJECT = 'salesQuotes'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      navigation :sales_quote_line
+    end
+  end
+end

data/lib/business_central/object/sales_quote_line.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class SalesQuoteLine < Base
+      OBJECT = 'salesQuoteLines'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      OBJECT_PARENTS = %w[
+        salesQuotes
+      ].freeze
+
+      def initialize(client, parent: 'salesQuotes', parent_id:, **args)
+        return if !valid_parent?(parent)
+
+        super(client, args)
+        @parent_path << {
+          path: parent,
+          id: parent_id
+        }
+      end
+    end
+  end
+end

data/lib/business_central/object/shipment_method.rb

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

data/lib/business_central/object/subscription.rb

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

data/lib/business_central/object/tax_area.rb

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

data/lib/business_central/object/tax_group.rb

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

data/lib/business_central/object/time_registration_entry.rb

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

data/lib/business_central/object/trial_balance.rb

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

data/lib/business_central/object/units_of_measure.rb

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

data/lib/business_central/object/url_builder.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class URLBuilder
+      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_object(query)
+        end
+      end
+
+      def initialize(base_url:, parent_path: [], child_path: '', child_id: '', child_code: '', filter: '')
+        @base_url = base_url.to_s
+        @parent_path = parent_path || []
+        @child_path = child_path.to_s
+        @child_id = child_id.to_s
+        @child_code = child_code.to_s
+        @filter = filter.to_s
+      end
+
+      def build
+        url = @base_url
+        url += build_parent_path
+        url += build_child_path
+        url += build_filter
+        url
+      end
+
+      private
+
+      def build_parent_path
+        return '' if @parent_path.empty?
+
+        @parent_path.map do |parent|
+          "/#{parent[:path]}(#{parent[:id]})" if !parent[:id].nil?
+        end.join('')
+      end
+
+      def build_child_path
+        url = ''
+        url += "/#{@child_path}" if @child_path.present?
+        url += "(#{@child_id})" if @child_id.present?
+        url += "('#{odata_encode(@child_code)}')" if @child_code.present?
+        url
+      end
+
+      def build_filter
+        url = ''
+        url += "?$filter=#{@filter}" if @filter.present?
+        url
+      end
+    end
+  end
+end

data/lib/business_central/object/url_helper.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    module URLHelper
+      def encode_url_object(object)
+        URI::RFC2396_Parser.new.escape(object)
+      end
+
+      def encode_url_params(query)
+        CGI.escape(query)
+      end
+
+      def odata_encode(value)
+        value = value.dup
+        value.gsub!(/'/, "''") if value.instance_of?(String) && value =~ /'/
+        value.to_s
+      end
+
+      private
+
+      def replace_template_with_value(query, values)
+        query = query.dup
+        return replace_template_with_hash_values(query, values) if values.first.is_a?(Hash)
+        replace_template_with_array_values(query, values)
+      end
+
+      def replace_template_with_hash_values(query, values)
+        values.first.each do |key, value|
+          query.gsub!(/:#{key}/, odata_encode(value))
+        end
+        query
+      end
+
+      def replace_template_with_array_values(query, values)
+        query.scan(/\?/).each_with_index do |_character, index|
+          character_position = query =~ /\?/
+          query[character_position] = odata_encode(values[index])
+        end
+        query
+      end
+    end
+  end
+end

data/lib/business_central/object/validation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Validation
@@ -11,25 +13,26 @@ module BusinessCentral
         @validation_rules.each do |rules_key, rules_value|
           rules_value.each do |validation_key, validation_value|
             if required?(validation_key, validation_value, @object_params[rules_key].to_s)
-              @errors << { field: rules_key, message: 'is a required field'}
+              @errors << { field: rules_key, message: 'is a required field' }
             end
 
             if exceeds_maximum_length?(validation_key, validation_value, @object_params[rules_key].to_s)
-              @errors << { field: rules_key, message: "has exceeded the maximum length #{validation_value}"}
+              @errors << { field: rules_key, message: "has exceeded the maximum length #{validation_value}" }
             end
 
             if not_inclusive_of?(validation_key, validation_value, @object_params[rules_key].to_s)
-              @errors << { field: rules_key, message: "is not one of #{validation_value.join(', ')}"}
+              @errors << { field: rules_key, message: "is not one of #{validation_value.join(', ')}" }
             end
 
             if date_type?(validation_key, validation_value, @object_params[rules_key])
-              @errors << { field: rules_key, message: 'is not a date'}
+              @errors << { field: rules_key, message: 'is not a date' }
             end
           end
         end
 
-        raise InvalidObjectException.new(@errors) if @errors.any?
-        return true
+        raise InvalidObjectException, @errors if @errors.any?
+
+        true
       end
 
       private
@@ -51,4 +54,4 @@ module BusinessCentral
       end
     end
   end
-end
+end

data/lib/business_central/object/vendor.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   module Object
     class Vendor < Base
-      extend BusinessCentral::Object::Helper
+      extend BusinessCentral::Object::ObjectHelper
 
-      OBJECT = 'vendors'.freeze
+      OBJECT = 'vendors'
 
       OBJECT_VALIDATION = {
         number: {
@@ -26,14 +28,15 @@ module BusinessCentral
         }
       }.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/vendor_purchase.rb

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

data/lib/business_central/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BusinessCentral
-  VERSION = "1.0.3".freeze
-end
+  VERSION = '1.0.7'
+end

data/lib/business_central/web_service.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  class WebService
+    DEFAULT_URL = 'https://api.businesscentral.dynamics.com/v2.0/production/ODataV4'
+
+    attr_reader :url, :object_url
+
+    def initialize(client:, **options)
+      @client = client
+      opts = options.dup
+      @url = opts.delete(:url) || DEFAULT_URL
+    end
+
+    def object(object_url = '', *values)
+      if values.length.zero?
+        @object_url = object_url
+        return self
+      end
+
+      @object_url = Object::URLBuilder.sanitize(object_url, values)
+      self
+    end
+
+    def get(query = '', *values)
+      raise InvalidObjectURLException if @object_url.to_s.blank?
+
+      Object::Request.get(
+        @client,
+        build_url(
+          filter: Object::FilterQuery.sanitize(query, values)
+        )
+      )
+    end
+
+    def post(params = {})
+      raise InvalidObjectURLException if @object_url.to_s.blank?
+
+      Object::Request.post(
+        @client,
+        build_url,
+        params
+      )
+    end
+
+    def patch(params = {})
+      raise InvalidObjectURLException if @object_url.to_s.blank?
+
+      object = get
+      Object::Request.patch(
+        @client,
+        build_url,
+        object[:etag],
+        params
+      )
+    end
+
+    def delete
+      raise InvalidObjectURLException if @object_url.to_s.blank?
+
+      object = get
+      Object::Request.delete(
+        @client,
+        build_url,
+        object[:etag]
+      )
+    end
+
+    private
+
+    def build_url(filter: '')
+      Object::URLBuilder.new(
+        base_url: "#{@url}/#{@object_url}",
+        filter: filter
+      ).build
+    end
+  end
+end

data/lib/business_central.rb

@@ -5,15 +5,21 @@ require 'json'
 
 require 'core_ext/string'
 
-require 'business_central/object/helper'
+require 'business_central/object/argument_helper'
+require 'business_central/object/url_helper'
+require 'business_central/object/object_helper'
+
 require 'business_central/object/base'
 require 'business_central/object/validation'
 require 'business_central/object/response'
 require 'business_central/object/request'
+require 'business_central/object/filter_query'
+require 'business_central/object/url_builder'
 
 require 'business_central/object/account'
 require 'business_central/object/aged_account_payable'
 require 'business_central/object/aged_account_receivable'
+require 'business_central/object/attachment'
 require 'business_central/object/cash_flow_statement'
 require 'business_central/object/balance_sheet'
 require 'business_central/object/company'
@@ -26,10 +32,42 @@ require 'business_central/object/customer_payment'
 require 'business_central/object/customer_payment_journal'
 require 'business_central/object/customer_sale'
 require 'business_central/object/default_dimension'
-require 'business_central/object/vendor'
+require 'business_central/object/dimension'
+require 'business_central/object/dimension_line'
+require 'business_central/object/dimension_value'
+require 'business_central/object/employee'
+require 'business_central/object/general_ledger_entry'
+require 'business_central/object/income_statement'
+require 'business_central/object/irs1099_code'
 require 'business_central/object/item'
+require 'business_central/object/item_category'
+require 'business_central/object/journal'
+require 'business_central/object/journal_line'
+require 'business_central/object/payment_method'
+require 'business_central/object/payment_term'
+require 'business_central/object/picture'
 require 'business_central/object/purchase_invoice'
 require 'business_central/object/purchase_invoice_line'
+require 'business_central/object/retained_earning_statement'
+require 'business_central/object/sales_invoice'
+require 'business_central/object/sales_invoice_line'
+require 'business_central/object/sales_credit_memo'
+require 'business_central/object/sales_credit_memo_line'
+require 'business_central/object/sales_order'
+require 'business_central/object/sales_order_line'
+require 'business_central/object/sales_quote'
+require 'business_central/object/sales_quote_line'
+require 'business_central/object/shipment_method'
+require 'business_central/object/subscription'
+require 'business_central/object/tax_area'
+require 'business_central/object/tax_group'
+require 'business_central/object/time_registration_entry'
+require 'business_central/object/trial_balance'
+require 'business_central/object/units_of_measure'
+require 'business_central/object/vendor'
+require 'business_central/object/vendor_purchase'
+require 'business_central/object/purchase_order'
 
 require 'business_central/exceptions'
 require 'business_central/client'
+require 'business_central/web_service'