ticker_fetcher 0.3.1 → 0.4.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Matt White
+Copyright (c) 2010 Matt White
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,17 @@
 = ticker_fetcher
 
-Description goes here.
+Downloads basic company information for the three major US stock exchanges (NYSE, Nasdaq, Amex).
+
+== Installation
+
+    gem install ticker_fetcher
+
+== Usage
+
+    tf = TickerFetcher::Retriever.new
+    tf.run                            # gets all 3 exchanges
+    tf.run('NASD')                    # gets the specified exchange
+    tf['NASD']
 
 == Note on Patches/Pull Requests
  

data/lib/ticker_fetcher/retriever.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'open-uri'
+require 'csv'
+require 'ticker_fetcher/stock'
+
+module TickerFetcher
+  class Retriever
+    Symbol = 0
+    Name = 1
+    LastSale = 2
+    MarketCap = 3
+    IPOYear = 4
+    Sector = 5
+    Industry = 6
+    attr_reader :exchanges, :exchange_urls
+
+    # Passing an exchange name will retrieve only that exchange. Default is to retrieve all.
+    def initialize
+      @exchanges = {}
+      @exchange_urls = {
+        'AMEX' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=AMEX&render=download',
+        'NASD' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=NASDAQ&render=download',
+        'NYSE' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=NYSE&render=download'
+      }
+    end
+
+    def run(exchange=:all)
+      if exchange == :all
+        @exchange_urls.each { |exchange, url| @exchanges[exchange] = parse_exchange(exchange, url) }
+      else
+        @exchanges[exchange] = parse_exchange(exchange, @exchange_urls[exchange])
+      end
+    end
+
+    def parse_exchange(exchange, url)
+      data = open(url)
+      parse_csv(data)
+    end
+
+    def [](exchange)
+      exchanges[exchange]
+    end
+
+    private
+
+    def parse_csv(data)
+      CSV.parse(data, :headers => true).inject([]) do |stocks, row|
+        stocks << TickerFetcher::Stock.new([ticker(row), name(row), last_sale(row), market_cap(row), ipo_year(row), sector(row), industry(row)])
+      end
+    end
+
+    def name(row)
+      row[Name]
+    end
+
+    def ticker(row)
+      ticker = row[Symbol].strip.gsub('"', '')
+      unless(ticker.nil? || ticker.empty?)
+        ticker = ticker =~ /\W/ ? ticker.gsub('/', '.').gsub('^', '-') : ticker
+      end
+    end
+
+    def last_sale(row)
+      row[LastSale]
+    end
+
+    def market_cap(row)
+      row[MarketCap]
+    end
+
+    def ipo_year(row)
+      row[IPOYear]
+    end
+
+    def sector(row)
+      row[Sector]
+    end
+
+    def industry(row)
+      row[Industry]
+    end
+  end
+end

data/lib/ticker_fetcher/stock.rb

@@ -0,0 +1,17 @@
+require 'ticker_fetcher/retriever'
+
+module TickerFetcher
+  class Stock
+    attr_reader :symbol, :name, :last_sale, :market_cap, :ipo_year, :sector, :industry
+
+    def initialize(data)
+      @symbol = data[TickerFetcher::Retriever::Symbol]
+      @name = data[TickerFetcher::Retriever::Name]
+      @last_sale = data[TickerFetcher::Retriever::LastSale]
+      @market_cap = data[TickerFetcher::Retriever::MarketCap]
+      @ipo_year = data[TickerFetcher::Retriever::IPOYear]
+      @sector = data[TickerFetcher::Retriever::Sector]
+      @industry = data[TickerFetcher::Retriever::Industry]
+    end
+  end
+end

data/test/helper.rb

@@ -4,4 +4,3 @@ require 'fakeweb'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'ticker_fetcher'

data/test/test_retriever.rb

