pfs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53fb6ce5c9683637596438a427cccce4ce657c1832f5dfa39d746175a474344
-  data.tar.gz: 4afa2887ffb5663b916c9f78fb9d2b6f79336793ed8b1866f6fff98902ce8c39
+  metadata.gz: a4ffbfed283d9a1eb89089f8bd15e98ec2dc89ddcbc1f972ceed0a7dbcef5c2c
+  data.tar.gz: 65aaff12422e7369d9cd525c3976ac711d9153e93bc4f5ea829c884af17783f8
 SHA512:
-  metadata.gz: 68d23a3e05f5d0d8f921e4647765b386ac1db9114711656479e80f0d6903c4f592e77e989d0bafbc8a9a0406e6b4f1b73121a7708291f3a45158264dc1936e16
-  data.tar.gz: 1810aee630ba56917b9d399ba57e15558ef519d7b7c79efd868620fff6c39e3c04ffb4ab52728e1c7a248114b3ba0ea842173835db4b9cc1fea22f29d8134c2f
+  metadata.gz: 4849cdbab3506e2e0625eece427ea671fba0c7180987454109d5ec94a692e6e6108a54acd467f72b6b4c07bd1cd03382fefc3ff14b508686e457529d4647e54a
+  data.tar.gz: 01b6e3c69925c6b8b060225b57dec87e7b8bc3e7c52685ca18ec62fe4edaad4ddd4a4c22b64762fe1e54228e4365307a867e165b3d01fd751a845d2f0908d6c7

data/README.md

@@ -1,4 +1,4 @@
-# Pfs
+# PFS FINAC API Ruby client
 
 Ruby client for PFS (cf. <https://staging-api.prepaidfinancialservices.com/apidocumentation>)
 
@@ -28,13 +28,20 @@ gem install pfs
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then tag and push the new version:
+
+```git
+git tag vx.x.x main
+git push origin vx.x.x
+```
+
+The tagging will trigger the GitHub action defined in `release.yml`, pushing the gem to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/aitor/pfs>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aitor/pfs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/devengoapp/pfs-ruby>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/devengoapp/pfs-ruby/pfs/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -42,4 +49,4 @@ The gem is available as open-source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the PFS project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/aitor/pfs/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PFS project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/devengoapp/pfs-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/pfs/api/accounts_service.rb

@@ -5,7 +5,7 @@ module PFS
     class AccountsService < Service
       def balance(account_id)
         response = client.get("/Account/#{account_id}/Balance")
-        Resources::Accounts::Balance.new(response)
+        Resources::Accounts::Balance.new(response.body[:data])
       end
 
       def credit(account_id, currency, amount, fee_code = "**API", description = "Deposit To Card API")
@@ -16,7 +16,7 @@ module PFS
           transactionDescription: description,
         }
         response = client.post("/Account/#{account_id}/Balance/Credit", attributes)
-        Resources::Accounts::BalanceCredit.new(response)
+        Resources::Accounts::BalanceCredit.new(response.body[:data])
       end
     end
   end

data/lib/pfs/api/authentication_service.rb

@@ -9,7 +9,7 @@ module PFS
           password: password,
         }
         response = client.post("/Auth/Jwt", attributes, options)
-        Resources::Authentication::Token.new(response)
+        Resources::Authentication::Token.new(response.body[:data])
       end
     end
   end

data/lib/pfs/api/services.rb

@@ -5,6 +5,7 @@ require_relative "accounts_service"
 require_relative "authentication_service"
 require_relative "transactions_service"
 require_relative "transfers_service"
+require_relative "statements_service"
 
 module PFS
   module API
@@ -24,6 +25,10 @@ module PFS
       def transactions
         @services[:transactions] ||= API::TransactionsService.new(self)
       end
+
+      def statements
+        @services[:statements] ||= API::StatementsService.new(self)
+      end
     end
   end
 end

data/lib/pfs/api/statements_service.rb

@@ -0,0 +1,12 @@
+module PFS
+  module API
+    class StatementsService < Service
+      def by_id(account_id:, statement_id:, inward_outward:, processor:)
+        response = client.get(
+          "/BankPayment/#{account_id}/StatementById?statementitemid=#{statement_id}&InwardOutward=#{inward_outward}&Processor=#{processor}"
+        )
+        Resources::Statements::Statement.new(response.body.dig(:data, :transaction))
+      end
+    end
+  end
+end

data/lib/pfs/api/transactions_service.rb

@@ -6,7 +6,7 @@ module PFS
       def history(account_id:, start_date:, end_date:)
         response = client.get("/Account/#{account_id}/Transactions?StartDate=#{start_date}&EndDate=#{end_date}")
         transactions_raw = response.body.dig(:data, :transactions)
-        Resources::Transactions::Transactions.from_raw(transactions_raw)
+        Resources::Transactions::Transactions.new(response.body.dig(:data, :transactions))
       end
     end
   end

data/lib/pfs/api/transfers_service.rb

