tf2r 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c5bd71115ed3cebd26737dc98ab7dcc23355253
-  data.tar.gz: 1eef157620f392d7f5247cc262eef47a02451fcd
+  metadata.gz: d3eea3425354043f9ded54a379f71f341cf8010e
+  data.tar.gz: d0104958be84f7c9ddada47b9149c60a5fcdb565
 SHA512:
-  metadata.gz: dab7f6734488422f90ca4defcd8af4f071eb6778a36f90551721b5a778bee9bb9e96f3b41d03f7126b42574b09274251efbcc3a7510277ceed2f95c339282d7b
-  data.tar.gz: e3755809104357d54bdfec5bc792565914d1e9c6ab230d0f349dcfb3cb54f51da60e4101b6c0820ad8abbebeeabe420bc6c5e2d68e2742660283046df7ad8c95
+  metadata.gz: 69b5e73e168c64ea21deae35c377854651add86269f3b371f1a453fc64e255b508e8affcd283f776ae10d444760ba821bb0f5eaa237f0b9b141e5efcfd97be23
+  data.tar.gz: 27e52dac9061e970a47073b5fffbdc47eb37e3f54d9bf569a1c1ad3a9eaa160d7ab7fde95a428883f231333fda3cae80ea8661cf4576935dca9d61e9e61338bf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tf2r (0.2.0)
+    tf2r (0.2.1)
       mechanize (~> 2.7)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     cane (2.6.2)
       parallel
     coderay (1.1.0)
-    coveralls (0.7.0)
+    coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
@@ -75,7 +75,7 @@ GEM
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.3.0)
+    tins (1.3.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.6)
@@ -91,7 +91,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.3)
   cane (~> 2.6)
-  coveralls (~> 0.7)
+  coveralls (~> 0.7.1)
   pry (~> 0.10)
   rake (~> 10.0)
   rspec (~> 3.0)

data/lib/tf2r.rb

@@ -2,6 +2,7 @@ require 'mechanize'
 require 'pry'
 
 require 'tf2r/api'
+require 'tf2r/text_helpers'
 require 'tf2r/raffle'
 require 'tf2r/scraper'
 require 'tf2r/version'

data/lib/tf2r/raffle.rb

@@ -3,6 +3,8 @@ module TF2R
   # raffle from the Scraper and API.
   # TODO: make this an actuall wrapper instead of accepting pre-made info.
   class Raffle
+    include TF2R::TextHelpers
+
     attr_reader :link_snippet, :api_info, :scraper_info
 
     def initialize(link_snippet, api_info, scraper_info)
@@ -24,11 +26,21 @@ module TF2R
     end
 
     def participants
-      @api_info['newentry']
+      @normalized_participants ||= normalize_entries(@api_info['newentry'])
     end
 
     private
 
+    def normalize_entries(entries)
+      entries.map do |entry|
+        entry[:steam_id] = extract_steam_id entry.delete('link')
+        entry[:username] = entry.delete('name')
+        entry[:colour] = entry.delete('color').downcase
+        entry[:avatar_link] = entry.delete('avatar')
+      end
+      entries
+    end
+
     def title
       @scraper_info[0][:title]
     end

data/lib/tf2r/scraper.rb

@@ -1,6 +1,8 @@
 module TF2R
   # @author Justin Kim
   class Scraper
+    include TF2R::TextHelpers
+
     class InvalidUserPage < StandardError; end
     # Creates a Scraper. Pass values using the options hash.
     #
@@ -65,11 +67,9 @@ module TF2R
     # @return [Array]
     #   * the raffle Hash from scrape_raffle_for_raffle
     #   * the creator Hash from scrape_raffle_for_creator
-    #   * the participants Array from scrape_raffle_for_participants
     def scrape_raffle(page)
       [scrape_raffle_for_raffle(page),
-       scrape_raffle_for_creator(page),
-       scrape_raffle_for_participants(page)]
+       scrape_raffle_for_creator(page)]
     end
 
     # Scrapes a raffle page for information about the creator.
@@ -156,9 +156,10 @@ module TF2R
        start_time: start_time, end_time: end_time}
     end
 
-    # Scrapes a raffle page for all the participants.
+    # @deprecated Please use {#TF2R::API} instead. The API provides a far more
+    # efficient and reliable method of retrieving the entry list.
     #
-    # TODO: add an example
+    # Scrapes a raffle page for all the participants.
     #
     # @param page [Mechanize::Page] the raffle page.
     # @return [Array] contains Hashes representing each of the participants,
@@ -167,6 +168,8 @@ 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|
@@ -259,29 +262,6 @@ module TF2R
       {name: name, description: description, colour: colour}
     end
 
-    # Extracts a SteamID64 from a TF2R user link.
-    #
-    # @example
-    #   extract_steam_id('http://tf2r.com/user/76561198061719848.html')
-    #     #=> 76561198061719848
-    #
-    # @param href [String] The full user profile link.
-    # @return [Fixnum] The Steam ID.
-    def extract_steam_id(href)
-      /http:\/\/tf2r.com\/user\/(\d+)\.html/.match(href)[1].to_i
-    end
-
-    # Extracts a hex colour code.
-    #
-    # @example
-    #   extract_colour('color:#70B01B;') #=> '70b01b'
-    #
-    # @param href [String] Any string containing a hex colour code.
-    # @return [String] The hex colour code, downcased.
-    def extract_colour(str)
-      /#(\w+)\s*;/.match(str)[1].downcase
-    end
-
     # Extracts the Time from any String.
     #
     # @param [String] a String containing a unix timestamp value.
@@ -298,14 +278,6 @@ module TF2R
       extract_time(td.attribute('data-rsend-unix').to_s)
     end
 
-    # Extract the link_snippet from a path or link.
-    #
-    # @param [String] any raffle link or path.
-    # @return [String] the raffle's link snippet.
-    def extract_link_snippet(text)
-      /\/(k.+)\.html/.match(text)[1]
-    end
-
     # Extract the title from a raffle title string.
     #
     # @param [String] the raffle title string.

data/lib/tf2r/text_helpers.rb

@@ -0,0 +1,34 @@
+module TF2R
+  module TextHelpers
+    # Extracts a hex colour code.
+    #
+    # @example
+    #   extract_colour('color:#70B01B;') #=> '70b01b'
+    #
+    # @param href [String] Any string containing a hex colour code.
+    # @return [String] The hex colour code, downcased.
+    def extract_colour(str)
+      /#(\w+)\s*;/.match(str)[1].downcase
+    end
+
+    # Extract the link_snippet from a path or link.
+    #
+    # @param [String] any raffle link or path.
+    # @return [String] the raffle's link snippet.
+    def extract_link_snippet(text)
+      /\/(k.+)\.html/.match(text)[1]
+    end
+
+    # Extracts a SteamID64 from a TF2R user link.
+    #
+    # @example
+    #   extract_steam_id('http://tf2r.com/user/76561198061719848.html')
+    #     #=> 76561198061719848
+    #
+    # @param href [String] The full user profile link.
+    # @return [Fixnum] The Steam ID.
+    def extract_steam_id(href)
+      /http:\/\/tf2r.com\/user\/(\d+)\.html/.match(href)[1].to_i
+    end
+  end
+end

data/lib/tf2r/version.rb

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

data/spec/scraper_spec.rb

@@ -74,7 +74,6 @@ describe TF2R::Scraper do
     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))
-      expect(result[2]).to eql(scraper.scrape_raffle_for_participants(raffle_page))
     end
   end
 

data/tf2r.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_development_dependency 'cane', '~> 2.6'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'coveralls', '~> 0.7.1'
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'vcr', '~> 2.9'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tf2r
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,7 @@ files:
 - lib/tf2r/api.rb
 - lib/tf2r/raffle.rb
 - lib/tf2r/scraper.rb
+- lib/tf2r/text_helpers.rb
 - lib/tf2r/version.rb
 - spec/raffle_spec.rb
 - spec/raffles.html