gmoney 0.2.1 → 0.4.0

data/Manifest

@@ -3,6 +3,7 @@ README.rdoc
 Rakefile
 gmoney.gemspec
 lib/extensions/fixnum.rb
+lib/extensions/nil_class.rb
 lib/extensions/string.rb
 lib/gmoney.rb
 lib/gmoney/authentication_request.rb
@@ -21,6 +22,8 @@ spec/authentication_request_spec.rb
 spec/fixtures/cacert.pem
 spec/fixtures/default_portfolios_feed.xml
 spec/fixtures/empty_portfolio_feed.xml
+spec/fixtures/new_portfolio_feed.xml
+spec/fixtures/new_transaction_feed.xml
 spec/fixtures/portfolio_9_feed.xml
 spec/fixtures/portfolio_feed_with_returns.xml
 spec/fixtures/position_feed_for_9_GOOG.xml
@@ -29,7 +32,9 @@ 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/fixtures/updated_portfolio_feed.xml
 spec/gmoney_spec.rb
+spec/nil_class_spec.rb
 spec/portfolio_feed_parser_spec.rb
 spec/portfolio_spec.rb
 spec/position_feed_parser_spec.rb

data/README.rdoc

@@ -9,61 +9,88 @@ A gem for interacting with the Google Finance API
 == Usage
 
 Login
-
+-----
   
     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
+    > 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 = portfolio.positions #returns an Array of the Positions held within a given portfolio
+  Creating
+    > portfolio = GMoney::Portfolio.new
+    > portfolio.title = "My New Portfolio"
+    > portfolio.save #returns portfolio object
+    
+  Updating
+    > portfolio = GMoney::Portfolio.find 9
+    > portfolio.title = "My Updated Portfolio Title"
+    > portfolio.save #returns portfolio object        
     
   Deleting
-    GMoney::Portfolio.delete 2
+    > GMoney::Portfolio.delete 2
   
     or
 
-    portfolio = GMoney::Portfolio.find 2
-    portfolio.delete #call delete on an instance of a portfolio
+    > portfolio = GMoney::Portfolio.find 2
+    > portfolio.delete #call delete on an instance of a portfolio
   
      
 Positions    
-
+--------
 
   Reading
-    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
+    > 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 = position.transactions #returns an Array of the Transactions within a given position
+  Creating/Updating
+    Positions are created/updated via transactions
     
   Deleting
-    GMoney::Position.delete '2/NASDAQ:GOOG'
+    > GMoney::Position.delete '2/NASDAQ:GOOG'
   
     or
 
-    position = GMoney::Position.find '2/NASDAQ:GOOG'
-    position.delete #call delete on an instance of a position
+    > position = GMoney::Position.find '2/NASDAQ:GOOG'
+    > position.delete #call delete on an instance of a position
 
-Transactions
 
+Transactions
+--------
 
   Reading
-    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
+    > 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
+    
+  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.save #returns transaction object
+    
+  Updating
+    > transaction = GMoney::Transaction.find('9/NYSE:C/1')
+    > transaction.shares = 50
+    > transaction.price = 3.50
+    > transaction.save #returns transaction object
     
   Deleting
-    GMoney::Transaction.delete '2/NASDAQ:GOOG/1'
+    > GMoney::Transaction.delete '2/NASDAQ:GOOG/1'
   
     or
 
-    transaction = GMoney::Transaction.find '2/NASDAQ:GOOG/1'
-    transaction.delete #call delete on an instance of a transaction    
+    > transaction = GMoney::Transaction.find '2/NASDAQ:GOOG/1'
+    > transaction.delete #call delete on an instance of a transaction    
     
-
+----------
 
 Options parameter
 
@@ -81,8 +108,11 @@ Options parameter
   all take a hash as an optional last parameter.  Valid values for this hash are:
 
   * :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 to 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 to true
+  * :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
 

data/gmoney.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmoney}
-  s.version = "0.2.1"
+  s.version = "0.4.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-11-14}
+  s.date = %q{2009-11-17}
   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"]
