gmoney 0.4.0 → 0.4.2

data/README.rdoc

@@ -9,7 +9,7 @@ A gem for interacting with the Google Finance API
 == Usage
 
 Login
------
+--------
   
     GMoney::GFSession.login('google username', 'password')
 
@@ -17,7 +17,7 @@ Portfolios
 --------
 
   Reading
-    > portfolios = GMoney::Portfolio.all #returns all of a users portfolios
+    > portfolios = GMoney::Portfolio.all #returns all of a user's portfolios
     > portfolio = GMoney::Portfolio.find(9) #returns a specific portfolio
     
     > positions = portfolio.positions #returns an Array of the Positions held within a given portfolio
@@ -45,7 +45,7 @@ Positions
 --------
 
   Reading
-    > positions = GMoney::Position.find(9) #returns all of a users positions within a given portfolio, i.e. Portfolio "9"
+    > positions = GMoney::Position.find(9) #returns all of a user's 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
@@ -66,14 +66,14 @@ Transactions
 --------
 
   Reading
-    > transactions = GMoney::Transaction.find("9/NASDAQ:GOOG") #returns all of a users transactions within a given position
+    > transactions = GMoney::Transaction.find("9/NASDAQ:GOOG") #returns all of a user's transactions within a given position
     > transaction = GMoney::Transaction.find("9/NASDAQ:GOOG/2") #returns a specific transaction within a given position
     
   Creating
     > transaction = GMoney::Transaction.new
-    > transaction.portfolio = 9     #Must be a valid portfolio id
-    > transaction.ticker = 'nyse:c' #Must be a valid ticker symbol
-    > transaction.type = 'Buy'      #Must be one of the following: Buy, Sell, Sell Short, Buy to Cover
+    > transaction.portfolio = 9      #Must be a valid portfolio id
+    > transaction.ticker = 'nyse:c'  #Must be a valid ticker symbol
+    > transaction.type = GMoney::BUY #Must be one of the following: Buy, Sell, Sell Short, Buy to Cover
     > transaction.save #returns transaction object
     
   Updating
@@ -90,7 +90,7 @@ Transactions
     > transaction = GMoney::Transaction.find '2/NASDAQ:GOOG/1'
     > transaction.delete #call delete on an instance of a transaction    
     
-----------
+--------
 
 Options parameter
 
@@ -111,14 +111,14 @@ Options parameter
   * :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
   
-----------
+--------
 There are still some rough edges.  Feedback is appreciated.  
 
 == License
 
 (The MIT License)
 
-Copyright (c) 2009 Justin Spradlin
+Copyright (c) 2010 Justin Spradlin
 
 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:
 

data/gmoney.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmoney}
-  s.version = "0.4.0"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Spradlin"]
-  s.date = %q{2009-11-17}
+  s.date = %q{2010-01-30}
   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/fixnum.rb", "lib/extensions/nil_class.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"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gmoney", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{gmoney}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{A gem for interacting with the Google Finance API}
 
   if s.respond_to? :specification_version then

data/lib/gmoney.rb

@@ -1,6 +1,6 @@
 # Justin Spradlin
 # www.fiascode.com
-# (C) 2009
+# (C) 2010
 
 
 $:.unshift File.expand_path(File.dirname(__FILE__))
@@ -28,7 +28,7 @@ require 'gmoney/transaction'
 require 'gmoney/transaction_feed_parser'
 
 module GMoney
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
   GF_URL = "https://finance.google.com/finance"
   GF_FEED_URL = "#{GF_URL}/feeds/default"
   GF_PORTFOLIO_FEED_URL = "#{GF_FEED_URL}/portfolios"
@@ -36,6 +36,12 @@ module GMoney
   HTTPOK = 200
   HTTPCreated = 201
   
+  BUY = 'Buy'
+  SELL = 'Sell'
+  SELL_SHORT = 'Sell Short'
+  BUY_TO_COVER = 'Buy to Cover'
+  
+  
   def self.version
     VERSION
   end

data/lib/gmoney/portfolio.rb

