flinks 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b388d711a383c65fff4792fc54d11024d5c55af0dc0d49bbaa5767125d5f59c
-  data.tar.gz: 7575f6d1664374bf957dbd8458d1794f9ce6531eef1430a3def130dc8ca701a9
+  metadata.gz: e828957d3fa28a60e8efaef004a27bd79adab1093434e03220a73cb489f55dc1
+  data.tar.gz: 5ecfa2c75dcd95a2800d9b753fadb742136af10ad6edb6bd785f097af0344f3c
 SHA512:
-  metadata.gz: 1c8c33bfc2a5b21a400d0294f6affa86b630cae61c6adce81bf05d4052c76bc821c4f2c9ace48ed717d973d7482a173728263aa5d9287d7cdb7e20d315fed1fa
-  data.tar.gz: a0fe976c3bfec049d736dbb4feffeee1b0767f811fa9938527bb20ca57092b0b6004d1e6910073740dc39217d720f271914875c6e9cbe4a164c516e490757622
+  metadata.gz: 11238f6378dd82d401a2ca78a6fb2d4f96eefd4da19c39ae6c2e07741dcaf1aaac8415d171e5ecad3841e2cf2daeb4c320eab3caac241c904544ed9015931e1b
+  data.tar.gz: 26538846f2e14ca59b2d7449e4da2afb147ec89129d14b6b692586713d796458fad5915fda14e2c4ba4d6046013cedf61c6808472701d3e6e7a8e71479bd6195

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/flinks.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: flinks 0.1.1 ruby lib
+# stub: flinks 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "flinks".freeze
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "flinks.gemspec",
     "lib/flinks.rb",
     "lib/flinks/api/account.rb",
+    "lib/flinks/api/authorize.rb",
     "lib/flinks/api/card.rb",
     "lib/flinks/api/refresh.rb",
     "lib/flinks/api/statement.rb",
@@ -36,10 +37,11 @@ Gem::Specification.new do |s|
     "lib/flinks/error.rb",
     "lib/flinks/request.rb",
     "lib/flinks/version.rb",
-    "spec/lib/api/account.rb",
-    "spec/lib/api/card.rb",
-    "spec/lib/api/refresh.rb",
-    "spec/lib/api/statement.rb",
+    "spec/lib/api/account_spec.rb",
+    "spec/lib/api/authorize_spec.rb",
+    "spec/lib/api/card_spec.rb",
+    "spec/lib/api/refresh_spec.rb",
+    "spec/lib/api/statement_spec.rb",
     "spec/lib/client_spec.rb",
     "spec/spec_helper.rb"
   ]

data/lib/flinks/api/account.rb

@@ -1,24 +1,26 @@
+require 'dry-validation'
+
 module Flinks
   module API
     module Account
       AccountSummaryRequestSchema = Dry::Validation.Schema do
         required(:request_id).filled(:str?)
-        optional(:direct_refresh).maybe(:bool?)
-        optional(:with_balance).maybe(:bool?)
-        optional(:with_transactions).maybe(:bool?)
-        optional(:with_account_identity).maybe(:bool?)
-        optional(:most_recent).maybe(:bool?)
-        optional(:most_recent_cached).maybe(:bool?)
+        optional(:direct_refresh).filled(:bool?)
+        optional(:with_balance).filled(:bool?)
+        optional(:with_transactions).filled(:bool?)
+        optional(:with_account_identity).filled(:bool?)
+        optional(:most_recent).filled(:bool?)
+        optional(:most_recent_cached).filled(:bool?)
       end
 
       AccountDetailRequestSchema = Dry::Validation.Schema do
         required(:request_id).filled(:str?)
-        optional(:with_account_identity).maybe(:bool?)
-        optional(:with_kyc).maybe(:bool?)
-        optional(:with_transactions).maybe(:bool?)
-        optional(:with_balance).maybe(:bool?)
-        optional(:get_mfa_questions_answers).maybe(:bool?)
-        optional(:date_from).maybe(:date?)
+        optional(:with_account_identity).filled(:bool?)
+        optional(:with_kyc).filled(:bool?)
+        optional(:with_transactions).filled(:bool?)
+        optional(:with_balance).filled(:bool?)
+        optional(:get_mfa_questions_answers).filled(:bool?)
+        optional(:date_from).filled(:date?)
         optional(:date_to) { date? | date_time? }
         optional(:accounts_filter).each(:str?)
 
@@ -30,8 +32,8 @@ module Flinks
         end
 
         optional(:days_of_transactions).included_in?(['Days90', 'Days360'])
-        optional(:most_recent).maybe(:bool?)
-        optional(:most_recent_cached).maybe(:bool?)
+        optional(:most_recent).filled(:bool?)
+        optional(:most_recent_cached).filled(:bool?)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#get-accounts-summary

data/lib/flinks/api/authorize.rb

@@ -0,0 +1,74 @@
+require 'dry-validation'
+
+module Flinks
+  module API
+    module Authorize
+      AuthorizeRequestSchema = Dry::Validation.Schema do
+        required(:login_id).filled(:str?)
+
+        optional(:language).filled(:str?)
+        optional(:save).filled(:bool?)
+        optional(:security_responses).filled(:hash?)
+        optional(:schedule_refresh).filled(:bool?)
+        optional(:direct_refresh).filled(:bool?)
+        optional(:days_of_transactions).included_in?(['Days90', 'Days360'])
+        optional(:most_recent_cached).filled(:bool?)
+        optional(:with_transactions).filled(:bool?)
+        optional(:with_balance).filled(:bool?)
+      end
+
+      AuthorizeWithCredentialsRequestSchema = Dry::Validation.Schema do
+        required(:username).filled?(:str?)
+        required(:password).filled?(:str?)
+        required(:institution).filled?(:str?)
+
+        optional(:language).filled(:str?)
+        optional(:save).filled(:bool?)
+        optional(:security_responses).filled(:hash?)
+        optional(:schedule_refresh).filled(:bool?)
+        optional(:direct_refresh).filled(:bool?)
+        optional(:days_of_transactions).included_in?(['Days90', 'Days360'])
+        optional(:most_recent_cached).filled(:bool?)
+        optional(:with_transactions).filled(:bool?)
+        optional(:with_balance).filled(:bool?)
+      end
+
+      AuthorizeMultipleRequestSchema = Dry::Validation.Schema do
+        required(:login_ids).each(:str?)
+      end
+
+      # @see https://sandbox-api.flinks.io/Readme/#authorize
+      # @param login_id [String]
+      # @param options [Hash]
+      # @return [Hash]
+      def authorize(login_id:, options: {})
+        payload = AuthorizeRequestSchema.call(options.merge(login_id: login_id))
+        raise ArgumentError, error_message(payload) unless payload.success?
+
+        post("#{customer_id}/BankingServices/Authorize", body: payload.to_hash)
+      end
+
+      # @see https://sandbox-api.flinks.io/Readme/#authorize
+      # @param username [String]
+      # @param password [String]
+      # @param institution [String]
+      # @param options [Hash]
+      def authorize_with_credentials(username:, password:, institution:, options: {})
+        payload = AuthorizeWithCredentialsRequestSchema.call(options.merge(username: username, password: password, institution: institution))
+        raise ArgumentError, error_message(payload) unless payload.success?
+
+        post("#{customer_id}/BankingServices/Authorize", body: payload.to_hash)
+      end
+
+      # @see https://sandbox-api.flinks.io/Readme/#authorize-multiple
+      # @param login_ids [Array]
+      # @return [Hash]
+      def authorize_multiple(login_ids:)
+        payload = AuthorizeMultipleRequestSchema.call(options.merge(login_ids: login_ids))
+        raise ArgumentError, error_message(payload) unless payload.success?
+
+        post("#{customer_id}/BankingServices/AuthorizeMultiple", body: payload.to_hash)
+      end
+    end
+  end
+end

data/lib/flinks/api/statement.rb

@@ -1,3 +1,5 @@
+require 'dry-validation'
+
 module Flinks
   module API
     module Statement

data/lib/flinks/client.rb

@@ -1,11 +1,11 @@
 require 'active_support'
 require 'active_support/core_ext/object'
 require 'dry-initializer'
-require 'dry-validation'
 
 require 'flinks/version'
 require 'flinks/request'
 require 'flinks/api/account'
+require 'flinks/api/authorize'
 require 'flinks/api/card'
 require 'flinks/api/refresh'
 require 'flinks/api/statement'
@@ -16,6 +16,7 @@ module Flinks
 
     include Flinks::Request
     include Flinks::API::Account
+    include Flinks::API::Authorize
     include Flinks::API::Card
     include Flinks::API::Refresh
     include Flinks::API::Statement

data/spec/lib/api/authorize_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe Flinks::API::Authorize do
+  let(:api_endpoint) { Flinks::Client.dry_initializer.definitions[:api_endpoint].default.call }
+  let(:client) { Flinks.new(customer_id: 'customer_id') }
+
+  describe '#authorize' do
+    let(:login_id) { 'login_id' }
+
+    before do
+      stub_request(:post, /#{api_endpoint}/)
+        .to_return(status: 200, body: "{}", headers: { 'Content-Type'=>'application/json' })
+    end
+
+    it "returns an object" do
+      expect(client.authorize(login_id: login_id)).to be_a(Hash)
+    end
+
+    context "with valid options" do
+      let(:options) do
+        {
+          language: 'language',
+          save: true,
+          security_responses: {
+            'Question': ['response']
+          },
+          schedule_refresh: true,
+          direct_refresh: true,
+          days_of_transactions: 'Days90',
+          most_recent_cached: true,
+          with_transactions: true,
+          with_balance: true
+        }
+      end
+
+      it "returns an object" do
+        expect(client.authorize(login_id: login_id, options: options)).to be_a(Hash)
+      end
+    end
+
+    context "with invalid options" do
+      let(:options) do
+        {
+          language: 'invalid',
+          save: 'invalid',
+          security_responses: 'invalid',
+          schedule_refresh: 'invalid',
+          direct_refresh: 'invalid',
+          days_of_transactions: 'invalid',
+          most_recent_cached: 'invalid',
+          with_transactions: 'invalid',
+          with_balance: 'invalid'
+        }
+      end
+
+      it "raises an error" do
+        expect {
+          client.accounts_summary(login_id: login_id, options: options)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#authorize_with_credentials' do
+    let(:username) { 'username' }
+    let(:password) { 'password' }
+    let(:institution) { 'institution' }
+
+    before do
+      stub_request(:post, /#{api_endpoint}/)
+        .to_return(status: 200, body: "{}", headers: { 'Content-Type'=>'application/json' })
+    end
+
+    context "with valid options" do
+      let(:options) do
+        {
+          language: 'language',
+          save: true,
+          security_responses: {
+            'Question': ['response']
+          },
+          schedule_refresh: true,
+          direct_refresh: true,
+          days_of_transactions: 'Days90',
+          most_recent_cached: true,
+          with_transactions: true,
+          with_balance: true
+        }
+      end
+
+      it "returns an object" do
+        expect(client.authorize_with_credentials(username: username, password: password, institution: institution, options: options)).to be_a(Hash)
+      end
+    end
+
+    context "with invalid options" do
+      let(:options) do
+        {
+          language: 'invalid',
+          save: 'invalid',
+          security_responses: 'invalid',
+          schedule_refresh: 'invalid',
+          direct_refresh: 'invalid',
+          days_of_transactions: 'invalid',
+          most_recent_cached: 'invalid',
+          with_transactions: 'invalid',
+          with_balance: 'invalid'
+        }
+      end
+
+      it "raises an error" do
+        expect {
+          client.authorize_with_credentials(username: username, password: password, institution: institution, options: options)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flinks
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Philippe Dionne
@@ -182,6 +182,7 @@ files:
 - flinks.gemspec
 - lib/flinks.rb
 - lib/flinks/api/account.rb
+- lib/flinks/api/authorize.rb
 - lib/flinks/api/card.rb
 - lib/flinks/api/refresh.rb
 - lib/flinks/api/statement.rb
@@ -189,10 +190,11 @@ files:
 - lib/flinks/error.rb
 - lib/flinks/request.rb
 - lib/flinks/version.rb
-- spec/lib/api/account.rb
-- spec/lib/api/card.rb
-- spec/lib/api/refresh.rb
-- spec/lib/api/statement.rb
+- spec/lib/api/account_spec.rb
+- spec/lib/api/authorize_spec.rb
+- spec/lib/api/card_spec.rb
+- spec/lib/api/refresh_spec.rb
+- spec/lib/api/statement_spec.rb
 - spec/lib/client_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/phildionne/flinks