shwheelz / capital_one Goto Github PK

Need to have a way for the user to specify which key they want to use for each method. Some methods only accept one of the keys (POST, PUT, DELETE) and other methods don't need either (ATMs, Branches). Need to so some research on how this should be done.

Was thinking about adding it as a parameter to the methods that would need it like Account.getAccounts(keyType). I am trying to find a way to do it without having to add it as an argument for every single method though.

We could possibly have a Cust and Ent object. So CustAccount.getAccounts, CustAtm.getAtms, etc. would use the user's customer key and EntAccount.getAccounts, EntAtm.getAtms, etc. would use the user's enterprise key. That could work. Any ideas on this?

We should move the functions for each entity into their own file with their own class. So in the end we should have these files in the capital_one folder:

*accounts.rb
*atms.rb
*bills.rb
*branches.rb
*customers.rb

This will help us organize the code and better separate dev tasks without having to worry about merge conflicts every time we change something.

• Add in the functions for the endpoints
• Test the functions
• Document the functions

need to make methods for enterprise

There is now support for a parameter which specifies if you are looking for the transactions that you are the payer or the payee. Need to add support for this into the gem.

• Add parameters
• Test
• Document

What do they do and what args do they take. What format is the JSON that goes into them. <-- that should also be in the documentation.

• Transaction
• GET
  - Error on "Specific transaction for an account AND POST for transaction"
  • JSON::ParseError: 757: unexpected token at '...'
• DELETE
  - See error in Transaction GET
• Withdrawal
• DELETE
  - Failure/Error: expect(withdrawal.class).to be(Net::HTTPNoContent)
  - got #Class:70268775297560 => Net::HTTPNotFound
• Deposit
• DELETE
  - Failure/Error: expect(deposit.class).to be(Net::HTTPNoContent)
  - got #Class:70268775297560 => Net::HTTPNotFound

I will appreciate if the readme file would contain an example of any request using this gem. Thanks.

Need to make an explicit request using Net::HTTP.get_response rather than a method defined by the Ruby wrapper. Will make calling paginated responses more intuitive in the future.

There are parameters on ATMs for long, lat, and radius to narrow the search. Need to add support for this into the API.

• Add parameters
• Test
• Document

Need to add a way for the user of the gem to specify their API keys and have the gem pick them up. I need to do some research on how this should be done.

Once these issues are completed we definitely want to get this hosted on RubyGems for students at other hackathons to download.

Looks like the wrapper is putting address into the system as hashes when its updating a customer. Need to fix this in the PUT customer method.

We need to test everything!

--need to research what testing framework we want to use
--there should also be a code coverage tool we use to make sure we hit everything in the gem

This repo hasn't been updated due to lack of Ruby adoption at college hackathons. It should still work for the most common functionality, such as account and customer requests, but is missing some of the newer features. Please let me know in advance if you plan on using any of the newer features and I'm happy to update, or (since it's open source) feel free to send a PR with your updates.