@@ -0,0 +1,78 @@
+require 'helper'
+require 'ticker_fetcher/retriever'
+
+class TestRetriever < Test::Unit::TestCase
+  def setup
+    @retriever = TickerFetcher::Retriever.new
+    @retriever.exchange_urls.each do |exchange, url|
+      FakeWeb.register_uri(
+        :get,
+        url,
+        :body => File.open("test/#{exchange.downcase}_test_data.csv").read)
+    end
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_one_exchange
+    @retriever.run('NYSE')
+    assert_not_nil(@retriever.exchanges['NYSE'])
+    assert_nil(@retriever.exchanges['NASD'])
+    assert_nil(@retriever.exchanges['AMEX'])
+  end
+
+  def test_retrieve_with_two_exchanges_returns_a_ticker_fetcher_with_two_exchanges
+    @retriever.run('NYSE')
+    @retriever.run('NASD')
+    assert_not_nil(@retriever.exchanges['NYSE'])
+    assert_not_nil(@retriever.exchanges['NASD'])
+    assert_nil(@retriever.exchanges['AMEX'])
+  end
+
+  def test_retrieve_with_all_exchanges_returns_a_ticker_fetcher_with_all_exchanges
+    @retriever.run
+    @retriever.exchanges.keys.each do |exchange|
+      assert_not_nil(@retriever.exchanges[exchange])
+    end
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_tickers
+    @retriever.run('NYSE')
+    assert_equal('SC', @retriever.exchanges['NYSE'].first.symbol)
+    assert_equal('ZGEN', @retriever.exchanges['NYSE'].last.symbol)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_company_names
+    @retriever.run('NYSE')
+    assert_equal('StupidCompany, Inc.', @retriever.exchanges['NYSE'].first.name)
+    assert_equal('ZymoGenetics, Inc.', @retriever.exchanges['NYSE'].last.name)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_last_sale_price
+    @retriever.run('NYSE')
+    assert_equal('2.71', @retriever.exchanges['NYSE'].first.last_sale)
+    assert_equal('25', @retriever.exchanges['NYSE'].last.last_sale)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_market_cap
+    @retriever.run('NYSE')
+    assert_equal('72858350', @retriever.exchanges['NYSE'].first.market_cap)
+    assert_equal('85473000', @retriever.exchanges['NYSE'].last.market_cap)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_ipo_year
+    @retriever.run('NYSE')
+    assert_equal('1999', @retriever.exchanges['NYSE'].first.ipo_year)
+    assert_equal('2015', @retriever.exchanges['NYSE'].last.ipo_year)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_sector
+    @retriever.run('NYSE')
+    assert_equal('Consumer Services', @retriever.exchanges['NYSE'].first.sector)
+    assert_equal('Technology', @retriever.exchanges['NYSE'].last.sector)
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_industry
+    @retriever.run('NYSE')
+    assert_equal('Other Specialty Stores', @retriever.exchanges['NYSE'].first.industry)
+    assert_equal('Semiconductors', @retriever.exchanges['NYSE'].last.industry)
+  end
+end

data/test/test_stock.rb

@@ -0,0 +1,25 @@
+require 'helper'
+require 'ticker_fetcher/stock'
+
+class TestStock < Test::Unit::TestCase
+  def setup
+    @symbol = 'TESTING'
+    @name = 'Testing, Inc.'
+    @last_sale = '1.23'
+    @market_cap = '123456789'
+    @ipo_year = '2000'
+    @sector = 'Consumer Services'
+    @industry = 'Other Specialty Stores'
+  end
+
+  def test_create_a_stock
+    stock = TickerFetcher::Stock.new([@symbol, @name, @last_sale, @market_cap, @ipo_year, @sector, @industry])
+    assert_equal(@symbol, stock.symbol)
+    assert_equal(@name, stock.name)
+    assert_equal(@last_sale, stock.last_sale)
+    assert_equal(@market_cap, stock.market_cap)
+    assert_equal(@ipo_year, stock.ipo_year)
+    assert_equal(@sector, stock.sector)
+    assert_equal(@industry, stock.industry)
+  end
+end

data/ticker_fetcher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "ticker_fetcher"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
   s.authors = ["Matt White"]
   s.email = %q{mattw922@gmail.com}
   s.homepage = %q{http://github.com/whitethunder/ticker_fetcher}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ticker_fetcher
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-09 00:00:00.000000000Z
+date: 2011-08-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &78156870 !ruby/object:Gem::Requirement
+  requirement: &80580980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *78156870
+  version_requirements: *80580980
 description: Retrieves tickers, names, and other useful data for all stocks listed
   on the 3 major US exchanges (NYSE, NASDAQ, AMEX).
 email: mattw922@gmail.com
@@ -37,12 +37,14 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
-- lib/ticker_fetcher.rb
+- lib/ticker_fetcher/retriever.rb
+- lib/ticker_fetcher/stock.rb
 - test/amex_test_data.csv
 - test/helper.rb
 - test/nasd_test_data.csv
 - test/nyse_test_data.csv
-- test/test_ticker_fetcher.rb
+- test/test_retriever.rb
+- test/test_stock.rb
 - ticker_fetcher.gemspec
 homepage: http://github.com/whitethunder/ticker_fetcher
 licenses: []

data/lib/ticker_fetcher.rb

@@ -1,80 +0,0 @@
-require 'rubygems'
-require 'open-uri'
-require 'csv'
-
-class TickerFetcher
-  Symbol = 0
-  Name = 1
-  LastSale = 2
-  MarketCap = 3
-  IPOYear = 4
-  Sector = 5
-  Industry = 6
-  attr_reader :exchanges, :exchange_urls
-
-  # Passing an exchange name will retrieve only that exchange. Default is to retrieve all.
-  def initialize
-    @exchanges = {}
-    @exchange_urls = {
-      'AMEX' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=AMEX&render=download',
-      'NASD' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=NASDAQ&render=download',
-      'NYSE' => 'http://www.nasdaq.com/screening/companies-by-industry.aspx?exchange=NYSE&render=download'
-    }
-  end
-
-  def retrieve(exchange=:all)
-    if exchange == :all
-      @exchange_urls.each { |exchange, url| @exchanges[exchange] = parse_exchange(exchange, url) }
-    else
-      @exchanges[exchange] = parse_exchange(exchange, @exchange_urls[exchange])
-    end
-  end
-
-  def parse_exchange(exchange, url)
-    data = open(url)
-    parse_csv(data)
-  end
-
-  def [](exchange)
-    exchanges[exchange]
-  end
-
-  private
-
-  def parse_csv(data)
-    CSV.parse(data, :headers => true).inject([]) do |tickers, row|
-      tickers << [ticker(row), name(row), last_sale(row), market_cap(row), ipo_year(row), sector(row), industry(row)]
-    end
-  end
-
-  def name(row)
-    row[Name]
-  end
-
-  def ticker(row)
-    ticker = row[Symbol].strip.gsub('"', '')
-    unless(ticker.nil? || ticker.empty?)
-      ticker = ticker =~ /\W/ ? ticker.gsub('/', '.').gsub('^', '-') : ticker
-    end
-  end
-
-  def last_sale(row)
-    row[LastSale]
-  end
-
-  def market_cap(row)
-    row[MarketCap]
-  end
-
-  def ipo_year(row)
-    row[IPOYear]
-  end
-
-  def sector(row)
-    row[Sector]
-  end
-
-  def industry(row)
-    row[Industry]
-  end
-end

data/test/test_ticker_fetcher.rb

@@ -1,77 +0,0 @@
-require 'helper'
-
-class TestTickerFetcher < Test::Unit::TestCase
-  def setup
-    @tf = TickerFetcher.new
-    @tf.exchange_urls.each do |exchange, url|
-      FakeWeb.register_uri(
-        :get,
-        url,
-        :body => File.open("test/#{exchange.downcase}_test_data.csv").read)
-    end
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_one_exchange
-    @tf.retrieve('NYSE')
-    assert_not_nil(@tf.exchanges['NYSE'])
-    assert_nil(@tf.exchanges['NASD'])
-    assert_nil(@tf.exchanges['AMEX'])
-  end
-
-  def test_retrieve_with_two_exchanges_returns_a_ticker_fetcher_with_two_exchanges
-    @tf.retrieve('NYSE')
-    @tf.retrieve('NASD')
-    assert_not_nil(@tf.exchanges['NYSE'])
-    assert_not_nil(@tf.exchanges['NASD'])
-    assert_nil(@tf.exchanges['AMEX'])
-  end
-
-  def test_retrieve_with_all_exchanges_returns_a_ticker_fetcher_with_all_exchanges
-    @tf.retrieve
-    @tf.exchanges.keys.each do |exchange|
-      assert_not_nil(@tf.exchanges[exchange])
-    end
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_tickers
-    @tf.retrieve('NYSE')
-    assert_equal('SC', @tf.exchanges['NYSE'].first[TickerFetcher::Symbol])
-    assert_equal('ZGEN', @tf.exchanges['NYSE'].last[TickerFetcher::Symbol])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_company_names
-    @tf.retrieve('NYSE')
-    assert_equal('StupidCompany, Inc.', @tf.exchanges['NYSE'].first[TickerFetcher::Name])
-    assert_equal('ZymoGenetics, Inc.', @tf.exchanges['NYSE'].last[TickerFetcher::Name])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_last_sale_price
-    @tf.retrieve('NYSE')
-    assert_equal('2.71', @tf.exchanges['NYSE'].first[TickerFetcher::LastSale])
-    assert_equal('25', @tf.exchanges['NYSE'].last[TickerFetcher::LastSale])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_market_cap
-    @tf.retrieve('NYSE')
-    assert_equal('72858350', @tf.exchanges['NYSE'].first[TickerFetcher::MarketCap])
-    assert_equal('85473000', @tf.exchanges['NYSE'].last[TickerFetcher::MarketCap])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_ipo_year
-    @tf.retrieve('NYSE')
-    assert_equal('1999', @tf.exchanges['NYSE'].first[TickerFetcher::IPOYear])
-    assert_equal('2015', @tf.exchanges['NYSE'].last[TickerFetcher::IPOYear])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_sector
-    @tf.retrieve('NYSE')
-    assert_equal('Consumer Services', @tf.exchanges['NYSE'].first[TickerFetcher::Sector])
-    assert_equal('Technology', @tf.exchanges['NYSE'].last[TickerFetcher::Sector])
-  end
-
-  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_correct_industry
-    @tf.retrieve('NYSE')
-    assert_equal('Other Specialty Stores', @tf.exchanges['NYSE'].first[TickerFetcher::Industry])
-    assert_equal('Semiconductors', @tf.exchanges['NYSE'].last[TickerFetcher::Industry])
-  end
-end