-  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.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"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "gmoney.gemspec", "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", "spec/authentication_request_spec.rb", "spec/fixtures/cacert.pem", "spec/fixtures/default_portfolios_feed.xml", "spec/fixtures/empty_portfolio_feed.xml", "spec/fixtures/new_portfolio_feed.xml", "spec/fixtures/new_transaction_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/fixtures/updated_portfolio_feed.xml", "spec/gmoney_spec.rb", "spec/nil_class_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.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}

data/lib/extensions/nil_class.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end

data/lib/extensions/string.rb

@@ -67,4 +67,8 @@ class String
       raise TransactionParseError
     end
   end
+  
+  def blank?
+    respond_to?(:empty?) ? self.strip.empty? : !self
+  end  
 end

data/lib/gmoney.rb

@@ -11,6 +11,7 @@ require 'net/https'
 require 'rexml/document'
 
 require 'extensions/fixnum'
+require 'extensions/nil_class'
 require 'extensions/string'
 
 require 'gmoney/authentication_request'
@@ -27,7 +28,7 @@ require 'gmoney/transaction'
 require 'gmoney/transaction_feed_parser'
 
 module GMoney
-  VERSION = '0.2.1'
+  VERSION = '0.4.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/feed_parser.rb

@@ -14,9 +14,6 @@ module GMoney
         finance_object = feed_class.new
         finance_data = parsed_entry.elements["gf:#{feed_class_string}Data"]
 
-        #TODO - have someone peer review this.  Is it bad practice to use instance_variable_set because
-        #it breaks encapsulation? (Even though it actually enhances the encapsulation in the "domain" classes
-        #by not allowing users to set attributes that should be read only (i.e. id, updated, return1w))
         finance_object.instance_variable_set("@id", parsed_entry.elements['id'].text)
         finance_object.instance_variable_set("@title", parsed_entry.elements['title'].text)
         finance_object.instance_variable_set("@updated", DateTime.parse(parsed_entry.elements['updated'].text))
@@ -25,7 +22,6 @@ module GMoney
         finance_data.attributes.each { |attr_name, attr_value| set_ivar.call(finance_object, attr_name, attr_value) }
         parsed_entry.elements['gf:symbol'].each { |attr_name, attr_value| set_ivar.call(finance_object, attr_name, attr_value)} if options[:symbol]
 
-        #TODO - This is only going to work for USD for now.  Might need to updated to make a "Money" object to store amount and currency code.
         finance_data.elements.each do |cg|
           finance_object.instance_variable_set("@#{cg.name.camel_to_us}", cg.elements['gd:money'].attributes['amount'].to_f)
         end

data/lib/gmoney/portfolio.rb

@@ -2,6 +2,7 @@ module GMoney
   class Portfolio 
     class PortfolioRequestError < StandardError;end
     class PortfolioDeleteError < StandardError;end
+    class PortfolioSaveError < StandardError;end    
   
     attr_accessor :title, :currency_code
                   
@@ -27,6 +28,10 @@ module GMoney
       @positions.is_a?(Array) ? @positions : [@positions]
     end
     
+    def save
+      save_portfolio
+    end
+    
     def self.delete(id)
       delete_portfolio(id)
     end
@@ -56,16 +61,44 @@ module GMoney
       
       portfolios        
     end
+    
+    def save_portfolio
+      raise PortfolioSaveError, 'Portfolios must have a title' if @title.blank?
+
+      @currency_code ||= 'USD'
+      
+      #Rcov hates multi-line strings and I hate red on my test coverage report.
+      atom_string = "<?xml version='1.0'?><entry xmlns='http://www.w3.org/2005/Atom' xmlns:gf='http://schemas.google.com/finance/2007' xmlns:gd='http://schemas.google.com/g/2005'><title type='text'>#{title}</title> <gf:portfolioData currencyCode='#{currency_code}'/></entry>"
+      
+      url = @id ? @id : GF_PORTFOLIO_FEED_URL
+
+      #Some firewalls block HTTP PUT messages. To get around this, you can include a 
+      #X-HTTP-Method-Override: PUT header in a POST request
+      headers = {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}", "Content-Type" => "application/atom+xml"}     
+      headers["X-HTTP-Method-Override"] = "PUT" if @id #if there is already an @id defined then we are updating a portfolio
+      
+      request = GFRequest.new(url, :method => :post, :body => atom_string, :headers => headers)
+     
+      response = GFService.send_request(request)
+
+      if response.status_code == HTTPCreated || response.status_code == HTTPOK
+        portfolio = PortfolioFeedParser.parse_portfolio_feed(response.body)[0]
+        self.instance_variable_set("@id", portfolio.id) if response.status_code == HTTPCreated
+      else
+        raise PortfolioSaveError, response.body
+      end
+      portfolio
+    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"    
+    #Some firewalls block HTTP DELETE messages. To get around this, you can include a 
+    #X-HTTP-Method-Override: DELETE header in a POST request   
     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 :save_portfolio
     private_class_method :retreive_portfolios, :delete_portfolio
   end
 end

data/lib/gmoney/transaction.rb

@@ -2,15 +2,19 @@ module GMoney
   class Transaction
     class TransactionRequestError < StandardError; end
     class TransactionDeleteError < StandardError;end    
+    class TransactionSaveError < StandardError;end
     
     attr_reader :id, :updated, :title
-
-    attr_accessor :type, :date, :shares, :notes, :commission, :price
+    attr_accessor :type, :date, :shares, :notes, :commission, :price, :portfolio, :ticker, :currency_code
     
     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 save
+      save_transaction
+    end    
+    
     def self.delete(id)
       delete_transaction(id)
     end
@@ -34,7 +38,7 @@ module GMoney
       return transactions[0] if transactions.size == 1
       
       transactions
-    end
+    end  
     
     #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
@@ -45,6 +49,53 @@ module GMoney
       raise TransactionDeleteError, response.body if response.status_code != HTTPOK
     end
     
+    def save_transaction
+      raise 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." if !is_valid_transaction?
+    
+      @currency_code ||= 'USD'
+      @date ||= Time.now.strftime("%Y-%m-%dT%H:%M:%S.000")
+      @shares ||= 0     
+     
+      atom_string = "<?xml version='1.0'?>
+      <entry xmlns='http://www.w3.org/2005/Atom'
+            xmlns:gf='http://schemas.google.com/finance/2007'
+            xmlns:gd='http://schemas.google.com/g/2005'>
+            <gf:transactionData date='#{@date}' shares='#{@shares}' type='#{@type}'>"
+                              
+      atom_string += "<gf:commission><gd:money amount='#{@commission}' currencyCode='#{@currency_code}'/></gf:commission>" if @commission
+      atom_string += "<gf:price><gd:money amount='#{@price}' currencyCode='#{@currency_code}'/></gf:price>" if @price
+      atom_string += "</gf:transactionData></entry>"
+      
+      url = @id ? @id : "#{GF_PORTFOLIO_FEED_URL}/#{@portfolio}/positions/#{@ticker}/transactions"
+      
+      #Some firewalls block HTTP PUT messages. To get around this, you can include a 
+      #X-HTTP-Method-Override: PUT header in a POST request
+      headers = {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}", "Content-Type" => "application/atom+xml"}
+      headers["X-HTTP-Method-Override"] = "PUT" if @id #if there is already an @id defined then we are updating a transaction
+
+      request = GFRequest.new(url, :method => :post, :body => atom_string, :headers => headers)
+      
+      response = GFService.send_request(request)
+
+      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
+      transaction
+    end
+    
+    def is_valid_transaction?
+      !(@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)
+    end
+    
+    private :save_transaction, :is_valid_transaction?, :is_valid_transaction_type?
     private_class_method :find_by_url, :delete_transaction
   end
 end

data/spec/fixtures/new_portfolio_feed.xml

