amex 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1 @@
+settings.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gem 'httparty', '0.9.0'
+gem 'nokogiri', '1.5.6'

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.5.0)
+    multi_xml (0.5.1)
+    nokogiri (1.5.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (= 0.9.0)
+  nokogiri (= 1.5.6)

data/README.md

@@ -0,0 +1,91 @@
+## Amex
+
+Welcome to the last continuation of my Ruby-based assault on various online
+banking systems, much like my
+[Lloyds TSB screen scraper](https://github.com/timrogers/lloydstsb).
+
+However, this one doesn't rely on nasty screen-scraping. Instead, it uses
+the previous unknown internal API used by American Express for their
+"Amex UK" iPhone app. I suspect it works elsewhere, but I haven't tested.
+
+### Changelog
+
+__v0.1.0__ - Original version
+__v0.2.0__ - Support for multiple American Express cards, parsing using
+Nokogiri
+
+### Usage
+
+The file `example.rb` provides a very simple example of how the code works, but here's a step by step:
+
+1. Ensure the gem is installed, and then include it in your Ruby file, or in your Gemfile where appropriate:
+
+```
+$ gem install amex
+`require 'amex'
+```
+
+2. You'll just need two variables, @username and @password, each unsurprisingly corresponding to different authentication details used
+
+```
+@username = "chuck_norris"
+@password = "roundhousekick123"
+```
+
+3. Instantiate a new instance of the `Amex::Client` object, passing in the
+username and password - this is used to perform the authentication required.
+
+`client = Amex::Client.new(@username, @password)`
+
+4. Call the `account` method of the object you just made - it'll take a few seconds, and will return an Amex::CardAccount object. There'll only be one, since this
+only supports one card at a time right now.
+
+```
+accounts = client.accounts
+puts account.first.product
+puts account.first.type
+```
+
+### Data models
+
+An `Amex::CardAccount` is created by `Amex::CardAccount.new` passing in a hash
+of the parsed XML. The parsing is done by `Amex::Client`.
+
+An __Amex::CardAccount__ instance has the following attributes:
+
+* __product (string)__ - the type of card (e.g. "The Preferred Rewards Gold Card®")
+* __card_number_suffix (string)__ - the last five digits of your card number
+* __lending_type (string)__ - either "Charge" or "Credit", depending on the type of credit arrangement you have
+* __card_member_name (string)__ - your name, as recorded as the account holder
+* __past_due (boolean)__ - is the card past its due payment date?
+* __cancelled?__ (boolean)__ - has the account been cancelled?
+* __is_basic/centurion/platinum/premium] (boolean)__ - which type of account does this conform to?
+* __market (string)__ - the market that your card is registered too, e.g. "en_GB"
+* __card__art (string)__ - a URL for an image of your card
+* __loyalty_indicator (boolean)__ - does this card have some
+kind of loyalty scheme active? (e.g. Membership Rewards)
+* __loyalty_programmes (array of Amex::LoyaltyProgramme objects)__ - the loyalty programmes this card belongs to
+* __loyalty_balances (hash)__ - the loyalty balances on this card - the key is the name of the programme (string), and the balance is the value, as an integer
+* __statement_balance (float)__ - the amount of the last statement on your account
+* __payment_credits (float)__ - the combination of current payments and credits on your account
+* __recent_charges (float)__ - charges since your last statement was issued (I believe)
+* __total_balance (float)__ - what American Express refer to as your total balance, whatever that is!
+* __payment_due (float)__ - the amount of money you need to pay before `payment_due_date`
+* __payment_due_date (DateTime)__ - when the `payment_due` needs to be paid by
+
+There are lots of extra useful methods here to make accessing
+some of the various properties easier. They're very self-explanatory - check `lib/amex/card_account.rb`.
+
+A __LloydsTSB::LoyaltyProgramme has just two attributes:
+
+* __name (string)__ - The name of the programme, most often "Membership Rewards"
+* __balance (integer)__ - The balance of the programme
+
+### Limitations
+
+* There's no support for viewing transactions yet - watch this space!
+
+### License
+
+Use this for what you will, as long as it isn't evil. If you make any changes or cool improvements, please let me know at <tim+amex@tim-rogers.co.uk>.
+

data/amex.gemspec

@@ -0,0 +1,15 @@
+require File.expand_path('../lib/amex/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'amex'
+  gem.version = Amex::VERSION.dup
+  gem.authors = ['Tim Rogers']
+  gem.email = ['tim@tim-rogers.co.uk']
+  gem.summary = 'A library for accessing data on an American Express account'
+  gem.homepage = 'https://github.com/timrogers/amex'
+
+  gem.add_runtime_dependency "httparty"
+  gem.add_runtime_dependency "nokogiri"
+
+  gem.files = `git ls-files`.split("\n")
+end

data/example.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'amex'
+
+# Bring in the settings.rb file - this isn't included in the repository,
+# but it should just contain two class variables, `username` and `password`
+require "#{File.dirname(__FILE__)}/settings.rb"
+
+client = Amex::Client.new(@username, @password)
+accounts = client.accounts
+puts accounts.first.inspect

data/lib/amex/client.rb

@@ -1,5 +1,6 @@
 require 'erb'
 require 'httparty'
+require 'nokogiri'
 
 module Amex
   class Client
@@ -23,7 +24,7 @@ module Amex
       ERB.new(xml).result(binding)
     end
 
-    def account
+    def accounts
       # This only supports one account for now, because I'm lazy and I
       # hate traversing XML...
       options = { :body => { "PayLoadText" => request_xml }}
@@ -31,30 +32,43 @@ module Amex
         '/myca/intl/moblclient/emea/ws.do?Face=en_GB', options
       )
 
-      xml = MultiXml.parse(response)['XMLResponse']
+      xml = Nokogiri::XML(response.body)
+      xml = xml.css("XMLResponse")
 
-      if xml['ServiceResponse']['Status'] != "success"
+      if xml.css('ServiceResponse Status').text != "success"
         raise "There was a problem logging in to American Express."
       else
-        account_details = {}
-        xml["CardAccounts"]["CardAccount"]["CardData"]["param"].each do |item|
-          account_details[item['name']] = item['__content__']
-        end
+        accounts = [] # We'll store all the accounts in here!
 
-        xml["CardAccounts"]["CardAccount"]["AccountSummaryData"]["SummaryElement"].each do |item|
-          account_details[item['name']] = item['value'] ? item['value'].to_f : item['formattedValue']
-        end
+        xml.css('CardAccounts CardAccount').each do |item|
+          account_details = {} # All the attributes from the XML go in here
+          # For each of the CardAccount objects, let's first go through
+          # the CardData to pull out lots of nice information
+          item.css('CardData param').each do |attribute|
+            account_details[attribute.attr('name')] = attribute.text
+          end
 
-        account = Amex::CardAccount.new(account_details)
+          # Now let's go through the AccountSummaryData to find all the
+          # various bits of balance information
+          item.css('AccountSummaryData SummaryElement').each do |attribute|
+            account_details[attribute.attr('name')] = attribute.attr('value') ? attribute.attr('value').to_f : attribute.attr('formattedValue')
+          end
+
+          # We have all the attributes ready to go, so let's make an
+          # Amex::CardAccount object
+          account = Amex::CardAccount.new(account_details)
 
-        xml["CardAccounts"]["CardAccount"]["LoyaltyProgramData"].each do |item|
-          item.each do |part|
-            next if part.class == String
-            account.loyalty_programmes << Amex::LoyaltyProgramme.new(part['label'], part['formattedValue'].gsub(",", "").to_i)
+          # Finally, let's rip out all the loyalty balances...
+          item.css('LoyaltyProgramData LoyaltyElement').each do |element|
+            account.loyalty_programmes << Amex::LoyaltyProgramme.new(
+              element.attr('label'), element.attr('formattedValue').gsub(",", "").to_i
+            )
           end
+          accounts << account
+
         end
 
-        account
+        accounts
       end
 
     end

data/lib/amex/version.rb

@@ -1,3 +1,3 @@
 module Amex
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - tim@tim-rogers.co.uk
@@ -34,13 +50,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- amex-0.1.0.gem
+- amex-0.2.0.gem
+- amex.gemspec
+- example.rb
 - lib/amex.rb
 - lib/amex/card_account.rb
 - lib/amex/client.rb
+- lib/amex/data/request.xml
 - lib/amex/loyalty_programme.rb
 - lib/amex/utils.rb
 - lib/amex/version.rb
-- lib/amex/data/request.xml
 homepage: https://github.com/timrogers/amex
 licenses: []
 post_install_message: