stocktwits 1.0.0

data/spec/fixtures/stocktwits.rb

@@ -0,0 +1,5 @@
+require 'net/http'
+
+TWITTER_JSON = {
+  :verify_credentials => "{\"profile_image_url\":\"http:\\/\\/static.twitter.com\\/images\\/default_profile_normal.png\",\"description\":\"Saving the world for all Twitter kind.\",\"utc_offset\":null,\"favourites_count\":0,\"profile_sidebar_fill_color\":\"e0ff92\",\"screen_name\":\"twitterman\",\"statuses_count\":0,\"profile_background_tile\":false,\"profile_sidebar_border_color\":\"87bc44\",\"friends_count\":2,\"url\":null,\"name\":\"Twitter Man\",\"time_zone\":null,\"protected\":false,\"profile_background_image_url\":\"http:\\/\\/static.twitter.com\\/images\\/themes\\/theme1\\/bg.gif\",\"profile_background_color\":\"9ae4e8\",\"created_at\":\"Fri Feb 06 18:10:32 +0000 2009\",\"profile_text_color\":\"000000\",\"followers_count\":2,\"location\":null,\"id\":20256865,\"profile_link_color\":\"0000ff\"}"
+}

data/spec/models/stocktwits/basic_user_spec.rb

@@ -0,0 +1,138 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Stocktwits::BasicUser do
+  before do
+    stub_basic!
+  end
+
+  describe '#password=' do
+    before do
+      @user = Factory.build(:stocktwits_basic_user, :stocktwits_id => '123')
+    end
+
+    it 'should change the value of crypted_password' do
+      lambda{@user.password = 'newpass'}.should change(@user, :crypted_password)
+    end
+
+    it 'should change the value of salt' do
+      lambda{@user.password = 'newpass'}.should change(@user, :salt)
+    end
+
+    it 'should not store the plaintext password' do
+      @user.password = 'newpass'
+      @user.crypted_password.should_not == 'newpass'
+    end
+  end
+
+  describe '#password' do
+    before do
+      @user = Factory.build(:stocktwits_basic_user, :password => 'monkey')
+    end
+
+    it 'should return the password' do
+      @user.password.should == 'monkey'
+    end    
+
+    it 'should not be a database attribute' do
+      @user['password'].should_not == 'monkey'
+    end
+  end
+  
+  describe '.verify_credentials' do
+    before do
+      @user = Factory.create(:stocktwits_basic_user)
+    end
+
+    it 'should return a JSON hash of the user when successful' do
+      hash = User.verify_credentials('stocktwitsman','test')
+      hash.should be_a(Hash)
+      hash['screen_name'].should == 'stocktwitsman'
+      hash['name'].should == 'Twitter Man'
+    end
+
+    it 'should return false when a 401 unauthorized happens' do
+      FakeWeb.register_uri(:get, 'https://stocktwits.com:443/account/verify_credentials.json', :string => '401 "Unauthorized"', :status => ['401',' Unauthorized'])
+      User.verify_credentials('stocktwitsman','wrong').should be_false
+    end
+  end
+
+  describe '.authenticate' do
+    before do
+      @user = Factory.create(:stocktwits_basic_user, :stocktwits_id => '123')
+    end
+
+    it 'should make a call to verify_credentials' do
+      User.should_receive(:verify_credentials).with('stocktwitsman','test')
+      User.authenticate('stocktwitsman','test')
+    end
+
+    it 'should return nil if verify_credentials returns false' do
+      User.stub!(:verify_credentials).and_return(false)
+      User.authenticate('stocktwitsman','test').should be_nil
+    end
+
+    it 'should return the user if verify_credentials succeeds' do
+      User.stub!(:verify_credentials).and_return(JSON.parse("{\"profile_image_url\":\"http:\\/\\/static.stocktwits.com\\/images\\/default_profile_normal.png\",\"description\":\"Saving the world for all Twitter kind.\",\"utc_offset\":null,\"favourites_count\":0,\"profile_sidebar_fill_color\":\"e0ff92\",\"screen_name\":\"stocktwitsman\",\"statuses_count\":0,\"profile_background_tile\":false,\"profile_sidebar_border_color\":\"87bc44\",\"friends_count\":2,\"url\":null,\"name\":\"Twitter Man\",\"time_zone\":null,\"protected\":false,\"profile_background_image_url\":\"http:\\/\\/static.stocktwits.com\\/images\\/themes\\/theme1\\/bg.gif\",\"profile_background_color\":\"9ae4e8\",\"created_at\":\"Fri Feb 06 18:10:32 +0000 2009\",\"profile_text_color\":\"000000\",\"followers_count\":2,\"location\":null,\"id\":123,\"profile_link_color\":\"0000ff\"}"))
+      User.authenticate('stocktwitsman','test').should == @user
+    end
+  end
+
+  describe '.find_or_create_by_stocktwits_hash_and_password' do
+    before do
+      @user = Factory.create(:stocktwits_basic_user, :stocktwits_id => '123')
+    end
+
+    it 'should return the existing user if there is one' do
+      User.identify_or_create_from_stocktwits_hash_and_password({'id' => '123', 'screen_name' => 'stocktwitsman'},'test').should == @user
+    end
+
+    it 'should update the attributes from the hash' do
+      User.identify_or_create_from_stocktwits_hash_and_password({'id' => 123, 'screen_name' => 'stocktwitsman', 'name' => 'New Name'}, 'test').name.should == 'New Name'
+    end
+
+    it 'should update the password from the argument' do
+      User.identify_or_create_from_stocktwits_hash_and_password({'id' => '123', 'screen_name' => 'stocktwitsman', 'name' => 'New Name'}, 'test2').password.should == 'test2'
+    end
+
+    it 'should create a user if one does not exist' do
+      lambda{User.identify_or_create_from_stocktwits_hash_and_password({'id' => 124, 'screen_name' => 'dude', 'name' => "Lebowski"}, 'test')}.should change(User, :count).by(1)
+    end
+
+    it 'should assign the attributes from the hash to a created user' do
+      user = User.identify_or_create_from_stocktwits_hash_and_password({'id' => 124, 'screen_name' => 'dude', 'name' => "Lebowski"}, 'test')
+      user.stocktwits_id.should == '124'
+      user.login.should == 'dude'
+      user.name.should == 'Lebowski'
+      user.password.should == 'test'
+    end
+  end
+
+  describe '#stocktwits' do
+    before do
+      @user = Factory.create(:stocktwits_basic_user, :stocktwits_id => '123')
+    end
+
+    it 'should be an instance of Stocktwits::Dispatcher::Basic' do
+      @user.stocktwits.class.should == Stocktwits::Dispatcher::Basic
+    end
+
+    it 'should have the correct user set' do
+      @user.stocktwits.user.should == @user
+    end
+  end
+
+  describe 'changing usernames' do
+    before do
+      @user = Factory.create(:stocktwits_basic_user, :stocktwits_id => '123')
+    end
+
+    it 'should not create a new record when a screen_name has changed' do
+      lambda{User.identify_or_create_from_stocktwits_hash_and_password({'id' => '123', 'screen_name' => 'dude'},'awesome')}.should_not change(User,:count)
+    end
+
+    it 'should update the record with the new screen name' do
+      User.identify_or_create_from_stocktwits_hash_and_password({'id' => '123', 'screen_name' => 'dude'},'awesome').should == @user.reload
+      @user.login.should == 'dude'
+    end
+  end
+end

data/spec/models/stocktwits/generic_user_spec.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Stocktwits::GenericUser do
+  should_validate_presence_of :login, :stocktwits_id
+  should_validate_format_of :login, 'some_guy', 'awesome', 'cool_man'
+  should_not_validate_format_of :login, 'with-dashes', 'with.periods', 'with spaces'
+  should_validate_length_of :login, :in => 1..15
+  
+  it 'should validate uniqueness of login' do
+    Factory.create(:stocktwits_oauth_user)
+    Factory.build(:stocktwits_oauth_user).should have_at_least(1).errors_on(:login)
+  end
+
+  it 'should validate uniqueness of remember_token' do
+    Factory.create(:stocktwits_oauth_user, :remember_token => 'abc')
+    Factory.build(:stocktwits_oauth_user, :remember_token => 'abc').should have_at_least(1).errors_on(:remember_token)
+  end
+
+  it 'should allow capital letters in the username' do
+    Factory.build(:stocktwits_oauth_user, :login => 'TwitterMan').should have(:no).errors_on(:login)
+  end
+
+  it 'should not allow the same login with different capitalization' do
+    Factory.create(:stocktwits_oauth_user, :login => 'stocktwitsman')
+    Factory.build(:stocktwits_oauth_user, :login => 'TwitterMan').should have_at_least(1).errors_on(:login)
+  end
+
+  describe '.new_from_stocktwits_hash' do
+    it 'should raise an argument error if the hash does not have a screen_name attribute' do
+      lambda{User.new_from_stocktwits_hash({'id' => '123'})}.should raise_error(ArgumentError, 'Invalid hash: must include screen_name.')
+    end
+
+    it 'should raise an argument error if the hash does not have an id attribute' do
+      lambda{User.new_from_stocktwits_hash({'screen_name' => 'abc123'})}.should raise_error(ArgumentError, 'Invalid hash: must include id.')
+    end
+
+    it 'should return a user' do
+      User.new_from_stocktwits_hash({'id' => '123', 'screen_name' => 'stocktwitsman'}).should be_a(User)
+    end
+
+    it 'should assign login to the screen_name' do
+      User.new_from_stocktwits_hash({'id' => '123', 'screen_name' => 'stocktwitsman'}).login.should == 'stocktwitsman'
+    end
+
+    it 'should assign stocktwits attributes that are provided' do
+      u = User.new_from_stocktwits_hash({'id' => '4566', 'screen_name' => 'stocktwitsman', 'name' => 'Twitter Man', 'description' => 'Saving the world for all Tweet kind.'})
+      u.name.should == 'Twitter Man'
+      u.description.should == 'Saving the world for all Tweet kind.'
+    end
+  end
+
+  describe '#update_stocktwits_attributes' do
+    it 'should assign values to the user' do
+      user = Factory.create(:stocktwits_oauth_user, :name => "Dude", :description => "Awesome, man.")
+      user.update_stocktwits_attributes({'name' => 'Twitter Man', 'description' => 'Works.'})
+      user.reload
+      user.name.should == 'Twitter Man'
+      user.description.should == 'Works.'
+    end
+
+    it 'should not throw an error with extraneous info' do
+      user = Factory.create(:stocktwits_oauth_user, :name => "Dude", :description => "Awesome, man.")
+      lambda{user.update_stocktwits_attributes({'name' => 'Twitter Man', 'description' => 'Works.', 'whoopsy' => 'noworks.'})}.should_not raise_error
+    end
+  end
+
+  describe '#remember_me' do
+    before do
+      @user = Factory(:stocktwits_oauth_user)
+    end
+
+    it 'should check for the remember_token column' do
+      @user.should_receive(:respond_to?).with(:remember_token).and_return(false)
+      @user.remember_me
+    end
+
+    it 'should return nil if there is no remember_token column' do
+      @user.should_receive(:respond_to?).with(:remember_token).and_return(false)
+      @user.remember_me.should be_false
+    end
+    
+    describe ' with proper columns' do
+      it 'should generate a secure random token' do
+        ActiveSupport::SecureRandom.should_receive(:hex).with(10).and_return('abcdef')
+        @user.remember_me
+        @user.remember_token.should == 'abcdef'
+      end
+
+      it 'should set the expiration to the current time plus the remember_for period' do
+        Stocktwits.stub!(:remember_for).and_return(10)
+        time = Time.now
+        Time.stub!(:now).and_return(time)
+
+        @user.remember_me
+
+        @user.remember_token_expires_at.should == Time.now + 10.days
+      end
+
+      it 'should return a hash with a :value and :expires key' do
+        result = @user.remember_me
+        result.should be_a(Hash)
+        result.key?(:value).should be_true
+        result.key?(:expires).should be_true
+      end
+
+      it 'should return a hash with appropriate values' do
+        Stocktwits.stub!(:remember_for).and_return(10)
+        time = Time.now
+        Time.stub!(:now).and_return(time)
+        ActiveSupport::SecureRandom.stub!(:hex).and_return('abcdef')
+
+        @user.remember_me.should == {:value => 'abcdef', :expires => (Time.now + 10.days)}
+      end
+    end
+  end
+
+  describe '#forget_me' do
+    it 'should reset remember_token and remember_token_expires_at' do
+      @user = Factory(:stocktwits_oauth_user, :remember_token => "abcdef", :remember_token_expires_at => Time.now + 10.days)
+      @user.forget_me
+      @user.reload
+      @user.remember_token.should be_nil
+      @user.remember_token_expires_at.should be_nil
+    end
+  end
+
+  describe '.from_remember_token' do
+    before do
+      @user = Factory(:stocktwits_oauth_user, :remember_token => 'abcdef', :remember_token_expires_at => (Time.now + 10.days))
+    end
+
+    it 'should find the user with the specified remember_token' do
+      User.from_remember_token('abcdef').should == @user
+    end
+
+    it 'should not find a user with an expired token' do
+      user2 = Factory(:stocktwits_oauth_user, :login => 'walker', :remember_token => 'ghijkl', :remember_token_expires_at => (Time.now - 10.days))
+      User.from_remember_token('ghijkl').should be_nil
+    end
+
+    it 'should not find a user with a nil token and an expiration' do
+      user = Factory(:stocktwits_oauth_user, :login => 'stranger', :remember_token => nil, :remember_token_expires_at => (Time.now + 10.days))
+      User.from_remember_token(nil).should be_nil
+    end
+  end
+end

data/spec/models/stocktwits/oauth_user_spec.rb

@@ -0,0 +1,100 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Stocktwits::OauthUser do
+  before do
+    stub_oauth!
+  end
+ 
+  describe '.identify_or_create_from_access_token' do
+    before do
+       @token = OAuth::AccessToken.new(Stocktwits.consumer, 'faketoken', 'fakesecret')
+    end
+
+    it 'should accept an OAuth::AccessToken' do
+      lambda{ User.identify_or_create_from_access_token(@token) }.should_not raise_error(ArgumentError)
+    end
+
+    it 'should change the login when the screen_name changes' do
+      @user = Factory(:stocktwits_oauth_user, :stocktwits_id => '123')
+      User.stub!(:handle_response).and_return({'id' => 123, 'screen_name' => 'dude'})
+      User.identify_or_create_from_access_token(@token).should == @user.reload
+    end
+
+    it 'should accept two strings' do
+      lambda{ User.identify_or_create_from_access_token('faketoken', 'fakesecret') }.should_not raise_error(ArgumentError)
+    end
+
+    it 'should not accept one string' do
+      lambda{ User.identify_or_create_from_access_token('faketoken') }.should raise_error(ArgumentError, 'Must authenticate with an OAuth::AccessToken or the string access token and secret.')
+    end
+
+    it 'should make a call to verify_credentials' do
+      # this is in the before, just making it explicit
+      User.identify_or_create_from_access_token(@token)
+    end
+
+    it 'should try to find the user with that id' do
+      User.should_receive(:find_by_stocktwits_id).once.with('123')
+      User.identify_or_create_from_access_token(@token)
+    end
+
+    it 'should return the user if he/she exists' do
+      user = Factory.create(:stocktwits_oauth_user, :stocktwits_id => '123', :login => 'stocktwitsman')
+      user.reload
+      User.identify_or_create_from_access_token(@token).should == user
+    end
+
+    it 'should update the access_token and access_secret for the user if he/she exists' do
+      user = Factory.create(:stocktwits_oauth_user, :stocktwits_id => '123', :login => 'stocktwitsman', :access_token => 'someothertoken', :access_secret => 'someothersecret')
+      User.identify_or_create_from_access_token(@token)
+      user.reload
+      user.access_token.should == @token.token
+      user.access_secret.should == @token.secret
+    end
+
+    it 'should update the user\'s attributes based on the stocktwits info' do
+      user = Factory.create(:stocktwits_oauth_user, :login => 'stocktwitsman', :name => 'Not Twitter Man')
+      User.identify_or_create_from_access_token(@token).name.should == 'Twitter Man'
+    end
+
+    it 'should create a user if one does not exist' do
+      lambda{User.identify_or_create_from_access_token(@token)}.should change(User, :count).by(1)
+    end
+
+    it 'should assign the oauth access token and secret' do
+      user = User.identify_or_create_from_access_token(@token)
+      user.access_token.should == @token.token
+      user.access_secret.should == @token.secret
+    end
+  end
+
+  describe '#token' do
+    before do
+      @user = Factory.create(:stocktwits_oauth_user, :access_token => 'token', :access_secret => 'secret')
+    end
+
+    it 'should return an AccessToken' do
+      @user.token.should be_a(OAuth::AccessToken)
+    end
+
+    it "should use the user's access_token and secret" do
+      @user.token.token.should == @user.access_token
+      @user.token.secret.should == @user.access_secret
+    end
+  end
+
+  describe '#stocktwits' do
+    before do
+      @user = Factory.create(:stocktwits_oauth_user, :access_token => 'token', :access_secret => 'secret')
+    end
+
+    it 'should return a Stocktwits::Dispatcher::Oauth' do
+      @user.stocktwits.should be_a(Stocktwits::Dispatcher::Oauth)
+    end
+
+    it 'should use my token and secret' do
+      @user.stocktwits.token.should == @user.access_token
+      @user.stocktwits.secret.should == @user.access_secret
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :stocktwits_users, :force => true do |t|
+    t.string :twitter_id
+    t.string :login
+    
+    # OAuth fields
+    t.string :access_token
+    t.string :access_secret
+
+    # Basic fields
+    t.binary :crypted_password
+    t.string :salt
+
+    # Remember token fields
+    t.string :remember_token
+    t.datetime :remember_token_expires_at
+
+    # This information is automatically kept
+    # in-sync at each login of the user. You
+    # may remove any/all of these columns.
+
+    t.timestamps
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,107 @@
+# begin
+#   require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+# rescue LoadError
+#   puts "You need to install rspec in your base app"
+#   exit
+# end
+
+RAILS_ROOT = File.dirname(__FILE__) unless defined?(RAILS_ROOT)
+
+
+module Rails
+  
+  module VERSION
+    STRING = "2.3.5"
+  end
+  
+  def self.env
+    "test"
+  end
+  
+  def self.root
+    File.dirname(__FILE__)
+  end
+end unless defined?(Rails)
+
+
+
+require 'rubygems'
+require 'active_record'
+require 'action_controller'
+require 'action_controller/test_process'
+require 'spec'
+require 'spec/rails'
+require 'shoulda'
+#require 'shoulda/rails'
+
+#include Shoulda::Rails
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'stocktwits'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'..','lib','**','*.rb'))].each {|f| require f}
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'..','app','**','*.rb'))].each {|f| require f}
+
+
+class Stocktwits::GenericUser
+  def self.table_name; 'stocktwits_users' end
+end
+
+class User < Stocktwits::GenericUser; end
+
+
+
+require 'remarkable'
+require File.dirname(__FILE__) + '/fixtures/factories'
+require File.dirname(__FILE__) + '/fixtures/fakeweb'
+# require File.dirname(__FILE__) + '/fixtures/stocktwits'
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+load(File.dirname(__FILE__) + '/schema.rb')
+
+def define_basic_user_class!
+  Stocktwits::GenericUser.send :include, Stocktwits::BasicUser 
+end
+
+def define_oauth_user_class!
+  Stocktwits::GenericUser.send :include, Stocktwits::OauthUser  
+end
+
+def define_plain_user_class!
+  Stocktwits::GenericUser.send :include, Stocktwits::PlainUser  
+end
+
+def stub_oauth!
+  Stocktwits.stub!(:config).and_return({
+    'strategy' => 'oauth',
+    'oauth_consumer_key' => 'testkey',
+    'oauth_consumer_secret' => 'testsecret'
+  })
+  define_oauth_user_class!
+end
+
+def stub_basic!
+  Stocktwits.stub!(:config).and_return({
+    'strategy' => 'basic',
+    'encryption_key' => 'secretcode'
+  })
+  define_basic_user_class!
+end
+
+def stub_plain!
+  Stocktwits.stub!(:config).and_return({
+    'strategy' => 'plain'
+  })
+  define_plain_user_class!
+end
+
+define_oauth_user_class!