navfund 0.0.2 → 0.0.3

data/README.md

@@ -10,11 +10,11 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install navfund
+    gem install navfund
 
 ## Usage
 
@@ -22,20 +22,36 @@ Get a list of supported Providers:
 
     Navfund::Providers
 
-Get supported funds for a specific Provider:
-
-    Navfund::Sunlife::Funds
-
 Initialize a Provider's data:
 
     @sunlife = Navfund::Sunlife.new
-        
+
+To get a list of supported funds for a specific Provider:
+
+    Navfund::Sunlife::Funds
+    @sunlife.funds  # if a provider is initialized
+
 Get the current NAVPU/NAVPS of a fund, by name:
 
     @sunlife.value("Bond Fund")
     
+Some Providers have a separate page when listing VUL (Variable Unit Life Insurance) fund values. To get the VUL value by name, add a :vul option when calling the value method. It is possible that the same name is used for both VUL and non-VUL funds:
+
+    @sunlife.value("Bond Fund", :vul)
+    
 A Navfund::Provider::InvalidFund will be raised if the specified fund is not supported or is invalid.
 
+## Testing
+
+Install the minitest gem if its not already installed in your system
+
+    gem install minitest
+    
+Then run the tests (default rake task is the 'test' task):
+
+    rake test
+
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -6,4 +6,6 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/lib/navfund/*_test.rb']
   t.verbose = true
 end
+
+desc "Run tests"
 task :default => :test

data/lib/navfund/exceptions.rb

@@ -0,0 +1,19 @@
+# Main module
+
+module Navfund
+
+  class InvalidProvider < StandardError
+    def initialize(msg = "The provider you entered is not supported!")
+      super
+    end
+  end
+  
+  class Provider
+    class InvalidFund < StandardError
+      def initialize(msg = "The fund name you entered is not supported!")
+        super
+      end
+    end
+  end
+  
+end

data/lib/navfund/navfund.rb

@@ -1,7 +1,6 @@
 # Main module
 
 module Navfund
-  class InvalidProvider < StandardError; end
 
   #def self.scrape(url)
   #  Providers.each do |scraper|

data/lib/navfund/provider.rb

@@ -2,11 +2,23 @@
 
 module Navfund
   class Provider
-    class InvalidFund < StandardError; end
     
     def scrape
       @document = open(@url).read
       @wrapped_document = Nokogiri::HTML(@document)
+      if @vul_url
+        @vul_document = open(@vul_url).read
+        @wrapped_vul_document = Nokogiri::HTML(@vul_document)
+      end
     end
+    
+    def self.strip_value(val)
+      val.strip.gsub('PHP', '').gsub('USD', '').strip
+    end
+    
+    def valid_fund?(fund)
+      false
+    end
+    
   end
 end

data/lib/navfund/providers/sunlife.rb

@@ -4,21 +4,34 @@ module Navfund
   class Sunlife < Provider
     # List of funds
     MAIN_URL = "http://www.sunlife.com.ph/philippines/Products+and+Services/Sun+Life+Prosperity+Funds?vgnLocale=en_CA"
+    VUL_URL = "http://www.sunlife.com.ph/philippines/Products+and+Services/VUL?vgnLocale=en_CA"
     Funds = ["Bond Fund", "Balanced Fund", "Equity Fund", "Money Market Fund", "GS Fund", "Dollar Advantage Fund", "Dollar Abundance Fund"]
    
     def initialize
       @url = MAIN_URL
+      @vul_url = VUL_URL
       self.scrape
-    end  
+    end 
     
-    def value(fund)
+    # Fetch the current value
+    # Some providers have a separate page for VUL funds, to force checking the VUL page,
+    # set the type to :vul, for example @sunlife.value("Bond Fund", :vul)
+    # It is possible that the same fund name is used for VUL and non-VUL funds so this is necessary
+    def value(fund, fund_type=nil)
       val = nil
+      # Set fund_type to nil if VUL page is not present
+      fund_type = nil if fund_type == :vul && @wrapped_vul_document.nil?
       if valid_fund?(fund)
-        fname = @wrapped_document.search("[text()*='#{fund}']").first
+        source_document = (fund_type == :vul) ? @wrapped_vul_document : @wrapped_document
+        fname = source_document.search("[text()*='#{fund}']").first
         if fname
           fval = fname.parent.next_element rescue nil
-          val = fval.text.strip.gsub('PHP', '').strip if fval
+        elsif @wrapped_vul_document && fund_type != :vul
+          # Search VUL page (if its not done before)
+          fname = @wrapped_vul_document.search("[text()*='#{fund}']").first
+          fval = fname.parent.next_element rescue nil
         end
+        val = Provider.strip_value(fval.text) if fval
       else
         raise InvalidFund
       end
@@ -28,5 +41,9 @@ module Navfund
     def valid_fund?(fund)
       Funds.include?(fund)
     end
+    
+    def funds
+      Funds
+    end
   end
 end

data/lib/navfund/version.rb

@@ -1,3 +1,3 @@
 module Navfund
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/navfund.rb

@@ -11,6 +11,7 @@ require "navfund/utils/require_relative"
 # Main files
 require "navfund/version"
 require "navfund/navfund"
+require "navfund/exceptions"
 require "navfund/provider"
 
 # Providers

data/test/lib/navfund/function_test.rb

@@ -1,14 +1,5 @@
 require_relative '../../test_helper'
 
 describe Navfund do
-  before do
-    @fund = Navfund::Metrobank.fund("Equity")
-  end
-  it "should get the fund object" do
-    @fund.should_not be_blank
-    STDERR.puts "<p>#{@fund.inspect}</p>"
-  end
-  it "should get the current navpu back in the response" do
-    @fund.value.should_not be_blank
-  end
+  
 end

data/test/lib/navfund/provider_test.rb

@@ -0,0 +1,20 @@
+require_relative '../../test_helper'
+
+describe Navfund do
+  before do
+    @sunlife = Navfund::Sunlife.new
+  end  
+  describe "when a provider is given" do
+    it "should get the provider object" do
+      @sunlife.wont_be_nil
+    end
+    it "should get the current value back in the response" do
+      Navfund::Sunlife::Funds.each do |fund|
+        @sunlife.value(fund).wont_be_nil
+      end
+    end
+    it "should get the current value back in the response when :vul is set" do
+      @sunlife.value("Bond Fund", :vul).wont_be_nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navfund
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -56,6 +56,7 @@ files:
 - README.md
 - Rakefile
 - lib/navfund.rb
+- lib/navfund/exceptions.rb
 - lib/navfund/navfund.rb
 - lib/navfund/provider.rb
 - lib/navfund/providers/metrobank.rb
@@ -64,6 +65,7 @@ files:
 - lib/navfund/version.rb
 - navfund.gemspec
 - test/lib/navfund/function_test.rb
+- test/lib/navfund/provider_test.rb
 - test/lib/navfund/version_test.rb
 - test/test_helper.rb
 homepage: https://github.com/marvs/navfund
@@ -93,5 +95,6 @@ summary: Navfund is a ruby gem that fetches the values of the current NAVPU/NAVP
   of several Banks/Providers of UITFs/Mutual Funds
 test_files:
 - test/lib/navfund/function_test.rb
+- test/lib/navfund/provider_test.rb
 - test/lib/navfund/version_test.rb
 - test/test_helper.rb