tf2r 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3eea3425354043f9ded54a379f71f341cf8010e
-  data.tar.gz: d0104958be84f7c9ddada47b9149c60a5fcdb565
+  metadata.gz: f93befc5ee498a05c0f863dca2156747a184e75b
+  data.tar.gz: 88a9ee5bb47d1eb9725065277f53bc251f309f24
 SHA512:
-  metadata.gz: 69b5e73e168c64ea21deae35c377854651add86269f3b371f1a453fc64e255b508e8affcd283f776ae10d444760ba821bb0f5eaa237f0b9b141e5efcfd97be23
-  data.tar.gz: 27e52dac9061e970a47073b5fffbdc47eb37e3f54d9bf569a1c1ad3a9eaa160d7ab7fde95a428883f231333fda3cae80ea8661cf4576935dca9d61e9e61338bf
+  metadata.gz: 1a6339383a2d14a9cc3da5bb378d0f2fbced0d31f7790ea47b311542ec554cb74d0855c6e7fd12493b8e2deb7415d17f2d41d257d4ad5ba78cb451d4da694f81
+  data.tar.gz: 8816069f87359a8b4efee8c4dbc6292a23885e16e86a288b7c1c5a3a570ac08f4c87bf2d7bf66270d9e9404af1497679bb5811a2786f1b9a28e37cb2205206c3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tf2r (0.2.1)
+    tf2r (0.3.0)
       mechanize (~> 2.7)
 
 GEM

data/lib/tf2r/api.rb

@@ -5,6 +5,9 @@ module TF2R
   class API
     HOST = 'http://tf2r.com'
     ENDPOINT = '/job.php'
+    # newentry on a checkraffle job can only return up to 2500 entries. This is
+    # a problem for any raffles with a maximum entries greater than 2500.
+    MAX_ENTRY_RESPONSE_COUNT = 2500
 
     def self.raffle_info(link_snippet)
       params = {checkraffle: true, rid: link_snippet[1..-1],
@@ -14,7 +17,7 @@ module TF2R
 
     private
 
-    # Make this sane with something like httparty
+    # TODO: Make this sane with something like httparty
     def self.request(params)
       uri = URI.parse(HOST)
       http = Net::HTTP.new(uri.host, uri.port)

data/lib/tf2r/raffle.rb

@@ -1,16 +1,18 @@
 module TF2R
   # This class provides a simple wrapper around grabbing information for a
   # raffle from the Scraper and API.
-  # TODO: make this an actuall wrapper instead of accepting pre-made info.
+  # TODO: document
   class Raffle
     include TF2R::TextHelpers
 
-    attr_reader :link_snippet, :api_info, :scraper_info
+    attr_reader :link_snippet
 
-    def initialize(link_snippet, api_info, scraper_info)
+    def initialize(link_snippet)
       @link_snippet = link_snippet
-      @api_info     = api_info
-      @scraper_info = scraper_info
+
+      @scraper = Scraper.new
+      populate_raffle_info
+      get_full_participants if max_entries > API::MAX_ENTRY_RESPONSE_COUNT
     end
 
     def info
@@ -25,12 +27,35 @@ module TF2R
       @scraper_info[1]
     end
 
+    # TODO: test raffles with max_entries greater than 2500
     def participants
-      @normalized_participants ||= normalize_entries(@api_info['newentry'])
+      if max_entries > 2500
+        @normalized_participants ||= normalize_entries(@api_info['newentry'])
+      else
+        @full_participants
+      end
     end
 
     private
 
+    def populate_raffle_info
+      threads = []
+      threads << Thread.new do
+        @api_info = API.raffle_info(@link_snippet)
+      end
+      threads << Thread.new do
+        page = @scraper.fetch(raffle_link(@link_snippet))
+        @scraper_info = @scraper.scrape_raffle(page)
+      end
+
+      threads.each { |t| t.join }
+    end
+
+    def get_full_participants
+      page = @scraper.fetch(raffle_link_full(@link_snippet))
+      @full_participants = @scraper.scrape_raffle_for_participants(page)
+    end
+
     def normalize_entries(entries)
       entries.map do |entry|
         entry[:steam_id] = extract_steam_id entry.delete('link')

data/lib/tf2r/scraper.rb

@@ -13,7 +13,7 @@ module TF2R
     # @option opts [String] :user_agent a custom User-Agent header content
     # @option opts [File] :cookies_txt a cookies.txt to load the Mechanize
     #   agent with
-    def initialize(options)
+    def initialize(options={})
       @mech = Mechanize.new { |mech|
         mech.user_agent = options[:user_agent] || "TF2R::Scraper #{VERSION}"
       }
@@ -156,11 +156,11 @@ module TF2R
        start_time: start_time, end_time: end_time}
     end
 
