mortgagerb 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15d0932e45e8a052fd914fe4deec87393e381d67e8b3cfdd7303b3d96072375c
-  data.tar.gz: be02a4e36939c96e569540b0a67a9b07e744482fd3493ae330ab6c2dd2b9ee50
+  metadata.gz: d8e3fcee7b69255bf0df020d2a1e38600bf355b9c3dc3478df00caec5cbc64aa
+  data.tar.gz: ee31b2bbb990b25daec56f30a043d0b62211d72da1480570a67d85b457e5cd4b
 SHA512:
-  metadata.gz: bf8847fda2ddf9ddb30b1373dff35ba4845f47902079e321e9993a6b64b92eca62a63832683a51ef6fd83a1a794a08b4536b305ecfacf23de4d6ef35afac5c1a
-  data.tar.gz: fba108618cbaf0b44d918460ba2c9194586942b6744bef324234d29cac72c6276ffd9e20ba40bd8b7c74acca817131e3744951b0beab6e0da8296b8651fa0489
+  metadata.gz: 8c7e1926a18c4dabbd13c1a5b114cf2c440a517204dfcccb13ab2fa20593f4f7bb8db467d1f896fa7f54cef9498bb76901548a78cd1e9e27f29de89a0bf6fab8
+  data.tar.gz: 413800dccf465e107ed86dbcc2fa494c3c29fb4d3017f19b1af53d5cb64b9cf284f3de57824a3ec7ec080fa4926c824f876236a966e347466c804eef48dbe2d0

data/README.md

@@ -30,6 +30,21 @@ scenario = Mortgagerb::Scenario.new(principal, rate, type)
 amortization_payment = scenario.calculate # 5677.89
 ```
 
+### Get the 30-Yr FRM and 15-Yr FRM from Freddie Mac
+
+The gem will scrape Freddie Mac's website in order to get the rates.
+Use this responsibly. Do not over-scrape the website. Cache the value locally.
+Check for new data seldomly.
+
+```ruby
+require 'mortgagerb'
+
+rates_now = Mortgagerb::FreddieMac.now
+frm30 = rates_now[:fmr30] # 7.77
+frm15 = rates_now[:frm15] # 6.66
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/mortgagerb/freddie_mac.rb

@@ -0,0 +1,27 @@
+require "faraday"
+require "nokogiri"
+
+module Mortgagerb
+  class FreddieMac
+    def self.now
+      parsed_data = fetch
+      locate_assign(parsed_data)
+    end
+
+    def self.fetch
+      response = Faraday.get("https://www.freddiemac.com/pmms/pmmsthick.html")
+      html = response.body
+      parsed_data = Nokogiri::HTML.parse(html)
+    end
+
+    def self.locate_assign(parsed_data)
+      fmr30 = parsed_data.xpath("//div[@class='pmmsContainer']/table[@class='table1']/tr/td[1]")
+      fmr15 = parsed_data.xpath("//div[@class='pmmsContainer']/table[@class='table1']/tr/td[2]")
+
+      {
+        fmr30: fmr30.text.strip.to_f,
+        fmr15: fmr15.text.strip.to_f
+      }
+    end
+  end
+end

data/lib/mortgagerb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mortgagerb
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/lib/mortgagerb.rb

@@ -2,6 +2,7 @@
 
 require_relative "mortgagerb/version"
 require_relative "mortgagerb/calculator"
+require_relative "mortgagerb/freddie_mac"
 require_relative "mortgagerb/scenario"
 
 module Mortgagerb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mortgagerb
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Kim
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies: []
 description: Calculate periodic payment given principal, rate and mortgage type
 email:
@@ -24,6 +24,7 @@ files:
 - Rakefile
 - lib/mortgagerb.rb
 - lib/mortgagerb/calculator.rb
+- lib/mortgagerb/freddie_mac.rb
 - lib/mortgagerb/scenario.rb
 - lib/mortgagerb/version.rb
 - sig/mortgagerb.rbs