stocktwits 1.0.0

data/spec/stocktwits/cryptify_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TwitterAuth::Cryptify do
+  before do
+    stub_basic!
+  end
+
+  it 'should have encrypt and decrypt methods' do
+    TwitterAuth::Cryptify.should respond_to(:encrypt)
+    TwitterAuth::Cryptify.should respond_to(:decrypt)
+  end
+
+  describe '.encrypt' do
+    it 'should return a hash with :encrypted_data and :salt keys' do
+      result = TwitterAuth::Cryptify.encrypt('some string')
+      result.should be_a(Hash)
+      result.key?(:encrypted_data).should be_true
+      result.key?(:salt).should be_true
+    end
+
+    it 'should make a call to EzCrypto::Key.encrypt_with_password' do
+      EzCrypto::Key.should_receive(:encrypt_with_password).once.and_return('gobbledygook')
+      TwitterAuth::Cryptify.encrypt('some string') 
+    end
+
+    it 'should not have the same encrypted as plaintext data' do
+      TwitterAuth::Cryptify.encrypt('some string')[:encrypted_data].should_not == 'some string'
+    end
+  end
+
+  describe '.decrypt' do
+    before do
+      @salt = TwitterAuth::Cryptify.generate_salt
+      TwitterAuth::Cryptify.stub!(:generate_salt).and_return(@salt)
+      @string = 'decrypted string'
+      @encrypted = TwitterAuth::Cryptify.encrypt(@string)
+    end
+
+    it 'should return the original string' do
+      TwitterAuth::Cryptify.decrypt(@encrypted).should == @string
+    end
+
+    it 'should raise an argument error if encrypted data is provided without a salt' do
+      lambda{TwitterAuth::Cryptify.decrypt('asodiaoie2')}.should raise_error(ArgumentError)
+    end
+
+    it 'should raise an argument error if a string or hash are not provided' do
+      lambda{TwitterAuth::Cryptify.decrypt(23)}.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/stocktwits/dispatcher/basic_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe TwitterAuth::Dispatcher::Basic do
+  before do
+    stub_basic!
+    @user = Factory.create(:twitter_basic_user, :login => 'twitterman', :password => 'test')
+  end
+
+  it 'should require a user as the initialization argument' do
+    lambda{TwitterAuth::Dispatcher::Basic.new(nil)}.should raise_error(TwitterAuth::Error, 'Dispatcher must be initialized with a User.')
+  end
+
+  it 'should store the user in an attr_accessor' do
+    TwitterAuth::Dispatcher::Basic.new(@user).user.should == @user
+  end
+
+  describe '#request' do
+    before do
+      @dispatcher = TwitterAuth::Dispatcher::Basic.new(@user)
+      FakeWeb.register_uri('https://twitter.com:443/fake.json', :string => {'fake' => true}.to_json)
+        FakeWeb.register_uri('https://twitter.com:443/fake.xml', :string => '<fake>true</fake>')
+    end
+    
+    it 'should automatically parse JSON if valid' do
+       @dispatcher.request(:get, '/fake.json').should == {'fake' => true}
+    end
+
+    it 'should return XML as a string' do
+      @dispatcher.request(:get, '/fake.xml').should == "<fake>true</fake>"
+    end
+
+    it 'should append .json to the path if no extension is provided' do
+      @dispatcher.request(:get, '/fake.json').should == @dispatcher.request(:get, '/fake')
+    end
+
+    %w(get post put delete).each do |method|
+      it "should build a #{method} class based on a :#{method} http_method" do
+        @req = "Net::HTTP::#{method.capitalize}".constantize.new('/fake.json')
+        "Net::HTTP::#{method.capitalize}".constantize.should_receive(:new).and_return(@req)
+        @dispatcher.request(method.to_sym, '/fake')
+      end
+    end
+
+    it 'should start the HTTP session' do
+      @net = TwitterAuth.net
+      TwitterAuth.stub!(:net).and_return(@net)
+      @net.should_receive(:start)
+      lambda{@dispatcher.request(:get, '/fake')}.should raise_error(NoMethodError)
+    end
+
+    it "should raise a TwitterAuth::Dispatcher::Error if response code isn't 200" do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.json', :string => {'error' => 'bad response'}.to_json, :status => ['401', 'Unauthorized'])
+      lambda{@dispatcher.request(:get, '/bad_response')}.should raise_error(TwitterAuth::Dispatcher::Error)
+    end
+
+    it 'should set the error message to the JSON message' do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.json', :string => {'error' => 'bad response'}.to_json, :status => ['403', 'Forbidden'])
+      lambda{@dispatcher.request(:get, '/bad_response')}.should raise_error(TwitterAuth::Dispatcher::Error, 'bad response')
+    end
+
+    it 'should raise a TwitterAuth::Dispatcher::Unauthorized on 401' do
+      FakeWeb.register_uri('https://twitter.com:443/unauthenticated_response.xml', :string => "<hash>\n<request>/unauthenticated_response.xml</request>\n<error>bad response</error>\n</hash>", :status => ['401', 'Unauthorized'])
+      lambda{@dispatcher.request(:get, '/unauthenticated_response.xml')}.should raise_error(TwitterAuth::Dispatcher::Unauthorized)
+    end
+
+    it 'should set the error message to the XML message' do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.xml', :string => "<hash>\n<request>/bad_response.xml</request>\n<error>bad response</error>\n</hash>", :status => ['403', 'Forbidden'])
+      lambda{@dispatcher.request(:get, '/bad_response')}.should raise_error(TwitterAuth::Dispatcher::Error, 'bad response')
+    end
+  end
+
+  %w(get post delete put).each do |method|
+    it "should have a ##{method} method that calls request(:#{method})" do
+      dispatcher = TwitterAuth::Dispatcher::Basic.new(@user)
+      if %w(get delete).include?(method)
+        dispatcher.should_receive(:request).with(method.to_sym, '/fake.json')
+      else
+        dispatcher.should_receive(:request).with(method.to_sym, '/fake.json', '')
+      end
+      dispatcher.send(method, '/fake.json')
+    end
+  end
+end

data/spec/stocktwits/dispatcher/oauth_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe TwitterAuth::Dispatcher::Oauth do
+  before do
+    stub_oauth!
+    @user = Factory.create(:twitter_oauth_user, :access_token => 'token', :access_secret => 'secret')
+  end
+
+  it 'should be a child class of OAuth::AccessToken' do
+    TwitterAuth::Dispatcher::Oauth.new(@user).should be_a(OAuth::AccessToken)
+  end
+
+  it 'should require initialization of an OauthUser' do
+    lambda{TwitterAuth::Dispatcher::Oauth.new(nil)}.should raise_error(TwitterAuth::Error, 'Dispatcher must be initialized with a User.')
+  end
+
+  it 'should store the user in an attr_accessor' do
+    TwitterAuth::Dispatcher::Oauth.new(@user).user.should == @user
+  end
+
+  it "should initialize with the user's token and secret" do
+    d = TwitterAuth::Dispatcher::Oauth.new(@user)
+    d.token.should == 'token'
+    d.secret.should == 'secret'
+  end
+
+  describe '#request' do
+    before do
+      @dispatcher = TwitterAuth::Dispatcher::Oauth.new(@user)
+      FakeWeb.register_uri(:get, 'https://twitter.com:443/fake.json', :string => {'fake' => true}.to_json)
+      FakeWeb.register_uri(:get, 'https://twitter.com:443/fake.xml', :string => "<fake>true</fake>")
+    end
+    
+    it 'should automatically parse json' do
+      result = @dispatcher.request(:get, '/fake.json')
+      result.should be_a(Hash)
+      result['fake'].should be_true
+    end
+
+    it 'should return xml as a string' do
+      @dispatcher.request(:get, '/fake.xml').should == '<fake>true</fake>'
+    end
+
+    it 'should append .json to the path if no extension is provided' do
+      @dispatcher.request(:get, '/fake').should == @dispatcher.request(:get, '/fake.json')
+    end
+
+    it "should raise a TwitterAuth::Dispatcher::Error if response code isn't 200" do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.json', :string => {'error' => 'bad response'}.to_json, :status => ['401', 'Unauthorized'])
+      lambda{@dispatcher.request(:get, '/bad_response')}.should raise_error(TwitterAuth::Dispatcher::Error)
+    end
+
+    it 'should set the error message to the JSON message' do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.json', :string => {'error' => 'bad response'}.to_json, :status => ['403', 'Forbidden'])
+      lambda{@dispatcher.request(:get, '/bad_response')}.should raise_error(TwitterAuth::Dispatcher::Error, 'bad response')
+    end
+
+    it 'should set the error message to the XML message' do
+      FakeWeb.register_uri('https://twitter.com:443/bad_response.xml', :string => "<hash>\n<request>/bad_response.xml</request>\n<error>bad response</error>\n</hash>", :status => ['403', 'Forbidden'])
+      lambda{@dispatcher.request(:get, '/bad_response.xml')}.should raise_error(TwitterAuth::Dispatcher::Error, 'bad response')
+    end
+
+    it 'should raise a TwitterAuth::Dispatcher::Unauthorized on 401' do
+      FakeWeb.register_uri('https://twitter.com:443/unauthenticated_response.xml', :string => "<hash>\n<request>/unauthenticated_response.xml</request>\n<error>bad response</error>\n</hash>", :status => ['401', 'Unauthorized'])
+      lambda{@dispatcher.request(:get, '/unauthenticated_response.xml')}.should raise_error(TwitterAuth::Dispatcher::Unauthorized)
+    end
+
+    it 'should work with verb methods' do
+      @dispatcher.get('/fake').should == @dispatcher.request(:get, '/fake')
+    end
+  end
+end

data/spec/stocktwits/dispatcher/shared_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe TwitterAuth::Dispatcher::Shared do
+  include TwitterAuth::Dispatcher::Shared
+
+  describe '#append_extension_to' do
+    it 'should leave extensions alone if they exist' do
+      append_extension_to('/fake.json').should == '/fake.json'    
+      append_extension_to('/fake.xml').should == '/fake.xml'
+    end
+
+    it 'should append .json if no extension is provided' do
+      append_extension_to('/fake').should == '/fake.json'
+      append_extension_to('/verify/fake').should == '/verify/fake.json'
+    end
+
+    it 'should leave extensions alone even with query strings' do
+      append_extension_to('/fake.json?since_id=123').should == '/fake.json?since_id=123'
+      append_extension_to('/fake.xml?since_id=123').should == '/fake.xml?since_id=123'
+    end
+
+    it 'should add an extension even with query strings' do
+      append_extension_to('/fake?since_id=123').should == '/fake.json?since_id=123'
+    end
+  end
+end

data/spec/stocktwits_spec.rb

@@ -0,0 +1,173 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Stocktwits do
+  describe '.base_url' do
+    it 'should have default to http://api.stocktwits.com' do
+      Stocktwits.stub!(:config).and_return({})
+      Stocktwits.base_url.should == 'http://api.stocktwits.com'
+    end
+
+    it 'should otherwise load from the config[base_url]' do
+      Stocktwits.stub!(:config).and_return({'base_url' => 'https://example.com'})
+      Stocktwits.base_url.should == 'https://example.com'
+    end
+
+    it 'should utilize oauth consumer settings' do
+      @config = Stocktwits.config
+      Stocktwits.stub!(:config).and_return(@config.merge('authorize_path' => '/somewhere_else'))
+      Stocktwits.consumer.authorize_path.should == '/somewhere_else'
+    end
+  end
+
+  describe ".path_prefix" do
+    it 'should be blank if the base url does not have a path' do
+      Stocktwits.stub!(:base_url).and_return("https://api.stocktwits.com:443")
+      Stocktwits.path_prefix.should == ""
+    end
+
+    it 'should return the path prefix if one exists' do
+      Stocktwits.stub!(:base_url).and_return("http://api.stocktwits.com/api/twitter")
+      Stocktwits.path_prefix.should == "/api/twitter"
+    end
+  end
+
+  describe '.api_timeout' do
+    it 'should default to 10' do
+      Stocktwits.stub!(:config).and_return({})
+      Stocktwits.api_timeout.should == 10
+    end
+
+    it 'should be settable via config' do
+      Stocktwits.stub!(:config).and_return({'api_timeout' => 15})
+      Stocktwits.api_timeout.should == 15
+    end
+  end
+
+  describe '.remember_for' do
+    it 'should default to 14' do
+      Stocktwits.stub!(:config).and_return({})
+      Stocktwits.remember_for.should == 14
+    end
+
+    it 'should be settable via config' do
+      Stocktwits.stub!(:config).and_return({'remember_for' => '7'})
+      Stocktwits.remember_for.should == 7
+    end
+  end
+
+  describe '.net' do
+    before do
+      stub_basic!
+    end
+
+    it 'should return a Net::HTTP object' do
+      Stocktwits.net.should be_a(Net::HTTP)
+    end
+
+    it 'should be SSL if the base_url is' do
+      Stocktwits.stub!(:config).and_return({'base_url' => 'http://api.stocktwits.com'})
+      Stocktwits.net.use_ssl?.should be_false
+      Stocktwits.stub!(:config).and_return({'base_url' => 'https://api.stocktwits.com'})
+      Stocktwits.net.use_ssl?.should be_true
+    end
+
+    it 'should work from the base_url' do
+      @net = Net::HTTP.new('example.com',80)
+      Net::HTTP.should_receive(:new).with('example.com',80).and_return(@net)
+      Stocktwits.stub!(:config).and_return({'base_url' => 'http://example.com'})
+      Stocktwits.net
+    end
+  end 
+
+  describe '#config' do
+    before do
+      Stocktwits.send(:instance_variable_set, :@config, nil)
+      @config_file = File.open(File.dirname(__FILE__) + '/fixtures/config/stocktwits.yml')
+      File.should_receive(:open).any_number_of_times.and_return(@config_file) 
+    end
+
+    it 'should load a hash from RAILS_ROOT/config/stocktwits.yml' do
+      Stocktwits.config.should be_a(Hash)
+    end
+
+    it 'should be able to override the RAILS_ENV' do
+      Stocktwits.config('development')['oauth_consumer_key'].should == 'devkey'
+    end
+  end
+
+  describe '#consumer' do
+    before do
+      stub_oauth!
+    end
+
+    it 'should be an OAuth Consumer' do
+      Stocktwits.consumer.should be_a(OAuth::Consumer)
+    end
+
+    it 'should use the credentials from #config' do
+      Stocktwits.consumer.key.should == 'testkey'
+      Stocktwits.consumer.secret.should == 'testsecret'
+    end
+
+    it 'should use the Stocktwits base_url' do
+      Stocktwits.stub!(:base_url).and_return('https://example.com')
+      Stocktwits.consumer.site.should == Stocktwits.base_url
+      Stocktwits.consumer.site.should == 'https://example.com'
+    end
+  end
+
+  describe '#strategy' do
+    it 'should pull and symbolize from the config' do
+      Stocktwits.stub!(:config).and_return({'strategy' => 'oauth'})
+      Stocktwits.strategy.should == Stocktwits.config['strategy'].to_sym
+    end
+    
+    it 'should raise an argument error if not oauth or basic' do
+      Stocktwits.stub!(:config).and_return({'strategy' => 'oauth'}) 
+      lambda{Stocktwits.strategy}.should_not raise_error(ArgumentError)
+
+      Stocktwits.stub!(:config).and_return({'strategy' => 'basic'}) 
+      lambda{Stocktwits.strategy}.should_not raise_error(ArgumentError)
+      
+      Stocktwits.stub!(:config).and_return({'strategy' => 'plain'}) 
+      lambda{Stocktwits.strategy}.should_not raise_error(ArgumentError)
+      
+      Stocktwits.stub!(:config).and_return({'strategy' => 'invalid_strategy'}) 
+      lambda{Stocktwits.strategy}.should raise_error(ArgumentError)
+    end
+  end
+
+  it '#oauth? should be true if strategy is :oauth' do
+    Stocktwits.stub!(:config).and_return({'strategy' => 'oauth'})
+    Stocktwits.oauth?.should be_true
+    Stocktwits.basic?.should be_false
+    Stocktwits.plain?.should be_false
+  end
+
+  it '#basic? should be true if strategy is :basic' do
+    Stocktwits.stub!(:config).and_return({'strategy' => 'basic'})
+    Stocktwits.basic?.should be_true
+    Stocktwits.oauth?.should be_false
+    Stocktwits.plain?.should be_false
+  end
+
+  
+  it '#plain? should be true if strategy is :basic' do
+    Stocktwits.stub!(:config).and_return({'strategy' => 'plain'})
+    Stocktwits.plain?.should be_true
+    Stocktwits.oauth?.should be_false
+    Stocktwits.basic?.should be_false
+  end
+  
+  describe '#encryption_key' do
+    it 'should raise a Cryptify error if none is found' do
+      Stocktwits.stub!(:config).and_return({})
+      lambda{Stocktwits.encryption_key}.should raise_error(Stocktwits::Cryptify::Error, "You must specify an encryption_key in config/stocktwits.yml")
+    end
+
+    it 'should return the config[encryption_key] value' do
+      Stocktwits.stub!(:config).and_return({'encryption_key' => 'mickeymouse'})
+      Stocktwits.encryption_key.should == 'mickeymouse'
+    end
+  end
+end

data/stocktwits.gemspec

@@ -0,0 +1,116 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stocktwits}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Elad Meidar"]
+  s.date = %q{2010-03-20}
+  s.description = %q{ Provide an OAuth, Basic HTTP authentication and plain interfaces to the StockTwits API.}
+  s.email = %q{elad@eizesus.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/sessions_controller.rb",
+     "app/models/stocktwits/basic_user.rb",
+     "app/models/stocktwits/generic_user.rb",
+     "app/models/stocktwits/oauth_user.rb",
+     "app/models/stocktwits/plain_user.rb",
+     "app/views/sessions/_login.html.erb",
+     "app/views/sessions/new.html.erb",
+     "config/routes.rb",
+     "generators/stocktwits/USAGE",
+     "generators/stocktwits/stocktwits_generator.rb",
+     "generators/stocktwits/templates/migration.rb",
+     "generators/stocktwits/templates/stocktwits.yml",
+     "generators/stocktwits/templates/user.rb",
+     "lib/stocktwits.rb",
+     "lib/stocktwits/controller_extensions.rb",
+     "lib/stocktwits/cryptify.rb",
+     "lib/stocktwits/dispatcher/basic.rb",
+     "lib/stocktwits/dispatcher/oauth.rb",
+     "lib/stocktwits/dispatcher/plain.rb",
+     "lib/stocktwits/dispatcher/shared.rb",
+     "rails/init.rb",
+     "spec/application.rb",
+     "spec/controllers/controller_extensions_spec.rb",
+     "spec/controllers/sessions_controller_spec.rb",
+     "spec/debug.log",
+     "spec/fixtures/config/twitter_auth.yml",
+     "spec/fixtures/factories.rb",
+     "spec/fixtures/fakeweb.rb",
+     "spec/fixtures/stocktwits.rb",
+     "spec/models/stocktwits/basic_user_spec.rb",
+     "spec/models/stocktwits/generic_user_spec.rb",
+     "spec/models/stocktwits/oauth_user_spec.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/stocktwits/cryptify_spec.rb",
+     "spec/stocktwits/dispatcher/basic_spec.rb",
+     "spec/stocktwits/dispatcher/oauth_spec.rb",
+     "spec/stocktwits/dispatcher/shared_spec.rb",
+     "spec/stocktwits_spec.rb",
+     "stocktwits.gemspec"
+  ]
+  s.homepage = %q{http://github.com/eladmeidar/stocktwits}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Stocktwits.com API wrapper}
+  s.test_files = [
+    "spec/application.rb",
+     "spec/controllers/controller_extensions_spec.rb",
+     "spec/controllers/sessions_controller_spec.rb",
+     "spec/fixtures/factories.rb",
+     "spec/fixtures/fakeweb.rb",
+     "spec/fixtures/stocktwits.rb",
+     "spec/models/stocktwits/basic_user_spec.rb",
+     "spec/models/stocktwits/generic_user_spec.rb",
+     "spec/models/stocktwits/oauth_user_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb",
+     "spec/stocktwits/cryptify_spec.rb",
+     "spec/stocktwits/dispatcher/basic_spec.rb",
+     "spec/stocktwits/dispatcher/oauth_spec.rb",
+     "spec/stocktwits/dispatcher/shared_spec.rb",
+     "spec/stocktwits_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<ezcrypto>, [">= 0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<ezcrypto>, [">= 0"])
+      s.add_dependency(%q<oauth>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<ezcrypto>, [">= 0"])
+    s.add_dependency(%q<oauth>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+