gmoney 0.0.2 → 0.1.0

data/Manifest

@@ -2,6 +2,7 @@ Manifest
 README.rdoc
 Rakefile
 gmoney.gemspec
+lib/extensions/fixnum.rb
 lib/extensions/string.rb
 lib/gmoney.rb
 lib/gmoney/authentication_request.rb
@@ -22,9 +23,11 @@ spec/fixtures/default_portfolios_feed.xml
 spec/fixtures/empty_portfolio_feed.xml
 spec/fixtures/portfolio_9_feed.xml
 spec/fixtures/portfolio_feed_with_returns.xml
+spec/fixtures/position_feed_for_9_GOOG.xml
 spec/fixtures/positions_feed_for_portfolio_14.xml
 spec/fixtures/positions_feed_for_portfolio_9.xml
 spec/fixtures/positions_feed_for_portfolio_9r.xml
+spec/fixtures/transaction_feed_for_GOOG_1.xml
 spec/fixtures/transactions_feed_for_GOOG.xml
 spec/gmoney_spec.rb
 spec/portfolio_feed_parser_spec.rb

data/README.rdoc

@@ -4,17 +4,61 @@ A gem for interacting with the Google Finance API
 
 == Install
 
+  gem install gmoney
+  
+  or
+  
   gem install jspradlin-gmoney --source http://gems.github.com
   
 == Usage
 
-GMoney::GFSession.login('google username', 'password')
+Login
+-----
+  
+    > GMoney::GFSession.login('google username', 'password')
+
+Portfolios
+--------
+
+    > portfolios = GMoney::Portfolio.all #returns all of a users portfolios
+    > portfolio = GMoney::Portfolio.find(9) #returns a specific portfolio
+    
+    > positions = portfolio.positions #returns an Array of the Positions held within a given portfolio
+     
+Positions    
+--------
 
-portfolios = GMoney::Portfolio.all #or GMoney::Portfolio.all(:with_returns => true)
+    > positions = GMoney::Position.find(9) #returns all of a users positions within a given portfolio, i.e. Portfolio "9"
+    > position = GMoney::Position.find("9/NASDAQ:GOOG") #returns a specific position within a given portfolio
+    
+    > transactions = position.transactions #returns an Array of the Transactions within a given position
+
+Transactions
+--------
+
+    > transactions = GMoney::Transaction.find("9/NASDAQ:GOOG") #returns all of a users transactions within a given position
+    > transaction = GMoney::Transaction.find("9/NASDAQ:GOOG/2") #returns a specific transaction within a given position
+    
+----------
+
+Options parameter
+
+  
+  The following methods:
+    Portfolio.all
+    Portfolio.find
+    portfolio.positions #where portfolio is an instance of the Portfolio class
 
-#wait for a minute or so
+    Position.find
+    position.transactions #where position is an instance of the Position class
+    
+    Transaction.find
+   
+  all take a hash as an optional last parameter.  Valid values for this hash are:
 
-portfolios will now contain a list of all of your google finance portfolios, positions, and transactions
+  * :returns - By default Google does not return a comprehensive list of returns data.  Set this parameter to true to access this information.
+  * :refresh - GMoney caches the data returned from Google by default.  Set :refresh => true if you would like to get the latest data.
+  * :eager - GMoney lazily loads children data (i.e. positions for a given Portfolio).  If you would like to load all of this data at once set :eager => true
 
 == License
 

data/Rakefile

@@ -1,12 +1,13 @@
 require 'rubygems'
 require 'rake'
 require 'echoe'
-require 'spec/rake/spectask'
+require 'spec/rake/spectask'
+require 'lib/gmoney'
 
-task :default => :specs
+task :default => :spec
 
 desc "Run the gmoney specs"
-task :specs do
+task :spec do
   Spec::Rake::SpecTask.new do |t|
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.rcov = true
@@ -15,11 +16,14 @@ task :specs do
   end
 end
 
-Echoe.new('gmoney', '0.0.2') do |p|
-  p.description = "A gem for interacting with the Google Finance API"
-  p.url = "http://github.com/jspradlin/gmoney"
-  p.author = "Justin Spradlin"
-  p.email = "jspradlin@gmail.com"
-  p.ignore_pattern = ["coverage/*", "*~"]
-  p.development_dependencies = []
+desc "Gemify GMoney"
+  namespace :gemify do
+  Echoe.new('gmoney', GMoney.version) do |p|
+    p.description = "A gem for interacting with the Google Finance API"
+    p.url = "http://github.com/jspradlin/gmoney"
+    p.author = "Justin Spradlin"
+    p.email = "jspradlin@gmail.com"
+    p.ignore_pattern = ["coverage/*", "*~"]
+    p.development_dependencies = []
+  end
 end

