business-central 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfee02464cc6b4a28c6208ced736a5d8453f917cbe8757f7e28cd6ad900721d6
-  data.tar.gz: ca2a683c9f3440d4fa953507051021145b1690bd42152ba488eae70c451ce2ae
+  metadata.gz: 68fd68c7e0cf337b5f2c83ba5f08e21cdbab84b3c10a3515338a6d5241ab3c8d
+  data.tar.gz: 14b3bcbe75143b2457c7ca2606a33926de4e89fd7001323c97911d557037301e
 SHA512:
-  metadata.gz: 454c708a9323072524312b21877aca84918c2bb2c611956849291446c9117a007301112333d7c3bf25b3e5ac1707a81a2bdde2d7b3cc50f561ec0d28df5a40d0
-  data.tar.gz: 78cbb22465b21ca9f876c621986e55a9843df5b9505a6552425ae56667258aaddff9ec76e3a00f5b7f820572e3a3bf887c2d49516d8e2b203f0ef2d02bf52aaf
+  metadata.gz: bfe06ca5d2427eaed0f8bcb6826e87635d72f02e456e7f4dba47bb19645edb757cc85af0436038f611821975fe43e39387238e180172e3ec09b95720ab45edcb
+  data.tar.gz: 461aadc6e03b1a77bbe6737d69776d2c909baebd36c680a558320abc674f27824983cc1e3b1401b35f85b90fb9ba28f5ff7aaa93a0adbd79e50d8df828532fc6

data/lib/business_central.rb

@@ -5,11 +5,16 @@ 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'
@@ -26,10 +31,38 @@ 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/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/exceptions'
 require 'business_central/client'
+require 'business_central/web_service'

data/lib/business_central/client.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module BusinessCentral
   class Client
-    extend BusinessCentral::Object::Helper
+    extend BusinessCentral::Object::ObjectHelper
 
-    DEFAULT_URL = 'https://api.businesscentral.dynamics.com/v1.0/api/beta'.freeze
+    DEFAULT_LOGIN_URL = 'https://login.microsoftonline.com/common'
 
-    DEFAULT_LOGIN_URL = 'https://login.microsoftonline.com/common'.freeze
+    DEFAULT_URL = 'https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0'
 
     attr_reader :tenant_id,
                 :username,
@@ -12,11 +14,13 @@ module BusinessCentral
                 :application_id,
                 :secret_key,
                 :url,
+                :web_service_url,
                 :oauth2_login_url,
-                :oauth2_client,
-                :default_company_id
+                :oauth2_access_token,
+                :default_company_id,
+                :debug
 
-    alias_method :access_token, :oauth2_client
+    alias access_token oauth2_access_token
 
     object :account
     object :aged_account_payable
@@ -33,10 +37,37 @@ module BusinessCentral
     object :customer_payment_journal
     object :customer_sale
     object :default_dimension
-    object :vendor
+    object :dimension
+    object :dimension_line
+    object :dimension_value
+    object :employee
     object :purchase_invoice
     object :purchase_invoice_line
     object :item
+    object :item_category
+    object :journal
+    object :journal_line
+    object :payment_method
+    object :payment_term
+    object :picture
+    object :retained_earning_statement
+    object :sales_invoice
+    object :sales_invoice_line
+    object :sales_credit_memo
+    object :sales_credit_memo_line
+    object :sales_order
+    object :sales_order_line
+    object :sales_quote
+    object :sales_quote_line
+    object :shipment_method
+    object :subscription
+    object :tax_area
+    object :tax_group
+    object :time_registration_entry
+    object :trial_balance
+    object :units_of_measure
+    object :vendor
+    object :vendor_purchase
 
     def initialize(options = {})
       opts = options.dup
@@ -44,70 +75,66 @@ module BusinessCentral
       @username = opts.delete(:username)
       @password = opts.delete(:password)
       @url = opts.delete(:url) || DEFAULT_URL
+      @web_service_url = opts.delete(:web_service_url)
       @application_id = opts.delete(:application_id)
       @secret_key = opts.delete(:secret_key)
       @oauth2_login_url = opts.delete(:oauth2_login_url) || DEFAULT_LOGIN_URL
       @default_company_id = opts.delete(:default_company_id)
+      @debug = opts.delete(:debug) || false
     end
 
     def authorize(params = {}, oauth_authorize_callback: '')
       params[:redirect_uri] = oauth_authorize_callback
       begin
         oauth2_client.auth_code.authorize_url(params)
-      rescue OAuth2::Error => error
-        handle_error(error)
+      rescue OAuth2::Error => e
+        handle_error(e)
       end
     end
 
     def request_token(code = '', oauth_token_callback: '')
