starkinfra 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d456d927d988604b83c18adacb7d92fe77f299ba95e89c15ed5ae0e7a5cc4fc
-  data.tar.gz: 8ec44ecac1652b99596506d7a6234dde1ebfe94eb1299b70e27ae39809dde463
+  metadata.gz: 407cfd041d62916d22344d376a24ff392b4ef1fcf38cf3ae1c6ab38f01916e3a
+  data.tar.gz: 29d6b4e29af482ce49862a6e77eb72c570bad1844e66fcf1171f6148497179ec
 SHA512:
-  metadata.gz: 79ac2d80db5a48923b6d0c34fbecd148a9b1e9ea82f5d4d6dc46bec8011dc8959fcdffbb3a40d4661a64a6d0516a24a13b2cfa94e5d70bbe7aec38c8511f1024
-  data.tar.gz: '03180e37ba1c743016d8356a6851f7659e994b302ba55144747d9d9be216eaefad569779128f6f90f8a6ed7c5aece229d353e7ccfa683faa9c3aad8e8dd7d82c'
+  metadata.gz: d4a549b1f028df0b976c790587c5f7c3989a5290f356e93816aa6051537241f6a490617c5cd19fabf6755ec31ec9a085b1049907d2b6df35d342def6e0b065b8
+  data.tar.gz: 22556e362fb270328d57d12875797961ecb06bf87f2e19a15fa6a37b598c4d37fe76209f0a9be93289ce68c0e6c82f63fc6156745b93eb662403bb73671f618a

