aggcat 0.4.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0c6e9b22ff49963c78a07302e83aaa846abd8a
-  data.tar.gz: d9912a2c3d68bc93fe7ef90790eba73340a825ab
+  metadata.gz: 04cae6d196e8a35478b7c0264578977c7a8c3b24
+  data.tar.gz: 9488dfe842aced92961c1c7833ed982683633c81
 SHA512:
-  metadata.gz: c74e838e70a3b0564cafe8be97e5fbe321d12d7742992bbc9fa36438f79c9cd94f553a3e9084c7df0ca4cbc15569dd03477bfd3a49ad2fbd1d5bb4b5da6b0fe6
-  data.tar.gz: 9ca6d14fc9a46972c397046a8f66222de4f6a323d2c3b0a2d109a7d49633a17817ab9465106bac5b1024d2384815e34d4fbfd006b1390809554989bdde77fd46
+  metadata.gz: 520b7105368d998757a51606ae920dd19c26aecfed002889c4108b1daa52a00fb8d40dfad59f8c3e6130b73f1ed371316d5a6c74ba5e7598b353c67612d3f94e
+  data.tar.gz: d9dd0219d569e94069be492157f3bf01d3163b77a2ef86595df2086e7badd3ed7d464e0c4d9b3343b74b4780ecd27a60ad15b9b19b8348694e1ba6d92403ae15

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.0
+ruby-2.2.3

data/.travis.yml

@@ -6,7 +6,8 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
-  - 2.2.0
+  - 2.2.4
+  - 2.3.0
 script:
   - gem build aggcat.gemspec
   - gem install aggcat-*

data/README.md

@@ -36,6 +36,7 @@ Aggcat.configure do |config|
   config.consumer_key = 'your consumer key'
   config.consumer_secret = 'your consumer secret'
   config.certificate_path = '/path/to/your/certificate/key'
+  config.verbose = false # verpose = true will output all raw XML API requests/responses to STDOUT
   # certificate could be provided as a string instead of a path to a file using certificate_value
   # certificate_value takes precedence over certificate_path
   # certificate_value should contain newline characters as appropriate

data/aggcat.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.required_rubygems_version = '>= 1.3.6'
 
   spec.add_dependency 'oauth', '>= 0.4'
-  spec.add_dependency 'xmlhasher'
+  spec.add_dependency 'xmlhasher', '>= 1.0.2'
   spec.add_dependency 'builder', '>= 3.0'
   spec.add_dependency 'activesupport', '>= 3.2'
 

data/lib/aggcat/base.rb

@@ -54,7 +54,7 @@ module Aggcat
     end
 
     def new_token(message)
-      uri = URI.parse(SAML_URL)
+      uri = URI.parse(@oauth_url)
       http = Net::HTTP.new(uri.host, uri.port)
       request = Net::HTTP::Post.new(uri.request_uri)
       request['Authorization'] = %[OAuth oauth_consumer_key="#{@consumer_key}"]
@@ -77,7 +77,7 @@ module Aggcat
       signature_value = Base64.encode64(key.sign(OpenSSL::Digest::SHA1.new(nil), signed_info)).gsub(/\n/, '')
       signature = %[<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_value}</ds:SignatureValue></ds:Signature>]
       assertion_with_signature = assertion.sub(/saml2:Issuer\>\<saml2:Subject/, "saml2:Issuer>#{signature}<saml2:Subject")
-      Base64.encode64(assertion_with_signature)
+      Base64.strict_encode64(assertion_with_signature)
     end
 
     def certificate
@@ -90,6 +90,7 @@ module Aggcat
 
     def parse_xml(data)
       return data if data.nil? || data.to_s.empty?
+      $stdout.puts(data) if @verbose
       @parser ||= XmlHasher::Parser.new(snakecase: true, ignore_namespaces: true)
       @parser.parse(data)
     end

data/lib/aggcat/client.rb

@@ -5,6 +5,8 @@ module Aggcat
 
     def initialize(options={})
       raise ArgumentError.new('customer_id is required for scoping all requests') if options[:customer_id].nil? || options[:customer_id].to_s.empty?