data/gmoney.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmoney}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Spradlin"]
-  s.date = %q{2009-09-16}
+  s.date = %q{2009-10-01}
   s.description = %q{A gem for interacting with the Google Finance API}
   s.email = %q{jspradlin@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/extensions/string.rb", "lib/gmoney.rb", "lib/gmoney/authentication_request.rb", "lib/gmoney/feed_parser.rb", "lib/gmoney/gf_request.rb", "lib/gmoney/gf_response.rb", "lib/gmoney/gf_service.rb", "lib/gmoney/gf_session.rb", "lib/gmoney/portfolio.rb", "lib/gmoney/portfolio_feed_parser.rb", "lib/gmoney/position.rb", "lib/gmoney/position_feed_parser.rb", "lib/gmoney/transaction.rb", "lib/gmoney/transaction_feed_parser.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "gmoney.gemspec", "lib/extensions/string.rb", "lib/gmoney.rb", "lib/gmoney/authentication_request.rb", "lib/gmoney/feed_parser.rb", "lib/gmoney/gf_request.rb", "lib/gmoney/gf_response.rb", "lib/gmoney/gf_service.rb", "lib/gmoney/gf_session.rb", "lib/gmoney/portfolio.rb", "lib/gmoney/portfolio_feed_parser.rb", "lib/gmoney/position.rb", "lib/gmoney/position_feed_parser.rb", "lib/gmoney/transaction.rb", "lib/gmoney/transaction_feed_parser.rb", "spec/authentication_request_spec.rb", "spec/fixtures/cacert.pem", "spec/fixtures/default_portfolios_feed.xml", "spec/fixtures/empty_portfolio_feed.xml", "spec/fixtures/portfolio_9_feed.xml", "spec/fixtures/portfolio_feed_with_returns.xml", "spec/fixtures/positions_feed_for_portfolio_14.xml", "spec/fixtures/positions_feed_for_portfolio_9.xml", "spec/fixtures/positions_feed_for_portfolio_9r.xml", "spec/fixtures/transactions_feed_for_GOOG.xml", "spec/gmoney_spec.rb", "spec/portfolio_feed_parser_spec.rb", "spec/portfolio_spec.rb", "spec/position_feed_parser_spec.rb", "spec/position_spec.rb", "spec/request_spec.rb", "spec/response_spec.rb", "spec/service_spec.rb", "spec/session_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "spec/transaction_feed_parser_spec.rb", "spec/transaction_spec.rb"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/extensions/fixnum.rb", "lib/extensions/string.rb", "lib/gmoney.rb", "lib/gmoney/authentication_request.rb", "lib/gmoney/feed_parser.rb", "lib/gmoney/gf_request.rb", "lib/gmoney/gf_response.rb", "lib/gmoney/gf_service.rb", "lib/gmoney/gf_session.rb", "lib/gmoney/portfolio.rb", "lib/gmoney/portfolio_feed_parser.rb", "lib/gmoney/position.rb", "lib/gmoney/position_feed_parser.rb", "lib/gmoney/transaction.rb", "lib/gmoney/transaction_feed_parser.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "gmoney.gemspec", "lib/extensions/fixnum.rb", "lib/extensions/string.rb", "lib/gmoney.rb", "lib/gmoney/authentication_request.rb", "lib/gmoney/feed_parser.rb", "lib/gmoney/gf_request.rb", "lib/gmoney/gf_response.rb", "lib/gmoney/gf_service.rb", "lib/gmoney/gf_session.rb", "lib/gmoney/portfolio.rb", "lib/gmoney/portfolio_feed_parser.rb", "lib/gmoney/position.rb", "lib/gmoney/position_feed_parser.rb", "lib/gmoney/transaction.rb", "lib/gmoney/transaction_feed_parser.rb", "spec/authentication_request_spec.rb", "spec/fixtures/cacert.pem", "spec/fixtures/default_portfolios_feed.xml", "spec/fixtures/empty_portfolio_feed.xml", "spec/fixtures/portfolio_9_feed.xml", "spec/fixtures/portfolio_feed_with_returns.xml", "spec/fixtures/position_feed_for_9_GOOG.xml", "spec/fixtures/positions_feed_for_portfolio_14.xml", "spec/fixtures/positions_feed_for_portfolio_9.xml", "spec/fixtures/positions_feed_for_portfolio_9r.xml", "spec/fixtures/transaction_feed_for_GOOG_1.xml", "spec/fixtures/transactions_feed_for_GOOG.xml", "spec/gmoney_spec.rb", "spec/portfolio_feed_parser_spec.rb", "spec/portfolio_spec.rb", "spec/position_feed_parser_spec.rb", "spec/position_spec.rb", "spec/request_spec.rb", "spec/response_spec.rb", "spec/service_spec.rb", "spec/session_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/string_spec.rb", "spec/transaction_feed_parser_spec.rb", "spec/transaction_spec.rb"]
   s.homepage = %q{http://github.com/jspradlin/gmoney}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gmoney", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/lib/extensions/fixnum.rb

@@ -0,0 +1,13 @@
+class Fixnum
+  def portfolio_id
+    self.to_s.portfolio_id
+  end
+  
+  def position_id
+    self.to_s.position_id
+  end
+  
+  def transaction_id
+    self.to_s.transaction_id
+  end    
+end

data/lib/extensions/string.rb

@@ -1,4 +1,16 @@
 class String
+  class PortfolioParseError < StandardError; end
+  class PositionParseError < StandardError; end
+  class TransactionParseError < StandardError; end
+  
+  @@portfolio_re = /\d+/
+  @@portfolio_re_in = /^\d+$/  
+  @@position_re = /\d+\/[a-zA-Z]+:[a-zA-Z]+/
+  @@position_re_in = /^\d+\/[a-zA-Z]+:[a-zA-Z]+$/
+  @@transaction_re = /\d+\/[a-zA-Z]+:[a-zA-Z]+\/\d+/
+  @@transaction_re_in = /^\d+\/[a-zA-Z]+:[a-zA-Z]+\/\d+$/
+
+
   def camel_to_us
     add_us = gsub(/(.)([A-Z][a-z]+)/, '\1_\2')
     add_us.gsub(/([a-z0-9])([A-Z])/, '\1_\2').downcase  
@@ -7,4 +19,44 @@ class String
   def is_numeric?
     Float self rescue false
   end
+  
+  def portfolio_feed_id
+    self[self.rindex('/')+1..-1]
+  end
+  
+  def position_feed_id
+   portfolio = self[self.rindex('portfolios/')+11..index('/positions')-1]
+   position = self[rindex('/')+1..-1]
+   "#{portfolio}/#{position}"
+  end  
+  
+  def portfolio_id
+    if self[@@transaction_re_in] || self[@@position_re_in] || self[@@portfolio_re_in]
+      self[@@portfolio_re]
+    else
+      raise PortfolioParseError
+    end
+  end
+  
+  def position_id
+    if self[@@portfolio_re_in] 
+      ""
+    elsif self[@@position_re_in] 
+      self[self.index('/')+1..-1]  
+    elsif self[@@transaction_re_in]
+      self[self.index('/')+1..self.rindex('/')-1] 
+    else
+      raise PositionParseError
+    end
+  end
+  
+  def transaction_id
+    if self[@@position_re_in] 
+      ""
+    elsif self[@@transaction_re_in]
+      self[self.rindex('/')+1..-1] 
+    else
+      raise TransactionParseError
+    end
+  end
 end

data/lib/gmoney.rb

@@ -10,6 +10,7 @@ require 'net/http'
 require 'net/https'
 require 'rexml/document'
 
+require 'extensions/fixnum'
 require 'extensions/string'
 
 require 'gmoney/authentication_request'
@@ -26,9 +27,10 @@ require 'gmoney/transaction'
 require 'gmoney/transaction_feed_parser'
 
 module GMoney
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
   GF_URL = "https://finance.google.com/finance"
   GF_FEED_URL = "#{GF_URL}/feeds/default"
+  GF_PORTFOLIO_FEED_URL = "#{GF_FEED_URL}/portfolios"
   
   HTTPOK = 200
   HTTPCreated = 201

data/lib/gmoney/feed_parser.rb

@@ -10,7 +10,7 @@ module GMoney
         target.instance_variable_set("@#{name.camel_to_us}", value)
       end
 
-      doc.elements.each('feed/entry') do |parsed_entry|
+      doc.elements.each('//entry') do |parsed_entry|
         finance_object = feed_class.new
         finance_data = parsed_entry.elements["gf:#{feed_class_string}Data"]
 

data/lib/gmoney/portfolio.rb

@@ -2,19 +2,34 @@ module GMoney
   class Portfolio 
     class PortfolioRequestError < StandardError;end
   
-    attr_accessor :title, :currency_code, :positions
+    attr_accessor :title, :currency_code
                   
     attr_reader :id, :feed_link, :updated, :gain_percentage, :return1w, :return4w, :return3m, 
                 :return_ytd, :return1y, :return3y, :return5y, :return_overall, 
                 :cost_basis, :days_gain, :gain, :market_value
+     
+    def self.all(options = {})
+      retreive_portfolios(:all, options)
+    end
     
-    def initialize()    
-      @positions = []
+    def self.find(id, options = {})
+      retreive_portfolios(id, options)
     end
     
-    def self.all(options = {})
-      url = "#{GF_FEED_URL}/portfolios"
-      url += "?returns=true" if options[:with_returns]
+    def positions(options = {})
+      if options[:refresh]
+        @positions = Position.find(@id.portfolio_feed_id, options)
+      else
+        @positions ||= Position.find(@id.portfolio_feed_id, options)
+      end
+      
+      @positions.is_a?(Array) ? @positions : [@positions]
+    end
+       
+    def self.retreive_portfolios(id, options = {})
+      url = GF_PORTFOLIO_FEED_URL
+      url += "/#{id}" if id != :all
+      url += "?returns=true" if options[:returns]
       portfolios = []
       
       response = GFService.send_request(GFRequest.new(url, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}"}))
@@ -22,13 +37,16 @@ module GMoney
       if response.status_code == HTTPOK
         portfolios = PortfolioFeedParser.parse_portfolio_feed(response.body)
       else
-        raise PortfolioRequestError
+        raise PortfolioRequestError, response.body
       end
 
-      portfolios.each do |portfolio|
-        portfolio.positions = Position.find_by_url(portfolio.feed_link, {:with_returns => options[:with_returns]})
-      end      
-      portfolios  
-    end
+      portfolios.each { |p| p.instance_variable_set("@positions", p.positions(options))} if options[:eager]
+      
+      return portfolios[0] if portfolios.size == 1
+      
+      portfolios        
+    end        
+    
+    private_class_method :retreive_portfolios         
   end
 end

data/lib/gmoney/position.rb

@@ -1,33 +1,44 @@
 module GMoney
   class Position
     class PositionRequestError < StandardError; end
-    attr_accessor :transactions
-
     attr_reader :id, :updated, :title, :feed_link, :exchange, :symbol, :shares, 
                 :full_name, :gain_percentage, :return1w, :return4w, :return3m, 
                 :return_ytd, :return1y, :return3y, :return5y, :return_overall, 
                 :cost_basis, :days_gain, :gain, :market_value
     
-    def initialize
-      @transactions = []
+    def self.find(id, options={})   
+      find_by_url("#{GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}", options)    
+    end
+    
+    def transactions(options={})
+      if options[:refresh]
+        @transactions = Transaction.find(@id.position_feed_id, options)
+      else
+        @transactions ||= Transaction.find(@id.position_feed_id, options)
+      end            
+      
+      @transactions.is_a?(Array) ? @transactions : [@transactions]      
     end
     
     def self.find_by_url(url, options = {})
       positions = []
-      url += "?returns=true" if options[:with_returns]
+      url += "?returns=true" if options[:returns]
       
       response = GFService.send_request(GFRequest.new(url, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}"}))
       
       if response.status_code == HTTPOK
         positions = PositionFeedParser.parse_position_feed(response.body) if response.status_code == 200
       else
-        raise PositionRequestError
+        raise PositionRequestError, response.body
       end
 
-      positions.each do |position|
-        position.transactions = Transaction.find_by_url(position.feed_link)
-      end      
-      positions
+      positions.each { |p| p.instance_variable_set("@transactions", p.transactions(options))} if options[:eager]
+      
+      return positions[0] if positions.size == 1
+      
+      positions              
     end 
+    
+    private_class_method :find_by_url
   end
 end

data/lib/gmoney/transaction.rb

@@ -6,16 +6,26 @@ module GMoney
 
     attr_accessor :type, :date, :shares, :notes, :commission, :price
     
-    def self.find_by_url(url)
+    def self.find(id, options={})   
+      find_by_url("#{GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}/transactions/#{id.transaction_id}", options)    
+    end    
+    
+    def self.find_by_url(url, options={})
       transactions = []
       
       response = GFService.send_request(GFRequest.new(url, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}"}))
       
       if response.status_code == HTTPOK
-        TransactionFeedParser.parse_transaction_feed(response.body)
+        transactions = TransactionFeedParser.parse_transaction_feed(response.body)
       else
-        raise TransactionRequestError
+        raise TransactionRequestError, response.body
       end
-    end     
+      
+      return transactions[0] if transactions.size == 1
+      
+      transactions
+    end
+    
+    private_class_method :find_by_url
   end
 end

data/spec/fixtures/position_feed_for_9_GOOG.xml

@@ -0,0 +1,25 @@
+<?xml version='1.0' encoding='utf-8'?>
+<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gf='http://schemas.google.com/finance/2007' xmlns:gd='http://schemas.google.com/g/2005'>
+  <id>http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG</id>
+  <updated>2009-09-27T22:35:35.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/finance/2007#position' />
+  <title type='text'>Google Inc.</title>
+  <link rel='self' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ%3AGOOG' />
+  <gd:feedLink href='http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions' />
+  <gf:positionData gainPercentage='0.1742898491' return1w='0.002075448663' return1y='0.1665490533' return3m='0.1665490533' return3y='0.1665490533' return4w='0.1665490533' return5y='0.1665490533' returnOverall='0.1665490533' returnYTD='0.1665490533'
+  shares='325.0'>
+    <gf:costBasis>
+      <gd:money amount='136300.25' currencyCode='USD' />
+    </gf:costBasis>
+    <gf:daysGain>
+      <gd:money amount='-1394.24285' currencyCode='USD' />
+    </gf:daysGain>
+    <gf:gain>
+      <gd:money amount='23755.75' currencyCode='USD' />
+    </gf:gain>
+    <gf:marketValue>
+      <gd:money amount='160056.0' currencyCode='USD' />
+    </gf:marketValue>
+  </gf:positionData>
+  <gf:symbol exchange='NASDAQ' fullName='Google Inc.' symbol='GOOG' />
+</entry>

data/spec/fixtures/transaction_feed_for_GOOG_1.xml

@@ -0,0 +1,17 @@
+<?xml version='1.0' encoding='utf-8'?>
+<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gf='http://schemas.google.com/finance/2007' xmlns:gd='http://schemas.google.com/g/2005'>
+  <id>http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/2</id>
+  <updated>2009-09-12T18:22:44.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/finance/2007#transaction' />
+  <title type='text'>2</title>
+  <link rel='self' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ%3AGOOG/transactions/2' />
+  <link rel='edit' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ%3AGOOG/transactions/2' />
+  <gf:transactionData date='2009-09-01T00:00:00.000' shares='100.0' type='Buy'>
+    <gf:commission>
+      <gd:money amount='50.0' currencyCode='USD' />
+    </gf:commission>
+    <gf:price>
+      <gd:money amount='400.0' currencyCode='USD' />
+    </gf:price>
+  </gf:transactionData>
+</entry>

data/spec/portfolio_spec.rb

@@ -17,7 +17,7 @@ describe GMoney::Portfolio do
     @gf_response = GMoney::GFResponse.new
     @gf_response.status_code = 200
     @gf_response.body = @default_feed
-    @positions = []
+    @positions = nil
   end 
 
   it "should return all Portfolios when status_code is 200" do   
@@ -27,70 +27,87 @@ describe GMoney::Portfolio do
     portfolios.size.should be_eql(3)
   end
 
-  it "should return a portfolio with returns data is :with_returns == true" do
+  it "should return a portfolio with returns data is :returns == true" do
     @url = 'https://finance.google.com/finance/feeds/default/portfolios?returns=true'
     @gf_response.body = @feed_with_returns
 
-    portfolios = portfolio_helper(@url, {:with_returns => true})
+    portfolios = portfolio_helper(@url, :all, {:returns => true})
     
     portfolios.size.should be_eql(3)
     portfolios[0].cost_basis.should be_eql(2500.00)
     portfolios[0].gain_percentage.should be_eql(28.3636)
     portfolios[0].return4w.should be_eql(-0.1670616114)
-
     portfolios[2].cost_basis.should be_nil
   end
   
   it "should raise an error if the portfolio request does not return an OK status code" do
-    @gf_response.status_code = 404
-  
+    @gf_response.status_code = 401  
     lambda { portfolio_helper(@url) }.should raise_error(GMoney::Portfolio::PortfolioRequestError)
   end
   
-  it "should return an Array with only the default 'My Portfolio' portfolio when a user does not define his own portfolios" do
+  it "should raise an error with an error message when the user requests an invalid portfolio" do
+    @url += '/235234'
+    @gf_response.status_code = 404
+    @gf_response.body = "No portfolio exists with pid 235234"
+
+    lambda { portfolio_helper(@url, 235234) }.should raise_error(GMoney::Portfolio::PortfolioRequestError, @gf_response.body)
+  end  
+  
+  it "should return the default 'My Portfolio' portfolio when a user has not defined his own portfolios" do
     @gf_response.body = @empty_feed
-    portfolios = portfolio_helper(@url)
-    
-    portfolios.size.should be_eql(1)  
-    portfolios[0].title.should be_eql('My Portfolio')
+    portfolio = portfolio_helper(@url)    
+    portfolio.title.should be_eql('My Portfolio')
   end
 
-=begin TODO - create a method that retreives individual portfolios
-  it "should return a specific portfolio is the request a specific portfolio" do
+  it "should return a specific portfolio if the user requests a specific portfolio" do
     @url += '/9'
     @gf_request.url = @url
     
     @gf_response.body = @portfolio_9_feed
-    portfolios = portfolio_helper(@url)
+    portfolio = portfolio_helper(@url, 9)    
+    portfolio.title.should be_eql('GMoney Test')  
+  end
+  
+  it "should grab the latest positions when :refresh is used." do
+    @url += '/9'
+    @gf_request.url = @url
+    @positions = [GMoney::Position.new, GMoney::Position.new]
+    
+    @gf_response.body = @portfolio_9_feed
+    portfolio = portfolio_helper(@url, 9)
+
+    GMoney::Position.should_receive(:find).with("9", {:refresh => true}).and_return(@positions)
     
-    portfolios.size.should be_eql(1)  
-    portfolios[0].title.should be_eql('GMoney Test')  
+    portfolio.positions(:refresh => true).size.should be_eql(2)
   end
-=end
+  
+  it "should use the cached portfolios when :refresh is not used (and the portfolios have already been set)" do
+    @url += '/9'
+    @gf_request.url = @url
+    @positions = [GMoney::Position.new, GMoney::Position.new]
+    
+    @gf_response.body = @portfolio_9_feed
+    portfolio = portfolio_helper(@url, 9, :eager => true)
+    
+    GMoney::Position.should_not_receive(:find).with(9, :eager => true)
+    portfolio.positions.size.should be_eql(2)
+  end  
+  
 
-  def portfolio_helper(url, options = {})
+  def portfolio_helper(url, id = nil, options = {})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
 
     GMoney::GFRequest.should_receive(:new).with(url, :headers => {"Authorization" => "GoogleLogin auth=toke"}).and_return(@gf_request)
 
     GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
     
-    position_urls = get_position_urls(@gf_response.body)
-    
-    position_urls.each do |position_url|
-      GMoney::Position.should_receive(:find_by_url).with(position_url, {:with_returns => options[:with_returns]}).any_number_of_times.and_return(@positions)        
+    if options[:eager]
+      feed_ids = get_feed_ids(@gf_response.body)   
+      feed_ids.each do |feed_id|
+        GMoney::Position.should_receive(:find).with(feed_id.portfolio_feed_id, options).any_number_of_times.and_return(@positions)        
+      end
     end
       
-    GMoney::Portfolio.all(options)
-  end
-  
-  def get_position_urls(feed)
-    doc = REXML::Document.new(feed)
-    feed_links = []     
-
-    doc.elements.each('feed/entry') do |parsed_entry|
-      feed_links << parsed_entry.elements['gd:feedLink'].attributes['href']
-    end
-    feed_links
+    portfolios = id ? GMoney::Portfolio.find(id, options) : GMoney::Portfolio.all(options)
   end
 end

data/spec/position_spec.rb

@@ -5,12 +5,13 @@ describe GMoney::Position do
     @default_feed = File.read('spec/fixtures/positions_feed_for_portfolio_9.xml')
     @feed_with_returns = File.read('spec/fixtures/positions_feed_for_portfolio_9r.xml')
     @empty_feed = File.read('spec/fixtures/positions_feed_for_portfolio_14.xml')
+    @feed_for_port9_goog = File.read('spec/fixtures/position_feed_for_9_GOOG.xml')
   end
   
   before(:each) do
-    @url = 'https://finance.google.com/finance/feeds/default/portfolios/9/positions'
+    @portfolio_id = '9'
   
-    @gf_request = GMoney::GFRequest.new(@url)
+    @gf_request = GMoney::GFRequest.new(@portfolio_id)
     @gf_request.method = :get   
     
     @gf_response = GMoney::GFResponse.new
@@ -21,15 +22,15 @@ describe GMoney::Position do
 
   it "should return all Positions when status_code is 200" do   
     @gf_response.body = @default_feed
-    positions = position_helper(@url)
+    positions = position_helper(@portfolio_id)
     
     positions.size.should be_eql(5)
   end
 
-  it "should return a position with returns data is :with_returns == true" do
+  it "should return a position with returns data is :returns == true" do
     @gf_response.body = @feed_with_returns
 
-    positions = position_helper(@url, {:with_returns => true})
+    positions = position_helper(@portfolio_id, {:returns => true})
     
     positions.size.should be_eql(5)
     positions[0].cost_basis.should be_eql(615.00)
@@ -40,41 +41,69 @@ describe GMoney::Position do
   end
   
   it "should raise an error if the position request does not return an OK status code" do
-    @gf_response.status_code = 404
-  
-    lambda { position_helper(@url) }.should raise_error(GMoney::Position::PositionRequestError)
+    @gf_response.status_code = 404  
+    lambda { position_helper(@portfolio_id) }.should raise_error(GMoney::Position::PositionRequestError)
   end
 
-=begin TODO - create a method that retreives individual positions
-  it "should return a specific position is the request a specific position" do
+  it "should return a specific position if the user requests a specific position" do
+    @portfolio_id = '9/NASDAG:GOOG'
+    @gf_response.body = @feed_for_port9_goog
+    
+    position = position_helper(@portfolio_id)
+
+    position.cost_basis.should be_eql(136300.25)
+    position.return1w.should be_eql(0.002075448663)
   end
-=end
+  
+  
+  it "should raise an error message when a user request an invalid Position" do
+    @portfolio_id = '9/NASDAG:ASDF'
+    @gf_response.status_code = 404
+    @gf_response.body = "No position exists with ticker NASDAQ:ASDF"
 
-  def position_helper(url, options = {})
+    lambda { position_helper(@portfolio_id)}.should raise_error(GMoney::Position::PositionRequestError, @gf_response.body)
+  end
+  
+  it "should grab the latest transactions when :refresh is used" do 
+    @position_id = '9/NASDAG:GOOG'
+    @transactions = [GMoney::Transaction.new, GMoney::Transaction.new, GMoney::Transaction.new]
+    
+    @gf_response.body = @feed_for_port9_goog
+    position = position_helper(@position_id, :refresh => true)
+          
+    GMoney::Transaction.should_receive(:find).with(position.id.position_feed_id, {:refresh => true}).and_return(@transactions)
+    
+    position.transactions(:refresh => true).size.should be_eql(3)
+  end
+  
+  it "should grab cached transactions when :refresh is not used" do 
+    @position_id = '9/NASDAG:GOOG'
+    @transactions = [GMoney::Transaction.new, GMoney::Transaction.new, GMoney::Transaction.new]
+    
+    @gf_response.body = @feed_for_port9_goog
+    position = position_helper(@position_id, :eager => true)
+          
+    GMoney::Transaction.should_not_receive(:find).with(position.id.position_feed_id, {:eager => true})
+    position.transactions(:eager => true).size.should be_eql(3)
+  end
+  
+  def position_helper(id, options = {})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
 
-    send_url = options[:with_returns] ? (url + '?returns=true') : url
+    url = "#{GMoney::GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}"
+    send_url = options[:returns] ? (url + '?returns=true') : url
 
     GMoney::GFRequest.should_receive(:new).with(send_url, :headers => {"Authorization" => "GoogleLogin auth=toke"}).and_return(@gf_request)
 
     GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
     
-    transaction_urls = get_transaction_urls(@gf_response.body)
-    
-    transaction_urls.each do |transaction_url|
-      GMoney::Transaction.should_receive(:find_by_url).with(transaction_url).any_number_of_times.and_return(@transactions)
-    end
+    if options[:eager]
+      feed_ids = get_feed_ids(@gf_response.body)   
+      feed_ids.each do |feed_id|
+        GMoney::Transaction.should_receive(:find).with(feed_id.position_feed_id, options).any_number_of_times.and_return(@transactions)        
+      end
+    end    
       
-    GMoney::Position.find_by_url(url, options)
-  end
-  
-  def get_transaction_urls(feed)
-    doc = REXML::Document.new(feed)
-    feed_links = []     
-
-    doc.elements.each('feed/entry') do |parsed_entry|
-      feed_links << parsed_entry.elements['gd:feedLink'].attributes['href']
-    end
-    feed_links
+    GMoney::Position.find(id, options)
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,11 @@
 require File.dirname(__FILE__) + '/../lib/gmoney'
+
+def get_feed_ids(feed)
+  doc = REXML::Document.new(feed)
+  feed_ids = []     
+
+  doc.elements.each('//entry') do |parsed_entry|
+    feed_ids << parsed_entry.elements['id'].text
+  end
+  feed_ids
+end

data/spec/string_spec.rb

@@ -37,4 +37,43 @@ describe String do
     '$123.23'.is_numeric?.should be_false           
     '.'.is_numeric?.should be_false               
   end
+  
+  it "should be able to parse a portfolio id from an portfolio feed url" do
+    "http://finance.google.com/finance/feeds/user@example.com/portfolios/9".portfolio_feed_id.should be_eql("9")
+  end
+  
+  it "should be able to parse a position id from an position feed feed url" do
+    "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAG:GOOG".position_feed_id.should be_eql("9/NASDAG:GOOG")
+  end  
+  
+  it "should be able to parse a portfolio id out of a string" do
+    1.portfolio_id.should be_eql("1")
+    "1".portfolio_id.should be_eql("1")
+    lambda { "asdf".portfolio_id }.should raise_error(String::PortfolioParseError)
+    lambda { "123/NASDAQ:GOOG/2134/23".portfolio_id }.should raise_error(String::PortfolioParseError)    
+    "124".portfolio_id.should be_eql("124")
+    "1/NASDAQ:GOOG".portfolio_id.should be_eql("1") 
+    "123/NASDAQ:GOOG".portfolio_id.should be_eql("123")
+    "123/NASDAQ:GOOG/23".portfolio_id.should be_eql("123")
+  end
+  
+  it "should be able to parse a position id out of a string" do
+    1.position_id.should be_eql("")
+    "1".position_id.should be_eql("")
+    lambda { "asdf".position_id }.should raise_error(String::PositionParseError)
+    lambda {"123/NASDAQ:GOOG/2134/23".position_id}.should raise_error(String::PositionParseError)
+    "1/NASDAQ:GOOG".position_id.should be_eql("NASDAQ:GOOG")
+    "123/NASDAQ:GOOG".position_id.should be_eql("NASDAQ:GOOG")   
+    "123/NASDAQ:GOOG/23".position_id.should be_eql("NASDAQ:GOOG")
+  end
+  
+  it "should be able to parse a transaction id out of a string" do  
+    lambda { 1.transaction_id }.should raise_error(String::TransactionParseError)
+    lambda { "1".transaction_id }.should raise_error(String::TransactionParseError)
+    lambda { "asdf".transaction_id }.should raise_error(String::TransactionParseError)
+    "1/NASDAQ:GOOG".transaction_id.should be_eql("")
+    lambda {"123/NASDAQ:GOOG/asdf".transaction_id}.should raise_error(String::TransactionParseError)
+    lambda {"123/NASDAQ:GOOG/2134/23".transaction_id}.should raise_error(String::TransactionParseError)
+    "123/NASDAQ:GOOG/23".transaction_id.should be_eql("23")
+  end
 end

data/spec/transaction_spec.rb

@@ -3,10 +3,12 @@ require File.join(File.dirname(__FILE__), '/spec_helper')
 describe GMoney::Transaction do
   before(:all) do
     @goog_feed = File.read('spec/fixtures/transactions_feed_for_GOOG.xml')
+    @goog_feed_1 = File.read('spec/fixtures/transaction_feed_for_GOOG_1.xml')
   end
   
   before(:each) do
     @url = 'https://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ:GOOG/transactions' 
+    @transaction_id = '9/NASDAQ:GOOG'
     
     @gf_request = GMoney::GFRequest.new(@url)
     @gf_request.method = :get   
@@ -17,7 +19,7 @@ describe GMoney::Transaction do
   end
   
   it "should return all Tranasactions when the status code is 200" do
-    transactions = transaction_helper(@url)
+    transactions = transaction_helper(@transaction_id)
   
     transactions.size.should be_eql(4)
     transactions[1].commission.should be_eql(12.75)
@@ -25,22 +27,31 @@ describe GMoney::Transaction do
   end
   
   it "should raise an error when the status code is not 200" do
+    @transaction_id += '/1'
     @gf_response.status_code = 404
+    @gf_response.body = "No transaction exists with tid 1"
   
-    lambda { transaction_helper(@url) }.should raise_error(GMoney::Transaction::TransactionRequestError)  
+    lambda { transaction_helper(@transaction_id) }.should raise_error(GMoney::Transaction::TransactionRequestError, @gf_response.body)  
   end
 
-=begin TODO - create a method that retreives individual transactions
-  it "should return a specific transactions is the request a specific transactions" do
-=end    
+  it "should return a specific transactions if the user request a specific transaction" do
+    @transaction_id += '/2'
+    @gf_response.body = @goog_feed_1
+    transaction = transaction_helper(@transaction_id)
   
-  def transaction_helper(url)
+    transaction.commission.should be_eql(50.0)
+    transaction.price.should be_eql(400.0)
+  end    
+  
+  def transaction_helper(id, options={})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
 
+    url = "#{GMoney::GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}/transactions/#{id.transaction_id}"
+
     GMoney::GFRequest.should_receive(:new).with(url, :headers => {"Authorization" => "GoogleLogin auth=toke"}).and_return(@gf_request)
 
     GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
     
-    GMoney::Transaction.find_by_url(url)
+    GMoney::Transaction.find(id, options)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gmoney
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Justin Spradlin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-16 00:00:00 -04:00
+date: 2009-10-01 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -21,6 +21,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- lib/extensions/fixnum.rb
 - lib/extensions/string.rb
 - lib/gmoney.rb
 - lib/gmoney/authentication_request.rb
@@ -40,6 +41,7 @@ files:
 - README.rdoc
 - Rakefile
 - gmoney.gemspec
+- lib/extensions/fixnum.rb
 - lib/extensions/string.rb
 - lib/gmoney.rb
 - lib/gmoney/authentication_request.rb
@@ -60,9 +62,11 @@ files:
 - spec/fixtures/empty_portfolio_feed.xml
 - spec/fixtures/portfolio_9_feed.xml
 - spec/fixtures/portfolio_feed_with_returns.xml
+- spec/fixtures/position_feed_for_9_GOOG.xml
 - spec/fixtures/positions_feed_for_portfolio_14.xml
 - spec/fixtures/positions_feed_for_portfolio_9.xml
 - spec/fixtures/positions_feed_for_portfolio_9r.xml
+- spec/fixtures/transaction_feed_for_GOOG_1.xml
 - spec/fixtures/transactions_feed_for_GOOG.xml
 - spec/gmoney_spec.rb
 - spec/portfolio_feed_parser_spec.rb