@@ -0,0 +1,11 @@
+<?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/38</id>
+  <updated>2009-11-14T21:52:46.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/finance/2007#portfolio' />
+  <title type='text'>New Portfolio</title>
+  <link rel='self' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/38' />
+  <link rel='edit' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/38' />
+  <gd:feedLink href='http://finance.google.com/finance/feeds/user@example.com/portfolios/38/positions' />
+  <gf:portfolioData currencyCode='USD' gainPercentage='0.0' return1w='0.0' return1y='0.0' return3m='0.0' return3y='0.0' return4w='0.0' return5y='0.0' returnOverall='0.0' returnYTD='0.0' />
+</entry>

data/spec/fixtures/new_transaction_feed.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/12</id>
+  <updated>2009-11-18T01:44:50.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/finance/2007#transaction' />
+  <title type='text'>12</title>
+  <link rel='self' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ%3AGOOG/transactions/12' />
+  <link rel='edit' type='application/atom+xml' href='http://finance.google.com/finance/feeds/default/portfolios/9/positions/NASDAQ%3AGOOG/transactions/12' />
+  <gf:transactionData date='2009-11-17T00:00:00.000' shares='50.0' type='Buy'>
+    <gf:commission>
+      <gd:money amount='20.0' currencyCode='USD' />
+    </gf:commission>
+    <gf:price>
+      <gd:money amount='450.0' currencyCode='USD' />
+    </gf:price>
+  </gf:transactionData>
+</entry>

data/spec/fixtures/updated_portfolio_feed.xml

@@ -0,0 +1,13 @@
+<?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/38</id>
+  <updated>2009-11-14T22:12:15.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/finance/2007#portfolio' />
+  <title type='text'>Updated Title</title>
+  <link rel='self' type='application/atom+xml' href='http://finance.google.com/finance/feeds/user@example.com/portfolios/38' />
+  <link rel='edit' type='application/atom+xml' href='http://finance.google.com/finance/feeds/user@example.com/portfolios/38' />
+  <gd:feedLink href='http://finance.google.com/finance/feeds/user@example.com/portfolios/38/positions' />
+  <gf:portfolioData currencyCode='USD' gainPercentage='0.0' return1w='0.0' return1y='0.0' return3m='0.0' return3y='0.0' return4w='0.0' return5y='0.0' returnOverall='0.0' returnYTD='0.0' />
+</entry>
+
+

data/spec/nil_class_spec.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), '/spec_helper')
+
+describe NilClass do 
+  it "should return true for a method call to blank?" do  
+    nil.blank?.should be_true
+  end
+end

data/spec/portfolio_spec.rb

@@ -5,7 +5,9 @@ describe GMoney::Portfolio do
     @default_feed = File.read('spec/fixtures/default_portfolios_feed.xml')
     @feed_with_returns = File.read('spec/fixtures/portfolio_feed_with_returns.xml')
     @empty_feed = File.read('spec/fixtures/empty_portfolio_feed.xml')
-    @portfolio_9_feed = File.read('spec/fixtures/portfolio_9_feed.xml')
+    @portfolio_9_feed = File.read('spec/fixtures/portfolio_9_feed.xml')    
+    @new_portfolio_feed = File.read('spec/fixtures/new_portfolio_feed.xml')
+    @updated_portfolio_feed = File.read('spec/fixtures/updated_portfolio_feed.xml')        
   end
   
   before(:each) do
@@ -133,7 +135,58 @@ describe GMoney::Portfolio do
     portfolio_delete_helper("#{@url}/asdf")
 
     lambda { GMoney::Portfolio.delete("asdf") }.should raise_error(GMoney::Portfolio::PortfolioDeleteError, @gf_response.body)
