qonto 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f24ba0d4ac1660f45b44441bbc3b43ed68b2343
+  data.tar.gz: 7512617e196450d36f421dd38f84f5d1017cbbf6
+SHA512:
+  metadata.gz: 7c57c3fd514dc333f9a5196e6cf5ccfa91e10039b506dbf3a02cd95dc293b77e18d0890809aa667c17cb355f2e477df5d18d610ca150a2d9093ecf7364d57382
+  data.tar.gz: 16aacda3639335db6c7e750e7acb8a89a085687e7c0d609d6f8b9e846efdddea40666d6e18098effee6eed1f7ee32dac166c9c9fd770c2ca3ef8d0069a337539

data/.circleci/config.yml

@@ -0,0 +1,50 @@
+version: 2
+jobs:
+  build-latest: &common-build
+    working_directory: ~/qonto-api-ruby
+    docker:
+      - image: circleci/ruby:2.4.1-node
+    steps:
+      - checkout
+
+      - type: cache-restore
+        name: Restore bundle cache
+        keys:
+          - bump-bundle-{{ checksum "qonto-api.gemspec" }}
+          # fallback to using the latest cache if no exact match is found
+          - bump-bundle-
+
+      - run:
+          name: Bundle Install
+          command: bundle install --path vendor/bundle
+
+      - type: cache-save
+        name: Store bundle cache
+        key: bump-bundle-{{ checksum "qonto-api.gemspec" }}
+        paths:
+          - vendor/bundle
+
+      - run:
+          name: Run tests
+          command: bundle exec rspec
+  build-2-3:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.3.4-node
+  build-2-2:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.2.7-node
+  build-2-1:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.1.10-node
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-latest
+      - build-2-3
+      - build-2-2
+      - build-2-1

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/Gemfile.lock
+/coverage/
+/doc/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017- Sébastien Charrier
+
+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,72 @@
+# Qonto API Ruby Client
+
+The Qonto API Ruby client provides convenient access to the Qonto API from applications written in Ruby language.
+It is currently up to date with the `v1` version. Qonto API documentation is avaible at https://api-doc.qonto.eu.
+
+This project is not affiliated with the Qonto company in any way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qonto'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qonto
+
+## Requirements
+
+* Ruby 2.1+.
+
+## Usage
+
+The library needs to be configured with your account's secret key and organization
+slug which are available in your organization dashboard on http://qonto.eu.
+
+    require 'qonto'
+
+    # Initialize your client
+    client = Qonto::Client.new(slug: 'your-organization-slug', secret_key: 'your-secret-key')
+
+You can retrieve your organization bank accounts by calling `get_organization`:
+
+    # Retrieve your organization object
+    organization = client.get_organization
+    bank_account = organization.bank_accounts.first
+
+    # Balance is available for each bank account
+    puts "Balance: #{bank_account.balance} €"
+
+You can list transactions for a given bank account by calling `list_transactions`:
+
+    # Paginate through the transactions
+    transactions = client.list_transactions(
+      bank_account: bank_account,
+      per_page: 10,
+      current_page: 2
+    )
+
+    transactions.each do |transaction|
+      puts " #{transaction.side}: #{transaction.amount} #{transaction.currency} - #{transaction.label}"
+    end
+
+If a request returns an error, the client raises a `Qonto::Error`. This can be simply
+handled by a `begin/rescue` block:
+
+    begin
+      organization = client.get_organization
+      puts "Balance: #{organization.bank_accounts.first.balance} €"
+    rescue Qonto::Error => e
+      puts "Oops: #{e.to_s}"
+    end
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/qonto.rb

@@ -0,0 +1,5 @@
+module Qonto
+end
+
+require 'qonto/version'
+require 'qonto/client'

data/lib/qonto/actions.rb

@@ -0,0 +1,7 @@
+module Qonto
+  module Actions
+  end
+end
+
+require_relative 'actions/organization'
+require_relative 'actions/transactions'

