jspradlin-gmoney 0.0.2

data/Manifest

@@ -0,0 +1,42 @@
+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

data/README.rdoc

@@ -0,0 +1,29 @@
+= GMoney
+
+A gem for interacting with the Google Finance API
+
+== Install
+
+  gem install jspradlin-gmoney --source http://gems.github.com
+  
+== Usage
+
+GMoney::GFSession.login('google username', 'password')
+
+portfolios = GMoney::Portfolio.all #or GMoney::Portfolio.all(:with_returns => true)
+
+#wait for a minute or so
+
+portfolios will now contain a list of all of your google finance portfolios, positions, and transactions
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 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:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'spec/rake/spectask'
+
+task :default => :specs
+
+desc "Run the gmoney specs"
+task :specs do
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec']
+    t.spec_opts = ['--options', "spec/spec.opts"]
+  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 = []
+end

data/gmoney.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gmoney}
+  s.version = "0.0.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-09-15}
+  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.homepage = %q{http://github.com/jspradlin/gmoney}
+  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.summary = %q{A gem for interacting with the Google Finance API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/extensions/string.rb

@@ -0,0 +1,10 @@
+class String
+  def camel_to_us
+    add_us = gsub(/(.)([A-Z][a-z]+)/, '\1_\2')
+    add_us.gsub(/([a-z0-9])([A-Z])/, '\1_\2').downcase  
+  end
+  
+  def is_numeric?
+    Float self rescue false
+  end
+end

data/lib/gmoney.rb

@@ -0,0 +1,39 @@
+# Justin Spradlin
+# www.fiascode.com
+# (C) 2009
+
+
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'date'
+require 'net/http'
+require 'net/https'
+require 'rexml/document'
+
+require 'extensions/string'
+
+require 'gmoney/authentication_request'
+require 'gmoney/feed_parser.rb'
+require 'gmoney/gf_request'
+require 'gmoney/gf_response'
+require 'gmoney/gf_service'
+require 'gmoney/gf_session'
+require 'gmoney/portfolio'
+require 'gmoney/portfolio_feed_parser'
+require 'gmoney/position'
+require 'gmoney/position_feed_parser'
+require 'gmoney/transaction'
+require 'gmoney/transaction_feed_parser'
+
+module GMoney
+  VERSION = '0.0.2'
+  GF_URL = "https://finance.google.com/finance"
+  GF_FEED_URL = "#{GF_URL}/feeds/default"
+  
+  HTTPOK = 200
+  HTTPCreated = 201
+  
+  def self.version
+    VERSION
+  end
+end

data/lib/gmoney/authentication_request.rb

@@ -0,0 +1,52 @@
+module GMoney
+  class AuthenticationRequest
+    class AuthError < StandardError;end
+    
+    AUTH_URL = 'https://www.google.com/accounts/ClientLogin'
+    
+    def initialize(email, password)
+      @email = email
+      @password = password
+    end
+    
+    def parameters
+      {
+        'Email'       => @email,
+        'Passwd'      => @password,
+        'accountType' => 'HOSTED_OR_GOOGLE',
+        'service'     => 'finance',
+        'source'      => 'gmoney-001'
+      }
+    end
+    
+    def uri
+      URI.parse(AUTH_URL)
+    end
+    
+    def send_request(ssl_mode)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = ssl_mode
+
+      if ssl_mode == OpenSSL::SSL::VERIFY_PEER
+        http.ca_file = CA_CERT_FILE
+      end
+
+      http.request(build_request) do |response|
+        raise AuthError unless response.is_a?(Net::HTTPOK)
+      end
+    end
+
+    def build_request
+      post = Net::HTTP::Post.new(uri.path)
+      post.set_form_data(parameters)
+      post
+    end
+    
+    def auth_token(opts={})
+      ssl_mode = opts[:secure] ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+      send_request(ssl_mode).body.match(/^Auth=(.*)$/)[1]
+    end
+
+  end
+end

data/lib/gmoney/feed_parser.rb

@@ -0,0 +1,37 @@
+module GMoney
+  class FeedParser
+    def self.parse_feed(feed, feed_class, options = {:feed_link => true, :symbol => false})
+      doc = REXML::Document.new(feed)
+      finance_objects = []      
+      feed_class_string = feed_class.to_s.gsub("GMoney::", "").downcase
+      
+      set_ivar = lambda do |target, name, value|
+        value = value.to_f if value.is_numeric?
+        target.instance_variable_set("@#{name.camel_to_us}", value)
+      end
+
+      doc.elements.each('feed/entry') do |parsed_entry|
+        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))
+        finance_object.instance_variable_set("@feed_link", parsed_entry.elements['gd:feedLink'].attributes['href']) if options[:feed_link]
+        
+        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
+        finance_objects << finance_object 
+      end
+      finance_objects
+    end
+  end
+end

