economic-rest 0.6.3 → 0.6.4

data/lib/economic/model.rb

@@ -0,0 +1,99 @@
+module Economic
+  class Model
+    class << self
+      def field(name, as: nil)
+        (@attributes ||= []) << Attribute.new(name:, as:)
+        attr_accessor name
+      end
+
+      def relation(name, as: nil, multiple: false, klass: nil)
+        (@relations ||= []) << Relation.new(name:, as:, multiple:, klass:)
+        attr_accessor name
+      end
+
+      def from_json(json)
+        from_hash(JSON.parse(json))
+      end
+
+      def from_hash(hash)
+        translated_attributes = translate_attributes(hash)
+        translated_relations = translate_relations(hash, translated_attributes)
+        new(**translated_relations)
+      end
+
+      def translate_attributes(hash)
+        economic_attribute_names = attributes.map(&:economic_name)
+        attributes_hash = hash.slice(*economic_attribute_names)
+
+        attributes_hash.each_with_object({}) do |(key, value), result|
+          attribute = attributes.find { |attr| attr.as.to_s == key || attr.name.to_s.camelize(:lower) == key }
+          result[attribute.name] = value
+        end
+      end
+
+      def translate_relations(hash, translated_attributes)
+        return translated_attributes unless relations&.any?
+
+        economic_relation_names = relations.map(&:economic_name)
+        relations_hash = hash.slice(*economic_relation_names)
+
+        relations_hash.each_with_object(translated_attributes) do |(key, value), result|
+          relation = relations.find { |rel| rel.as.to_s == key || rel.name.to_s.camelize(:lower) == key }
+          result[relation.name] = relation.multiple? ? value.map { relation.klass.from_hash(_1) } : relation.klass.from_hash(value)
+        end
+      end
+
+      def inherited(subclass)
+        return if self == Economic::Model
+
+        attributes.each do |attribute|
+          subclass.attributes << attribute
+        end
+        relations.each do |relation|
+          subclass.relations << relation
+        end
+      end
+
+      def attributes
+        @attributes ||= []
+      end
+
+      def relations
+        @relations ||= []
+      end
+    end
+
+    def initialize(**kwargs)
+      valid_keys = self.class.attributes.map(&:name) + (self.class.relations&.map(&:name) || [])
+      invalid_keys = kwargs.keys - valid_keys
+      raise ArgumentError, "invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+
+      self.class.attributes.each { |attribute| instance_variable_set :"@#{attribute.name}", kwargs[attribute.name] }
+      self.class.relations&.each { |relation| instance_variable_set :"@#{relation.name}", relation_value(relation, kwargs) }
+    end
+
+    def to_h
+      result = {}
+      self.class.attributes.each_with_object(result) { |attribute, hash| hash[attribute.economic_name] = instance_variable_get :"@#{attribute.name}" }
+      self.class.relations&.each_with_object(result) { |relation, hash| hash[relation.economic_name] = relation_to_h(relation) }
+      result.compact
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    private
+
+    def relation_value(relation, kwargs)
+      relation.multiple? ? (kwargs[relation.name] || []) : kwargs[relation.name]
+    end
+
+    def relation_to_h(relation)
+      value = instance_variable_get(:"@#{relation.name}")
+      return if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+      relation.multiple? ? value.map(&:to_h) : value.to_h
+    end
+  end
+end

data/lib/economic/models/accounting_year.rb

@@ -0,0 +1,9 @@
+module Economic
+  module Models
+    class AccountingYear < Economic::Model
+      field :from_date
+      field :to_date
+      field :year
+    end
+  end
+end

data/lib/economic/models/attention.rb

@@ -0,0 +1,8 @@
+module Economic
+  module Models
+    class Attention < Economic::Model
+      field :customer_contact_number
+      field :supplier_contact_number
+    end
+  end
+end

data/lib/economic/models/customer.rb

@@ -0,0 +1,41 @@
+module Economic
+  module Models
+    class Customer < Economic::Model
+      field :id, as: :customerNumber
+      field :address
+      field :balance
+      field :barred
+      field :city
+      field :contacts
+      field :corporate_identification_number
+      field :country
+      field :credit_limit
+      field :currency
+      field :delivery_locations
+      field :due_amount
+      field :ean
+      field :email
+      field :last_updated
+      field :name
+      field :mobile_phone
+      field :p_number
+      field :public_entry_number
+      field :telephone_and_fax_number
+      field :vat_number
+      field :website
+      field :zip
+
+      # field :attention
+      # field :customer_contact
+      relation :customer_group
+      # field :default_delivery_location
+      # field :invoices
+      # relation :layout
+      relation :payment_terms
+      # field :sales_person
+      # field :templates
+      # field :totals
+      relation :vat_zone
+    end
+  end
+end

data/lib/economic/models/customer_group.rb

@@ -0,0 +1,11 @@
+module Economic
+  module Models
+    class CustomerGroup < Economic::Model
+      field :id, as: :customerGroupNumber
+      field :account
+      field :customers
+      field :layout
+      field :name
+    end
+  end
+end

data/lib/economic/models/customers/contact.rb

@@ -0,0 +1,19 @@
+module Economic
+  module Models
+    module Customers
+      class Contact < Economic::Model
+        field :id, as: :customerContactNumber
+        field :deleted
+        field :e_invoice_id
+        field :email
+        field :email_notifications
+        field :name
+        field :notes
+        field :phone
+        field :sort_key
+
+        relation :customer
+      end
+    end
+  end
+end

data/lib/economic/models/invoice.rb

@@ -0,0 +1,32 @@
+module Economic
+  module Models
+    class Invoice < Economic::Model
+      field :currency
+      field :date
+      field :due_date
+      field :exchange_rate
+      field :gross_amount
+      field :gross_amount_in_base_currency
+      field :margin_in_base_currency
+      field :margin_percentage
+      field :net_amount
+      field :rounding_amount
+      field :vat_amount
+      field :remainder
+      field :cost_price_in_base_currency
+      field :net_amount_in_base_currency
+
+      relation :lines, multiple: true
+      relation :customer
+      relation :payment_terms
+      relation :recipient
+      relation :notes
+      relation :references
+      relation :layout
+      # relation :delivery
+      # relation :delivery_location
+      # relation :pdf
+      # relation :project
+    end
+  end
+end

data/lib/economic/models/invoices/booked.rb

@@ -0,0 +1,11 @@
+module Economic
+  module Models
+    module Invoices
+      class Booked < Economic::Models::Invoice
+        field :id, as: :bookedInvoiceNumber
+
+        relation :draft_invoice, klass: "Economic::Models::Invoices::Draft"
+      end
+    end
+  end
+end

data/lib/economic/models/invoices/draft.rb

@@ -0,0 +1,9 @@
+module Economic
+  module Models
+    module Invoices
+      class Draft < Economic::Models::Invoice
+        field :id, as: :draftInvoiceNumber
+      end
+    end
+  end
+end

data/lib/economic/models/layout.rb

@@ -0,0 +1,9 @@
+module Economic
+  module Models
+    class Layout < Economic::Model
+      field :deleted
+      field :id, as: :layoutNumber
+      field :name
+    end
+  end
+end

data/lib/economic/models/line.rb

@@ -0,0 +1,21 @@
+module Economic
+  module Models
+    class Line < Economic::Model
+      field :id, as: :lineNumber
+      field :description
+      field :sort_key
+      field :quantity
+      field :unit_net_price
+      field :discount_percentage
+      field :unit_cost_price
+      field :margin_in_base_currency
+      field :margin_percentage
+      field :total_net_amount
+
+      relation :product
+      relation :unit
+      # relation :delivery
+      # relation :departmental_distribution
+    end
+  end
+end

data/lib/economic/models/note.rb

@@ -0,0 +1,9 @@
+module Economic
+  module Models
+    class Note < Economic::Model
+      field :heading
+      field :text_line1
+      field :text_line2
+    end
+  end
+end

data/lib/economic/models/payment_term.rb

@@ -0,0 +1,10 @@
+module Economic
+  module Models
+    class PaymentTerm < Economic::Model
+      field :days_of_credit
+      field :name
+      field :payment_terms_number
+      field :payment_terms_type
+    end
+  end
+end

data/lib/economic/models/product.rb

@@ -0,0 +1,22 @@
+module Economic
+  module Models
+    class Product < Economic::Model
+      field :id, as: :productNumber
+      field :bar_code
+      field :barred
+      field :cost_price
+      field :description
+      field :last_updated
+      field :name
+      field :recommended_price
+      field :sales_price
+
+      # field :departmental_distribution
+      # relation :inventory
+      # field :invoices
+      # field :pricing
+      # relation :product_group
+      # relation :unit
+    end
+  end
+end

data/lib/economic/models/recipient.rb