@@ -10,6 +10,10 @@ module GMoney
                 :return_ytd, :return1y, :return3y, :return5y, :return_overall, 
                 :cost_basis, :days_gain, :gain, :market_value
      
+    def pid
+      @id.portfolio_feed_id
+    end
+
     def self.all(options = {})
       retreive_portfolios(:all, options)
     end
@@ -20,9 +24,9 @@ module GMoney
     
     def positions(options = {})
       if options[:refresh]
-        @positions = Position.find(@id.portfolio_feed_id, options)
+        @positions = Position.find(pid, options)
       else
-        @positions ||= Position.find(@id.portfolio_feed_id, options)
+        @positions ||= Position.find(pid, options)
       end
       
       @positions.is_a?(Array) ? @positions : [@positions]
@@ -37,7 +41,7 @@ module GMoney
     end
     
     def delete
-      Portfolio.delete(@id.portfolio_feed_id)
+      Portfolio.delete(pid)
       freeze
     end
       

data/lib/gmoney/position.rb

@@ -7,6 +7,10 @@ module GMoney
                 :full_name, :gain_percentage, :return1w, :return4w, :return3m, 
                 :return_ytd, :return1y, :return3y, :return5y, :return_overall, 
                 :cost_basis, :days_gain, :gain, :market_value
+                
+    def pid
+      @id.position_feed_id
+    end
     
     def self.find(id, options={})   
       find_by_url("#{GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}", options)    
@@ -14,9 +18,9 @@ module GMoney
     
     def transactions(options={})
       if options[:refresh]
-        @transactions = Transaction.find(@id.position_feed_id, options)
+        @transactions = Transaction.find(pid, options)
       else
-        @transactions ||= Transaction.find(@id.position_feed_id, options)
+        @transactions ||= Transaction.find(pid, options)
       end            
       
       @transactions.is_a?(Array) ? @transactions : [@transactions]      
@@ -27,7 +31,7 @@ module GMoney
     end
     
     def delete
-      Position.delete(@id.position_feed_id)
+      Position.delete(pid)
       freeze
     end
     

data/lib/gmoney/transaction.rb

@@ -3,10 +3,41 @@ module GMoney
     class TransactionRequestError < StandardError; end
     class TransactionDeleteError < StandardError;end    
     class TransactionSaveError < StandardError;end
+    class TransactionIdError < StandardError;end
     
     attr_reader :id, :updated, :title
     attr_accessor :type, :date, :shares, :notes, :commission, :price, :portfolio, :ticker, :currency_code
     
+    def tid
+      @id.transaction_feed_id
+    end
+    
+    def portfolio
+      if @id
+        @portfolio = tid.portfolio_id
+      else
+        @portfolio
+      end
+    end
+    
+    def ticker
+      if @id
+        @ticker = tid.position_id
+      else
+        @ticker
+      end    
+    end
+    
+    def portfolio=(p)
+      raise TransactionIdError, "You can't modify the portfolio for a Transaction that already has an id" if @id        
+      @portfolio = p
+    end
+    
+    def ticker=(t)
+      raise TransactionIdError, "You can't modify the ticker for a Transaction that already has an id" if @id        
+      @ticker = t
+    end
+    
     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    
@@ -20,7 +51,7 @@ module GMoney
     end
     
     def delete
-      Transaction.delete(@id.transaction_feed_id)
+      Transaction.delete(tid)
       freeze
     end    
     
@@ -80,7 +111,6 @@ module GMoney
       if response.status_code == HTTPCreated || response.status_code == HTTPOK
         transaction = TransactionFeedParser.parse_transaction_feed(response.body)[0]
         self.instance_variable_set("@id", transaction.id) if response.status_code == HTTPCreated
-        transaction.portfolio = @portfolio if response.status_code == HTTPCreated        
       else
         raise TransactionSaveError, response.body
       end
@@ -88,11 +118,11 @@ module GMoney
     end
     
     def is_valid_transaction?
