tf2r 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0228ccd1fe398e24c3437a9130d1bb8c60354f2
-  data.tar.gz: 1d574edad3dfbc811e332ece10e40c8faaa37343
+  metadata.gz: d040ee6e9265eed2195362f8c115193590c62207
+  data.tar.gz: be7f1f7cf1a805e4fa5b16fc02fd41b0692193c7
 SHA512:
-  metadata.gz: 5986819d3cde531f50cd27aebf7aab9d5743f2fe770cfb29f6e27b6e79f9e44282b3396e9d70fc6bf7068f1832ea20856565c01621bc29f64e045429c2a24027
-  data.tar.gz: 40f6ab0a5eb7dc46dac07043d59de61308a188e22d76b053437f1b16f0a448d5a697f35322bc0666c8ea2bcbae38b2e551a6d370c731c7972994061e51d6a5b1
+  metadata.gz: 51aef9d710a7e17129106d3ec3f0843f822cd7e43e5a89e39de7fa48f324877437028fc0f75a3e6a4b7c946d5085dd7a7e4eb721305c0ca5e06bb4fcb134a068
+  data.tar.gz: 00ea3e40215556e898e0a9e3c078bab6506083e4f11cac1ca4ee4eb97e36688e7c85ef988586b576fc065130f531a0e39e0a49a760dbba45b02c7b9113b66033

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/Gemfile.lock

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

data/lib/tf2r/api.rb

@@ -1,7 +1,7 @@
 module TF2R
   # This class handles interaction with TF2R's "API", which is really just an
   # open endpoint located at http://tf2r.com/job.php, in use all over the site
-  # to have dynamically updating pages.
+  # for dynamically updating pages.
   class API
     HOST = 'http://tf2r.com'
     ENDPOINT = '/job.php'
@@ -9,6 +9,22 @@ module TF2R
     # a problem for any raffles with a maximum entries greater than 2500.
     MAX_ENTRY_RESPONSE_COUNT = 2500
 
+    # Queries the API for information about a raffle.
+    #
+    # @params link_snippet [String] the link snippet of the desired raffle.
+    # @return [Array] the API response for the raffle.
+    #   * ended (+Boolean+) whether the raffle is done.
+    #   * timeleft (+Fixnum+) seconds remaining.
+    #   * max_entry (+Fixnum+) maximum number of entries.
+    #   * entry (+String+) but really a number. This is the ID in TF2R's db of
+    #       the last entry returned in the response.
+    #   * wc (+Float+) the chance for any one participant to win.
+    #   * cur_entry (+Fixnum+) current number of entries.
+    #   * started (+Boolean+) whether the raffle has begun.
+    #   * newentry (+Array+) contains hashes representing participants in
+    #       chronological order.
+    #   * chaten (+Array+) I have no idea.
+    #   * chatmax (+Fixnum) ¯\_(ツ)_/¯
     def self.raffle_info(link_snippet)
       params = {checkraffle: true, rid: link_snippet[1..-1],
                 lastentrys: 0, lastchat: 0}
@@ -17,7 +33,8 @@ module TF2R
 
     private
 
-    # TODO: Make this sane with something like httparty
+    # Submits a request to job.php with the given params.
+    # TODO: should this do something with the responses headers?
     def self.request(params)
       uri = URI.parse(HOST)
       http = Net::HTTP.new(uri.host, uri.port)

data/lib/tf2r/raffle.rb

@@ -15,6 +15,34 @@ module TF2R
       get_full_participants if max_entries > API::MAX_ENTRY_RESPONSE_COUNT
     end
 
+
+    # Gives information about the raffle.
+    #
+    # @example
+    #   r = Raffle.new('kstzcbd')
+    #   r.info #=>
+    #   {:link_snippet=>"kstzcbd",
+    #    :title=>"Just one refined [1 hour]",
+    #    :description=>"Plain and simple.",
+    #    :start_time=>2012-10-29 09:51:45 -0400,
+    #    :end_time=>2012-10-29 09:53:01 -0400,
+    #    :win_chance=>0.1,
+    #    :current_entries=>10,
+    #    :max_entries=>10,
+    #    :is_done=>true}
+    #
+    # @param page [Mechanize::Page] the raffle page.
+    # @return [Hash] a representation of the raffle.
+    #   * :link_snippet (+String+) — the "raffle id" in the URL.
+    #   * :title (+String+) — the raffle's title.
+    #   * :description (+String+) — the raffle's "message".
+    #   * :start_time (+Time+) — the creation time of the raffle.
+    #   * :end_time (+Time+) — the projects/observed end time for the raffle.
+    #   * :win_chance (+Float+) — a participant's chance to win the raffle.
+    #     Rounded to 5 digits.
+    #   * :current_entries (+Fixnum+) — the current number of participants.
+    #   * :max_entries (+Fixnum+) — the maximum number of particpants allowed.
+    #   * :is_done (+Boolean+) — whether new users can enter the raffle.
     def info
       @info ||= {link_snippet: @link_snippet, title: title,
                  description: description, start_time: start_time,
@@ -23,6 +51,11 @@ module TF2R
                  is_done: is_done}
     end
 
