capital_one 0.3.0 → 0.4.0

data/lib/capital_one/branch.rb

@@ -1,35 +1,37 @@
-class Branch
-
-	def self.url
-		return Config.baseUrl
-	end
-
-	def self.urlWithEntity
-		return Config.baseUrl + "/branches"
-	end
-
-	def self.apiKey
-		return Config.apiKey
-	end
-
-	# *** GET ***
-	#==getAll
-	# Get all the branches
-	#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
-	
-	#==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 = JSON.parse(resp.body)
-		
-	end
+class Branch
+
+	def self.url
+		return Config.baseUrl
+	end
+
+	def self.urlWithEntity
+		return Config.baseUrl + "/branches"
+	end
+
+	def self.apiKey
+		return Config.apiKey
+	end
+
+	# *** GET ***
+
+	#==getAll
+		# Gets all branches
+		# Returns an array of Hashes with the branch data
+
+	def self.getAll
+		url = "#{self.urlWithEntity}?key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
+		
+	#==getOne
+		# Gets one branch for a given ID
+		#= Parameters: AtmId
+		# Returns a hash with the ATM data
+
+	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/customer.rb

@@ -1,80 +1,113 @@
-class Customer
-
-	def self.urlWithEntity
-		return Config.baseUrl + "/customers"
-	end
-
-	def self.urlWithAcctEntity
-		return Config.baseUrl + "/accounts"
-	end
-
-	def self.url
-		return Config.baseUrl
-	end
-
-	def self.apiKey
-		return Config.apiKey
-	end
-
-	# *** GET ***
-	#==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}"
-		resp = Net::HTTP.get_response(URI.parse(url))
-		data = JSON.parse(resp.body)
-	end
-
-	#==getOneByAccountId
-	#Get the customer for the given account.
-	#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))
-		data = JSON.parse(resp.body)
-	end
-
-
-	# *** 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)
-		customerToUpdate = customer.to_json
-		url = "#{self.urlWithEntity}/#{custID}?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 = customerToUpdate
-		response = http.request(request)
-		return JSON.parse(response.body)
-	end
-
-	# 
-
+class Customer
+
+	def self.urlWithEntity
+		return Config.baseUrl + "/customers"
+	end
+
+	def self.urlWithAcctEntity
+		return Config.baseUrl + "/accounts"
+	end
+
+	def self.url
+		return Config.baseUrl
+	end
+
+	def self.apiKey
+		return Config.apiKey
+	end
+
+	# *** GET ***
+
+	#== 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: CustomerId
+		# Returns a Hash with the customer data
+	
+	def self.getOne(custId)
+		url = "#{self.urlWithEntity}/#{custId}?key=#{self.apiKey}"
+		resp = Net::HTTP.get_response(URI.parse(url))
+		data = JSON.parse(resp.body)
+	end
+
+	#== getOneByAccountId
+		# Get the customer for the given account.
+		#= 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))
+		data = JSON.parse(resp.body)
+	end
+
+	# *** POST ***
+
+	#==createCustomer
+		# Creates a new customer with the given json data
+		#= Parameters: CustomerHash
+		# JSON is as follows: 
+			# {
+			# "first_name": "string",
+			# "last_name": "string",
+			# "address": {
+			# 	  "street_number": "string",
+			#     "street_name": "",
+			#     "city": "",
+			#     "state": "",
+			#     "zip": ""		
+			#   }
+			# }
+		# Returns http response code
+		
+	def self.createCustomer(customer)
+		url = "#{self.urlWithEntity}?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 = customer.to_json
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end
+
+
+	# *** PUT ***
+	
+	#== updateCustomer
+		# Updates a customer by id with given json data. 
+		#= Parameters: CustomerId, CustomerHash.
+		# Json is as follows: 
+			# 	{
+			#   "address": {
+			#     "street_number": "",
+			#     "street_name": "",
+			#     "city": "",
+			#     "state": "",
+			#     "zip": ""
+			#   }
+			# }
+		# Returns http response code. 
+	
+	def self.updateCustomer(custID, customer)
+		customerToUpdate = customer.to_json
+		url = "#{self.urlWithEntity}/#{custID}?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 = customerToUpdate
+		response = http.request(request)
+		return JSON.parse(response.body)
+	end 
+
 end

data/lib/capital_one/deposit.rb

@@ -1,77 +1,110 @@
-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, deposit)
-    depositToCreate = deposit.to_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 = depositToCreate
-    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)
-  end
+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
+    #= 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
+
+
+  #==getOne
+    # Returns a deposit for a given ID
+    #= Parameters: DepositId
+    # Returns a hash with the deposit data
+  def self.getOne(id)
+    url = "#{self.url}/deposits/#{id}?key=#{self.apiKey}"
+    resp = Net::HTTP.get_response(URI.parse(url))
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** POST ***
+
+  #==createDeposit
+    # Creates a new deposit.
+    # Parameters: toAccountId, DepositHash
+    # DepositHash is formatted as follows: 
+    # {
+    #   "medium": "balance",
+    #   "transaction_date": "string",
+    #   "status": "pending",
+    #   "amount": 0,
+    #   "description": "string"
+    # }
+    # Returns http response code. 
+
+  def self.createDeposit(toAcc, deposit)
+    depositToCreate = deposit.to_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 = depositToCreate
+    resp = http.request(request)
+    data = JSON.parse(resp.body)
+  end
+
+
+  # *** PUT ***
+
+  #==updateDeposit
+    # Updates an existing deposit
+    #= Parameters: DepositId, DepositHash
+    # DepositHash is formatted as follows: 
+    # {
+    #   "medium": "balance",
+    #   "transaction_date": "string",
+    #   "status": "pending",
+    #   "amount": 0,
+    #   "description": "string"
+    # }
+    # Returns http response code
+
+  def self.updateDeposit(id, deposit)
+    depositToUpdate = deposit.to_json
+    url = "#{self.url}/deposits/#{id}?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 = depositToUpdate
+    response = http.request(request)
+    return JSON.parse(response.body)
+  end
+
+  # *** DELETE ***
+
+  #==deleteDeposit
+    # Deletes an existing deposit
+    #= Parameters: DepositId
+    # Returns http response code
+
+  def self.deleteDeposit(id)
+    url = "#{self.url}/deposits/#{id}?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