business_central 0.9.3

data/lib/business_central/purchase_invoice.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /purchaseInvoices API
+#
+
+module BusinessCentral
+  class PurchaseInvoice < BusinessCentral::Base
+    API_OBJECT = "purchaseInvoices"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/purchase_invoice_line.rb

@@ -0,0 +1,43 @@
+##
+# Provides access to the /purchaseInvoices/{Id}/purchaseInvoiceLines API
+#
+
+module BusinessCentral
+  class PurchaseInvoiceLine < BusinessCentral::Base
+    API_OBJECT_PARENT = "purchaseInvoices"
+    API_OBJECT = "purchaseInvoiceLines"
+
+    def get(purchase_invoice_id, purchase_invoice_line_id = nil)
+      get_child(purchase_invoice_id, purchase_invoice_line_id)
+    end
+
+    def create(purchase_invoice_id, data)
+      url = build_url(purchase_invoice_id, nil)
+
+      response = @client.post(url, data)
+      handle_error(response)
+      results = process(response)
+
+      return results.first
+    end
+
+    def update(purchase_invoice_id, purchase_invoice_line_id, etag, data)
+      url = build_url(purchase_invoice_id, purchase_invoice_line_id)
+
+      response = @client.patch(url, etag, data)
+      handle_error(repsonse)
+      results = process(response)
+
+      return results.first
+    end
+
+    def delete(purchase_invoice_id, purchase_invoice_line_id, etag)
+      url = build_url(purchase_invoice_id, purchase_invoice_line_id)
+
+      response = @client.delete(url, etag)
+      handle_error(response)
+
+      return response.code
+    end
+  end
+end

data/lib/business_central/request_builder.rb

@@ -0,0 +1,60 @@
+##
+# An object to build the request object
+#
+
+class BusinessCentral::RequestBuilder
+  attr_accessor :request
+  attr_reader :verb, :url, :etag, :data
+
+  # @param client [BusinessCentral::Client]
+  # @param opts [Hash] Options used to build the request
+  #
+  def initialize(client, opts = {})
+    @client = client
+    @verb = opts[:verb] if opts.has_key?(:verb)
+    @url = opts[:url] if opts.has_key?(:url)
+    @etag = opts[:etag] if opts.has_key?(:etag)
+    @data = opts[:data] if opts.has_key?(:data)
+    build
+  end
+
+  # Create the appropriate request object
+  #
+  # Populates @request with the constructed object
+  def build
+    @request = request_object.new(uri)
+    @request.content_type = "application/json"
+    @request.basic_auth(@client.api_username, @client.api_password)
+    add_etag
+    add_data
+  end
+
+  # If an etag is supplied, add it to the request in an ['If-Match'] header
+  #
+  def add_etag
+    return if @etag.nil?
+    @request['If-Match'] = @etag
+  end
+
+  # If form data is supplied, add it to the request body as JSON
+  #
+  def add_data
+    return if @data.nil?
+    @request.body = JSON.generate(@data)
+  end
+
+  # @returns [Net::HTTP::Request] object, based on the verb supplied in the
+  # initialization opts Hash
+  #
+  def request_object
+    Object.const_get("Net::HTTP::#{@verb.capitalize}")
+  end
+
+  # Contstruct URI for the request
+  #
+  # @returns [URI]
+  #
+  def uri
+    URI(@client.base_url + @url)
+  end
+end

data/lib/business_central/response/response_handler.rb

