ruby_mint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42561a5237e90022049c08135df7a1af5e9ee9f7
+  data.tar.gz: cebbafc6bb874c9d63487982e70adc83ca6c6f4e
+SHA512:
+  metadata.gz: c46009068385a016cc3ed4cbb42c4286272f234850c8ab95111fdb00d253d5a7b4b9c771aa7c2d0f75f3d3b775d6b6fbfe38b00316fdda843c78dde3ffbbd005
+  data.tar.gz: d96c4583c9d647d2162974c96642a9bbcd62f563ef89894f733c925ec2631a70c32a91e720a27de95e4103220f3ba89256882fdaf47a9b79beb75694b537b53e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_mint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nick Marrone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# RubyMint
+
+RubyMint is a gem to assist you with getting information from Mint.com's API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_mint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_mint
+
+## Usage
+
+# Initiate the Gem
+
+RubyMint must be initiated using an email address and password. Prior to making
+any calls to the API, you must also login.
+
+```ruby
+ruby_mint = RubyMint.new('myemail@foobar.com', 'mysecretpassword')
+ruby_mint.login
+```
+
+# Refreshing Data
+
+Mint.com does not keep financial data 100% up to date, so if you want to get the most recent
+account and transaction data you must first refresh the data. Once a refresh has been
+initiated, it takes at least a few seconds for Mint.com to complete. There is also a method
+to check refresh status.
+
+```ruby
+ruby_mint.initiate_account_refresh
+ruby_mint.refreshing?
+```
+
+For convenience, you can also include a block to execute once refreshing is complete. There is
+an optional parameter to indicate how many seconds to wait between calls to check if the Mint.com
+is still refreshing.
+
+```ruby
+ruby_mint.initiate_account_refresh(3) do
+  # Get your mint data once refresh is complete
+  puts "Refresh complete!"
+end
+```
+
+# Account Data
+
+Account data is returned as a hash.
+
+```ruby
+accounts = ruby_mint.accounts
+```
+
+# Transaction Data
+
+Mint.com returns transactions as CSV.
+
+```ruby
+transactions = ruby_mint.transactions
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nickmarrone/ruby_mint/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/mint_download.rb

@@ -0,0 +1,100 @@
+require 'ruby_mint'
+require 'csv'
+require 'io/console'
+
+def print_usage
+    puts <<-USAGE
+Usage: ruby #{__FILE__} <-a=account_output> <-t=transaction_output>
+* -a=account_output:     CSV file to append account data to (default to mint_accounts.csv)
+* -t=transaction_output: CSV file to write transaction data to (default to mint_transactions.csv)
+    USAGE
+    exit
+end
+
+def fail!(error_msg)
+  puts "Error: #{error_msg}"
+  print_usage
+end
+
+accounts_file = nil
+transactions_file = nil
+
+if ARGV.length == 0
+  accounts_file = "mint_accounts.csv"
+end
+
+ARGV.each do |arg|
+  command, filename = arg.split('=')
+  case command
+  when '-a'
+    accounts_file = filename
+  when '-t'
+    transactions_file = filename
+  else
+    print_usage
+    exit
+  end
+end
+
+# Get username and password
+print "Email: "
+email = STDIN.gets.chomp
+
+print "Password: "
+password = STDIN.noecho(&:gets).chomp
+print "\n"
+
+ruby_mint = RubyMint.new(email, password)
+
+puts "Logging in..."
+ruby_mint.login
+
+accounts = nil
+transactions = nil
+puts "Refreshing account..."
+
+ruby_mint.initiate_account_refresh do
+  if accounts_file
+    puts "Downloading accounts..."
+    accounts = ruby_mint.accounts
+  end
+
+  if transactions_file
+    puts "Downloading transactions..."
+    transactions = ruby_mint.transactions
+  end
+end
+
+puts "Writing data..."
+timestamp = Time.now.strftime("%Y-%m-%d-%H%M")
+
+if accounts_file
+  # Check if file already exists
+  file_exists = File.file?(accounts_file)
+
+  CSV.open(accounts_file, "a") do |csv|
+    if !file_exists
+      csv << ['id', 'timestamp', 'name', 'subName', 'class', 'value', 'currentBalance']
+    end
+
+    accounts.each do |account|
+      csv << [
+        account["id"],
+        timestamp,
+        account["fiName"],
+        account["accountName"],
+        account["klass"],
+        account["value"],
+        account["currentBalance"]]
+    end
+  end
+end
+
+if transactions_file
+  # Write transactions to file
+  File.open(transactions_file, "w") do |output|
+    output.puts transactions
+  end
+end
+
+puts "Complete!"

data/lib/ruby_mint/version.rb

@@ -0,0 +1,3 @@
+class RubyMint
+  VERSION = "0.1.0"
+end

data/lib/ruby_mint.rb

@@ -0,0 +1,143 @@
+require "ruby_mint/version"
+require "mechanize"
+require "json"
+
+class RubyMintError < StandardError; end
+
+class RubyMint
+  JSON_HEADERS = { "accept" => "application/json" }
+
+  ACCOUNT_TYPES = [
+    "BANK",
+    "CREDIT",
+    "INVESTMENT",
+    "LOAN",
+    "MORTGAGE",
+    "OTHER_PROPERTY",
+    "REAL_ESTATE",
+    "VEHICLE",
+    "UNCLASSIFIED",
+  ]
+
+  # Initialize RubyMint
+  #
+  # @param username [String] usually an email address
+  # @param password [String]
+  def initialize(username, password)
+    @username = username
+    @password = password
+    @request_id = 34
+
+    @token = nil
+  end
+
+  # Login retrieves a user token from Mint.com
+  def login
+    response = agent.get("https://wwws.mint.com/login.event?task=L")
+    raise RubyMintError.new("Unable to GET Mint login page.") if response.code != "200"
+
+    response = agent.post("https://wwws.mint.com/getUserPod.xevent", { "username" => @username }, JSON_HEADERS)
+    raise RubyMintError.new("Unable to POST to getUserPod.") if response.code != "200"
+
+    query = {
+      "username" => @username,
+      "password" => @password,
+      "task" => "L",
+      "browser" => "firefox",
+      "browserVersion" => "27",
+      "os" => "Linux",
+    }
+
+    response = agent.post("https://wwws.mint.com/loginUserSubmit.xevent", query, JSON_HEADERS)
+    if response.code != "200" || !response.body.include?("token")
+      raise RubyMintError.new("Mint.com login failed. Response code: #{response.code}")
+    end
+
+    login_body = JSON.load(response.body)
+    if !login_body || !login_body["sUser"] || !login_body["sUser"]["token"]
+      raise RubyMintError.new("Mint.com login failed (no token in login response body).")
+    end
+
+    @token = login_body["sUser"]["token"]
+  end
+
+  # Check if user is logged in already by the presence of a token.
+  #
+  # @returns [Boolean]
+  def logged_in?
+    !@token.nil?
+  end
+
+  # Request that Mint.com refresh its account and transaction data
+  #
+  # @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)
+    agent.post("https://wwws.mint.com/refreshFILogins.xevent", { "token" => @token }, JSON_HEADERS)
+    if block
+      loop{ sleep sleep_time; break if !refreshing? }
+      yield
+    end
+  end
+
+  # Is Mint.com in the process of refreshing its data?
+  #
+  # @returns [Boolean]
+  def refreshing?
+    response = agent.get("https://wwws.mint.com/userStatus.xevent", JSON_HEADERS)
+    if response.code != "200" || !response.body.include?("isRefreshing")
+      raise RubyMintError.new("Unable to check if account is refreshing.")
+    end
+
+    JSON.parse(response.body)["isRefreshing"]
+  end
+
+  # Get account data
+  #
+  # @param account_types [Array<String>] Type of accounts to retrieve. Defaults to all types.
+  # @returns [Hash]
+  def accounts(account_types = ACCOUNT_TYPES)
+    # Use a new request_id
+    @request_id += 1
+
+    account_query = {
+      "input" => JSON.dump([{
+        "args" => { "types" => account_types },
+        "id" => @request_id.to_s,
+        "service" => "MintAccountService",
+        "task" => "getAccountsSorted",
+      }])}
+
+    # Use token to get list of accounts
+    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"
+
+    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).")
+    end
+
+    account_body["response"][@request_id.to_s]["response"]
+  end
+
+  # Get transactions from mint. They are returned as CSV and include ALL
+  # the transactions available
+  #
+  # @returns [String] CSV of all transactions
+  def transactions
+    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("Non-CSV content returned.") if !results.header["content-type"].include?("text/csv")
+
+    results.body
+  end
+
+
+  private
+
+  def agent
+    @agent ||= Mechanize.new { |agent|
+        agent.user_agent_alias = 'Linux Firefox'
+    }
+  end
+end

data/ruby_mint.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_mint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_mint"
+  spec.version       = RubyMint::VERSION
+  spec.authors       = ["Nick Marrone"]
+  spec.email         = ["nickmarrone@gmail.com"]
+
+  spec.summary       = "Retrieve your Mint.com transaction and account information."
+  spec.description   = "Gem to allow you to incorporate Mint.com into your ruby applications."
+  spec.homepage      = "https://github.com/nickmarrone/ruby_mint"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mechanize", "~> 2.7"
+  spec.add_dependency "json", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: ruby_mint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Marrone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Gem to allow you to incorporate Mint.com into your ruby applications.
+email:
+- nickmarrone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mint_download.rb
+- lib/ruby_mint.rb
+- lib/ruby_mint/version.rb
+- ruby_mint.gemspec
+homepage: https://github.com/nickmarrone/ruby_mint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Retrieve your Mint.com transaction and account information.
+test_files: []