-    # @deprecated Please use {#TF2R::API} instead. The API provides a far more
-    # efficient and reliable method of retrieving the entry list.
-    #
     # Scrapes a raffle page for all the participants.
     #
+    # This should rarely be used. This will only be necessary in the case that
+    # a raffle has maximum entries greater than 2500.
+    #
     # @param page [Mechanize::Page] the raffle page.
     # @return [Array] contains Hashes representing each of the participants,
     # in chronological order (first entered to last).
@@ -168,8 +168,6 @@ module TF2R
     #   * :username (+String+) — the participant's username.
     #   * :colour (+String+) — hex colour code of the participant's username.
     def scrape_raffle_for_participants(page)
-      warn '[DEPRECATION] `scrape_raffle_for_participants` is deprecated. '\
-            'Please use `TF2R::API` instead.'
       participants = []
       participant_divs = page.parser.css('.pentry')
       participant_divs.each do |participant|

data/lib/tf2r/text_helpers.rb

@@ -1,4 +1,5 @@
 module TF2R
+  # TODO: document
   module TextHelpers
     # Extracts a hex colour code.
     #
@@ -30,5 +31,20 @@ module TF2R
     def extract_steam_id(href)
       /http:\/\/tf2r.com\/user\/(\d+)\.html/.match(href)[1].to_i
     end
+
+    # Generates the TF2R link for a raffle given a link snippet.
+    #
+    # @example
+    #   raffle_link('kabc123') => 'http://tf2r.com/kabc123.html'
+    #
+    # @param link_snippet [String] the raffle link snippet.
+    # @return [String] the raffle link.
+    def raffle_link(link_snippet)
+      link = "http://tf2r.com/#{link_snippet}.html"
+    end
+
+    def raffle_link_full(link_snippet)
+      "#{raffle_link(link_snippet)}?full"
+    end
   end
 end

data/lib/tf2r/version.rb

@@ -1,3 +1,3 @@
 module TF2R
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/spec/raffle_spec.rb

@@ -1,15 +1,11 @@
 require 'spec_helper'
 
 describe TF2R::Raffle do
-  let(:scraper) { TF2R::Scraper.new({}) }
-  let(:scraper_info) {
+  let(:raffle) {
     VCR.use_cassette('kstzcbd') do
-      scraper.scrape_raffle(scraper.fetch('http://tf2r.com/kstzcbd.html'))
+      raffle = TF2R::Raffle.new('kstzcbd')
     end
   }
-  let(:raffle) {
-    TF2R::Raffle.new('kstzcbd', TF2R::API.raffle_info('kstzcbd'), scraper_info)
-  }
 
   describe '#info' do
     let(:result) { raffle.info }

data/spec/scraper_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe TF2R::Scraper do
-  let(:scraper) { TF2R::Scraper.new({}) }
+  let(:scraper) { TF2R::Scraper.new() }
   let(:raffle_page) {
     VCR.use_cassette('raffle_kstzcbd') do
       scraper.fetch('http://tf2r.com/kstzcbd.html')
@@ -10,14 +10,14 @@ describe TF2R::Scraper do
 
   it 'is instantiable' do
     expect{
-      TF2R::Scraper.new({})
+      TF2R::Scraper.new()
     }.not_to raise_error
   end
 
   describe '#new' do
     context 'no options are given' do
       it 'creates an agent with default user agent if none is specified' do
-        scraper = TF2R::Scraper.new({})
+        scraper = TF2R::Scraper.new()
         expect(
           scraper.instance_variable_get(:@mech).user_agent
         ).to eql("TF2R::Scraper #{TF2R::VERSION}")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tf2r
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler