gmoney 0.1.0 → 0.2.0

data/README.rdoc

@@ -6,24 +6,30 @@ A gem for interacting with the Google Finance API
 
   gem install gmoney
   
-  or
-  
-  gem install jspradlin-gmoney --source http://gems.github.com
-  
 == Usage
 
 Login
 -----
   
-    > GMoney::GFSession.login('google username', 'password')
+    GMoney::GFSession.login('google username', 'password')
 
 Portfolios
 --------
 
+  Reading
     > 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
+    
+  Deleting
+    > GMoney::Portfolio.delete 2
+  
+    or
+
+    > portfolio = GMoney::Portfolio.find 2
+    > portfolio.destroy #call destroy on an instance of a portfolio
+  
      
 Positions    
 --------
@@ -32,6 +38,14 @@ Positions
     > 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
+    
+  Deleting
+    > GMoney::Position.delete '2/NASDAQ:GOOG'
+  
+    or
+
+    > position = GMoney::Position.find '2/NASDAQ:GOOG'
+    > position.destroy #call destroy on an instance of a position
 
 Transactions
 --------
@@ -39,6 +53,14 @@ 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
     
+  Deleting
+    > GMoney::Transaction.delete '2/NASDAQ:GOOG/1'
+  
+    or
+
+    > transaction = GMoney::Transaction.find '2/NASDAQ:GOOG/1'
+    > transaction.destroy #call destroy on an instance of a transaction    
+    
 ----------
 
 Options parameter

data/gmoney.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmoney}
-  s.version = "0.1.0"
+  s.version = "0.2.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-10-01}
+  s.date = %q{2009-11-13}
   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/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"]

data/lib/extensions/string.rb

@@ -1,7 +1,8 @@
 class String
-  class PortfolioParseError < StandardError; end
-  class PositionParseError < StandardError; end
-  class TransactionParseError < StandardError; end
+  class ParseError < StandardError; end
+  class PortfolioParseError < ParseError; end
+  class PositionParseError < ParseError; end
+  class TransactionParseError < ParseError; end
   
   @@portfolio_re = /\d+/
   @@portfolio_re_in = /^\d+$/  
@@ -30,6 +31,13 @@ class String
    "#{portfolio}/#{position}"
   end  
   
+  def transaction_feed_id
+   portfolio = self[self.rindex('portfolios/')+11..index('/positions')-1]
+   position = self[self.rindex('positions/')+10..index('/transactions')-1]
+   transaction = self[rindex('/')+1..-1]
+   "#{portfolio}/#{position}/#{transaction}"
+  end  
+  
   def portfolio_id
     if self[@@transaction_re_in] || self[@@position_re_in] || self[@@portfolio_re_in]
       self[@@portfolio_re]

data/lib/gmoney.rb

@@ -27,7 +27,7 @@ require 'gmoney/transaction'
 require 'gmoney/transaction_feed_parser'
 
 module GMoney
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   GF_URL = "https://finance.google.com/finance"
   GF_FEED_URL = "#{GF_URL}/feeds/default"
   GF_PORTFOLIO_FEED_URL = "#{GF_FEED_URL}/portfolios"

data/lib/gmoney/portfolio.rb

@@ -1,6 +1,7 @@
 module GMoney
   class Portfolio 
     class PortfolioRequestError < StandardError;end
+    class PortfolioDeleteError < StandardError;end
   
     attr_accessor :title, :currency_code
                   
@@ -25,7 +26,16 @@ module GMoney
       
       @positions.is_a?(Array) ? @positions : [@positions]
     end
-       
+    
+    def self.delete(id)
+      delete_portfolio(id)
+    end
+    
+    def destroy
+      Portfolio.delete(@id.portfolio_feed_id)
+      freeze
+    end
+      
     def self.retreive_portfolios(id, options = {})
       url = GF_PORTFOLIO_FEED_URL
       url += "/#{id}" if id != :all
@@ -45,8 +55,17 @@ module GMoney
       return portfolios[0] if portfolios.size == 1
       
       portfolios        
-    end        
+    end
+   
+    #If you are working behind some firewalls HTTP DELETE request won't work.
+    #To overcome this problem the google doc say to use a post request with
+    #the X-HTTP-Method-Override set to "DELETE"    
+    def self.delete_portfolio(id)
+      url = "#{GF_PORTFOLIO_FEED_URL}/#{id}"
+      response = GFService.send_request(GFRequest.new(url, :method => :post, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}", "X-HTTP-Method-Override" => "DELETE"}))
+      raise PortfolioDeleteError, response.body if response.status_code != HTTPOK
+    end
     
-    private_class_method :retreive_portfolios         
+    private_class_method :retreive_portfolios, :delete_portfolio
   end
 end

data/lib/gmoney/position.rb

@@ -1,6 +1,8 @@
 module GMoney
   class Position
     class PositionRequestError < StandardError; end
+    class PositionDeleteError < StandardError; end
+    
     attr_reader :id, :updated, :title, :feed_link, :exchange, :symbol, :shares, 
                 :full_name, :gain_percentage, :return1w, :return4w, :return3m, 
                 :return_ytd, :return1y, :return3y, :return5y, :return_overall, 
@@ -19,6 +21,15 @@ module GMoney
       
       @transactions.is_a?(Array) ? @transactions : [@transactions]      
     end
+
+    def self.delete(id)
+      delete_position(id)
+    end
+    
+    def destroy
+      Position.delete(@id.position_feed_id)
+      freeze
+    end
     
     def self.find_by_url(url, options = {})
       positions = []
@@ -39,6 +50,24 @@ module GMoney
       positions              
     end 
     
-    private_class_method :find_by_url
+    #In order to delete a position you must delete all the transactions that fall under
+    #that position.
+    def self.delete_position(id)
+      begin
+        trans = Transaction.find("#{id.portfolio_id}/#{id.position_id}")
+        if trans.class == Transaction
+          trans.destroy
+        else
+          trans.each {|t| t.destroy }
+        end
+      rescue Transaction::TransactionRequestError => e
+        raise PositionDeleteError, e.message
+      rescue String::ParseError
+        raise PositionDeleteError, 'Invalid Position ID'
+      end
+      nil
+    end
+    
+    private_class_method :find_by_url, :delete_position
   end
 end

data/lib/gmoney/transaction.rb

@@ -1,6 +1,7 @@
 module GMoney
   class Transaction
     class TransactionRequestError < StandardError; end
+    class TransactionDeleteError < StandardError;end    
     
     attr_reader :id, :updated, :title
 
@@ -10,6 +11,15 @@ module GMoney
       find_by_url("#{GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}/transactions/#{id.transaction_id}", options)    
     end    
     
+    def self.delete(id)
+      delete_transaction(id)
+    end
+    
+    def destroy
+      Transaction.delete(@id.transaction_feed_id)
+      freeze
+    end    
+    
     def self.find_by_url(url, options={})
       transactions = []
       
@@ -26,6 +36,15 @@ module GMoney
       transactions
     end
     
-    private_class_method :find_by_url
+    #If you are working behind some firewalls DELETE HTTP request won't work.
+    #To overcome this problem the google doc say to use a post request with
+    #the X-HTTP-Method-Override set to "DELETE"
+    def self.delete_transaction(id)    
+      url = "#{GF_PORTFOLIO_FEED_URL}/#{id.portfolio_id}/positions/#{id.position_id}/transactions/#{id.transaction_id}"
+      response = GFService.send_request(GFRequest.new(url, :method => :post, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}", "X-HTTP-Method-Override" => "DELETE"}))
+      raise TransactionDeleteError, response.body if response.status_code != HTTPOK
+    end
+    
+    private_class_method :find_by_url, :delete_transaction
   end
 end

data/spec/portfolio_feed_parser_spec.rb

@@ -31,7 +31,8 @@ describe GMoney::PortfolioFeedParser do
   it "should create Portfolio objects with valid numeric data types for the returns" do
     @portfolios_with_returns.each do |portfolio|
       portfolio.public_methods(false).each do |pm|
-        if !(['id', 'feed_link', 'updated', 'title', 'currency_code', 'positions'].include? pm) && !(pm.include?('='))
+        if (['gain_percentage', 'return1w', 'return4w', 'return3m', 'return_ytd', 'return1y', 'return3y', 'return5y', 
+             'return_overall', 'cost_basis', 'days_gain', 'gain', 'market_value'].include? pm) && !(pm.include?('='))
           return_val = portfolio.send(pm)
           return_val.should be_instance_of(Float) if return_val
         end

data/spec/portfolio_spec.rb

@@ -93,6 +93,47 @@ describe GMoney::Portfolio do
     portfolio.positions.size.should be_eql(2)
   end  
   
+  it "should delete portfolios using a class method and id" do
+    @gf_request = GMoney::GFRequest.new(@url)
+    @gf_request.method = :delete
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 200
+    
+    portfolio_delete_helper("#{@url}/19")
+    
+    GMoney::Portfolio.delete(19).should be_nil
+  end
+  
+  it "should delete portfolios by calling destroy on an instance of a portfolio" do
+    @gf_request = GMoney::GFRequest.new(@url)
+    @gf_request.method = :delete
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 200
+    
+    portfolio = GMoney::Portfolio.new
+    portfolio.instance_variable_set("@id", "#{@url}/24")
+     
+    portfolio_delete_helper("#{@url}/24")
+
+    portfolio_return = portfolio.destroy
+    portfolio_return.should be_eql(portfolio)
+    portfolio_return.frozen?.should be_true
+  end
+  
+  it "should raise a PortfolioDeleteError when there is an attempt to delete an portfolio that doesn't exist')" do
+    @gf_request = GMoney::GFRequest.new(@url)
+    @gf_request.method = :delete
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 400
+    @gf_request.body = "Invalid portfolio ID."
+
+    portfolio_delete_helper("#{@url}/asdf")
+
+    lambda { GMoney::Portfolio.delete("asdf") }.should raise_error(GMoney::Portfolio::PortfolioDeleteError, @gf_response.body)
+  end   
 
   def portfolio_helper(url, id = nil, options = {})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
@@ -110,4 +151,12 @@ describe GMoney::Portfolio do
       
     portfolios = id ? GMoney::Portfolio.find(id, options) : GMoney::Portfolio.all(options)
   end
+  
+  def portfolio_delete_helper(url)
+    GMoney::GFSession.should_receive(:auth_token).and_return('toke')
+
+    GMoney::GFRequest.should_receive(:new).with(url, :method => :post, :headers => {"Authorization" => "GoogleLogin auth=toke", "X-HTTP-Method-Override" => "DELETE"}).and_return(@gf_request)
+
+    GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
+  end  
 end

data/spec/position_feed_parser_spec.rb

@@ -28,8 +28,8 @@ describe GMoney::PositionFeedParser do
   
   it "should create Position objects with valid numeric data types for the returns" do
     @positions_with_returns.each do |position|
-      position.public_methods(false).each do |pm|     
-        if !(['id', 'feed_link', 'updated', 'title', 'exchange', 'symbol', 'full_name', 'transactions'].include? pm) && !(pm.include?('='))
+      position.public_methods(false).each do |pm|           
+        if (['shares', 'gain_percentage', 'return1w', 'return4w', 'return3m', 'return_ytd', 'return1y', 'return3y', 'return5y', 'return_overall', 'cost_basis', 'days_gain', 'gain', 'market_value'].include? pm) && !(pm.include?('='))
           return_val = position.send(pm)
           return_val.should be_instance_of(Float) if return_val
         end

data/spec/position_spec.rb

@@ -10,6 +10,7 @@ describe GMoney::Position do
   
   before(:each) do
     @portfolio_id = '9'
+    @url = 'https://finance.google.com/finance/feeds/default/portfolios/9/positions' 
   
     @gf_request = GMoney::GFRequest.new(@portfolio_id)
     @gf_request.method = :get   
@@ -87,6 +88,51 @@ describe GMoney::Position do
     position.transactions(:eager => true).size.should be_eql(3)
   end
   
+  
+  it "should delete positions (with a single transaction) using a class method and id" do
+    @trans = GMoney::Transaction.new
+    @trans.instance_variable_set("@id", "#{@url}/NASDAQ:GOOG/transactions/21")
+    
+    position_delete_helper('9/NASDAQ:GOOG')
+        
+    GMoney::Position.delete('9/NASDAQ:GOOG').should be_nil
+  end
+  
+  it "should delete positions (with multiple transactions) using a class method and id" do
+    tran1 = GMoney::Transaction.new
+    tran1.instance_variable_set("@id", "#{@url}/NASDAQ:GOOG/transactions/21")    
+    tran2 = GMoney::Transaction.new
+    tran2.instance_variable_set("@id", "#{@url}/NASDAQ:GOOG/transactions/22")    
+    @trans = [tran1, tran2]
+    
+    position_delete_helper('9/NASDAQ:GOOG')
+    
+    GMoney::Position.delete('9/NASDAQ:GOOG').should be_nil
+  end
+  
+  it "should delete positions when calling destroy on an instance of a position" do
+    position = GMoney::Position.new
+    position.instance_variable_set("@id", "#{@url}/NASDAQ:GOOG")
+     
+    @trans = GMoney::Transaction.new
+    @trans.instance_variable_set("@id", "#{@url}/NASDAQ:GOOG/transactions/21")
+
+    position_delete_helper('9/NASDAQ:GOOG')
+
+    position_return = position.destroy
+    position_return.should be_eql(position)
+    position_return.frozen?.should be_true
+  end  
+
+  it "should raise a PositionDeleteError when there is an attempt to delete a position with a bad position id')" do
+    lambda { GMoney::Position.delete("9/NASDAQ:GOOG/asdf") }.should raise_error(GMoney::Position::PositionDeleteError, 'Invalid Position ID')
+  end  
+  
+  it "should raise a PositionDeleteError when there is an attempt to delete a position with a bad position id')" do
+    GMoney::Transaction.should_receive(:find).with('9/NYSE:C').and_raise(GMoney::Transaction::TransactionRequestError.new('No position exists with ticker NYSE:C'))
+    lambda { GMoney::Position.delete("9/NYSE:C") }.should raise_error(GMoney::Position::PositionDeleteError, 'No position exists with ticker NYSE:C')
+  end    
+  
   def position_helper(id, options = {})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
 
@@ -106,4 +152,14 @@ describe GMoney::Position do
       
     GMoney::Position.find(id, options)
   end
+  
+  def position_delete_helper(id)
+    GMoney::Transaction.should_receive(:find).with(id).and_return(@trans)    
+    
+    if @trans.class == GMoney::Transaction
+      @trans.should_receive(:destroy)
+    else
+      @trans.each {|t| t.should_receive(:destroy)}      
+    end 
+  end      
 end

data/spec/string_spec.rb

@@ -42,10 +42,15 @@ describe String 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
+  it "should be able to parse a position id from an position 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 transaction id from an transaction feed url" do
+    "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAG:GOOG/transactions/12".transaction_feed_id.should be_eql("9/NASDAG:GOOG/12")
+    "http://finance.google.com/finance/feeds/user@example.com/portfolios/12/positions/NYSE:GLD/transactions/3".transaction_feed_id.should be_eql("12/NYSE:GLD/3")    
+  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")

data/spec/transaction_feed_parser_spec.rb

@@ -5,7 +5,6 @@ describe GMoney::TransactionFeedParser do
     feed = File.read('spec/fixtures/transactions_feed_for_GOOG.xml')
     @transactions = GMoney::TransactionFeedParser.parse_transaction_feed(feed)
   end
-
   it "should create Transaction objects out of transaction feeds" do
     @transactions.each do |transaction|
       transaction.should be_instance_of(GMoney::Transaction)
@@ -19,7 +18,7 @@ describe GMoney::TransactionFeedParser do
   it "should create Transaction objects with valid numeric data types" do
     @transactions.each do |transaction|
       transaction.public_methods(false).each do |pm|      
-        if !(['id', 'updated', 'title', 'date', 'type', 'notes'].include? pm) && !(pm.include?('='))
+        if (['shares', 'commission', 'price'].include? pm) && !(pm.include?('='))
           return_val = transaction.send(pm)
           return_val.should be_instance_of(Float) if return_val
         end

data/spec/transaction_spec.rb

@@ -41,7 +41,49 @@ describe GMoney::Transaction do
   
     transaction.commission.should be_eql(50.0)
     transaction.price.should be_eql(400.0)
-  end    
+  end  
+  
+  it "should delete transactions using a class method and id" do
+    @gf_request = GMoney::GFRequest.new("#{@url}/24")
+    @gf_request.method = :post
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 200
+    
+    transaction_delete_helper("#{@url}/24")
+    
+    GMoney::Transaction.delete('9/NASDAQ:GOOG/24').should be_nil
+  end
+
+  it "should delete transactions when calling destroy on an instance of a transaction" do
+    @gf_request = GMoney::GFRequest.new("#{@url}/21")
+    @gf_request.method = :post
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 200
+    
+    transaction = GMoney::Transaction.new
+    transaction.instance_variable_set("@id", "#{@url}/21")
+     
+    transaction_delete_helper("#{@url}/21")
+
+    transaction_return = transaction.destroy
+    transaction_return.should be_eql(transaction)
+    transaction_return.frozen?.should be_true
+  end
+
+  it "should raise a TransactionDeleteError when there is an attempt to delete a transaction from a portfolio that doesn't exist')" do
+    @gf_request = GMoney::GFRequest.new("#{@url}/24")
+    @gf_request.method = :post
+    
+    @gf_response = GMoney::GFResponse.new
+    @gf_response.status_code = 400
+    @gf_request.body = "Invalid Portfolio"
+
+    transaction_delete_helper("#{@url}/24")
+
+    lambda { GMoney::Transaction.delete("9/NASDAQ:GOOG/24") }.should raise_error(GMoney::Transaction::TransactionDeleteError, @gf_response.body)
+  end
   
   def transaction_helper(id, options={})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
@@ -54,4 +96,12 @@ describe GMoney::Transaction do
     
     GMoney::Transaction.find(id, options)
   end
+  
+  def transaction_delete_helper(url)
+    GMoney::GFSession.should_receive(:auth_token).and_return('toke')
+
+    GMoney::GFRequest.should_receive(:new).with(url, :method => :post, :headers => {"Authorization" => "GoogleLogin auth=toke", "X-HTTP-Method-Override" => "DELETE"}).and_return(@gf_request)
+
+    GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
+  end    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gmoney
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Justin Spradlin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-01 00:00:00 -04:00
+date: 2009-11-13 00:00:00 -05:00
 default_executable: 
 dependencies: []