data/lib/gmoney/gf_request.rb

@@ -0,0 +1,15 @@
+module GMoney
+  class GFRequest
+    attr_accessor :url, :body, :method, :headers
+    
+    def initialize(url, options = {})
+      @url = url
+      options.each do |key, value|
+        self.send("#{key}=", value)
+      end
+      
+      @method ||= :get
+      @headers ||= {}
+    end    
+  end 
+end

data/lib/gmoney/gf_response.rb

@@ -0,0 +1,5 @@
+module GMoney
+  class GFResponse
+    attr_accessor :status_code, :body, :headers
+  end 
+end

data/lib/gmoney/gf_service.rb

@@ -0,0 +1,46 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module GMoney 
+  class GFService 
+    def self.send_request(request)       
+      url = URI.parse(request.url)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = (url.scheme == 'https')
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      case request.method
+      when :get
+        req = Net::HTTP::Get.new(url.request_uri)
+      when :put
+        req = Net::HTTP::Put.new(url.request_uri)
+      when :post
+        req = Net::HTTP::Post.new(url.request_uri)
+      when :delete
+        req = Net::HTTP::Delete.new(url.request_uri)
+      else
+        raise ArgumentError, "Unsupported HTTP method specified."
+      end
+      
+      req.body = request.body.to_s
+      
+      request.headers.each do |key, value|
+        req[key] = value
+      end
+           
+      res = http.request(req)
+      
+      response = GFResponse.new
+      response.body = res.body
+      response.headers = Hash.new
+      res.each do |key, value|
+        response.headers[key] = value
+      end
+      
+      response.status_code = res.code.to_i
+      
+      return response
+    end
+  end
+end

data/lib/gmoney/gf_session.rb

@@ -0,0 +1,18 @@
+module GMoney
+  class GFSession
+    
+    def self.login(email, password, opts={})
+      @email = email
+      auth_request = GMoney::AuthenticationRequest.new(email, password)
+      @auth_token = auth_request.auth_token(opts)
+    end
+
+    def self.auth_token
+      @auth_token
+    end
+
+    def self.email
+      @email
+    end
+  end
+end

data/lib/gmoney/portfolio.rb

@@ -0,0 +1,34 @@
+module GMoney
+  class Portfolio 
+    class PortfolioRequestError < StandardError;end
+  
+    attr_accessor :title, :currency_code, :positions
+                  
+    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 initialize()    
+      @positions = []
+    end
+    
+    def self.all(options = {})
+      url = "#{GF_FEED_URL}/portfolios"
+      url += "?returns=true" if options[:with_returns]
+      portfolios = []
+      
+      response = GFService.send_request(GFRequest.new(url, :headers => {"Authorization" => "GoogleLogin auth=#{GFSession.auth_token}"}))
+
+      if response.status_code == HTTPOK
+        portfolios = PortfolioFeedParser.parse_portfolio_feed(response.body)
+      else
+        raise PortfolioRequestError
+      end
+
+      portfolios.each do |portfolio|
+        portfolio.positions = Position.find_by_url(portfolio.feed_link, {:with_returns => options[:with_returns]})
+      end      
+      portfolios  
+    end
+  end
+end

data/lib/gmoney/portfolio_feed_parser.rb

@@ -0,0 +1,7 @@
+module GMoney
+  class PortfolioFeedParser < FeedParser
+    def self.parse_portfolio_feed(portfolio_feed)
+      parse_feed(portfolio_feed, Portfolio)
+    end
+  end 
+end

data/lib/gmoney/position.rb

@@ -0,0 +1,33 @@
+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 = []
+    end
+    
+    def self.find_by_url(url, options = {})
+      positions = []
+      url += "?returns=true" if options[:with_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
+      end
+
+      positions.each do |position|
+        position.transactions = Transaction.find_by_url(position.feed_link)
+      end      
+      positions
+    end 
+  end
+end

data/lib/gmoney/position_feed_parser.rb

@@ -0,0 +1,7 @@
+module GMoney
+  class PositionFeedParser < FeedParser
+    def self.parse_position_feed(position_feed)
+      parse_feed(position_feed, Position, {:feed_link => true, :symbol => true})
+    end
+  end 
+end