economic-rest 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7161dbc46a416bb2149a88b25429c65eae35099faf62169b2b118e8ef8f9fed1
-  data.tar.gz: 5e9bfcd9ed82bc4fda82a28bd2dc6a9417520a9dbe0373d8039328f2692bbc36
+  metadata.gz: ecb77f38beb7fd8228abe2b64c507b3ae13da887b8222d7b03c66e336293fca5
+  data.tar.gz: 71e58f5128017ecaeb766b866240095f886b4476a240ebc4663c0c38fca649cc
 SHA512:
-  metadata.gz: 5f1cb5a27774f787e1f397847b46811ede46bdaca93ea85b578762988754e4956c2c1fcd683826302e503a063acb349b1f712d35c98fadb2fc88519ede78a29f
-  data.tar.gz: fbee922209d5f9f01affa38aee587dc40f877619dbabce222ec487d2c620bf2c3e5e68fef01f792802ed79a43e809cf1720effba9c4bd564d1500ecf23dd232a
+  metadata.gz: bf006f406ff0bc9b4bc500d01b0bd0c0092f00fe725a2dca65d64739ccb23e4ceaed0dd2fd5f06454873a29b2aa6a9d67cad4ea86cc22371f9aea907fe7e37ad
+  data.tar.gz: 3a9c2e2acbde4319d255bb00038e1b2beb27c637f0e4d9e46d7e5ac61d139c1c1288ebea4ef3d693d951ef1a66edb70a988f8ad5822e87a5f9fa0b74569dc9fb

data/Gemfile.lock

@@ -39,19 +39,22 @@ GEM
     httpi (2.4.4)
       rack
       socksify
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
     json (2.1.0)
     m (1.5.1)
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
+    metaclass (0.0.4)
     method_source (0.9.2)
     mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0904)
+    mime-types-data (3.2019.1009)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
+    mocha (1.9.0)
+      metaclass (~> 0.0.1)
     netrc (0.11.0)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
@@ -110,7 +113,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    zeitwerk (2.1.10)
+    zeitwerk (2.2.0)
 
 PLATFORMS
   ruby
@@ -122,6 +125,7 @@ DEPENDENCIES
   economic-rest!
   m
   minitest (~> 5.0)
+  mocha
   rake (~> 10.0)
   simplecov
   standard

data/economic-rest.gemspec

@@ -32,6 +32,7 @@ The documentation can be found at https://restdocs.e-conomic.com'
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "standard"
   spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "mocha"
 
   spec.add_dependency "savon"
   spec.add_dependency "rest-client"

data/lib/economic/base.rb

@@ -48,7 +48,7 @@ module Economic
         if relation_hash[:multiple]
           relation_name = relation_hash[:name]
           model_name = relation_hash[:name].singularize