+      options[:oauth_url] ||= SAML_URL
+      options[:base_url] ||= BASE_URL
       options[:open_timeout] ||= OPEN_TIMEOUT
       options[:read_timeout] ||= READ_TIMEOUT
       options[:verbose] ||= false
@@ -115,7 +117,7 @@ module Aggcat
     def request(http_method, path, *options)
       tries = 0
       begin
-        response = oauth_client.send(http_method, BASE_URL + path, *options)
+        response = oauth_client.send(http_method, @base_url + path, *options)
         result = {:status_code => response.code, :result => parse_xml(response.body)}
         if response['challengeSessionId']
           result[:challenge_session_id] = response['challengeSessionId']
@@ -140,7 +142,9 @@ module Aggcat
 
     def credentials(institution_id, login_credentials)
       institution = institution(institution_id)
-      raise ArgumentError.new("institution_id #{institution_id} is invalid") if institution.nil? || institution[:result].nil? || institution[:result][:institution_detail].nil?
+      if institution.nil? || institution[:result].nil? || institution[:result][:institution_detail].nil?
+        raise ArgumentError.new(institution[:result][:status][:error_info][:error_message])
+      end
       login_keys = institution[:result][:institution_detail][:keys][:key].select { |key| key[:display_flag] == 'true' }.sort { |a, b| a[:display_order].to_i <=> b[:display_order].to_i }
       if login_keys.length != login_credentials.length
         raise ArgumentError.new("institution_id #{institution_id} requires #{login_keys.length} credential fields but was given #{login_credentials.length} to authenticate with.")
@@ -198,5 +202,3 @@ module Aggcat
     end
   end
 end
-
-

data/lib/aggcat/configurable.rb

@@ -1,7 +1,7 @@
 module Aggcat
   module Configurable
 
-    KEYS = [:issuer_id, :consumer_key, :consumer_secret, :certificate_value, :certificate_password, :certificate_path, :customer_id, :open_timeout, :read_timeout, :verbose]
+    KEYS = [:oauth_url, :base_url, :issuer_id, :consumer_key, :consumer_secret, :certificate_value, :certificate_password, :certificate_path, :customer_id, :open_timeout, :read_timeout, :verbose]
 
     attr_writer *KEYS
 

data/lib/aggcat/version.rb

@@ -1,3 +1,3 @@
 module Aggcat
-  VERSION = '0.4.0'
+  VERSION = '1.0.1'
 end

data/test/aggcat/aggcat_test.rb

@@ -1,8 +1,13 @@
 require 'test_helper'
 
 class AggcatTest < Test::Unit::TestCase
+  OAUTH_URL = Aggcat::Base::SAML_URL
+  BASE_URL = Aggcat::Client::BASE_URL
+
   def setup
     Aggcat.configure do |config|
+      config.oauth_url = OAUTH_URL
+      config.base_url = BASE_URL
       config.issuer_id = 'issuer_id'
       config.consumer_key = 'consumer_key'
       config.consumer_secret = 'consumer_secret'
@@ -12,6 +17,8 @@ class AggcatTest < Test::Unit::TestCase
 
   def test_configure
     configurable = Aggcat.configure do |config|
+      config.oauth_url = OAUTH_URL
+      config.base_url = BASE_URL
       config.issuer_id = 'issuer_id'
       config.consumer_key = 'consumer_key'
       config.consumer_secret = 'consumer_secret'
@@ -19,6 +26,8 @@ class AggcatTest < Test::Unit::TestCase
       config.open_timeout = 5
       config.read_timeout = 30
     end
+    assert_equal OAUTH_URL, configurable.instance_variable_get(:'@oauth_url')
+    assert_equal BASE_URL, configurable.instance_variable_get(:'@base_url')
     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')
@@ -30,6 +39,8 @@ class AggcatTest < Test::Unit::TestCase
   def test_configure_certificate_by_value
     cert_value = File.read("#{fixture_path}/cert.key")
     configurable = Aggcat.configure do |config|
+      config.oauth_url = OAUTH_URL
+      config.base_url = BASE_URL
       config.issuer_id = 'issuer_id'
       config.consumer_key = 'consumer_key'
       config.consumer_secret = 'consumer_secret'
