business-central 1.0.5 → 2.0.0

data/lib/business_central/object/request.rb

@@ -3,6 +3,8 @@
 module BusinessCentral
   module Object
     class Request
+      using Refinements::Strings
+
       class << self
         def get(client, url)
           request(:get, client, url)
@@ -66,23 +68,20 @@ module BusinessCentral
             response
           elsif Response.success_no_content?(request.code.to_i)
             true
-          else
-            if Response.unauthorized?(request.code.to_i)
-              raise UnauthorizedException
-            elsif Response.not_found?(request.code.to_i)
-              raise NotFoundException
+          elsif Response.unauthorized?(request.code.to_i)
+            raise UnauthorizedException
+          elsif Response.not_found?(request.code.to_i)
+            raise NotFoundException
+          elsif !response.fetch(:error, nil).nil?
+            case response[:error][:code]
+            when 'Internal_CompanyNotFound'
+              raise CompanyNotFoundException
             else
-              if !response.fetch(:error, nil).nil?
-                case response[:error][:code]
-                when 'Internal_CompanyNotFound'
-                  raise CompanyNotFoundException
-                else
-                  raise ApiException, "#{request.code} - #{response[:error][:code]} #{response[:error][:message]}"
-                end
-              else
-                raise ApiException, "#{request.code} - API call failed"
-              end
+              raise ApiException,
+                    "#{request.code} - #{response[:error][:code]} #{response[:error][:message]}"
             end
+          else
+            raise ApiException, "#{request.code} - API call failed"
           end
         end
       end

data/lib/business_central/object/response.rb

@@ -3,6 +3,8 @@
 module BusinessCentral
   module Object
     class Response
+      using Refinements::Strings
+
       class << self
         def success?(status)
           [200, 201].include?(status)
@@ -35,7 +37,9 @@ module BusinessCentral
       private
 
       def process
-        if @response.is_a?(Array)
+        if @response.is_a?(String)
+          @results = @response
+        elsif @response.is_a?(Array)
           @results = []
           @response.each do |data|
             @results << convert(data)

data/lib/business_central/object/url_builder.rb

@@ -3,6 +3,8 @@
 module BusinessCentral
   module Object
     class URLBuilder
+      using Refinements::Strings
+
       extend URLHelper
 
       class << self
@@ -14,12 +16,11 @@ module BusinessCentral
         end
       end
 
-      def initialize(base_url:, parent_path: [], child_path: '', child_id: '', child_code: '', filter: '')
+      def initialize(base_url:, object_path: [], object_id: '', object_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
+        @object_path = object_path || []
+        @object_id = object_id.to_s
+        @object_code = object_code.to_s
         @filter = filter.to_s
       end
 
@@ -34,18 +35,21 @@ module BusinessCentral
       private
 
       def build_parent_path
-        return '' if @parent_path.empty?
-
-        @parent_path.map do |parent|
-          "/#{parent[:path]}(#{parent[:id]})" if !parent[:id].nil?
+        return '' if @object_path.empty?
+
+        @object_path.map do |parent|
+          if !parent[:id].nil?
+            "/#{parent[:path]}(#{parent[:id]})"
+          else
+            "/#{parent[:path]}"
+          end
         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 += "(#{@object_id})" if @object_id.present?
+        url += "('#{odata_encode(@object_code)}')" if @object_code.present?
         url
       end
 

data/lib/business_central/object/url_helper.rb

@@ -3,8 +3,10 @@
 module BusinessCentral
   module Object
     module URLHelper
+      using Refinements::Strings
+
       def encode_url_object(object)
-        URI.encode(object)
+        URI::RFC2396_Parser.new.escape(object)
       end
 
       def encode_url_params(query)
@@ -13,7 +15,7 @@ module BusinessCentral
 
       def odata_encode(value)
         value = value.dup
-        value.gsub!(/'/, "''") if value =~ /'/
+        value.gsub!(/'/, "''") if value.instance_of?(String) && value =~ /'/
         value.to_s
       end
 
@@ -21,6 +23,18 @@ module BusinessCentral
 
       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])

data/lib/business_central/version.rb

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

data/lib/business_central/web_service.rb

@@ -2,6 +2,8 @@
 
 module BusinessCentral
   class WebService
+    using Refinements::Strings
+
     DEFAULT_URL = 'https://api.businesscentral.dynamics.com/v2.0/production/ODataV4'
 
     attr_reader :url, :object_url

data/lib/business_central.rb

@@ -3,69 +3,18 @@ require 'oauth2/error'
 require 'net/http'
 require 'json'
 
-require 'core_ext/string'
+require 'refinements/strings'
 
-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'
-require 'business_central/object/company_information'
-require 'business_central/object/country_region'
-require 'business_central/object/currency'
-require 'business_central/object/customer'
-require 'business_central/object/customer_financial_detail'
-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/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/base'
+require 'business_central/object/companies'
 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/attachments'
 
 require 'business_central/exceptions'
 require 'business_central/client'

data/lib/refinements/strings.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Strings
+    refine String do
+      def blank?
+        empty? || /\A[[:space:]]*\z/.match?(self)
+      end
+
+      def present?
+        !blank?
+      end
+
+      # Convert string to CamelCase
+      def to_camel_case(uppercase_first_letter = false)
+        string = self
+        string = if uppercase_first_letter
+                   string.sub(/^[a-z\d]*/, &:capitalize)
+                 else
+                   string.sub(/^(?:(?=\b|[A-Z_])|\w)/, &:downcase)
+                 end
+        string.gsub(%r{(?:_|(/))([a-z\d]*)}) do
+          "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+        end.gsub('/', '::')
+      end
+
+      # Convert string to snake_case
+      def to_snake_case
+        gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+
+      # Convert to class symbol
+      def to_class_sym
+        to_camel_case(true).to_s.to_sym
+      end
+    end
+  end
+end

data/test/business_central/client_test.rb

@@ -112,6 +112,30 @@ class BusinessCentral::ClientTest < Minitest::Test
     end
   end
 
+  def test_refresh_token_throws_invalid_grant_exception
+    @client.authorize_from_token(
+      token: '123',
+      refresh_token: '456',
+      expires_at: Time.now + 3600,
+      expires_in: 3600
+    )
+    stub_request(:post, /#{BusinessCentral::Client::DEFAULT_LOGIN_URL}/)
+      .to_return(
+        status: 200,
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: {
+          error: 'invalid_grant',
+          error_description: 'Invalid grant was because it was invalid'
+        }.to_json
+      )
+
+    assert_raises(BusinessCentral::InvalidGrantException) do
+      @client.refresh_token
+    end
+  end
+
   def test_build_web_service_object
     @client.web_service.object('Company/Vendors')
     assert_equal @client.web_service.object_url, 'Company/Vendors'

data/test/business_central/exceptions_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+# rake test TEST=test/business_central/exceptions_test.rb
+
+class BusinessCentral::ExceptionsTest < Minitest::Test
+  def test_invalid_client_exception
+    exception = BusinessCentral::InvalidClientException.new
+    assert_equal('Invalid client setup', exception.message)
+  end
+
+  def test_company_not_found_exception
+    exception = BusinessCentral::CompanyNotFoundException.new
+    assert_equal('Company not found', exception.message)
+  end
+
+  def test_unathorized_exception
+    exception = BusinessCentral::UnauthorizedException.new
+    assert_equal('Unauthorized - The credentials provided are incorrect', exception.message)
+  end
+
+  def test_not_found_exception
+    exception = BusinessCentral::NotFoundException.new
+    assert_equal('Not Found - The URL provided cannot be found', exception.message)
+  end
+
+  def test_invalid_object_url_exception
+    exception = BusinessCentral::InvalidObjectURLException.new
+    assert_equal('Object URL missing for request', exception.message)
+  end
+
+  def test_invalid_grant_exception
+    exception = BusinessCentral::InvalidGrantException.new('Extra error details')
+    assert_equal(
+      'The provided grant has expired due to it being revoked, a fresh auth token is needed',
+      exception.message
+    )
+    assert_equal('Extra error details', exception.error_message)
+  end
+end

data/test/business_central/object/{attachment_test.rb → attachments_test.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'test_helper'
-# rake test TEST=test/business_central/object/attachment_test.rb
+# rake test TEST=test/business_central/object/attachments_test.rb
 
-class BusinessCentral::Object::AttachmentTest < Minitest::Test
+class BusinessCentral::Object::AttachmentsTest < Minitest::Test
   def setup
     @company_id = '123456'
     @client = BusinessCentral::Client.new
-    @attachment = @client.attachment(company_id: @company_id)
+    @attachment = @client.attachments(company_id: @company_id)
   end
 
   def test_find_all
@@ -106,12 +106,11 @@ class BusinessCentral::Object::AttachmentTest < Minitest::Test
   end
 
   def test_delete
-    test_parent_id = '011124'
     test_attachment_id = '11124'
 
-    stub_request(:delete, /attachments\(#{test_parent_id},#{test_attachment_id}\)/)
+    stub_request(:delete, /attachments\(#{test_attachment_id}\)/)
       .to_return(status: 204)
 
-    assert @attachment.destroy(parent_id: test_parent_id, attachment_id: test_attachment_id)
+    assert @attachment.destroy(test_attachment_id)
   end
 end

data/test/business_central/object/base_test.rb

@@ -6,36 +6,73 @@ require 'test_helper'
 class BusinessCentral::Object::BaseTest < Minitest::Test
   def setup
     @company_id = '123456'
-    @client = BusinessCentral::Client.new
+    @client = BusinessCentral::Client.new(
+      default_company_id: @company_id
+    )
   end
 
-  def test_no_method_supported_for_find_all
-    base = BusinessCentral::Object::Base.new(@client, {})
-    set_object_method(base, [])
-    assert_raises(BusinessCentral::NoSupportedMethod) do
-      base.find_all
-    end
+  def test_client_responds_to_any_method_object
+    assert(@client.respond_to?(:random_object_that_does_not_exist))
   end
 
-  def test_no_method_supported_for_find_by_id
-    base = BusinessCentral::Object::Base.new(@client, {})
-    set_object_method(base, [])
-    assert_raises(BusinessCentral::NoSupportedMethod) do
-      base.find_by_id('123')
-    end
+  def test_respond_to_chaining_objects
+    assert(@client.vendors.respond_to?(:random_object_that_does_not_exist))
   end
 
-  def test_no_method_supported_for_where_query
-    base = BusinessCentral::Object::Base.new(@client, {})
-    set_object_method(base, [])
-    assert_raises(BusinessCentral::NoSupportedMethod) do
-      base.where("displayName eq '123'")
-    end
+  def test_find_all_for_vendor_object
+    stub_request(:get, %r{companies\(#{@company_id}\)/vendors})
+      .to_return(
+        status: 200,
+        body: {
+          'value': [
+            {
+              displayName: 'vendor1'
+            }
+          ]
+        }.to_json
+      )
+
+    response = @client.vendors.find_all
+    assert_equal response.first[:display_name], 'vendor1'
   end
 
-  private
+  def test_find_all_for_vendors_default_dimensions
+    stub_request(:get, %r{companies\(#{@company_id}\)/vendors\(1\)/defaultDimensions})
+      .to_return(
+        status: 200,
+        body: {
+          'value': [
+            {
+              dimensionValueCode: 'SALES'
+            }
+          ]
+        }.to_json
+      )
+
+    response = @client.vendors(id: 1).default_dimensions.find_all
+    assert_equal response.first[:dimension_value_code], 'SALES'
+  end
+
+  def test_update_vendor_object
+    test_id = 1
+    stub_request(:get, %r{companies\(#{@company_id}\)/vendors\(#{test_id}\)})
+      .to_return(
+        status: 200,
+        body: {
+          etag: '111',
+          displayName: 'vendor1'
+        }.to_json
+      )
+
+    stub_request(:patch, %r{companies\(#{@company_id}\)/vendors\(#{test_id}\)})
+      .to_return(
+        status: 200,
+        body: {
+          displayName: 'vendor2'
+        }.to_json
+      )
 
-  def set_object_method(base, value)
-    base.class.const_set('OBJECT_METHODS', value) if !base.class.const_defined?('OBJECT_METHODS')
+    response = @client.vendors.update(test_id, { display_name: 'vendor2' })
+    assert_equal response[:display_name], 'vendor2'
   end
 end

data/test/business_central/object/{company_test.rb → companies_test.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'test_helper'
-# rake test TEST=test/business_central/object/company_test.rb
+# rake test TEST=test/business_central/object/companies_test.rb
 
-class BusinessCentral::Object::CompanyTest < Minitest::Test
+class BusinessCentral::Object::CompaniesTest < Minitest::Test
   def setup
     @client = BusinessCentral::Client.new
-    @company = @client.company
+    @company = @client.companies
   end
 
   def test_find_all
@@ -39,22 +39,4 @@ class BusinessCentral::Object::CompanyTest < Minitest::Test
     response = @company.find_by_id(test_company_id)
     assert_equal response[:display_name], 'business2'
   end
-
-  def test_create
-    assert_raises BusinessCentral::NoSupportedMethod do
-      @company.create({})
-    end
-  end
-
-  def test_update
-    assert_raises BusinessCentral::NoSupportedMethod do
-      @company.update('123', {})
-    end
-  end
-
-  def test_delete
-    assert_raises BusinessCentral::NoSupportedMethod do
-      @company.destroy('123')
-    end
-  end
 end

data/test/business_central/object/picture_test.rb

@@ -7,11 +7,11 @@ class BusinessCentral::Object::PictureTest < Minitest::Test
   def setup
     @company_id = '123456'
     @client = BusinessCentral::Client.new
-    @picture = @client.picture(parent: 'vendors', parent_id: '123', company_id: @company_id)
+    @picture = @client.items(id: 123, company_id: @company_id).picture
   end
 
   def test_find_all
-    stub_request(:get, /picture/)
+    stub_request(:get, %r{companies\(#{@company_id}\)/items\(123\)/picture})
       .to_return(
         status: 200,
         body: {
@@ -25,21 +25,12 @@ class BusinessCentral::Object::PictureTest < Minitest::Test
           ]
         }.to_json
       )
-
     response = @picture.find_all
     assert_equal response.first[:content_type], 'image\jpeg'
   end
 
-  def test_create
-    stub_request(:patch, /picture/)
-      .to_return(status: 204)
-
-    response = @picture.create('ImageData')
-    assert response
-  end
-
   def test_update
-    stub_request(:get, /picture/)
+    stub_request(:get, %r{companies\(#{@company_id}\)/items\(123\)/picture})
       .to_return(
         status: 200,
         body: {
@@ -48,16 +39,16 @@ class BusinessCentral::Object::PictureTest < Minitest::Test
         }.to_json
       )
 
-    stub_request(:patch, /picture/)
+    stub_request(:patch, %r{companies\(#{@company_id}\)/items\(123\)/picture\(1\)/content})
       .to_return(status: 204)
 
-    response = @picture.update('ImageData')
+    response = @picture.update(1, 'ImageData')
     assert response
   end
 
   def test_delete
     test_id = 2
-    stub_request(:get, /picture/)
+    stub_request(:get, %r{companies\(#{@company_id}\)/items\(123\)/picture\(#{test_id}\)})
       .to_return(
         status: 200,
         body: {
@@ -66,7 +57,7 @@ class BusinessCentral::Object::PictureTest < Minitest::Test
         }.to_json
       )
 
-    stub_request(:delete, /picture/)
+    stub_request(:delete, %r{companies\(#{@company_id}\)/items\(123\)/picture\(#{test_id}\)})
       .to_return(status: 204)
 
     assert @picture.destroy(test_id)

data/test/business_central/object/response_test.rb

@@ -43,4 +43,9 @@ class BusinessCentral::Object::ResponseTest < Minitest::Test
     request = BusinessCentral::Object::Response.new(params).results
     assert request.key?(:item)
   end
+
+  def test_string_response
+    response = BusinessCentral::Object::Response.new('{ "value": "OK - Action was successful" }')
+    assert_equal 'OK - Action was successful', response.results
+  end
 end

data/test/business_central/web_service_test.rb

@@ -14,11 +14,16 @@ class BusinessCentral::WebServiceTest < Minitest::Test
     assert_equal @web_service.object_url, 'Company/Vendors'
   end
 
-  def test_build_object_url_with_template_values
+  def test_build_object_url_with_array_template_values
     @web_service.object("Company('?')", 'business1')
     assert_equal @web_service.object_url, "Company('business1')"
   end
 
+  def test_build_object_url_with_hash_template_values
+    @web_service.object("Company(':business_name')", business_name: 'business1')
+    assert_equal @web_service.object_url, "Company('business1')"
+  end
+
   def test_object_get_request
     stub_request(:get, /Company/)
       .to_return(
@@ -92,4 +97,4 @@ class BusinessCentral::WebServiceTest < Minitest::Test
 
     assert @web_service.object("Company('?')", test_company_name).delete
   end
-end
+end