data/lib/qonto/actions/organization.rb

@@ -0,0 +1,26 @@
+module Qonto
+  module Actions
+    module Organization
+      def get_organization
+        response = get("/organizations/#{slug}")
+        modelize_organization(response.parsed_response['organization'])
+      end
+
+      private
+
+      def modelize_organization(organization)
+        if !organization['bank_accounts'].nil?
+          organization['bank_accounts'] = modelize_bank_accounts(organization['bank_accounts'])
+        end
+
+        Qonto::Model::Organization.new(organization)
+      end
+
+      def modelize_bank_accounts(bank_accounts)
+        bank_accounts.map do |bank_account|
+          Qonto::Model::BankAccount.new(bank_account)
+        end
+      end
+    end
+  end
+end

data/lib/qonto/actions/transactions.rb

@@ -0,0 +1,31 @@
+module Qonto
+  module Actions
+    module Transactions
+      def list_transactions(bank_account:, current_page: nil, per_page: nil)
+        query = prepare_query_string(bank_account, current_page, per_page)
+        response = get("/transactions?#{query}")
+
+        modelize_transactions(response.parsed_response['transactions'])
+      end
+
+      private
+
+      def prepare_query_string(bank_account, current_page, per_page)
+        {
+          slug: bank_account.slug,
+          iban: bank_account.iban,
+          current_page: current_page,
+          per_page: per_page
+        }.delete_if { |key, value| value.nil? }
+         .map { |(key, value)| "#{key}=#{value}" }
+         .join('&')
+       end
+
+      def modelize_transactions(transactions)
+        transactions.map do |transaction|
+          Qonto::Model::Transaction.new(transaction)
+        end
+      end
+    end
+  end
+end

data/lib/qonto/client.rb

@@ -0,0 +1,72 @@
+require 'httparty'
+require 'qonto/actions'
+require 'qonto/error'
+require 'qonto/model'
+
+module Qonto
+  class Client
+    include Qonto::Actions::Organization
+    include Qonto::Actions::Transactions
+
+    API_VERSION = '1'.freeze
+    BASE_URL = 'https://thirdparty.qonto.eu/v'.freeze
+    USER_AGENT = "qonto-api-ruby/#{VERSION}".freeze
+
+    def initialize(slug:, secret_key:)
+      @slug = slug
+      @secret_key = secret_key
+    end
+
+    def base_url
+      "#{BASE_URL}#{API_VERSION}"
+    end
+
+    def get(path)
+      execute :get, path
+    end
+
+    private
+
+    attr_reader :slug, :secret_key
+
+    def execute(method, path)
+      begin
+        response = request(method, path)
+      rescue *Error::NET_HTTP_ERRORS => err
+        raise ConnectionError.new, err.message
+      end
+
+      case response.code
+      when 200..299
+        response
+      when 400
+        raise BadRequestError.new(response)
+      when 401
+        raise AuthenticationError.new(response)
+      when 404
+        raise NotFoundError.new(response)
+      when 400..499
+        raise ResponseError.new(response)
+      when 500
+        raise InternalServerError.new(response)
+      when 500..599
+        raise ServerError.new(response)
+      end
+    end
+
+    def request(method, path)
+      HTTParty.send(method, base_url + path, base_options)
+    end
+
+    def base_options
+      {
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'Authorization' => "#{slug}:#{secret_key}",
+          'User-Agent' => USER_AGENT
+        }
+      }
+    end
+  end
+end

data/lib/qonto/error.rb