-      begin
-        oauth2_client.auth_code.get_token(code, redirect_uri: oauth_token_callback)
-      rescue OAuth2::Error => error
-        handle_error(error)
-      end
+      oauth2_client.auth_code.get_token(code, redirect_uri: oauth_token_callback)
+    rescue OAuth2::Error => e
+      handle_error(e)
     end
 
     def authorize_from_token(token: '', refresh_token: '', expires_at: nil, expires_in: nil)
-      @oauth2_client = OAuth2::AccessToken.new(
+      @oauth2_access_token = OAuth2::AccessToken.new(
         oauth2_client,
         token,
         refresh_token: refresh_token,
         expires_at: expires_at,
-        expires_in: expires_in,
+        expires_in: expires_in
       )
     end
 
     def refresh_token
-      @oauth2_client.refresh!
+      @oauth2_access_token.refresh!
+    end
+
+    def web_service
+      @web_service ||= BusinessCentral::WebService.new(client: self, url: web_service_url)
     end
 
     private
 
     def oauth2_client
-      if @oauth2_client.nil?
-        @oauth2_client = OAuth2::Client.new(
-          @application_id,
-          @secret_key,
-          {
-            site: @oauth2_login_url,
-            authorize_url: 'oauth2/authorize?resource=https://api.businesscentral.dynamics.com',
-            token_url: 'oauth2/token?resource=https://api.businesscentral.dynamics.com'
-          }
-        )
-      end
-        
-      return @oauth2_client
+      OAuth2::Client.new(
+        @application_id,
+        @secret_key,
+        site: @oauth2_login_url,
+        authorize_url: 'oauth2/authorize?resource=https://api.businesscentral.dynamics.com',
+        token_url: 'oauth2/token?resource=https://api.businesscentral.dynamics.com'
+      )
     end
 
     def handle_error(error)
-      if !error.code.nil?
-        case error.code
-          when 'invalid_client'
-            raise InvalidClientException.new
-        end
-      else
-        raise ApiException.new(error.message)
+      raise ApiException, error.message if error.code.nil?
+
+      case error.code
+      when 'invalid_client'
+        raise InvalidClientException
       end
     end
   end
-end
+end

data/lib/business_central/exceptions.rb

@@ -1,5 +1,6 @@
-module BusinessCentral
+# frozen_string_literal: true
 
+module BusinessCentral
   class BusinessCentralError < StandardError; end
 
   class InvalidClientException < BusinessCentralError
@@ -13,9 +14,7 @@ module BusinessCentral
       @message = message
     end
 
-    def message
-      @message
-    end
+    attr_reader :message
   end
 
   class CompanyNotFoundException < BusinessCentralError
@@ -30,15 +29,19 @@ module BusinessCentral
     end
   end
 
+  class NotFoundException < BusinessCentralError
+    def message
+      'Not Found - The URL provided cannot be found'
+    end
+  end
+
   class InvalidObjectException < BusinessCentralError
     def initialize(errors)
       @errors = errors
     end
 
     def message
-      @errors.each do |error|
-        "#{error[:field]} - #{error[:message]}"
-      end
+      @errors.each { |error| "#{error[:field]} - #{error[:message]}" }
     end
   end
 
@@ -49,7 +52,8 @@ module BusinessCentral
     end
 
     def message
-      "#{method} method is currently not support. Allowed methods are: #{allowed_methods.join(', ')}"
+      methods_allowed = @allowed_methods.join(', ')
+      "#{@method} method is currently not support. Allowed methods are: #{methods_allowed}"
     end
   end
 
@@ -62,4 +66,10 @@ module BusinessCentral
       "Invalid argument entered - #{@message}"
     end
   end
-end
+
+  class InvalidObjectURLException < BusinessCentralError
+    def message
+      'Object URL missing for request'
+    end
+  end
+end

data/lib/business_central/object/account.rb

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

data/lib/business_central/object/aged_account_payable.rb

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

data/lib/business_central/object/aged_account_receivable.rb

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

data/lib/business_central/object/argument_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    module ArgumentHelper
+      def id(argument)
+        return @id if instance_variable_defined?('@id') && !@id.nil?
+        return argument.fetch(:id, '') if !argument.nil?
+
+        nil
+      end
+
+      def company_id(argument)
+        return @client.default_company_id if !@client.default_company_id.nil?
+        return @company_id if instance_variable_defined?('@company_id') && !@company_id.nil?
+        return argument.fetch(:company_id, '') if !argument.nil?
+
+        nil
+      end
+    end
+  end
+end

data/lib/business_central/object/balance_sheet.rb

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

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