business-central 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb391f19d6cbf2649ddbe7eb0cf937d2657c140de32d6f6a8c1f92483a353f57
-  data.tar.gz: c9ad222424c8b46bd9cdc4e282e5b583b2e795d1e1917c942b7da259e8380c92
+  metadata.gz: 0bea7c31120cb14daee81aa200a050a427d8ea281c924c87d04d3655a8d17841
+  data.tar.gz: 1894167530217ffd7e30624729896ad8f2ae30ffb9eb2c3d305d6695cd962638
 SHA512:
-  metadata.gz: 3413af99b793f31b5913c726dd7fc3f5c48328f39321809b35da46f62100a12b529996eadfd3191d1581c52a718d749fa7eb2b808eb3f063f7a2e9c05975967e
-  data.tar.gz: 5e96d79316386187618b362f3ea365f2f510b50622a50f2436ec45feaa32d435e839fcbf4ac20b8c7bb8dc8b33e98a5a7295b2d9beeac7257bd4f1d5e6a4aca5
+  metadata.gz: 73b14fc71f142fae957f851631c84517bc42a56ba4492f1c5c19ec7f50ea8a5b01eaaf33abee424f5748e61808778c3a950756c31929ad221f8e3ece186bed95
+  data.tar.gz: b39dc96f9302397ab319d2c266f7dcedf8336e7972996fed4b7e44c8f17c8afd395b9f0fff02c2210debb590abc43b34eeb76bcebe3ed96836c70d60f3f4cb25

data/README.md

@@ -22,9 +22,9 @@ Or install it yourself as:
 
 ## Basic Usage
 
-This gem supports both authentication methods:
+This gem supports both basic and OAuth2 authentication methods:
 
-https://docs.microsoft.com/en-us/dynamics-nav/api-reference/v1.0/endpoints-apis-for-dynamics
+https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/endpoints-apis-for-dynamics
 
 ```Ruby
 require 'business_central'
@@ -55,24 +55,6 @@ client = BusinessCentral::Client.new(
     url: '<url>',
     default_company_id: '11111111-2222-3333-4444-555555555555'
 )
-
-# Find all vendors
-vendors = client.vendor.all
-
-# Find vendor by ID
-vendor = client.vendor.find('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
-
-# Query vendor by display name
-vendor = client.vendor.where("displayName eq 'First Up Consultants'")
-
-# Create a new vendor
-vendor = client.vendor.create({ display_name: 'hello testing new vendor' })
-
-# Update an existing vendor by ID
-vendor = client.vendor.update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
-
-# Delete a vendor
-client.vendor.destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
 ```
 
 ### Oauth2 Authentication
@@ -102,26 +84,57 @@ client.authorize_from_token(
     expires_at: DateTime.current + 3600,
     expires_in: 3600
 )
+```
 
-# Find all vendors
-vendors = client.vendor.all
+### Calling objects
 
-# Find vendor by ID
-vendor = client.vendor.find('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4')
+https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/
+
+```Ruby
+begin
+    # Find all vendors
+    client.vendors.all
 
-# Query vendor by display name
-vendor = client.vendor.where("displayName eq 'First Up Consultants'")
+    # Find vendor by ID
+    client.vendors.find('557d12d7-25f5-ec11-82f1-000d3a299c8c')
 
-# Create a new vendor
-vendor = client.vendor.create({ display_name: 'hello testing' })
+    # Query vendor by display name
+    client.vendors.where("displayName eq 'First Up Consultants'")
 
-# Update an existing vendor by ID
-vendor = client.vendor.update('3f445b08-2ffd-4f9d-81a0-b82f0d9714c4', { phone_number: '1112' })
+    # Create a new vendor
+    client.vendors.create({ display_name: 'hello testing' })
 
