Nas-yahoo_stock_kalus 1.0.7

data/History.txt

@@ -0,0 +1,94 @@
+=== 0.1.1 2009-08-31
+
+* 1 major enhancement:
+  * Initial release
+
+=== 0.1.2 2009-09-01
+
+* 1 minor change:
+  * changed method name YahooStock::Quote#get_data to get
+
+=== 0.1.3 2009-09-05
+
+* 3 additions:
+  * adds a new class called YahooStock::ScripSymbol that allows to 
+    find out the stock symbol for a company
+  * adds specs for previous and new code
+  * adds 
+
+=== 0.1.4 2009-09-05
+
+* 2 changes related with ruby 1.9:
+  * modifies quote class to be compatible with ruby 1.9
+  * modifies interface class to be compatible with 1.9
+
+=== 0.1.5 2009-09-06
+
+* 1 changes related with ruby 1.9:
+  * modifies ScripSymbol class to be compatible with ruby 1.9
+
+=== 0.1.6 2009-09-07
+
+* 1 addition:
+  * adds convenience methods Quote#realtime, standard and extended to 
+    fetch relevant stock values
+
+=== 1.0.1 2009-09-10
+
+* 1 addition:
+  * adds feature to retrieve historical stock data
+
+=== 1.0.2 2009-10-04
+Major changes in the public API. Check the README.rdoc file and individual classes for more information
+
+* 8 addition:
+  * adds YahooStock::Interface::History
+  * adds YahooStock::Interface::Quote
+  * adds YahooStock::Interface::ScripSymbol
+  * adds YahooStock::Result as a superclass for all formatter classes
+  * adds array format, Result::ArrayFormat, to generate results as an array
+  * adds hash format, Result::ArrayFormat, to generate results as key value pairs
+  * adds base class as parent for public facing classes
+  * adds observers to check when it is required to send request to yahoo again to get fresh data
+
+* 7 changes:
+  * changes YahooStock::Interface to be the main interface class. Other interface classes will inherit from this
+  * changes YahooStock::ScripSymbol to use YahooStock::Interface::ScripSymbol
+  * removes all history interface logic from YahooStock::History and uses YahooStock::Interface::History
+  * changes YahooStock::Quote, YahooStock::History, YahooStock::ScripSymbol to extend from YahooStock::Base
+  * sorts url parameters before sending request to yahoo
+  * YahooInterface::Quote#realtime, extended, and standard methods should return self to allow calling different format output method calls
+  * do not discard any empty values when finding scrip symbol options for a company as this interferes with different format options
+
+=== 1.0.3 2009-10-04
+
+* 2 changes:
+  * changes README file to add reference for gemcutter
+  * changes gemspec to use nas-yahoo_stock
+
+=== 1.0.4 2009-10-23
+
+* 2 addition:
+	* adds support for xml format
+	* adds cucumber features
+	
+* 1 changes:
+  * changes README file to remove git source add for github
+
+=== 1.0.5 2010-05-07
+
+* 1 change:
+  * made the case statement in YahooStock::Interface::History on line 86 ruby 1.9.1 compatible
+
+=== 1.0.6 2010-11-13
+
+* 2 addition:
+  * adds dividend query option by Ryan Sandridge
+  * adds cucumber rake task
+
+* 1 changes:
+  * Make sure all tests are run with rspec 2.1.0
+
+=== 1.0.7 2010-11-14
+
+* Some refactoring after the addition of dividend option to the history

data/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/yahoo_stock/base.rb
+lib/yahoo_stock/history.rb
+lib/yahoo_stock/interface.rb
+lib/yahoo_stock/interface/history.rb
+lib/yahoo_stock/interface/quote.rb
+lib/yahoo_stock/interface/scrip_symbol.rb
+lib/yahoo_stock/quote.rb
+lib/yahoo_stock/result.rb
+lib/yahoo_stock/result/array_format.rb
+lib/yahoo_stock/result/hash_format.rb
+lib/yahoo_stock/result/xml_format.rb
+lib/yahoo_stock/scrip_symbol.rb
+lib/yahoo_stock.rb
+spec/spec_helper.rb
+spec/yahoo_stock/base_spec.rb
+spec/yahoo_stock/interface_spec.rb
+spec/yahoo_stock/interface/history_spec.rb
+spec/yahoo_stock/interface/quote_spec.rb
+spec/yahoo_stock/interface/scrip_symbol_spec.rb
+spec/yahoo_stock/quote_spec.rb
+spec/yahoo_stock/history_spec.rb
+spec/yahoo_stock/result_spec.rb
+spec/yahoo_stock/result/array_format_spec.rb
+spec/yahoo_stock/result/hash_format_spec.rb
+spec/yahoo_stock/result/xml_format_spec.rb
+spec/yahoo_stock/scrip_symbol_spec.rb
+features/history.feature
+features/quotes.feature
+features/script_symbol.feature
+features/step_definitions/history_steps.rb
+features/step_definitions/quotes_steps.rb
+features/step_definitions/script_symbol_steps.rb
+

