figo 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 3133d62a73507bbdadc5bfc1a4090da15960f895
+  data.tar.gz: acb3d79e2d8870dba61f222bc36158050abab8db
+SHA512: 
+  metadata.gz: 8cb5a5c2ccd4483907c3304c2f842333ee033340f46b1ec23834b8d7c94039cd42fde6f413d7e8ee2a3bed9348722ab6eb63cc2259852ec91fc3152e6aed11c7
+  data.tar.gz: 31145565afb3cb72a68bf0705d3b26c31b56ed1595615e218034e33f7f96460fa96f188e966d44088a9713196b17eff9e2a81c0f8a5d78bf30a95e4dc650ca62

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rake"

data/README.md

@@ -0,0 +1,41 @@
+ruby-figo [![Build Status](https://secure.travis-ci.org/figo-connect/ruby-figo.png)](https://travis-ci.org/figo-connect/ruby-figo)
+=========
+
+Ruby bindings for the figo connect API: http://figo.me
+
+Usage
+=====
+
+First, you've to install the gem
+
+```bash
+    gem install figo
+```
+
+and require it
+
+```ruby
+    require "figo"
+```
+
+Now you can create a new session and access data:
+
+```ruby
+    session = Figo::Session.new("ASHWLIkouP2O6_bgA2wWReRhletgWKHYjLqDaqb0LFfamim9RjexTo22ujRIP_cjLiRiSyQXyt2kM1eXU2XLFZQ0Hro15HikJQT_eNeT_9XQ")
+    
+    # Print out a list of accounts.
+    session.accounts.each do |account|
+      puts account
+      puts account.balance
+    end
+
+    # Print out the list of all transactions of a specific account.
+    session.get_account("A1.2").transactions.each do |transaction|
+      puts transaction
+    end
+```
+
+Requirements
+============
+
+This gem requires Ruby 1.9.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/figo.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = "figo"
+  s.version     = "1.0"
+  s.authors     = ["Stefan Richter", "Michael Haller"]
+  s.email       = ["stefan.richter@figo.me", "michael.haller@figo.me"]
+  s.homepage    = "https://github.com/figo-connect/ruby-figo"
+  s.license     = "MIT"
+  s.summary     = %q{API wrapper for figo Connect.}
+  s.description = %q{Library to easily use the API of http://www.figo.me}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "flt"
+  s.add_dependency "net-http-persistent"
+end

data/lib/figo.rb

@@ -0,0 +1,243 @@
+#
+# Copyright (c) 2013 figo GmbH
+# 
+# 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.
+# 
+
+require "json"
+require "logger"
+require 'net/http/persistent'
+require "digest/sha1"
+require "./lib/models.rb"
+
+$logger = Logger.new(STDOUT)
+
+module Figo
+
+  API_ENDPOINT = "api.leanbank.com"
+
+  VALID_FINGERPRINTS = ["A6:FE:08:F4:A8:86:F9:C1:BF:4E:70:0A:BD:72:AE:B8:8E:B7:78:52",
+                        "AD:A0:E3:2B:1F:CE:E8:44:F2:83:BA:AE:E4:7D:F2:AD:44:48:7F:1E"]
+
+  class Error < RuntimeError
+
+    def initialize(error, error_description) # :nodoc:
+      @error = error
+      @error_description = error_description
+    end
+
+    def to_s # :nodoc:
+      return @error_description
+    end
+
+  end
+
+  class HTTPS < Net::HTTP::Persistent # :nodoc:
+
+    def initialize(name = nil, proxy = nil)
+      super(name, proxy)
+
+      # Attribute ca_file must be set, otherwise verify_callback would never be called.
+      @ca_file = ""
+      @verify_callback = proc do |preverify_ok, store_context|
+        if preverify_ok and store_context.error == 0
+          certificate = OpenSSL::X509::Certificate.new(store_context.chain[0])
+          fingerprint = Digest::SHA1.hexdigest(certificate.to_der).upcase.scan(/../).join(":")
+          VALID_FINGERPRINTS.include?(fingerprint)
+        else
+          false
+        end
+      end
+    end
+
+    def request(uri, req = nil, &block)
+      response = super(uri, req, &block)
+
+      # Evaluate HTTP response.
+      case response
+        when Net::HTTPSuccess
+          return response
+        when Net::HTTPBadRequest
+          hash = JSON.parse(response.body)
+          raise Error.new(hash["error"], hash["error_description"])
+        when Net::HTTPUnauthorized
+          raise Error.new("unauthorized", "Missing, invalid or expired access token.")
+        when Net::HTTPForbidden
+          raise Error.new("forbidden", "Insufficient permission.")
+        when Net::HTTPNotFound
+          raise Error.new("not_found", "Requested object does not exist.")
+        when Net::HTTPMethodNotAllowed
+          raise Error.new("method_not_allowed", "Unexpected request method.")
+        when Net::HTTPServiceUnavailable
+          raise Error.new("service_unavailable", "Exceeded rate limit.")
+        else
+          $logger.warn("Querying the API failed when accessing '#{path}': #{response.code}")
+          raise Error.new("internal_server_error", "We are very sorry, but something went wrong.")
+      end
+    end
+
+  end
+
+  # Represents a non user-bound connection to the figo Connect API.
+  class Connection
+
+    # Create connection object with your client ID and client secret.
+    def initialize(client_id, client_secret, redirect_uri = nil)
+      @client_id = client_id
+      @client_secret = client_secret
+      @redirect_uri = redirect_uri
+      @https = HTTPS.new("figo-#{client_id}")
+    end
+
+    def query_api(path, data = nil) # :nodoc:
+        uri = URI("https://#{API_ENDPOINT}#{path}")
+        puts uri
+
+        # Setup HTTP request.
+        request = Net::HTTP::Post.new(path)
+        request.basic_auth(@client_id, @client_secret)
+        request["Content-Type"] = "application/x-www-form-urlencoded"
+        request['User-Agent'] =  "ruby-figo"
+        request.body = URI.encode_www_form(data) unless data.nil?
+
+        # Send HTTP request.
+        response = @https.request(uri, request)
+
+        # Evaluate HTTP response.
+        return response.body == "" ? {} : JSON.parse(response.body)
+    end
+
+    # Get the URL a user should open in the web browser to start the login process.
+    def login_url(state, scope = nil)
+      data = { "response_type" => "code", "client_id" => @client_id, "state" => state }
+      data["redirect_uri"] = @redirect_uri unless @redirect_uri.nil?
+      data["scope"] = scope unless scope.nil?
+      return "https://#{API_ENDPOINT}/auth/code?" + URI.encode_www_form(data) 
+    end
+
+    # Exchange authorization code or refresh token for access token.
+    def obtain_access_token(authorization_code_or_refresh_token, scope = nil)
+      # Authorization codes always start with "O" and refresh tokens always start with "R".
+      if authorization_code_or_refresh_token[0] == "O"
+        data = { "grant_type" => "authorization_code", "code" => authorization_code_or_refresh_token }
+        data["redirect_uri"] = @redirect_uri unless @redirect_uri.nil?
+      elsif authorization_code_or_refresh_token[0] == "R"
+        data = { "grant_type" => "refresh_token", "refresh_token" => authorization_code_or_refresh_token }
+        data["scope"] = scope unless scope.nil?
+      end
+      return query_api("/auth/token", data)
+    end
+
+    # Revoke refresh token or access token.
+    def revoke_token(refresh_token_or_access_token)
+      data = { "token" => refresh_token_or_access_token }
+      query_api("/auth/revoke?" + URI.encode_www_form(data))
+      return nil
+    end
+
+  end
+
+  # Represents a user-bound connection to the figo Connect API and allows access to the user's data.
+  class Session
+
+    # Create session object with access token.
+    def initialize(access_token)
+      @access_token = access_token
+      @https = HTTPS.new("figo-#{access_token}")
+    end
+
+    def query_api(path, data=nil, method="GET") # :nodoc:
+      uri = URI("https://#{API_ENDPOINT}#{path}")
+
+      # Setup HTTP request.
+      request = case method
+        when "POST"
+          Net::HTTP::Post.new(path)
+        when "PUT"
+          Net::HTTP::Put.new(path)
+        when "DELETE"
+          Net::HTTP::Delete.new(path)
+        else
+          Net::HTTP::Get.new(path)
+      end
+
+      request["Authorization"] = "Bearer #{@access_token}"
+      request["Content-Type"] = "application/json"
+      request['User-Agent'] =  "ruby-figo"
+      request.body = JSON.generate(data) unless data.nil?
+
+      # Send HTTP request.
+      response = @https.request(uri, request)
+
+      # Evaluate HTTP response.
+      return response.body == "" ? {} : JSON.parse(response.body)
+    end
+
+    # Request list of accounts.
+    def accounts
+      response = query_api("/rest/accounts")
+      return response["accounts"].map {|account| Account.new(self, account)}
+    end
+
+    # Request specific account.
+    def get_account(account_id)
+      response = query_api("/rest/accounts/#{account_id}")
+      return Account.new(self, response)
+    end
+
+    # Request list of transactions.
+    def transactions(since = nil, start_id = nil, count = 1000, include_pending = false)
+      data = {}
+      data["since"] = (since.is_a?(Date) ? since.to_s : since) unless since.nil?
+      data["start_id"] = start_id unless start_id.nil?
+      data["count"] = count.to_s
+      data["include_pending"] = include_pending ? "1" : "0"
+      response = query_api("/rest/transactions?" + URI.encode_www_form(data)) 
+      return response["transactions"].map {|transaction| Transaction.new(self, transaction)}
+    end
+
+    # Request the URL a user should open in the web browser to start the synchronization process.
+    def sync_url(redirect_uri, state, disable_notifications = false, if_not_synced_since = 0)
+      data = { "redirect_uri" => redirect_uri, "state" => state, "disable_notifications" => disable_notifications, "if_not_synced_since" => if_not_synced_since }
+      response = query_api("/rest/sync", data, "POST")
+      return "https://#{API_ENDPOINT}/task/start?id=#{response["task_token"]}"
+    end
+
+    # Request list of registered notifications.
+    def notifications
+      response = query_api("/rest/notifications")
+      return response["notifications"].map {|notification| Notification.new(self, notification)}
+    end
+
+    # Register notification.
+    def add_notification(observe_key, notify_uri, state)
+      data = { "observe_key" => observe_key, "notify_uri" => notify_uri, "state" => state }
+      response = query_api("/rest/notifications", data, "POST")
+      return response["notification_id"]
+    end
+
+    # Unregister notification.
+    def remove_notification(notification_id)
+      query_api("/rest/notifications/#{notification_id}", nil, "DELETE")
+      return nil
+    end
+
+  end
+
+end

data/lib/models.rb

@@ -0,0 +1,161 @@
+#
+# Copyright (c) 2013 figo GmbH
+# 
+# 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.
+# 
+
+require "date"
+require "flt"
+
+module Figo
+
+  # Set decimal precision to two digits.
+  Flt::DecNum.context.precision = 2
+
+  class AccountType
+    GIRO        = "Giro account"
+    SAVINGS     = "Savings account"
+    CREDIT_CARD = "Credit card"
+    LOAN        = "Loan account"
+    PAYPAL      = "PayPal"
+    UNKNOWN     = "Unknown"
+  end
+
+  class TransactionType
+    TRANSFER            = "Transfer"
+    STANDING_ORDER      = "Standing order"
+    DIRECT_DEBIT        = "Direct debit"
+    SALARY_OR_RENT      = "Salary or rent"
+    ELECTRONIC_CASH     = "Electronic cash"
+    GELDKARTE           = "GeldKarte"
+    ATM                 = "ATM"
+    CHARGES_OR_INTEREST = "Charges or interest"
+    UNKNOWN             = "Unknown"
+  end
+
+  class Base # :nodoc:
+
+    def initialize(session, hash)
+      @session = session
+
+      hash.each do |key, value|
+        if key == "status"
+          value = SynchronizationStatus.new(session, value)
+        elsif key == "amount" or key == "balance"
+          value = Flt::DecNum(value.to_s)
+        elsif key.end_with?("_date")
+          value = DateTime.iso8601(value)
+        elsif key.end_with?("_timestamp")
+          value = Date.iso8601(value)
+        end
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+  end
+
+  class Account < Base
+
+    attr_accessor :account_id
+    attr_accessor :bank_id
+    attr_accessor :name
+    attr_accessor :owner
+    attr_accessor :auto_sync
+    attr_accessor :account_number
+    attr_accessor :bank_code
+    attr_accessor :bank_name
+    attr_accessor :currency
+    attr_accessor :iban
+    attr_accessor :bic
+    attr_accessor :type
+    attr_accessor :icon
+    attr_accessor :in_total_balance
+    attr_accessor :preview
+    attr_accessor :status
+
+    # Request balance.
+    def balance
+      response = @session.query_api("/rest/accounts/#{@account_id}/balance")
+      return AccountBalance.new(@session, response)
+    end
+
+    # Request list of transactions.
+    def transactions(since = nil, start_id = nil, count = 1000, include_pending = false)
+      data = {}
+      data["since"] = (since.is_a?(Date) ? since.to_s : since) unless since.nil?
+      data["start_id"] = start_id unless start_id.nil?
+      data["count"] = count.to_s
+      data["include_pending"] = include_pending ? "1" : "0"
+      response = @session.query_api("/rest/accounts/#{@account_id}/transactions?" + URI.encode_www_form(data)) 
+      return response["transactions"].map {|transaction| Transaction.new(@session, transaction)}
+    end
+
+  end
+
+  class AccountBalance < Base
+
+    attr_accessor :balance
+    attr_accessor :balance_date
+    attr_accessor :credit_line
+    attr_accessor :monthly_spending_limit
+    attr_accessor :status
+
+  end
+
+  class Transaction < Base
+
+    attr_accessor :transaction_id
+    attr_accessor :account_id
+    attr_accessor :name
+    attr_accessor :account_number
+    attr_accessor :bank_code
+    attr_accessor :bank_name
+    attr_accessor :amount
+    attr_accessor :currency
+    attr_accessor :booking_date
+    attr_accessor :value_date
+    attr_accessor :purpose
+    attr_accessor :type
+    attr_accessor :booking_text
+    attr_accessor :booked
+    attr_accessor :creation_timestamp
+    attr_accessor :modification_timestamp
+    attr_accessor :visited
+
+  end
+
+  class SynchronizationStatus < Base
+
+    attr_accessor :code
+    attr_accessor :message
+    attr_accessor :sync_timestamp
+    attr_accessor :success_timestamp
+
+  end
+
+  class Notification < Base
+
+    attr_accessor :notification_id
+    attr_accessor :observe_key
+    attr_accessor :notify_uri
+    attr_accessor :state
+
+  end
+
+end

data/test/test_figo.rb

@@ -0,0 +1,28 @@
+#
+# Copyright (c) 2013 figo GmbH
+# 
+# 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.
+# 
+
+require "test/unit"
+require "figo"
+
+class FigoTest < Test::Unit::TestCase
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: figo
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Stefan Richter
+- Michael Haller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-http-persistent
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :runtime
+  version_requirements: *id003
+description: Library to easily use the API of http://www.figo.me
+email: 
+- stefan.richter@figo.me
+- michael.haller@figo.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- figo.gemspec
+- lib/figo.rb
+- lib/models.rb
+- test/test_figo.rb
+homepage: https://github.com/figo-connect/ruby-figo
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: API wrapper for figo Connect.
+test_files: 
+- test/test_figo.rb