ticker_fetcher 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Matt White
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= ticker_fetcher
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matt White. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ticker_fetcher"
+    gem.summary = %Q{Fetches all tickers for NYSE, NASDAQ, and AMEX exchanges.}
+    gem.description = %Q{Retrieves tickers, names, and SEC descriptions for all securities listed on the 3 major US exchanges (NYSE, NASDAQ, AMEX).}
+    gem.email = "mattw922@gmail.com"
+    gem.homepage = "http://github.com/whitethunder/ticker_fetcher"
+    gem.authors = ["Matt White"]
+    gem.add_development_dependency "fastercsv", ">= 1.5.0"
+    gem.add_development_dependency "flexmock", ">= 0.8.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ticker_fetcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ticker_fetcher.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'open-uri'
+require 'fastercsv'
+
+class TickerFetcher
+  attr_accessor :exchanges
+
+  # Passing 1 or more exchange names will retrieve only those exchanges. Default
+  # is to retrieve all.
+  def initialize
+    @exchanges = {}
+    @exchange_urls = {
+      'NASD' => 'http://www.nasdaq.com/asp/symbols.asp?exchange=Q&start=0',
+      'AMEX' => 'http://www.nasdaq.com/asp/symbols.asp?exchange=1&start=0',
+      'NYSE' => 'http://www.nasdaq.com/asp/symbols.asp?exchange=N&start=0'
+    }
+  end
+
+  def retrieve(*exchanges_to_get)
+    @exchange_urls.delete_if { |k,v| !exchanges_to_get.flatten.include?(k.upcase) } unless exchanges_to_get.empty?
+    @exchange_urls.each { |exchange, url| @exchanges[exchange] = parse_exchange(exchange, url) }
+  end
+
+  def parse_exchange(exchange, url)
+    data = open(url)
+    parse_csv(data)
+  end
+
+  private
+
+  def parse_csv(data)
+    tickers = []
+    FasterCSV.parse(data) { |row|
+      name = row[0]
+      ticker = row[1].strip.gsub('"', '')
+      unless(ticker.nil? || ticker.empty? || ticker == 'Symbol')
+        ticker = ticker.gsub('/', '.').gsub('^', '-') if ticker =~ /\W/
+        description = row[5].strip
+        tickers << [ticker, name, description]
+      end
+    }
+    tickers
+  end
+end

data/test/amex_test_data.csv

@@ -0,0 +1,41 @@
+"Some Exchange Securities as of 12/31/2010","","",""
+"Name","Symbol","Security Type","Shares Outstanding","Market Value (millions)","Description (as filed with the SEC)"
+"StupidCompany, Inc.","SC","Common Stock","26,656,000","$75.7","For more than 30 years, StupidCompany, Inc. - ""Your Premier Provider of All Things Stupid"" -
+has been  providing  customers  around the world with the stupidest crap you can imagine.
+
+Customers can ""call, click, or come in"" to shop for stupid crap."
+"AwesomeCompany, Inc.","AC^B","Common Stock","26,656,000","$75.7","For more than 40 years, AwesomeCompany, Inc. - ""Your Premier Provider of All Things Awesome"" -
+has been  providing  customers  around the world with the awesomest awesome you can imagine.
+
+Customers can ""call, click, or come in"" to shop for awesome."
+"Company, Inc.","C-A","Common Stock","26,656,000","$75.7","For more than 50 years, Company, Inc. - ""Your Premier Provider of All Things"" -
+has been  providing  customers  around the world with evarything.
+
+Customers can ""call, click, or come in"" to shop."
+"Zygo Corporation","ZIGO","Common Stock","17,411,000","$162.8","Zygo Corporation (<93>ZYGO,<92><92> <93>we,<92><92> <93>us,<92><92> <93>our,<92><92> or <93>Company<92><92>) designs,
+develops, and manufactures ultra-high precision measurement solutions to improve
+our customers<92> manufacturing yields, and top-tier optical sub-systems and
+components for original equipment manufacturers (<93>OEM<94>) and end-user
+applications. We operate with two divisions. Our Metrology Solutions Division
+(also referred to herein as the <93>Metrology segment<94>) manufactures products to
+improve quality, increase productivity, and decrease the overall cost of product
+development and manufacturing for high-technology companies, particularly in
+their semiconductor manufacturing processes. Our Optical Systems Division (also
+referred to herein as the <93>Optics segment<94>) provides leading-edge product
+development and manufacturing services that leverage a variety of core
+technologies across medical, defense, semiconductor, laser fusion research,
+biomedical, and other industrial markets.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2007%2f09%2f20%2f0000930413-07-007562.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"ZymoGenetics, Inc.","ZGEN","Common Stock","85,473,000","$555.6","This Annual Report on Form 10-K contains, in addition to historical information,
+forward-looking statements within the meaning of the Private Securities
+Litigation Reform Act of 1995 that involve risks and uncertainties. This Act
+provides a <93>safe harbor<94> for forward-looking statements to encourage companies
+to provide prospective information about themselves. All statements other than
+statements of historical fact, including statements regarding company and
+industry prospects and future results of operations, financial position and cash
+flows, made in this Annual Report on Form 10-K are forward-looking. We use words
+such as <93>anticipate,<94> <93>believe,<94> <93>continue,<94> <93>could,<94> <93>estimate,<94> <93>expect,<94>
+<93>future,<94> <93>intend,<94> <93>may,<94> <93>potential,<94> <93>seek,<94> <93>should,<94> <93>target<94> and similar
+expressions, including negatives, to identify forward-looking statements.
+Forward-looking statements reflect management<92>s current expectations, plans or
+projections and are inherently uncertain.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2008%2f02%2f29%2f0001193125-08-043300.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"© Copyright 2010, The NASDAQ Stock Market, Inc. All Rights Reserved.","","",""

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'flexmock/test_unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ticker_fetcher'
+
+class Test::Unit::TestCase
+end

