flinks 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bbbf0a02763ddebf7cc99bdada61f89ffd254e9edafa4d48fca314619bcb18b
-  data.tar.gz: 72a81130480e91ce328d5e7e142d3b7b968f5fcb4ebf08c722d169b3af8e6f74
+  metadata.gz: 8b7a392806d3c94ce6e355367e627315f520970216796aa47b77f9a0208e55e1
+  data.tar.gz: f17b1804a6d60dbe6c11342b01b95a978e94cd6a15297a07b164402080c6941f
 SHA512:
-  metadata.gz: 6e23c086214b89d665dc871ed5125dbca516019f864509ba2c61151288a0bf87c331de5e688a90321f09d422f4fb124f8548ca78fd7f374b1608438ba0ac05fd
-  data.tar.gz: ddd6594be9862596243394081bf307f4204098629934d9ff4e01cbc6cebef81005e091609442d2e59faadb0746ab2c61facbc7d0247040b560a6001d6575c46f
+  metadata.gz: c19e8dc8039795b03b503ebbedf33cfb5b6012cf34d78204d32a34ecd5f2b7355b45032a93d27e43ec6f3f8ffe6a7e902a40d264fe32a91a78e50ba604adccec
+  data.tar.gz: 3482beb2baf3ad3d5a2fcfd40a47e40509c7dfcf4bc2c4a498ea74b75ae81195f32abb5cb13fd1a4d882da76896dd009d387ea15a74c0bc83027ce5c2067687e

data/.travis.yml

@@ -5,9 +5,9 @@ env:
 language: ruby
 
 rvm:
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.3
+  - 2.4
+  - 2.5
 
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/README.md

@@ -21,34 +21,42 @@ gem 'flinks', require: 'flinks'
 
 ## Usage
 
-This library needs to be configured with your API customer ID.
+This library needs to be configured with your API customer ID and API endpoint.
 
 ```ruby
-flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'])
+flinks = Flinks.new(customer_id: ENV['FLINKS_CUSTOMER_ID'], api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/")
 ```
 
-Configure `on_error` to catch API requests returning a 400..599 HTTP status.
+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 responses.
+Configure `debug` to print every API requests and responses.
 
 ```ruby
 flinks = Flinks.new({
   customer_id: ENV['FLINKS_CUSTOMER_ID'],
+  api_endpoint: "https://YOURNAME-api.private.fin.ag/v3/",
   debug: true
 })
 ```
 
 ### Endpoints
 
+#### Authorize
+
+- `authorize(login_id:, options:)`
+- `authorize_with_credentials(username:, password:, institution:, options:)`
+- `authorize_multiple(login_ids:)`
+
 #### Account
 
 - `accounts_summary(request_id:, options:)`
