capital_one 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc2f9909981e3e6c28c5ffedaf019df1b8c8331
-  data.tar.gz: 3324bd1688e85d433110080cec4144850fa5ea6a
+  metadata.gz: db36793ee044270553fdf245f7d1f362f2611a82
+  data.tar.gz: 07c1c5ce42f21642dab1a46752a8e1a0f45f266a
 SHA512:
-  metadata.gz: 4a19f6ee7e419509ae32fce8b96128585886fb257c4bc81f9a217400cc07efe9e66add806674a1e5a69aff3de3f94a28af3bbbf160d03d5182763c6642755a2b
-  data.tar.gz: c9d75359a81e350be15e5497d5dfda449330d0ab2f6f6d3c5eb8e540666759291a4401585401313032fa3f0baaa67e8872aa37fde8959f1947aa02ad5c0a4239
+  metadata.gz: 19efc14f69d99863956df6fc596d80798049a260948f431e7ee1017b6ff5cdb5818bc1704619510c0bd934aa7f85f164c2835c61b3a5cc95d39fafdab217d056
+  data.tar.gz: 63fffc1566312deec7e8e9b4eefcd6f632a796471a4a124223adbdb8ed928ffe82538e2d9697bf1a601c32962c911df19d1fb315cd5a3b700da32409f86f2b63

data/lib/capital_one.rb

@@ -1,55 +1,58 @@
-=begin
- 
-==Capital One API Gem
-
- This is a gem to wrap the Capital One public API.
- Visit api.reimaginebanking.com for more details.
-  
-=end
-
-module Config
-  class << self
-    attr_accessor :apiKey
-
-    def baseUrl
-      @baseUrl = 'http://api.reimaginebanking.com:80'
-    end
-  end
-end
-
-require 'net/http'
-require 'json'
-require 'uri'
-
-require 'capital_one/account'
-require 'capital_one/atm'
-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
-
-
-
+=begin
+ 
+==Capital One API Gem
+
+ This is a gem to wrap the Capital One public API.
+ Visit api.reimaginebanking.com for more details.
+  
+=end
+
+module Config
+  class << self
+    attr_accessor :apiKey
+
+    def baseUrl
+      @baseUrl = 'http://api.nessiebanking.com:80'
+    end
+  end
+end
+
+require 'net/http'
+require 'json'
+require 'uri'
+
+require 'capital_one/account'
+require 'capital_one/atm'
+require 'capital_one/bill'
+require 'capital_one/branch'
+require 'capital_one/customer'
+require 'capital_one/deposit'
+require 'capital_one/merchant'
+require 'capital_one/purchase'
+require 'capital_one/transfer'
+require 'capital_one/withdrawal'
+
+ 
+=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

@@ -1,107 +1,116 @@
-class Account
-
-	def self.urlWithEntity
-		return Config.baseUrl + "/accounts"
-	end
-
-	def self.url
-		return Config.baseUrl
-	end
-
-	def self.apiKey
-		return Config.apiKey
-	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}"
-		resp = Net::HTTP.get_response(URI.parse(url))
-		data = JSON.parse(resp.body)
-	end
-
-	#== 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.
-		#=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
-		#== 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))
-		data = JSON.parse(resp.body)
-	end
-
-
-	# *** PUT ***
-	#==updateAccount
-	#Updates an account's nickname.
-	#Parameters: AccountID, AccountHash
-	#Returns the http response code.
-	def self.updateAccount(accountId, account)
-		accountToUpdate = account.to_json
-		url = "#{self.urlWithEntity}/#{accountId}?key=#{self.apiKey}"
-		uri = URI.parse(url)
-		http = Net::HTTP.new(uri.host, uri.port)
-		key = "?key=#{self.apiKey}"
-		request = Net::HTTP::Put.new(uri.path+key, initheader = {'Content-Type' =>'application/json'})
-		request.body = accountToUpdate
-		response = http.request(request)
-		return JSON.parse(response.body)
-	end
-
-
-	# *** POST ***
-	#==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}"
-		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 = accountToCreate
-		response = http.request(request)
-		return JSON.parse(response.body)
-	end
-
-
-	# *** DELETE ***
-	#==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)
-		http = Net::HTTP.new(uri.host, uri.port)
-		key="?key=#{self.apiKey}"
-		request = Net::HTTP::Delete.new(uri.path+key)
-		response = http.request(request)
-	end
-end
+class Account
+
+	def self.urlWithEntity
+		return Config.baseUrl + "/accounts"
+	end
+
+	def self.url
+		return Config.baseUrl
+	end
+
+	def self.apiKey
+		return Config.apiKey
+	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}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
+
+	#== getAllByType
+		# Gets all accounts of a given type.
+		#= Parameters: type
+		# 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 its account ID.
+		#= Parameters: AccountId
+		# 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
+	
+	#== getAllByCustomerId
+		# Returns all accounts associated with a given customer ID as an array of hashes. 
+		#= Parameters: CustomerId
+		# Accepts a string of the customer ID
+
+	def self.getAllByCustomerId(customerId)
+		url = "#{self.url}/customers/#{customerId}/accounts?key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
+
+
+	# *** PUT ***
+	
+	#==updateAccount
+		# Updates an account's nickname.
+		#= Parameters: AccountID, AccountHash
+		# Returns the http response code.
+	
+	def self.updateAccount(accountId, account)
+		accountToUpdate = account.to_json
+		url = "#{self.urlWithEntity}/#{accountId}?key=#{self.apiKey}"
+		uri = URI.parse(url)
+		http = Net::HTTP.new(uri.host, uri.port)
+		key = "?key=#{self.apiKey}"
+		request = Net::HTTP::Put.new(uri.path+key, initheader = {'Content-Type' =>'application/json'})
+		request.body = accountToUpdate
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end
+
+
+	# *** POST ***
+	
+	#== 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}"
+		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 = accountToCreate
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end
+
+
+	# *** DELETE ***
+	
+	#== 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)
+		http = Net::HTTP.new(uri.host, uri.port)
+		key="?key=#{self.apiKey}"
+		request = Net::HTTP::Delete.new(uri.path+key)
+		response = http.request(request)
+	end
+end

