capital_one 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa8bdefb2ec0e1cbb42ae29b7c16a9a0e5797267
-  data.tar.gz: 352fe4394dd839a985f051b4ccbd351c8e7129ae
+  metadata.gz: 37266853addb740e2d6e646c3f97aad6e51d7d43
+  data.tar.gz: ce2878b48b6a415b71071b810fdfc73c1b062c2c
 SHA512:
-  metadata.gz: 1500cda5cd763356625a5c8f0090b0cefa7be14a9053bb67715c33ee84f8aa58aaef5022d998f31fbb72c37222e6a7306aec5f72fc8ba548a6b6289f657de989
-  data.tar.gz: 681c0156b3d3bcc8e8e5e1d73fc4e02244a4ecef426195a1f20294ab0c33eb46c764dfa6a0f10261ad1179d1e27993e2f7baed35d449b90213c99b22eb1f3aa8
+  metadata.gz: 81a3b93e75eafa60d15067953c6254b13b81b944e17ff5a2f1bb765be72111428e1118971347fd03c9bf4515427f82b6a9762c5e63fa5d74a9b841c1e76a37c2
+  data.tar.gz: eb62295f194a01999924776dc1d2e238af96e833f284815fe0ff8724601490e67fa0394006b523afaf1a468718425d548f8a7b4467e2e66ab9d9956b67ddf30e

data/lib/capital_one.rb

@@ -1,5 +1,7 @@
 =begin
  
+==Capital One API Gem
+
  This is a gem to wrap the Capital One public API.
  Visit api.reimaginebanking.com for more details.
   
@@ -25,13 +27,29 @@ require 'capital_one/bill'
 require 'capital_one/branch'
 require 'capital_one/customer'
 require 'capital_one/transaction'
+require 'capital_one/withdrawal'
+require 'capital_one/deposit'
  
 =begin 
 
+==Important Info
+
 Depending on the access level/type of API key supplied, some of
 these methods will return 403 error codes(forbidden). Enterprise level
 API keys have access to any/all of the GET requests, but nothing else. 
 Customer level API keys have access to GET, POST, PUT, and DELETE, but only
 for valid accounts which are associated with the customer API key. 
 
+Additionally, some of the GET requests will change in functionality depending on the
+type of key used. For example, the getAll method in the Customer class returns all customers if
+the enterprise API key is used. If the customer API key is used, it will only return the customers that
+the key is associated with.
+
+For the purposes of this gem, any ID parameters Strings that are 24 hex characters long. Below is an example:
+5326c07ba520d1066c9ac52b
+
+You can see the API that this gem wraps at api.reimaginebanking.com
+
+
+
 =end

data/lib/capital_one/account.rb

@@ -13,6 +13,9 @@ class Account
 	end
 
 	# *** GET ***
+	# = getAll
+		# Returns an array of hashes getting all the customers.
+		#Each index in the array is the hash of an individual customer. 
 
 	def self.getAll
 		url = "#{self.urlWithEntity}?&key=#{self.apiKey}"
@@ -20,23 +23,32 @@ class Account
 		data = JSON.parse(resp.body)
 	end
 
-	#Gets all accounts of a given type.
-	#Possible arguments are: Savings, Credit Card, or Checking.
-	#tested, credit card doesn't work, returns array of hashes.
+	#== getAllByType
+		#Gets all accounts of a given type.
+		#=Parameters:
+		#Accepts a string of the account type. 3 possbilities: Credit Card, Savings, Checking.
+		#Returns an array of hashes with the accounts.
+
 	def self.getAllByType(type)
 		url = "#{self.urlWithEntity}?type=#{type}&key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
 	end
+
+		#== getOne
 		#Returns the account specified by it's account ID.
-		#tested - returns a hash with the account info.
+		#=Parameters:
+		#Accepts a string of the account ID. 
+		#Returns a hash with the account info.
 	def self.getOne(id)
 		url = "#{self.urlWithEntity}/#{id}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
 	end
-		#Gets all accounts associated with a given customer ID. 
-		#tested - returns an array of hashes.
+		#== getAllByCustomerId
+		#Returns all accounts associated with a given customer ID
+		#as an array of hashes. 
+
 	def self.getAllByCustomerId(customerId)
 		url = "#{self.url}/customers/#{customerId}/accounts?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
@@ -45,8 +57,10 @@ class Account
 
 
 	# *** PUT ***
-
-	#updates an account's nickname by id with given json data. 
+	#==updateAccount
+	#Updates an account's nickname.
+	#Parameters: AccountID, AccountHash
+	#Returns the http response code.
 	def self.updateAccount(accountId, account)
 		url = "#{self.urlWithEntity}/#{accountId}?key=#{self.apiKey}"
 		uri = URI.parse(url)
@@ -60,8 +74,10 @@ class Account
 
 
 	# *** POST ***
-
-	#creates a new account
+	#==createAccount
+	#Creates a new account
+	#Parameters: CustomerID, accountHash
+	#Returns the http response code. 
 	def self.createAccount(custID, account)
 		accountToCreate = account.to_json
 		url = "#{self.url}/customers/#{custID}/accounts?key=#{self.apiKey}"
@@ -75,8 +91,10 @@ class Account
 
 
 	# *** DELETE ***
-
-	#delete a given account with some ID
+	#==deleteAccount
+	#delete a given account by accountId.
+	#Parameters: AccountId.
+	#Returns the http response code. 
 	def self.deleteAccount(accountId)
 		url = "#{self.urlWithEntity}/#{accountId}?key=#{self.apiKey}"
 		uri = URI.parse(url)

data/lib/capital_one/atm.rb

@@ -13,12 +13,27 @@ class Atm
 	end
 
 	# *** GET ***
+	#==getAll
+	#Returns all ATMs as an array of hashes.
+
 	def self.getAll
 		url = "#{self.urlWithEntity}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
 	end
+
+	#==getAllByLocation
+	# Get all ATMs withing a certain radius of a geocoordinate
+	# Returns an array of hashes within the radius of the geocoordinate.  Each hash has an ATM.
+	def self.getAllByLocation(lat, lng, rad)
+		url = "#{self.urlWithEntity}?lat=#{lat}&lng=#{lng}&rad=#{rad}&key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
 	
+	#==getOne
+	#Parameters: ATMid
+	#Returns the ATM that has the given ID. 
 	def self.getOne(id)
 		url = "#{self.urlWithEntity}/#{id}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))

data/lib/capital_one/bill.rb

@@ -18,29 +18,39 @@ class Bill
 
 	# *** GET ***
 
-	#tested -returns array of hashes
+	#==getAllByCustomerId
 	# Get all bills for a specific customer
+	#Parameters: customerId
+	#Returns the customer as a hash array.
 	def self.getAllByCustomerId(customerId)
 		url = "#{self.customerBaseUrl}/#{customerId}/bills?key=#{self.apiKey}"
 		response = Net::HTTP.get_response(URI.parse(url))
 		return JSON.parse(response.body)
 	end
-	#tested - returns array of hashes
-	# Get a specific bill
+
+	#==getOneByCustomerIdBillId
+	# Get a specific bill from a specific customer.
+	#Parameters: customerId, BillId
+	#Returns the specified bill as a hash array
 	def self.getOneByCustomerIdBillId(customerId, billId)
 		url = "#{self.customerBaseUrl}/#{customerId}/bills/#{billId}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
 	end
-	#tested - returns an array of hashes with the bills for that account in it.
+
+	#==getAllByAccountId
 	#Get all bills for a specific account
+	#Parameters: accountId
+	#Returns an array of hashes containing the bills. 
 	def self.getAllByAccountId(accountId)
 		url = "#{self.accountBaseUrl}/#{accountId}/bills?key=#{self.apiKey}"
 		response = Net::HTTP.get_response(URI.parse(url))
 		return JSON.parse(response.body)
 	end
-	
-	#get a specific bill from a specific account
+	#==getOneByAccountIdBillId
+	#Get a specific bill from a specific account
+	#Parameters: AccountId, BillId
+	#Returns a hash array with the bill. 
 	def self.getOneByAccountIdBillId(accountId, billId)
 		url ="#{self.accountBaseUrl}/#{accountId}/bills/#{billId}?key=#{self.apiKey}"
 		response = Net::HTTP.get_response(URI.parse(url))
@@ -48,8 +58,20 @@ class Bill
 	end
 
 	# *** POST ***