-  end   
+  end
+  
+  it "should save a portfolio" do
+    portfolio = GMoney::Portfolio.new
+    portfolio.title = "New Portfolio"
+    
+    @gf_response.status_code = 200
+    @gf_response.body = @new_portfolio_feed
+
+    portfolio_save_helper(portfolio)
+
+    portfolio_return = portfolio.save
+    
+    portfolio_return.id.should be_eql('http://finance.google.com/finance/feeds/user@example.com/portfolios/38')
+    portfolio_return.title.should be_eql("New Portfolio")
+  end
+  
+  it "should update a portfolio when an @id is already set" do
+    portfolio = GMoney::Portfolio.new
+    portfolio.title = "New Portfolio"
+    portfolio.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/38")
+    
+    @gf_response.status_code = 201
+    @gf_response.body = @new_portfolio_feed
+
+    portfolio_save_helper(portfolio)
+    
+    portfolio.save
+  end
+  
+  it "should raise a PortfolioSaveError if the portfolio title is empty or nil" do
+    portfolio = GMoney::Portfolio.new
+    lambda { portfolio.save }.should raise_error(GMoney::Portfolio::PortfolioSaveError, 'Portfolios must have a title')    
+    
+    portfolio.title = ""
+    lambda { portfolio.save }.should raise_error(GMoney::Portfolio::PortfolioSaveError, 'Portfolios must have a title')        
+    
+    portfolio.title = "   "
+    lambda { portfolio.save }.should raise_error(GMoney::Portfolio::PortfolioSaveError, 'Portfolios must have a title')            
+  end  
+
+  it "should raise a PortfolioSaveError if a portfolio with the same title already exists" do
+    portfolio = GMoney::Portfolio.new
+    portfolio.title = "New Portfolio" #already exists
+    
+    @gf_response.status_code = 400
+    @gf_response.body = 'A Portfolio with this name already exists.'
+
+    portfolio_save_helper(portfolio)
+
+    lambda { portfolio.save }.should raise_error(GMoney::Portfolio::PortfolioSaveError, 'A Portfolio with this name already exists.')
+  end
 
   def portfolio_helper(url, id = nil, options = {})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
@@ -158,5 +211,23 @@ describe GMoney::Portfolio do
     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
+  
+  def portfolio_save_helper(portfolio)
+    title = portfolio.title
+    currency_code = portfolio.currency_code ? portfolio.currency_code : 'USD'
+  
+    atom_string = "<?xml version='1.0'?><entry xmlns='http://www.w3.org/2005/Atom' xmlns:gf='http://schemas.google.com/finance/2007' xmlns:gd='http://schemas.google.com/g/2005'><title type='text'>#{title}</title> <gf:portfolioData currencyCode='#{currency_code}'/></entry>"
+    
+    url = portfolio.id ? portfolio.id : GMoney::GF_PORTFOLIO_FEED_URL    
+
+    GMoney::GFSession.should_receive(:auth_token).and_return('toke')
+
+    headers = {"Authorization" => "GoogleLogin auth=toke", "Content-Type" => "application/atom+xml"}
+    headers["X-HTTP-Method-Override"] = "PUT" if portfolio.id
+
+    GMoney::GFRequest.should_receive(:new).with(url, :method => :post, :body => atom_string, :headers => headers).and_return(@gf_request)
+
+    GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)    
+  end
 end

data/spec/string_spec.rb

@@ -81,4 +81,12 @@ describe String do
     lambda {"123/NASDAQ:GOOG/2134/23".transaction_id}.should raise_error(String::TransactionParseError)
     "123/NASDAQ:GOOG/23".transaction_id.should be_eql("23")
   end
+  
+  it "should be able to detect blank strings" do  
+    nil.blank?.should be_true
+    "".blank?.should be_true
+    "    ".blank?.should be_true    
+    "  a  ".blank?.should be_false
+    "234".blank?.should be_false  
+  end
 end

data/spec/transaction_spec.rb

@@ -4,6 +4,7 @@ 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')
+    @new_transaction_feed = File.read('spec/fixtures/new_transaction_feed.xml')
   end
   
   before(:each) do
@@ -85,6 +86,140 @@ describe GMoney::Transaction do
     lambda { GMoney::Transaction.delete("9/NASDAQ:GOOG/24") }.should raise_error(GMoney::Transaction::TransactionDeleteError, @gf_response.body)
   end
   