data/test/nasd_test_data.csv

@@ -0,0 +1,41 @@
+"Some Exchange Securities as of 12/31/2010","","",""
+"Name","Symbol","Security Type","Shares Outstanding","Market Value (millions)","Description (as filed with the SEC)"
+"StupidCompany, Inc.","SC","Common Stock","26,656,000","$75.7","For more than 30 years, StupidCompany, Inc. - ""Your Premier Provider of All Things Stupid"" -
+has been  providing  customers  around the world with the stupidest crap you can imagine.
+
+Customers can ""call, click, or come in"" to shop for stupid crap."
+"AwesomeCompany, Inc.","AC^B","Common Stock","26,656,000","$75.7","For more than 40 years, AwesomeCompany, Inc. - ""Your Premier Provider of All Things Awesome"" -
+has been  providing  customers  around the world with the awesomest awesome you can imagine.
+
+Customers can ""call, click, or come in"" to shop for awesome."
+"Company, Inc.","C-A","Common Stock","26,656,000","$75.7","For more than 50 years, Company, Inc. - ""Your Premier Provider of All Things"" -
+has been  providing  customers  around the world with evarything.
+
+Customers can ""call, click, or come in"" to shop."
+"Zygo Corporation","ZIGO","Common Stock","17,411,000","$162.8","Zygo Corporation (<93>ZYGO,<92><92> <93>we,<92><92> <93>us,<92><92> <93>our,<92><92> or <93>Company<92><92>) designs,
+develops, and manufactures ultra-high precision measurement solutions to improve
+our customers<92> manufacturing yields, and top-tier optical sub-systems and
+components for original equipment manufacturers (<93>OEM<94>) and end-user
+applications. We operate with two divisions. Our Metrology Solutions Division
+(also referred to herein as the <93>Metrology segment<94>) manufactures products to
+improve quality, increase productivity, and decrease the overall cost of product
+development and manufacturing for high-technology companies, particularly in
+their semiconductor manufacturing processes. Our Optical Systems Division (also
+referred to herein as the <93>Optics segment<94>) provides leading-edge product
+development and manufacturing services that leverage a variety of core
+technologies across medical, defense, semiconductor, laser fusion research,
+biomedical, and other industrial markets.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2007%2f09%2f20%2f0000930413-07-007562.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"ZymoGenetics, Inc.","ZGEN","Common Stock","85,473,000","$555.6","This Annual Report on Form 10-K contains, in addition to historical information,
+forward-looking statements within the meaning of the Private Securities
+Litigation Reform Act of 1995 that involve risks and uncertainties. This Act
+provides a <93>safe harbor<94> for forward-looking statements to encourage companies
+to provide prospective information about themselves. All statements other than
+statements of historical fact, including statements regarding company and
+industry prospects and future results of operations, financial position and cash
+flows, made in this Annual Report on Form 10-K are forward-looking. We use words
+such as <93>anticipate,<94> <93>believe,<94> <93>continue,<94> <93>could,<94> <93>estimate,<94> <93>expect,<94>
+<93>future,<94> <93>intend,<94> <93>may,<94> <93>potential,<94> <93>seek,<94> <93>should,<94> <93>target<94> and similar
+expressions, including negatives, to identify forward-looking statements.
+Forward-looking statements reflect management<92>s current expectations, plans or
+projections and are inherently uncertain.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2008%2f02%2f29%2f0001193125-08-043300.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"© Copyright 2010, The NASDAQ Stock Market, Inc. All Rights Reserved.","","",""

data/test/nyse_test_data.csv

@@ -0,0 +1,41 @@
+"Some Exchange Securities as of 12/31/2010","","",""
+"Name","Symbol","Security Type","Shares Outstanding","Market Value (millions)","Description (as filed with the SEC)"
+"StupidCompany, Inc.","SC","Common Stock","26,656,000","$75.7","For more than 30 years, StupidCompany, Inc. - ""Your Premier Provider of All Things Stupid"" -
+has been  providing  customers  around the world with the stupidest crap you can imagine.
+
+Customers can ""call, click, or come in"" to shop for stupid crap."
+"AwesomeCompany, Inc.","AC^B","Common Stock","26,656,000","$75.7","For more than 40 years, AwesomeCompany, Inc. - ""Your Premier Provider of All Things Awesome"" -
+has been  providing  customers  around the world with the awesomest awesome you can imagine.
+
+Customers can ""call, click, or come in"" to shop for awesome."
+"Company, Inc.","C/A","Common Stock","26,656,000","$75.7","For more than 50 years, Company, Inc. - ""Your Premier Provider of All Things"" -
+has been  providing  customers  around the world with evarything.
+
+Customers can ""call, click, or come in"" to shop."
+"Zygo Corporation","ZIGO","Common Stock","17,411,000","$162.8","Zygo Corporation (<93>ZYGO,<92><92> <93>we,<92><92> <93>us,<92><92> <93>our,<92><92> or <93>Company<92><92>) designs,
+develops, and manufactures ultra-high precision measurement solutions to improve
+our customers<92> manufacturing yields, and top-tier optical sub-systems and
+components for original equipment manufacturers (<93>OEM<94>) and end-user
+applications. We operate with two divisions. Our Metrology Solutions Division
+(also referred to herein as the <93>Metrology segment<94>) manufactures products to
+improve quality, increase productivity, and decrease the overall cost of product
+development and manufacturing for high-technology companies, particularly in
+their semiconductor manufacturing processes. Our Optical Systems Division (also
+referred to herein as the <93>Optics segment<94>) provides leading-edge product
+development and manufacturing services that leverage a variety of core
+technologies across medical, defense, semiconductor, laser fusion research,
+biomedical, and other industrial markets.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2007%2f09%2f20%2f0000930413-07-007562.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"ZymoGenetics, Inc.","ZGEN","Common Stock","85,473,000","$555.6","This Annual Report on Form 10-K contains, in addition to historical information,
+forward-looking statements within the meaning of the Private Securities
+Litigation Reform Act of 1995 that involve risks and uncertainties. This Act
+provides a <93>safe harbor<94> for forward-looking statements to encourage companies
+to provide prospective information about themselves. All statements other than
+statements of historical fact, including statements regarding company and
+industry prospects and future results of operations, financial position and cash
+flows, made in this Annual Report on Form 10-K are forward-looking. We use words
+such as <93>anticipate,<94> <93>believe,<94> <93>continue,<94> <93>could,<94> <93>estimate,<94> <93>expect,<94>
+<93>future,<94> <93>intend,<94> <93>may,<94> <93>potential,<94> <93>seek,<94> <93>should,<94> <93>target<94> and similar
+expressions, including negatives, to identify forward-looking statements.
+Forward-looking statements reflect management<92>s current expectations, plans or
+projections and are inherently uncertain.&nbsp;&nbsp;... More...""http://secfilings.nasdaq.com/edgar_conv_html%2f2008%2f02%2f29%2f0001193125-08-043300.html#FIS_BUSINESS"" &nbsp;&nbsp;"
+"© Copyright 2010, The NASDAQ Stock Market, Inc. All Rights Reserved.","","",""