-      !(@portfolio.to_s.blank? || @ticker.blank? || !is_valid_transaction_type?)
+      !(portfolio.to_s.blank? || ticker.blank? || !is_valid_transaction_type?)
     end
     
     def is_valid_transaction_type?
-      ['Buy', 'Sell', 'Buy to Cover', 'Sell Short'].include?(@type)
+      [BUY, SELL, SELL_SHORT, BUY_TO_COVER].include?(@type)
     end
     
     private :save_transaction, :is_valid_transaction?, :is_valid_transaction_type?

data/spec/portfolio_spec.rb

@@ -20,7 +20,17 @@ describe GMoney::Portfolio do
     @gf_response.status_code = 200
     @gf_response.body = @default_feed
     @positions = nil
-  end 
+  end
+  
+  it "should have return a human readable (i.e. non-url) portfolio id" do
+    @gf_response.body = @default_feed
+
+    portfolios = portfolio_helper(@url)    
+    
+    portfolios[0].pid.should be_eql("8")
+    portfolios[1].pid.should be_eql("9")
+    portfolios[2].pid.should be_eql("3")
+  end
 
   it "should return all Portfolios when status_code is 200" do   
     @gf_response.body = @default_feed

data/spec/position_spec.rb

@@ -20,6 +20,16 @@ describe GMoney::Position do
     @gf_response.body = @defaul_feed
     @transactions = []
   end 
+  
+  it "should have return a human readable (i.e. non-url) position id" do    
+    @gf_response.body = @feed_with_returns
+    
+    positions = position_helper(@portfolio_id, {:returns => true})
+    
+    positions[0].pid.should be_eql("9/NASDAQ:JAVA")
+    positions[1].pid.should be_eql("9/NASDAQ:GOOG")
+    positions[2].pid.should be_eql("9/NASDAQ:AAPL")
+  end
 
   it "should return all Positions when status_code is 200" do   
     @gf_response.body = @default_feed

data/spec/transaction_spec.rb

@@ -19,6 +19,55 @@ describe GMoney::Transaction do
     @gf_response.body = @goog_feed
   end
   
+  it "should have return a human readable (i.e. non-url) transaction id" do
+    transactions = transaction_helper(@transaction_id)
+    transactions[0].tid.should be_eql("9/NASDAQ:GOOG/2")
+    transactions[1].tid.should be_eql("9/NASDAQ:GOOG/10")
+  end  
+
+  it "should return the portfolio id when it is set or infer the portfolio id from the transaction id when the portfolio id is not set" do
+    transaction = GMoney::Transaction.new
+    transaction.portfolio.should be_nil
+    
+    transaction.portfolio = '18'
+    transaction.portfolio.should be_eql('18')
+    
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    transaction.portfolio.should be_eql('9')
+
+    transaction = GMoney::Transaction.new
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    transaction.portfolio.should be_eql('9')
+  end
+
+  it "should return the ticker id when it is set or infer the ticker id from the transaction id when the ticker id is not set" do
+    transaction = GMoney::Transaction.new
+    transaction.ticker.should be_nil
+    
+    transaction.ticker = 'NASDAQ:AAPL'
+    transaction.ticker.should be_eql('NASDAQ:AAPL')
+    
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    transaction.ticker.should be_eql('NASDAQ:GOOG')
+
+    transaction = GMoney::Transaction.new
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    transaction.ticker.should be_eql('NASDAQ:GOOG')  
+  end
+  
+  it "should not allow users to set a portfolio on a transaction for transactions that have already been saved" do
+    transaction = GMoney::Transaction.new
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+
+    lambda { transaction.portfolio = 10 }.should raise_error(GMoney::Transaction::TransactionIdError, "You can't modify the portfolio for a Transaction that already has an id")  
+  end
+  
+  it "should not allow users to set a portfolio on a transaction for transactions that have already been saved" do
+    transaction = GMoney::Transaction.new
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    lambda { transaction.ticker = "NASDAQ::AAPL" }.should raise_error(GMoney::Transaction::TransactionIdError, "You can't modify the ticker for a Transaction that already has an id")  
+  end
+  
   it "should return all Tranasactions when the status code is 200" do
     transactions = transaction_helper(@transaction_id)
   