data/lib/capital_one/atm.rb

@@ -1,43 +1,49 @@
-class Atm
-
-	def self.urlWithEntity
-		return Config.baseUrl + "/atms"
-	end
-
-	def self.url
-		return Config.baseUrl
-	end
-
-	def self.apiKey
-		return Config.apiKey
-	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 = JSON.parse(resp.body)
-	end
-end
-
+class Atm
+
+	def self.urlWithEntity
+		return Config.baseUrl + "/atms"
+	end
+
+	def self.url
+		return Config.baseUrl
+	end
+
+	def self.apiKey
+		return Config.apiKey
+	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
+		#= Paremeters: latitude, longitude, radius
+		# Accepts lat, lng, and rad as floats
+		# 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
+		# Gets one ATM for a given ID
+		# 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 = JSON.parse(resp.body)
+	end
+end
+

data/lib/capital_one/bill.rb

@@ -1,125 +1,124 @@
-class Bill
-
-	def self.accountBaseUrl
-		return Config.baseUrl + "/accounts"
-	end
-
-	def self.customerBaseUrl
-		return Config.baseUrl + "/customers"
-	end
-
-	def self.url
-		return Config.baseUrl
-	end
-
-	def self.apiKey
-		return Config.apiKey
-	end
-
-	# *** GET ***
-
-	#==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
-
-	#==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
-
-	#==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
-	#==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))
-		return JSON.parse(response.body)
-	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. 
-
-	def self.updateBill(accountId, billId, bill)
-		billToUpdate = bill.to_json
-		url = "#{self.accountBaseUrl}/#{accountId}/bills/#{billId}?key=#{self.apiKey}"
-		uri = URI.parse(url)
-		http = Net::HTTP.new(uri.host, uri.port)
-		key = "?key=#{self.apiKey}"
-		request = Net::HTTP::Put.new(uri.path+key, initheader = {'Content-Type' =>'application/json'})
-		request.body = billToUpdate
-		response = http.request(request)
-		return JSON.parse(response.body)
-	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)
-		http = Net::HTTP.new(uri.host, uri.port)
-		request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
-		request.body = bill.to_json
-		response = http.request(request)
-		return JSON.parse(response.body)
-	end
-
-
-	# *** DELETE ***
-	#==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)
-		http = Net::HTTP.new(uri.host, uri.port)
-		key="?key=#{self.apiKey}"
-		request = Net::HTTP::Delete.new(uri.path+key)
-		response = http.request(request)
-	end
+class Bill
+
+	def self.accountBaseUrl
+		return Config.baseUrl + "/accounts"
+	end
+
+	def self.customerBaseUrl
+		return Config.baseUrl + "/customers"
+	end
+
+	def self.urlWithEntity
+		return Config.baseUrl + "/bills"
+	end
+
+	def self.url
+		return Config.baseUrl
+	end
+
+	def self.apiKey
+		return Config.apiKey
+	end
+
+	# *** GET ***
+
+	#==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
+
+	#==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
+
+	#==getOne
+		# Gets one bill for a specific billId
+		# Parameters: billId
+		# Returns a hash with the bill data
+
+	def self.getOne(id)
+		url = "#{self.urlWithEntity}/#{id}?key=#{self.apiKey}"
+		response = Net::HTTP.get_response(URI.parse(url))
+		return JSON.parse(response.body)
+	end
+
+	# *** POST ***
+
+	#==updateBill
+		# Updates an account's information by id with given json data. 
+		# Parameters: BillId, BillJson
+		# Json format is as follows: 
+			# 	{
+			#   "status": "",
+			#   "payee": "",
+			#   "nickname": "",
+			#   "payment_date": "",
+			#   "recurring_date": 0,
+			#   "payment_amount": 0
+			# }
+		# Returns http response code. 
+
+	def self.updateBill(billId, bill)
+		billToUpdate = bill.to_json
+		url = "#{self.urlWithEntity}/#{billId}?key=#{self.apiKey}"
+		uri = URI.parse(url)
+		http = Net::HTTP.new(uri.host, uri.port)
+		key = "?key=#{self.apiKey}"
+		request = Net::HTTP::Put.new(uri.path+key, initheader = {'Content-Type' =>'application/json'})
+		request.body = billToUpdate
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end
+
+	#==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)
+		http = Net::HTTP.new(uri.host, uri.port)
+		request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' => 'application/json'})
+		request.body = bill.to_json
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end
+
+
+	# *** DELETE ***
+	#==deleteBill
+		# delete a bill by its id
+		# Parameters: BillId
+		# Returns http response code
+	def self.deleteBill(billId)
+		url = "#{self.urlWithEntity}/#{billId}?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)
+		response = http.request(request)
+	end
 end