business-central 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68fd68c7e0cf337b5f2c83ba5f08e21cdbab84b3c10a3515338a6d5241ab3c8d
-  data.tar.gz: 14b3bcbe75143b2457c7ca2606a33926de4e89fd7001323c97911d557037301e
+  metadata.gz: eb391f19d6cbf2649ddbe7eb0cf937d2657c140de32d6f6a8c1f92483a353f57
+  data.tar.gz: c9ad222424c8b46bd9cdc4e282e5b583b2e795d1e1917c942b7da259e8380c92
 SHA512:
-  metadata.gz: bfe06ca5d2427eaed0f8bcb6826e87635d72f02e456e7f4dba47bb19645edb757cc85af0436038f611821975fe43e39387238e180172e3ec09b95720ab45edcb
-  data.tar.gz: 461aadc6e03b1a77bbe6737d69776d2c909baebd36c680a558320abc674f27824983cc1e3b1401b35f85b90fb9ba28f5ff7aaa93a0adbd79e50d8df828532fc6
+  metadata.gz: 3413af99b793f31b5913c726dd7fc3f5c48328f39321809b35da46f62100a12b529996eadfd3191d1581c52a718d749fa7eb2b808eb3f063f7a2e9c05975967e
+  data.tar.gz: 5e96d79316386187618b362f3ea365f2f510b50622a50f2436ec45feaa32d435e839fcbf4ac20b8c7bb8dc8b33e98a5a7295b2d9beeac7257bd4f1d5e6a4aca5

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.rb

@@ -19,6 +19,7 @@ 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'
@@ -35,6 +36,9 @@ 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'

data/lib/business_central/client.rb

@@ -8,8 +8,7 @@ module BusinessCentral
 
     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,
@@ -25,6 +24,7 @@ module BusinessCentral
     object :account
     object :aged_account_payable
     object :aged_account_receivable
+    object :attachment
     object :balance_sheet
     object :cash_flow_statement
     object :company
@@ -41,6 +41,9 @@ module BusinessCentral
     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
@@ -71,7 +74,6 @@ module BusinessCentral
 
     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

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/customer.rb

@@ -27,6 +27,7 @@ module BusinessCentral
         delete
       ].freeze
 
+      navigation :default_dimension
       navigation :picture
     end
   end

data/lib/business_central/object/default_dimension.rb

@@ -36,7 +36,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
         @parent_id = parent_id

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

data/lib/business_central/object/journal_line.rb

@@ -39,7 +39,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
       end

data/lib/business_central/object/picture.rb

@@ -24,7 +24,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
         @parent_id = parent_id

data/lib/business_central/object/sales_credit_memo_line.rb

@@ -21,7 +21,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
       end

data/lib/business_central/object/sales_invoice_line.rb

@@ -21,7 +21,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
       end

data/lib/business_central/object/sales_order_line.rb

@@ -21,7 +21,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
       end

data/lib/business_central/object/sales_quote_line.rb

@@ -21,7 +21,7 @@ module BusinessCentral
 
         super(client, args)
         @parent_path << {
-          path: parent.downcase,
+          path: parent,
           id: parent_id
         }
       end

data/lib/business_central/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BusinessCentral
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/test/business_central/object/attachment_test.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+# rake test TEST=test/business_central/object/attachment_test.rb
+
+class BusinessCentral::Object::AttachmentTest < Minitest::Test
+  def setup
+    @company_id = '123456'
+    @client = BusinessCentral::Client.new
+    @attachment = @client.attachment(company_id: @company_id)
+  end
+
+  def test_find_all
+    stub_request(:get, /attachments/)
+      .to_return(
+        status: 200,
+        body: {
+          'value': [
+            {
+              id: '111',
+              fileName: 'attachment1.pdf'
+            }
+          ]
+        }.to_json
+      )
+
+    response = @attachment.find_all
+    assert_equal response.first[:file_name], 'attachment1.pdf'
+  end
+
+  def test_find_by_id
+    test_id = '09876'
+    stub_request(:get, /attachments\(#{test_id}\)/)
+      .to_return(
+        status: 200,
+        body: {
+          id: '222',
+          fileName: 'attachment2.jpg'
+        }.to_json
+      )
+
+    response = @attachment.find_by_id(test_id)
+    assert_equal response[:file_name], 'attachment2.jpg'
+  end
+
+  def test_where
+    test_filter = "fileName eq 'attachment3.png'"
+    stub_request(:get, /attachments\?\$filter=#{test_filter}/)
+      .to_return(
+        status: 200,
+        body: {
+          'value': [
+            {
+              id: '333',
+              fileName: 'attachment3.png'
+            }
+          ]
+        }.to_json
+      )
+
+    response = @attachment.where(test_filter)
+    assert_equal response.first[:file_name], 'attachment3.png'
+  end
+
+  def test_create
+    stub_request(:post, /attachments/)
+      .to_return(
+        status: 200,
+        body: {
+          fileName: 'attachment4.gif'
+        }.to_json
+      )
+
+    response = @attachment.create(
+      file_name: 'attachment4.gif'
+    )
+    assert_equal response[:file_name], 'attachment4.gif'
+  end
+
+  def test_update
+    test_parent_id = '011123'
+    test_attachment_id = '11123'
+    stub_request(:get, /attachments\(parentId=#{test_parent_id},id=#{test_attachment_id}\)/)
+      .to_return(
+        status: 200,
+        body: {
+          etag: '112',
+          fileName: 'attachment5.pdf'
+        }.to_json
+      )
+
+    stub_request(:patch, /attachments\(parentId=#{test_parent_id},id=#{test_attachment_id}\)/)
+      .to_return(
+        status: 200,
+        body: {
+          fileName: 'attachment6.pdf'
+        }.to_json
+      )
+
+    response = @attachment.update(
+      parent_id: test_parent_id,
+      attachment_id: test_attachment_id,
+      file_name: 'attachment6.pdf'
+    )
+    assert_equal response[:file_name], 'attachment6.pdf'
+  end
+
+  def test_delete
+    test_parent_id = '011124'
+    test_attachment_id = '11124'
+
+    stub_request(:delete, /attachments\(#{test_parent_id},#{test_attachment_id}\)/)
+      .to_return(status: 204)
+
+    assert @attachment.destroy(parent_id: test_parent_id, attachment_id: test_attachment_id)
+  end
+end