+  it "should create only valid transactions" do
+    trans = GMoney::Transaction.new
+    
+    #Make is_valid_transaction? method public for testing purposes
+    def trans.public_is_valid_transaction?(*args)
+      is_valid_transaction?(*args)
+    end 
+    
+    trans.portfolio = 1
+    trans.ticker = "NYSE:GLD"    
+    trans.type = 'Buy'
+    trans.public_is_valid_transaction?.should be_true
+    
+    trans.type = 'Sell'
+    trans.public_is_valid_transaction?.should be_true    
+    
+    trans.type = 'Buy to Cover'
+    trans.public_is_valid_transaction?.should be_true    
+
+    trans.type = 'Sell Short'
+    trans.public_is_valid_transaction?.should be_true        
+    
+    trans.portfolio = 1
+    trans.ticker = "NYSE:GLD"    
+    trans.type = nil
+    trans.public_is_valid_transaction?.should be_false
+    
+    trans.portfolio = 1
+    trans.ticker = "NYSE:GLD"    
+    trans.type = 'buy'
+    trans.public_is_valid_transaction?.should be_false
+    
+    trans.portfolio = 1
+    trans.ticker = "   "
+    trans.type = 'Buy'    
+    trans.public_is_valid_transaction?.should be_false
+    
+    trans.portfolio = "  "
+    trans.ticker = "NYSE:GLD"
+    trans.type = 'Buy'    
+    trans.public_is_valid_transaction?.should be_false    
+    
+    trans.portfolio = nil
+    trans.ticker = nil
+    trans.type = nil
+    trans.public_is_valid_transaction?.should be_false        
+    
+    trans.portfolio = nil
+    trans.ticker = "NYSE:GLD"
+    trans.type = 'Buy'    
+    trans.public_is_valid_transaction?.should be_false        
+    
+    trans.portfolio = "1"
+    trans.ticker = nil
+    trans.type = 'Buy'    
+    trans.public_is_valid_transaction?.should be_false                
+  end
+
+  it "should save a transaction" do
+    transaction = GMoney::Transaction.new
+    transaction.portfolio = 9
+    transaction.ticker = 'NASDAQ:GOOG'
+    transaction.type = 'Buy'
+    transaction.shares = 50
+    transaction.price = 450.0
+    transaction.commission = 20.0
+    transaction.date = '2009-11-17T00:00:00.000'
+    
+    @gf_response.status_code = 200
+    @gf_response.body = @new_transaction_feed
+
+    transaction_save_helper(transaction)
+
+    transaction_return = transaction.save
+    
+    transaction_return.id.should be_eql('http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12')
+    transaction_return.commission.should be_eql(20.0)
+    transaction_return.price.should be_eql(450.0)
+    transaction_return.type.should be_eql('Buy')
+  end
+
+  it "should update a transaction when an @id is already set" do
+    transaction = GMoney::Transaction.new
+    transaction.portfolio = 9
+    transaction.ticker = 'NASDAQ:GOOG'
+    transaction.type = 'Buy'
+    transaction.shares = 50
+    transaction.price = 450.0
+    transaction.commission = 20.0
+    transaction.date = '2009-11-17T00:00:00.000'
+    transaction.instance_variable_set("@id", "http://finance.google.com/finance/feeds/user@example.com/portfolios/9/positions/NASDAQ:GOOG/transactions/12")
+    
+    @gf_response.status_code = 201
+    @gf_response.body = @new_transaction_feed
+
+    transaction_save_helper(transaction)
+    
+    transaction.save
+  end
+ 
+  it "should raise a TransactionSaveError if the transaction type, ticker, or portfolio are not set" do
+    transaction = GMoney::Transaction.new
+    
+    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'
+    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'
+    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
+  
+  it "should give you a warning from Google if your transaction attributes are bad" do   
+    transaction = GMoney::Transaction.new
+    transaction.portfolio = 9
+    transaction.ticker = 'asdfasd:asdfs' #invalid ticker
+    transaction.type = 'Buy'
+    transaction.shares = 50
+    transaction.price = 450.0
+    transaction.commission = 20.0
+    transaction.date = '2009-11-17T00:00:00.000'    
+
+    @gf_response.status_code = 400
+    @gf_response.body = 'Some of the values submitted are not valid and have been ignored.'
+
+    transaction_save_helper(transaction)
+    
+    lambda { transaction.save }.should raise_error(GMoney::Transaction::TransactionSaveError, "Some of the values submitted are not valid and have been ignored.")
+    
+  end
+  
   def transaction_helper(id, options={})
     GMoney::GFSession.should_receive(:auth_token).and_return('toke')
 