+	#==updateBill
+	#Updates an account's nickname by id with given json data. 
+	#Parameters: AccountId, BillId, BillJson
+	#Json format is as follows: 
+		# 	{
+		#   "status": "",
+		#   "payee": "",
+		#   "nickname": "",
+		#   "payment_date": "",
+		#   "recurring_date": 0,
+		#   "payment_amount": 0
+		# }
+	#Returns http response code. 
 
-	#updates an account's nickname by id with given json data. 
 	def self.updateBill(accountId, billId, bill)
 		url = "#{self.accountBaseUrl}/#{accountId}/bills/#{billId}?key=#{self.apiKey}"
 		uri = URI.parse(url)
@@ -62,8 +84,19 @@ class Bill
 	end
 
 	# *** POST ***
-
+	#==createBill
 	#create a new bill on an associated account ID
+	#Parameters: AccountId, BillJson
+	#Json is as follows:
+		# 	{
+		#   "status": "",
+		#   "payee": "",
+		#   "nickname": "",
+		#   "payment_date": "",
+		#   "recurring_date": 0,
+		#   "payment_amount": 0
+		# }
+	#Returns http response code. 
 	def self.createBill(accountId, bill)
 		url = "#{self.accountBaseUrl}/#{accountId}/bills?key=#{self.apiKey}"
 		uri = URI.parse(url)
@@ -76,8 +109,10 @@ class Bill
 
 
 	# *** DELETE ***
-
-	#delete a bill by id from a given account
+	#==deleteBill
+	#delete a bill by id from a given account.
+	#Parameters: Accountid, billid.
+	#Returns http response code. 
 	def self.deleteBill(accountId, billId)
 		url = "#{self.accountBaseUrl}/#{accountId}/bills/#{billId}?key=#{self.apiKey}"
 		uri = URI.parse(url)

data/lib/capital_one/branch.rb

@@ -13,18 +13,19 @@ class Branch
 	end
 
 	# *** GET ***
-
+	#==getAll
 	# Get all the branches
-	#tested - returns an array of hashes. Each hash is a branch.
+	#Returns an array of hashes. Each hash is a branch.
 	def self.getAll
 		url = "#{self.urlWithEntity}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
-		
 	end
-
-	# Get a branch by it's id
-	#tested - returns a hash with the specified branch.
+	
+	#==getOne
+	#Get a branch by it's id
+	#Parameters: BranchId
+	#Returns a hash with the specified branch.
 	def self.getOne(id)
 		url = "#{self.urlWithEntity}/#{id}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))

data/lib/capital_one/customer.rb

@@ -17,16 +17,19 @@ class Customer
 	end
 
 	# *** GET ***
-
-	#Returns all customers that the API key used has access to.
-	#tested - Returns an array of hashes.
+	#==getAll
+	#Gets all customers the API key has acccess to.
+	#Returns an array of hashes.
 	def self.getAll
 		url = "#{self.urlWithEntity}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
 		data = JSON.parse(resp.body)
 		return data
 	end
+
+	#==getOne
 	#Gets the specified customer's information.
+	#Parameters
 	#tested - Returns a hash.
 	def self.getOne(custId)
 		url = "#{self.urlWithEntity}/#{custId}?key=#{self.apiKey}"
@@ -34,8 +37,10 @@ class Customer
 		data = JSON.parse(resp.body)
 	end
 
+	#==getOneByAccountId
 	#Get the customer for the given account.
-	#tested - Returns a hash with the specified customer data.
+	#Parameters: AccountId
+	#Returns a hash with the specified customer data.
 	def self.getOneByAccountId(accID)
 		url = "#{self.urlWithAcctEntity}/#{accID}/customer?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
@@ -44,7 +49,20 @@ class Customer
 
 
 	# *** PUT ***
-
+	#==updateCustomer
+	#Updates a customer by id with given json data. 
+	#Parameters: CustomerId, CustomerJson.
+	#Json is as follows: 
+		# 	{
+		#   "address": {
+		#     "street_number": "",
+		#     "street_name": "",
+		#     "city": "",
+		#     "state": "",
+		#     "zip": ""
+		#   }
+		# }
+	#Returns http response code. 
 	def self.updateCustomer(custID, customer)
 		url = "#{self.urlWithEntity}/#{custID}?key=#{self.apiKey}"
 		uri = URI.parse(url)

data/lib/capital_one/deposit.rb

@@ -0,0 +1,77 @@
+class Deposit
+
+  def self.urlWithEntity
+    return Config.baseUrl + "/accounts"
+  end
+
+  def self.url
+    return Config.baseUrl
+  end
+
+  def self.apiKey
+    return Config.apiKey
+  end
+
+
+  # *** GET ***
+  #==getAllByAccountId
+  #Get all deposits for a specific account
+  #Returns an array of hashes.
+  #Parameters: AccountID
+  #Returns an array of hashes containing the deposits for that account.
+  def self.getAllByAccountId(accID)
+    url = "#{self.urlWithEntity}/#{accID}/deposits?key=#{self.apiKey}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = JSON.parse(resp.body)
+    return data
+  end
+
+  #==getOneByAccountIdDepositId
+  # Get a specific deposit from a specific account.
+  #Parameters: AccountID, DepositID
+  # Returns a hash with the specified deposit
+  
+  def self.getOneByAccountIdDepositId(accID, depositID)
+    url = "#{self.urlWithEntity}/#{accID}/deposits/#{depositID}?key=#{self.apiKey}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** POST ***
+
+  # Create a new deposit into an account
+  #==createDeposit
+  #Creates a new deposit.
+  #Parameters: toAccountId, hashWithDepositData
+  #Returns http response code. 
+  def self.createDeposit(toAcc, json)
+    url = "#{self.urlWithEntity}/#{toAcc}/deposits?key=#{self.apiKey}"
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+    request.body = json
+    resp = http.request(request)
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** DELETE ***
+
+  #==deleteDeposit
+  #Deletes a specified deposit from a specified account.
+  #Parameters: accountID, depositID
+  #Returns http response code.
+  #=Note:
+  #This does not actually delete the deposit from the database, it only sets it's
+  #status to 'cancelled'
+  def self.deleteDeposit(accID, depositID)
+    url = "#{self.urlWithEntity}/#{accID}/deposits/#{depositID}?key=#{self.apiKey}"
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    key="?key=#{self.apiKey}"
+    request = Net::HTTP::Delete.new(uri.path+key)
+    resp = http.request(request)
+    data = JSON.parse(resp.body)
+  end
+end

data/lib/capital_one/transaction.rb

@@ -14,9 +14,11 @@ class Transaction
 
 
 	# *** GET ***
-
-	# Get all transactions for a specific account
-	#tested - Returns an array of hashes.
+	#==getAllByAccountId
+	#Get all transactions for a specific account where that account is the payer or payee
+	#Returns an array of hashes.
+	#Parameters: AccountID
+	#Returns an array of hashes containing the transactions for that account where that account is the payer or payee.
 	def self.getAllByAccountId(accID)
 		url = "#{self.urlWithEntity}/#{accID}/transactions?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
@@ -24,8 +26,37 @@ class Transaction
 		return data
 	end
 
-	# Get a specific transaction
-	# tested - Returns a hash with the specified transaction
+	# *** GET ***
+	#==getAllByAccountIdPayer
+	#Get all transactions for a specific account where that account is the payer
+	#Returns an array of hashes.
+	#Parameters: AccountID
+	#Returns an array of hashes containing the transactions for that account where that account is the payer.
+	def self.getAllByAccountIdPayer(accID)
+		url = "#{self.urlWithEntity}/#{accID}/transactions?type=payer&key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+		return data
+	end
+
+	# *** GET ***
+	#==getAllByAccountIdPayee
+	#Get all transactions for a specific account where that account is the payee
+	#Returns an array of hashes.
+	#Parameters: AccountID
+	#Returns an array of hashes containing the transactions for that account where that account is the payee.
+	def self.getAllByAccountIdPayee(accID)
+		url = "#{self.urlWithEntity}/#{accID}/transactions?type=payee&key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+		return data
+	end
+
+	#==getOneByAccountIdTransactionId
+	# Get a specific transaction from a specific account.
+	#Parameters: AccountID, TransactionId
+	# Returns a hash with the specified transaction
+	
 	def self.getOneByAccountIdTransactionId(accID, tranID)
 		url = "#{self.urlWithEntity}/#{accID}/transactions/#{tranID}?key=#{self.apiKey}"
 		resp = Net::HTTP.get_response(URI.parse(url))