data/test/test_ticker_fetcher.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestTickerFetcher < Test::Unit::TestCase
+  def setup
+    @t = TickerFetcher.new
+    @t_mock = flexmock(@t)
+    @t_mock.should_receive(:parse_exchange).with('NYSE', 'http://www.nasdaq.com/asp/symbols.asp?exchange=N&start=0').and_return(@t_mock.send(:parse_csv, File.open("test/nyse_test_data.csv").read))
+    @t_mock.should_receive(:parse_exchange).with('NASD', 'http://www.nasdaq.com/asp/symbols.asp?exchange=Q&start=0').and_return(@t_mock.send(:parse_csv, File.open("test/nasd_test_data.csv").read))
+    @t_mock.should_receive(:parse_exchange).with('AMEX', 'http://www.nasdaq.com/asp/symbols.asp?exchange=1&start=0').and_return(@t_mock.send(:parse_csv, File.open("test/amex_test_data.csv").read))
+#    @t_mock.should_receive(:retrieve).with_no_args.and_return({'NYSE' => File.open("test/nyse_test_data.csv").read, 'NASD' => File.open("test/nasd_test_data.csv").read, 'AMEX' => File.open("test/amex_test_data.csv").read})
+#    @t_mock.should_receive(:retrieve).with('NYSE').and_return({'NYSE' => File.open("test/nyse_test_data.csv").read})
+#    @t_mock.should_receive(:retrieve).with('NYSE', 'NASD').and_return({'NYSE' => File.open("test/nyse_test_data.csv").read, 'NASD' => File.open("test/nasd_test_data.csv").read})
+  end
+
+  def test_retrieve_with_one_exchange_returns_a_ticker_fetcher_with_the_correct_data
+    @t_mock.retrieve('NYSE')
+    assert_not_nil(@t_mock.exchanges['NYSE'])
+    assert_nil(@t_mock.exchanges['NASD'])
+    assert_nil(@t_mock.exchanges['AMEX'])
+    assert_equal('SC', @t_mock.exchanges['NYSE'][0][0])
+    assert_equal('AC-B', @t_mock.exchanges['NYSE'][1][0])
+    assert_equal('C.A', @t_mock.exchanges['NYSE'][2][0])
+  end
+
+  def test_retrieve_with_two_exchanges_returns_a_ticker_fetcher_with_the_correct_data
+    @t_mock.retrieve('NYSE', 'NASD')
+    assert_not_nil(@t_mock.exchanges['NYSE'])
+    assert_not_nil(@t_mock.exchanges['NASD'])
+    assert_nil(@t_mock.exchanges['AMEX'])
+  end
+
+  def test_retrieve_with_all_exchanges_returns_a_ticker_fetcher_with_the_correct_data
+    @t_mock.retrieve
+    assert_not_nil(@t_mock.exchanges['NYSE'])
+    assert_not_nil(@t_mock.exchanges['NASD'])
+    assert_not_nil(@t_mock.exchanges['AMEX'])
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: ticker_fetcher
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt White
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :development
+  version_requirements: *id002
+description: Retrieves tickers, names, and SEC descriptions for all securities listed on the 3 major US exchanges (NYSE, NASDAQ, AMEX).
+email: mattw922@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ticker_fetcher.rb
+- test/amex_test_data.csv
+- test/helper.rb
+- test/nasd_test_data.csv
+- test/nyse_test_data.csv
+- test/test_ticker_fetcher.rb
+has_rdoc: true
+homepage: http://github.com/whitethunder/ticker_fetcher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Fetches all tickers for NYSE, NASDAQ, and AMEX exchanges.
+test_files: 
+- test/test_ticker_fetcher.rb
+- test/helper.rb