@@ -75,6 +83,12 @@ flinks = Flinks.new({
 
 See the [API docs](https://sandbox-api.flinks.io).
 
+## Supported Ruby versions
+
+- MRI 2.3
+- MRI 2.4
+- MRI 2.5
+
 ## Development
 
 Run all tests:
@@ -82,3 +96,7 @@ Run all tests:
 ```bash
 bundle exec rspec
 ```
+
+## License
+
+[MIT](LICENSE.txt)

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

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.0 ruby lib
+# stub: flinks 0.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "flinks".freeze
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   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-14"
+  s.date = "2018-02-16"
   s.description = "Flinks financial services API client".freeze
   s.email = "dionne.phil@gmail.com".freeze
   s.extra_rdoc_files = [

data/lib/flinks/api/account.rb

@@ -41,10 +41,10 @@ module Flinks
       # @param options [Hash]
       # @return [Hash]
       def accounts_summary(request_id:, options: {})
-        payload = AccountSummaryRequestSchema.call(options.merge(request_id: request_id))
-        raise ArgumentError, error_message(payload) unless payload.success?
+        payload = options.merge(request_id: request_id)
+        validate_request!(AccountSummaryRequestSchema, payload)
 
-        post("#{customer_id}/BankingServices/GetAccountsSummary", body: payload.to_h)
+        post("#{customer_id}/BankingServices/GetAccountsSummary", body: payload)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#get-accounts-detail
@@ -52,10 +52,10 @@ module Flinks
       # @param options [Hash]
       # @return [Hash]
       def accounts_detail(request_id:, options: {})
-        payload = AccountDetailRequestSchema.call(options.merge(request_id: request_id))
-        raise ArgumentError, error_message(payload) unless payload.success?
+        payload = options.merge(request_id: request_id)
+        validate_request!(AccountDetailRequestSchema, payload)
 
-        post("#{customer_id}/BankingServices/GetAccountsDetail", body: payload.to_h)
+        post("#{customer_id}/BankingServices/GetAccountsDetail", body: payload)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#get-accounts-summary

data/lib/flinks/api/authorize.rb

@@ -42,10 +42,10 @@ module Flinks
       # @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?
+        payload = options.merge(login_id: login_id)
+        validate_request!(AuthorizeRequestSchema, payload)
 
-        post("#{customer_id}/BankingServices/Authorize", body: payload.to_hash)
+        post("#{customer_id}/BankingServices/Authorize", body: payload)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#authorize
@@ -54,20 +54,20 @@ module Flinks
       # @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?
+        payload = options.merge(username: username, password: password, institution: institution)
+        validate_request!(AuthorizeWithCredentialsRequestSchema, payload)
 
-        post("#{customer_id}/BankingServices/Authorize", body: payload.to_hash)
+        post("#{customer_id}/BankingServices/Authorize", body: payload)
       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?
+        payload = options.merge(login_ids: login_ids)
+        validate_request!(AuthorizeMultipleRequestSchema, payload)
 
-        post("#{customer_id}/BankingServices/AuthorizeMultiple", body: payload.to_hash)
+        post("#{customer_id}/BankingServices/AuthorizeMultiple", body: payload)
       end
     end
   end

data/lib/flinks/api/statement.rb

@@ -15,10 +15,8 @@ module Flinks
       # @param options [Hash]
       # @return [Hash]
       def statements(options: {})
-        payload = StatementRequestSchema.call(options)
-        raise ArgumentError, error_message(payload) unless payload.success?
-
-        post("#{customer_id}/BankingServices/GetStatements", body: payload.to_h)
+        validate_request!(StatementRequestSchema, options)
+        post("#{customer_id}/BankingServices/GetStatements", body: options)
       end
 
       # @see https://sandbox-api.flinks.io/Readme/#get-pdf-statements

data/lib/flinks/client.rb

@@ -26,11 +26,25 @@ module Flinks
     option :on_error,     default: proc { proc {} }
     option :debug,        default: proc { false }
 
+
+    private
+
+    # Builds an error message from a validation object
     #
     # @param validation [Dry::Validation::Result]
     # @return [String]
     def error_message(validation)
       validation.messages(full: true).values.flatten.to_sentence
     end
+
+    # Validates a request payload against a schema object
+    #
+    # @param schema [Class]
+    # @param options [Hash]
+    # @raise [ArgumentError]
+    def validate_request!(schema, options)
+      payload = schema.call(options)
+      raise ArgumentError, error_message(payload) unless payload.success?
+    end
   end
 end

data/lib/flinks/request.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/hash/indifferent_access'
 require 'http'
 
 require 'flinks/error'
@@ -10,7 +11,7 @@ module Flinks
     # @param path [String]
     # @param params [Hash]
     def get(path, params: {})
-      request(:get, URI.parse(api_endpoint).merge(path), params: params)
+      request(:get, path, params: params)
     end
 
     # Performs a HTTP Post request
@@ -19,7 +20,7 @@ module Flinks
     # @param params [Hash]
     # @param body [Hash]
     def post(path, params: {}, body: {})
-      request(:post, URI.parse(api_endpoint).merge(path), params: params, body: body)
+      request(:post, path, params: params, body: body)
     end
 
     # Performs a HTTP Patch request
@@ -28,7 +29,7 @@ module Flinks
     # @param params [Hash]
     # @param body [Hash]
     def patch(path, params: {}, body: {})
-      request(:patch, URI.parse(api_endpoint).merge(path), params: params, body: body)
+      request(:patch, path, params: params, body: body)
     end
 
 
@@ -38,18 +39,26 @@ module Flinks
     # @raise [Flinks::Error]
     def request(method, path, params: {}, body: {})
       headers = {
-        'Accept'     => "application/json",
-        'User-Agent' => user_agent
+        'Content-Type' => "application/json",
+        'Accept'       => "application/json",
+        'User-Agent'   => user_agent
       }
 
+      # Build URL
+      url = URI.parse(api_endpoint).merge(path)
+
       # Build payload
       payload = body.transform_keys { |k| k.to_s.camelize }
 
       # Perform request
-      response = Http.headers(headers).send(method, path, params: params, json: payload)
+      response = Http.headers(headers).send(method, url, params: params, json: payload)
 
       if debug
-        p response
+        p "Method: #{method}"
+        p "Url: #{url}"
+        p "Headers: #{headers}"
+        p "Payload: #{payload}"
+        p "Response: #{response}"
       end
 
       # Pass on errors when HTTP status included in 400 to 599
@@ -59,8 +68,11 @@ module Flinks
         on_error.call(response.code, response.reason, body)
       end
 
-      # Return parsed json body
-      response.parse
+      # Parse body
+      data = response.parse
+
+      # Transform data
+      data.deep_transform_keys { |k| k.underscore }.with_indifferent_access
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flinks
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Philippe Dionne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http