flinks 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7a392806d3c94ce6e355367e627315f520970216796aa47b77f9a0208e55e1
-  data.tar.gz: f17b1804a6d60dbe6c11342b01b95a978e94cd6a15297a07b164402080c6941f
+  metadata.gz: c1f7a9b0d7dffd9587855c4180c6460f075e026aa77aad81e27a3e8a9fdff230
+  data.tar.gz: c7694a914067bad7e8c87de6c075efe68b13aafb658c6b78a535383850045871
 SHA512:
-  metadata.gz: c19e8dc8039795b03b503ebbedf33cfb5b6012cf34d78204d32a34ecd5f2b7355b45032a93d27e43ec6f3f8ffe6a7e902a40d264fe32a91a78e50ba604adccec
-  data.tar.gz: 3482beb2baf3ad3d5a2fcfd40a47e40509c7dfcf4bc2c4a498ea74b75ae81195f32abb5cb13fd1a4d882da76896dd009d387ea15a74c0bc83027ce5c2067687e
+  metadata.gz: ad693d77d924727a384e14df77e150067011fc0eebf417ebcd8436234eabd1eec2d84c7b3816c519bc036421f7401fa88041d2deec9efb095415ec5e52559dbd
+  data.tar.gz: 4ef300d40d8d154222b8a804bd18687bd8e29e515bb1fea168b85dbd6f730c16c73ecd1f83d45fa508646b98d9514cb3b985ff40d45eb4bdbf56e6a70e4d0d3c

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.5.1

data/.travis.yml

@@ -9,6 +9,9 @@ rvm:
   - 2.4
   - 2.5
 
+before_install:
+  - gem install bundler
+
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/Gemfile.lock

@@ -1,9 +1,9 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.2)
@@ -15,40 +15,40 @@ GEM
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
-    docile (1.1.5)
-    domain_name (0.5.20170404)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
     dry-container (0.6.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.2)
+    dry-core (0.4.6)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.0)
+    dry-equalizer (0.2.1)
+    dry-inflector (0.1.2)
     dry-initializer (2.4.0)
     dry-logic (0.4.2)
       dry-container (~> 0.2, >= 0.2.6)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-types (0.12.2)
+    dry-types (0.13.2)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1)
       dry-container (~> 0.3)
-      dry-core (~> 0.2, >= 0.2.1)
+      dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer (~> 0.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 0.4, >= 0.4.2)
-      inflecto (~> 0.0.0, >= 0.0.2)
-    dry-validation (0.11.1)
+    dry-validation (0.12.0)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
       dry-core (~> 0.2, >= 0.2.1)
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
-      dry-types (~> 0.12.0)
+      dry-types (~> 0.13.1)
     faraday (0.12.2)
       multipart-post (>= 1.2, < 3)
-    git (1.3.0)
+    git (1.4.0)
     github_api (0.18.2)
       addressable (~> 2.4)
       descendants_tracker (~> 0.0.4)
@@ -57,19 +57,18 @@ GEM
       oauth2 (~> 1.0)
     hashdiff (0.3.7)
     hashie (3.5.7)
-    highline (1.7.10)
-    http (3.0.0)
+    highline (2.0.0)
+    http (3.3.0)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http-form_data (~> 2.0)
       http_parser.rb (~> 0.6.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.0.0)
+    http-form_data (2.1.1)
     http_parser.rb (0.6.0)
-    i18n (0.9.3)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
-    inflecto (0.0.2)
     json (1.8.6)
     juwelier (2.1.3)
       builder
@@ -87,7 +86,7 @@ GEM
     multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.3)
       mini_portile2 (~> 2.3.0)
     oauth2 (1.4.0)
       faraday (>= 0.8, < 0.13)
@@ -95,9 +94,9 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    public_suffix (3.0.1)
-    rack (2.0.4)
-    rake (12.3.0)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rake (12.3.1)
     rdoc (3.12.2)
       json (~> 1.4)
     rspec (3.7.0)
