tikkie-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c0fb0212ecabd850a104349b9edff3fc279c90f9
+  data.tar.gz: dbce2933f3a3b0750f385d1c74bb53f232256824
+SHA512:
+  metadata.gz: ed9a6a3f22a00360a990527fe9700c07ad68795db7bf2474523703467726aec375bb537d7dfb766bc0fe480b7bce1a74a38cc11bab7108d8b1a50fa62dd587f9
+  data.tar.gz: c60da0bf7f3b15499ea768389527161e0acaec5b4bbbcfc0f636862966a37406d2ef46a091c47c7b2d9539ca33c28a2c961c47a61c4bdcf4b4d2f59dba5899e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/AbcSize:
+  Max: 21
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+
+Style/GuardClause:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tikkie-api.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.52.0'

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    tikkie-api (0.1.0)
+      jwt (>= 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    jwt (2.1.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    timecop (0.9.1)
+    unicode-display_width (1.3.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52.0)
+  tikkie-api!
+  timecop (~> 0.9)
+  webmock (~> 2.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Peter Postma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,150 @@
+# Tikkie API
+
+Unofficial Ruby library for communicating with the [Tikkie API](https://developer.abnamro.com/content/tikkie).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tikkie-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tikkie-api
+
+## Usage
+
+### Initialization
+
+First create a Tikkie configuration and specify your API key and the path to your private RSA key. See also the [developer documentation from ABN AMRO](https://developer.abnamro.com/get-started) to get started.
+
+Use the configuration to initialize a Tikkie client:
+
+```ruby
+require 'tikkie/api'
+
+config = Tikkie::Api::Configuration.new("your_api_key", "private_rsa.pem")
+client = Tikkie::Api::Client.new(config)
+```
+
+### Platforms
+
+Retrieve all platforms:
+
+```ruby
+platforms = client.platforms.list
+```
+
+Create a new platform:
+
+```ruby
+platform = client.platforms.create(
+  name: "Kentaa",
+  phone_number: "0601234567",
+  platform_usage: Tikkie::Api::Types::PlatformUsage::FOR_MYSELF,
+  email: "info@kentaa.nl",                      # optional
+  notification_url: "https://kentaa.nl/tikkie"  # optional
+)
+
+platform_token = platform.platform_token
+```
+
+### Users
+
+Retrieve all users for a platform:
+
+```ruby
+users = client.users.list("platform_token")
+```
+
+Create a new user for a platform:
+
+```ruby
+user = client.users.create("platform_token",
+  name: "Kentaa",
+  phone_number: "0601234567",
+  iban: "NL02ABNA0123456789",
+  bank_account_label: "Personal account"
+)
+
+user_token = user.user_token
+bank_account_token = user.bank_accounts.first.bank_account_token
+```
+
+### Payment requests
+
+Retrieve all payment requests for a user on a platform:
+
+```ruby
+payment_requests = client.payment_requests.list("platform_token", "user_token")
+```
+
+The payments requests response is paginated. You can use the method `more_elements?` to determine if there's more data to retrieve. In the next request, set the `offset` parameter to the new offset using the method `next_offset` from the previous response. For example:
+
+```ruby
+response = client.payment_requests.list("platform_token", "user_token")
+payment_requests = response.to_a
+
+while response.more_elements?
+  response = client.payment_requests.list("platform_token", "user_token", offset: response.next_offset)
+  payment_requests << response.to_a
+end
+```
+
+To retrieve a single payment request:
+
+```ruby
+payment_request = client.payment_requests.get("platform_token", "user_token", "payment_request_token")
+```
+
+Create a new payment request for an existing user:
+
+```ruby
+payment_request = client.payment_requests.create("platform_token", "user_token", "bank_account_token",
+  amount: "5.00",
+  currency: "EUR",
+  description: "Test",
+  external_id: "Invoice 12345"  # optional
+)
+
+tikkie_url = payment_request.payment_request_url
+payment_request_token =payment_request.payment_request_token
+```
+
+### Error handling
+
+All responses to an API request include the methods `success?` and `error?` to determine whether the API call was successful or not. When the API request was not successful, the method `errors` will return details about the error response.
+
+```ruby
+payment_request = client.payment_requests.create("platform_token", "user_token", "bank_account_token", ...)
+
+if payment_request.success?
+  # Success handling...
+
+  redirect_to payment_request.payment_request_url
+else
+  # Error handling...
+
+  puts payment_request.errors
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KentaaNL/tikkie-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tikkie/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tikkie/api.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "tikkie/api/access_token"
+require "tikkie/api/authentication"
+require "tikkie/api/client"
+require "tikkie/api/configuration"
+require "tikkie/api/exception"
+require "tikkie/api/request"
+require "tikkie/api/version"
+
+require "tikkie/api/requests/payment_requests"
+require "tikkie/api/requests/platforms"
+require "tikkie/api/requests/users"
+
+require "tikkie/api/responses/base"
+require "tikkie/api/responses/bank_account"
+require "tikkie/api/responses/error"
+require "tikkie/api/responses/pagination"
+require "tikkie/api/responses/payment_request_created"
+require "tikkie/api/responses/payment_request"
+require "tikkie/api/responses/payment_requests"
+require "tikkie/api/responses/payment"
+require "tikkie/api/responses/platform"
+require "tikkie/api/responses/platforms"
+require "tikkie/api/responses/user"
+require "tikkie/api/responses/users"
+
+require "tikkie/api/types/payment_request_status"
+require "tikkie/api/types/payment_status"
+require "tikkie/api/types/platform_status"
+require "tikkie/api/types/platform_usage"
+require "tikkie/api/types/user_status"

data/lib/tikkie/api/access_token.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    # Access token that can be used to make API calls.
+    class AccessToken
+      attr_accessor :token
+
+      def initialize(token, expires_in)
+        @token = token
+        @expires_at = Time.now + expires_in.to_i
+      end
+
+      def expired?
+        Time.now > @expires_at
+      end
+    end
+  end
+end

data/lib/tikkie/api/authentication.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'jwt'
+require 'net/http'
+require 'uri'
+
+module Tikkie
+  module Api
+    # Provides authentication for the ABN AMRO OAuth API.
+    # see https://developer.abnamro.com/get-started#authentication
+    class Authentication
+      def initialize(config)
+        @config = config
+      end
+
+      def authenticate
+        uri = URI.parse(File.join(@config.api_url, "/oauth/token"))
+
+        request = Net::HTTP::Post.new(uri)
+        request["Api-Key"] = @config.api_key
+
+        request.set_form_data(
+          client_assertion: jwt_token,
+          client_assertion_type: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
+          grant_type: "client_credentials",
+          scope: "tikkie"
+        )
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+          http.request(request)
+        end
+
+        if response.is_a?(Net::HTTPSuccess)
+          json = JSON.parse(response.body, symbolize_names: true)
+
+          Tikkie::Api::AccessToken.new(json[:access_token], json[:expires_in])
+        else
+          raise Tikkie::Api::AuthenticationException, response
+        end
+      end
+
+      private
+
+      def jwt_token
+        now = Time.now.to_i
+
+        payload = {
+          nbf: now - 120,
+          exp: now + 120, # Token is valid for 2 minutes
+          iss: "Ruby Tikkie client",
+          sub: @config.api_key,
+          aud: @config.oauth_token_url
+        }
+
+        JWT.encode(payload, @config.private_data, @config.jwt_hashing_algorithm, typ: "JWT")
+      end
+    end
+  end
+end