bridge_bankin 0.1.0 → 0.1.1

data/lib/bridge_bankin/api/error.rb

@@ -2,7 +2,19 @@
 
 module BridgeBankin
   module API
+    #
+    # Error is the base error from which all other more specific BridgeBankin errors derive.
+    #
     class Error < StandardError
+      #
+      # Initializes Error
+      #
+      # @param [String] code the HTTP code returned by the API
+      # @param [Hash] response_body the parsed API response
+      # @option response_body [String] :type 	the machine readable error message
+      # @option response_body [String] :message the human readable error message
+      # @option response_body [String] :documentation_url the optional link to documentation
+      #
       def initialize(code, response_body = {})
         @payload = response_body
         @code = code

data/lib/bridge_bankin/api/resource.rb

@@ -2,14 +2,17 @@
 
 module BridgeBankin
   module API
+    #
+    # Extend any resource class with API specific methods
+    #
     module Resource
+      private
+
       def protected_resource(access_token)
         api_client.access_token = access_token
         yield
       end
 
-      private
-
       def api_client
         @api_client ||= API::Client.new
       end

data/lib/bridge_bankin/authorization.rb

@@ -3,9 +3,18 @@
 require "time"
 
 module BridgeBankin
+  #
+  # User authentication & authorization
+  #
   class Authorization
     attr_reader :access_token, :expires_at
 
+    #
+    # Initializes Authorization
+    #
+    # @param [String] access_token access token the access token provided by the API
+    # @param [Time] expires_at the expiration time for the provided access token
+    #
     def initialize(access_token, expires_at)
       @access_token = access_token
       @expires_at = Time.parse(expires_at)
@@ -14,6 +23,14 @@ module BridgeBankin
     class << self
       include API::Resource
 
+      #
+      # Authenticate user with the corresponding credentials
+      #
+      # @param [String] email the registered user email
+      # @param [String] password the registered user password
+      #
+      # @return [Authorization] the authorization informations provided by the API
+      #
       def generate_token(email:, password:)
         response = api_client.post("/v2/authenticate", email: email, password: password)
         new(response[:access_token], response[:expires_at])

data/lib/bridge_bankin/bank.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Bank resource
+  #
   class Bank < BridgeObject
     RESOURCE_TYPE = "bank"
 
     class << self
       include API::Resource
 
+      #
+      # List all banks supported by the Bridge API
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Bank>] the supported banks list
+      #
       def list(**params)
         data = api_client.get("/v2/banks", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Retrieve a single bank
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Bank] the requested bank
+      #
       def find(id:, **params)
         data = api_client.get("/v2/banks/#{id}", params)
         convert_to_bridge_object(data)

data/lib/bridge_bankin/bridge_object.rb

@@ -1,14 +1,29 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # BridgeObject is the base class from which all other more specific BridgeBankin resources derive.
+  #
   class BridgeObject
     HIDDEN_ATTRIBUTES = %i[resource_type resource_uri].freeze
 
+    #
+    # Initializes BridgeObject
+    #
+    # @param [Hash] attrs any informations returned by the API as a valid response
+    #
     def initialize(**attrs)
       define_instance_variables(attrs)
     end
 
     class << self
+      #
+      # Convert any API response body with its corresponding resource object if exists
+      #
+      # @param [Hash] data parsed API response body
+      #
+      # @return [Account, Bank, Category, Item, Stock, Transaction, Transfer, User, BridgeObject] a resource object
+      #
       def convert_to_bridge_object(**data)
         if data[:resources]
           data[:resources].map { |resource| convert_to_bridge_object(resource) }

data/lib/bridge_bankin/category.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Category resource
+  #
   class Category < BridgeObject
     RESOURCE_TYPE = "category"
 
     class << self
       include API::Resource
 
+      #
+      # List all categories supported by the Bridge API
+      #
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Array<Category>] the supported categories list
+      #
       def list(**params)
         data = api_client.get("/v2/categories", params)
         convert_to_bridge_object(data)
       end
 
+      #
+      # Retrieve a single category
+      #
+      # @param [Integer] id the id of the requested resource
+      # @param [Hash] params any params that might be required (or optional) to communicate with the API
+      #
+      # @return [Category] the requested category
+      #
       def find(id:, **params)
         data = api_client.get("/v2/categories/#{id}", params)
         convert_to_bridge_object(data)

data/lib/bridge_bankin/configuration.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+#
+# BridgeBankin module
+#
 module BridgeBankin
   def self.configuration
     @configuration ||= Configuration.new
@@ -13,10 +16,16 @@ module BridgeBankin
     yield configuration
   end
 
+  #
+  # Configurations setup
+  #
   class Configuration
     attr_reader :api_base_url, :api_version
     attr_accessor :api_client_id, :api_client_secret
 
+    #
+    # Initializes Configuration
+    #
     def initialize
       @api_base_url = "https://sync.bankin.com"
       @api_version = "2019-02-18"

data/lib/bridge_bankin/connect.rb

@@ -1,10 +1,21 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Connect resource
+  #
   class Connect < BridgeObject
     class << self
       include API::Resource
 
