gobl 0.1.2

data/lib/gobl/org/unit.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Org
+    # Unit describes how the quantity of the product should be interpreted.
+    class Unit < GOBL::Struct
+      # The Schema ID of the GOBL Unit structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/org/unit'
+
+      # The enumeration of values of the object and their descriptions (Values different to these are also allowed)
+      ENUM = {
+        'g' => 'Metric grams',
+        'kg' => 'Metric kilograms',
+        't' => 'Metric tons',
+        'mm' => 'Milimetres',
+        'cm' => 'Centimetres',
+        'm' => 'Metres',
+        'km' => 'Kilometers',
+        'in' => 'Inches',
+        'ft' => 'Feet',
+        'm2' => 'Square metres',
+        'm3' => 'Cubic metres',
+        'cl' => 'Centilitres',
+        'l' => 'Litres',
+        'w' => 'Watts',
+        'kw' => 'Kilowatts',
+        'kwh' => 'Kilowatt Hours',
+        'day' => 'Days',
+        's' => 'Seconds',
+        'h' => 'Hours',
+        'min' => 'Minutes',
+        'piece' => 'Pieces',
+        'bag' => 'Bags',
+        'box' => 'Boxes',
+        'bin' => 'Bins',
+        'can' => 'Cans',
+        'tub' => 'Tubs',
+        'case' => 'Cases',
+        'tray' => 'Trays',
+        'portion' => 'Portions',
+        'dozen' => 'Dozens',
+        'roll' => 'Rolls',
+        'carton' => 'Cartons',
+        'cylinder' => 'Cylinders',
+        'barrel' => 'Barrels',
+        'jerrican' => 'Jerricans',
+        'carboy' => 'Carboys',
+        'demijohn' => 'Demijohn',
+        'bottle' => 'Bottles',
+        '6pack' => 'Six Packs',
+        'canister' => 'Canisters',
+        'pkg' => 'Packages',
+        'bunch' => 'Bunches',
+        'tetrabrik' => 'Tetra-Briks',
+        'pallet' => 'Pallets',
+        'reel' => 'Reels',
+        'sack' => 'Sacks',
+        'sheet' => 'Sheets',
+        'envelope' => 'Envelopes'
+      }.freeze
+
+      attribute :_value, GOBL::Types::String
+      private :_value
+
+      # Creates a new object from a GOBL value
+      #
+      # @param data [String] the GOBL value
+      #
+      # @return [Unit] the object created from the given data
+      def self.from_gobl!(data)
+        new(_value: data)
+      end
+
+      # Returns a GOBL value representing the current object
+      #
+      # @return [String] the GOBL value that represents the current object
+      def to_gobl
+        _value
+      end
+
+      # Returns a {Unit} that corresponds to a given object. The object can be a
+      # `Symbol`, a `String` or anything coercible into one (via `#to_s`).
+      #
+      # @param object [Symbol, String, #to_s] the value of the object.
+      #
+      # @return [Unit] the object corresponding to the given value.
+      #
+      # @example Instantiating from a symbol
+      #   unit = GOBL::Org::Unit.new(:g)
+      #
+      # @example Instantiating from a string
+      #   unit = GOBL::Org::Unit.new('g')
+      def self.new(object)
+        case object
+        when Hash, self # internal use, not to be used in public calls
+          super
+        when Symbol
+          new find_by_sym(object) || object.to_s
+        else
+          super _value: object.to_s
+        end
+      end
+
+      # Returns the string representation of the current object
+      #
+      # @return [String] the string representation of the current object
+      def to_s
+        _value.to_s
+      end
+
+      # Returns the symbol representation of the current object
+      #
+      # @return [Symbol] the symbol representation of the current object
+      def to_sym
+        to_s.parameterize.underscore.to_sym
+      end
+
+      # Returns whether the current object is equivalent to a given one. In addition
+      # to {Unit} objects, the current object can be compared to a `Symbol`, a
+      # `String` or anything coercible into one (via `#to_s`)
+      #
+      # @param other [Unit, Symbol, String, #to_s] the other object to compare to
+      #
+      # @return [Boolean] `true` if the objects are equivalent, `false` otherwise
+      #
+      # @example Comparing to another {Unit} object
+      #   unit = GOBL::Org::Unit.new('g')
+      #   unit == GOBL::Org::Unit.new('g') #=> true
+      #   unit == GOBL::Org::Unit.new('kg') #=> false
+      #
+      # @example Comparing to a string
+      #   unit = GOBL::Org::Unit.new('g')
+      #   unit == 'g' #=> true
+      #   unit == 'kg' #=> false
+      #
+      # @example Comparing to a symbol
+      #   unit = GOBL::Org::Unit.new('g')
+      #   unit == :g #=> true
+      #   unit == :kg #=> false
+      def ==(other)
+        case other
+        when self.class
+          super
+        when Symbol
+          to_sym == other
+        else
+          to_s == other.to_s
+        end
+      end
+
+      # Returns an array with all the enumerated objects of this type
+      #
+      # @return [Array<Unit>] the array of enumerated objects
+      def self.all
+        ENUM.keys.map { |key| new(key) }
+      end
+
+      # @api private
+      def self.find_by_sym(sym)
+        all.find { |object| object.to_sym == sym }
+      end
+
+      # @api private
+      def self.find_by_inquirer(method_name)
+        method_name =~ /(.+)\?$/ && find_by_sym(Regexp.last_match(1).to_sym)
+      end
+
+      # Returns the description of the current object
+      #
+      # @return [String] the description of the current object
+      def description
+        ENUM.fetch(_value, _value)
+      end
+
+      # @api private
+      def respond_to_missing?(method_name, include_private = false)
+        self.class.find_by_inquirer(method_name) || super
+      end
+
+      # Enables dynamic value inquirers like `Unit#g?` for
+      # each of the declared enum values (see {ENUM}). Each inquirer returns a
+      # `Boolean` denoting whether the value equals the enquired value (`true`) or
+      # not (`false`)
+      #
+      # @example
+      #   unit = GOBL::Org::Unit.new('g')
+      #   unit.g? # => true
+      #   unit.kg? # => false
+      def method_missing(method_name, *args, &block)
+        if value = self.class.find_by_inquirer(method_name)
+          self == value
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/gobl/pay/advance.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Pay
+    # Advance represents a single payment that has been made already, such as a deposit on an intent to purchase, or as credit from a previous invoice which was later corrected or cancelled.
+    class Advance < GOBL::Struct
+      # The Schema ID of the GOBL Advance structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/pay/advance'
+
+      # @!attribute [r] uuid
+      # Unique identifier for this advance.
+      # @return [GOBL::UUID::UUID]
+      attribute? :uuid, GOBL::UUID::UUID.optional
+
+      # @!attribute [r] date
+      # When the advance was made.
+      # @return [GOBL::Cal::Date]
+      attribute? :date, GOBL::Cal::Date.optional
+
+      # @!attribute [r] ref
+      # ID or reference for the advance.
+      # @return [String]
+      attribute? :ref, GOBL::Types::String.optional
+
+      # @!attribute [r] grant
+      # If this "advance" payment has come from a public grant or subsidy, set this to true.
+      # @return [Boolean]
+      attribute? :grant, GOBL::Types::Bool.optional
+
+      # @!attribute [r] desc
+      # Details about the advance.
+      # @return [String]
+      attribute :desc, GOBL::Types::String
+
+      # @!attribute [r] percent
+      # How much as a percentage of the total with tax was paid
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] amount
+      # How much was paid.
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] currency
+      # If different from the parent document's base currency.
+      # @return [GOBL::Currency::Code]
+      attribute? :currency, GOBL::Currency::Code.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Advance] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          uuid: data['uuid'] ? GOBL::UUID::UUID.from_gobl!(data['uuid']) : nil,
+          date: data['date'] ? GOBL::Cal::Date.from_gobl!(data['date']) : nil,
+          ref: data['ref'],
+          grant: data['grant'],
+          desc: data['desc'],
+          percent: data['percent'] || nil,
+          amount: data['amount'],
+          currency: data['currency'] ? GOBL::Currency::Code.from_gobl!(data['currency']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'uuid' => attributes[:uuid]&.to_gobl,
+          'date' => attributes[:date]&.to_gobl,
+          'ref' => attributes[:ref],
+          'grant' => attributes[:grant],
+          'desc' => attributes[:desc],
+          'percent' => attributes[:percent]&.to_gobl,
+          'amount' => attributes[:amount]&.to_gobl,
+          'currency' => attributes[:currency]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Advance} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Advance] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/pay/card.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Pay
+    # Card contains simplified card holder data as a reference for the customer.
+    class Card < GOBL::Struct
+      # The Schema ID of the GOBL Card structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/Card'
+
+      # @!attribute [r] last4
+      # Last 4 digits of the card's Primary Account Number (PAN).
+      # @return [String]
+      attribute :last4, GOBL::Types::String
+
+      # @!attribute [r] holder
+      # Name of the person whom the card belongs to.
+      # @return [String]
+      attribute :holder, GOBL::Types::String
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [Card] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          last4: data['last4'],
+          holder: data['holder']
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'last4' => attributes[:last4],
+          'holder' => attributes[:holder]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {Card} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [Card] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/pay/credit_transfer.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Pay
+    # CreditTransfer contains fields that can be used for making payments via a bank transfer or wire.
+    class CreditTransfer < GOBL::Struct
+      # The Schema ID of the GOBL CreditTransfer structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/CreditTransfer'
+
+      # @!attribute [r] iban
+      # International Bank Account Number
+      # @return [String]
+      attribute? :iban, GOBL::Types::String.optional
+
+      # @!attribute [r] bic
+      # Bank Identifier Code used for international transfers.
+      # @return [String]
+      attribute? :bic, GOBL::Types::String.optional
+
+      # @!attribute [r] number
+      # Account number, if IBAN not available.
+      # @return [String]
+      attribute? :number, GOBL::Types::String.optional
+
+      # @!attribute [r] name
+      # Name of the bank.
+      # @return [String]
+      attribute? :name, GOBL::Types::String.optional
+
+      # @!attribute [r] branch
+      # Bank office branch address, not normally required.
+      # @return [GOBL::Org::Address]
+      attribute? :branch, GOBL::Org::Address.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [CreditTransfer] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          iban: data['iban'],
+          bic: data['bic'],
+          number: data['number'],
+          name: data['name'],
+          branch: data['branch'] ? GOBL::Org::Address.from_gobl!(data['branch']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'iban' => attributes[:iban],
+          'bic' => attributes[:bic],
+          'number' => attributes[:number],
+          'name' => attributes[:name],
+          'branch' => attributes[:branch]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {CreditTransfer} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [CreditTransfer] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/pay/direct_debit.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Pay
+    # DirectDebit defines the data that will be used to make the direct debit.
+    class DirectDebit < GOBL::Struct
+      # The Schema ID of the GOBL DirectDebit structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/pay/instructions#/$defs/DirectDebit'
+
+      # @!attribute [r] ref
+      # Unique identifier assigned by the payee for referencing the direct debit.
+      # @return [String]
+      attribute? :ref, GOBL::Types::String.optional
+
+      # @!attribute [r] creditor
+      # Unique banking reference that identifies the payee or seller assigned by the bank.
+      # @return [String]
+      attribute? :creditor, GOBL::Types::String.optional
+
+      # @!attribute [r] account
+      # Account identifier to be debited by the direct debit.
+      # @return [String]
+      attribute? :account, GOBL::Types::String.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [DirectDebit] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          ref: data['ref'],
+          creditor: data['creditor'],
+          account: data['account']
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'ref' => attributes[:ref],
+          'creditor' => attributes[:creditor],
+          'account' => attributes[:account]
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {DirectDebit} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [DirectDebit] the object corresponding to the given input
+    end
+  end
+end

data/lib/gobl/pay/due_date.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+##
+## DO NOT EDIT - This file was generated automatically.
+##
+## Generated with GOBL v0.30.4
+##
+
+module GOBL
+  module Pay
+    # DueDate contains an amount that should be paid by the given date.
+    class DueDate < GOBL::Struct
+      # The Schema ID of the GOBL DueDate structure
+      SCHEMA_ID = 'https://gobl.org/draft-0/pay/terms#/$defs/DueDate'
+
+      # @!attribute [r] date
+      # When the payment is due.
+      # @return [GOBL::Cal::Date]
+      attribute :date, GOBL::Cal::Date
+
+      # @!attribute [r] notes
+      # Other details to take into account for the due date.
+      # @return [String]
+      attribute? :notes, GOBL::Types::String.optional
+
+      # @!attribute [r] amount
+      # How much needs to be paid by the date.
+      # @return [GOBL::Num::Amount]
+      attribute :amount, GOBL::Types.Constructor(GOBL::Num::Amount)
+
+      # @!attribute [r] percent
+      # Percentage of the total that should be paid by the date.
+      # @return [GOBL::Num::Percentage]
+      attribute? :percent, GOBL::Types.Constructor(GOBL::Num::Percentage).optional
+
+      # @!attribute [r] currency
+      # If different from the parent document's base currency.
+      # @return [GOBL::Currency::Code]
+      attribute? :currency, GOBL::Currency::Code.optional
+
+      # Creates a new object from a hash of GOBL data
+      #
+      # @param data [Hash] a hash of GOBL data
+      #
+      # @return [DueDate] the object created from the given data
+      def self.from_gobl!(data)
+        data = GOBL::Types::Hash[data]
+
+        new(
+          date: GOBL::Cal::Date.from_gobl!(data['date']),
+          notes: data['notes'],
+          amount: data['amount'],
+          percent: data['percent'] || nil,
+          currency: data['currency'] ? GOBL::Currency::Code.from_gobl!(data['currency']) : nil
+        )
+      end
+
+      # Returns a hash of GOBL data representing the current object
+      #
+      # @return [Hash] the array of GOBL data that represents the current object
+      def to_gobl
+        {
+          'date' => attributes[:date]&.to_gobl,
+          'notes' => attributes[:notes],
+          'amount' => attributes[:amount]&.to_gobl,
+          'percent' => attributes[:percent]&.to_gobl,
+          'currency' => attributes[:currency]&.to_gobl
+        }.compact
+      end
+
+      # @!method self.new(attrs)
+      #
+      #   Returns a {DueDate} object from a given hash of attributes. Nested
+      #   attributes are supported: the constructor will instantiate the proper GOBL
+      #   objects when nested hashes or arrays are given as part of the `attrs`
+      #   parameter.
+      #
+      #   The `new` method will only allow to create a new object if all attributes
+      #   marked as mandatory and not calculated in the JSON schema are provided.
+      #
+      #   @param attrs [Hash] the hash of attributes
+      #
+      #   @return [DueDate] the object corresponding to the given input
+    end
+  end
+end