business-central 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfee02464cc6b4a28c6208ced736a5d8453f917cbe8757f7e28cd6ad900721d6
-  data.tar.gz: ca2a683c9f3440d4fa953507051021145b1690bd42152ba488eae70c451ce2ae
+  metadata.gz: f0f72fc6bbd65910d177852470a583d46dd0ec8972df68f3aed670cb0a2ff7f9
+  data.tar.gz: 42984f880fd1d2fa3b72d81ea788e3e1d60b0fec81d1f8bf89c4ed8b2a774592
 SHA512:
-  metadata.gz: 454c708a9323072524312b21877aca84918c2bb2c611956849291446c9117a007301112333d7c3bf25b3e5ac1707a81a2bdde2d7b3cc50f561ec0d28df5a40d0
-  data.tar.gz: 78cbb22465b21ca9f876c621986e55a9843df5b9505a6552425ae56667258aaddff9ec76e3a00f5b7f820572e3a3bf887c2d49516d8e2b203f0ef2d02bf52aaf
+  metadata.gz: ee5ff0ec47a550c3a2433b12ab79f6c733f3adc17a0dca4aa83393a0661cc90a0e4351743c937f523af567aef048213e60dfcec7a48c58ab94ab7f25a8a9751d
+  data.tar.gz: 912b7d625087bed194cd73707425089798dec3a09ab048d347842a904f170bb021f770d2826ac1398cda0be3f94f82efd406b56d5088b3bda08fa1b4b87be6c9

data/README.md

@@ -26,6 +26,22 @@ This gem supports both authentication methods:
 
 https://docs.microsoft.com/en-us/dynamics-nav/api-reference/v1.0/endpoints-apis-for-dynamics
 
+```Ruby
+require 'business_central'
+
+client = BusinessCentral::Client.new(
+    username: '<username>',                 # Basic authentication username
+    password: '<password>',                 # Basic authentication password
+    url: '<url>',                           # URL for API defaults to https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0
+    web_service_url: '<url>',               # URL for custom web services defaults to https://api.businesscentral.dynamics.com/v2.0/production/ODataV4 
+    application_id: '<application_id>',     # Oauth2 authentication application ID
+    secret_key: '<application_secret_key>', # OAuth2 authentication application secret key
+    oauth2_login_url: '<url>',              # OAuth2 authentication login URL defaults to https://login.microsoftonline.com/common
+    default_company_id: '<company_id>',     # Default company ID used in all requests (if required)
+    debug: false                            # Output requests to console
+)
+```
+
 ### Basic Authentication:
 
 https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/developer/devenv-develop-connect-apps#setting-up-basic-authentication
@@ -36,26 +52,27 @@ require 'business_central'
 client = BusinessCentral::Client.new(
     username: '<username>',
     password: '<password>',
-    url: '<url>'
+    url: '<url>',
+    default_company_id: '11111111-2222-3333-4444-555555555555'
 )
 
 # Find all vendors
-vendors = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').find_all
+vendors = client.vendor.all
 
 # Find vendor by ID
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').find_by_id('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
+vendor = client.vendor.find('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
 
 # Query vendor by display name
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').where("displayName eq 'First Up Consultants'")
+vendor = client.vendor.where("displayName eq 'First Up Consultants'")
 
 # Create a new vendor
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').create({ display_name: 'hello testing new vendor' })
+vendor = client.vendor.create({ display_name: 'hello testing new vendor' })
 
 # Update an existing vendor by ID
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
+vendor = client.vendor.update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
 
 # Delete a vendor
-client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
+client.vendor.destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
 ```
 
 ### Oauth2 Authentication
@@ -67,10 +84,10 @@ require 'business_central'
 
 # Create client - used to connect to the API
 client = BusinessCentral::Client.new(
-    tenant_id: '<tenant_id>',
     application_id: '<application_id>',
     secret_key: '<application_secret_key>',
-    url: '<url>'
+    url: '<url>',
+    default_company_id: '11111111-2222-3333-4444-555555555555'
 )
 
 # Controller endpoint 1
@@ -87,22 +104,48 @@ client.authorize_from_token(
 )
 
 # Find all vendors
-vendors = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').find_all
+vendors = client.vendor.all
 
 # Find vendor by ID
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').find_by_id('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
+vendor = client.vendor.find('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
 
 # Query vendor by display name
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').where("displayName eq 'First Up Consultants'")
+vendor = client.vendor.where("displayName eq 'First Up Consultants'")
 
 # Create a new vendor
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').create({ display_name: 'hello testing' })
+vendor = client.vendor.create({ display_name: 'hello testing' })
 
 # Update an existing vendor by ID
-vendor = client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
+vendor = client.vendor.update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
 
 # Delete a vendor
-client.vendor(company_id: '3a502065-2a08-4c3b-9468-fb83642d3d3a').destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
+client.vendor.destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
+```
+
+### OData Web Services
+
+https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/webservices/odata-web-services
+
+```Ruby
+require 'business_central'
+
+client = BusinessCentral::Client.new(
+    username: '<username>',
+    password: '<password>',
+    web_service_url: '<url>'
+)
+
+# Query a record 
+company = client.web_service.object("Company('?')/Purchase_Order", 'My Company').get
+
+# Create a record
+client.web_service.object("Company('?')/Purchase_Order", 'My Company').post({})
+
+# Update a record
+client.web_service.object("Company('?')/Purchase_Order", 'My Company').patch({})
+
+# Delete a record
+client.web_service.object("Company('?')/Purchase_Order", 'My Company').delete
 ```
 
 ## Development

data/lib/business_central/client.rb

@@ -1,26 +1,30 @@
+# 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,
+    attr_reader :username,
                 :password,
                 :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
     object :aged_account_receivable
+    object :attachment
     object :balance_sheet
     object :cash_flow_statement
     object :company
@@ -33,81 +37,107 @@ 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 :general_ledger_entry
+    object :income_statement
+    object :irs1099_code
     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
+    object :purchase_order
 
     def initialize(options = {})
       opts = options.dup
-      @tenant_id = opts.delete(:tenant_id)
       @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/attachment.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class Attachment < Base
+      OBJECT = 'attachments'
+
+      OBJECT_METHODS = %i[
+        get
+        post
+        patch
+        delete
+      ].freeze
+
+      def update(parent_id:, attachment_id:, **params)
+        url = "#{build_url(child_path: OBJECT)}(parentId=#{parent_id},id=#{attachment_id})/content"
+        Request.call(:patch, @client, url, etag: '', params: {}) do |request|
+          request['Content-Type'] = 'application/json'
+          request['If-Match'] = 'application/json'
+          request.body = Request.convert(params)
+        end
+      end
+
+      def destroy(parent_id:, attachment_id:)
+        url = "#{build_url(child_path: OBJECT)}(#{parent_id},#{attachment_id})"
+        Request.call(:delete, @client, url, etag: '')
+      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