@@ -37,6 +48,8 @@ class AggcatTest < Test::Unit::TestCase
       config.open_timeout = 5
       config.read_timeout = 30
     end
+    assert_equal OAUTH_URL, configurable.instance_variable_get(:'@oauth_url')
+    assert_equal BASE_URL, configurable.instance_variable_get(:'@base_url')
     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')
@@ -48,12 +61,16 @@ class AggcatTest < Test::Unit::TestCase
   def test_configure_certificate_with_password
     cert_value = File.read("#{fixture_path}/cert.key")
     configurable = Aggcat.configure do |config|
+      config.oauth_url = OAUTH_URL
+      config.base_url = BASE_URL
       config.issuer_id = 'issuer_id'
       config.consumer_key = 'consumer_key'
       config.consumer_secret = 'consumer_secret'
       config.certificate_value = cert_value
       config.certificate_password = 'cert_password'
     end
+    assert_equal OAUTH_URL, configurable.instance_variable_get(:'@oauth_url')
+    assert_equal BASE_URL, configurable.instance_variable_get(:'@base_url')
     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')
@@ -64,6 +81,8 @@ class AggcatTest < Test::Unit::TestCase
   def test_scope
     client1 = Aggcat.scope('1')
     assert_true client1.is_a?(Aggcat::Client)
+    assert_equal OAUTH_URL, client1.instance_variable_get(:'@oauth_url')
+    assert_equal BASE_URL, client1.instance_variable_get(:'@base_url')
     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')
@@ -83,7 +102,7 @@ class AggcatTest < Test::Unit::TestCase
   end
 
   def test_client_api