+    # Gives information about the raffle's creator.
+    #
+    # Taken straight from +Scraper+.
+    #
+    # @see Scraper#scrape_raffle_for_creator
     def creator
       @scraper_info[1]
     end
@@ -38,6 +71,8 @@ module TF2R
 
     private
 
+    # Asynchronously makes network connections to TF2R to query its API and
+    # scrape the raffle page.
     def populate_raffle_info
       threads = []
       threads << Thread.new do
@@ -56,6 +91,8 @@ module TF2R
       @full_participants = @scraper.scrape_raffle_for_participants(page)
     end
 
+    # Converts the representation of participants by TF2R's API into our own
+    # standard representation.
     def normalize_entries(entries)
       entries.map do |entry|
         entry[:steam_id] = extract_steam_id entry.delete('link')

data/lib/tf2r/scraper.rb

@@ -4,6 +4,7 @@ module TF2R
     include TF2R::TextHelpers
 
     class InvalidUserPage < StandardError; end
+
     # Creates a Scraper. Pass values using the options hash.
     #
     #   :user_agent a String used for the User-Agent header
@@ -207,12 +208,11 @@ module TF2R
         raise InvalidUserPage, 'The given page does not correspond to any user.'
       else
         infos = user_page.parser.css('.raffle_infomation') #sic
-        avatar_anchor = infos[0].css('img')[0]
         user_anchor = infos[1].css('a')[0]
 
         steam_id = extract_steam_id(user_page.uri.to_s)
         username = /TF2R Item Raffles - (.+)/.match(user_page.title)[1]
-        avatar_link = avatar_anchor.attribute('src').to_s
+        avatar_link = infos[0].css('img')[0].attribute('src').to_s
 
         posrep = infos.css('.upvb').text.to_i
         negrep = infos.css('.downvb').text.to_i

data/lib/tf2r/text_helpers.rb

@@ -1,5 +1,7 @@
 module TF2R
-  # TODO: document
+  # This module provides common methods for manipulating text throughout this
+  # gem. Common operations include messing with Steam ID 64s, hex color codes,
+  # and link to resources on TF2R.
   module TextHelpers
     # Extracts a hex colour code.
     #
@@ -43,6 +45,10 @@ module TF2R
       link = "http://tf2r.com/#{link_snippet}.html"
     end
 
+    # @example
+    #   raffle_link_full('kabc123') => 'http://tf2r.com/kabc123.html?full'
+    #
+    # @see raffle_link
     def raffle_link_full(link_snippet)
       "#{raffle_link(link_snippet)}?full"
     end

data/lib/tf2r/version.rb

@@ -1,3 +1,3 @@
 module TF2R
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/raffle_spec.rb

@@ -8,23 +8,56 @@ describe TF2R::Raffle do
   }
 
   describe '#info' do
-    let(:result) { raffle.info }
+    let(:info) { raffle.info }
 
     it 'returns correct values' do