@@ -0,0 +1,57 @@
+##
+# Provides the interface to convert the JSON response from the API
+# to a Ruby Object
+#
+module BusinessCentral::Response
+  class ResponseHandler
+    attr_accessor :dataset
+    attr_accessor :compiled_data
+
+    # Constructor
+    #
+    # @param dataset [Hash | Array] the result from the API operation
+    #
+    def initialize(dataset)
+      @compiled_data = []
+      @dataset = dataset
+      process
+    end
+
+    # Compiles the data in the @dataset to the supplied class
+    #
+    def process
+      @dataset.is_a?(Array) ? process_array : process_data(@dataset)
+    end
+
+    # If the supplied result from the API operation is an array, iterate over
+    # it and process each result into @compiled_data
+    #
+    def process_array
+      @dataset.each { |data| process_data(data) }
+    end
+
+    # Parse the JSON response from the API into an OpenStruct object. This will
+    # also parse any child objects, which allows the data to be accessed via
+    # regular chaining
+    #
+    # eg 
+    #   company.address.state
+    #
+    # @param data [JSON]
+    #
+    def process_data(data)
+      new_record = JSON.parse(sanitize(data), object_class: OpenStruct)
+
+      unless data["@odata.etag"].nil?
+        new_record.etag = data["@odata.etag"]
+      end
+      @compiled_data << new_record
+    end
+
+    # Ensures the data is in JSON format
+    #
+    def sanitize(data)
+      data.is_a?(Hash) ? data.to_json : data
+    end
+  end
+end

data/lib/business_central/retained_earnings_statement.rb

@@ -0,0 +1,9 @@
+##
+# Provides access to the /retainedEarningsStatement API
+#
+module BusinessCentral
+  class RetainedEarningsStatement < BusinessCentral::Base
+    API_OBJECT = "retainedEarningsStatement"
+    SUPPORTED_METHODS = [:get]
+  end
+end

data/lib/business_central/sales_credit_memo.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /salesCreditMemos API
+#
+
+module BusinessCentral
+  class SalesCreditMemo < BusinessCentral::Base
+    API_OBJECT = "salesCreditMemos"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/sales_credit_memo_line.rb

@@ -0,0 +1,14 @@
+##
+# Provides access to the /salesCreditMemos/{Id}/salesCreditMemoLines API
+#
+
+module BusinessCentral
+  class SalesCreditMemoLine < BusinessCentral::Base
+    API_OBJECT_PARENT = "salesCreditMemos"
+    API_OBJECT = "salesCreditMemoLines"
+
+    def get(sales_credit_memo_id, sales_credit_memo_line_id = nil)
+      get_child(sales_credit_memo_id, sales_credit_memo_line_id)
+    end
+  end
+end

data/lib/business_central/sales_invoice.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /salesInvoices API
+#
+
+module BusinessCentral
+  class SalesInvoice < BusinessCentral::Base
+    API_OBJECT = "salesInvoices"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/sales_invoice_line.rb

@@ -0,0 +1,25 @@
+##
+# Provides access to the /salesInvoices/{Id}/salesInvoiceLines API
+#
+
+module BusinessCentral
+  class SalesInvoiceLine < BusinessCentral::Base
+    API_OBJECT_PARENT = "salesInvoices"
+    API_OBJECT = "salesInvoiceLines"
+
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+
+    def get(sales_invoice_id, sales_invoice_line_id = nil)
+      get_child(sales_invoice_id, sales_invoice_line_id)
+    end
+
+    def create(sales_invoice_id, data)
+      url = "/#{API_OBJECT_PARENT}(#{sales_invoice_id})/#{API_OBJECT}"
+
+      response = @client.post(url, data)
+      handle_error(response)
+      result = process(response)
+      return result.first
+    end
+  end
+end

data/lib/business_central/sales_order.rb

@@ -0,0 +1,9 @@
+##
+# Access the /salesOrders API on Business Central
+#
+module BusinessCentral
+  class SalesOrder < BusinessCentral::Base
+    API_OBJECT = "salesOrders"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/sales_order_line.rb

@@ -0,0 +1,14 @@
+##
+# Provides access to the /salesOrders/{Id}/salesOrdersLines api
+#
+
+module BusinessCentral
+  class SalesOrderLine < BusinessCentral::Base
+    API_OBJECT_PARENT = "salesOrders"
+    API_OBEJCT = "salesOrderLines"
+
+    def get(sales_order_id, sales_order_line_id = nil)
+      get_child(sales_order_id, sales_order_line_id)
+    end
+  end
+end