@@ -0,0 +1,82 @@
+module Qonto
+  class Error < StandardError
+    NET_HTTP_ERRORS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::ENETUNREACH,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Net::OpenTimeout,
+      Net::ReadTimeout,
+      SocketError,
+      Zlib::GzipFile::Error,
+      OpenSSL::SSL::SSLError
+    ]
+
+    attr_reader :http_response
+
+    def initialize(response = nil)
+      @http_response = response
+      super(build_error_message)
+    end
+
+    def http_request
+      http_response.request
+    end
+
+    private
+
+    def build_error_message
+      return nil if http_response.nil?
+
+      message = "#{http_request_method} "
+      message << "#{http_request.path} : "
+      message << "#{http_response.code} - "
+      message << response_message unless response_message.nil?
+      message
+    end
+
+    def http_request_method
+      http_request.http_method.name.split('::').last.upcase
+    end
+
+    def response_message
+      content_type = http_response.headers['Content-Type']
+      if content_type && content_type.start_with?('application/json')
+        http_response.parsed_response['message']
+      else
+        net_http_response = http_response.response
+        "#{net_http_response.code} #{net_http_response.message}"
+      end
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ResponseError < Error; end
+
+  # Raised when the API returns a 400 HTTP status code
+  class BadRequestError < ResponseError; end
+
+  # Raised when the API returns a 401 HTTP status code
+  class AuthenticationError < ResponseError; end
+
+  # Raised when the API returns a 402 HTTP status code
+  class PaymentRequiredError < ResponseError; end
+
+  # Raised when the API returns a 404 HTTP status code
+  class NotFoundError < ResponseError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when the API returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when we can't establish a connection to the API or if reading the reponse times out
+  class ConnectionError < Error; end
+end

data/lib/qonto/model.rb

@@ -0,0 +1,16 @@
+module Qonto
+  module Model
+    class Base
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          m = "#{key}=".to_sym
+          send(m, value) if respond_to?(m)
+        end
+      end
+    end
+  end
+end
+
+require_relative 'model/bank_account'
+require_relative 'model/organization'
+require_relative 'model/transaction'

data/lib/qonto/model/bank_account.rb

@@ -0,0 +1,12 @@
+module Qonto
+  module Model
+    class BankAccount  < Base
+      attr_accessor :slug
+      attr_accessor :iban
+      attr_accessor :bic
+      attr_accessor :current
+      attr_accessor :balance
+      attr_accessor :balance_cents
+    end
+  end
+end

data/lib/qonto/model/organization.rb

@@ -0,0 +1,8 @@
+module Qonto
+  module Model
+    class Organization  < Base
+      attr_accessor :slug
+      attr_accessor :bank_accounts
+    end
+  end
+end

data/lib/qonto/model/transaction.rb

@@ -0,0 +1,16 @@
+module Qonto
+  module Model
+    class Transaction < Base
+      attr_accessor :amount
+      attr_accessor :amount_cents
+      attr_accessor :local_amount
+      attr_accessor :local_amount_cents
+      attr_accessor :side
+      attr_accessor :operation_type
+      attr_accessor :currency
+      attr_accessor :local_currency
+      attr_accessor :settled_at
+      attr_accessor :label
+    end
+  end
+end

data/lib/qonto/version.rb

@@ -0,0 +1,3 @@
+module Qonto
+  VERSION = '0.1.0'.freeze
+end

data/qonto.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qonto/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'qonto'
+  spec.version  = Qonto::VERSION
+  spec.authors  = ['Sébastien Charrier']
+  spec.email    = ['scharrier@gmail.com']
+  spec.licenses = ['MIT']
+
+  spec.summary  = 'A Ruby client for the Qonto Api.'
+  spec.homepage = 'https://github.com/scharrier/qonto-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_runtime_dependency 'httparty', '~> 0'
+
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 3'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: qonto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sébastien Charrier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- scharrier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- lib/qonto.rb
+- lib/qonto/actions.rb
+- lib/qonto/actions/organization.rb
+- lib/qonto/actions/transactions.rb
+- lib/qonto/client.rb
+- lib/qonto/error.rb
+- lib/qonto/model.rb
+- lib/qonto/model/bank_account.rb
+- lib/qonto/model/organization.rb
+- lib/qonto/model/transaction.rb
+- lib/qonto/version.rb
+- qonto.gemspec
+homepage: https://github.com/scharrier/qonto-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the Qonto Api.
+test_files: []