-      expect(result[:link_snippet]).to eql('kstzcbd')
-      expect(result[:title]).to eql('Just one refined [1 hour]')
-      expect(result[:description]).to eql('Plain and simple.')
-      expect(result[:start_time]).to eql(
+      expect(info[:link_snippet]).to eql('kstzcbd')
+      expect(info[:title]).to eql('Just one refined [1 hour]')
+      expect(info[:description]).to eql('Plain and simple.')
+      expect(info[:start_time]).to eql(
         Time.new(2012, 10, 29, 14, 51, 45, '+01:00')
       )
-      expect(result[:end_time]).to eql(
+      expect(info[:end_time]).to eql(
         Time.new(2012, 10, 29, 14, 53, 01, '+01:00')
       )
-      expect(result[:win_chance]).to eql(0.1)
+      expect(info[:win_chance]).to eql(0.1)
       # TODO: use a raffle where current_entries != max_entries
-      expect(result[:current_entries]).to eql(10)
-      expect(result[:max_entries]).to eql(10)
-      expect(result[:is_done]).to eql(true)
+      expect(info[:current_entries]).to eql(10)
+      expect(info[:max_entries]).to eql(10)
+      expect(info[:is_done]).to eql(true)
+    end
+  end
+
+  describe '#creator' do
+    let(:creator) { raffle.creator }
+
+    it 'returns the raffle creator' do
+      expect(creator[:steam_id]).to match(76561198061719848)
+      expect(creator[:username]).to eql('Yulli')
+      expect(creator[:avatar_link]).to match(STEAM_AVATAR_LINK_REGEXP)
+      expect(creator[:posrep]).to eql(11459)
+      expect(creator[:negrep]).to eql(0)
+      expect(creator[:colour]).to match(HEX_COLOUR_REGEXP)
+    end
+  end
+
+  describe '#participants' do
+    let(:participants) { raffle.participants }
+
+    it 'returns the correct number of participants' do
+      expect(participants.length).to eql(10)
+    end
+
+    it 'returns the correct participants' do
+      expect(participants[0][:steam_id]).to match(76561198017461530)
+      expect(participants[0][:username]).to eql('TheJohn')
+      expect(participants[0][:colour]).to match(HEX_COLOUR_REGEXP)
+      expect(participants[0][:avatar_link]).to match(STEAM_AVATAR_LINK_REGEXP)
+
+      expect(participants[-1][:steam_id]).to match(76561198029274581)
+      expect(participants[-1][:username]).to eql('pony danza (OUT...')
+      expect(participants[-1][:colour]).to match(HEX_COLOUR_REGEXP)
+      expect(participants[-1][:avatar_link]).to match(STEAM_AVATAR_LINK_REGEXP)
     end
   end
 end

data/spec/scraper_spec.rb

@@ -8,12 +8,6 @@ describe TF2R::Scraper do
     end
   }
 
-  it 'is instantiable' do
-    expect{
-      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
@@ -53,51 +47,26 @@ describe TF2R::Scraper do
                   :headers => {'content_type' => 'text/html'})
     end
 
-    it 'makes a request to the specified URL' do
-      expect(
-        scraper.fetch('http://google.com')
-      ).to have_requested(:get, 'google.com')
-    end
-
     it 'returns a Mechanize::Page' do
       expect(scraper.fetch('http://google.com')).to be_a(Mechanize::Page)
     end
   end
 
-  describe '#scrape_raffle' do
-    let(:result) { scraper.scrape_raffle(raffle_page) }
-
-    it 'returns an Array' do
-      expect(result).to be_an(Array)
-    end
-
-    it 'returns the same as its child methods' do
-      expect(result[0]).to eql(scraper.scrape_raffle_for_raffle(raffle_page))
-      expect(result[1]).to eql(scraper.scrape_raffle_for_creator(raffle_page))
-    end
-  end
-
   describe '#scrape_main_page' do
     let(:result) {
-      VCR.use_cassette('raffle_kstzcbd') do
-        scraper.scrape_main_page
-      end
+      scraper.scrape_main_page
     }
 
     before(:each) do
       raffles_file = File.new(File.join(File.dirname(__FILE__), 'raffles.html'))
+
       stub_request(:get, "http://tf2r.com/raffles.html").
         with(:headers => {'Accept'=>'*/*', 'Host'=>'tf2r.com'}).
         to_return(:status => 200, :body => raffles_file,
                   :headers => {'content_type' => 'text/html'})
     end
 
-    it 'returns an Array of Strings' do
-      expect(result).to be_an(Array)
-      expect(result[0]).to be_a(String)
-      expect(result[-1]).to be_a(String)
-    end
-
+    # TODO: figure out a way to periodicially use more recent pages
     it 'returns raffle links in reverse chronological order' do
       # See spec/raffles.html for the hard-coded values.
       expect(result[0]).to eql('http://tf2r.com/kzkp8jo.html')
@@ -105,12 +74,17 @@ describe TF2R::Scraper do
     end
   end
 
-  describe '#scrape_raffle_for_creator' do
-    let(:result) { scraper.scrape_raffle_for_creator(raffle_page) }
+  describe '#scrape_raffle' do
+    let(:result) { scraper.scrape_raffle(raffle_page) }
 
-    it 'returns a Hash representation of a user' do
-      expect(result).to be_a(Hash)
+    it 'returns the same as its child methods' do
+      expect(result[0]).to eql(scraper.scrape_raffle_for_raffle(raffle_page))
+      expect(result[1]).to eql(scraper.scrape_raffle_for_creator(raffle_page))
     end
+  end
+
+  describe '#scrape_raffle_for_creator' do
+    let(:result) { scraper.scrape_raffle_for_creator(raffle_page) }
 
     # This is a terrible spec right now. The raffle tested against is one of
     # my own, which is constantly updated as I use the site. If I gain or lose
@@ -118,13 +92,13 @@ describe TF2R::Scraper do
     # TODO: Use a stagnant alt account to make a test raffle.
     it 'returns correct values' do
       expect(result[:steam_id]).to eql(76561198061719848)
-      expect(result[:colour]).to eql('70b01b')
+      expect(result[:colour]).to match(HEX_COLOUR_REGEXP)
 
       # The following expectations are very brittle. TF2R updates the certain
       # user attributes (such as name and avatar) every time the user logs in
       # with new ones.
       expect(result[:username]).to eql('Yulli')
-      expect(result[:avatar_link]).to eql('http://media.steampowered.com/steamcommunity/public/images/avatars/bc/bc9dc4302d23f2e2f37f59c59f29c27dbc8cade6_full.jpg')
+      expect(result[:avatar_link]).to match(STEAM_AVATAR_LINK_REGEXP)
 
       # Talk about brittle.
       expect(result[:posrep]).to eql(11459)
@@ -136,10 +110,6 @@ describe TF2R::Scraper do
   describe '#scrape_raffle_for_raffle' do
     let(:result) { scraper.scrape_raffle_for_raffle(raffle_page) }
 
-    it 'returns a Hash representation of a raffle' do
-      expect(result).to be_a(Hash)
-    end
-
     it 'returns correct values' do
       expect(result[:link_snippet]).to eql('kstzcbd')
       expect(result[:title]).to eql('Just one refined [1 hour]')
@@ -154,6 +124,7 @@ describe TF2R::Scraper do
   end
 
   describe '#scrape_raffle_for_participants' do
+    # TODO: use a real test raffle
     let(:page) {
       VCR.use_cassette('raffle_kstzcbd_full') do
         scraper.fetch('http://tf2r.com/kstzcbd.html?full')
@@ -161,12 +132,6 @@ describe TF2R::Scraper do
     }
     let(:result) { scraper.scrape_raffle_for_participants(page) }
 
-    it 'returns an Array of Hashes' do
-      expect(result).to be_an(Array)
-      expect(result[0]).to be_a(Hash)
-      expect(result[-1]).to be_a(Hash)
-    end
-
     it 'returns correct values' do
       expect(result[0][:steam_id]).to eql(76561198017461530)
       expect(result[0][:username]).to eql('TheJohn')
@@ -187,17 +152,13 @@ describe TF2R::Scraper do
       }
       let(:result) { scraper.scrape_user(user_page) }
 
-      it 'returns a Hash' do
-        expect(result).to be_a(Hash)
-      end
-
       # This spec is also brittle. It relies on my TF2R user account, which is
       # updated constantly.
       # TODO: use a stagnant alt account
       it 'returns correct values' do
         expect(result[:steam_id]).to eql(76561198061719848)
         expect(result[:username]).to eql('Yulli')
-        expect(result[:avatar_link]).to eql('http://media.steampowered.com/steamcommunity/public/images/avatars/bc/bc9dc4302d23f2e2f37f59c59f29c27dbc8cade6_full.jpg')
+        expect(result[:avatar_link]).to match(STEAM_AVATAR_LINK_REGEXP)
         expect(result[:posrep]).to eql(11459)
         expect(result[:negrep]).to eql(0)
         expect(result[:colour]).to eql('70b01b')
@@ -228,12 +189,6 @@ describe TF2R::Scraper do
     }
     let(:result) { scraper.scrape_ranks(info_page) }
 
-    it 'returns an Array of Hashes' do
-      expect(result).to be_an(Array)
-      expect(result[0]).to be_a(Hash)
-      expect(result[-1]).to be_a(Hash)
-    end
-
     it 'returns correct values' do
       expect(result[0][:name]).to eql('User')
       expect(result[0][:description]).to eql(
@@ -242,6 +197,7 @@ describe TF2R::Scraper do
       expect(result[0][:colour]).to eql('ebe2ca')
 
       # This is brittle. Every time a new rank is added, this fails.
+      # TODO: explore possibilities to limber this up
       expect(result[-1][:name]).to eql('Lense')
       expect(result[-1][:description]).to eql('[ Custom donator rank ]')
       expect(result[-1][:colour]).to eql('545d6c')

data/spec/spec_helper.rb

@@ -23,4 +23,7 @@ VCR.configure do |c|
   end
 end
 
-WebMock.disable_net_connect!(allow_localhost: true)
+WebMock.disable_net_connect!(allow_localhost: true)
+
+STEAM_AVATAR_LINK_REGEXP = /^http:\/\/media\.steampowered\.com\/steamcommunity\/public\/images\/avatars\/\w{2}\/[\w]+\.jpg$/
+HEX_COLOUR_REGEXP = /^[a-f0-9]{3}{1,2}$/i

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tf2r
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"