@@ -0,0 +1,17 @@
+module Economic
+  module Models
+    class Recipient < Economic::Model
+      field :address
+      field :name
+      field :city
+      field :country
+      field :ean
+      field :mobile_phone
+      field :public_entry_number
+      field :zip
+
+      relation :vat_zone
+      relation :attention
+    end
+  end
+end

data/lib/economic/models/reference.rb

@@ -0,0 +1,11 @@
+module Economic
+  module Models
+    class Reference < Economic::Model
+      field :other
+
+      relation :customer_contact, klass: "Economic::Models::Customers::Contact"
+      relation :sales_person
+      relation :vendor_reference
+    end
+  end
+end

data/lib/economic/models/sales_person.rb

@@ -0,0 +1,7 @@
+module Economic
+  module Models
+    class SalesPerson < Economic::Model
+      field :employee_number
+    end
+  end
+end

data/lib/economic/models/unit.rb

@@ -0,0 +1,8 @@
+module Economic
+  module Models
+    class Unit < Economic::Model
+      field :id, as: :unitNumber
+      field :name
+    end
+  end
+end

data/lib/economic/models/vat_zone.rb

@@ -0,0 +1,10 @@
+module Economic
+  module Models
+    class VatZone < Economic::Model
+      field :vat_zone_number
+      field :enabled_for_customer
+      field :enabled_for_supplier
+      field :name
+    end
+  end
+end

data/lib/economic/models/vendor_reference.rb

@@ -0,0 +1,7 @@
+module Economic
+  module Models
+    class VendorReference < Economic::Model
+      field :employee_number
+    end
+  end
+end

data/lib/economic/nested_base_repo.rb

@@ -17,11 +17,6 @@ module Economic
         "#{kebab(model.class.name.demodulize.pluralize)}/#{model.id_key}/#{endpoint_name}"
       end
 
-      def send(model, on:)
-        warn "use #{self}.save().  #{self}.send() is deprecated"
-        save(model, on: on)
-      end
-
       def save(model, on:)
         super(model, url: nested_endpoint_url(on))
       end

data/lib/economic/orders/repo.rb

@@ -13,7 +13,7 @@ module Economic
           orders
         end
 
-        def send(model, url: endpoint_url)
+        def save(model, url: endpoint_url)
           response = send_request(method: :post, url: url, payload: model.to_h.to_json)
 
           modelize_response(response)

data/lib/economic/relation.rb

@@ -0,0 +1,17 @@
+module Economic
+  class Relation < Data.define(:name, :as, :multiple, :klass)
+    def economic_name
+      return as.to_s unless as.to_s.blank?
+
+      name.to_s.camelize(:lower)
+    end
+
+    def klass
+      super&.constantize || "Economic::Models::#{name.to_s.classify}".constantize
+    end
+
+    def multiple?
+      multiple
+    end
+  end
+end

data/lib/economic/repo.rb

@@ -0,0 +1,127 @@
+module Economic
+  class Repo
+    ROOT = "https://restapi.e-conomic.com".freeze
+    DEFAULT_QUERY_PARAMS = {skippages: 0, pagesize: 1000}.freeze
+
+    def initialize(credentials: Economic::Credentials.fetch!)
+      @credentials = credentials
+      raise Economic::MissingCredentialsError if credentials.missing?
+    end
+
+    attr_reader :credentials
+
+    def all(filter: nil)
+      response = make_request(method: :get, query: {filter:})
+
+      entries = response.collection
+      while response.pagination.next_page?
+        uri = build_uri(response.pagination.next_page)
+        response = make_request(uri:, method: :get)
+        entries += response.collection
+      end
+
+      entries
+    end
+
+    def find(id_or_model)
+      make_request(id_or_model:, method: :get).entity
+    end
+
+    def create(model)
+      make_request(method: :post, data: model).entity
+    end
+
+    def update(model)
+      make_request(id_or_model: model, method: :put, data: model).entity
+    end
+
+    def destroy(id_or_model)
+      make_request(id_or_model:, method: :delete)
+    end
+
+    private
+
+    def make_request(method:, uri: url, id_or_model: nil, data: nil, query: nil)
+      uri = build_uri(uri, id_or_model:, query:)
+      request = build_request(uri)
+      args = [method, uri, data&.to_json, headers].compact
+      response = request.public_send(*args)
+
+      parse_response(response)
+    end
+
+    def build_request(uri)
+      http = Net::HTTP.new(uri.hostname, Net::HTTP.https_default_port)
+      http.use_ssl = true
+
+      http
+    end
+
+    def build_uri(uri, id_or_model: nil, query: nil)
+      uri = id_or_model.present? ? "#{uri}/#{id_or_model.try(:id) || id_or_model}" : uri
+      uri = URI(uri)
+      uri.query = URI.encode_www_form(query.with_defaults(DEFAULT_QUERY_PARAMS).compact) if query.present?
+
+      uri
+    end
+
+    def parse_response(response)
+      case response.code
+      when "200", "201"
+        Economic::Response.from_json(response.body)
+      when "204"
+        true
+      when "400"
+        raise BadRequestError, response.body
+      when "401"
+        raise UnauthorizedError, response.body
+      when "403"
+        raise ForbiddenError, response.body
+      when "404"
+        raise NotFoundError, response.body
+      when "500"
+        raise InternalError, response.body
+      else
+        raise Error, "#{response.code} - #{response.body}"
+      end
+    end
+
+    def url
+      "#{ROOT}/#{endpoint}"
+    end
+
+    def endpoint
+      resource_name.pluralize.underscore.dasherize
+    end
+
+    def resource_name
+      self.class.to_s[17..]
+    end
+
+    def headers
+      {
+        "X-AppSecretToken": credentials.app_secret_token,
+        "X-AgreementGrantToken": credentials.agreement_grant_token,
+        "Content-Type": "application/json"
+      }
+    end
+  end
+
+  class BadRequestError < StandardError
+  end
+
+  class UnauthorizedError < StandardError
+  end
+
+  class ForbiddenError < StandardError
+  end
+
+  class NotFoundError < StandardError
+  end
+
+  class InternalError < StandardError
+  end
+
+  class Error < StandardError
+  end
+end