+      #
+      # Request URL to Bridge's Connect funnel for adding an item
+      #
+      # @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] URL to Bridge's Connect funnel for adding an item
+      #
       def connect_item(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/connect/items/add/url", params)
@@ -12,6 +23,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # Returns the URL to Bridge's Connect funnel for adding an item using 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] the URL to Bridge's Connect funnel for adding an item using IBAN
+      #
       def connect_item_with_iban(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.post("/v2/connect/items/add/url", params)
@@ -19,6 +38,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the URL to Bridge's Connect funnel for editing an item
+      #
+      # @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 Connect funnel for editing an item
+      #
       def edit_item(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/connect/items/edit/url", params)
@@ -26,6 +53,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the URL to Bridge's Connect funnel for managing
+      # a Strong Customer Authentication and synchronizing an item
+      #
+      # @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 Connect funnel for managing
+      #
       def item_sync(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/connect/items/sync", params)
@@ -33,6 +69,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the URL to Bridge's Connect funnel for validating a user's email
+      #
+      # @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 Connect funnel for validating a user's email
+      #
       def validate_email(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/connect/users/email/confirmation/url", params)
@@ -40,6 +84,14 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the URL to Bridge's Connect funnel for validating pro items
+      #
+      # @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 Connect funnel for validating pro items
+      #
       def validate_pro_items(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/connect/items/pro/confirmation/url", params)

data/lib/bridge_bankin/insight.rb

@@ -1,10 +1,21 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Insight resource
+  #
   class Insight < BridgeObject
     class << self
       include API::Resource
 
+      #
+      # Categories statistics provided by Bridge
+      #
+      # @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 [Insight] the statistics generated by Bridge API
+      #
       def categories_insights(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/insights/category", params)

data/lib/bridge_bankin/item.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Item resource (bank connector)
+  #
   class Item < BridgeObject
     RESOURCE_TYPE = "item"
 
@@ -9,6 +12,14 @@ module BridgeBankin
     class << self
       include API::Resource
 
+      #
+      # List all logged in user items
+      #
+      # @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<Item>] the user items
+      #
       def list(access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/items", params)
@@ -16,6 +27,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Retrieve a single item 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 [Account] the requested user item
+      #
       def find(id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/items/#{id}", params)
@@ -23,6 +43,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Trigger a refresh for a specific item
+      #
+      # @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 [BridgeObject] the item refresh status path
+      #
       def refresh(id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.post("/v2/items/#{id}/refresh", params)
@@ -30,6 +59,15 @@ module BridgeBankin
         end
       end
 
+      #
+      # Request the refresh status of a specific item
+      #
+      # @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 [BridgeObject] the user item refresh status
+      #
       def refresh_status(id:, access_token:, **params)
         protected_resource(access_token) do
           data = api_client.get("/v2/items/#{id}/refresh/status", params)
@@ -37,10 +75,19 @@ module BridgeBankin
         end
       end
 
+      #
+      # Delete a specific item
+      #
+      # @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 [Boolean] the request success status
+      #
       def delete(id:, access_token:, **params)
         protected_resource(access_token) do
-          data = api_client.delete("/v2/items/#{id}", params)
-          convert_to_bridge_object(data)
+          api_client.delete("/v2/items/#{id}", params)
+          true
         end
       end
     end

data/lib/bridge_bankin/object_types.rb

@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Supported resources types
+  #
   module ObjectTypes
+    #
+    # Matches API resources with corresponding gem classes
+    #
+    # @return [Account, Bank, Category, Item, Stock, Transaction, Transfer, User, nil] the matched resource or nil
+    #
     def self.resource_types_to_classes
       {
         Account::RESOURCE_TYPE => Account,

data/lib/bridge_bankin/stock.rb

@@ -1,25 +1,59 @@
 # frozen_string_literal: true
 
 module BridgeBankin
+  #
+  # Stock resource
+  #
   class Stock < BridgeObject
     RESOURCE_TYPE = "stock"
 
     class << self
       include API::Resource
 
-      def list(**params)
-        data = api_client.get("/v2/stocks", params)
-        convert_to_bridge_object(data)
+      #
+      # List all logged in user stocks
+      #
+      # @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<Stock>] the user accounts
+      #
+      def list(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks", params)
+          convert_to_bridge_object(data)
+        end
       end
 
-      def list_updated(**params)
-        data = api_client.get("/v2/stocks/updated", params)
-        convert_to_bridge_object(data)
+      #
+      # List all logged in user updated stocks
+      #
+      # @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<Stock>] the user accounts
+      #
+      def list_updated(access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks/updated", params)
+          convert_to_bridge_object(data)
+        end
       end
 
-      def find(id:, **params)
-        data = api_client.get("/v2/stocks/#{id}", params)
-        convert_to_bridge_object(data)
+      #
+      # Retrieve a single stock 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 [Account] the user accounts
+      #
+      def find(id:, access_token:, **params)
+        protected_resource(access_token) do
+          data = api_client.get("/v2/stocks/#{id}", params)
+          convert_to_bridge_object(data)
+        end
       end
     end
   end