bridge_bankin 0.1.0 → 0.1.1

data/lib/bridge_bankin/transaction.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Transaction resource
+  #
   class Transaction < BridgeObject
     RESOURCE_TYPE = "transaction"
 
     class << self
       include API::Resource
 
+      #
+      # List all logged in user transactions
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user transactions
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transactions", params)
@@ -14,6 +25,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all logged in user updated transactions
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_updated(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transactions/updated", params)
@@ -21,6 +40,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Retrieve a single transaction for logged in user
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Transaction] the user accounts
+      #
       def find(id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transactions/#{id}", params)
@@ -28,6 +56,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all logged in user transactions for a specific account
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_by_account(account_id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/accounts/#{account_id}/transactions", params)
@@ -35,6 +71,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all logged in user updated transactions for a specific account
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_updated_by_account(account_id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/accounts/#{account_id}/transactions/updated", params)
@@ -42,6 +86,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all logged in user transactions with a specific IBAN
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transaction>] the user accounts
+      #
       def list_by_iban(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.post("/v2/transactions/search", params)

data/lib/bridge_bankin/transfer.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Transfer resource
+  #
   class Transfer < BridgeObject
     RESOURCE_TYPE = "transfert"
 
     class << self
       include API::Resource
 
+      #
+      # Request the URL to Bridge's Pay funnel to make a transfer
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the URL to Bridge's Pay funnel
+      #
       def send(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.post("/v2/pay/transfer/url", params)
@@ -14,6 +25,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all logged in user transfers
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Transfer>] the user's transfers
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transfers", params)
@@ -21,6 +40,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Retrieve a single transfer for the logged in user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Transfer] the requested transfer
+      #
       def find(uuid:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transfers/#{uuid}", params)
@@ -28,6 +56,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all sender transfer accounts
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_all_sender_accounts(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transfers/accounts/senders", params)
@@ -35,6 +71,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all receiver transfer accounts
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_all_receiver_accounts(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transfers/accounts/receivers", params)
@@ -42,6 +86,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # List all receiver transfer accounts for a specific sender account
+      #
+      # @param [Integer] sender_account_id the sender_account_id of the requested resource
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<BridgeObject>] the user accounts
+      #
       def list_receiver_accounts_for_sender(sender_account_id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/transfers/accounts/#{sender_account_id}/receivers", params)

data/lib/bridge_bankin/user.rb

@@ -1,47 +1,111 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # User resource
+  #
   class User < BridgeObject
     RESOURCE_TYPE = "user"
 
     class << self
       include API::Resource
 
+      #
+      # List all registered users
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<User>] the registered users list
+      #
       def list(**params)
         data = api_client.get("/v2/users", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Retrieve a specific user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the requested user
+      #
       def find(uuid:, **params)
         data = api_client.get("/v2/users/#{uuid}", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Create a new user
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the newly created user
+      #
       def create(**params)
         data = api_client.post("/v2/users", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Update user email
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the updated user
+      #
       def update_email(uuid:, **params)
         data = api_client.put("/v2/users/#{uuid}/email", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Update user password
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [User] the updated user
+      #
       def update_password(uuid:, **params)
         data = api_client.put("/v2/users/#{uuid}/password", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Delete a specific user
+      #
+      # @param [UUID] uuid the uuid of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Boolean] the request success status
+      #
       def delete_user(uuid:, **params)
-        data = api_client.delete("/v2/users/#{uuid}", params)
-        convert_to_bridge_object(data)
+        api_client.delete("/v2/users/#{uuid}", params)
+        true
       end
 
+      #
+      # Delete all registered users
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Boolean] the request success status
+      #
       def delete_all_users(**params)
-        data = api_client.delete("/v2/users", params)
-        convert_to_bridge_object(data)
+        api_client.delete("/v2/users", params)
+        true
       end
 
+      #
+      # Check the logged in user email confirmation status
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] the user email confirmation status
+      #
       def check_email_confirmation(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/users/me/email/confirmation", params)
@@ -49,6 +113,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the URL to access to an interface to manage the logged in user accounts' IBAN
+      #
+      # @param [String] access_token the access token provided during the user authentication
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [BridgeObject] an URL to access to the interface to manage accounts' IBAN
+      #
       def manage_accounts(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/users/manage/accounts/iban", params)

data/lib/bridge_bankin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgeBankin
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridge_bankin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Olivier Buffon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -159,7 +159,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/ci-analysis.yml"
+- ".github/workflows/rubocop-analysis.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -216,5 +217,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Unofficial client to consume Bridge by Bankin’ API
+summary: Unofficial Ruby client to consume Bridge by Bankin’ API
 test_files: []