figo 1.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: c9bbbd2adbe88269274fcff1ddcd8f342bf56e1a
-  data.tar.gz: 7267a93b66bc7aea0e1ae909ebf7e6bf9a0878c0
-SHA512: 
-  metadata.gz: 02cc595570b661a625333d589e7eff74632dbb289d3f20a6fd5ed1e67520234eac7d68e66325471a0e9cd616bba8ba34200fa207d695fac43f737f20a5a2af27
-  data.tar.gz: 85d7e1e88a2ead733cdfd1cefe03a978d1b2065701e483f94bdff50cc588f7704fe1dfdd3ec393ffd14aa2dd997f77ac6e11b04a4d36a818998e69c18bd22f6c
+---
+SHA1:
+  metadata.gz: 390163889160a8aefcb91f1f8b4f99e18c84efb9
+  data.tar.gz: 2a24495ecbb097b1659dbb29f8ad697b082d24a2
+SHA512:
+  metadata.gz: e0c1cc2c14a9b6db75c5724b949ec2d0b7d496103247bd4bdcd72993e549d6371465dcd1222105ca939d7837c99ee44d2f6937efe56b606cffb40982641eb52f
+  data.tar.gz: b5401f6d092be459e5165bb86564d4180e7529cfd750261604865e17d5fcac0e0b44c3ecc311b435b194fcb4dc0d3ffd936be1840ba9dda2c5e012a48de97f2a

data/.travis.yml

@@ -2,5 +2,13 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.1
+  - ruby-head
+  - rbx-2.1.1
+  - rbx
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: jruby-head

data/Gemfile

@@ -3,3 +3,4 @@ source "http://rubygems.org"
 gemspec
 
 gem "rake"
+gem "minitest"

data/README.md

@@ -6,35 +6,67 @@ Ruby bindings for the figo Connect API: http://developer.figo.me
 Usage
 =====
 
-First, you've to install the gem
+First, you've to install the gem:
 
 ```bash
-    gem install figo
+gem install figo
 ```
 
-and require it
+Now you can create a new session and access data:
 
 ```ruby
-    require "figo"
+require "figo"
+
+session = Figo::Session.new("ASHWLIkouP2O6_bgA2wWReRhletgWKHYjLqDaqb0LFfamim9RjexTo22ujRIP_cjLiRiSyQXyt2kM1eXU2XLFZQ0Hro15HikJQT_eNeT_9XQ")
+
+# Print out list of account numbers and balances.
+session.accounts.each do |account|
+  puts account.account_number
+  puts account.balance.balance
+end
+
+# Print out the list of all transaction originators/recipients of a specific account.
+session.get_account("A1.1").transactions.each do |transaction|
+  puts transaction.name
+end
 ```
 
-Now you can create a new session and access data:
+It is just as simple to allow users to login through the API:
 
 ```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
+require "figo"
+require "launchy"
+
+connection = Figo::Connection.new("<client ID>", "<client secret>", "http://my-domain.org/redirect-url")
+
+def start_login
+  # Open webbrowser to kick of the login process.
+  Launchy.open(connection.login_url("qweqwe"))
+end
+
+def process_redirect(authorization_code, state)
+  # Handle the redirect URL invocation from the initial start_login call.
+
+  # Ignore bogus redirects.
+  if state != "qweqwe"
+    return
+  end
+
+  # Trade in authorization code for access token.
+  token_hash = connection.obtain_access_token(authorization_code)
+
+  # Start session.
+  session = Figo::Session.new(token_hash["access_token"])
+  
+  # Print out list of account numbers.
+  session.accounts.each do |account|
+    puts account.account_number
+  end
+end
 ```
 
+You can find more documentation at http://rubydoc.info/github/figo-connect/ruby-figo/master/frames
+
 Requirements
 ============
 

data/figo.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "figo"
-  s.version     = "1.1"
+  s.version     = "1.1.1"
   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"

data/lib/cacert.pem

@@ -1,41 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIHPTCCBSWgAwIBAgIBADANBgkqhkiG9w0BAQQFADB5MRAwDgYDVQQKEwdSb290
-IENBMR4wHAYDVQQLExVodHRwOi8vd3d3LmNhY2VydC5vcmcxIjAgBgNVBAMTGUNB
-IENlcnQgU2lnbmluZyBBdXRob3JpdHkxITAfBgkqhkiG9w0BCQEWEnN1cHBvcnRA
-Y2FjZXJ0Lm9yZzAeFw0wMzAzMzAxMjI5NDlaFw0zMzAzMjkxMjI5NDlaMHkxEDAO
-BgNVBAoTB1Jvb3QgQ0ExHjAcBgNVBAsTFWh0dHA6Ly93d3cuY2FjZXJ0Lm9yZzEi
-MCAGA1UEAxMZQ0EgQ2VydCBTaWduaW5nIEF1dGhvcml0eTEhMB8GCSqGSIb3DQEJ
-ARYSc3VwcG9ydEBjYWNlcnQub3JnMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIIC
-CgKCAgEAziLA4kZ97DYoB1CW8qAzQIxL8TtmPzHlawI229Z89vGIj053NgVBlfkJ
-8BLPRoZzYLdufujAWGSuzbCtRRcMY/pnCujW0r8+55jE8Ez64AO7NV1sId6eINm6
-zWYyN3L69wj1x81YyY7nDl7qPv4coRQKFWyGhFtkZip6qUtTefWIonvuLwphK42y
-fk1WpRPs6tqSnqxEQR5YYGUFZvjARL3LlPdCfgv3ZWiYUQXw8wWRBB0bF4LsyFe7
-w2t6iPGwcswlWyCR7BYCEo8y6RcYSNDHBS4CMEK4JZwFaz+qOqfrU0j36NK2B5jc
-G8Y0f3/JHIJ6BVgrCFvzOKKrF11myZjXnhCLotLddJr3cQxyYN/Nb5gznZY0dj4k
-epKwDpUeb+agRThHqtdB7Uq3EvbXG4OKDy7YCbZZ16oE/9KTfWgu3YtLq1i6L43q
-laegw1SJpfvbi1EinbLDvhG+LJGGi5Z4rSDTii8aP8bQUWWHIbEZAWV/RRyH9XzQ
-QUxPKZgh/TMfdQwEUfoZd9vUFBzugcMd9Zi3aQaRIt0AUMyBMawSB3s42mhb5ivU
-fslfrejrckzzAeVLIL+aplfKkQABi6F1ITe1Yw1nPkZPcCBnzsXWWdsC4PDSy826
-YreQQejdIOQpvGQpQsgi3Hia/0PsmBsJUUtaWsJx8cTLc6nloQsCAwEAAaOCAc4w
-ggHKMB0GA1UdDgQWBBQWtTIb1Mfz4OaO873SsDrusjkY0TCBowYDVR0jBIGbMIGY
-gBQWtTIb1Mfz4OaO873SsDrusjkY0aF9pHsweTEQMA4GA1UEChMHUm9vdCBDQTEe
-MBwGA1UECxMVaHR0cDovL3d3dy5jYWNlcnQub3JnMSIwIAYDVQQDExlDQSBDZXJ0
-IFNpZ25pbmcgQXV0aG9yaXR5MSEwHwYJKoZIhvcNAQkBFhJzdXBwb3J0QGNhY2Vy
-dC5vcmeCAQAwDwYDVR0TAQH/BAUwAwEB/zAyBgNVHR8EKzApMCegJaAjhiFodHRw
-czovL3d3dy5jYWNlcnQub3JnL3Jldm9rZS5jcmwwMAYJYIZIAYb4QgEEBCMWIWh0
-dHBzOi8vd3d3LmNhY2VydC5vcmcvcmV2b2tlLmNybDA0BglghkgBhvhCAQgEJxYl
-aHR0cDovL3d3dy5jYWNlcnQub3JnL2luZGV4LnBocD9pZD0xMDBWBglghkgBhvhC
-AQ0ESRZHVG8gZ2V0IHlvdXIgb3duIGNlcnRpZmljYXRlIGZvciBGUkVFIGhlYWQg
-b3ZlciB0byBodHRwOi8vd3d3LmNhY2VydC5vcmcwDQYJKoZIhvcNAQEEBQADggIB
-ACjH7pyCArpcgBLKNQodgW+JapnM8mgPf6fhjViVPr3yBsOQWqy1YPaZQwGjiHCc
-nWKdpIevZ1gNMDY75q1I08t0AoZxPuIrA2jxNGJARjtT6ij0rPtmlVOKTV39O9lg
-18p5aTuxZZKmxoGCXJzN600BiqXfEVWqFcofN8CCmHBh22p8lqOOLlQ+TyGpkO/c
-gr/c6EWtTZBzCDyUZbAEmXZ/4rzCahWqlwQ3JNgelE5tDlG+1sSPypZt90Pf6DBl
-Jzt7u0NDY8RD97LsaMzhGY4i+5jhe1o+ATc7iwiwovOVThrLm82asduycPAtStvY
-sONvRUgzEv/+PDIqVPfE94rwiCPCR/5kenHA0R6mY7AHfqQv0wGP3J8rtsYIqQ+T
-SCX8Ev2fQtzzxD72V7DX3WnRBnc0CkvSyqD/HMaMyRa+xMwyN2hzXwj7UfdJUzYF
-CpUCTPJ5GhD22Dp1nPMd8aINcGeGG7MW9S/lpOt5hvk9C8JzC6WZrG/8Z7jlLwum
-GCSNe9FINSkYQKyTYOGWhlC0elnYjyELn8+CkcY7v2vcB5G5l1YjqrZslMZIBjzk
-zk6q5PYvCdxTby78dOs6Y5nCpqyJvKeyRKANihDjbPIky/qbn3BHLt4Ui9SyIAmW
-omTxJBzcoTWcFbLUvFUufQb1nA5V9FrWk9p2rSVzTMVD
------END CERTIFICATE-----

data/lib/figo.rb

@@ -21,8 +21,7 @@
 # 
 
 require "json"
-require "logger"
-require 'net/http/persistent'
+require "net/http/persistent"
 require "digest/sha1"
 require_relative "models.rb"
 
@@ -30,12 +29,9 @@ require_relative "models.rb"
 # Ruby bindings for the figo Connect API: http://developer.figo.me
 module Figo
 
-  $api_endpoint = "api.leanbank.com"
+  $api_endpoint = "api.figo.me"
 
-  $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"]
-
-  $logger = Logger.new(STDOUT)
+  $valid_fingerprints = ["3A:62:54:4D:86:B4:34:38:EA:34:64:4E:95:10:A9:FF:37:27:69:C0"]
 
   # Base class for all errors transported via the figo Connect API.
   class Error < RuntimeError
@@ -104,7 +100,6 @@ module Figo
         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
@@ -141,7 +136,7 @@ module Figo
       request.basic_auth(@client_id, @client_secret)
       request["Accept"] = "application/json"
       request["Content-Type"] = "application/x-www-form-urlencoded"
-      request['User-Agent'] =  "ruby-figo"
+      request["User-Agent"] =  "ruby-figo"
       request.body = URI.encode_www_form(data) unless data.nil?
 
       # Send HTTP request.
@@ -163,6 +158,7 @@ module Figo
     #        validated the authenticity of the call to the redirect URL
     # @param scope [String] optional scope of data access to ask the user for, 
     #        e.g. `accounts=ro`
+    # @return [String] the URL to be opened by the user.
     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?
@@ -179,7 +175,7 @@ module Figo
     # @param scope [String] optional scope of data access to ask the user for, 
     #        e.g. `accounts=ro`
     # @return [Hash] object with the keys `access_token`, `refresh_token` and 
-    #        `expires,` as documented in the figo Connect API specification.
+    #        `expires`, as documented in the figo Connect API specification.
     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"
@@ -196,7 +192,7 @@ module Figo
     #
     # @note this action has immediate effect, i.e. you will not be able use that token anymore after this call.
     #
-    # @param token [String] access or refresh token to be revoked
+    # @param refresh_token_or_access_token [String] access or refresh token to be revoked
     # @return [nil]
     def revoke_token(refresh_token_or_access_token)
       data = { "token" => refresh_token_or_access_token }
@@ -221,6 +217,7 @@ module Figo
     #
     # @param path [String] the URL path on the server
     # @param data [hash] this optional object will be used as JSON-encoded POST content.
+    # @param method [String] the HTTP method
     # @return [Hash] JSON response
     def query_api(path, data=nil, method="GET") # :nodoc:
       uri = URI("https://#{$api_endpoint}#{path}")
@@ -240,7 +237,7 @@ module Figo
       request["Authorization"] = "Bearer #{@access_token}"
       request["Accept"] = "application/json"
       request["Content-Type"] = "application/json"
-      request['User-Agent'] =  "ruby-figo"
+      request["User-Agent"] =  "ruby-figo"
       request.body = JSON.generate(data) unless data.nil?
 
       # Send HTTP request.
@@ -270,14 +267,14 @@ module Figo
     # @return [Account] account object
     def get_account(account_id)
       response = query_api("/rest/accounts/#{account_id}")
-      return Account.new(self, response)
+      return response.nil? ? nil : Account.new(self, response)
     end
 
     # Request list of transactions.
     #
-    # @param since [String] this parameter can either be a transaction ID or a date
+    # @param since [String, Date] this parameter can either be a transaction ID or a date
     # @param start_id [String] do only return transactions which were booked after the start transaction ID
-    # @param count [Intger] limit the number of returned transactions
+    # @param count [Integer] limit the number of returned transactions
     # @param include_pending [Boolean] this flag indicates whether pending transactions should be included 
     #        in the response; pending transactions are always included as a complete set, regardless of 
     #        the `since` parameter
@@ -294,7 +291,7 @@ module Figo
 
     # Request the URL a user should open in the web browser to start the synchronization process.
     #
-    # @param redirect_uri [String] URI the user is redirected to after the process completes
+    # @param redirect_uri [String] the user will be redirected to this URL after the process completes
     # @param state [String] this string will be passed on through the complete synchronization process 
     #        and to the redirect target at the end. It should be used to validated the authenticity of 
     #        the call to the redirect URL
@@ -338,13 +335,13 @@ module Figo
       return Notification.new(self, response)
     end
 
-    # Modify a notification.
+    # Modify notification.
     #
     # @param notification [Notification] modified notification object
     # @return [nil]
     def modify_notification(notification)
       data = { "observe_key" => notification.observe_key, "notify_uri" => notification.notify_uri, "state" => notification.state }
-      response = query_api("/rest/notifications/#{notification.notification_id}", data, "PUT")
+      query_api("/rest/notifications/#{notification.notification_id}", data, "PUT")
       return nil
     end
 

data/lib/models.rb

@@ -36,6 +36,7 @@ module Figo
     CREDIT_CARD = "Credit card"
     LOAN        = "Loan account"
     PAYPAL      = "PayPal"
+    CASH_BOOK   = "Cash book"
     UNKNOWN     = "Unknown"
   end
 
@@ -155,13 +156,13 @@ module Figo
 
     # Request list of transactions of this account.
     #
-    # @param since [String] this parameter can either be a transaction ID or a date
+    # @param since [String, Date] this parameter can either be a transaction ID or a date
     # @param start_id [String] do only return transactions which were booked after the start transaction ID
-    # @param count [Intger] limit the number of returned transactions
+    # @param count [Integer] limit the number of returned transactions
     # @param include_pending [Boolean] this flag indicates whether pending transactions should be included 
     #        in the response; pending transactions are always included as a complete set, regardless of 
     #        the `since` parameter
-    # @return [Array] an array of `Transaction` objects, one for each transaction of the user
+    # @return [Array] an array of `Transaction` objects, one for each transaction of this account
     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?
@@ -172,13 +173,13 @@ module Figo
       return response["transactions"].map {|transaction| Transaction.new(@session, transaction)}
     end
 
-    # Request a specific transaction.
+    # Request specific transaction.
     #
     # @param transaction_id [String] ID of the transaction to be retrieved
     # @return [Transaction] transaction object
     def transaction(transaction_id)
       response = @session.query_api("/rest/accounts/#{@account_id}/transactions/#{transaction_id}")
-      return Transaction.new(@session, response)
+      return response.nil? ? nil : Transaction.new(@session, response)
     end
 
   end
@@ -227,7 +228,7 @@ module Figo
     # @return [String]
     attr_accessor :account_number
 
-    # Bank code of originator or recipien.
+    # Bank code of originator or recipient.
     # @return [String]
     attr_accessor :bank_code
 

data/test/test_figo.rb

@@ -20,17 +20,12 @@
 # THE SOFTWARE.
 # 
 
-require "test/unit"
+require "minitest/autorun"
 require_relative "../lib/figo"
 
 
-class FigoTest < Test::Unit::TestCase
+class FigoTest < MiniTest::Unit::TestCase
 
-  def setup
-    $api_endpoint = "api.staging.figo.me"
-    $valid_fingerprints = ["AF:FF:C3:2A:45:13:86:FB:28:57:55:80:0A:58:23:C7:7A:70:B6:2D"]
-  end
-    
   def test_accounts
     sut = Figo::Session.new("ASHWLIkouP2O6_bgA2wWReRhletgWKHYjLqDaqb0LFfamim9RjexTo22ujRIP_cjLiRiSyQXyt2kM1eXU2XLFZQ0Hro15HikJQT_eNeT_9XQ")
 

metadata

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