@@ -16,7 +16,7 @@ module PFS
         data[:isinstant] = true if options[:instant]
         data[:reference] = options[:reference] if options[:reference]
         response = client.post("/BankPayment/#{account_id}/OneOffPayment", data, options)
-        Resources::Transfers::Transfer.new(response)
+        Resources::Transfers::Transfer.new(response.body[:data])
       end
     end
   end

data/lib/pfs/client.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "securerandom"
+
 # require "faraday_middleware"
 require_relative "api/services"
 require_relative "resources/base"

data/lib/pfs/resources/accounts/balance.rb

@@ -3,7 +3,7 @@
 module PFS
   module Resources
     module Accounts
-      class Balance < Resources::Base
+      class Balance < Base
         attr_accessor :currency,
                       :availableBalance,
                       :ledgerBalance

data/lib/pfs/resources/base.rb

@@ -3,11 +3,7 @@
 module PFS
   module Resources
     class Base
-      attr_reader :response
-
-      def initialize(response, root = :data)
-        @response = response
-        attributes = response.body[root]
+      def initialize(attributes = {})
         attributes.each do |key, value|
           m = "#{key}=".to_sym
           send(m, value) if respond_to?(m)
@@ -17,11 +13,11 @@ module PFS
   end
 end
 
+require_relative "collection"
 require_relative "accounts/balance"
 require_relative "accounts/balance_credit"
-require_relative "accounts/transaction"
-require_relative "accounts/transaction"
 require_relative "authentication/token"
 require_relative "transfers/transfer"
 require_relative "transactions/transaction"
 require_relative "transactions/transactions"
+require_relative "statements/statement"

data/lib/pfs/resources/collection.rb

@@ -5,11 +5,9 @@ module PFS
     class Collection
       include Enumerable
 
-      attr_reader :response
-
-      def initialize(response, item_klass, data)
-        @response = response
-        @items = (data || []).map { |item| item_klass.new(response, item) }
+      def initialize(item_klass, attributes_collection = [])
+        @attributes_collection = attributes_collection
+        @items = attributes_collection.map { |attributes_item| item_klass.new(attributes_item) }
       end
 
       def each(&block)

data/lib/pfs/resources/statements/statement.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PFS
+  module Resources
+    module Statements
+      class Statement < Base
+        attr_accessor :id,
+                      :transactionId,
+                      :amount,
+                      :cardholderID,
+                      :debtorBankIndentifier,
+                      :debtorAccountIdentifier,
+                      :debtorFullName,
+                      :debtorFullAddress,
+                      :debtorCountryCode,
+                      :creditorBankIdentifier,
+                      :creditorAccountIdentifier,
+                      :creditorFullName,
+                      :creditorFullAddress,
+                      :creditorCountryCode,
+                      :reference,
+                      :dateTimeEntered,
+                      :inwardOutward,
+                      :processorType,
+                      :paymentStatus,
+                      :userDefinedFields
+
+        alias transaction_id transactionId
+        alias cardholder_id cardholderID
+        alias debtor_bank_identifier debtorBankIndentifier
+        alias debtor_account_identifier debtorAccountIdentifier
+        alias debtor_full_name debtorFullName
+        alias debtor_full_address debtorFullAddress
+        alias debtor_country_code debtorCountryCode
+        alias creditor_bank_identifier creditorBankIdentifier
+        alias creditor_account_identifier creditorAccountIdentifier
+        alias creditor_full_name creditorFullName
+        alias creditor_full_address creditorFullAddress
+        alias creditor_country_code creditorCountryCode
+        alias entered_at dateTimeEntered
+        alias inward_outward inwardOutward
+        alias processor_type processorType
+        alias status paymentStatus
+        alias user_defined_fields userDefinedFields
+
+      end
+    end
+  end
+end

data/lib/pfs/resources/transactions/transaction.rb

@@ -3,48 +3,85 @@
 module PFS
   module Resources
     module Transactions
-      class Transaction
-        attr_reader :amount,
-                    :currency,
-                    :transaction_description,
-                    :transaction_origin,
-                    :transaction_type,
-                    :date,
-                    :unique_reference,
-                    :transfer_response_reference
+      class Transaction < Base
+        attr_accessor :date,
+                      :amount,
+                      :currency,
+                      :availableBalance,
+                      :ledgerBalance,
+                      :transactionOrigin,
+                      :transactionType,
+                      :transactionDescription,
+                      :transactionCodeDescription,
+                      :transactionResult,
+                      :terminalID,
+                      :terminalLocation,
+                      :terminalOwner,
+                      :terminalCity,
+                      :terminalState,
+                      :terminalCountry,
+                      :terminalCurrency,
+                      :uniqueReference,
+                      :cardType,
+                      :mti,
+                      :arn,
+                      :stn,
+                      :authenticationNumber,
+                      :recordType,
+                      :fee,
+                      :atmFee,
+                      :issuerFee,
+                      :foreignExchangeFee,
+                      :clientId,
+                      :mcc,
+                      :surcharge,
+                      :responseCode,
+                      :originalTransactionAmount,
+                      :originalHoldAmount,
+                      :conversionRate,
+                      :cardAcceptorIdCode,
+                      :actionCodeDescription,
+                      :acquiringInstitution,
+                      :processor,
+                      :posEntryMode,
+                      :walletProvider,
+                      :cardId,
+                      :walletId
 