data/lib/brcodepreview/brcodepreview.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/parse')
+require_relative('../utils/checks')
+require_relative('../utils/resource')
+
+module StarkInfra
+  # # BrcodePreview object
+  #
+  # A BrcodePreview is used to get information from a BR Code you received to check the information before paying it.
+  #
+  # When you initialize a BrcodePreview, the entity will not be automatically
+  # created in the Stark Infra API. The 'create' function sends the objects
+  # to the Stark Infra API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - id [string]: BR Code string for the Pix payment. This is also de information directly encoded in a QR Code. ex: '00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A'
+  #
+  # Attributes (return-only):
+  # - account_number [string]: Payment receiver account number. ex: '1234567'
+  # - account_type [string]: Payment receiver account type. ex: 'checking'
+  # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+  # - amount_type [string]: amount type of the BR Code. If the amount type is 'custom' the BR Code's amount can be changed by the sender at the moment of payment. Options: 'fixed' or 'custom'
+  # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+  # - branch_code [string]: Payment receiver branch code. ex: '0001'
+  # - cash_amount [integer]: Amount to be withdrawn from the cashier in cents. ex: 1000 (= R$ 10.00)
+  # - cashier_bank_code [string]: Cashier's bank code. ex: '20018183'
+  # - cashier_type [string]: Cashier's type. Options: 'merchant', 'participant' and 'other'
+  # - discount_amount [integer]: Discount value calculated over nominal_amount. ex: 3000
+  # - fine_amount [integer]: Fine value calculated over nominal_amount. ex: 20000
+  # - key_id [string]: Receiver's PixKey id. ex: '+5511989898989'
+  # - interest_amount [integer]: Interest value calculated over nominal_amount. ex: 10000
+  # - name [string]: Payment receiver name. ex: 'Tony Stark'
+  # - nominal_amount [integer]: BR Code emission amount, without fines, fees and discounts. ex: 1234 (= R$ 12.34)
+  # - reconciliation_id [string]: Reconciliation ID linked to this payment. If the BR Code is dynamic, the reconciliation_id will have from 26 to 35 alphanumeric characters, ex: 'cd65c78aeb6543eaaa0170f68bd741ee'. If the brcode is static, the reconciliation_id will have up to 25 alphanumeric characters 'ah27s53agj6493hjds6836v49'
+  # - reduction_amount [integer]: Reduction value to discount from nominal_amount. ex: 1000
+  # - scheduled [DateTime]: date of payment execution. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0).
+  # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+  # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+  class BrcodePreview < StarkInfra::Utils::Resource
+    attr_reader :id, :account_number, :account_type, :amount, :amount_type, :bank_code, :branch_code, :cash_amount,
+                :cashier_bank_code, :cashier_type, :discount_amount, :fine_amount, :key_id, :interest_amount, :name,
+                :nominal_amount, :reconciliation_id, :reduction_amount, :scheduled, :status, :tax_id
+    def initialize(
+      id:, account_number: nil, account_type: nil, amount: nil, amount_type: nil, bank_code: nil,
+      branch_code: nil, cash_amount: nil, cashier_bank_code:nil, cashier_type:nil, discount_amount: nil,
+      fine_amount: nil, key_id: nil, interest_amount: nil, name: nil, nominal_amount: nil,
+      reconciliation_id: nil, reduction_amount: nil, scheduled: nil, status: nil, tax_id: nil
+    )
+      super(id)
+      @account_number = account_number
+      @account_type = account_type
+      @amount = amount
+      @amount_type = amount_type
+      @bank_code = bank_code
+      @branch_code = branch_code
+      @cash_amount = cash_amount
+      @cashier_bank_code = cashier_bank_code
+      @cashier_type = cashier_type
+      @discount_amount = discount_amount
+      @fine_amount = fine_amount
+      @key_id = key_id
+      @interest_amount = interest_amount
+      @name = name
+      @nominal_amount = nominal_amount
+      @reconciliation_id = reconciliation_id
+      @reduction_amount = reduction_amount
+      @scheduled = scheduled
+      @status = status
+      @tax_id = tax_id
+    end
+
+    # # Retrieve BrcodePreviews
+    #
+    # Process BR Codes before paying them.
+    #
+    # ## Parameters (required):
+    # - previews [list of BrcodePreview objects]: List of BrcodePreview objects to preview. ex: [starkinfra.BrcodePreview('00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A')]
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - list of BrcodePreview objects with updated attributes
+    def self.create(previews, user: nil)
+      StarkInfra::Utils::Rest.post(entities: previews, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'BrcodePreview',
+        resource_maker: proc { |json|
+          BrcodePreview.new(
+            id: json['id'],
+            account_number: json['account_number'],
+            account_type: json['account_type'],
+            amount: json['amount'],
+            amount_type: json['amount_type'],
+            bank_code: json['bank_code'],
+            branch_code: json['branch_code'],
+            cash_amount: json['cash_amount'],
+            cashier_bank_code: json['cashier_bank_code'],
+            cashier_type: json['cashier_type'],
+            discount_amount: json['discount_amount'],
+            fine_amount: json['fine_amount'],
+            key_id: json['key_id'],
+            interest_amount: json['interest_amount'],
+            name: json['name'],
+            nominal_amount: json['nominal_amount'],
+            reconciliation_id: json['reconciliation_id'],
+            reduction_amount: json['reduction_amount'],
+            scheduled: json['scheduled'],
+            status: json['status'],
+            tax_id: json['tax_id']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/cardmethod/cardmethod.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative('../utils/rest')
+require_relative('../utils/sub_resource')
+
+module StarkInfra
+  # # CardMethod object
+  #
+  # CardMethod's codes are used to define method filters in IssuingRules.
+  #
+  # ## Parameters (required):
+  # - code [string]: method's code. Options: 'chip', 'token', 'server', 'manual', 'magstripe', 'contactless'
+  #
+  # Attributes (return-only):
+  # - name [string]: method's name. ex: 'token'
+  # - number [string]: method's number. ex: '81'
+  class CardMethod < StarkInfra::Utils::SubResource
+    attr_reader :code, :name, :number
+    def initialize(code:, name: nil, number: nil)
+      @code = code
+      @name = name
+      @number = number
+    end
+
+    # # Retrieve CardMethods
+    #
+    # Receive a generator of CardMethod objects available in the Stark Infra API
+    #
+    # ## Parameters (optional):
+    # - search [string, default nil]: keyword to search for code, name, number or short_code. ex: 'token'
+    # - user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call
+    #
+    # ## Return:
+    # - generator of CardMethod objects with updated attributes
+    def self.query(search: nil, user: nil)
+      StarkInfra::Utils::Rest.get_stream(
+        search: search,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'CardMethod',
+        resource_maker: proc { |json|
+          CardMethod.new(
+            code: json['code'],
+            name: json['name'],
+            number: json['number']
+          )
+        }
+      }
+    end
+  end
+end