@@ -96,10 +145,10 @@ describe GMoney::Transaction do
     
     trans.portfolio = 1
     trans.ticker = "NYSE:GLD"    
-    trans.type = 'Buy'
+    trans.type = GMoney::BUY
     trans.public_is_valid_transaction?.should be_true
     
-    trans.type = 'Sell'
+    trans.type = GMoney::SELL
     trans.public_is_valid_transaction?.should be_true    
     
     trans.type = 'Buy to Cover'
@@ -120,12 +169,12 @@ describe GMoney::Transaction do
     
     trans.portfolio = 1
     trans.ticker = "   "
-    trans.type = 'Buy'    
+    trans.type = GMoney::BUY
     trans.public_is_valid_transaction?.should be_false
     
     trans.portfolio = "  "
     trans.ticker = "NYSE:GLD"
-    trans.type = 'Buy'    
+    trans.type = GMoney::BUY
     trans.public_is_valid_transaction?.should be_false    
     
     trans.portfolio = nil
@@ -135,12 +184,12 @@ describe GMoney::Transaction do
     
     trans.portfolio = nil
     trans.ticker = "NYSE:GLD"
-    trans.type = 'Buy'    
+    trans.type = GMoney::BUY
     trans.public_is_valid_transaction?.should be_false        
     
     trans.portfolio = "1"
     trans.ticker = nil
-    trans.type = 'Buy'    
+    trans.type = GMoney::BUY
     trans.public_is_valid_transaction?.should be_false                
   end
 
@@ -148,7 +197,7 @@ describe GMoney::Transaction do
     transaction = GMoney::Transaction.new
     transaction.portfolio = 9
     transaction.ticker = 'NASDAQ:GOOG'
-    transaction.type = 'Buy'
+    transaction.type = GMoney::BUY
     transaction.shares = 50
     transaction.price = 450.0
     transaction.commission = 20.0
@@ -171,7 +220,7 @@ describe GMoney::Transaction do
     transaction = GMoney::Transaction.new
     transaction.portfolio = 9
     transaction.ticker = 'NASDAQ:GOOG'
-    transaction.type = 'Buy'
+    transaction.type = GMoney::BUY
     transaction.shares = 50
     transaction.price = 450.0
     transaction.commission = 20.0
@@ -192,12 +241,12 @@ describe GMoney::Transaction do
     lambda { transaction.save }.should raise_error(GMoney::Transaction::TransactionSaveError, "You must include a portfolio id, ticker symbol, and transaction type ['Buy', 'Sell', 'Buy to Cover', 'Sell Short'] in order to create a transaction.")    
     
     transaction.portfolio = 9
-    transaction.type = 'Buy'
+    transaction.type = GMoney::BUY
     lambda { transaction.save }.should raise_error(GMoney::Transaction::TransactionSaveError, "You must include a portfolio id, ticker symbol, and transaction type ['Buy', 'Sell', 'Buy to Cover', 'Sell Short'] in order to create a transaction.")        
     
     transaction.portfolio = nil
     transaction.ticker = 'NASDAQ:GOOG'
-    transaction.type = 'Buy'
+    transaction.type = GMoney::BUY
     lambda { transaction.save }.should raise_error(GMoney::Transaction::TransactionSaveError, "You must include a portfolio id, ticker symbol, and transaction type ['Buy', 'Sell', 'Buy to Cover', 'Sell Short'] in order to create a transaction.")            
   end
   
@@ -205,7 +254,7 @@ describe GMoney::Transaction do
     transaction = GMoney::Transaction.new
     transaction.portfolio = 9
     transaction.ticker = 'asdfasd:asdfs' #invalid ticker
-    transaction.type = 'Buy'
+    transaction.type = GMoney::BUY
     transaction.shares = 50
     transaction.price = 450.0
     transaction.commission = 20.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gmoney
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - Justin Spradlin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-17 00:00:00 -05:00
+date: 2010-01-30 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gmoney
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A gem for interacting with the Google Finance API