-# Delete a vendor
-client.vendor.destroy('f0730ada-b315-ea11-a813-000d3ad21e99')
+    # Update an existing vendor by ID
+    client.vendors.update('39a7ef39-ba0f-ed11-90ed-00224895e26b', { phone_number: '1112' })
+
+    # Delete a vendor
+    client.vendors.destroy('39a7ef39-ba0f-ed11-90ed-00224895e26b')
+
+    # ---------
+
+    # Find all vendor default dimensions
+    client.vendors(id: '557d12d7-25f5-ec11-82f1-000d3a299c8c').default_dimensions.all
+
+    # Query vendor default dimensions by dimension code
+    client.vendors(id: '557d12d7-25f5-ec11-82f1-000d3a299c8c').default_dimensions.where("dimensionCode eq 'DEPARTMENT'")
+
+    # Create a new vendor default dimension
+    client.vendors(id: '557d12d7-25f5-ec11-82f1-000d3a299c8c').default_dimensions.create({ dimension_code: 'DEPARTMENT' })
+
+    # Update an existing vendor default dimension
+    client.vendors(id: '557d12d7-25f5-ec11-82f1-000d3a299c8c').default_dimensions.update('6576ecf4-25f5-ec11-82f1-000d3a299c8c', { dimension_code: 'NEW_DEPARTMENT' })
+
+    # Delete a vendor default dimension
+    client.vendors(id: '557d12d7-25f5-ec11-82f1-000d3a299c8c').default_dimensions.destroy('6576ecf4-25f5-ec11-82f1-000d3a299c8c')
+rescue StandardError => e
+  puts e.message
+rescue BusinessCentral::ApiException => e
+  puts e.message
+end
 ```
 
+All objects should be callable, assuming the endpoint exists.
+
 ### OData Web Services
 
 https://docs.microsoft.com/en-us/dynamics365/business-central/dev-itpro/webservices/odata-web-services

data/lib/business_central/client.rb

@@ -2,7 +2,9 @@
 
 module BusinessCentral
   class Client
-    extend BusinessCentral::Object::ObjectHelper
+    using Refinements::Strings
+
+    include BusinessCentral::Object::ObjectHelper
 
     DEFAULT_LOGIN_URL = 'https://login.microsoftonline.com/common'
 
@@ -21,57 +23,6 @@ module BusinessCentral
 
     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
-    object :company_information
-    object :country_region
-    object :currency
-    object :customer
-    object :customer_financial_detail
-    object :customer_payment
-    object :customer_payment_journal
-    object :customer_sale
-    object :default_dimension
-    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
-
     def initialize(options = {})
       opts = options.dup
       @username = opts.delete(:username)
@@ -112,6 +63,8 @@ module BusinessCentral
 
     def refresh_token
       @oauth2_access_token.refresh!
+    rescue OAuth2::Error => e
+      handle_error(e)
     end
 
     def web_service
@@ -136,6 +89,8 @@ module BusinessCentral
       case error.code
       when 'invalid_client'
         raise InvalidClientException
+      when 'invalid_grant'
+        raise InvalidGrantException, error.message
       end
     end
   end

data/lib/business_central/exceptions.rb

@@ -3,15 +3,10 @@
 module BusinessCentral
   class BusinessCentralError < StandardError; end
 
-  class InvalidClientException < BusinessCentralError
-    def message
-      'Invalid client setup'
-    end
-  end
-
   class ApiException < BusinessCentralError
     def initialize(message)
       @message = message
+      super
     end
 
     attr_reader :message
@@ -35,41 +30,28 @@ module BusinessCentral
     end
   end
 
-  class InvalidObjectException < BusinessCentralError
-    def initialize(errors)
-      @errors = errors
-    end
-
+  class InvalidObjectURLException < BusinessCentralError
     def message
-      @errors.each { |error| "#{error[:field]} - #{error[:message]}" }
+      'Object URL missing for request'
     end
   end
 
-  class NoSupportedMethod < BusinessCentralError
-    def initialize(method, allowed_methods)
-      @method = method
-      @allowed_methods = allowed_methods
-    end
-
+  class InvalidClientException < BusinessCentralError
     def message
-      methods_allowed = @allowed_methods.join(', ')
-      "#{@method} method is currently not support. Allowed methods are: #{methods_allowed}"
+      'Invalid client setup'
     end
   end
 
-  class InvalidArgumentException < BusinessCentralError
-    def initialize(message)
-      @message = message
+  class InvalidGrantException < BusinessCentralError
+    def initialize(error_message)
+      @error_message = error_message
+      super
     end
 
-    def message
-      "Invalid argument entered - #{@message}"
-    end
-  end
+    attr_reader :error_message
 
-  class InvalidObjectURLException < BusinessCentralError
     def message
-      'Object URL missing for request'
+      'The provided grant has expired due to it being revoked, a fresh auth token is needed'
     end
   end
 end

data/lib/business_central/object/{attachment.rb → attachments.rb}

@@ -2,18 +2,17 @@
 
 module BusinessCentral
   module Object
-    class Attachment < Base
+    class Attachments < Base
+      using Refinements::Strings
+
       OBJECT = 'attachments'
 
-      OBJECT_METHODS = %i[
-        get
-        post
-        patch
-        delete
-      ].freeze
+      def initialize(client, **args)
+        super(client, **args.merge!({ object_name: OBJECT }))
+      end
 
       def update(parent_id:, attachment_id:, **params)
-        url = "#{build_url(child_path: OBJECT)}(parentId=#{parent_id},id=#{attachment_id})/content"
+        url = "#{build_url}(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'
@@ -21,9 +20,8 @@ module BusinessCentral
         end
       end
 
-      def destroy(parent_id:, attachment_id:)
-        url = "#{build_url(child_path: OBJECT)}(#{parent_id},#{attachment_id})"
-        Request.call(:delete, @client, url, etag: '')
+      def destroy(id)
+        Request.call(:delete, @client, build_url(object_id: id), etag: '')
       end
     end
   end

data/lib/business_central/object/base.rb

@@ -3,154 +3,82 @@
 module BusinessCentral
   module Object
     class Base
-      include ArgumentHelper
+      using Refinements::Strings
 
-      attr_reader :client, :parent_path, :path
+      attr_reader :client
 
-      attr_writer :id, :company_id
-
-      def initialize(client, args = {})
+      def initialize(client, **args)
         @client = client
-        @id = id(args)
-        @company_id = company_id(args)
-        @parent_path = @company_id.nil? ? [] : [
-          {
-            path: 'companies',
-            id: @company_id
-          }
-        ]
+        @object_path = args.fetch(
+          :object_path,
+          [
+            {
+              path: 'companies',
+              id: args.fetch(:company_id, client.default_company_id)
+            },
+            {
+              path: args.fetch(:object_name, '').to_s.to_camel_case,
+              id: args.fetch(:id, nil)
+            }
+          ]
+        )
       end
 
       def find_all
-        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))
+        Request.get(@client, build_url)
       end
       alias all find_all
 
       def find_by_id(id)
-        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
-          )
-        )
+        Request.get(@client, build_url(object_id: id))
       end
       alias find find_by_id
 
       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)
-          )
-        )
+        Request.get(@client, build_url(filter: FilterQuery.sanitize(query, values)))
       end
 
       def create(params = {})
-        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)
+        Request.post(@client, build_url, params)
       end
 
       def update(id, params = {})
-        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
-        )
+        Request.patch(@client, build_url(object_id: id), object[:etag], params)
       end
 
       def destroy(id)
-        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]
-        )
+        Request.delete(@client, build_url(object_id: id), object[:etag])
+      end
+      alias delete destroy
+
+      def method_missing(object_name, **params)
+        @object_path << {
+          path: object_name.to_s.to_camel_case,
+          id: params.fetch(:id, nil)
+        }
+        if BusinessCentral::Object.const_defined?(object_name.to_s.to_class_sym)
+          klass = BusinessCentral::Object.const_get(object_name.to_s.to_class_sym)
+          return klass.new(client, **params.merge!({ object_path: @object_path }))
+        end
+        self
       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(', ')}"
+      def respond_to_missing?(_object_name, *_params)
+        true
       end
 
-      def build_url(parent_path: [], child_path: '', child_id: '', filter: '')
+      private
+
+      def build_url(object_id: '', filter: '')
         URLBuilder.new(
           base_url: client.url,
-          parent_path: parent_path,
-          child_path: child_path,
-          child_id: child_id,
+          object_path: @object_path,
+          object_id: object_id,
           filter: filter
         ).build
       end
-
-      private
-
-      def object_name
-        self.class.const_get(:OBJECT)
-      end
-
-      def 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 object_parent_name
-        self.class.const_get(:OBJECT_PARENTS)
-      end
-
-      def method_supported?(method)
-        return true if object_methods.include?(method)
-
-        false
-      end
     end
   end
 end

data/lib/business_central/object/companies.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module BusinessCentral
+  module Object
+    class Companies < Base
+      using Refinements::Strings
+
+      OBJECT = 'companies'
+
+      def initialize(client, **args)
+        super(client, **args.merge!({ object_name: OBJECT }))
+        @object_path = [{
+          path: OBJECT,
+          id: nil
+        }]
+      end
+    end
+  end
+end

data/lib/business_central/object/filter_query.rb

@@ -3,6 +3,8 @@
 module BusinessCentral
   module Object
     class FilterQuery
+      using Refinements::Strings
+
       extend URLHelper
 
       class << self

data/lib/business_central/object/object_helper.rb

@@ -3,46 +3,19 @@
 module BusinessCentral
   module Object
     module ObjectHelper
-      include ArgumentHelper
-      
-      def object(object_name, *_params)
-        define_method(object_name) do |argument = nil|
-          object = "@#{object_name}_cache".to_sym
-          if argument.nil?
-            if !instance_variable_defined?(object)
-              instance_variable_set(
-                object,
-                BusinessCentral::Object.const_get(
-                  object_name.to_s.to_camel_case(true).to_s.to_sym
-                ).new(self, argument)
-              )
-            else
-              instance_variable_get(object)
-            end
-          else
-            instance_variable_set(
-              object,
-              BusinessCentral::Object.const_get(
-                object_name.to_s.to_camel_case(true).to_s.to_sym
-              ).new(self, argument)
-            )
-          end
+      using Refinements::Strings
+
+      def method_missing(object_name, **params)
+        if BusinessCentral::Object.const_defined?(object_name.to_s.to_class_sym)
+          klass = BusinessCentral::Object.const_get(object_name.to_s.to_class_sym)
+          klass.new(self, **params)
+        else
+          BusinessCentral::Object::Base.new(self, **params.merge!({ object_name: object_name }))
         end
       end
 
-      def navigation(object_name, *_params)
-        define_method(object_name) do |argument = nil|
-          object = "@#{object_name}_cache".to_sym
-          instance_variable_set(
-            object,
-            BusinessCentral::Object.const_get(object_name.to_s.to_camel_case(true).to_s.to_sym).new(
-              client,
-              company_id: company_id(argument),
-              parent: self.class.const_get(:OBJECT),
-              parent_id: id(argument)
-            )
-          )
-        end
+      def respond_to_missing?(_object_name, _include_all)
+        true
       end
     end
   end

data/lib/business_central/object/picture.rb

@@ -3,47 +3,11 @@
 module BusinessCentral
   module Object
     class Picture < Base
-      OBJECT = 'picture'
+      using Refinements::Strings
 
-      OBJECT_METHODS = %i[
-        get
-        post
-        patch
-        delete
-      ].freeze
-
-      OBJECT_PARENTS = %w[
-        items
-        customers
-        vendors
-        employees
-      ].freeze
-
-      def initialize(client, parent:, parent_id:, **args)
-        return if !valid_parent?(parent)
-
-        super(client, args)
-        @parent_path << {
-          path: parent,
-          id: parent_id
-        }
-        @parent_id = parent_id
-      end
-
-      def create(data)
-        url = "#{build_url(parent_path: @parent_path, child_path: object_name)}(#{@parent_id})/content"
-        Request.call(:patch, @client, url, etag: '', params: {}) do |request|
-          request['Content-Type'] = 'application/octet-stream'
-          request['If-Match'] = '*'
-          request.body = data
-        end
-      end
-
-      def update(data)
-        url = "#{build_url(parent_path: @parent_path, child_path: object_name)}(#{@parent_id})"
-        object = Request.get(@client, url)
-        url = "#{build_url(parent_path: @parent_path, child_path: object_name)}(#{@parent_id})/content"
-        Request.call(:patch, @client, url, etag: object[:etag], params: {}) do |request|
+      def update(id, data)
+        object = find_all
+        Request.call(:patch, @client, "#{build_url(object_id: id)}/content", etag: object[:etag], params: {}) do |request|
           request['Content-Type'] = 'application/octet-stream'
           request.body = data
         end