-          related_model_array = @internal_hash[relation_name]&.map { |data|
+          related_model_array = Array(@internal_hash[relation_name])&.map { |data|
             model_class(model_name).new(data)
           }
           instance_variable_set("@#{relation_name}", related_model_array)

data/lib/economic/base_repo.rb

@@ -7,24 +7,32 @@ module Economic
     URL = "https://restapi.e-conomic.com/".freeze
 
     class << self
-      def save(model)
+      attr_accessor :endpoint
+
+      def save(model, url: endpoint_url)
         post_or_put = model.id_key.nil? ? :post : :put
+        url += "/" + model.id_key.to_s
+
+        response = send_request(method: post_or_put, url: url, payload: model.to_h.to_json)
 
-        send_request(method: post_or_put, url: URI.escape(endpoint_url + "/" + model.id_key.to_s), payload: model.to_h.to_json)
+        modelize_response(response)
       end
 
-      def send(model)
-        send_request(method: :post, url: URI.escape(endpoint_url), payload: model.to_h.to_json)
+      # TODO: This method does not seem to do anything that the save method cannot do - is there any reason to keep it? Posting to a not-existing id is apparenly fine
+      def send(model, url: endpoint_url)
+        response = send_request(method: :post, url: url, payload: model.to_h.to_json)
+
+        modelize_response(response)
       end
 
-      def all(filter_text: "")
+      def all(filter_text: "", url: endpoint_url)
         pagination = {}
         pageindex = 0
         entries = []
 
         # Loop until last page, last page does not have a 'nextPage'
         while pagination["nextPage"] || pageindex.zero?
-          response = fetch(pageindex: pageindex, filter_text: filter_text)
+          response = fetch(url: url, pageindex: pageindex, filter_text: filter_text)
 
           hash = JSON.parse(response.body)
           hash["collection"].each do |entry_hash|
@@ -37,16 +45,18 @@ module Economic
         entries
       end
 
-      def filter(filter_text)
-        all(filter_text: filter_text)
+      def filter(filter_text, url: endpoint_url)
+        all(filter_text: filter_text, url: url)
       end
 
       def updated_after(date)
         filter("lastUpdated$gt:#{to_iso8601z(date)}")
       end
 
-      def find(id)
-        response = send_request(method: :get, url: endpoint_url + "/" + id.to_s)
+      def find(id, url: endpoint_url)
+        url += "/" + id.to_s
+        response = send_request(method: :get, url: url)
+
         entry_hash = JSON.parse(response.body)
         model.new(entry_hash)
       end
@@ -55,14 +65,16 @@ module Economic
         URL + endpoint_name
       end
 
-      private
-
-      def destroy(id)
-        response = send_request(method: :delete, url: endpoint_url + "/" + id.to_s)
+      def destroy(id, url: endpoint_url)
+        url += "/" + id.to_s
+        response = send_request(method: :delete, url: url)
 
-        JSON.parse(response.body)["message"] == "Deleted #{model.to_s.split("::").last.downcase}."
+        success_codes = [200, 204]
+        return true if success_codes.include?(response.code)
       end
 
+      private
+
       def model
         scopes = name.split("::")
         scopes[1] = scopes[1][0...-1] if scopes.count == 3
@@ -70,6 +82,8 @@ module Economic
       end
 
       def endpoint_name
+        return endpoint unless endpoint.nil?
+
         end_p = name.sub("Economic::", "")
         if end_p.include?("::")
           end_p = end_p.gsub("Repo", "")
@@ -77,11 +91,6 @@ module Economic
         else
           end_p = end_p.gsub("Repo", "s")
         end
-        end_p = end_p.gsub("Journals", "Journals-Experimental")
-        end_p = end_p.gsub("Selfs", "Self")
-        # PaymentTerms is named with a plural s for a single record, but the end point is still just paymentterms.
-        # Therefore the endpoint gets substituted
-        end_p = end_p.gsub("PaymentTermss", "PaymentTerms")
         kebab(end_p)
       end
 
@@ -92,6 +101,7 @@ module Economic
       end
 
       def send_request(method:, url:, payload: "", &block)
+        url = URI.escape(url)
         if payload.strip.empty?
           RestClient::Request.execute(method: method, url: url, headers: headers, &block)
         else
@@ -105,12 +115,12 @@ module Economic
         {'X-AppSecretToken': Session.app_secret_token, 'X-AgreementGrantToken': Session.agreement_grant_token, 'Content-Type': "application/json"}
       end
 
-      def fetch(pageindex: 0, filter_text: "")
-        url = endpoint_url
+      def fetch(url: endpoint_url, pageindex: 0, filter_text: "")
+        url = url.dup
         url << "?skippages=#{pageindex}&pagesize=1000"
         url << "&filter=#{filter_text}" unless filter_text == ""
 
-        send_request(method: :get, url: URI.escape(url))
+        send_request(method: :get, url: url)
       end
 
       def kebab(string)
@@ -120,6 +130,12 @@ module Economic
           .tr("_", "-")
           .downcase
       end
+
+      def modelize_response(response)
+        entry_hash = response.body.blank? ? {} : JSON.parse(response.body)
+
+        model.new(entry_hash)
+      end
     end
   end
 end

data/lib/economic/concerns/soap_methods.rb

@@ -34,8 +34,38 @@ module Economic
 
         result = Economic::SoapAPI.call(
           soap_method_names[:send][:method], message: {
-            soap_method_names[:send][:handle] => {
-              Number: model.customer.customerNumber,
+            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,
             },
           }
         )
@@ -178,6 +208,10 @@ module Economic
 
         arr
       end
+
+      def is_vat_included?(model)
+        model.vat_amount != 0
+      end
     end
   end
 end

data/lib/economic/customer_contact.rb

@@ -0,0 +1,15 @@
+module Economic
+  class CustomerContact < Base
+    field :customerContactNumber, id: true
+    field :deleted
+    field :eInvoiceId
+    field :email
+    # field :emailNotifications - is an array
+    field :name
+    field :notes
+    field :phone
+    field :sortKey
+
+    relation :customer, fields: [:customerNumber]
+  end
+end

data/lib/economic/customer_contact_repo.rb

@@ -0,0 +1,5 @@
+module Economic
+  class CustomerContactRepo < Economic::NestedBaseRepo
+    self.endpoint = "contacts"
+  end
+end

data/lib/economic/invoice.rb

@@ -13,20 +13,23 @@ module Economic
     field :roundingAmount
     field :vatAmount
     field :draftInvoiceNumber, id: true # This changes name depending on its type (draft, unpaid etc)
+    field :bookedInvoiceNumber
+    field :remainder
 
     relation :customer, fields: [:customerNumber]
-    # relation :delivery, fields: []
+    relation :delivery, fields: []
     # relation :deliveryLocation, fields: []
     relation :layout, fields: [:layoutNumber]
-    # relation :notes, fields: []
+    relation :notes, fields: []
     relation :paymentTerms, fields: [:paymentTermsNumber]
     # relation :pdf, fields: []
     # relation :project, fields: []
-    relation :recipient, fields: [:name]
+    relation :recipient, fields: [:name, :ean]
     relation :references, fields: [:other]
-    relation :lines, fields: [:lineNumber], multiple: true
+    relation :lines, fields: [:lineNumber, :description, :sortKey, :quantity, :unitNetPrice, :discountPercentage, :unitCostPrice, :marginInBaseCurrency, :marginPercentage, :totalNetAmount], multiple: true
 
     def self.build_from_soap_api(data)
+      # TODO: Add all the options
       hash = {
         "currency" => data[:currency_handle][:code],
         "date" => data[:date].to_date,
@@ -44,6 +47,7 @@ module Economic
         "customer" => {"customerNumber" => data[:debtor_handle][:id].to_i},
         "layout" => {"layoutNumber" => data[:layout_handle][:id].to_i},
         "paymentTerms" => {"paymentTermsNumber" => data[:term_of_payment_handle][:id].to_i},
+        "references" => {"other" => data[:other_reference]},
       }
 
       new(hash)

data/lib/economic/invoices/booked_repo.rb

@@ -1,6 +1,23 @@
 module Economic
   module Invoices
     class BookedRepo < Economic::Invoices::Repo
+      class << self
+        def send(invoice)
+          response = send_request(method: :post, url: URI.escape(endpoint_url), payload: payload(invoice))
+
+          entry_hash = JSON.parse(response.body)
+
+          invoice.class.new(entry_hash)
+        end
+
+        private
+
+        def payload(invoice)
+          {
+            draftInvoice: invoice.to_h,
+          }.to_json
+        end
+      end
     end
   end
 end

data/lib/economic/invoices/drafts_repo.rb

@@ -1,42 +1,42 @@
 module Economic
   module Invoices
     class DraftsRepo < Economic::Invoices::Repo
-      include Economic::SoapMethods
+      # include Economic::SoapMethods
 
-      class << self
-        def soap_method_names
-          {
-            find: {method: :current_invoice_get_data, handle: :entityHandle},
-            all: {method: :current_invoice_get_all, handle: :current_invoice_handle},
-            send: {method: :current_invoice_create, handle: :debtorHandle},
-            find_lines: {
-              method: :current_invoice_get_lines,
-              handle: :currentInvoiceHandle,
-              line_handle: :current_invoice_line_handle,
-            },
-            create_lines: {
-              method: :current_invoice_line_create_from_data_array,
-              line_data_handle: :CurrentInvoiceLineData,
-              model_handle: :InvoiceHandle,
-            },
-            find_all_lines: {
-              method: :current_invoice_line_get_data_array,
-              handle: :entityHandles,
-              data: :current_invoice_line_data,
-              line_handle: :CurrentInvoiceLineHandle,
-            },
-            find_all_records: {
-              method: :current_invoice_get_data_array,
-              handle: :CurrentInvoiceHandle,
-              data: :current_invoice_data,
-            },
-            destroy: {
-              method: :current_invoice_delete,
-              handle: :currentInvoiceHandle,
-            },
-          }
-        end
-      end
+      # class << self
+      #   def soap_method_names
+      #     {
+      #       find: {method: :current_invoice_get_data, handle: :entityHandle},
+      #       all: {method: :current_invoice_get_all, handle: :current_invoice_handle},
+      #       send: {method: :current_invoice_create_from_data},
+      #       find_lines: {
+      #         method: :current_invoice_get_lines,
+      #         handle: :currentInvoiceHandle,
+      #         line_handle: :current_invoice_line_handle,
+      #       },
+      #       create_lines: {
+      #         method: :current_invoice_line_create_from_data_array,
+      #         line_data_handle: :CurrentInvoiceLineData,
+      #         model_handle: :InvoiceHandle,
+      #       },
+      #       find_all_lines: {
+      #         method: :current_invoice_line_get_data_array,
+      #         handle: :entityHandles,
+      #         data: :current_invoice_line_data,
+      #         line_handle: :CurrentInvoiceLineHandle,
+      #       },
+      #       find_all_records: {
+      #         method: :current_invoice_get_data_array,
+      #         handle: :CurrentInvoiceHandle,
+      #         data: :current_invoice_data,
+      #       },
+      #       destroy: {
+      #         method: :current_invoice_delete,
+      #         handle: :currentInvoiceHandle,
+      #       },
+      #     }
+      #   end
+      # end
     end
   end
 end

data/lib/economic/journal_repo.rb

@@ -1,4 +1,5 @@
 module Economic
   class JournalRepo < Economic::BaseRepo
+    self.endpoint = "journals-experimental"
   end
 end

data/lib/economic/nested_base_repo.rb

@@ -0,0 +1,37 @@
+module Economic
+  class NestedBaseRepo < Economic::BaseRepo
+    class << self
+      def all(filter_text: "", on:)
+        super(filter_text: filter_text, url: nested_endpoint_url(on))
+      end
+
+      def filter(filter_text, on:)
+        all(filter_text: filter_text, on: on)
+      end
+
+      def nested_endpoint_url(model)
+        Economic::BaseRepo::URL + nested_endpoint_name(model)
+      end
+
+      def nested_endpoint_name(model)
+        "#{kebab(model.class.name.demodulize.pluralize)}/#{model.id_key}/#{endpoint_name}"
+      end
+
+      def send(model, on:)
+        super(model, url: nested_endpoint_url(on))
+      end
+
+      def save(model, on:)
+        super(model, url: nested_endpoint_url(on))
+      end
+
+      def find(id, on:)
+        super(id, url: nested_endpoint_url(on))
+      end
+
+      def destroy(id, on:)
+        super(id, url: nested_endpoint_url(on))
+      end
+    end
+  end
+end

data/lib/economic/payment_terms_repo.rb

@@ -1,4 +1,5 @@
 module Economic
   class PaymentTermsRepo < Economic::BaseRepo
+    self.endpoint = "payment-terms"
   end
 end

data/lib/economic/product.rb

@@ -15,6 +15,6 @@ module Economic
     # field :invoices
     # field :pricing
     relation :productGroup, fields: [:productGroupNumber]
-    # field :unit
+    relation :unit, fields: [:unitNumber]
   end
 end

data/lib/economic/recipient.rb

@@ -2,6 +2,7 @@ module Economic
   class Recipient < Base
     field :address
     field :name
+    field :ean
 
     relation :vatZone, fields: []
   end

data/lib/economic/references.rb

@@ -1,5 +1,7 @@
 module Economic
   class References < Base
     field :other
+
+    relation :customerContact, fields: [:customerContactNumber]
   end
 end

data/lib/economic/rest.rb

@@ -5,6 +5,7 @@ require "savon"
 require "active_support/inflector"
 
 require "economic/base_repo"
+require "economic/nested_base_repo"
 require "economic/base"
 require "economic/soap_api"
 require "economic/concerns/soap_methods"
@@ -33,6 +34,8 @@ require "economic/references"
 require "economic/customer_repo"
 require "economic/customer"
 require "economic/customer_group_repo"
+require "economic/customer_contact"
+require "economic/customer_contact_repo"
 require "economic/product_repo"
 require "economic/product"
 require "economic/pricing_repo"

data/lib/economic/rest/version.rb

@@ -1,5 +1,5 @@
 module Economic
   module Rest
-    VERSION = "0.4.3".freeze
+    VERSION = "0.4.4".freeze
   end
 end

data/lib/economic/self_repo.rb

@@ -1,9 +1,13 @@
 module Economic
   class SelfRepo < Economic::BaseRepo
-    def self.self
-      response = send_request(method: :get, url: URI.escape(Economic::SelfRepo.endpoint_url))
-      entry_hash = JSON.parse(response.body)
-      model.new(entry_hash)
+    self.endpoint = "self"
+
+    class << self
+      def self
+        response = send_request(method: :get, url: URI.escape(Economic::SelfRepo.endpoint_url))
+        entry_hash = JSON.parse(response.body)
+        model.new(entry_hash)
+      end
     end
   end
 end

data/lib/economic/session.rb

@@ -2,21 +2,24 @@ module Economic
   # The Economic::Session contains details and behaviors for a current
   # connection to the API endpoint.
   class Session
-    def self.authentication(private_app_id, access_id)
-      @private_app_id = private_app_id
-      @access_id = access_id
-    end
+    class << self
+      def authentication(private_app_id, access_id)
+        @private_app_id = private_app_id
+        @access_id = access_id
+      end
+      alias authenticate authentication
 
-    def self.app_secret_token
-      raise ArgumentError, "Authentication tokens not set, Call Session.authentication" if @private_app_id.nil?
+      def app_secret_token
+        raise ArgumentError, "Authentication tokens not set, Call Session.authentication" if @private_app_id.nil?
 
-      @private_app_id
-    end
+        @private_app_id
+      end
 
-    def self.agreement_grant_token
-      raise ArgumentError, "Authentication tokens not set, Call Session.authentication" if @access_id.nil?
+      def agreement_grant_token
+        raise ArgumentError, "Authentication tokens not set, Call Session.authentication" if @access_id.nil?
 
-      @access_id
+        @access_id
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: economic-rest
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Peter Klogborg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-30 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +218,8 @@ files:
 - lib/economic/concerns/soap_methods.rb
 - lib/economic/currency.rb
 - lib/economic/customer.rb
+- lib/economic/customer_contact.rb
+- lib/economic/customer_contact_repo.rb
 - lib/economic/customer_group.rb
 - lib/economic/customer_group_repo.rb
 - lib/economic/customer_repo.rb
@@ -224,6 +240,7 @@ files:
 - lib/economic/layout.rb
 - lib/economic/layout_repo.rb
 - lib/economic/line.rb
+- lib/economic/nested_base_repo.rb
 - lib/economic/notes.rb
 - lib/economic/order.rb
 - lib/economic/orders/archived_repo.rb
@@ -275,7 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the e-conomic REST API, that aims at making working with