data/lib/economic/repos/accounting_year.rb

@@ -0,0 +1,6 @@
+module Economic
+  module Repos
+    class AccountingYear < Economic::Repo
+    end
+  end
+end

data/lib/economic/repos/customer.rb

@@ -0,0 +1,6 @@
+module Economic
+  module Repos
+    class Customer < Economic::Repo
+    end
+  end
+end

data/lib/economic/repos/customers/contact.rb

@@ -0,0 +1,21 @@
+module Economic
+  module Repos
+    module Customers
+      class Contact < Economic::Repo
+        def initialize(parent, credentials: Economic::Credentials.fetch!)
+          @parent = parent
+          super(credentials:)
+        end
+
+        private
+
+        attr_reader :parent
+
+        def endpoint
+          fragments = resource_name.pluralize.underscore.dasherize.split("/")
+          fragments.insert(1, "/#{parent.id}/").join
+        end
+      end
+    end
+  end
+end

data/lib/economic/repos/invoices/booked.rb

@@ -0,0 +1,19 @@
+module Economic
+  module Repos
+    module Invoices
+      class Booked < Economic::Repo
+        def create(model, send_by: nil)
+          hash = model.to_h
+          hash[:sendBy] = send_by if send_by.to_s == "ean"
+          super(hash)
+        end
+
+        private
+
+        def endpoint
+          resource_name.underscore.dasherize
+        end
+      end
+    end
+  end
+end

data/lib/economic/repos/invoices/draft.rb

@@ -0,0 +1,8 @@
+module Economic
+  module Repos
+    module Invoices
+      class Draft < Economic::Repo
+      end
+    end
+  end
+end

data/lib/economic/repos/invoices/drafts/line.rb

@@ -0,0 +1,26 @@
+module Economic
+  module Repos
+    module Invoices
+      module Drafts
+        class Line < Economic::Repo
+          def create(draft_invoice_model_or_id, lines)
+            draft_invoice_id = draft_invoice_model_or_id.try(:id) || draft_invoice_model_or_id
+            draft_invoice = Economic::Models::Invoices::Draft.new(lines: lines)
+
+            uri = URI("#{Economic::Repo::ROOT}/invoices/drafts/#{draft_invoice_id}/lines")
+
+            make_request(uri: uri, method: :post, data: draft_invoice)
+          end
+
+          private
+
+          def parse_response(response)
+            JSON.parse(response.body)["lines"].map do |line_data|
+              Economic::Models::Line.from_hash(**line_data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/economic/response/pagination.rb

@@ -0,0 +1,16 @@
+module Economic
+  class Response::Pagination < Economic::Model
+    field :max_page_size_allowed
+    field :skip_pages
+    field :page_size
+    field :results
+    field :results_without_filter
+    field :first_page
+    field :next_page
+    field :last_page
+
+    def next_page?
+      next_page.present?
+    end
+  end
+end