capital_one 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a1bd14810b458fc3a3033b8ba909952facf6717
-  data.tar.gz: 39126cc9a598c20fb9357d7e748b506d324f4b68
+  metadata.gz: 79386ee43f71bc66ddc6118b14528281dd7c360e
+  data.tar.gz: b6c3ccba8d425dd184f318d8f6607640e7489f76
 SHA512:
-  metadata.gz: 153b3846c5ac03b829a45d491046ae0090c9735864553763b7ece73329b812dd0e681d2583e98e0358502f94eebdd9c7940dca86c6eae8c75d6353ade435c2e5
-  data.tar.gz: 0e9129dd776a4a46577f1c0043c59ae3d8be0851f180f8e4d399398554e06ba769f675d613a5215af6204d99b600fdd523675700d9d7798f7e3565e3fd2c9b5b
+  metadata.gz: 8b974823364bc825d07363091c26861fdf74ae03ac07912b96e566a7232d521e145f85a7635d3810e2e623fe0c095e84c45f49f661000871a144ac220868bd45
+  data.tar.gz: 46b5436b17ec21d48a4a698d99cef85426459010feac6a03434b83c9566090aeeb27e9e72aeec0efb26bde45c5c0fc94140f3ad5c22b4049c51891cd38ddeb03

data/lib/capital_one.rb

@@ -1,58 +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/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
-
-
-
+=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/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,116 +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: 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
+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,49 +1,73 @@
-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
-
+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 a hash (first page only)
+		# Pagination was implemented to break up the size of the hash
+
+	def self.getAll
+		url = "#{self.urlWithEntity}?key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
+
+	#==getAllWithPage
+		# Returns all ATMs for a given response page
+		#= Parameters: page as an integer
+		# Returns a hash of ATM details 
+
+	def self.getAllWithPage(page)
+		url = "#{self.urlWithEntity}?key=#{self.apiKey}&page=#{page}"
+		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
+	
+	#==getAllByLocationWithPage
+		# Returns all ATMs within a certain radius for a given response page
+		#= Parameters: lat, lng, and rad as floats; page as int
+		# Returns a hash of ATM details
+
+	def self.getAllByLocationWithPage(lat, lng, rad, page)
+		url = "#{self.urlWithEntity}?lat=#{lat}&lng=#{lng}&rad=#{rad}&key=#{self.apiKey}&page=#{page}"
+		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
+