aggcat 0.0.3 → 0.0.4

data/README.md

@@ -21,42 +21,45 @@ gem 'aggcat'
 ```ruby
 require 'aggcat'
 
-# configure Aggcat
+# Aggcat global configuration
 Aggcat.configure do |config|
-  config.issuer_id = YOUR_ISSUER_ID
-  config.consumer_key = YOUR_CONSUMER_KEY
-  config.consumer_secret = YOUR_CONSUMER_SECRET
+  config.issuer_id = 'your issuer id'
+  config.consumer_key = 'your consumer key'
+  config.consumer_secret = 'your consumer secret'
   config.certificate_path = '/path/to/your/certificate/key'
 end
 
-# create client
-client = Aggcat.client
+# alternatively, specify configuration options when instantiating an Aggcat::Client
+client = Aggcat::Client.new(
+  issuer_id: 'your issuer id',
+  consumer_key: 'your consumer key',
+  consumer_secret: 'your consumer secret',
+  certificate_path: '/path/to/your/certificate/key'
+)
 
 # get all supported financial institutions
-client.institutions
-=> {:response_code=>"200", :response=>{:institutions=>{:institution=>[{:institution_id=>"8860", :institution_name=>"Carolina Foothills FCU Credit Card", :home_url=>"http://www.cffcu.org/index.html", :phone_number=>"1-864-585-6838", :virtual=>false},
+Aggcat.institutions
 
 # get details for Bank of America
-client.institution(14007)
-=> {:response_code=>"200", :response=>{:institution_detail=>{:institution_id=>"14007", :institution_name=>"Bank of America", :home_url=>"https://www.bankofamerica.com/", :phone_number=>"1-800-792-0808", :address=>{:address1=>"307 S. MAIN", :city=>"Charlotte", :state=>"NC", :postal_code=>"28255", :country=>"USA"}, :email_address=>"https://www.bankofamerica.com/contact/", :special_text=>"Please enter your Bank of America Online ID and Passcode required for login.", :currency_code=>"USD", :keys=>{:key=>[{:name=>"TAX_AGGR_ENABLED", :val=>"FALSE", :status=>"Active", :display_flag=>false, :display_order=>"20", :mask=>false}, {:name=>"passcode", :status=>"Active", :value_length_max=>"20", :display_flag=>true, :display_order=>"2", :mask=>true, :description=>"Passcode"}, {:name=>"onlineID", :status=>"Active", :value_length_max=>"32", :display_flag=>true, :display_order=>"1", :mask=>false, :description=>"Online ID"}]}}}}
+Aggcat.institution(14007)
 
 # add new financial account to aggregate from Bank of America
-client.discover_and_add_accounts(14007, username, password)
+Aggcat.discover_and_add_accounts(14007, username, password)
 
-# get one financial account
-client.account(account_id)
+# get already aggregated financial account
+Aggcat.account(account_id)
 
 # get all aggregated accounts
-client.accounts
+Aggcat.accounts
 
 # delete account
-client.delete_account(account_id)
+Aggcat.delete_account(account_id)
 
 # get account transactions
-client.account_transactions(account_id, start_date, end_date)
+Aggcat.account_transactions(account_id, start_date, end_date)
 
 # delete all aggregated customers
-client.delete_customers
+Aggcat.delete_customers
 
 ```
 

data/lib/aggcat/client.rb

@@ -14,10 +14,12 @@ module Aggcat
     end
 
     def institution(institution_id)
+      validate(institution_id: institution_id)
       get("/institutions/#{institution_id}")
     end
 
     def discover_and_add_accounts(institution_id, username, password)
+      validate(institution_id: institution_id, username: username, password: password)
       body = credentials(institution_id, username, password)
       post("/institutions/#{institution_id}/logins", body, {user_id: "#{institution_id}-#{username}"})
     end
@@ -27,21 +29,21 @@ module Aggcat
     end
 
     def account(account_id)
+      validate(account_id: account_id)
       get("/accounts/#{account_id}")
     end
 
-    def account_transactions(account_id, start_date = nil, end_date = nil)
-      uri = "/accounts/#{account_id}/transactions"
-      if start_date
-        uri += "?txnStartDate=#{start_date.strftime(DATE_FORMAT)}"
-        if end_date
-          uri += "&txnEndDate=#{end_date.strftime(DATE_FORMAT)}"
-        end
+    def account_transactions(account_id, start_date, end_date = nil)
+      validate(account_id: account_id, start_date: start_date)
+      uri = "/accounts/#{account_id}/transactions?txnStartDate=#{start_date.strftime(DATE_FORMAT)}"
+      if end_date
+        uri += "&txnEndDate=#{end_date.strftime(DATE_FORMAT)}"
       end
       get(uri)
     end
 
     def delete_account(account_id)
+      validate(account_id: account_id)
       delete("/accounts/#{account_id}")
     end
 
@@ -73,6 +75,14 @@ module Aggcat
 
     private
 
+    def validate(args)
+      args.each do |name, value|
+        if value.nil? || value.to_s.empty?
+          raise ArgumentError, "#{name} is required"
+        end
+      end
+    end
+
     def credentials(institution_id, username, password)
       institution = institution(institution_id)
       keys = institution[:response][:institution_detail][:keys][:key].sort { |a, b| a[:display_order] <=> b[:display_order] }

data/lib/aggcat/version.rb

@@ -1,3 +1,3 @@
 module Aggcat
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aggcat
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: