nas-yahoo_stock 1.0.3 → 1.0.4

data/History.txt

@@ -64,4 +64,13 @@ Major changes in the public API. Check the README.rdoc file and individual class
 
 * 2 changes:
   * changes README file to add reference for gemcutter
-  * changes gemspec to use nas-yahoo_stock
+  * 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

data/Manifest.txt

@@ -12,6 +12,7 @@ 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
@@ -25,5 +26,12 @@ 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

@@ -8,13 +8,11 @@ Provides an interface to yahoo finance to get stock related data. For instance,
 
 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, example is given below in the USAGE section.
+YahooStock::Quote object and passing valid_parameters message to the quote object, example is given below in the USAGE section.
 
 
 == INSTALL:
 
-	gem sources -a http://gems.github.com
-
 	gem sources -a http://gemcutter.org
 
 	sudo gem install nas-yahoo_stock
@@ -62,6 +60,10 @@ quote.results
 	
 	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')
@@ -82,6 +84,10 @@ symbol.results
 	
 	symbol.results(:to_hash).output
 	
+	to return xml, use:
+	
+	quote.results(:to_xml).output
+	
 	to store results in a file, use:
 	
 	symbol.results.store('filename')
@@ -108,6 +114,10 @@ symbols.store('filename')
 	
 	to return a hash, use:
 	
+	to return xml, use:
+	
+	quote.results(:to_xml).output
+	
 	history.results(:to_hash).output
 	
 	to store results in a file, use:

data/features/history.feature

@@ -0,0 +1,23 @@
+Feature: Find historical stock data for a stock
+	As a user
+	I want to find historical data for a stock
+	So that I can use the historical data
+	Scenario: Get historical data
+		Given I do not have any historical data for the symbol "msft"
+		When I get historical data for "msft"
+		Then I should be able to get history results as a comma separated values in a string
+	
+	Scenario: Get results in array format
+		Given I have the history results for the symbol "yhoo"
+		When I want to get the history results in array format
+		Then I should get an array of history values
+	
+	Scenario: Get results in hash format
+		Given I have the history results for the symbol "yhoo"
+		When I want to get the history results in hash format
+		Then I should get an array of hash key values for history
+	
+	Scenario: Get results in xml format
+		Given I have the history results for the symbol "yhoo"
+		When I want to get the history results in xml format
+		Then I should be able to get history result as xml

data/features/quotes.feature

@@ -0,0 +1,23 @@
+Feature: Get quotes for a stock
+	As a user
+	I want to get the stock quotes
+	So that I can use them in different formats
+	Scenario: Get stock quotes
+		Given I do not have any quote results
+		When I want to get the quotes for the symbol "yhoo"
+		Then I should be able to get results as a comma separated values in a string
+	
+	Scenario: Get results in array format
+		Given I have the results for the symbol "yhoo"
+		When I want to get the results in array format
+		Then I should get an array of values
+	
+	Scenario: Get results in hash format
+		Given I have the results for the symbol "yhoo"
+		When I want to get the results in hash format
+		Then I should get an array of hash key values
+	
+	Scenario: Get results in xml format
+		Given I have the results for the symbol "yhoo"
+		When I want to get the results in xml format
+		Then I should be able to get result as xml

data/features/script_symbol.feature

@@ -0,0 +1,23 @@
+Feature: Find Script Symbols
+	As a user
+	I want to find the script symbols for a company
+	So that I can use in other classes
+	Scenario: Find Scrip Symbols
+		Given I know the name of the company "Yahoo"
+		When I try to find the scrip symbols for "Yahoo"
+		Then I should be able to get scrip symbol results as a comma separated values in a string
+		
+	Scenario: Get symbol results in array format
+		Given I have the scrip symbol results for the symbol "yhoo"
+		When I want to get the scrip symbol results in array format
+		Then I should get an array of values for scrip symbol
+
+	Scenario: Get symbol results in hash format
+		Given I have the scrip symbol results for the symbol "yhoo"
+		When I want to get the scrip symbol results in hash format
+		Then I should get an array of hash key values for scrip symbol
+
+	Scenario: Get symbol results in xml format
+		Given I have the scrip symbol results for the symbol "yhoo"
+		When I want to get the scrip symbol results in xml format
+		Then I should be able to get scrip symbol result as xml

data/features/step_definitions/history_steps.rb

@@ -0,0 +1,44 @@
+Given /^I do not have any historical data for the symbol "([^\"]*)"$/ do |scrip_symbol|
+  @history = nil
+end
+
+When /^I get historical data for "([^\"]*)"$/ do |arg1|
+  @history = YahooStock::History.new(:stock_symbol => 'msft', 
+                                     :start_date => Date.today-10, 
+                                     :end_date => Date.today-2)
+  @results = @history.results
+end
+
+Then /^I should be able to get history results as a comma separated values in a string$/ do
+  @results.output.should =~ /.*,.*/
+end
+
+Given /^I have the history results for the symbol "([^\"]*)"$/ do |stock_symbol|
+  @history_format = YahooStock::History.new(:stock_symbol => stock_symbol,
+                                            :start_date => Date.today-4, 
+                                            :end_date => Date.today-2)
+end
+
+When /^I want to get the history results in array format$/ do
+  @array_output = @history_format.results(:to_array).output
+end
+
+Then /^I should get an array of history values$/ do
+  @array_output.should_not be_empty
+end
+
+When /^I want to get the history results in hash format$/ do
+  @hash_output = @history_format.results(:to_hash).output
+end
+
+Then /^I should get an array of hash key values for history$/ do
+  @hash_output.first.keys.should_not be_nil
+end
+
+When /^I want to get the history results in xml format$/ do
+  @xml_output = @history_format.results(:to_xml).output
+end
+
+Then /^I should be able to get history result as xml$/ do
+  @xml_output.should =~ /^\<xml*/
+end

data/features/step_definitions/quotes_steps.rb

@@ -0,0 +1,45 @@
+Given /^I do not have any quote results$/ do
+  @quote = nil
+end
+
+When /^I want to get the quotes for the symbol "([^\"]*)"$/ do |stock_symbol|
+  @quote = YahooStock::Quote.new(:stock_symbols => stock_symbol)
+  @results = @quote.results
+end
+
+Then /^I should be able to get results as a comma separated values in a string$/ do
+  @results.output.should =~ /.*,.*/
+end
+
+Given /^I have the results for the symbol "([^\"]*)"$/ do |stock_symbol|
+  @quote_format = YahooStock::Quote.new(:stock_symbols => stock_symbol)
+end
+
+When /^I want to get the results in array format$/ do
+  @array_output = @quote_format.results(:to_array).output
+end
+
+Then /^I should get an array of values$/ do
+  @array_output.should_not be_empty
+end
+
+Then /^by default there should only be two values$/ do
+  @array_output.size.should eql(2)
+end
+
+When /^I want to get the results in hash format$/ do
+  @hash_output = @quote_format.results(:to_hash).output
+end
+
+Then /^I should get an array of hash key values$/ do
+  @hash_output.first.keys.should include(:last_trade_price_only, :last_trade_date)
+end
+
+When /^I want to get the results in xml format$/ do
+  @xml_output = @quote_format.results(:to_xml).output
+end
+
+Then /^I should be able to get result as xml$/ do
+  @xml_output.should =~ /^\<xml*/
+end
+

data/features/step_definitions/script_symbol_steps.rb

@@ -0,0 +1,40 @@
+Given /^I know the name of the company "([^\"]*)"$/ do |company_name|
+  @company_name = company_name
+end
+
+When /^I try to find the scrip symbols for "([^\"]*)"$/ do |company_name|
+  @symbol = YahooStock::ScripSymbol.new(company_name)
+end
+
+Then /^I should be able to get scrip symbol results as a comma separated values in a string$/ do
+  @symbol.results.output.should =~ /.*,.*/
+end
+
+Given /^I have the scrip symbol results for the symbol "([^\"]*)"$/ do |company|
+  @symbol_format = YahooStock::ScripSymbol.new(company)
+  @results = @symbol_format.results
+end
+
+When /^I want to get the scrip symbol results in array format$/ do
+  @array_output = @symbol_format.results(:to_array).output
+end
+
+Then /^I should get an array of values for scrip symbol$/ do
+  @array_output.should_not be_empty
+end
+
+When /^I want to get the scrip symbol results in hash format$/ do
+  @hash_output = @symbol_format.results(:to_hash).output
+end
+
+Then /^I should get an array of hash key values for scrip symbol$/ do
+   @hash_output.first.keys.should_not be_nil
+end
+
+When /^I want to get the scrip symbol results in xml format$/ do
+  @xml_output = @symbol_format.results(:to_xml).output
+end
+
+Then /^I should be able to get scrip symbol result as xml$/ do
+  @xml_output.should =~ /^\<xml*/
+end

data/lib/yahoo_stock/result/xml_format.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'builder'
+
+module YahooStock
+  # == DESCRIPTION:
+  # Convert results to xml
+  # 
+  # == USAGE
+  # YahooStock::Result::XmlFormat.new("data as string"){[:keys => :values]}.output
+  #
+  # Mostly will be used as a separate strategy for formatting results  to xml
+  
+  class Result::XmlFormat < Result
+    def initialize(data, &block)
+      @hash_format = YahooStock::Result::HashFormat.new(data){yield}
+      @data = @hash_format.output
+      super(self)
+    end
+    
+    def output
+      builder = Builder::XmlMarkup.new(:indent=>2)
+      builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      builder.items do |items|
+        @data.each do |data|
+          builder.item do |b|
+            data.each_pair do |key, value|
+              next if key.nil?
+              eval("b.#{key}(value)")
+            end
+          end
+        end
+      end
+      builder
+    end
+  end
+  
+end

data/lib/yahoo_stock.rb

@@ -13,6 +13,7 @@ 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.3'

data/spec/yahoo_stock/result/hash_format_spec.rb

@@ -40,18 +40,6 @@ describe YahooStock::Result::HashFormat do
     end
   end
   
-  def output
-    data = []
-    @data.each do |datum|
-      row_values = {}
-      datum.each_with_index do |item, i|
-        row_values[keys[i]] = item
-      end
-      data << row_values
-    end
-    data
-  end
-  
   describe "keys" do
     it "should replace white space characters to underscore in the keys" do
       hash_format = YahooStock::Result::HashFormat.new(@data){['ke y 1', 'k e y 2']}

data/spec/yahoo_stock/result/xml_format_spec.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe YahooStock::Result::XmlFormat do
+  before(:each) do
+    @data = "26.71,65620100,MSFT"
+    @attributes = "price,volume,symbol"
+  end
+  
+  describe ".new" do
+    before(:each) do
+      @hashed_format = stub('YahooStock::Result::HashFormat')
+      YahooStock::Result::HashFormat.stub!(:new).and_return(@hashed_format)
+    end
+    
+    it "should create the new hash object" do
+      @hashed_format.stub!(:output)
+      YahooStock::Result::HashFormat.should_receive(:new).with(@data){ @attributes }.and_return(@hashed_format)
+      YahooStock::Result::XmlFormat.new(@data){@attributes}
+    end
+    
+    it "should get the output of the hashed format" do
+      @hashed_format.should_receive(:output)
+      YahooStock::Result::XmlFormat.new(@data){@attributes}
+    end
+  end
+  
+  describe "#output" do
+    before(:each) do
+      @builder = stub('Builder::XmlMarkup')
+      Builder::XmlMarkup.stub!(:new).and_return(@builder)
+      @xml_format = YahooStock::Result::XmlFormat.new(@data){[:last_trade_price_only, :volume, :last_trade_date]}
+      @builder.stub!(:instruct!)
+      @builder.stub!(:items)
+      @builder.stub!(:item)
+    end
+    
+    it "should initialise the builder xml markup object" do
+      Builder::XmlMarkup.should_receive(:new).and_return(@builder)
+      @xml_format.output
+    end
+    
+    it "should create the instruct for the xml" do
+      @builder.should_receive(:instruct!)
+      @xml_format.output
+    end
+    
+    it "should create the root element called items" do
+      @builder.should_receive(:items)
+      @xml_format.output
+    end
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nas-yahoo_stock
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-04 00:00:00 +01:00
+date: 2009-10-23 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
 description: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance
 email: nas35_in@yahoo.com
 executables: []
@@ -37,6 +46,7 @@ files:
 - 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
 has_rdoc: true
 homepage: http://github.com/nas/yahoo_stock
@@ -64,7 +74,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.3.4
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Yahoo Stock is a Ruby library for extracting information about stocks from yahoo finance.
 test_files: 
 - spec/spec_helper.rb
@@ -78,4 +88,11 @@ test_files:
 - 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