data/lib/business_central/sales_quote.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /salesQuotes API
+#
+
+module BusinessCentral
+  class SalesQuote < BusinessCentral::Base
+    API_OBJECT = "salesQuotes"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/sales_quote_line.rb

@@ -0,0 +1,14 @@
+##
+# Provides access to the /salesQuotes/{Id}/salesQuotesLines API
+#
+
+module BusinessCentral
+  class SalesQuoteLine < BusinessCentral::Base
+    API_OBJECT_PARENT = "salesQuotes"
+    API_OBJECT = "salesQuoteLines"
+
+    def get(sales_quote_id, sales_quote_line_id = nil)
+      get_child(sales_quote_id, sales_quote_line_id)
+    end
+  end
+end

data/lib/business_central/shipment_method.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /shipmentMethods API
+#
+
+module BusinessCentral
+  class ShipmentMethod < BusinessCentral::Base
+    API_OBJECT = "shipmentMethods"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/subscription.rb

@@ -0,0 +1,63 @@
+##
+# Access the /subscriptions API on BusinessCentral
+#
+# Allows the registration of Webhooks to receive notifications of updates to
+# various resources
+#
+# The system uses a slightly different URL for the registration process. It
+# doesn't include the TenantID (eg /companies(XXXX)) in the POST url
+
+module BusinessCentral
+  class Subscription < BusinessCentral::Base
+    API_OBJECT = "subscriptions"
+    SUPPORTED_METHODS = [:post]
+
+    attr_reader :resource, :endpoint, :client
+
+    def initialize(client, resource, endpoint)
+      @client = client.nil? ? BusinessCentral::Client.new() : client
+      @resource = resource
+      @endpoint = endpoint
+    end
+
+    def get
+      request = Net::HTTP::Get.new(URI(request_url))
+      request.content_type = "application/json"
+      request.basic_auth(@client.api_username, @client.api_password)
+      response = perform_request(request)
+      JSON.parse(response.body)
+    end
+
+    def create
+      request = Net::HTTP::Post.new(URI(request_url))
+      request.content_type = "application/json"
+      request.basic_auth(@client.api_username, @client.api_password)
+      request.body = JSON.generate(post_data)
+      request
+
+      response = perform_request(request)
+
+      JSON.parse(response.body)
+    end
+
+    def perform_request(request)
+      Net::HTTP.start(request.uri.hostname, request.uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+    end
+
+    def request_url
+      "#{@client.api_host}#{@client.api_version}#{@client.api_path}/subscriptions"
+    end
+
+    def post_data
+      {
+        "notificationUrl": @endpoint,
+        "resource": @resource
+      }
+    end
+
+    def build_request_object
+    end
+  end
+end

data/lib/business_central/tax_area.rb

@@ -0,0 +1,10 @@
+##
+# PRovides access to the /taxAreas API
+#
+
+module BusinessCentral
+  class TaxArea < BusinessCentral::Base
+    API_OBJECT = "taxAreas"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/tax_group.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /taxGroups API
+#
+
+module BusinessCentral
+  class TaxGroup < BusinessCentral::Base
+    API_OBJECT = "taxGroups"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/trial_balance.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /trialBalance API
+#
+
+module BusinessCentral
+  class TrialBalance < BusinessCentral::Base
+    API_OBJECT = "trialBalance"
+    SUPPORTED_METHOD = [:get]
+  end
+end

data/lib/business_central/unit_of_measure.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /unitsOfMeasure API
+#
+
+module BusinessCentral
+  class UnitOfMeasure < BusinessCentral::Base
+    API_OBJECT = "unitsOfMeasure"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/url_builder.rb

@@ -0,0 +1,33 @@
+##
+# Builds URLs for API access
+#
+
+module BusinessCentral
+  class URLBuilder
+    attr_reader :url
+    attr_reader :parent_path, :parent_id
+    attr_reader :child_path, :child_id, :sequence
+
+    # @param parent_path [String] The path for the parent object
+    # @param parent_id [String] The object ID
+    # @param options [Hash] any associated child object
+    #
+    def initialize(parent_path, parent_id, options = {})
+      @url = ""
+      @parent_path = parent_path
+      @parent_id = parent_id
+      @child_path = options.fetch(:child_path, nil)
+      @child_id = options.fetch(:child_id, nil)
+      @sequence = options.fetch(:sequence, nil)
+      build
+    end
+
+    # Creates the URL string from the provided options
+    #
+    def build
+      @url = "/#{@parent_path}(#{@parent_id})"
+      @url += "/#{@child_path}" unless @child_path.nil?
+      @url += "(#{@child_id})" unless @child_id.nil?
+    end
+  end
+end

data/lib/business_central/vendor.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /vendors API
+#
+
+module BusinessCentral
+  class Vendor < BusinessCentral::Base
+    API_OBJECT = "vendor"
+    SUPPORTED_METHODS = [:get, :create, :update, :delete]
+  end
+end

data/lib/business_central/vendor_purchase.rb

@@ -0,0 +1,10 @@
+##
+# Provides access to the /vendorPurchases API
+#
+
+module BusinessCentral
+  class VendorPurchase < BusinessCentral::Base
+    API_OBJECT = "vendorPurchase"
+    SUPPORTED_METHODS = [:get]
+  end
+end

data/lib/business_central/version.rb

@@ -0,0 +1,3 @@
+module BusinessCentral
+  VERSION = "0.9.3"
+end

data/lib/business_central.rb

@@ -0,0 +1,67 @@
+require 'net/http'
+require 'json'
+
+require 'business_central/api_methods'
+require 'business_central/base'
+require 'business_central/request_builder'
+require 'business_central/url_builder'
+require 'business_central/client'
+require 'business_central/version'
+require 'business_central/response/response_handler'
+
+require 'business_central/account'
+require 'business_central/aged_accounts_payable'
+require 'business_central/aged_accounts_receivable'
+require 'business_central/balance_sheet'
+require 'business_central/cash_flow_statement'
+require 'business_central/company'
+require 'business_central/company_information'
+require 'business_central/countries_region'
+require 'business_central/currency'
+require 'business_central/customer'
+require 'business_central/customer_financial_details'
+require 'business_central/customer_payment'
+require 'business_central/customer_payments_journal'
+require 'business_central/customer_sales'
+require 'business_central/dimension'
+require 'business_central/dimension_line'
+require 'business_central/employee'
+require 'business_central/general_ledger_entry'
+require 'business_central/income_statement'
+require 'business_central/irs_1099_code'
+require 'business_central/item'
+require 'business_central/item_category'
+require 'business_central/journal'
+require 'business_central/journal_line'
+require 'business_central/payment_method'
+require 'business_central/payment_term'
+require 'business_central/picture'
+require 'business_central/purchase_invoice'
+require 'business_central/purchase_invoice_line'
+require 'business_central/retained_earnings_statement'
+require 'business_central/sales_credit_memo'
+require 'business_central/sales_credit_memo_line'
+require 'business_central/sales_invoice'
+require 'business_central/sales_invoice_line'
+require 'business_central/sales_order'
+require 'business_central/sales_order_line'
+require 'business_central/sales_quote'
+require 'business_central/sales_quote_line'
+require 'business_central/shipment_method'
+require 'business_central/subscription'
+require 'business_central/tax_area'
+require 'business_central/tax_group'
+require 'business_central/trial_balance'
+require 'business_central/unit_of_measure'
+require 'business_central/vendor'
+require 'business_central/vendor_purchase'
+
+
+module BusinessCentral
+  API_PATH = "/api/v1.0"
+  API_VERSION = "/v1.0"
+  ENDPOINT_TEST = "https://api.businesscentral.dynamics.com"
+  ENDPOINT_PRODUCTION = "https://api.businesscentral.dynamics.com"
+end
+
+ServiceUnavailableError = Class.new(StandardError)

data/test/business_central/account_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class BusinessCentral::AccountTest < Test::Unit::TestCase
+  def test_initialize
+    api_account = BusinessCentral::Account.new(bc_client)
+    assert_not_nil api_account
+  end
+
+  def test_get_accounts
+    stub_get("accounts").
+      with(headers: stub_headers).
+      to_return( status: 200, body: fixture("get_accounts_200.json"))
+
+    accounts = BusinessCentral::Account.new(bc_client).get
+    assert accounts.length > 0
+  end
+
+  def test_get_account
+    stub_get("accounts(1234)").
+      with(headers: stub_headers).
+      to_return(status: 200, body: fixture("get_account_200.json"))
+
+    account = BusinessCentral::Account.new(bc_client).get("1234")
+    assert_equal "Depreciation, Equipment", account.displayName
+  end
+end

data/test/business_central/aged_accounts_payable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BusinessCentral::AgedAccountsPayableTest < Test::Unit::TestCase
+  def test_initialize
+    api = BusinessCentral::AgedAccountsPayable.new(bc_client)
+    assert_not_nil api
+  end
+end

data/test/business_central/aged_accounts_receivable_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BusinessCentral::AgedAccountsReceivableTest < Test::Unit::TestCase
+  def test_initialize
+    api = BusinessCentral::AgedAccountsReceivable.new(bc_client)
+    assert_not_nil api
+  end
+end

data/test/business_central/base_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class BusinessCentral::BaseTest < Test::Unit::TestCase
+  def setup
+    BusinessCentral::Base.const_set("API_OBJECT", "bar")
+    BusinessCentral::Base.const_set("API_OBJECT_PARENT", "foo")
+    BusinessCentral::Base.const_set("SUPPORTED_METHODS", [:get])
+  end
+
+  test "should initialize with a client" do
+    base = BusinessCentral::Base.new(bc_client)
+    assert_not_nil base
+    assert_not_nil base.client
+  end
+
+  test "should build a URL with only a single parameter" do
+    base = BusinessCentral::Base.new(bc_client)
+    # base.const_set(API_OBJECT, "foo")
+    url = base.build_url("1234")
+    assert_equal '/foo(1234)/bar', url
+  end
+
+  test "should build a URL with multiple parameters" do
+    base = BusinessCentral::Base.new(bc_client)
+    url = base.build_url("1234", "4321")
+    assert_equal "/foo(1234)/bar(4321)", url
+  end
+end

data/test/business_central/company_information_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BusinessCentral::CompanyInformationTest < Test::Unit::TestCase
+  def test_initialize
+    api = BusinessCentral::CompanyInformation.new(bc_client)
+    assert_not_nil api
+  end
+end

data/test/business_central/company_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class BusinessCentral::CompanyTest < Test::Unit::TestCase
+  def test_initialize
+    api_company = BusinessCentral::Company.new(bc_client)
+    assert_not_nil api_company
+  end
+
+  def test_company_success
+    stub_get("companies(1234)").
+      with(headers: stub_headers).
+      to_return(status: 200, body: fixture("get_company_200.json"))
+
+    company = BusinessCentral::Company.new(bc_client).get("1234")
+    assert_equal "CRONUS AU", company.name
+  end
+
+  def test_companies_success
+    stub_get("companies").
+      with(headers: stub_headers).
+      to_return(status: 200, body: fixture("get_companies_200.json"))
+
+    companies = BusinessCentral::Company.new(bc_client).get
+    assert_equal 1, companies.length
+    assert_equal "CRONUS AU", companies.first.name
+  end
+end