stocktwits 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Elad Meidar
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= stocktwits
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Elad Meidar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stocktwits"
+    gem.summary = %Q{ Stocktwits.com API wrapper}
+    gem.description = %Q{ Provide an OAuth, Basic HTTP authentication and plain interfaces to the StockTwits API.}
+    gem.email = "elad@eizesus.com"
+    gem.homepage = "http://github.com/eladmeidar/stocktwits"
+    gem.authors = ["Elad Meidar"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency 'ezcrypto'
+    gem.add_dependency 'oauth'
+    gem.add_dependency 'json'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+desc 'Default: run specs.'
+task :default => :spec
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stocktwits #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,68 @@
+class SessionsController < ApplicationController
+  unloadable
+
+  def new
+    if Stocktwits.oauth?
+      oauth_callback = request.protocol + request.host_with_port + '/oauth_callback'
+      @request_token = Stocktwits.consumer.get_request_token({:oauth_callback=>oauth_callback})
+      session[:request_token] = @request_token.token
+      session[:request_token_secret] = @request_token.secret
+     
+      url = @request_token.authorize_url
+      url << "&oauth_callback=#{CGI.escape(Stocktwits.oauth_callback)}" if Stocktwits.oauth_callback?      
+      redirect_to url
+    else
+      # we don't have to do anything, it's just a simple form for HTTP basic!
+    end
+  end
+
+  def create
+    logout_keeping_session!
+    if user = User.authenticate(params[:login], params[:password])
+      self.current_user = user
+      authentication_succeeded and return
+    else
+      authentication_failed('Unable to verify your credentials through Stocktwits. Please try again.', '/login') and return
+    end
+  end
+
+  def oauth_callback
+    unless session[:request_token] && session[:request_token_secret] 
+      authentication_failed('No authentication information was found in the session. Please try again.') and return
+    end
+
+   unless params[:oauth_token].blank? || session[:request_token] ==  params[:oauth_token]
+     authentication_failed('Authentication information does not match session information. Please try again.') and return
+   end
+
+    @request_token = OAuth::RequestToken.new(Stocktwits.consumer, session[:request_token], session[:request_token_secret])
+
+    oauth_verifier = params["oauth_verifier"]
+    @access_token = @request_token.get_access_token(:oauth_verifier => oauth_verifier)
+    
+    # The request token has been invalidated
+    # so we nullify it in the session.
+    session[:request_token] = nil
+    session[:request_token_secret] = nil
+
+    @user = User.identify_or_create_from_access_token(@access_token)
+
+    session[:user_id] = @user.id
+
+    cookies[:remember_token] = @user.remember_me
+
+    authentication_succeeded 
+  rescue Net::HTTPServerException => e
+    case e.message
+      when '401 "Unauthorized"'
+        authentication_failed('This authentication request is no longer valid. Please try again.') and return
+      else
+        authentication_failed('There was a problem trying to authenticate you. Please try again.') and return
+    end 
+  end
+  
+  def destroy
+    logout_keeping_session!
+    redirect_back_or_default('/')
+  end
+end

data/app/models/stocktwits/basic_user.rb

@@ -0,0 +1,64 @@
+require 'net/http'
+
+module Stocktwits
+  module BasicUser
+    def self.included(base)
+      base.class_eval do
+        attr_protected :crypted_password, :salt
+      end
+
+      base.extend Stocktwits::BasicUser::ClassMethods
+    end
+
+    module ClassMethods
+      def verify_credentials(login, password)
+        response = Stocktwits.net.start { |http|
+          request = Net::HTTP::Get.new('/account/verify_credentials.json')
+          request.basic_auth login, password
+          http.request(request)
+        }
+
+        if response.code == '200'
+          JSON.parse(response.body)
+        else
+          false
+        end
+      end
+
+      def authenticate(login, password)
+        if stocktwits_hash = verify_credentials(login, password)
+          user = identify_or_create_from_stocktwits_hash_and_password(stocktwits_hash, password)
+          user
+        else
+          nil
+        end
+      end
+
+      def identify_or_create_from_stocktwits_hash_and_password(stocktwits_hash, password)
+        if user = User.find_by_stocktwits_id(stocktwits_hash['id'].to_s)
+          user.login = stocktwits_hash['screen_name']
+          user.assign_stocktwits_attributes(stocktwits_hash)
+          user.password = password
+          user.save
+          user
+        else
+          user = User.new_from_stocktwits_hash(stocktwits_hash)
+          user.password = password
+          user.save
+          user
+        end
+      end
+    end
+   
+    def password=(new_password)
+      encrypted = Stocktwits::Cryptify.encrypt(new_password)
+      self.crypted_password = encrypted[:encrypted_data]
+      self.salt = encrypted[:salt]
+    end
+
+    def password
+      Stocktwits::Cryptify.decrypt(self.crypted_password, self.salt)
+    end
+  end
+end
+

data/app/models/stocktwits/generic_user.rb

@@ -0,0 +1,123 @@
+module Stocktwits
+  class GenericUser < ActiveRecord::Base
+    attr_protected :stocktwits_id, :remember_token, :remember_token_expires_at
+    
+    STOCKTWITS_FIELDS = ["avatar_url_thumb", 
+                         "avatar_url_medium", 
+                         #"profile", 
+                         "following_count", 
+                         #"id", 
+                         "updates_count", 
+                         "avatar_url_large", 
+                         "last_name", 
+                         "followers_count", 
+                         "recommended", 
+                         "bio", 
+                         # "login", 
+                         "first_name"]
+                         
+    STOCKTWITS_PROFILE_FIELDS = ["approach",
+                                 "location",
+                                 "title",
+                                 "risk_profile",
+                                 "focus",
+                                 #"id",
+                                 "long_short",
+                                 "qualifications",
+                                 "user_id",
+                                 "investment_style",
+                                 "website",
+                                 "asset_classes_traded",
+                                 "bio",
+                                 "capitalization_bias",
+                                 "holding_period",
+                                 "education",
+                                 "industry",
+                                 "personal_interests",
+                                 "trading_experience"]
+                                 
+    # with_options :if => :utilize_default_validations do |v|
+    #   v.validates_presence_of :login, :stocktwits_id
+    #   v.validates_format_of :login, :with => /\A[a-z0-9_]+\z/i
+    #   v.validates_length_of :login, :in => 1..15
+    #   v.validates_uniqueness_of :login, :case_sensitive => false
+    #   v.validates_uniqueness_of :stocktwits_id, :message => "ID has already been taken."
+    #   v.validates_uniqueness_of :remember_token, :allow_blank => true
+    # end
+    
+    def self.table_name; 'users' end
+
+    def self.new_from_stocktwits_hash(hash)
+      raise ArgumentError, "Expected a 'user' key in attributes hash, got: #{hash.keys.inspect}" unless hash.key?('user')
+      hash = hash['user']
+      raise ArgumentError, "Invalid hash: must include login." unless hash.key?('login')
+
+      raise ArgumentError, 'Invalid hash: must include id.' unless hash.key?('id')
+
+      user = User.new
+      user.stocktwits_id = hash['id'].to_s
+      user.login = hash['login']
+
+      user.assign_stocktwits_attributes(hash)
+      
+      user
+    end
+
+    def self.from_remember_token(token)
+      first(:conditions => ["remember_token = ? AND remember_token_expires_at > ?", token, Time.now])
+    end
+      
+    def assign_stocktwits_attributes(hash)
+      STOCKTWITS_FIELDS.each do |att|
+        send("#{att}=", hash[att.to_s]) if self.respond_to?("#{att}=")
+      end
+      
+      STOCKTWITS_PROFILE_FIELDS.each do |att|
+        send("#{att}=", hash['profile'][att.to_s]) if self.respond_to?("#{att}=")
+      end
+    end
+
+    def update_stocktwits_attributes(hash)
+      assign_stocktwits_attributes(hash)
+      save
+    end
+
+    if Stocktwits.oauth?
+      include Stocktwits::OauthUser
+    elsif Stocktwits.basic?
+      include Stocktwits::BasicUser
+    else
+      include Stocktwits::PlainUser
+    end
+
+    def utilize_default_validations
+      true
+    end
+
+    def stocktwits
+      if Stocktwits.oauth?
+        Stocktwits::Dispatcher::Oauth.new(self)
+      elsif Stocktwits.basic?
+        Stocktwits::Dispatcher::Basic.new(self)
+      else
+        Stocktwits::Dispatcher::Plain.new(self)
+      end
+    end
+
+    def remember_me
+      return false unless respond_to?(:remember_token)
+
+      self.remember_token = ActiveSupport::SecureRandom.hex(10)
+      self.remember_token_expires_at = Time.now + Stocktwits.remember_for.days
+      
+      save
+
+      {:value => self.remember_token, :expires => self.remember_token_expires_at}
+    end
+
+    def forget_me
+      self.remember_token = self.remember_token_expires_at = nil
+      self.save
+    end
+  end
+end

data/app/models/stocktwits/oauth_user.rb

@@ -0,0 +1,46 @@
+module Stocktwits
+  module OauthUser
+    def self.included(base)
+      base.class_eval do
+        attr_protected :access_token, :access_secret
+      end
+
+      base.extend Stocktwits::OauthUser::ClassMethods
+      base.extend Stocktwits::Dispatcher::Shared
+    end
+    
+    module ClassMethods
+      def identify_or_create_from_access_token(token, secret=nil)
+        raise ArgumentError, 'Must authenticate with an OAuth::AccessToken or the string access token and secret.' unless (token && secret) || token.is_a?(OAuth::AccessToken)
+        
+        token = OAuth::AccessToken.new(Stocktwits.consumer, token, secret) unless token.is_a?(OAuth::AccessToken)
+        
+        response = token.get(Stocktwits.path_prefix + '/account/verify_credentials.json')
+        user_info = handle_response(response)
+        
+        if user = User.find_by_stocktwits_id(user_info['id'].to_s)
+          user.login = user_info['screen_name']
+          user.assign_stocktwits_attributes(user_info)
+          user.access_token = token.token
+          user.access_secret = token.secret
+          user.save
+          user
+        else
+          User.create_from_stocktwits_hash_and_token(user_info, token) 
+        end
+      end
+
+      def create_from_stocktwits_hash_and_token(user_info, access_token)
+        user = User.new_from_stocktwits_hash(user_info)
+        user.access_token = access_token.token
+        user.access_secret = access_token.secret
+        user.save
+        user
+      end
+    end
+
+    def token
+      OAuth::AccessToken.new(Stocktwits.consumer, access_token, access_secret)
+    end 
+  end
+end