-    stub_request(:post, Aggcat::Base::SAML_URL).to_return(:status => 200, :body => fixture('oauth_token.txt'))
+    stub_request(:post, OAUTH_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

data/test/aggcat/client_test.rb

@@ -1,8 +1,14 @@
 require 'test_helper'
 
 class ClientTest < Test::Unit::TestCase
+  INTUIT_OAUTH_URL = Aggcat::Base::SAML_URL
+  INTUIT_BASE_URL = Aggcat::Client::BASE_URL
+
+  FINICITY_OAUTH_URL = 'https://api.finicity.com/oauth/v1/get_access_token_by_saml'
+  FINICITY_BASE_URL = 'https://api.finicity.com/financialdatafeed/v1'
+
   def setup
-    stub_request(:post, Aggcat::Base::SAML_URL).to_return(:status => 200, :body => fixture('oauth_token.txt'))
+    stub_request(:post, INTUIT_OAUTH_URL).to_return(:status => 200, :body => fixture('oauth_token.txt'))
     @client = Aggcat::Client.new(
         {
             issuer_id: 'issuer_id',
@@ -12,20 +18,53 @@ class ClientTest < Test::Unit::TestCase
             customer_id: 'default'
         }
     )
+
+    stub_request(:post, FINICITY_OAUTH_URL).to_return(:status => 200, :body => fixture('oauth_token.txt'))
+    @finicity_client = Aggcat::Client.new(
+        {
+            oauth_url: FINICITY_OAUTH_URL,
+            base_url: FINICITY_BASE_URL,
+            issuer_id: 'issuer_id',
+            consumer_key: 'consumer_key',
+            consumer_secret: 'consumer_secret',
+            certificate_path: "#{fixture_path}/cert.key",
+            customer_id: 'default'
+        }
+    )
   end
 
-  def test_arguments
-    assert_equal 'issuer_id', @client.instance_variable_get(:'@issuer_id')
-    assert_equal 'consumer_key', @client.instance_variable_get(:'@consumer_key')
-    assert_equal 'consumer_secret', @client.instance_variable_get(:'@consumer_secret')
-    assert_equal "#{fixture_path}/cert.key", @client.instance_variable_get(:'@certificate_path')
-    assert_equal 'default', @client.instance_variable_get(:'@customer_id')
-    assert_equal false, @client.instance_variable_get(:'@verbose')
+  def test_intuit_arguments
+    assert_equal INTUIT_OAUTH_URL, @client.instance_variable_get(:'@oauth_url')
+    assert_equal INTUIT_BASE_URL, @client.instance_variable_get(:'@base_url')
+    check_arguments @client
+  end
+
+  def test_finicity_arguments
+    assert_equal FINICITY_OAUTH_URL, @finicity_client.instance_variable_get(:'@oauth_url')
+    assert_equal FINICITY_BASE_URL, @finicity_client.instance_variable_get(:'@base_url')
+    check_arguments @finicity_client
+  end
+
+  def check_arguments(client)
+    assert_equal 'issuer_id', client.instance_variable_get(:'@issuer_id')
+    assert_equal 'consumer_key', client.instance_variable_get(:'@consumer_key')
+    assert_equal 'consumer_secret', client.instance_variable_get(:'@consumer_secret')
+    assert_equal "#{fixture_path}/cert.key", client.instance_variable_get(:'@certificate_path')
+    assert_equal 'default', client.instance_variable_get(:'@customer_id')
+    assert_equal false, client.instance_variable_get(:'@verbose')
   end
 
   def test_institutions
-    stub_get('/institutions').to_return(:body => fixture('institutions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
-    response = @client.institutions
+    check_institutions INTUIT_BASE_URL, @client
+  end
+
+  def test_finicity_institutions
+    check_institutions FINICITY_BASE_URL, @finicity_client
+  end
+
+  def check_institutions(base_url, client)
+    stub_request(:get, base_url + '/institutions').to_return(:body => fixture('institutions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    response = client.institutions
     assert_equal response[:result][:institutions][:institution][0][:institution_id].to_i, 100000
   end
 
@@ -318,8 +357,16 @@ class ClientTest < Test::Unit::TestCase
     account_id = '000000000001'
     stub_get("/accounts/#{account_id}/positions").to_return(:body => fixture('positions.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
     response = @client.investment_positions(account_id)
-    assert_equal response[:result][:investment_positions][:position][0][:investment_position_id].to_i , 000000000001
-    assert_equal response[:result][:investment_positions][:position][1][:investment_position_id].to_i , 000000000002
+    assert_equal response[:result][:investment_positions][:position][0][:investment_position_id].to_i, 000000000001
+    assert_equal response[:result][:investment_positions][:position][1][:investment_position_id].to_i, 000000000002
+  end
+
+  def test_max_customers_reached
+    institution_id = '100000'
+    stub_get("/institutions/#{institution_id}").to_return(:body => fixture('max_customers_reached.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    stub_post("/institutions/#{institution_id}/logins").to_return(:body => fixture('max_customers_reached.xml'), :headers => {:content_type => 'application/xml; charset=utf-8'})
+    exception = assert_raise(ArgumentError) { @client.discover_and_add_accounts(institution_id, 'username', 'password') }
+    assert_equal('The offering has reached the maximum number of customers allowed.', exception.message)
   end
 
 end

data/test/fixtures/max_customers_reached.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<Status xmlns="http://schema.intuit.com/platform/fdatafeed/common/v1">
+  <errorInfo>
+    <errorType>APP_ERROR</errorType>
+    <errorCode>api.max.customers</errorCode>
+    <errorMessage>The offering has reached the maximum number of customers allowed.</errorMessage>
+    <correlationId>gw-49b48b84-8962-46af-9116-fdaf4fe5ac9e</correlationId>
+  </errorInfo>
+</Status>

data/test/test_helper.rb

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'simplecov'
 require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aggcat
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Gene Drabkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +113,7 @@ files:
 - test/fixtures/institution_three_credentials.xml
 - test/fixtures/institutions.xml
 - test/fixtures/login.xml
+- test/fixtures/max_customers_reached.xml
 - test/fixtures/oauth_token.txt
 - test/fixtures/positions.xml
 - test/fixtures/transactions.xml
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for Intuit Customer Account Data APIs
@@ -154,6 +155,7 @@ test_files:
 - test/fixtures/institution_three_credentials.xml
 - test/fixtures/institutions.xml
 - test/fixtures/login.xml
+- test/fixtures/max_customers_reached.xml
 - test/fixtures/oauth_token.txt
 - test/fixtures/positions.xml
 - test/fixtures/transactions.xml