-        def self.from_raw(raw_transaction)
-          new(
-            amount: raw_transaction[:amount],
-            currency: raw_transaction[:currency],
-            transaction_description: raw_transaction[:transactionDescription],
-            transaction_origin: raw_transaction[:transactionOrigin],
-            transaction_type: raw_transaction[:transactionType],
-            date: raw_transaction[:date],
-            unique_reference: raw_transaction[:uniqueReference],
-            transfer_response_reference: raw_transaction[:terminalID]
-          )
-        end
-
-        def initialize(
-          amount:,
-          currency:,
-          transaction_description:,
-          transaction_origin:,
-          transaction_type:,
-          date:,
-          unique_reference:,
-          transfer_response_reference:
-        )
-          @amount = amount
-          @currency = currency
-          @transaction_description = transaction_description
-          @transaction_origin = transaction_origin
-          @transaction_type = transaction_type
-          @date = date
-          @unique_reference = unique_reference
-          @transfer_response_reference = transfer_response_reference
-        end
+        alias available availableBalance
+        alias ledger availableBalance
+        alias transaction_origin transactionOrigin
+        alias transaction_type transactionType
+        alias transaction_description transactionDescription
+        alias transaction_code_description transactionCodeDescription
+        alias transaction_result transactionResult
+        alias terminal_id terminalID
+        alias transfer_response_reference terminalID
+        alias terminal_location terminalLocation
+        alias terminal_owner terminalOwner
+        alias terminal_city terminalCity
+        alias terminal_state terminalState
+        alias terminal_country terminalCountry
+        alias terminal_currency terminalCurrency
+        alias unique_reference uniqueReference
+        alias card_type cardType
+        alias authentication_number authenticationNumber
+        alias record_type recordType
+        alias atm_fee atmFee
+        alias foreign_exchange_fee foreignExchangeFee
+        alias issuer_fee issuerFee
+        alias client_id clientId
+        alias response_code responseCode
+        alias original_transaction_amount originalTransactionAmount
+        alias original_hold_amount originalHoldAmount
+        alias conversion_rate conversionRate
+        alias card_acceptor_id_code cardAcceptorIdCode
+        alias action_code_description actionCodeDescription
+        alias acquiring_institution acquiringInstitution
+        alias pos_entry_mode posEntryMode
+        alias wallet_provider walletProvider
+        alias card_id cardId
+        alias wallet_id walletId
       end
     end
   end

data/lib/pfs/resources/transactions/transactions.rb

@@ -3,22 +3,9 @@
 module PFS
   module Resources
     module Transactions
-      class Transactions
-        include Enumerable
-
-        def self.from_raw(raw_transactions)
-          transactions = raw_transactions.map do |transaction|
-            Transaction.from_raw(transaction)
-          end
-          new(transactions)
-        end
-
-        def initialize(transactions)
-          @transactions = transactions
-        end
-
-        def each(&block)
-          @transactions.each(&block)
+      class Transactions < Collection
+        def initialize(attributes_collection)
+          super(Transaction, attributes_collection)
         end
       end
     end

data/lib/pfs/version.rb

@@ -1,3 +1,3 @@
 module PFS
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pfs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aitor García Rey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -51,15 +51,16 @@ files:
 - lib/pfs/api/authentication_service.rb
 - lib/pfs/api/service.rb
 - lib/pfs/api/services.rb
+- lib/pfs/api/statements_service.rb
 - lib/pfs/api/transactions_service.rb
 - lib/pfs/api/transfers_service.rb
 - lib/pfs/client.rb
 - lib/pfs/resources/accounts/balance.rb
 - lib/pfs/resources/accounts/balance_credit.rb
-- lib/pfs/resources/accounts/transaction.rb
 - lib/pfs/resources/authentication/token.rb
 - lib/pfs/resources/base.rb
 - lib/pfs/resources/collection.rb
+- lib/pfs/resources/statements/statement.rb
 - lib/pfs/resources/transactions/transaction.rb
 - lib/pfs/resources/transactions/transactions.rb
 - lib/pfs/resources/transfers/transfer.rb

data/lib/pfs/resources/accounts/transaction.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module PFS
-  module Resources
-    module Accounts
-      class Transaction < Base
-        attr_accessor :date,
-                      :transactionType,
-                      :authenticationNumber,
-                      :transactionOrigin,
-                      :transactionDescription,
-                      :amount,
-                      :fee,
-                      :availableBalance,
-                      :ledgerBalance,
-                      :terminalID,
-                      :terminalLocation,
-                      :terminalOwner,
-                      :transactionCodeDescription,
-                      :transactionResult,
-                      :authenticationNumber,
-                      :authenticationNumber
-      end
-    end
-  end
-end