qonto_ofx 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad86a6cf7dbc7277bd7d15a567a5a9ee39c86d0e
+  data.tar.gz: 3cb06c7c0d1b392c4be475d0c715c524a6fbae9a
+SHA512:
+  metadata.gz: f9b80fdf46d5f40538633a53f19692bee51dcacda9f6f1286b04f3bc2ff2cd85a1b2baf7e8b21e5a7acfeebb883fee3a1223b07f8da489c1c42697bd2ff93cd8
+  data.tar.gz: fc6b6a8fb4d00beeee867d25d53b685b3faa712d1bc4ea6a5b9fe5d49c9a0919b8940d202f2b6cbb80c7ab16acff01473b8cb9c7cef2a005bc9c934016494088

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,68 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-07-08 11:09:07 +0200 using RuboCop version 0.57.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/converter.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 32
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 27
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/qonto_ofx.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'qonto_ofx.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/api_gateway.rb'
+
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'lib/organization_validator.rb'
+    - 'lib/qonto_ofx/version.rb'
+    - 'test/test_converter.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 123

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in qonto_ofx.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    qonto_ofx (1.0.1)
+      htmlentities (~> 4.3)
+      json (~> 1.8)
+      json-schema (~> 2.5)
+      nokogiri (~> 1.6)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diffy (3.2.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    htmlentities (4.3.4)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (1.8.6)
+    json-schema (2.8.0)
+      addressable (>= 2.4)
+    metaclass (0.0.4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    mocha (1.5.0)
+      metaclass (~> 0.0.1)
+    netrc (0.11.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rubygems-tasks (0.2.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  diffy (~> 3.1)
+  minitest (~> 5.8)
+  mocha (~> 1.2)
+  qonto_ofx!
+  rake (~> 10.0)
+  rubygems-tasks (~> 0.2)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Simon
+
+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,34 @@
+# QontoOfx
+
+Export your Qonto account into an OFX 2 file.
+
+## Installation
+
+```ruby
+gem install qonto_ofx
+```
+
+## Usage
+
+```
+qonto_ofx -s YOUR_COMPANY_SLUG -t INTEGRATION_TOKEN
+```
+
+## Development
+
+This is an early stage version built for my own accounting needs.  
+I plan to improve this gem as I switch to Qonto.  
+As of today, it generates a valid OFX 2 file with all transactions for all
+accounts.
+
+Roadmap :
+ - Make sure all fields hold correct values
+ - Add filtering on transactions dates, and accounts
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/simon-watiau/qonto_ofx.
+
+## 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,11 @@
+require 'rake/testtask'
+require 'rubygems/tasks'
+
+Gem::Tasks.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/bin/qonto_ofx

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'converter'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: qonto_ofx [OPTIONS]"
+
+  opts.on("-t", "--token TOKEN", "Qonto API token") do |token|
+    options[:token] = token
+  end
+
+  opts.on("-s", "--slug SLUG", "Qonto account slug") do |slug|
+    options[:slug] = slug
+  end
+
+  opts.on("-n", "--[no-]namespace", "Exclude namespace") do |ns|
+    options[:namespace] = ns
+  end
+end.parse!
+
+converter = QontoOfx::Converter.new(options[:slug], options[:token])
+print converter.convert options[:namespace]

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/api_gateway.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'json-schema'
+require 'organization_validator'
+require 'transactions_listing_validator'
+
+module QontoOfx
+  # Call and verify responses for Qonto API
+  class ApiGateway
+    def initialize(slug, token)
+      @slug = slug
+      @token = token
+      @organization_validator = OrganizationValidator.new
+      @transactions_listing_validator = TransactionsListingValidator.new
+    end
+
+    def fetch_organization
+      response = RestClient.get(
+        "https://thirdparty.qonto.eu/v2/organizations/#{@slug}",
+        Authorization: "#{@slug}:#{@token}"
+      )
+      check_against_validator response, @organization_validator
+
+      JSON.parse(response.body)
+    end
+
+    def fetch_transactions(url)
+      response = RestClient.get(
+        url,
+        Authorization: "#{@slug}:#{@token}"
+      )
+
+      check_against_validator response, @transactions_listing_validator
+
+      JSON.parse(response.body)
+    end
+
+    def check_against_validator(response, validator)
+      if response.code != 200
+        raise "Qonto API call failed \
+          (status: #{response.code}): #{response.body}"
+      end
+
+      raise "response does not match schema: \
+        #{response.body}" unless validator.valid? response.body
+    end
+  end
+end

data/lib/base_validator.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'json-schema'
+
+module QontoOfx
+  # Base class for API response validation
+  class BaseValidator
+    def valid?(input)
+      return false unless JSON::Validator.validate(
+        @schema,
+        JSON.parse(input)
+      )
+      true
+    rescue JSON::ParserError
+      false
+    end
+  end
+end

data/lib/converter.rb

@@ -0,0 +1,158 @@
+require 'json'
+require 'api_gateway'
+require 'rest-client'
+require 'nokogiri'
+require 'ofx_validator'
+require 'htmlentities'
+
+module QontoOfx
+  # Convert a JSON transactions listing into an OFX hash
+  class Converter
+    def initialize(slug, token)
+      @gateway = ApiGateway.new slug, token
+      @ofx_validator = OfxValidator.new
+    end
+
+    # valid_ofx = false removes the namespaces
+    def convert(remove_ns = false)
+      organization = @gateway.fetch_organization['organization']
+
+      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8')
+      builder[:ofx].OFX('xmlns:ofx' => 'http://ofx.net/types/2003/04') do |xml|
+        add_signonmsgsrsv1_block xml
+
+        xml.BANKMSGSRSV1 do
+          xml.parent.namespace = nil
+          organization['bank_accounts'].each do |bank_account|
+            xml.STMTTRNRS do
+              xml.TRNUID 1
+              add_status_block xml
+
+              xml.STMTRS do
+                xml.CURDEF 'EUR'
+                add_bankacctfrom_block xml, bank_account
+
+                xml.BANKTRANLIST do
+                  process_transactions xml, bank_account
+                end
+
+                xml.LEDGERBAL do
+                  xml.BALAMT bank_account['balance']
+                  xml.DTASOF Time.now.strftime('%Y%m%d%H%M%S')
+                end
+              end
+            end
+          end
+        end
+      end
+
+      move_to_first_position(builder, '//DTEND')
+      move_to_first_position(builder, '//DTSTART')
+
+
+      result = builder.to_xml
+      raise 'generation failed (invalid OFX)' unless @ofx_validator.valid? result
+      result = result.gsub(
+        'ofx:OFX',
+        'OFX'
+      ).gsub(' xmlns:ofx="http://ofx.net/types/2003/04"', '') if remove_ns
+      result
+    end
+
+    def move_to_first_position(builder, path)
+      builder.doc.xpath(path).each do |el|
+        el.parent.children.first.before(el)
+      end
+
+    end
+
+    def add_bankacctfrom_block(xml, bank_account)
+      xml.BANKACCTFROM do
+        xml.BANKID '0000'
+        xml.ACCTID bank_account['iban'][-21..-1]
+        xml.ACCTTYPE 'CHECKING'
+      end
+    end
+
+    def add_status_block(xml, code = 0, severity = 'INFO')
+      xml.STATUS do
+        xml.CODE code
+        xml.SEVERITY severity
+      end
+    end
+
+    def add_signonmsgsrsv1_block(xml)
+      xml.SIGNONMSGSRSV1 do
+        xml.parent.namespace = nil
+        xml.SONRS do
+          add_status_block xml
+          xml.DTSERVER Time.now.strftime('%Y%m%d%H%M%S')
+          xml.LANGUAGE 'FRE'
+        end
+      end
+    end
+
+    def compute_dates_range(transaction, dtstart, dtend)
+      unless transaction['settled_at'].nil?
+        tmp_dtstart = Time.parse(transaction['emitted_at'])
+        dtstart = tmp_dtstart if dtstart.nil? || tmp_dtstart < dtstart
+
+        tmp_dtend = Time.parse(transaction['emitted_at'])
+        dtend = tmp_dtend if dtend.nil? || tmp_dtend > dtend
+      end
+      [dtstart, dtend]
+
+    end
+
+    def process_transactions(xml, account)
+      url = "https://thirdparty.qonto.eu/v2/transactions?slug=#{account['slug']}&iban=#{account['iban']}"
+
+      dtstart = dtend = nil
+      loop do
+        response = @gateway.fetch_transactions url
+        transactions = response['transactions']
+
+        transactions.each do |transaction|
+          dtstart, dtend = compute_dates_range transaction, dtstart, dtend
+          next if transaction['settled_at'].nil?
+          xml.STMTTRN do
+            xml.TRNTYPE operation_type(transaction)
+            xml.DTPOSTED Time.parse(
+              transaction['settled_at']
+            ).strftime('%Y%m%d%H%M%S')
+            xml.TRNAMT correct_value(transaction, 'amount')
+            xml.FITID transaction['transaction_id']
+            xml.NAME transaction['label'][0..31]
+
+            xml.MEMO transaction['note'] unless transaction['note'].nil? || transaction['note'].empty?
+          end
+        end
+
+        url = response['meta']['next_page']
+        break if url.nil?
+      end
+      xml.DTEND((dtend || Time.now).strftime('%Y%m%d%H%M%S'))
+      xml.DTSTART((dtstart || Time.now).strftime('%Y%m%d%H%M%S'))
+      nil
+    end
+
+    def correct_value(transaction, key)
+      if transaction['side'] === 'debit'
+        -transaction[key]
+      else
+        transaction[key]
+      end
+    end
+
+    def operation_type(transaction)
+      case transaction['operation_type']
+      when 'income'
+        'XFER'
+      when 'card'
+          'POS'
+      else
+          transaction['side'].upcase
+      end
+    end
+  end
+end

data/lib/ofx_validator.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'api_gateway'
+require 'rest-client'
+
+module QontoOfx
+  # Validate an OFX document against the schema
+  class OfxValidator
+    def valid?(input)
+      path = File.join(File.dirname(__FILE__), "../schema/OFX2_Protocol.xsd")
+      schema = Nokogiri::XML::Schema(File.open(path))
+      document = Nokogiri::XML(input)
+      schema.validate(document).empty?
+    rescue => e
+      false
+    end
+  end
+end

data/lib/organization_validator.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'json-schema'
+require 'base_validator'
+
+module QontoOfx
+  # Validate an organization JSON from Qonto API
+  class OrganizationValidator < BaseValidator
+    def initialize
+      path = File.join( File.dirname(__FILE__), '../qonto_organization_schema.json' )
+      @schema = JSON.parse(
+        File.read(
+          path
+        )
+      )
+    end
+  end
+end

data/lib/qonto_ofx/version.rb

@@ -0,0 +1,3 @@
+module QontoOfx
+  VERSION = "1.0.1".freeze
+end

data/lib/transactions_listing_validator.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'json-schema'
+require 'base_validator'
+
+module QontoOfx
+  # Validate a transaction listing JSON from Qonto API
+  class TransactionsListingValidator < BaseValidator
+    def initialize
+      path = File.join( File.dirname(__FILE__), '../qonto_transactions_schema.json' )
+      @schema = JSON.parse(
+        File.read(
+          path
+        )
+      )
+    end
+  end
+end

data/qonto_ofx.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qonto_ofx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qonto_ofx'
+  spec.version       = QontoOfx::VERSION
+  spec.authors       = ['Simon Watiau']
+  spec.email         = ['watiau.simon@gmail.com']
+
+  spec.summary       = 'Parse Qonto transations listing into an OFX file'
+  spec.homepage      = 'https://github.com/simon-watiau/qonto_ofx'
+  spec.license       = 'MIT'
+
+  spec.executables   = 'qonto_ofx'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'mocha', '~> 1.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  spec.add_development_dependency 'diffy', '~> 3.1'
+
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'json-schema', '~> 2.5'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'htmlentities', '~> 4.3'
+end

data/qonto_organization_schema.json

@@ -0,0 +1,63 @@
+{
+  "type":"object",
+  "required":[
+    "organization"
+  ],
+  "properties":{
+    "organization":{
+      "type":"object",
+      "required":[
+        "slug",
+        "bank_accounts"
+      ],
+      "properties":{
+        "slug":{
+          "type":"string"
+        },
+        "bank_accounts":{
+          "type":"array",
+          "items":{
+            "type":"object",
+            "required":[
+              "slug",
+              "iban",
+              "bic",
+              "currency",
+              "balance",
+              "balance_cents",
+              "authorized_balance",
+              "authorized_balance_cents"
+            ],
+            "properties":{
+              "slug":{
+                "type":"string"
+              },
+              "iban":{
+                "type":"string",
+                "pattern":"^[A-Z]{2}[0-9]{25}$"
+              },
+              "bic":{
+                "type":"string"
+              },
+              "currency":{
+                "type":"string"
+              },
+              "balance":{
+                "type":"number"
+              },
+              "balance_cents":{
+                "type":"integer"
+              },
+              "authorized_balance":{
+                "type":"number"
+              },
+              "authorized_balance_cents":{
+                "type":"integer"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}