ruby_mint 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35663ac4c4455968a43c43629104347ac097356
-  data.tar.gz: c00b9cd9cf3e4eb9c54450a730cf039f3996b706
+  metadata.gz: 0669bb9e0106c090f125a7b2347ec0a9328cad25
+  data.tar.gz: 3e9ad2ca1e6eee3c10a724f67eae1faca8b3a7b5
 SHA512:
-  metadata.gz: 13692c620ee097e5368b4bcf0ab96cc6dd7229d3ef4f38f768e42f1c634fd871d881c6e1ef5a8f043d5ecc8b77930564700a8b46c388ed1f661abd9001294637
-  data.tar.gz: de2f372cdf31d425fb64eeac56db6e9caca6d366dcb526952a07b3468ecf834cc786fe71cc44171f15ed800bf91ca962ee60a99bfcbb675253fc1bf796c78a14
+  metadata.gz: a1df96b9d242217ed2ef82d9db254cf134c10c2462f7305acaabb91013978a0493f7cd7c51a62f2ab8c479dd71ef13b6050bee69e03fa9cbcb285602d689807d
+  data.tar.gz: fb6dba46232e82db20b155ccffdb5ae99487fa84f785719b9b9bdc70ce1476708208a8c4f83ff39bb26ba70eceedfc87e38e63cd050b272f0585aa11a62e52fb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/ruby_mint.svg)](http://badge.fury.io/rb/ruby_mint)
+
 # RubyMint
 
 RubyMint is a gem to assist you with getting information from Mint.com's API.
@@ -63,10 +65,32 @@ accounts = ruby_mint.accounts
 
 # Transaction Data
 
-Mint.com returns transactions as CSV.
+Transactions can be obtained as either CSV or JSON data.
+
+CSV is a list of all transactions as a CSV dump.
+
+NOTE: Breaking change from v0.1 Old transactions method is now transactions_csv
+
+```ruby
+transactions_csv = ruby_mint.transactions_csv
+```
+
+JSON data must specify a date range and has the option to include pending transactions
+or to include a search term. Mint only returns a transaction date without a time. Date
+range is inclusive.
 
 ```ruby
-transactions = ruby_mint.transactions
+# Get all transactions from May 1, 2015 until now
+transactions = ruby_mint.transactions Time.parse("2015-05-01")
+
+# Get all transactions for the month of May
+transactions = ruby_mint.transactions Time.parse("2015-05-01"), Time.parse("2015-05-31")
+
+# Include pending transactions
+transactions = ruby_mint.transactions Time.parse("2015-05-01"), Time.parse("2015-05-31"), 'include_pending' => true
+
+# Include a search term
+transactions = ruby_mint.transactions Time.parse("2015-05-01"), Time.parse("2015-05-31"), 'search_term' => 'coffee'
 ```
 
 ## Contributing

data/bin/mint_download.rb

@@ -61,7 +61,7 @@ ruby_mint.initiate_account_refresh do
 
   if transactions_file
     puts "Downloading transactions..."
-    transactions = ruby_mint.transactions
+    transactions = ruby_mint.transactions_csv
   end
 end
 

data/lib/ruby_mint.rb

@@ -32,7 +32,11 @@ class RubyMint
   end
 
   # Login retrieves a user token from Mint.com
-  def login
+  #
+  # @param use_token [String] Use an existing token
+  def login(use_token = nil)
+    @token = use_token and return if use_token
+
     response = agent.get("https://wwws.mint.com/login.event?task=L")
     raise RubyMintError.new("Unable to GET Mint login page.") if response.code != "200"
 
@@ -72,9 +76,9 @@ class RubyMint
   #
   # @param sleep_time [Integer] Num of seconds to wait between calls to refreshing? when block is passed
   # @param block [Block] Code to execute upon completion of of refreshing
-  def initiate_account_refresh(sleep_time = 3, &block)
+  def initiate_account_refresh(sleep_time = 3)
     agent.post("https://wwws.mint.com/refreshFILogins.xevent", { "token" => @token }, JSON_HEADERS)
-    if block
+    if block_given?
       loop{ sleep sleep_time; break if !refreshing? }
       yield
     end
@@ -112,6 +116,8 @@ class RubyMint
     results = agent.post("https://wwws.mint.com/bundledServiceController.xevent?legacy=false&token=#{@token}", account_query, JSON_HEADERS)
     raise RubyMintError.new("Unable to obtain account information. Response code: #{results.code}") if results.code != "200"
 
+    raise RubyMintError.new("Not logged in.") if results.body.include?('Session has expired.')
+
     account_body = JSON.load(results.body)
     if !account_body || !account_body["response"] || !account_body["response"][@request_id.to_s] || !account_body["response"][@request_id.to_s]["response"]
       raise RubyMintError.new("Unable to obtain account information (no account information in response).")
@@ -124,14 +130,55 @@ class RubyMint
   # the transactions available
   #
   # @return [String] CSV of all transactions
-  def transactions
+  def transactions_csv
     results = agent.get("https://wwws.mint.com/transactionDownload.event", JSON_HEADERS)
-    raise RubyMintError.new("Unable to obtain transations.") if results.code != "200"
+    raise RubyMintError.new("Unable to obtain transactions.") if results.code != "200"
     raise RubyMintError.new("Non-CSV content returned.") if !results.header["content-type"].include?("text/csv")
 
     results.body
   end
 
+  # Get transactions from mint. Returned as JSON. Paginate
+  #
+  # Options:
+  #   include_pending [Boolean] default false
+  #   search_term     [String]  default ""
+  #
+  # @param start_date [Time] get all transactions on or after this date
+  # @param end_date   [Time] get all transactions up to and including this date
+  # @param options    [Hash] options hash
+  # @returns          [Array<Hash>] array of transactions
+  def transactions(start_date, end_date = Time.now, options = {})
+    include_pending = options.fetch('include_pending', false)
+    search_term     = options.fetch('search_term', '')
+    offset = 0
+    results = []
+
+    # Convert start and end dates 
+    start_date = Time.local(start_date.year, start_date.month, start_date.day)
+    end_date = Time.local(end_date.year, end_date.month, end_date.day)
+
+    loop do
+      next_page = transaction_page(offset, search_term)
+      break if next_page.empty?
+
+      # Filter out pending transactions
+      if !include_pending
+        next_page.reject!{ |t| t['isPending'] }
+      end
+
+      results.concat next_page
+      break if earliest_mint_date(next_page) < start_date
+
+      offset += next_page.count
+    end
+
+    # Filter by date
+    results.select do |t|
+      t['date'] >= start_date && t['date'] <= end_date
+    end
+  end
+
 
   private
 
@@ -140,4 +187,49 @@ class RubyMint
         agent.user_agent_alias = 'Linux Firefox'
     }
   end
+
+  # Get a single page of transaction data. Mint always returns 50 transactions per page.
+  def transaction_page(offset, search_term)
+    # Example query: https://wwws.mint.com/app/getJsonData.xevent?queryNew=&offset=0&filterType=cash&acctChanged=T&task=transactions&rnd=1436026512488
+    base_url = "https://wwws.mint.com/app/getJsonData.xevent"
+    search_query = "?queryNew=#{URI.encode(search_term)}"
+    offset_query = "&offset=#{offset}"
+    transaction_query = "&filterType=cash&comparableType=8&task=transactions&rnd=#{random_number}"
+
+    json_results = agent.get("#{base_url}#{search_query}#{offset_query}#{transaction_query}", JSON_HEADERS)
+    raise RubyMintError.new("Unable to obtain transactions.") if json_results.code != "200"
+    raise RubyMintError.new("Non-JSON content returned.") if !json_results.header["content-type"].include?("text/json")
+
+    transform_transaction_times JSON.parse(json_results.body)['set'][0]['data']
+  end
+
+  # Mint returns transactions in two formats: "Mar 8" for this year, "10/08/14" for previous years (month/day/year).
+  # Transform dates into ruby time objects.
+  #
+  # NOTE: Mint only returns the date of the transaction, there is no time
+  #
+  # @param transactions [Array<Hash>] array of transactions
+  def transform_transaction_times(transactions)
+    transactions.map do |t|
+      t['date'] = (t['date'] =~ /\d+\/\d+\/\d+/ ? Time.strptime(t['date'], "%D") : Time.parse(t['date']))
+      t
+    end
+  end
+
+  # Get the earliest date from this set of transactions. Assumes they are in reverse order.
+  #
+  # @params transactions [Array<Hash>]
+  # @returns [Time]
+  def earliest_mint_date(transactions)
+    transactions.last['date']
+  end
+
+  # Queries require a 12-digit random number
+  def random_number
+    # They are starting with 14, so I won't break the mold. Get 10 more.
+    nums = (0..9).to_a
+    result = "14"
+    10.times{ result << nums.sample.to_s }
+    result
+  end
 end

data/lib/ruby_mint/version.rb

@@ -1,3 +1,3 @@
 class RubyMint
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/ruby_mint.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_mint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Marrone
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -80,6 +80,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 description: Gem to allow you to incorporate Mint.com into your ruby applications.
 email:
 - nickmarrone@gmail.com
@@ -88,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -118,9 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Retrieve your Mint.com transaction and account information.
 test_files: []
-has_rdoc: