nas-yahoo_stock 1.0.1 → 1.0.2

data/spec/yahoo_stock/interface_spec.rb

@@ -3,265 +3,102 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe YahooStock::Interface do
   
   before(:each) do
-    @interface = YahooStock::Interface.new(:stock_symbols => ['MSFT'], :read_parameters => [:last_trade_price_only])
+    @interface = YahooStock::Interface.new
+    @interface.base_url = 'http://download.finance.yaaaaahoo.com/d/quotes.csv'
   end
-  
-  describe ".new" do
-    
-    it "should raise InterfaceError when stock params hash is nil" do
-      lambda { YahooStock::Interface.new(nil)
-       }.should raise_error(YahooStock::Interface::InterfaceError, 'You must pass a hash of stock symbols and the data you would like to see')
-    end
-    
-    it "should raise ArgumentError when no parameter is passed" do
-      lambda { YahooStock::Interface.new }.should raise_error(ArgumentError)  
-    end
-    
-    it "should raise InterfaceError when stock symbols hash is nil" do
-      lambda { YahooStock::Interface.new(:stock_symbols => nil) }.should raise_error(YahooStock::Interface::InterfaceError, 'No stocks passed')
-    end
-    
-    it "should raise InterfaceError when stock symbols parameter hash is an array of zero elements" do
-      lambda { YahooStock::Interface.new(:stock_symbols => []) }.should raise_error(YahooStock::Interface::InterfaceError, 'No stocks passed')
-    end
-    
-    it "should raise InterfaceError when read parameters hash is nil" do
-      lambda { YahooStock::Interface.new(:stock_symbols => 'sym', :read_parameters => nil) }.should raise_error(YahooStock::Interface::InterfaceError,'Dont know what data to get')
-    end
-    
-    it "should raise InterfaceError when read parameters hash is a zero element array" do
-      lambda { YahooStock::Interface.new(:stock_symbols => 'sym', :read_parameters => []) }.should raise_error(YahooStock::Interface::InterfaceError,'Dont know what data to get')
-    end
-    
-    it "should assign appropriate values to the stock symbols accessor" do
-      interface = YahooStock::Interface.new(:stock_symbols => ['sym'], :read_parameters => ['param1'])
-      interface.stock_symbols.should eql(['sym'])
-    end
-    
-    it "should assign appropriate values to the yahoo url parameters accessor" do
-      interface = YahooStock::Interface.new(:stock_symbols => ['sym'], :read_parameters => ['param1'])
-      interface.yahoo_url_parameters.should eql(['param1'])
-    end
-    
-  end
-  
-  describe "full_url" do
-    
-    it "should raise InterfaceError if the passed parameter is not present in the parameter list" do
-      interface = YahooStock::Interface.new(:stock_symbols => ['sym'], :read_parameters => [:param1, :param2])
-      lambda { interface.full_url }.should raise_error(YahooStock::Interface::InterfaceError, "The parameters 'param1, param2' are not valid. Please check using YahooStock::Interface#allowed_parameters or YahooStock::Quote#valid_parameters")
-    end
-    
-    it "should not raise any error if parameters passed are correct" do
-      lambda { @interface.full_url }.should_not raise_error
-    end
-    
-    it "should raise error if stock symbols accessor is cleared and empty" do
-      @interface.stock_symbols.clear
-      lambda { @interface.full_url }.should raise_error(YahooStock::Interface::InterfaceError, "You must add atleast one stock symbol to get stock data")
-    end
-    
-    it "should raise error if url parameters are cleared and empty" do
-      @interface.yahoo_url_parameters.clear
-      lambda { @interface.full_url }.should raise_error(YahooStock::Interface::InterfaceError, "You must add atleast one parameter to get stock data")
-    end
-    
-    it "should create the full url with one symbol and one parameter" do
-      @interface.full_url.should eql("http://download.finance.yahoo.com/d/quotes.csv?s=MSFT&f=l1")
-    end
-    
-    it "should create the full url with 3 symbols and 3 parameters" do
-      @interface.add_symbols 'AAP', 'GOOG'
-      @interface.add_parameters :change_from_200_day_moving_average, :percent_change_from_200_day_moving_average
-      @interface.full_url.should eql("http://download.finance.yahoo.com/d/quotes.csv?s=MSFT+AAP+GOOG&f=l1m5m6")
-    end
-    
-  end
-  
-  describe "get_values" do
-    
-    it "should call the class method get of HTTP class" do
-      Net::HTTP.should_receive(:get).and_return('some string')
-      @interface.get_values
-    end
-    
-    it "should parse the URI" do
-      Net::HTTP.stub!(:get).and_return('some string')
-      URI.should_receive(:parse)
-      @interface.get_values
-    end
-    
-    it "should generate the full url by combining the stock symbols and other parameters" do
-      Net::HTTP.stub!(:get).and_return('some string')
-      @interface.should_receive(:full_url).and_return('http://localhost')
-      @interface.get_values
+  describe "uri" do
+    it "should return base url when uri_parameters is empty" do
+      @interface.uri.should eql('http://download.finance.yaaaaahoo.com/d/quotes.csv')
     end
     
-  end
-  
-  describe "remove_parameters" do
-    
-    it "should remove the parameters if they are present" do
-      params = [:test1, :test2, :test3]
-      @interface.stub!(:yahoo_url_parameters).and_return(params)
-      @interface.remove_parameters(:test1, :test2)
-      @interface.yahoo_url_parameters.should eql([:test3])
-    end
-    
-    it "should raise an error when removing a parameter that is not present" do
-      lambda { @interface.remove_parameters(:test1) }.should raise_error(YahooStock::Interface::InterfaceError, "Parameter test1 is not present in current list")
-    end
-  end
-  
-  describe "add_parameters" do
-    
-    it "should raise an error when the parameter is not a valid parameter" do
-      lambda { @interface.add_parameters('test1') }.should raise_error(YahooStock::Interface::InterfaceError, "Interface parameter test1 is not a valid parameter.")
-    end
-    
-    it "should add the parameter if its a valid parameter" do
-      params = [:test1, :test2, :test3]
-      @interface.stub!(:allowed_parameters).and_return(params)
-      @interface.add_parameters(:test1, :test2)
-      @interface.yahoo_url_parameters.should include(:test1, :test2)
+    it "should raise error when base url is not present" do
+      @interface.base_url = nil
+      lambda { @interface.uri }.should raise_error(YahooStock::Interface::InterfaceError, 
+                                                   'Base url is require to generate full uri.')
     end
     
-    it "should not add the parameter more than once in the parameter list and silently ignore it" do
-      params = [:test1, :test2, :test3]
-      @interface.stub!(:allowed_parameters).and_return(params)
-      @interface.add_parameters(:test1, :test2)
-      @interface.yahoo_url_parameters.should include(:test1, :test2)
-      @interface.yahoo_url_parameters.size.should eql(3)
-      @interface.add_parameters(:test1, :test2)
-      @interface.yahoo_url_parameters.should include(:test1, :test2)
-      @interface.yahoo_url_parameters.size.should eql(3)
+    it "should generate full url with all paramenters" do
+      @interface.uri_parameters = {:s => 'boom', :f => 'toom', :k => 'zoom'}
+      @interface.uri.should =~ /http:\/\/download.finance.yaaaaahoo.com\/d\/quotes.csv?/
+      @interface.uri.should =~ /s=boom/
+      @interface.uri.should =~ /f=toom/
+      @interface.uri.should =~ /k=zoom/
     end
   end
   
-  describe "remove_symbols" do
-    
-    it "should remove the symbols if they are present" do
-      symbols = ['test1', 'test2', 'test3']
-      @interface.stub!(:stock_symbols).and_return(symbols)
-      @interface.remove_symbols('test1', 'test2')
-      @interface.stock_symbols.should eql(['test3'])
-    end
-    
-    it "should raise an error when removing a symbol that is not present" do
-      lambda { @interface.remove_symbols('test1') }.should raise_error(YahooStock::Interface::InterfaceError, "Cannot remove stock symbol test1 as it is currently not present.")
-    end
-  end
-  
-  describe "add_symbols" do
-    
-    it "should add the symbol" do
-      symbols = ['test1', 'test2', 'test3']
-      @interface.stub!(:stock_symbols).and_return(symbols)
-      @interface.add_symbols('test1', 'test2')
-      @interface.stock_symbols.should include('test1', 'test2')
-    end
-    
-    it "should not add the symbol more than once in the symbol list and silently ignore it" do
-      symbols = ['test']
-      @interface.stub!(:stock_symbols).and_return(symbols)
-      @interface.add_symbols('test1', 'test2')
-      @interface.stock_symbols.should include('test1', 'test2')
-      @interface.stock_symbols.size.should eql(3)
-      @interface.add_symbols('test1', 'test2')
-      @interface.stock_symbols.should include('test1', 'test2')
-      @interface.stock_symbols.size.should eql(3)
-    end
-  end
-  
-  describe "results" do
-    
+  describe "get" do
     before(:each) do
-      symbols = ['sym1', 'sym2', 'sym3']
-      @interface.stub!(:stock_symbols).and_return(symbols)
-      params = [:test1, :test2, :test3]
-      @interface.stub!(:yahoo_url_parameters).and_return(params)
-    end
-    
-    it "should get all values" do
-      @interface.should_receive(:get_values).and_return([])
-      @interface.results
-    end
-    
-    it "should have a hash of symbols and each parameter value" do
-      @values = ["23,787,09","43,45,65", "6,56,8"]
-      @interface.stub!(:get_values).and_return(@values)
-      @interface.results.should include({'sym1' => {:test1 => "23", :test2 => "787", :test3 => "09"}})
-      @interface.results.should include({'sym2' => {:test1 => "43", :test2 => "45", :test3 => "65"}})
-      @interface.results.should include({'sym3' => {:test1 => "6", :test2 => "56", :test3 => "8"}})
-    end
-    
-  end
-   
-  describe "allowed_parameters" do
-    
-    it "should find all parameters" do
-      @interface.should_receive(:parameters).and_return({})
-      @interface.allowed_parameters
+      @response = stub('HTTP Response')
+      @response.stub!(:code).and_return('200')
+      @response.stub!(:body)
+      URI.stub!(:parse)
+      Net::HTTP.stub!(:get_response).and_return(@response)
     end
     
-    it "should return the keys of all parameters" do
-      parameter_hash = {}
-      @interface.stub!(:parameters).and_return(parameter_hash)
-      parameter_hash.should_receive(:keys)
-      @interface.allowed_parameters
+    it "should get response for the uri" do
+      Net::HTTP.should_receive(:get_response).and_return(@response)
+      @interface.get
     end
     
-  end
-  
-  describe "add_standard_params" do
-    
-    it "should get the keys for standard parameters" do
-      YahooStock::Interface::STD_PARAMETERS.should_receive(:keys).and_return([])
-      @interface.add_standard_params
+    it "should parse the uri" do
+      URI.should_receive(:parse)
+      @interface.get
+    end
+    
+    it "should check the response code" do
+      @response.should_receive(:code)
+      @interface.get
+    end
+    
+    it "should get the body of the response if returned code is 200, ie success" do
+      @response.stub!(:code).and_return('200')
+      @response.should_receive(:body)
+      @interface.get
+    end
+    
+    describe "when response code is not 200" do
+      before(:each) do
+         @response.stub!(:code).and_return('301')
+         @response.stub!(:body).and_return('something')
+         @response.stub!(:message).and_return('eerrred')
+      end
+      
+      it "should return the response error when returned code is not 200" do
+        @interface.should_receive(:response_error)
+        @interface.get
+      end
+      
+      it "should not get the body of the response when returned code is not 200" do
+        @interface.should_receive(:response_error)
+        @response.should_not_receive(:body)
+        @interface.get
+      end
+      
+      it "should raise error when returned code is not 200" do
+        @interface.base_url = YahooStock::Interface::BASE_URLS[:quote]
+        lambda { @interface.get }.should raise_error
+      end
     end
     
-    it "should add each parameter" do
-      keys = [:a_key, :b_key]
-      YahooStock::Interface::STD_PARAMETERS.stub!(:keys).and_return(keys)
-      @interface.should_receive(:add_parameters).with(:a_key)
-      @interface.should_receive(:add_parameters).with(:b_key)
-      @interface.add_standard_params
-    end
-   
   end
   
-  describe "add_extended_params" do
-    
-    it "should get the keys for extended parameters" do
-      YahooStock::Interface::EXTENDED_PARAMETERS.should_receive(:keys).and_return([])
-      @interface.add_extended_params
+  describe "values" do
+    it "should call get to receive the values" do
+      @interface.should_receive(:get)
+      @interface.values
     end
     
-    it "should add each parameter" do
-      keys = [:a_key, :b_key]
-      YahooStock::Interface::EXTENDED_PARAMETERS.stub!(:keys).and_return(keys)
-      @interface.should_receive(:add_parameters).with(:a_key)
-      @interface.should_receive(:add_parameters).with(:b_key)
-      @interface.add_extended_params
+    it "should not call get when values are already set" do
+      @interface.stub!(:values).and_return('some string')
+      @interface.should_not_receive(:get)
+      @interface.values
     end
-   
   end
   
-  describe "add_realtime_params" do
-    
-    it "should get the keys for realtime parameters" do
-      YahooStock::Interface::REALTIME_PARAMETERS.should_receive(:keys).and_return([])
-      @interface.add_realtime_params
-    end
-    
-    it "should add each parameter" do
-      keys = [:a_key, :b_key]
-      YahooStock::Interface::REALTIME_PARAMETERS.stub!(:keys).and_return(keys)
-      @interface.should_receive(:add_parameters).with(:a_key)
-      @interface.should_receive(:add_parameters).with(:b_key)
-      @interface.add_realtime_params
+  describe "update" do
+    it "should set the values to nil" do
+      @interface.update.should be_nil
     end
-   
   end
   
 end

data/spec/yahoo_stock/quote_spec.rb

@@ -55,7 +55,7 @@ module YahooStock
       end
       
       it "should create a new instance of the Stock Interface class" do
-        YahooStock::Interface.should_receive(:new)
+        YahooStock::Interface::Quote.should_receive(:new)
         YahooStock::Quote.new(:stock_symbols => 'test')
       end
       
@@ -64,18 +64,10 @@ module YahooStock
     describe "subject" do
       
       before(:each) do
-        @interface = mock(YahooStock::Interface)
-        YahooStock::Interface.stub!(:new).and_return(@interface)
+        @interface = mock(YahooStock::Interface::Quote)
+        YahooStock::Interface::Quote.stub!(:new).and_return(@interface)
         @quote = YahooStock::Quote.new(:stock_symbols => 'MSFT')
       end
-  
-      describe "get" do
-      
-        it "should get the results from the interface" do
-          @interface.should_receive(:results)
-          @quote.get
-        end
-      end
       
       describe "add_symbols" do
         
@@ -84,11 +76,6 @@ module YahooStock
           @quote.add_symbols('new_symbol')
         end
         
-        it "should add the symbol to existing symbols by calling add symbols on interface for each sybmol" do
-          @interface.should_receive(:add_symbols).exactly(2).times
-          @quote.add_symbols('new_symbol', 'another_symbol')
-        end
-        
       end
       
       describe "remove_symbols" do
@@ -98,24 +85,12 @@ module YahooStock
           @quote.remove_symbols('remove_symbol')
         end
         
-        it "should remove the symbol from existing symbols by calling remove symbols on interface for each symbol" do
-          @interface.should_receive(:remove_symbols).exactly(2).times
-          @quote.remove_symbols('new_symbol', 'another_symbol')
-        end
-        
       end
       
       describe "clear_symbols" do
         
-        it "should get all stock symbols from the interface" do
-          @interface.should_receive(:stock_symbols).and_return([])
-          @quote.clear_symbols
-        end
-        
-        it "should remove the symbol from existing symbols by calling remove symbols on interface for each symbol" do
-          symbols = ['symbol1', 'symbol2']
-          @interface.stub!(:stock_symbols).and_return(symbols)
-          symbols.should_receive(:clear)
+        it "should remove the symbol from existing symbols by clearing symbols from interface" do
+          @interface.should_receive(:clear_symbols)
           @quote.clear_symbols
         end
         
@@ -137,11 +112,6 @@ module YahooStock
           @quote.add_parameters('param1')
         end
         
-        it "should add the parameter to existing parameters by calling add parameters on interface for each parameter" do
-          @interface.should_receive(:add_parameters).exactly(2).times
-          @quote.add_parameters('param1', 'param2')
-        end
-        
       end
       
       describe "remove_parameters" do
@@ -151,11 +121,6 @@ module YahooStock
           @quote.remove_parameters('remove_parameter')
         end
         
-        it "should remove the parameter from existing parameters by calling remove parameters on interface for each parameter" do
-          @interface.should_receive(:remove_parameters).exactly(2).times
-          @quote.remove_parameters('param1', 'param2')
-        end
-        
       end
       
       describe "valid_parameters" do
@@ -182,12 +147,6 @@ module YahooStock
           @quote.current_parameters
         end
         
-        it "should sort all received current parameters" do
-          @interface.stub!(:yahoo_url_parameters)
-          @quote.should_receive(:sort_symbols)
-          @quote.current_parameters
-        end
-        
       end
       
       describe "use_all_parameters" do
@@ -219,41 +178,39 @@ module YahooStock
       describe "clear_parameters" do
         
         it "should get all values for parameters from the interface" do
-          @interface.should_receive(:yahoo_url_parameters).and_return([])
+          @quote.stub!(:current_parameters)
+          @interface.should_receive(:clear_parameters)
           @quote.clear_parameters
         end
         
-        it "should remove the parameter from existing parameters by calling remove parameters on interface for each parameter" do
-          params = ['param1', 'param2']
-          @interface.stub!(:yahoo_url_parameters).and_return(params)
-          params.should_receive(:clear)
+        it "should get current parameters after clearing them" do
+          @interface.stub!(:clear_parameters)
+          @quote.should_receive(:current_parameters)
           @quote.clear_parameters
         end
         
+        it "clear all parameters and show an empty array when there are no yahoo url parameters" do
+          @interface.stub!(:clear_parameters)
+          @interface.stub!(:yahoo_url_parameters).and_return([])
+          @quote.clear_parameters.should eql([])
+        end
+        
       end
       
       describe "realtime" do
         
         before(:each) do
-          @quote.stub!(:get)
+          @quote.stub!(:find)
           @interface.stub!(:add_realtime_params)
         end
         
-        it "should clear all existing parameters for the existing instance" do
-          @quote.should_receive(:clear_parameters)
-          @quote.realtime
-        end
-        
         it "should add the realtime parameters" do
-          @quote.stub!(:clear_parameters)
           @interface.should_receive(:add_realtime_params)
           @quote.realtime
         end
         
-        it "should get the results" do
-          @quote.stub!(:clear_parameters)
-          @quote.should_receive(:get)
-          @quote.realtime
+        it "should return self" do
+          @quote.realtime.should eql(@quote)
         end
 
       end
@@ -261,25 +218,17 @@ module YahooStock
       describe "standard" do
         
         before(:each) do
-          @quote.stub!(:get)
+          @quote.stub!(:find)
           @interface.stub!(:add_standard_params)
         end
         
-        it "should clear all existing parameters for the existing instance" do
-          @quote.should_receive(:clear_parameters)
-          @quote.standard
-        end
-        
-        it "should add the realtime parameters" do
-          @quote.stub!(:clear_parameters)
+        it "should add the standard parameters" do
           @interface.should_receive(:add_standard_params)
           @quote.standard
         end
         
-        it "should get the results" do
-          @quote.stub!(:clear_parameters)
-          @quote.should_receive(:get)
-          @quote.standard
+        it "should return self" do
+          @quote.standard.should eql(@quote)
         end
 
       end
@@ -287,25 +236,17 @@ module YahooStock
       describe "extended" do
         
         before(:each) do
-          @quote.stub!(:get)
+          @quote.stub!(:find)
           @interface.stub!(:add_extended_params)
         end
         
-        it "should clear all existing parameters for the existing instance" do
-          @quote.should_receive(:clear_parameters)
-          @quote.extended
-        end
-        
-        it "should add the realtime parameters" do
-          @quote.stub!(:clear_parameters)
+        it "should add the extended parameters" do
           @interface.should_receive(:add_extended_params)
           @quote.extended
         end
         
-        it "should get the results" do
-          @quote.stub!(:clear_parameters)
-          @quote.should_receive(:get)
-          @quote.extended
+        it "should return self" do
+          @quote.extended.should eql(@quote)
         end
 
       end

data/spec/yahoo_stock/result/array_format_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe YahooStock::Result::ArrayFormat do
+  
+  describe "output" do
+    before(:each) do
+      @data = "asdf\"sdf,as,f\" asf s"
+      @array_format = YahooStock::Result::ArrayFormat.new(@data)
+    end
+    
+    it "should remove all double quotes from the data string" do
+      @data.should_receive(:gsub).with(/\"/,'').and_return('a string')
+      @array_format.output
+    end
+    
+    it "should create array element for each line by splitting it for the line break" do
+      string = "asdfsdf,as,f asf s"
+      @data.stub!(:gsub).and_return(string)
+      string.should_receive(:split).with(/\r\n|\n/).and_return([])
+      @array_format.output
+    end
+    
+    it "should create a sub array for each line by splitting them for each comma" do
+      string = "asdfsdf,as,f asf s"
+      @data.stub!(:gsub).and_return(string)
+      string.stub!(:split).with(/\r\n|\n/).and_return([string])
+      string.should_receive(:split).with(',').and_return([])
+      @array_format.output
+    end
+    
+    it "should return an array for each line and each line with an array of csv" do
+      string = "asdfsdf,as,f asf s\r\n23,sdf,2332,sdf"
+      @data.stub!(:gsub).and_return(string)
+      @array_format.output.should eql([['asdfsdf','as','f asf s'],['23','sdf' ,'2332', 'sdf']])
+    end
+  end
+  
+end

data/spec/yahoo_stock/result/hash_format_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe YahooStock::Result::HashFormat do
+  before(:each) do
+    @data = 'da,ta'
+    @array_format = YahooStock::Result::ArrayFormat.new(@data)
+  end
+  describe ".new" do
+    it "should initialise the Array Format class with data" do
+      YahooStock::Result::ArrayFormat.should_receive(:new).and_return(@array_format)
+      YahooStock::Result::HashFormat.new(@data){[:key1, :key2]}
+    end
+    
+    it "should get the output of the array format" do
+      YahooStock::Result::ArrayFormat.stub!(:new).and_return(@array_format)
+      @array_format.should_receive(:output)
+      YahooStock::Result::HashFormat.new(@data){[:key1, :key2]}
+    end
+    
+    it "should yield the block" do
+      hash_format = YahooStock::Result::HashFormat.new(@data){['key1', 'key2']}
+      hash_format.keys.should eql([:key1, :key2])
+    end
+  end
+  
+  
+  describe "output" do
+    it "should have the data as a hash with keys key1 and key2" do
+      hash_format = YahooStock::Result::HashFormat.new(@data){['key1', 'key2']}
+      hash_format.output.should eql([{:key1 => 'da',:key2 => 'ta'}])
+    end
+    
+    it "should have the data as an array of hashes with the same keys key1 and key2" do
+      data = "da,ta\nda,ta\r\nda,ta"
+      hash_format = YahooStock::Result::HashFormat.new(data){['key1', 'key2']}
+      hash_format.output.should eql([{:key1 => 'da',:key2 => 'ta'},
+                                     {:key1 => 'da',:key2 => 'ta'},
+                                     {:key1 => 'da',:key2 => 'ta'}
+                                    ])
+    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']}
+      hash_format.keys.should eql([:ke_y_1, :k_e_y_2])
+    end
+    
+    it "should replace upper case characters to lower case in the keys" do
+      hash_format = YahooStock::Result::HashFormat.new(@data){['Key1', 'keY2']}
+      hash_format.keys.should eql([:key1, :key2])
+    end
+  end
+  
+  
+end