transaction_faker 1.0.0

data/lib/transaction_faker/models/account.rb

@@ -0,0 +1,47 @@
+module TransactionFaker
+
+  class Account
+    attr_accessor :balance, :id, :institution_type, :item, :user, :type, :meta
+
+    def initialize(available_balance, current_balance)
+      @id   = Faker::Lorem.characters(37)
+      @item = Faker::Lorem.characters(37)
+      @user = Faker::Lorem.characters(37)
+      @institution_type  = get_random_institution
+      @balance = get_balance(available_balance, current_balance)
+      @meta = get_meta
+      @type = "depository"
+    end
+
+    def ==(other_account)
+      @id = other_account.id
+    end
+
+    private
+
+    def get_random_institution
+      ['amex', 'bofa', 'capone360', 'schwab', 'chase', 'citi', 'fidelity', 'pnc',
+       'svb', 'us', 'usaa', 'wells'].sample
+    end
+
+    def get_balance(available_balance, current_balance)
+      balance = {
+        "available" => available_balance,
+        "current" => current_balance
+      }
+    end
+
+    def get_meta
+      meta = {
+        "name" => get_account_name,
+        "number" => Faker::Number.number(4)
+      }
+    end
+
+    def get_account_name
+      string = Faker::Name.name
+      (rand >= 0.5) ? string += "'s Savings" : string += "'s Checking"
+      string
+    end
+  end
+end

data/lib/transaction_faker/models/transaction.rb

@@ -0,0 +1,63 @@
+require 'date'
+
+module TransactionFaker
+  #Excluded meta
+  class Transaction
+    attr_accessor :id, :account, :date, :amount, :name, :meta, :location, :pending, :score, :type, :cat, :category, :category_id, :pending_transaction
+
+    def initialize(account, amount, category_arr, cat_id, month_offset)
+      @id = Faker::Lorem.characters(38)
+      @account = account
+      @date = generate_date(month_offset)
+      @amount = amount
+      @name = Faker::Company.name
+      @location = create_location_hash()
+      @pending = false #should this vary?
+      @pendingTransaction = nil
+      @score = create_score
+
+      # Here for backwards compatibility only.
+      @type = { primary: Categories.get_transaction_type(cat_id) }
+      @category = category_arr
+      @category_id = cat_id
+      @meta = {"location" => @location["coordinates"]}
+    end
+
+    def ==(other_transaction)
+      @id == other_transaction.id
+    end
+
+    private
+
+    def generate_date(month_offset)
+      today = Date.today
+      month = today.prev_month(month_offset)
+
+      start_of_month = Date.new(month.year, month.month)
+      end_of_month = Date.new(start_of_month.year, start_of_month.month + 1) - 1
+
+      Faker::Date.between(start_of_month, end_of_month).iso8601
+    end
+
+    def create_location_hash()
+      hash = {
+        "coordinates" => {
+          "lat" => Faker::Address.latitude.to_i,
+          "lon" => Faker::Address.longitude.to_i,
+        }
+      }
+    end
+
+    def create_score
+      hash = {
+        "master" => 1,
+        "detail" => {
+          "address" => 1,
+          "city" => 1,
+          "name" => 1,
+          "state" => 1
+        }
+      }
+    end
+  end
+end

data/lib/transaction_faker/models/user.rb

@@ -0,0 +1,61 @@
+require 'json'
+
+module TransactionFaker
+  class User
+    attr_accessor :account, :transactions, :access_token
+
+    def initialize(available_balance, current_balance, transaction_hash, seed = nil)
+      srand(seed) if seed
+      @account = Account.new(available_balance, current_balance)
+      @transactions = TransactionHelper::create_transactions(transaction_hash, account)
+      @access_token = Faker::Lorem.characters(37)
+    end
+
+    def ==(other_user)
+      @account == other_user.account
+    end
+
+    def to_json
+      user_hash = {
+        accounts: [
+          {
+            _id: @account.id,
+            _item: @account.item,
+            _user: @account.user,
+            balance: {
+              available: @account.balance["available"],
+              current: @account.balance["current"]
+            },
+            institution_type: @account.institution_type,
+            meta: @account.meta,
+            type: @account.type
+          }
+        ],
+        transactions: add_hash_transactions
+      }
+      JSON.pretty_generate(user_hash)
+    end
+
+    def add_hash_transactions
+      @transactions.map do |transaction|
+        {
+          _account: transaction.account.id,
+          _id: transaction.id,
+          amount: transaction.amount,
+          date: transaction.date,
+          name: transaction.name,
+          meta: transaction.meta,
+          pending: transaction.pending,
+          type: transaction.type,
+          category: transaction.category,
+          category_id: transaction.category_id,
+          score: transaction.score
+        }
+      end
+    end
+  end
+end
+
+
+
+

