beway 0.0.1

data/lib/beway.rb

@@ -0,0 +1,4 @@
+require_relative './beway/auction.rb'
+require_relative './beway/bidder.rb'
+require_relative './beway/cli_runner.rb'
+require_relative './beway/ebay_data.rb'

data/lib/beway/auction.rb

@@ -0,0 +1,150 @@
+require 'nokogiri'
+require 'open-uri'
+
+module Beway
+  class AuctionParseError < StandardError; end;
+  class InvalidUrlError < StandardError; end;
+
+  # Auction
+  #
+  # Represents an ebay auction.  Can only be instantiated for true auctions
+  # (no buy-it-now-only sales) and completed auctions.
+  class Auction
+
+    attr_reader :url, :doc, :last_updated
+
+    def initialize url
+      @url = url
+      refresh_doc
+      raise InvalidUrlError unless valid_auction?
+    end
+
+    # can we represent this auction?
+    def valid_auction?
+      return true if complete? or has_bid_button?
+      return false
+    end
+
+    # has bidding ended yet?
+    def complete?
+      complete_span = @doc.at_xpath('//span[contains(text(), "Bidding has ended on this item")]')
+      return (complete_span.nil?) ? false : true
+    end
+
+    # fetch the url again
+    def refresh_doc
+      @doc = Nokogiri::HTML(open(@url))
+      @last_updated = Time.now
+    end
+
+    # parsing method, returns a string
+    def current_bid
+      # list of ways to get the bid.
+      xpaths = [
+        "//th[contains(text(),'Current bid:')]",
+        "//th[contains(text(),'Starting bid:')]",
+        "//th[contains(text(),'Price:')]",
+        "//td[contains(text(),'Starting bid:')]",
+        "//td[contains(text(),'Winning bid:')]",
+      ]
+
+      bid_node = xpaths.reduce(nil) do |node, xpath|
+        if node.nil?
+          node = @doc.at_xpath(xpath)
+          node = node.next_sibling unless node.nil?
+        end
+        node
+      end
+
+      raise AuctionParseError, "Couldn't find current/starting bid header in document" if bid_node.nil?
+      bid_text = node_text(bid_node)
+      bid_text = bid_text[/^[^\[]+/].strip if complete?
+      return bid_text
+    end
+
+    # parsing method, returns a string
+    def description
+      desc = @doc.at_css('b#mainContent h1')
+      raise AuctionParseError, "Couldn't find description in document" if desc.nil?
+      desc.inner_text.strip
+    end
+
+    # parsing method, returns a string
+    def time_left
+      return nil if complete?
+
+      time_str = node_text(time_node)
+      time_str = time_str[/^[^(]*/].strip
+      time_ar = time_str.split
+      raise AuctionParseError, "Didn't find hour marker where expected" unless time_ar[1] == 'h'
+      raise AuctionParseError, "Didn't find minute marker where expected" unless time_ar[3] == 'm'
+      raise AuctionParseError, "Didn't find second marker where expected" unless time_ar[5] == 's'
+      time_ar[0] + 'h ' + time_ar[2] + 'm ' + time_ar[4] + 's'
+    end
+
+    # parsing method, returns a float
+    def min_bid
+      return nil if complete?
+
+      max_label = @doc.at_xpath("//th/label[contains(text(),'Your max bid:')]")
+      raise AuctionParseError, "Couldn't find max bid label in document" unless max_label
+      min_bid_node = max_label.parent.parent.next_sibling
+      raise AuctionParseError, "Couldn't find minimum bid in document" unless min_bid_node
+      md = /\(Enter ([^)]*) or more\)/.match min_bid_node.inner_text
+      raise AuctionParseError, "Min Bid data not in expected format" if md.nil?
+      md[1][/\d*\.\d*/].to_f
+    end
+
+    # parsing method, returns a Time object
+    def end_time
+      text = node_text(time_node)
+      md = text.match(/\(([^)]*)\)/)
+      if md
+        time_str = md[1]
+      else
+        time_str = text
+      end
+      raise AuctionParseError unless time_str
+      Time.parse(time_str)
+    end
+
+    # parsing method, returns a string
+    def auction_number
+      canonical_url_node = @doc.at_css('link[@rel = "canonical"]')
+      raise AuctionParseError, "Couldn't find canonical URL" unless canonical_url_node
+      canonical_url_node.attr('href')[/\d+$/]
+    end
+
+    # parsming method, returns boolean
+    def has_bid_button?
+      place_bid_button = @doc.at_xpath('//form//input[@value="Place bid"]')
+      return (place_bid_button.nil?) ? false : true
+    end
+
+    private
+
+    # fetch the node containing the end time
+    def time_node
+      if complete?
+        td = @doc.at_xpath("//td[contains(text(),'Ended:')]")
+        raise AuctionParseError, "Couldn't find ended header" unless td
+        node = td.next_sibling
+      else
+        th = @doc.at_xpath("//th[contains(text(),'Time left:')]")
+        raise AuctionParseError, "Couldn't find Time Left header" unless th
+        node = th.parent.at_css('td')
+      end
+
+      raise AuctionParseError, "Couldn't find Time node" unless node
+      node
+    end
+
+    # a string of all text nodes below n, concatenated
+    def node_text(n)
+      t = ''
+      n.traverse { |e| t << ' ' + e.to_s if e.text? }
+      t.gsub(/ +/, ' ').strip
+    end
+
+  end
+end