data/README.rdoc

@@ -0,0 +1,143 @@
+= yahoo_stock
+
+	* http://github.com/nas/yahoo_stock
+
+== DESCRIPTION:
+
+Provides an interface to yahoo finance to get stock related data. For instance, latest trade related data, volume, 50 day moving average, market cap, etc, virtually any thing that yahoo finance provides.
+
+If you don't know the stock / scrip symbol of the company then you can find that out by using the YahooStock::ScripSymbol class. The methods are mentioned in the Usage section below. For instance, YHOO for yahoo, GOOG for google, etc.
+The kind of parameters to be passed can be found after initializing the
+YahooStock::Quote object and passing valid_parameters message to the quote object, example is given below in the USAGE section.
+
+For details : http://nasir.wordpress.com/2009/10/28/ruby-gem-for-finance-data
+
+
+== INSTALL:
+
+	gem sources -a http://gemcutter.org
+
+	sudo gem install nas-yahoo_stock
+
+
+== USAGE:
+
+	require 'rubygems'
+	require 'yahoo_stock'
+
+* Initialize quote object:
+
+	quote = YahooStock::Quote.new(:stock_symbols => ['YHOO', 'GOOG'])
+
+* To view the valid parameters that can be passed:
+
+	quote.valid_parameters
+
+* To view the current parameters used:
+
+	quote.current_parameters
+
+* To view the current stock symbols used:
+
+	quote.current_symbols
+
+* To add more stocks to the list:
+
+	quote.add_symbols('MSFT', 'AAPL')
+
+* To remove stocks from list:
+
+	quote.remove_symbols('MSFT', 'AAPL')
+
+* To find data for all stocks, this will give a string containing all values:
+
+	quote.results.output
+
+* To return an array instead of a string use:
+
+	quote.results(:to_array).output
+
+* To return a hash, use:
+
+	quote.results(:to_hash).output
+
+* To return xml, use:
+
+	quote.results(:to_xml).output
+
+* to store results in a file, use:
+
+	quote.results.store('filename')
+
+* To find out the stock symbol for a company:
+
+	symbol = YahooStock::ScripSymbol.new('Yahoo')
+
+* To find all symbols for that company, this will give a string containing all values:
+
+	symbol.results.output
+
+* Similarly to YahooStock::Quote, results can be converted to an array, a hash, xml, or stored in a file:
+
+	symbol.results(:to_array).output
+	symbol.results(:to_hash).output
+	symbol.results(:to_xml).output
+	symbol.results.store('filename')
+
+* To find symbols for multiple companies:
+
+	symbols = YahooStock::ScripSymbol.results('Yahoo', 'Company1', 'Company3')
+
+* To find historical data for a stock:
+
+	history = YahooStock::History.new(:stock_symbol => 'yhoo', :start_date => Date.today-20, :end_date => Date.today-2)
+
+* As with regular quotes and symbol lookups, the results can be returned in various formats:
+
+	history.results.output
+	history.results(:to_array).output
+	history.results(:to_hash).output
+	history.results(:to_xml).output
+	history.results.store('filename')
+
+==Docs
+
+http://rdoc.info/projects/nas/yahoo_stock
+
+== TESTS:
+
+To run all tests 'rspec spec' from the root directory. It requires rspec >= 2.1.0
+
+To run cucumber features "rake cucumber". It requires cucumber >= 0.9.4
+
+Cucumber Test html output is logged in log/features.html
+
+==Thanks
+
+* Thanks to {Ryan Sandridge}[http://github.com/dissolved] for adding the dividend query option.
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nasir Jamal
+
+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,12 @@
+require 'rubygems'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+desc 'Run Cucumber features and generate an HTML summary'
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = ["--no-color",
+                     "--format html -o log/features.html",
+                     "--format progress"]
+end
+

data/lib/yahoo_stock.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'date'
+require 'yahoo_stock/base.rb'
+require 'yahoo_stock/interface.rb'
+require 'yahoo_stock/history.rb'
+require 'yahoo_stock/scrip_symbol.rb'
+require 'yahoo_stock/quote.rb' 
+require 'yahoo_stock/interface/quote.rb'
+require 'yahoo_stock/interface/history.rb'
+require 'yahoo_stock/interface/scrip_symbol.rb'
+require 'yahoo_stock/result.rb'
+require 'yahoo_stock/result/array_format.rb'
+require 'yahoo_stock/result/hash_format.rb'
+require 'yahoo_stock/result/xml_format.rb'
+
+module YahooStock
+  VERSION = '1.0.8'
+end

data/lib/yahoo_stock/base.rb

@@ -0,0 +1,42 @@
+# YahooStock::Base class to find and output results.
+module YahooStock
+  
+  class Base
+    
+    def initialize(interface)
+      @interface = interface
+    end
+    
+    # Uses the values method of the interface used to show results .
+    def find
+      @interface.values
+    end
+
+    def symbols
+      @interface.stock_symbols
+    end
+    
+    # Method takes one parameter type or a block
+    # type uses the existing format classes namespaced in Result::ClassName.output
+    # e.g. * results :to_array
+    #      * results {YourSpecialFormat.method_name}
+    # to store
+    def results(type=nil, &block)
+      if block_given?
+        yield
+      else
+        return YahooStock::Result.new(find) if !type || type.to_s.empty?
+        format_type = type.to_s.sub(/^to_/,'').strip
+        return YahooStock::Result.const_get("#{format_type.capitalize}Format").new(find){data_attributes} unless format_type == "hash"
+        return YahooStock::Result.const_get("#{format_type.capitalize}Format").new(find, symbols){data_attributes}
+      end
+    end
+    
+    # Abstract method
+    def data_attributes
+      raise 'Abstract method called. Use the subclass data_attributes method'
+    end
+    
+  end
+  
+end

data/lib/yahoo_stock/history.rb

@@ -0,0 +1,32 @@
+module YahooStock
+  class History < Base
+    
+    class HistoryError < RuntimeError; end
+    
+    def initialize(options)
+      unless options.is_a?(Hash)
+        raise HistoryError, 'A hash of start_date, end_date and stock_symbol is expected as parameters'
+      end
+      @interface = YahooStock::Interface::History.new(options)
+    end
+    
+    def find
+      @find_values = super()
+      @find_values.sub(/Date.*\s/,'') if @find_values
+    end
+    
+    def values_with_header
+      @interface.values
+    end
+    
+    def data_attributes
+      return unless values_with_header
+      data_attributes = /Date.*\s/.match(values_with_header)
+      unless data_attributes.nil?
+        @data_attributes = data_attributes[0].sub(/\s*$/,'').split(',')
+        @data_attributes.map &:strip
+      end
+    end
+    
+  end
+end

data/lib/yahoo_stock/interface.rb

@@ -0,0 +1,71 @@
+=begin
+  Main class to interface with Yahoo
+=end
+
+require 'net/http'
+require 'observer'
+module YahooStock
+   # ==DESCRIPTION:
+   # 
+   # Class to generate the right url and interface with yahoo
+   #
+  class Interface
+    include Observable
+    class InterfaceError < RuntimeError ; end
+
+    BASE_URLS = {
+      :quote        => "http://download.finance.yahoo.com/d/quotes.csv",
+      :history      => "http://ichart.finance.yahoo.com/table.csv",
+      :scrip_symbol => "http://finance.yahoo.com/lookup/all"
+    } unless defined?(BASE_URLS)
+    
+    attr_accessor :base_url, :uri_parameters
+    
+    # Send request to the uri and get results
+    def get
+      begin
+        response = Net::HTTP.get_response(URI.parse(uri))
+      rescue => e
+        raise InterfaceError, "#{e.message}\n\n#{e.backtrace}"
+      end
+      response.code == '200' ? response.body : response_error(response)
+    end
+    
+    # Generates full url to connect to yahoo
+    def uri
+      raise InterfaceError, 'Base url is require to generate full uri.' unless @base_url
+      return @base_url if @uri_parameters.nil? || @uri_parameters.empty?
+      params_with_values = []
+      @uri_parameters.each {|k,v| params_with_values << "#{k}=#{v}"}
+      @base_url+'?'+params_with_values.join('&')
+    end
+    
+    # Get result string
+    def values
+      @values ||= get
+    end
+    
+    def update
+      @values = nil
+    end
+    
+    private 
+    
+    # Generate error for debugging when something goes wrong while sending
+    # request to yahoo
+    def response_error(response)
+      trace = "Response \n\nbody : #{response.body}\n\ncode: #{response.code}\n\nmessage: #{response.message}"
+      case @base_url
+        when BASE_URLS[:quote]
+          raise InterfaceError, "Error :: Could not get stock data \n\n#{trace}"
+        when BASE_URLS[:history]
+          raise InterfaceError, "Error :: Could not get historical data \n\n#{trace}"
+        when BASE_URLS[:scrip_symbol]
+          raise InterfaceError, "Error :: Could not get stock symbol \n\n#{trace}"
+        else
+          raise InterfaceError, "Error connecting to #{@base_url} \n\n#{trace}"
+      end
+    end
+    
+  end
+end