aggcat 0.1.0 → 0.1.1

data/Gemfile

@@ -1,15 +1,13 @@
 source 'https://rubygems.org'
 
-gem 'oauth', '~> 0.4'
-gem 'nori', '~> 2.0'
-gem 'nokogiri', '~> 1.5'
-gem 'active_support', '~> 3.0'
-gem 'builder', '~> 3.2'
 gem 'rake'
 
 group :test do
   gem 'minitest'
   gem 'test-unit'
   gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
   gem 'webmock'
 end
+
+gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Aggcat
 [![Build Status](https://travis-ci.org/cloocher/aggcat.png)](https://travis-ci.org/cloocher/aggcat)
+[![Coverage Status](https://coveralls.io/repos/cloocher/aggcat/badge.png?branch=master)](https://coveralls.io/r/cloocher/aggcat)
+[![Gem Version](https://badge.fury.io/rb/aggcat.png)](http://badge.fury.io/rb/aggcat)
 
   Intuit Customer Account Data API client
 
@@ -78,6 +80,10 @@ Aggcat.delete_customer
 
 Please make sure to read Intuit's [Account Data API](http://docs.developer.intuit.com/0020_Aggregation_Categorization_Apps/AggCat_API/0020_API_Documentation) docs.
 
+## Requirements
+
+* Ruby 1.9.2 or higher
+
 ## Copyright
 Copyright (c) 2013 Gene Drabkin.
 See [LICENSE][] for details.

data/lib/aggcat/base.rb

@@ -23,8 +23,6 @@ module Aggcat
 
     TIMEOUT = 120
 
-    IGNORE_KEYS = Set.new([:'@xmlns', :'@xmlns:ns2', :'@xmlns:ns3', :'@xmlns:ns4', :'@xmlns:ns5', :'@xmlns:ns6', :'@xmlns:ns7', :'@xmlns:ns8', :'@xmlns:ns9'])
-
     protected
 
     def oauth_client
@@ -61,7 +59,7 @@ module Aggcat
     def saml_message(user_id)
       now = Time.now.utc
       reference_id = SecureRandom.uuid.gsub('-', '')
-      assertion = %[<?xml version="1.0" encoding="UTF-8"?><saml2:Assertion xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" ID="_#{reference_id}" IssueInstant="#{iso8601(now)}" Version="2.0"><saml2:Issuer>#{@issuer_id}</saml2:Issuer><ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><ds:Reference URI="#_#{reference_id}"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><ds:DigestValue>%%DIGEST%%</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>%%SIGNATURE%%</ds:SignatureValue></ds:Signature><saml2:Subject><saml2:NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified">#{user_id}</saml2:NameID><saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"/></saml2:Subject><saml2:Conditions NotBefore="#{iso8601(now-5*60)}" NotOnOrAfter="#{iso8601(now+10*60)}"><saml2:AudienceRestriction><saml2:Audience>#{@issuer_id}</saml2:Audience></saml2:AudienceRestriction></saml2:Conditions><saml2:AuthnStatement AuthnInstant="#{iso8601(now)}" SessionIndex="_#{reference_id}"><saml2:AuthnContext><saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified</saml2:AuthnContextClassRef></saml2:AuthnContext></saml2:AuthnStatement></saml2:Assertion>]
+      assertion = %[<?xml version="1.0" encoding="UTF-8"?><saml2:Assertion xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" ID="_#{reference_id}" IssueInstant="#{iso8601(now)}" Version="2.0"><saml2:Issuer>#{@issuer_id}</saml2:Issuer><ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><ds:Reference URI="#_#{reference_id}"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><ds:DigestValue>%s</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>%s</ds:SignatureValue></ds:Signature><saml2:Subject><saml2:NameID Format="urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified">#{user_id}</saml2:NameID><saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"/></saml2:Subject><saml2:Conditions NotBefore="#{iso8601(now-5*60)}" NotOnOrAfter="#{iso8601(now+10*60)}"><saml2:AudienceRestriction><saml2:Audience>#{@issuer_id}</saml2:Audience></saml2:AudienceRestriction></saml2:Conditions><saml2:AuthnStatement AuthnInstant="#{iso8601(now)}" SessionIndex="_#{reference_id}"><saml2:AuthnContext><saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified</saml2:AuthnContextClassRef></saml2:AuthnContext></saml2:AuthnStatement></saml2:Assertion>]
       doc = Nokogiri::XML(assertion)
       doc.xpath('//ds:Signature', 'ds' => 'http://www.w3.org/2000/09/xmldsig#').remove
       doc.xpath('//text()[not(normalize-space())]').remove
@@ -71,7 +69,7 @@ module Aggcat
       signature_value = Nokogiri::XML(signed_info).canonicalize
       key = OpenSSL::PKey::RSA.new(File.read(@certificate_path))
       encoded_signature_value = Base64.encode64(key.sign(OpenSSL::Digest::SHA1.new, signature_value)).gsub!(/\n/, '')
-      Base64.encode64(assertion.gsub(/%%DIGEST%%/, encoded_digest).gsub(/%%SIGNATURE%%/, encoded_signature_value))
+      Base64.encode64(assertion % [encoded_digest, encoded_signature_value])
     end
 
     def iso8601(time)
@@ -88,7 +86,7 @@ module Aggcat
 
     def cleanup(hash)
       hash.each do |k, v|
-        if IGNORE_KEYS.include?(k)
+        if k.to_s[/^@xmlns/]
           hash.delete(k)
         elsif v.respond_to?(:keys)
           cleanup(v)

data/lib/aggcat/version.rb

@@ -1,3 +1,3 @@
 module Aggcat
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/test/aggcat/aggcat_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class AggcatTest < Test::Unit::TestCase
+  def setup
+    Aggcat.configure do |config|
+      config.issuer_id = 'issuer_id'
+      config.consumer_key = 'consumer_key'
+      config.consumer_secret = 'consumer_secret'
+      config.certificate_path = "#{fixture_path}/cert.key"
+    end
+  end
+
+  def test_configure
+    configurable = Aggcat.configure do |config|
+      config.issuer_id = 'issuer_id'
+      config.consumer_key = 'consumer_key'
+      config.consumer_secret = 'consumer_secret'
+      config.certificate_path = "#{fixture_path}/cert.key"
+    end
+    assert_equal 'issuer_id', configurable.instance_variable_get(:'@issuer_id')
+    assert_equal 'consumer_key', configurable.instance_variable_get(:'@consumer_key')
+    assert_equal 'consumer_secret', configurable.instance_variable_get(:'@consumer_secret')
+    assert_equal "#{fixture_path}/cert.key", configurable.instance_variable_get(:'@certificate_path')
+  end
+
+  def test_scope
+    client1 = Aggcat.scope('1')
+    assert_true client1.is_a?(Aggcat::Client)
+    assert_equal 'issuer_id', client1.instance_variable_get(:'@issuer_id')
+    assert_equal 'consumer_key', client1.instance_variable_get(:'@consumer_key')
+    assert_equal 'consumer_secret', client1.instance_variable_get(:'@consumer_secret')
+    assert_equal "#{fixture_path}/cert.key", client1.instance_variable_get(:'@certificate_path')
+    assert_equal '1', client1.instance_variable_get(:'@customer_id')
+    client2 = Aggcat.client
+    assert_equal client1, client2
+    client3 = Aggcat.scope('1')
+    assert_equal client1, client3
+    client4 = Aggcat.scope('2')
+    assert_not_equal client1, client4
+  end
+
+  def test_no_scope
+    exception = assert_raise(ArgumentError) { Aggcat.scope(nil) }
+    assert_equal('customer_id is required for scoping all requests', exception.message)
+  end
+
+  def test_client_api
+    stub_request(:post, Aggcat::Base::SAML_URL).to_return(:status => 200, :body => fixture('oauth_token.txt'))
+    Aggcat.scope('1')
+    stub_get('/institutions').to_return(:body => fixture('institutions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    response = Aggcat.institutions
+    assert_equal response[:response][:institutions][:institution][0][:institution_id].to_i, 100000
+  end
+end

data/test/aggcat/client_test.rb

@@ -27,9 +27,10 @@ class ClientTest < Test::Unit::TestCase
     assert_equal institution_id, response[:response][:institution_detail][:institution_id]
   end
 
-  def test_institution_with_bad_id
-    institution_id = '100000'
-    stub_get("/institutions/#{institution_id}").to_return(:body => fixture('institution.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+  def test_institution_with_bad_args
+    exception = assert_raise(ArgumentError) { @client.institution(nil) }
+    assert_equal('institution_id is required', exception.message)
+
     exception = assert_raise(ArgumentError) { @client.institution('') }
     assert_equal('institution_id is required', exception.message)
   end
@@ -43,6 +44,35 @@ class ClientTest < Test::Unit::TestCase
     assert_equal '000000000001', response[:response][:account_list][:banking_account][:account_id]
   end
 
+  def test_discover_and_add_accounts_with_challenge
+    institution_id = '100000'
+    stub_get("/institutions/#{institution_id}").to_return(:body => fixture('institution.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    stub_post("/institutions/#{institution_id}/logins").to_return(:code => 401, :body => fixture('account.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    response = @client.discover_and_add_accounts(institution_id, 'username', 'password')
+    assert_equal institution_id, response[:response][:account_list][:banking_account][:institution_id]
+    assert_equal '000000000001', response[:response][:account_list][:banking_account][:account_id]
+  end
+
+  def test_discover_and_add_accounts_bad_args
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(nil, 'username', 'password') }
+    assert_equal('institution_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts('', 'username', 'password') }
+    assert_equal('institution_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(1, nil, 'password') }
+    assert_equal('username is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(1, '', 'password') }
+    assert_equal('username is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(1, 'username', nil) }
+    assert_equal('password is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(1, 'username', '') }
+    assert_equal('password is required', exception.message)
+  end
+
   def test_account
     account_id = '000000000001'
     stub_get("/accounts/#{account_id}").to_return(:body => fixture('account.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
@@ -50,6 +80,14 @@ class ClientTest < Test::Unit::TestCase
     assert_equal account_id, response[:response][:account_list][:banking_account][:account_id]
   end
 
+  def test_account_bad_args
+    exception = assert_raise(ArgumentError) { @client.account(nil) }
+    assert_equal('account_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.account('') }
+    assert_equal('account_id is required', exception.message)
+  end
+
   def test_accounts
     stub_get('/accounts').to_return(:body => fixture('accounts.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
     response = @client.accounts
@@ -62,8 +100,36 @@ class ClientTest < Test::Unit::TestCase
     start_date = Date.today - 30
     uri = "/accounts/#{account_id}/transactions?txnStartDate=#{start_date.strftime(Aggcat::Base::DATE_FORMAT)}"
     stub_get(uri).to_return(:body => fixture('transactions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
-    response = @client.account_transactions(account_id, Date.today - 30)
+    response = @client.account_transactions(account_id, start_date)
+    assert_equal '75000088503', response[:response][:transaction_list][:credit_card_transaction][:id]
+  end
+
+  def test_account_transactions_with_dates
+    account_id = '000000000001'
+    end_date = Date.today
+    start_date = end_date - 30
+    challenge_session_id = '1234'
+    challenge_node_id = '4321'
+    uri = "/accounts/#{account_id}/transactions?txnStartDate=#{start_date.strftime(Aggcat::Base::DATE_FORMAT)}&txnEndDate=#{end_date.strftime(Aggcat::Base::DATE_FORMAT)}"
+    stub_get(uri).to_return(:body => fixture('transactions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8', :challengeSessionId => challenge_session_id, :challengeNodeId => challenge_node_id})
+    response = @client.account_transactions(account_id, start_date, end_date)
     assert_equal '75000088503', response[:response][:transaction_list][:credit_card_transaction][:id]
+    assert_equal response[:challenge_session_id], challenge_session_id
+    assert_equal response[:challenge_node_id], challenge_node_id
+  end
+
+  def test_account_transactions_bad_args
+    exception = assert_raise(ArgumentError) { @client.account_transactions(nil, Date.today) }
+    assert_equal('account_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.account_transactions('', Date.today) }
+    assert_equal('account_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.account_transactions(1, nil) }
+    assert_equal('start_date is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.account_transactions(1, '') }
+    assert_equal('start_date is required', exception.message)
   end
 
   def test_delete_account
@@ -73,6 +139,14 @@ class ClientTest < Test::Unit::TestCase
     assert_equal '200', response[:response_code]
   end
 
+  def test_delete_account_bad_args
+    exception = assert_raise(ArgumentError) { @client.delete_account(nil) }
+    assert_equal('account_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.delete_account('') }
+    assert_equal('account_id is required', exception.message)
+  end
+
   def test_delete_customer
     stub_delete('/customers').to_return(:status => 200)
     response = @client.delete_customer
@@ -88,4 +162,57 @@ class ClientTest < Test::Unit::TestCase
     assert_equal '200', response[:response_code]
   end
 
+  def test_update_login_bad_args
+    exception = assert_raise(ArgumentError) { @client.update_login(nil, 1, 'username', 'password') }
+    assert_equal('institution_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login('', 1, 'username', 'password') }
+    assert_equal('institution_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, nil, 'username', 'password') }
+    assert_equal('login_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, '', 'username', 'password') }
+    assert_equal('login_id is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, 1, nil, 'password') }
+    assert_equal('username is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, 1, '', 'password') }
+    assert_equal('username is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, 1, 'username', nil) }
+    assert_equal('password is required', exception.message)
+
+    exception = assert_raise(ArgumentError) { @client.update_login(1, 1, 'username', '') }
+    assert_equal('password is required', exception.message)
+  end
+
+
+  def test_account_confirmation
+    institution_id = '100000'
+    challenge_session_id = '1234'
+    challenge_node_id = '4321'
+    answer = 'answer'
+    parser = Nori.new(:parser => :nokogiri, :strip_namespaces => true, :convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
+    stub_get("/institutions/#{institution_id}").to_return(:body => fixture('institution.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    stub_post("/institutions/#{institution_id}/logins").to_return(:body => lambda { |request| assert_equal(parser.parse(fixture('challenge.xml').read), parser.parse(request.body)) })
+    @client.account_confirmation(institution_id, challenge_session_id, challenge_node_id, answer)
+  end
+
+  def test_update_login_confirmation
+    login_id = '1234567890'
+    challenge_session_id = '1234'
+    challenge_node_id = '4321'
+    answer = 'answer'
+    validator = lambda do |request|
+      parser = Nori.new(:parser => :nokogiri, :strip_namespaces => true, :convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
+      assert_equal(parser.parse(fixture('challenge.xml').read), parser.parse(request.body))
+      assert_equal(challenge_session_id, request.headers['Challengesessionid'])
+      assert_equal(challenge_node_id, request.headers['Challengenodeid'])
+    end
+    stub_put("/logins/#{login_id}?refresh=true").to_return(:body => validator)
+    @client.update_login_confirmation(login_id, challenge_session_id, challenge_node_id, answer)
+  end
+
 end

data/test/fixtures/challenge.xml

@@ -0,0 +1,5 @@
+<InstitutionLogin xmlns:v1="http://schema.intuit.com/platform/fdatafeed/institutionlogin/v1">
+  <challengeResponses>
+    <response xmlns:v11="http://schema.intuit.com/platform/fdatafeed/challenge/v1">answer</response>
+  </challengeResponses>
+</InstitutionLogin>

data/test/test_helper.rb

@@ -2,12 +2,20 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 SimpleCov.start
 
 require 'webmock/test_unit'
 require 'test/unit'
 require 'aggcat'
 
+WebMock.disable_net_connect!(:allow => 'coveralls.io')
+
 def stub_delete(path)
   stub_request(:delete, Aggcat::Client::BASE_URL + path)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aggcat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -142,10 +142,12 @@ files:
 - lib/aggcat/client.rb
 - lib/aggcat/configurable.rb
 - lib/aggcat/version.rb
+- test/aggcat/aggcat_test.rb
 - test/aggcat/client_test.rb
 - test/fixtures/account.xml
 - test/fixtures/accounts.xml
 - test/fixtures/cert.key
+- test/fixtures/challenge.xml
 - test/fixtures/institution.xml
 - test/fixtures/institutions.xml
 - test/fixtures/login.xml
@@ -178,10 +180,12 @@ signing_key:
 specification_version: 3
 summary: Intuit Customer Account Data API client
 test_files:
+- test/aggcat/aggcat_test.rb
 - test/aggcat/client_test.rb
 - test/fixtures/account.xml
 - test/fixtures/accounts.xml
 - test/fixtures/cert.key
+- test/fixtures/challenge.xml
 - test/fixtures/institution.xml
 - test/fixtures/institutions.xml
 - test/fixtures/login.xml