data/lib/beway/bidder.rb

@@ -0,0 +1,100 @@
+require 'mechanize'
+
+module Beway
+  
+  class BidderError < StandardError; end;
+
+  # Bidder
+  #
+  # Wrapper for Mechanize to perform actions on ebay
+  class Bidder
+
+    EBAY_HOME = 'http://www.ebay.com'
+
+    attr_accessor :username
+    attr_writer :password
+    attr_reader :agent, :logged_in, :last_login_time
+
+    # create a bidder with login credentials
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @agent = Mechanize.new
+      @logged_in = false
+      @last_login_time = nil
+    end
+
+    # log user in with credentials.
+    # returns boolean representing success
+    def login
+      ebay_home_page = @agent.get(EBAY_HOME)
+
+      sign_in_link = ebay_home_page.link_with( :text => 'Sign in' )
+      raise BidderError, "Couldn't find sign in link" unless sign_in_link
+      login_page = sign_in_link.click
+
+      handle_login_page(login_page)
+
+      return @logged_in
+    end
+
+    # bid amount on given auction
+    def bid(auction_url, amount)
+
+      # get auction
+      auction_page = @agent.get(auction_url)
+
+      # get the bid form
+      forms = auction_page.forms_with( :action => /http:\/\/offer\.ebay\.com\// )
+      raise BidderError, "Couldn't find auction bid form" if forms.length != 1
+      bid_form = forms[0]
+
+      # fill in, submit bid form
+      bid_form.maxbid = amount
+      bid_response = bid_form.submit
+
+      # if given a login page, do it and get redirected to confirm bid
+      if is_login_page?(bid_response)
+        bid_response = handle_login_page(bid_response) 
+      end
+
+      # get confirm bid form
+      forms = bid_response.forms_with( :action => 'http://offer.ebay.com/ws/eBayISAPI.dll' )
+      raise BidderError, "Couldn't find confirm bid form" if forms.length != 1
+      confirm_form = forms[0]
+
+      # click confirm button
+      confirm_button = confirm_form.button_with( :value => 'Confirm Bid' )
+      raise BidderError, "Couldn't find confirm bid button" unless confirm_button
+      confirm_response = confirm_form.submit( confirm_button )
+
+      confirm_response
+    end
+
+    private
+
+    # is page a login page?
+    def is_login_page?(page)
+      if page.form_with( :name => 'SignInForm')
+        true
+      else
+        false
+      end
+    end
+
+    # log into ebay as prompted by login_page
+    def handle_login_page(login_page)
+      login_form = login_page.form_with( :name => 'SignInForm')
+      raise BidderError, "Couldn't find login form" unless login_form
+      login_form.userid = @username
+      login_form.pass = @password
+      login_response =  login_form.submit
+
+      @logged_in = login_response.search('form#SignInForm').empty?
+      @last_login_time = Time.now if @logged_in
+
+      return login_response
+    end
+
+  end
+end

data/lib/beway/cli_runner.rb

@@ -0,0 +1,184 @@
+require_relative '../beway.rb'
+
+module Beway
+
+  # CliRunner
+  #
+  # A UI for the Beway module to snipe an ebay auction
+  class CliRunner
+
+    BID_THRESHOLD = 10
+
+    def self.start
+      runner = self.new
+      runner.run
+    end
+
+    def initialize
+    end
+
+    def run
+      
+      display_intro
+
+      # login prep
+      user = prompt_username
+      pass = prompt_password
+      bidder = Bidder.new(user, pass)
+      puts "Logging in..."
+      bidder.login
+      if bidder.logged_in
+        puts "          ...success"
+      else
+        puts "Bad ebay username/password combo!  Please try again."
+        exit
+      end
+
+      # bid prep
+      auction = auction_from_user
+      bid_amount = bid_for_auction_from_user(auction)
+
+      # our tools
+      ebay = EbayData.instance
+
+      loop do
+        display_auction auction
+
+        seconds_to_end = ebay.seconds_to(auction.end_time)
+
+        if seconds_to_end <= BID_THRESHOLD
+          puts "Placing bid..."
+          begin
+            bidder.bid(auction.url, bid_amount)
+            puts "           ...placed."
+            puts "Sleeping til end of auction..."
+            sleep ebay.seconds_to(auction.end_time).ceil
+            auction.refresh_doc
+            display_auction auction
+            exit
+          rescue BidderError => e
+            puts "           ...oh no!"
+            puts "There was an error placing your bid:"
+            puts
+            puts "  " + e.message
+            puts 
+            puts "So sorry!"
+            exit
+          end
+        end
+
+        seconds = seconds_to_end.floor / 2
+        seconds = 5 if seconds_to_end < (2 * BID_THRESHOLD)
+        puts "Sleeping #{seconds} seconds..."
+        sleep seconds
+
+        puts "Updating auction..."
+        puts
+        auction.refresh_doc
+      end
+    end
+
+    def bid_for_auction_from_user(a)
+      loop do
+        bid_amount = prompt_bid()#a.min_bid)
+        return bid_amount if prompt_confirm_bid(bid_amount)
+      end
+    end
+
+    def auction_from_user
+      loop do
+        begin
+          auction = Auction.new(prompt_url)
+          if auction.complete?
+            display_auction auction
+            puts
+            puts "That auction is done already!  Try another, or 'exit' to quit."
+            next
+          end
+        rescue AuctionParseError
+          puts "Sorry, we can't parse that url as an auction"
+          next
+        end
+
+        return auction if prompt_confirm_auction(auction)
+      end
+    end
+
+    def display_intro
+      puts "Welcome to Beway's CLI interface"
+    end
+
+    def display_auction(a)
+      puts
+      puts "URL:            #{a.url}"
+      puts "Description:    #{a.description}"
+      puts "Auction Number: #{a.auction_number}"
+      puts "Current Bid:    #{a.current_bid}"
+      puts "Min Bid:        #{a.min_bid || '-- bidding closed --'}"
+      puts "Time Left:      #{a.time_left || '-- bidding closed --'}"
+      puts "End Time:       #{a.end_time}"
+    end
+
+    def prompt_username
+      print "Enter eBay username >> "
+      return get_user_input.chomp
+    end
+
+    def prompt_password
+      print "Enter eBay password >> "
+      system "stty -echo"
+      pass = get_user_input
+      system "stty echo"
+      puts
+
+      pass.chomp
+    end
+
+    def prompt_bid(min=nil)
+      print "Enter your bid for the item >> "
+      bid = get_user_input.to_f
+      puts
+      return bid if min.nil? or bid >= min
+      puts "The minimum bid for this auction is #{min}.  Try again, or type 'exit' to quit."
+      prompt_bid(min)
+    end
+
+    def prompt_confirm_bid(amount)
+      printf "Are you sure you want to bid %.2f? (y\\n) >> ", amount
+      confirm = get_user_input
+      puts
+      if confirm.downcase.chr == 'y'
+        true
+      else
+        false
+      end
+    end
+
+    def prompt_confirm_auction(a)
+      display_auction(a)
+      print 'Does this look like your auction? (y\n) >> '
+      confirm = get_user_input
+      if confirm.downcase.chr == 'y'
+        true
+      else
+        false
+      end
+    end
+
+    def prompt_url
+      puts
+      puts "Enter an ebay auction url (or 'exit' to exit): "
+      print "\n>> "
+      url = get_user_input
+
+      url.chomp
+    end
+
+    def get_user_input
+      s = gets
+      exit if 'exit' == s.chomp.downcase
+      s
+    end
+  end
+
+end

data/lib/beway/ebay_data.rb

@@ -0,0 +1,66 @@
+require 'singleton'
+require 'nokogiri'
+require 'open-uri'
+
+module Beway
+
+  class EbayDataParseError < StandardError; end;
+
+  # EbayData
+  #
+  # Singleton class to handle ebay queries that are not auction-related.
+  class EbayData
+
+    include Singleton
+
+    EBAY_OFFICIAL_TIME_URL = 'http://viv.ebay.com/ws/eBayISAPI.dll?EbayTime'
+
+    def initialize
+      @time_offset = nil
+      @last_time_offset = nil
+    end
+
+    # The current ebay time as calculated by an offset from localtime.
+    def time
+      Time.now.localtime + self.time_offset
+    end
+
+    # The localtime offset from ebay time.
+    #
+    # add this offset to localtime to get an estimated ebay time
+    def time_offset
+      calc_time_offset unless @time_offset
+      @time_offset
+    end
+
+    # Calculate the ebay time offset
+    def calc_time_offset
+      @last_time_offset = Time.now
+      @time_offset = official_time - Time.now.localtime 
+    end
+
+    # Retrieve the official ebay time
+    def official_time
+      doc = Nokogiri::HTML(open(EBAY_OFFICIAL_TIME_URL))
+
+      time_label = doc.at_xpath('//p[contains(text(), "The official eBay Time is now:")]')
+
+      raise EbayDataParseError, "Couldn't find time label" unless time_label
+
+      time_node = time_label.next_sibling.next_sibling
+      raise EbayDataParseError, "Couldn't find time node" unless time_node
+
+      time_str = time_node.inner_text
+      time_re = /(Sun|Mon|Tues|Wednes|Thurs|Fri|Satur)day, (January|February|March|April|May|June|July|August|September|October|December) \d\d, 20\d\d \d\d:\d\d:\d\d PST/
+      raise EbayDataParseError, "Time in unexpected format" unless time_re.match(time_str)
+
+      Time.parse(time_str).localtime
+    end
+
+    # Returns the number of seconds to some_ebay_time
+    def seconds_to(some_ebay_time)
+      some_ebay_time - time
+    end
+
+  end
+end