lendmarket 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1926912dc91c179a7e7a5f6555db75f9545bdece
+  data.tar.gz: 55da7b97250421df1ded582ca55abb60d3c4a5cd
+SHA512:
+  metadata.gz: b44b63893c7ea702d1509bb2136854bf36e67dbe871f9eba00e6b566b9d3e29657a3e1663c5419856ae53a945af05acce382728cd1bfc63615d95fc4aff22d75
+  data.tar.gz: ab8bde85183e038c9bf64c6af947a4ddf5b27f8fa0e6d2f9bba366f1844bc26557c9ebcbad5adbb203f274cb7d8b1ca6f0b4ba8488467b72fe1a7680bb175ff5

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+/.idea/
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Valters Krontals
+
+MIT License
+
+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,32 @@
+# Lendmarket
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lendmarket'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lendmarket
+
+## Usage
+
+    $ lendmarket [market.csv] [loan_amount]
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lendmarket/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/lendmarket

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'lendmarket'
+require 'csv_tools'
+
+TERM = 36
+class NoMarketFile < StandardError; end
+
+begin
+  raise NoMarketFile if ARGV[0].nil?
+
+  csv_data = File.read(ARGV[0])
+  markets_hash = Lendmarket::CSVTools.csv_to_hash csv_data
+  quote = Lendmarket::Quote.new({ amount: ARGV[1].to_i, term: TERM, markets: markets_hash }).calc
+
+  puts "Requested amount: £%d" % quote[:requested_amount]
+  puts "Rate: %.1f%" % quote[:rate]
+  puts "Monthly repayment: £%.2f" % quote[:monthly_repayment]
+  puts "Total repayment: £%.2f" % quote[:total_repayment]
+
+rescue Errno::ENOENT
+  puts 'Markets file not found, check the path and try again'
+
+rescue Lendmarket::NotEnoughMoney
+  puts 'Sorry, it is not possible to provide a quote at this time'
+
+rescue Lendmarket::InvalidAmount
+  valid_amount_txt = Lendmarket::Quote::VALID_AMOUNT.minmax.join(' and ')
+  puts 'The seleced loan amount is not valid'
+  puts "You must choose an amount between #{ valid_amount_txt } in 100 increments"
+
+rescue NoMarketFile
+  puts 'You must provide a markets file'
+
+ensure
+  puts "\n\nusage: lendmarket [market.csv] [loan_amount]"
+
+end

data/data/market.csv

@@ -0,0 +1,8 @@
+Lender,Rate,Available
+Bob,0.075,640
+Jane,0.069,480
+Fred,0.071,520
+Mary,0.104,170
+John,0.081,320
+Dave,0.074,140
+Angela,0.071,60

data/lendmarket.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lendmarket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lendmarket"
+  spec.version       = Lendmarket::VERSION
+  spec.authors       = ["Valters Krontals"]
+  spec.email         = ["v.krontals@gmail.com"]
+  spec.summary       = %q{Command line tool to get the best rate}
+  spec.description   = %q{Get the best rate from lenders}
+  spec.homepage      = "https://github.com/vkrontals/lendmarket"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ['lendmarket']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "lib/lendmarket"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

data/lib/lendmarket/csv_tools.rb

@@ -0,0 +1,14 @@
+require 'csv'
+
+module Lendmarket
+  module CSVTools
+
+    def self.csv_to_hash(csv_data)
+      csv_data = CSV.parse(csv_data, { converters: :numeric })
+      keys = csv_data.shift.map{ |x| x.downcase.to_sym }
+      csv_data.map {|a| Hash[ keys.zip(a.map{ |x| x })] }
+    end
+
+  end
+
+end

data/lib/lendmarket/exceptions.rb

@@ -0,0 +1,10 @@
+module Lendmarket
+
+  class InvalidAmount < StandardError; end
+
+  # when given markets don't have enough money
+  class NotEnoughMoney < StandardError; end
+
+  class NoMarketsFound < StandardError; end
+
+end

data/lib/lendmarket/formulas.rb

@@ -0,0 +1,39 @@
+module Excel
+  module Formulas
+    def pmt(rate, nper, pv, fv=0, type=0)
+      ((-pv * pvif(rate, nper) - fv ) / ((1.0 + rate * type) * fvifa(rate, nper)))
+    end
+
+    def ipmt(rate, per, nper, pv, fv=0, type=0)
+      p = pmt(rate, nper, pv, fv, 0);
+      ip = -(pv * pow1p(rate, per - 1) * rate + p * pow1pm1(rate, per - 1))
+      (type == 0) ? ip : ip / (1 + rate)
+    end
+
+    def ppmt(rate, per, nper, pv, fv=0, type=0)
+      p = pmt(rate, nper, pv, fv, type)
+      ip = ipmt(rate, per, nper, pv, fv, type)
+      p - ip
+    end
+
+    protected
+
+    def pow1pm1(x, y)
+      (x <= -1) ? ((1 + x) ** y) - 1 : Math.exp(y * Math.log(1.0 + x)) - 1
+    end
+
+    def pow1p(x, y)
+      (x.abs > 0.5) ? ((1 + x) ** y) : Math.exp(y * Math.log(1.0 + x))
+    end
+
+    def pvif(rate, nper)
+      pow1p(rate, nper)
+    end
+
+    def fvifa(rate, nper)
+      (rate == 0) ? nper : pow1pm1(rate, nper) / rate
+    end
+
+  end
+
+end

data/lib/lendmarket/version.rb

@@ -0,0 +1,3 @@
+module Lendmarket
+  VERSION = "0.0.1"
+end

data/lib/lendmarket.rb

@@ -0,0 +1,75 @@
+require "lendmarket/version"
+require "lendmarket/exceptions"
+require "lendmarket/formulas"
+
+module Lendmarket
+  class Quote
+    include Excel::Formulas
+    attr_reader :amount, :markets, :term
+
+    VALID_AMOUNT = (1000..15000).step(100).to_a
+    Market = Struct.new( :rate, :available)
+
+    def initialize(args)
+      raise Lendmarket::InvalidAmount unless VALID_AMOUNT.include?(args[:amount])
+
+      @amount = args[:amount]
+      @markets = marketify args[:markets]
+      @term = args[:term]
+      raise Lendmarket::NotEnoughMoney if amount > money_available
+    end
+
+    def calc
+      {
+        requested_amount: amount,
+        rate: (rate * 100).round(1),
+        monthly_repayment: monthly_repayment.round(2),
+        total_repayment: total_repayment.round(2)
+      }
+    end
+
+    private
+
+    def total_repayment
+      monthly_repayment * term
+    end
+
+    def rate
+      val = sorted_markets
+       .reduce([]) do |result, market|
+         result << market if money_available(result) < amount
+         result
+       end
+
+      val.reduce(0) { |sum, n| sum + n.rate } / val.length
+    end
+
+    def money_available(markets_array = markets)
+      markets_array.reduce(0) { |sum, n| sum + n.available }
+    end
+
+    def monthly_repayment
+      pmt(monthly_rate, term, -amount)
+    end
+
+    def monthly_rate
+      (1 + rate) ** (1 / 12.0) - 1
+    end
+
+    def marketify(markets_array)
+      markets_array.reduce([]) do |result, lender|
+        (lender[:available].to_i / 10).times do
+          result << Market.new(lender[:rate], 10)
+        end
+
+        result
+      end
+    end
+
+    def sorted_markets
+      markets.sort_by { |x| x[:rate] }
+    end
+
+  end
+
+end

data/spec/csv_to_hash_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'csv_tools'
+
+describe Lendmarket::CSVTools do
+  let(:csv_data) {
+<<HERE
+Lender,Rate,Available
+Bob,0.075,640
+Jane,0.069,480
+HERE
+}
+  describe '#csv_to_hash' do
+    it 'converts a csv file to hash' do
+      expect(Lendmarket::CSVTools.csv_to_hash(csv_data)).to eq(
+        [{ lender: 'Bob', rate: 0.075, available: 640 },
+         { lender: 'Jane', rate: 0.069, available: 480 }])
+    end
+
+  end
+
+end

data/spec/lendmarket_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Lendmarket::Quote  do
+
+  let (:markets) {
+    [
+      { lender: 'Bob'   , rate: 0.075, available: 640 },
+      { lender: 'Jane'  , rate: 0.069, available: 480 },
+      { lender: 'Fred'  , rate: 0.071, available: 520 },
+      { lender: 'Mary'  , rate: 0.104, available: 170 },
+      { lender: 'John'  , rate: 0.081, available: 320 },
+      { lender: 'Dave'  , rate: 0.074, available: 140 },
+      { lender: 'Angela', rate: 0.071, available: 60 }
+    ]
+  }
+
+  describe "#new" do
+
+    it "raises exception if not enough money is available" do
+      expect { Lendmarket::Quote.new({ amount: 15000, term: 36, markets: markets }) }
+        .to raise_error Lendmarket::NotEnoughMoney
+    end
+
+    it "raises exception if amount is invalid" do
+      [50, 110, -100, 16000, 'test', '@£$@'].each do |amount|
+        expect { Lendmarket::Quote.new({ amount: amount, term: 36, markets: markets }) }
+          .to raise_error Lendmarket::InvalidAmount
+      end
+
+    end
+
+  end
+
+  describe "#total_repayment" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it { expect(quote.send :total_repayment).to be_within(0.01).of(1108.10) }
+
+  end
+
+  describe "#rate" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it { expect(quote.send :rate).to be_within(0.01).of(0.07) }
+  end
+
+  describe "#monthly_repayment" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it { expect(quote.send :monthly_repayment).to be_within(0.01).of(30.78) }
+  end
+
+  describe "#monthly_rate" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it { expect(quote.send :monthly_rate).to be_within(0.001).of(0.005) }
+  end
+
+  describe "#marketify" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it 'returns an array of markets' do
+      marketified = quote.send:marketify, markets
+      expect(marketified.length).to be(233)
+
+      marketified.each do |m|
+        expect(m.respond_to?(:rate)).to be true
+        expect(m.respond_to?(:available)).to be true
+      end
+
+    end
+
+  end
+
+  describe "#money_available" do
+    let(:quote) { Lendmarket::Quote.new({ amount: 1000, term: 36, markets: markets }) }
+
+    it { expect(quote.send :money_available).to eq 2330 }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'lendmarket'
+
+RSpec.configure do |config|
+  config.color = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: lendmarket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valters Krontals
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Get the best rate from lenders
+email:
+- v.krontals@gmail.com
+executables:
+- lendmarket
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/lendmarket
+- data/market.csv
+- lendmarket.gemspec
+- lib/lendmarket.rb
+- lib/lendmarket/csv_tools.rb
+- lib/lendmarket/exceptions.rb
+- lib/lendmarket/formulas.rb
+- lib/lendmarket/version.rb
+- spec/csv_to_hash_spec.rb
+- spec/lendmarket_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vkrontals/lendmarket
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/lendmarket
+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: Command line tool to get the best rate
+test_files:
+- spec/csv_to_hash_spec.rb
+- spec/lendmarket_spec.rb
+- spec/spec_helper.rb