@@ -121,18 +120,18 @@ GEM
     shoulda-context (1.2.2)
     shoulda-matchers (2.8.0)
       activesupport (>= 3.0.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.4)
-    webmock (3.3.0)
+    unf_ext (0.0.7.5)
+    webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff

data/README.md

@@ -21,10 +21,10 @@ gem 'flinks', require: 'flinks'
 
 ## Usage
 
-This library needs to be configured with your API customer ID and API endpoint.
+This library needs to be configured with your API customer ID.
 
 ```ruby
-flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'], api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/")
+flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'])
 ```
 
 Configure `on_error` to catch API requests returning a `400..599` HTTP status.
@@ -32,23 +32,38 @@ Configure `on_error` to catch API requests returning a `400..599` HTTP status.
 ```ruby
 flinks = Flinks.new({
   customer_id: ENV['FLINKS_CUSTOMER_ID'],
-  api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/",
   on_error: Proc.new do |status, message, body|
     p [status, message, body]
   end
 })
 ```
 
-Configure `debug` to print every API requests and responses.
+Configure `debug` to print every API requests and responses. Default to `false`.
 
 ```ruby
 flinks = Flinks.new({
   customer_id: ENV['FLINKS_CUSTOMER_ID'],
-  api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/",
   debug: true
 })
 ```
 
+Configure `raw` to get the raw, non-transformed API response. Default to `false`.
+
+```ruby
+flinks = Flinks.new({
+  customer_id: ENV['FLINKS_CUSTOMER_ID'],
+  raw: true
+})
+```
+
+### Sandbox and Production
+
+By default, the client uses the sandbox API endpoint: `https://sandbox.flinks.io/v3/`. In production, the API endpoint must be configured with your own:
+
+```ruby
+flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'], api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/")
+```
+
 ### Endpoints
 
 #### Authorize