@@ -104,4 +239,29 @@ describe GMoney::Transaction do
 
     GMoney::GFService.should_receive(:send_request).with(@gf_request).and_return(@gf_response)
   end    
+  
+  def transaction_save_helper(transaction)
+    currency_code = transaction.currency_code ? transaction.currency_code : 'USD'
+  
+      atom_string = "<?xml version='1.0'?>
+      <entry xmlns='http://www.w3.org/2005/Atom'
+            xmlns:gf='http://schemas.google.com/finance/2007'
+            xmlns:gd='http://schemas.google.com/g/2005'>
+            <gf:transactionData date='#{transaction.date}' shares='#{transaction.shares}' type='#{transaction.type}'>"
+
+      atom_string += "<gf:commission><gd:money amount='#{transaction.commission}' currencyCode='#{currency_code}'/></gf:commission>" if transaction.commission
+      atom_string += "<gf:price><gd:money amount='#{transaction.price}' currencyCode='#{currency_code}'/></gf:price>" if transaction.price
+      atom_string += "</gf:transactionData></entry>"
+    
+    url = transaction.id ? transaction.id : "#{GMoney::GF_PORTFOLIO_FEED_URL}/#{transaction.portfolio}/positions/#{transaction.ticker}/transactions"
+
+    GMoney::GFSession.should_receive(:auth_token).and_return('toke')
+
+    headers = {"Authorization" => "GoogleLogin auth=toke", "Content-Type" => "application/atom+xml"}
+    headers["X-HTTP-Method-Override"] = "PUT" if transaction.id
+
+    GMoney::GFRequest.should_receive(:new).with(url, :method => :post, :body => atom_string, :headers => headers).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.2.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Justin Spradlin
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-14 00:00:00 -05:00
+date: 2009-11-17 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,7 @@ extensions: []
 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
@@ -42,6 +43,7 @@ files:
 - Rakefile
 - gmoney.gemspec
 - lib/extensions/fixnum.rb
+- lib/extensions/nil_class.rb
 - lib/extensions/string.rb
 - lib/gmoney.rb
 - lib/gmoney/authentication_request.rb
@@ -60,6 +62,8 @@ files:
 - spec/fixtures/cacert.pem
 - spec/fixtures/default_portfolios_feed.xml
 - spec/fixtures/empty_portfolio_feed.xml
+- spec/fixtures/new_portfolio_feed.xml
+- spec/fixtures/new_transaction_feed.xml
 - spec/fixtures/portfolio_9_feed.xml
 - spec/fixtures/portfolio_feed_with_returns.xml
 - spec/fixtures/position_feed_for_9_GOOG.xml
@@ -68,7 +72,9 @@ files:
 - spec/fixtures/positions_feed_for_portfolio_9r.xml
 - spec/fixtures/transaction_feed_for_GOOG_1.xml
 - spec/fixtures/transactions_feed_for_GOOG.xml
+- spec/fixtures/updated_portfolio_feed.xml
 - spec/gmoney_spec.rb
+- spec/nil_class_spec.rb
 - spec/portfolio_feed_parser_spec.rb
 - spec/portfolio_spec.rb
 - spec/position_feed_parser_spec.rb
@@ -93,7 +99,7 @@ rdoc_options:
 - --title
 - Gmoney
 - --main
-- README.rdoc~
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement