economic-rest 0.6.3 → 0.6.4

data/lib/economic/response.rb

@@ -0,0 +1,51 @@
+module Economic
+  class Response
+    def initialize(self_link:, meta_data:, pagination: nil, collection: nil, entity: nil)
+      @self_link = self_link
+      @meta_data = meta_data
+      @pagination = pagination
+      @collection = collection
+      @entity = entity
+    end
+
+    attr_accessor :self_link, :meta_data, :pagination, :collection, :entity
+
+    class << self
+      def from_json(json)
+        parsed = JSON.parse(json)
+
+        if parsed.key?("collection")
+          endpoint = parsed["self"][30..].split("?").first
+          model_class = model_class_from_endpoint(endpoint)
+
+          collection = parsed["collection"].map do |hash|
+            # This method is very heavy. It takes about 2 seconds to run test/resources/customer_resource_test.rb:9, which instantiates 3684 customers
+            # Not instantiating them results in a runtime of 0.056 seconds.
+            model_class.from_hash(hash)
+          end
+
+          new(
+            collection: collection,
+            meta_data: parsed["metaData"],
+            self_link: parsed["self"],
+            pagination: Economic::Response::Pagination.from_hash(parsed["pagination"])
+          )
+        else
+          # find model class
+          endpoint = parsed["self"][30..].split("/")[0..-2].join("/")
+          model_class = model_class_from_endpoint(endpoint)
+
+          new(
+            entity: model_class.from_json(json),
+            self_link: parsed["self"],
+            meta_data: parsed["metaData"]
+          )
+        end
+      end
+
+      def model_class_from_endpoint(endpoint)
+        "Economic::Models::#{endpoint.underscore.tr("0-9", "").gsub("//", "/").classify}".constantize
+      end
+    end
+  end
+end

data/lib/economic/rest/version.rb

@@ -1,5 +1,5 @@
 module Economic
   module Rest
-    VERSION = "0.6.3".freeze
+    VERSION = "0.6.4".freeze
   end
 end

data/lib/economic/rest.rb

@@ -1,14 +1,49 @@
 require "economic/rest/version"
 
 require "rest-client"
-require "savon"
 require "active_support/inflector"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/hash/reverse_merge"
 
 require "economic/base_repo"
 require "economic/nested_base_repo"
 require "economic/base"
-require "economic/soap_api"
-require "economic/concerns/soap_methods"
+require "economic/configuration"
+require "economic/credentials"
+require "economic/model"
+require "economic/attribute"
+require "economic/relation"
+require "economic/repo"
+
+require "economic/response"
+require "economic/response/pagination"
+
+require "economic/repos/accounting_year"
+require "economic/models/accounting_year"
+require "economic/repos/customer"
+require "economic/models/customer"
+require "economic/models/customer_group"
+require "economic/models/payment_term"
+require "economic/models/vat_zone"
+require "economic/models/invoice"
+require "economic/repos/invoices/draft"
+require "economic/models/invoices/draft"
+require "economic/repos/invoices/drafts/line"
+require "economic/repos/invoices/booked"
+require "economic/models/invoices/booked"
+require "economic/models/line"
+require "economic/models/product"
+require "economic/models/unit"
+require "economic/models/recipient"
+require "economic/models/note"
+require "economic/models/reference"
+require "economic/models/customers/contact"
+require "economic/repos/customers/contact"
+require "economic/models/sales_person"
+require "economic/models/vendor_reference"
+require "economic/models/layout"
+require "economic/models/attention"
 
 require "economic/attention"
 require "economic/currency"
@@ -107,9 +142,9 @@ module Economic
   class Demo
     def self.hello
       RestClient.get("https://restapi.e-conomic.com/",
-        'X-AppSecretToken': "Demo",
-        'X-AgreementGrantToken': "Demo",
-        'Content-Type': "application/json")
+        "X-AppSecretToken": "Demo",
+        "X-AgreementGrantToken": "Demo",
+        "Content-Type": "application/json")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: economic-rest
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Peter Klogborg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: m
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.24'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -164,48 +164,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: savon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 description:
 email:
 - klogborg@traels.it
@@ -214,6 +200,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".vscode/settings.json"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -230,12 +217,14 @@ files:
 - lib/economic/accounting_year_repo.rb
 - lib/economic/accounts_summed.rb
 - lib/economic/attention.rb
+- lib/economic/attribute.rb
 - lib/economic/base.rb
 - lib/economic/base_repo.rb
 - lib/economic/company.rb
-- lib/economic/concerns/soap_methods.rb
+- lib/economic/configuration.rb
 - lib/economic/contra_account.rb
 - lib/economic/cost_account.rb
+- lib/economic/credentials.rb
 - lib/economic/currency.rb
 - lib/economic/customer.rb
 - lib/economic/customer_contact.rb
@@ -265,6 +254,26 @@ files:
 - lib/economic/layout.rb
 - lib/economic/layout_repo.rb
 - lib/economic/line.rb
+- lib/economic/model.rb
+- lib/economic/models/accounting_year.rb
+- lib/economic/models/attention.rb
+- lib/economic/models/customer.rb
+- lib/economic/models/customer_group.rb
+- lib/economic/models/customers/contact.rb
+- lib/economic/models/invoice.rb
+- lib/economic/models/invoices/booked.rb
+- lib/economic/models/invoices/draft.rb
+- lib/economic/models/layout.rb
+- lib/economic/models/line.rb
+- lib/economic/models/note.rb
+- lib/economic/models/payment_term.rb
+- lib/economic/models/product.rb
+- lib/economic/models/recipient.rb
+- lib/economic/models/reference.rb
+- lib/economic/models/sales_person.rb
+- lib/economic/models/unit.rb
+- lib/economic/models/vat_zone.rb
+- lib/economic/models/vendor_reference.rb
 - lib/economic/nested_base_repo.rb
 - lib/economic/notes.rb
 - lib/economic/order.rb
@@ -286,14 +295,23 @@ files:
 - lib/economic/project.rb
 - lib/economic/recipient.rb
 - lib/economic/references.rb
+- lib/economic/relation.rb
 - lib/economic/remittance_advice.rb
+- lib/economic/repo.rb
+- lib/economic/repos/accounting_year.rb
+- lib/economic/repos/customer.rb
+- lib/economic/repos/customers/contact.rb
+- lib/economic/repos/invoices/booked.rb
+- lib/economic/repos/invoices/draft.rb
+- lib/economic/repos/invoices/drafts/line.rb
+- lib/economic/response.rb
+- lib/economic/response/pagination.rb
 - lib/economic/rest.rb
 - lib/economic/rest/version.rb
 - lib/economic/sales_person.rb
 - lib/economic/self.rb
 - lib/economic/self_repo.rb
 - lib/economic/session.rb
-- lib/economic/soap_api.rb
 - lib/economic/supplier.rb
 - lib/economic/supplier_contact.rb
 - lib/economic/supplier_group.rb

data/lib/economic/concerns/soap_methods.rb

@@ -1,217 +0,0 @@
-require "active_support/concern"
-
-module Economic
-  module SoapMethods
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def find(id)
-        result = Economic::SoapAPI.call(
-          soap_method_names[:find][:method],
-          message: {soap_method_names[:find][:handle] => {Id: id}}
-        )
-
-        model.build_from_soap_api(result)
-      end
-
-      def all
-        result = Economic::SoapAPI.call(
-          soap_method_names[:all][:method],
-        )
-
-        ids = result_array(result[soap_method_names[:all][:handle]]).map { |record|
-          record[:id].to_i
-        }
-
-        find_all_records(ids)
-      end
-
-      def send(model)
-        # There is a current_invoice_create_from_data_array method for bulk creation of invoices as well, but bulk
-        # creation is not supported by the e-conomic REST api or any other REST api. To avoid implementing
-        # functionality that will be removed once e-conomic finish the REST api, we only use the standard create end
-        # point
-
-        result = Economic::SoapAPI.call(
-          soap_method_names[:send][:method], message: {
-            data: {
-              Handle: {
-                Id: model.id_key,
-              },
-              DebtorHandle: {
-                Number: model.customer.customer_number,
-              },
-              DebtorName: model.customer.name,
-              Date: to_iso8601z(model.date.to_datetime),
-              TermOfPaymentHandle: {
-                Id: model.payment_terms.payment_terms_number,
-              },
-              DueDate: to_iso8601z(model.due_date.to_datetime),
-              CurrencyHandle: {
-                Code: model.currency,
-              },
-              ExchangeRate: model.exchange_rate,
-              IsVatIncluded: is_vat_included?(model),
-              LayoutHandle: {
-                Id: model.layout.layout_number,
-              },
-              DeliveryAddress: model.delivery.address,
-              DeliveryPostalCode: model.delivery.zip,
-              DeliveryCity: model.delivery.city,
-              DeliveryCountry: model.delivery.country,
-              DeliveryDate: to_iso8601z(model.delivery.delivery_date.to_datetime),
-              Heading: model.notes.heading,
-              NetAmount: model.net_amount,
-              VatAmount: model.vat_amount,
-              GrossAmount: model.gross_amount,
-              Margin: model.margin_in_base_currency,
-              MarginAsPercent: model.margin_percentage,
-            },
-          }
-        )
-
-        model.id_key = result[:id]
-
-        create_lines(model) if model.lines.any?
-
-        find(result[:id].to_i)
-      end
-
-      def find_lines(invoice_id)
-        result = Economic::SoapAPI.call(
-          soap_method_names[:find_lines][:method],
-          message: {soap_method_names[:find_lines][:handle] => {Id: invoice_id}}
-        )
-
-        return if result.nil?
-
-        line_ids = result_array(result[soap_method_names[:find_lines][:line_handle]]).map { |line|
-          line[:number].to_i
-        }
-
-        find_all_lines(invoice_id, line_ids)
-      end
-
-      def destroy(id)
-        # The SoapAPI raises an exception if the record you try to delete is missing
-
-        result = Economic::SoapAPI.call(
-          soap_method_names[:destroy][:method],
-          message: {soap_method_names[:destroy][:handle] => {Id: id}}
-        )
-
-        true
-      rescue Savon::SOAPFault
-        false
-      end
-
-      private
-
-      # Since the soap api returns hashes, if there is a single record, and arrays, if there are more, this method
-      # wraps a response in an array, if it is not already.
-      def result_array(result)
-        return result if result.is_a? Array
-
-        [result]
-      end
-
-      def create_lines(model)
-        Economic::SoapAPI.call(
-          soap_method_names[:create_lines][:method], message: {
-            dataArray: build_line_data_array(model),
-          }
-        )
-      end
-
-      def find_all_lines(invoice_id, line_ids)
-        result = Economic::SoapAPI.call(
-          soap_method_names[:find_all_lines][:method],
-          message: {soap_method_names[:find_all_lines][:handle] => line_ids_array(invoice_id, line_ids, handle: soap_method_names[:find_all_lines][:line_handle])}
-        )
-
-        result_array(result[soap_method_names[:find_all_lines][:data]]).map do |data|
-          Economic::Line.build_from_soap_api(data)
-        end
-      end
-
-      def find_all_records(invoice_ids)
-        result = Economic::SoapAPI.call(
-          soap_method_names[:find_all_records][:method],
-          message: {
-            entityHandles: ids_array(invoice_ids, handle: soap_method_names[:find_all_records][:handle]),
-          }
-        )
-
-        result[soap_method_names[:find_all_records][:data]].map do |data|
-          model.build_from_soap_api(data)
-        end
-      end
-
-      def line_ids_array(order_id, line_ids, handle:)
-        arr = [handle => []]
-
-        line_ids.each do |line_id|
-          arr.first[handle].push(
-            {
-              Id: order_id,
-              Number: line_id,
-            }
-          )
-        end
-
-        arr
-      end
-
-      def ids_array(invoice_ids, handle:)
-        arr = [handle => []]
-
-        invoice_ids.each do |invoice_id|
-          arr.first[handle].push(
-            {
-              Id: invoice_id,
-            }
-          )
-        end
-
-        arr
-      end
-
-      def build_line_data_array(order)
-        arr = [soap_method_names[:create_lines][:line_data_handle] => []]
-
-        order.lines.each do |line|
-          arr.first[soap_method_names[:create_lines][:line_data_handle]].push(
-            {
-              :Handle => {
-                Id: order.id_key,
-                Number: line.line_number, # must be sent - does not have to fit with the next linenumber
-              },
-              :Id => order.id_key,
-              :Number => line.line_number, # must be sent - does not have to fit with the next linenumber
-              soap_method_names[:create_lines][:model_handle] => {
-                Id: order.id_key,
-              },
-              :Description => line.description,
-              :DeliveryDate => line.delivery.delivery_date,
-              :UnitHandle => {Number: line.unit.unit_number},
-              :ProductHandle => {Number: line.product.product_number},
-              :Quantity => line.quantity,
-              :UnitNetPrice => line.unit_net_price,
-              :DiscountAsPercent => line.discount_percentage,
-              :UnitCostPrice => line.unit_cost_price,
-              :TotalNetAmount => line.total_net_amount, # TODO: Should this not be sent?
-              :TotalMargin => line.margin_in_base_currency,
-              :MarginAsPercent => line.margin_percentage,
-            }
-          )
-        end
-
-        arr
-      end
-
-      def is_vat_included?(model)
-        model.vat_amount != 0
-      end
-    end
-  end
-end

data/lib/economic/soap_api.rb

@@ -1,24 +0,0 @@
-module Economic
-  class SoapAPI
-    URL = "https://api.e-conomic.com/secure/api1/EconomicWebService.asmx?WSDL".freeze
-
-    class << self
-      def call(method, message: {})
-        response = client.call(method, message: message, cookies: auth_cookies)
-
-        response.body["#{method}_response".to_sym]["#{method}_result".to_sym]
-      end
-
-      def auth_cookies
-        @auth_cookies ||= client.call(:connect_with_token, message: {token: Economic::Session.agreement_grant_token, appToken: Economic::Session.app_secret_token}).http.cookies
-      end
-
-      def client
-        @client ||= Savon.client {
-          wsdl(URL)
-          convert_request_keys_to :none # or one of [:lower_camelcase, :upcase, :none]
-        }
-      end
-    end
-  end
-end