lonely_coder 0.1.0

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    lonely_coder (0.1.0)
+      activesupport (>= 3.2.1)
+      mechanize (>= 2.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.7)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    domain_name (0.5.2)
+      unf (~> 0.0.3)
+    i18n (0.6.0)
+    mechanize (2.3)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (~> 0.0, >= 0.0.9)
+    mime-types (1.18)
+    multi_json (1.1.0)
+    net-http-digest_auth (1.2)
+    net-http-persistent (2.5.2)
+    nokogiri (1.5.2)
+    ntlm-http (0.1.1)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    unf (0.0.5)
+      unf_ext
+    unf_ext (0.0.4)
+    vcr (2.0.0)
+    webmock (1.8.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    webrobots (0.0.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  lonely_coder!
+  rspec
+  vcr
+  webmock

data/README.mdown

@@ -0,0 +1,72 @@
+Lonely Coder
+===================
+
+    ,d88b.d88b,
+    88888888888
+    `Y8888888Y'
+      `Y888Y'
+        `Y'
+        
+Lonely coder seeks nice boy
+-----------------------------
+    require 'lonely_coder'
+    okc = OKCupid.new('thetrek','thisisntmypasswordweirdo')
+    
+    sweet_guys = []
+    
+    ['Ann Arbor, MI', 'New York, New York', 
+    'Chicago, Illinois', 'San Francisco, CA'].each do |maybe_here|
+      sweet_guys += okc.search({
+        :min_age => 25,
+        :max_age => 35, # just someone around my age, yo
+        :gentation => 'Guys who like guys', # don't hate
+        :order_by => 'Match %', # I want us to get along
+        :match_limit => 80, # let's make it last
+        :last_login => 'last month',
+        :location => maybe_here
+        :radius => 25, # acceptable values are 25, 50, 100, 250, 500, nil
+        :require_photo => true, # I like a goofy smile
+        :relationship_status => 'single' # the heart aches, but not for friends
+      }).results
+    end
+    
+    sweet_guys.count # oof, 812. Let the coffee dates begin!
+    
+What is this nonsense?
+-----------------------------
+A ruby gem for interacting with [OKCupid](http://www.okcupid.com/). OKCupid doesn't actually have an API, so we use mechanize to interact with the site. Screen scraping isn't terribly fast, but it's pretty zippy compared to the other option – doing nothing.
+
+How does it work?
+-----------------------------
+You'll need an OKCupid account (it's free) because most of the site is behind authentication.  You can create a new connection to the site.
+
+    require 'lonely_coder'
+    okc = OKCupid.new('yourusername', 'yourpassword')
+    
+Once you have a connection you can check out a person's profile
+    
+    trek = okc.profile_for('thetrek')
+    trek.match # => 99. Damn, he's pretty sweet
+    trek.location # => 'Ann Arbor, Michigan'
+    `open #{trek.profile_thumb_urls.first}` # HOT. DAMN.
+
+Go ahead and ask for `username`, `match`, `friend`, `enemy`, `location`, `age`, `sex`, `orientation`, `single`, `last_online`, `ethnicity`, `height`, `body_type`, `diet`, `smokes`,  `drinks`, `drugs`, `religion`, `sign`, `education`, `job`, `income`, `offspring`, `pets`, `speaks`, and `profile_thumb_urls`
+
+If you don't have particular username in mind, you can search. Check `lib/magic_constants.rb` for the crazy [Magic Numbers](http://en.wikipedia.org/wiki/Magic_number_(programming\)).
+
+    search = okc.search({
+      :min_age => 18,
+      :max_age => 99,
+      :gentation => 'guys who like guys',
+      :ethnicity => ['human']
+    }) # search object
+  
+    # fires the loading of the first 10, but only limited profiles. If you'd like full
+    # deets, use okc.profile_for with a results username.
+    search.results
+    search.load_next_page # loads the next 10 results
+
+What if things don't go well
+-----------------------------
+
+    okc.love(1000) # ♥ 

data/lib/lonely_coder/authentication.rb

@@ -0,0 +1,41 @@
+class OKCupid
+  
+  def authenticate(username, password)
+    @authentication = Authentication.new(username, password, @browser)
+  end
+  
+  class Authentication
+    def initialize(username, password, browser)
+      change_to_using_simpler_parser(browser)
+      
+      browser.post("https://www.okcupid.com/login", {
+        username: username,
+        password: password
+      })
+      
+      @success = browser.page.uri.path == '/home'
+      
+      restore_default_parser(browser)
+    end
+    
+    def success?
+      @success
+    end
+    
+    def change_to_using_simpler_parser(browser)
+      browser.pluggable_parser.html = AuthenticationParser
+    end
+    
+    def restore_default_parser(browser)
+      browser.pluggable_parser.html = Mechanize::Page
+    end
+  end
+  
+  class AuthenticationParser < Mechanize::Page  
+    # We're only using page uri to determine successful login, so
+    # there's not a lot of value in passing a body string to nokogiri
+    def initialize(uri = nil, response = nil, body = nil, code =nil)
+      super(uri, response, nil, code)
+    end
+  end
+end

data/lib/lonely_coder/magic_constants.rb

@@ -0,0 +1,99 @@
+class OKCupid
+  module MagicNumbers
+    # Used to build OKCupid search urls. These are the wacky values
+    # that OKCupid expects.
+    Ethnicity = {
+      "asian" => 2,
+      "black" => 8,
+      "hispanic/latin" => 128,
+      "indian" => 32,
+      "middle eastern" => 4,
+      "native american" => 16,
+      "pacific islander" => 64,
+      "white" => 256,
+      "human" => 512
+    }
+    
+    Gentation = {
+      "girls who like guys" => 34,
+      "guys who like girls" => 17,
+      "girls who like girls" => 40,
+      "guys who like guys" => 20,
+      "both who like bi guys" => 54,
+      "both who like bi girls" => 57,
+      "straight girls only" => 2,
+      "Straight guys only" => 1,
+      "gay girls only" => 8,
+      "gay guys only" => 4,
+      "bi girls only" => 32,
+      "bi guys only" => 16,
+      "everybody" => 63
+    }
+    
+    Filters = {
+      # "account_status" => 29,
+      "age" => 2,
+      # "body_type" => 30,
+      # "cats" => 17,
+      # "children" => 18,
+      # "community_award" => 31,
+      # "diet" => 54,
+      # "dogs" => 16,
+      # "drinking" => 12,
+      # "drugs" => 13,
+      # "education" => 19,
+      # "eligible" => 7,
+      "ethnicity" => 9,
+      "gentation" => 0,
+      # "height" => 10,
+      # "jobtype" => 15,
+      # "join_date" => 6,
+      # "languages" => 22,
+      "last_login" => 5,
+      # "looking_for" => 32,
+      # "money" => 14,
+      # "not_looking_for" => 34,
+      # "num_ques_ans" => 33,
+      # "personality" => 20,
+      # "prof_score" => 28,
+      "radius" => 3,
+      "relationship_status" => 35,
+      # "religion" => 8,
+      "require_photo" => 1,
+      # "sign" => 21,
+      # "smoking" => 11,
+      # "v_first_contact" => 27,
+      # "v_looks" => 23,
+      # "v_personality" => 25,
+      
+      # added by us
+      'match_limit' => 'match_limit',
+      'order_by' => 'order_by',
+      'location' => 'location'
+    }
+    
+    RelationshipStatus = {
+      'single' => 2,
+      'not single' => 12,
+      'any' => 0
+    }
+    
+    OrderBy = {
+      'match %' => 'MATCH',
+      'friend %' => 'FRIEND',
+      'enemy %' => 'ENEMY',
+      'special blend' => 'SPECIAL_BLEND',
+      'join' => 'JOIN',
+      'last login' => 'LOGIN'
+    }
+    
+    LastLogin = {
+      "now" => 3600,
+      "last day" => 86400,
+      "last week" => 604800,
+      "last month" => 2678400,
+      "last year" => 31536000,
+      "last decade" => 315360000 
+    }
+  end
+end

data/lib/lonely_coder/profile.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+class OKCupid
+  
+  def profile_for(username)
+    Profile.by_username(username, @browser)
+  end
+  
+  class Profile
+    attr_accessor :username, :match, :friend, :enemy, :location,
+                  :age, :sex, :orientation, :single, :small_avatar_url
+    
+    # extended profile details
+    attr_accessor :last_online, :ethnicity, :height, :body_type, :diet, :smokes, 
+                  :drinks, :drugs, :religion, :sign, :education, :job, :income, 
+                  :offspring, :pets, :speaks, :profile_thumb_urls
+    
+                  
+    # Scraping is never pretty.
+    def self.from_search_result(html)
+      
+      username = html.search('span.username').text
+      age, sex, orientation, single = html.search('p.aso').text.split('/')
+      
+      percents = html.search('div.percentages')
+      match = percents.search('p.match .percentage').text.to_i
+      friend = percents.search('p.friend .percentage').text.to_i
+      enemy = percents.search('p.enemy .percentage').text.to_i
+      
+      location = html.search('p.location').text
+      small_avatar_url = html.search('a.user_image img').attribute('src').value
+      
+      OKCupid::Profile.new({
+        username: username,
+        age: OKCupid.strip(age),
+        sex: OKCupid.strip(sex),
+        orientation: OKCupid.strip(orientation),
+        single: OKCupid.strip(single),
+        match: match,
+        friend: friend,
+        enemy: enemy,
+        location: location,
+        small_avatar_url: small_avatar_url
+      })
+    end
+    
+    def Profile.by_username(username, browser)
+      html = browser.get("http://www.okcupid.com/profile/#{username}")
+      
+      percents = html.search('#percentages')
+      match = percents.search('span.match').text.to_i
+      friend = percents.search('span.friend').text.to_i
+      enemy = percents.search('span.enemy').text.to_i
+      
+      basic = html.search('#aso_loc')
+      age = basic.search('#ajax_age').text
+      sex = basic.search('#ajax_gender').text
+      orientation = basic.search('#ajax_orientation').text
+      single = basic.search('#ajax_status').text
+      location = basic.search('#ajax_location').text
+      
+      profile_thumb_urls = html.search('#profile_thumbs img').collect {|img| img.attribute('src').value}
+      
+      attributes = {
+        username: username,
+        match: match,
+        friend: friend,
+        enemy: enemy,
+        age: age,
+        sex: sex,
+        orientation: orientation,
+        location: location,
+        single: single,
+        profile_thumb_urls: profile_thumb_urls
+      }
+      
+      details_div = html.search('#profile_details dl')
+      
+      details_div.each do |node|
+        value = OKCupid.strip(node.search('dd').text)
+        next if value == '—'
+        
+        attr_name = node.search('dt').text.downcase.gsub(' ','_')
+        attributes[attr_name] = value
+      end
+      
+      self.new(attributes)
+    end
+    
+    def initialize(attributes)
+      attributes.each do |attr,val|
+        self.send("#{attr}=", val)
+      end
+    end
+    
+    def ==(other)
+      self.username == other.username
+    end
+  end
+end

data/lib/lonely_coder/search.rb

@@ -0,0 +1,199 @@
+require 'uri'
+
+class OKCupid
+  def search(options={})
+    Search.new(options, @browser)
+  end
+  
+  class Search
+    class FilterError < StandardError; end
+    
+    attr_reader :filters
+    
+    def self.location_id_for(query)
+      uri = URI("http://www.okcupid.com/locquery?func=query&query=#{URI.encode(query)}")
+      JSON.parse(Net::HTTP.get(uri))['results'][0]['locid'].to_s
+    end
+    
+    def initialize(options, browser = Mechanize.new)
+      @browser = browser
+      options = defaults.merge(options)
+      parse(options)
+    end
+    
+    def parse(options)
+      combine_ages(options)
+      check_for_required_options(options)
+      remove_match_limit(options)
+      
+      @filters = []
+      options.each do |name,value|
+        
+        if OKCupid.const_defined?("#{name.to_s.camelize}Filter")
+          @filters << OKCupid.const_get("#{name.to_s.camelize}Filter").new(name, value)
+        else
+          @filters << Filter.new(name, value)
+        end
+      end
+    end
+    
+    def remove_match_limit(options)
+      @match_limit = options.delete(:match_limit)
+    end
+    
+    def check_for_required_options(options)
+      raise(FilterError, 'gentation is a required option') unless options.has_key?(:gentation)
+    end
+    
+    def combine_ages(options)
+      age = [options.delete(:min_age), options.delete(:max_age)]
+      options[:age] = age
+    end
+    
+    # Default values for search:
+    # match_limit 80
+    # min_age 18
+    # max_age 99
+    # order_by 'match %'
+    # last_login 'last month'
+    # location 'Near me'
+    #    to search 'anywhere', use 'Near me' and omit a radius
+    # radius 25
+    # require_photo true
+    # relationship_status 'single'
+    def defaults
+      {
+        :match_limit => 80,
+        :min_age => 18,
+        :max_age => 99,
+        :order_by => 'Match %',
+        :last_login => 'last month',
+        :location => 'Near me',
+        :radius => 25, # acceptable values are 25, 50, 100, 250, 500, nil
+        :require_photo => true,
+        :relationship_status => 'single'
+      }
+    end
+    
+    def results
+      return @results if @results
+      
+      page = @browser.get(url)
+      @results = page.search('.match_row').collect do |node|
+        OKCupid::Profile.from_search_result(node)
+      end
+    end
+    
+    def load_next_page
+      @browser.pluggable_parser.html = SearchPaginationParser
+      page = @browser.get("#{url}&low=11&count=10&ajax_load=1")
+      @results += page.search('.match_row').collect do |node|
+        OKCupid::Profile.from_search_result(node)
+      end
+      @browser.pluggable_parser.html = Mechanize::Page
+      self
+    end
+    
+    def url
+      '/match?' + filters.compact.to_enum(:each_with_index).map {|filter,index| filter.to_param(index+1)}.join('&')
+    end
+  end
+  
+  class Filter
+    class NoSuchFilter < StandardError; end
+    class BadValue     < StandardError; end
+    
+    attr_reader :name, :value, :code
+    
+    def initialize(name, value)
+      @code = MagicNumbers::Filters[name.to_s]
+      raise(NoSuchFilter, name) unless @code
+      
+      @name = name.to_s
+      @value = value
+      @encoded_value = lookup(@value)
+      unless @encoded_value
+        raise(BadValue, "#{@value.inspect} is not a possible value for #{@name}. Try one of #{allowed_values.map(&:inspect).join(', ')}")
+      end
+    end
+    
+    def allowed_values
+      MagicNumbers.const_get(@name.camelize).keys
+    end
+    
+    def lookup(value)
+      MagicNumbers.const_get(@name.camelize)[value.downcase]
+    end
+    
+    def to_param(n)
+      "filter#{n}=#{@code},#{@encoded_value}"
+    end
+  end
+  
+  class EthnicityFilter < Filter
+    def lookup(values)
+      # lookup the race values and sum them. I think OKC is doing some kind of base2 math on them
+      values.collect {|v| MagicNumbers::Ethnicity[v.downcase]}.inject(0, :+)
+    end
+  end
+  
+  class LocationFilter < Filter
+    def lookup(value)
+      ''
+    end
+    
+    def to_param(n)
+      
+      # to do: 'anywhere' needs to remove the radius filter
+      if @value.is_a?(String)
+        if @value.downcase == 'near me'
+          "locid=0"
+        else
+          "lquery=#{URI.escape(@value)}"
+        end
+      else
+        "locid=#{@value}"
+      end
+    end
+  end
+  
+  class OrderByFilter < Filter
+    def to_param(n)
+      "matchOrderBy=#{@encoded_value}"
+    end
+  end
+  
+  # we fake this by paginating results ourselves.
+  # class MatchLimitFilter < Filter
+  #   def lookup(value)
+  #     'MATCH'
+  #   end
+  #   
+  #   def to_param(n)
+  #     nil
+  #   end
+  # end
+  
+  class RequirePhotoFilter < Filter
+    def lookup(value)
+      value ? 1 : 0
+    end
+  end
+    
+  class RadiusFilter < Filter
+    def lookup(value)
+      value.nil? ? '' : value
+    end
+    
+    def to_param(n)
+      return nil if @encoded_value === ''
+      super
+    end
+  end
+  
+  class AgeFilter < Filter
+    def lookup(value)
+      "#{value[0]},#{value[1]}"
+    end
+  end
+end

data/lib/lonely_coder/search_pagination_parser.rb

@@ -0,0 +1,12 @@
+require 'json'
+class OKCupid
+  # OKCupid's ajax pagination follows pjax pattern and returns json
+  # with page fragments. We switch to this custom parser when 
+  # interaction with search.
+  class SearchPaginationParser < Mechanize::Page
+    def initialize(uri = nil, response = nil, body = nil, code =nil)
+      body = JSON.parse(body)['html']
+      super(uri, response, body, code)
+    end
+  end
+end

data/lib/lonely_coder.rb

@@ -0,0 +1,38 @@
+#encoding: UTF-8
+
+#   Hey there.
+#           ,d88b.d88b,
+#           88888888888
+#           `Y8888888Y'
+#             `Y888Y'
+#               `Y'       - trek
+#
+require 'mechanize'
+
+class OKCupid
+  BaseUrl = 'http://www.okcupid.com'
+  VERSION = '0.1.0'
+  
+  def initialize(username=nil, password=nil)
+    @browser = Mechanize.new 
+    @browser.user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79 Safari/535.11'
+    authenticate(username, password)
+  end
+  
+  WhiteSpace = "\302\240"
+  def self.strip(str)
+    str.gsub(WhiteSpace, ' ').strip
+  end
+  
+  def love(n=20)
+    ' ♥ ' * n
+  end
+end
+
+require 'active_support/core_ext/string/inflections'
+
+require 'lonely_coder/magic_constants'
+require 'lonely_coder/profile'
+require 'lonely_coder/search'
+require 'lonely_coder/search_pagination_parser'
+require 'lonely_coder/authentication'

data/spec/authentication_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Authentication' do
+  it "returns true if successful" do
+    VCR.use_cassette('successful_authentication', :erb => {username: ENV['OKC_USERNAME'], password: ENV['OKC_PASSWORD']}) do
+      auth = OKCupid::Authentication.new(ENV['OKC_USERNAME'], ENV['OKC_PASSWORD'], Mechanize.new)
+      auth.success?.should == true
+    end
+  end
+  
+  it "returns false if not successful" do
+    VCR.use_cassette('failed_authentication') do
+      auth = OKCupid::Authentication.new('thisisnotauser', 'thisisnotapassword', Mechanize.new)
+      auth.success?.should == false
+    end
+  end
+
+  
+  it "restores Mechanize::Page as a parser after authenticating" do
+    @browser = Mechanize.new
+    VCR.use_cassette('successful_authentication', :erb => {username: ENV['OKC_USERNAME'], password: ENV['OKC_PASSWORD']}) do
+      auth = OKCupid::Authentication.new(ENV['OKC_USERNAME'], ENV['OKC_PASSWORD'], @browser)
+    end
+    @browser.pluggable_parser['text/html'].should == Mechanize::Page
+  end
+end