@@ -36,6 +67,10 @@ class Transaction
 	# *** POST ***
 
 	# Create a new transaction between 2 accounts
+	#==createTransaction
+	#Creates a new transaction.
+	#Parameters: toAccountId, hashWithTransacionData
+	#Returns http response code. 
 	def self.createTransaction(toAcc, json)
 		url = "#{self.urlWithEntity}/#{toAcc}/transactions?key=#{self.apiKey}"
 		uri = URI.parse(url)
@@ -49,6 +84,13 @@ class Transaction
 
 	# *** DELETE ***
 
+	#==deleteTransaction
+	#Deletes a specified transaction from a specified account.
+	#Parameters: AccountID, TransactionID
+	#Returns http response code.
+	#=Note:
+	#This does not actually delete the transaction from the database, it only sets it's
+	#status to 'cancelled'
 	def self.deleteTransaction(accID, transID)
 		url = "#{self.urlWithEntity}/#{accID}/transactions/#{transID}?key=#{self.apiKey}"
 		uri = URI.parse(url)
@@ -56,6 +98,5 @@ class Transaction
 		key="?key=#{self.apiKey}"
 		request = Net::HTTP::Delete.new(uri.path+key)
 		resp = http.request(request)
-		#data = JSON.parse(resp.body)
 	end
 end

data/lib/capital_one/withdrawal.rb

@@ -0,0 +1,76 @@
+class Withdrawal
+
+  def self.urlWithEntity
+    return Config.baseUrl + "/accounts"
+  end
+
+  def self.url
+    return Config.baseUrl
+  end
+
+  def self.apiKey
+    return Config.apiKey
+  end
+
+
+  # *** GET ***
+  #==getAllByAccountId
+  #Get all withdrawals for a specific account
+  #Returns an array of hashes.
+  #Parameters: AccountID
+  #Returns an array of hashes containing the withdrawals for that account.
+  def self.getAllByAccountId(accID)
+    url = "#{self.urlWithEntity}/#{accID}/withdrawals?key=#{self.apiKey}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = JSON.parse(resp.body)
+    return data
+  end
+
+  #==getOneByAccountIdWithdrawalId
+  # Get a specific withdrawal from a specific account.
+  #Parameters: accountID, withdrawalID
+  # Returns a hash with the specified withdrawal
+  
+  def self.getOneByAccountIdWithdrawalId(accID, withdrawalID)
+    url = "#{self.urlWithEntity}/#{accID}/withdrawals/#{withdrawalID}?key=#{self.apiKey}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** POST ***
+
+  # Create a new withdrawal into an account
+  #==createWithdrawal
+  #Creates a new withdrawal.
+  #Parameters: toAccountId, hashWithWithdrawalData
+  #Returns http response code. 
+  def self.createWithdrawal(toAcc, json)
+    url = "#{self.urlWithEntity}/#{toAcc}/withdrawals?key=#{self.apiKey}"
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+    request.body = json
+    resp = http.request(request)
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** DELETE ***
+
+  #==deleteWithdrawal
+  #Deletes a specified withdrawal from a specified account.
+  #Parameters: accountID, withdrawalID
+  #Returns http response code.
+  #=Note:
+  #This does not actually delete the withdrawal from the database, it only sets it's
+  #status to 'cancelled'
+  def self.deleteWithdrawal(accID, withdrawalID)
+    url = "#{self.urlWithEntity}/#{accID}/withdrawals/#{withdrawalID}?key=#{self.apiKey}"
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    key="?key=#{self.apiKey}"
+    request = Net::HTTP::Delete.new(uri.path+key)
+    resp = http.request(request)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capital_one
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shane Besong
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,14 +123,15 @@ files:
 - lib/capital_one/bill.rb
 - lib/capital_one/branch.rb
 - lib/capital_one/customer.rb
+- lib/capital_one/deposit.rb
 - lib/capital_one/transaction.rb
 - lib/capital_one/version.rb
+- lib/capital_one/withdrawal.rb
 homepage: https://github.com/Shwheelz/capital_one
 licenses:
 - MIT
 metadata:
-  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'' to prevent pushes to
-    rubygems.org, or delete to allow pushes to any server.'
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Connects to the Capital One API