data/lib/transaction_faker/transaction_helper.rb

@@ -0,0 +1,52 @@
+require_relative 'categories'
+require_relative 'models/transaction'
+require 'faker'
+
+module TransactionFaker
+  class TransactionHelper
+
+    # Returns an array with "amount" number of random values that comply with the
+    # mean and the standard_dev.The function gen.rng() will return an error if standard_dev
+    # is 0, so 0.000001 provides the same functionality
+    def self.normal_distribution(mean, standard_dev, amount)
+      standard_dev = 0.000001 if standard_dev == 0
+      gen = Rubystats::NormalDistribution.new(mean, standard_dev)
+      amount.times.map{ gen.rng().round(2) }
+    end
+
+    #Uses the TransactionHelper objects from the array created in 'create_data' to
+    #create an array of transactions over three months.
+    def self.create_transactions(transaction_hash, account_id)
+      3.times.flat_map do |month_offset|
+        transaction_hash.flat_map do |category, data|
+          subcategories = Categories::SUBCATEGORIES[category]
+
+          normal_distribution(data[:mean], data[:std_dev], data[:monthly_freq]).map do |price|
+            category_id = subcategories.sample
+            cat_array = create_category_array(category_id)
+            Transaction.new(account_id, price, cat_array, category_id.to_s, month_offset + 1)
+          end
+        end
+      end
+    end
+
+    #Returns an array of strings with the category hierarchy,
+    #   i.e. ["Food and Drink", "Restaurants", "Mexican"]
+    def self.create_category_array(id_num)
+      array = [
+        Categories::FIRST_DIV[convert_id(id_num, 1)],
+        Categories::SECOND_DIV[convert_id(id_num, 2)],
+        Categories::THIRD_DIV[id_num]
+      ].compact
+    end
+
+    #Takes in a transaction ID number and floors it to match its superior category's ID
+    #cat_division is either 1 (first category) or 2
+    #   i.e. 12034890 -> 12034000 or 12034890 -> 12000000
+    def self.convert_id(id_num, cat_division)
+      divisor = 1000**(3 - cat_division)
+      converted_id = ((id_num.to_f / divisor).to_i * divisor)
+    end
+
+  end
+end

data/lib/transaction_faker/version.rb

@@ -0,0 +1,3 @@
+module TransactionFaker
+  VERSION = "1.0.0"
+end

data/transaction_faker.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transaction_faker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transaction_faker"
+  spec.version       = TransactionFaker::VERSION
+  spec.authors       = ["Abiel Gutierrez"]
+  spec.email         = ["abielg@stanford.com"]
+
+  spec.summary       = %q{Creates fake bank account data and transactions to mimick an API response from Plaid's "Connect" service.}
+  spec.homepage      = "https://github.com/abielg/transaction-faker"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+ # if spec.respond_to?(:metadata)
+ #   spec.metadata['allowed_push_host'] = "https://github.com/abielg/transaction-faker"
+ # else
+ #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+ # end
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  #Gem Dependencies
+  spec.add_dependency "faker"
+  spec.add_dependency "rubystats"
+  spec.add_dependency "descriptive_statistics"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: transaction_faker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Abiel Gutierrez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubystats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: descriptive_statistics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- abielg@stanford.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/transaction_faker.rb
+- lib/transaction_faker/categories.rb
+- lib/transaction_faker/models/account.rb
+- lib/transaction_faker/models/transaction.rb
+- lib/transaction_faker/models/user.rb
+- lib/transaction_faker/transaction_helper.rb
+- lib/transaction_faker/version.rb
+- transaction_faker.gemspec
+homepage: https://github.com/abielg/transaction-faker
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Creates fake bank account data and transactions to mimick an API response
+  from Plaid's "Connect" service.
+test_files: []