@@ -70,8 +85,6 @@ flinks = Flinks.new({
 
 #### Refresh
 
-- `activate_scheduled_refresh(login_id:)`
-- `deactivate_scheduled_refresh(login_id:)`
 - `set_scheduled_refresh(activated, login_id:)`
 
 #### Statement
@@ -79,6 +92,34 @@ flinks = Flinks.new({
 - `statements(options:)`
 - `statements_async(request_id:)`
 
+## Errors
+
+### Client Errors
+
+| Error | Description |
+|-------|-------------|
+| `Flinks::ClientError` | Raised when API returns a 400..499 HTTP status code |
+| `Flinks::BadRequest` | Raised when API returns a 400 HTTP status code |
+| `Flinks::Unauthorized` | Raised when API returns a 401 HTTP status code |
+| `Flinks::Forbidden` | Raised when API returns a 403 HTTP status code |
+| `Flinks::TooManyRequests` | Raised when API returns a 403 HTTP status code for rate limit exceeded |
+| `Flinks::NotFound` | Raised when API returns a 404 HTTP status code |
+| `Flinks::MethodNotAllowed` | Raised when API returns a 405 HTTP status code |
+| `Flinks::NotAcceptable` | Raised when API returns a 406 HTTP status code |
+| `Flinks::Conflict` | Raised when API returns a 409 HTTP status code |
+| `Flinks::UnsupportedMediaType` | Raised when API returns a 415 HTTP status code |
+| `Flinks::UnprocessableEntity` | Raised when API returns a 422 HTTP status code |
+
+### Server Errors
+
+| Error | Description |
+|-------|-------------|
+| `Flinks::ServerError` | Raised when API returns a 500..599 HTTP status code |
+| `Flinks::InternalServerError` | Raised when API returns a 500 HTTP status code |
+| `Flinks::NotImplemented` | Raised when API returns a 501 HTTP status code |
+| `Flinks::BadGateway` | Raised when API returns a 502 HTTP status code |
+| `Flinks::ServiceUnavailable` | Raised when API returns a 503 HTTP status code |
+
 ## Documentation
 
 See the [API docs](https://sandbox-api.flinks.io).

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.2

data/flinks.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: flinks 0.3.1 ruby lib
+# stub: flinks 0.4.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "flinks".freeze
-  s.version = "0.3.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Philippe Dionne".freeze]
-  s.date = "2018-02-16"
+  s.date = "2018-06-18"
   s.description = "Flinks financial services API client".freeze
   s.email = "dionne.phil@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -48,7 +48,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/phildionne/flinks".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.7.3".freeze
+  s.rubygems_version = "2.7.6".freeze
   s.summary = "Flinks API client".freeze
 
   if s.respond_to? :specification_version then

data/lib/flinks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'flinks/client'
 
 module Flinks

data/lib/flinks/api/account.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-validation'
 
 module Flinks

data/lib/flinks/api/authorize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-validation'
 
 module Flinks
@@ -35,6 +37,8 @@ module Flinks
 
       AuthorizeMultipleRequestSchema = Dry::Validation.Schema do
         required(:login_ids).each(:str?)
+
+        optional(:most_recent_cached).filled(:bool?)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#authorize
@@ -62,8 +66,9 @@ module Flinks
 
       # @see https://sandbox-api.flinks.io/Readme/#authorize-multiple
       # @param login_ids [Array]
+      # @param options [Hash]
       # @return [Hash]
-      def authorize_multiple(login_ids:)
+      def authorize_multiple(login_ids:, options: {})
         payload = options.merge(login_ids: login_ids)
         validate_request!(AuthorizeMultipleRequestSchema, payload)
 

data/lib/flinks/api/card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Flinks
   module API
     module Card

data/lib/flinks/api/refresh.rb

@@ -1,20 +1,8 @@
+# frozen_string_literal: true
+
 module Flinks
   module API
     module Refresh
-      
-      # @see https://sandbox-api.flinks.io/Readme/#scheduling-background-refresh
-      # @param login_id [String]
-      # @return [Hash]
-      def activate_scheduled_refresh(login_id:)
-        patch("#{customer_id}/BankingServices/ActivateScheduledRefresh/#{login_id}")
-      end
-
-      # @see https://sandbox-api.flinks.io/Readme/#scheduling-background-refresh
-      # @param login_id [String]
-      # @return [Hash]
-      def deactivate_scheduled_refresh(login_id:)
-        patch("#{customer_id}/BankingServices/DeactivateScheduledRefresh/#{login_id}")
-      end
 
       # @see https://sandbox-api.flinks.io/Readme/#scheduling-background-refresh
       # @param activated [Boolean]

data/lib/flinks/api/statement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dry-validation'
 
 module Flinks

data/lib/flinks/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext/object'
 require 'dry-initializer'
@@ -25,6 +27,7 @@ module Flinks
     option :user_agent,   default: proc { "Flinks Ruby Gem" }
     option :on_error,     default: proc { proc {} }
     option :debug,        default: proc { false }
+    option :raw,          default: proc { false }
 
 
     private

data/lib/flinks/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Flinks
   class Error < StandardError
     attr_reader :response, :code
@@ -6,7 +8,8 @@ module Flinks
     # @return [Flinks::Error]
     def self.from_response(response)
       klass = case response.code
-              when 400      then Flinks::BadRequest
+              when 202      then error_for_202(response)
+              when 400      then error_for_400(response)
               when 401      then Flinks::Unauthorized
               when 403      then error_for_403(response)
               when 404      then Flinks::NotFound
@@ -28,6 +31,26 @@ module Flinks
       klass.new(response)
     end
 
+    # @param response [HTTP::Response]
+    # @return [Flinks::Error]
+    def self.error_for_202(response)
+      if response.parse['FlinksCode'] == 'OPERATION_PENDING'
+        Flinks::OperationPending
+      else
+        Flinks::OperationDispatched
+      end
+    end
+
+    # @param response [HTTP::Response]
+    # @return [Flinks::Error]
+    def self.error_for_400(response)
+      if response.parse['FlinksCode'] == 'SESSION_NONEXISTENT'
+        Flinks::SessionNonexistent
+      else
+        Flinks::BadRequest
+      end
+    end
+
     # @param response [HTTP::Response]
     # @return [Flinks::Error]
     def self.error_for_403(response)
@@ -56,12 +79,21 @@ module Flinks
     end
   end
 
+  # Raised when API returns a 202 HTTP status code
+  class OperationPending < Error; end
+
+  # Raised when API returns a 202 HTTP status code
+  class OperationDispatched < Error; end
+
   # Raised when API returns a 400..499 HTTP status code
   class ClientError < Error; end
 
   # Raised when API returns a 400 HTTP status code
   class BadRequest < ClientError; end
 
+  # Raised when API returns a 400 HTTP status code
+  class SessionNonexistent < ClientError; end
+
   # Raised when API returns a 401 HTTP status code
   class Unauthorized < ClientError; end
 

data/lib/flinks/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/hash/indifferent_access'
 require 'http'
 
@@ -72,7 +74,9 @@ module Flinks
       data = response.parse
 
       # Transform data
-      data.deep_transform_keys { |k| k.underscore }.with_indifferent_access
+      unless raw
+        data.deep_transform_keys { |k| k.underscore }.with_indifferent_access
+      end
     end
   end
 end

data/spec/lib/api/authorize_spec.rb

@@ -55,7 +55,7 @@ describe Flinks::API::Authorize do
 
       it "raises an error" do
         expect {
-          client.accounts_summary(login_id: login_id, options: options)
+          client.authorize(login_id: login_id, options: options)
         }.to raise_error(ArgumentError)
       end
     end
@@ -115,4 +115,43 @@ describe Flinks::API::Authorize do
       end
     end
   end
+
+  describe '#authorize_multiple' do
+    let(:login_ids) { ['login_id_1', 'login_id_2'] }
+
+    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_multiple(login_ids: login_ids)).to be_a(Hash)
+    end
+
+    context "with valid options" do
+      let(:options) do
+        {
+          most_recent_cached: true,
+        }
+      end
+
+      it "returns an object" do
+        expect(client.authorize_multiple(login_ids: login_ids, options: options)).to be_a(Hash)
+      end
+    end
+
+    context "with invalid options" do
+      let(:options) do
+        {
+          most_recent_cached: 'invalid'
+        }
+      end
+
+      it "raises an error" do
+        expect {
+          client.authorize_multiple(login_ids: login_ids, options: options)
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
 end

data/spec/lib/api/refresh_spec.rb

@@ -5,28 +5,6 @@ describe Flinks::API::Refresh do
   let(:client) { Flinks.new(customer_id: 'customer_id') }
   let(:login_id) { 'login_id' }
 
-  describe '#activate_scheduled_refresh' do
-    before do
-      stub_request(:patch, /#{api_endpoint}/)
-        .to_return(status: 200, body: "{}", headers: { 'Content-Type'=>'application/json' })
-    end
-
-    it "returns an object" do
-      expect(client.activate_scheduled_refresh(login_id: login_id)).to be_a(Hash)
-    end
-  end
-
-  describe '#deactivate_scheduled_refresh' do
-    before do
-      stub_request(:patch, /#{api_endpoint}/)
-        .to_return(status: 200, body: "{}", headers: { 'Content-Type'=>'application/json' })
-    end
-
-    it "returns an object" do
-      expect(client.deactivate_scheduled_refresh(login_id: login_id)).to be_a(Hash)
-    end
-  end
-
   describe '#set_scheduled_refresh' do
     before do
       stub_request(:patch, /#{api_endpoint}/)

data/spec/lib/client_spec.rb

@@ -18,6 +18,7 @@ describe Flinks::Client do
       expect(client.user_agent).not_to be_nil
       expect(client.on_error).not_to be_nil
       expect(client.debug).not_to be_nil
+      expect(client.raw).not_to be_nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flinks
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Philippe Dionne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Flinks API client