srl-api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129f173ed7e75ec70eb66b7582d56135d59aa1ac
-  data.tar.gz: f4b0e43b26a8517314aea1d7d251592ebe01056f
+  metadata.gz: 70a7c1a020ccd31a7c8b88363cf9bda2643d825b
+  data.tar.gz: 1d00bca316857d5e38ae19181d9634b7123b4621
 SHA512:
-  metadata.gz: f397545db33cf4277bb85431c6229d3e600d19741ef7dbdb4d83b930bd2e4695837fa42fe11bc44cc31f2fdd02e73d9f5ea36be2221172427fafbe526a74d9ae
-  data.tar.gz: 3f5e031e123c04e7d32b3273a15b8d050e35945ac866cefbc159f520a8e5ff5a3389ebcab001c14bef13e3b1f22237b2849e7e40b26229500d68117695f38412
+  metadata.gz: d162b873960d5b3da920b5e00f4cd84a8573564edc5fb80c23771bb58644b1f274c610f99f6cef700c6d4932aced7076b2d8da50eb1c6014ce66ffaf7f6c8c85
+  data.tar.gz: 15c69d309ed6ab202726aaedc592755614a6112c2bd0d43ac870e757f605bf2417a567b12d653ea8e7b014e1aae04027ef9bb15740db03366f846c001a3193c1

data/README.md

@@ -43,3 +43,14 @@ will not.
 ## Maintainer
 
 Brian Edmonds "Artea" <[brian@bedmonds.net](mailto:brian@bedmonds.net)>
+
+## Disclaimer
+
+I am not affiliated in any way with SpeedRunsLive.com; I'm just a runner 
+and viewer that likes the convenience of CLI tools. I wrote this small
+library for myself and my tools, but thought other people might like to
+use it as well.
+
+Do try to not be a twat; servers and bandwidth cost money, so don't go 
+around writing a cron job that requests outrageous amounts of data every
+five seconds.

data/lib/srl.rb

@@ -2,7 +2,7 @@ require_relative 'srl/api'
 
 module SRL
   # The current version of srl-api.
-  RELEASE = '0.4.0'.freeze
+  RELEASE = '0.4.1'.freeze
 
   # Return the current release version as a dotted string.
   def self.release

data/lib/srl/api.rb

@@ -11,6 +11,7 @@ require 'srl/unmarshalable'
 require 'srl/game'
 require 'srl/past_race'
 require 'srl/player'
+require 'srl/query'
 require 'srl/race'
 require 'srl/result_set'
 
@@ -61,15 +62,30 @@ module SRL
 
     # Return an array of PastRace objects for completed races.
     #
-    # call-seq: current_races -> array
+    # You may filter the results by providing a `player` or `game`
+    # argument, to limit results to a specific player or game 
+    # abbreviation.
+    #
+    #   # To fetch only the six million LTTP Rando races.
+    #   completed_races(game: 'alttphacks') 
+    #
+    #   # To only retrieve Edgeworth's FF Randomizer races.
+    #   completed_races(player: 'Edgeworth', game: 'ffhacks') 
+    #
+    # Results are paginated at `page_size` records per page, 
+    # starting at 1. An upper limit to this number has not
+    # been tested, though I'd recommend that you not be a twat 
+    # and limit your requests to something that will not murder
+    # the server.
+    #
+    # call-seq: current_races -> obj
     def completed_races(args = {})
-      res = query('pastraces', rewrite_args(args))
-      ResultSet.new(
-        SRL::Utils.collection(res.fetch('pastraces'), PastRace),
-        count: res.fetch('count'),
-        page: args.fetch(:page, 1),
-        page_size: args.fetch(:pageSize, 25)
-      )
+      query =
+        Query.new('pastraces', PastRace, args.merge({ pkey: 'pastraces' })) 
+
+      return query.page unless block_given?
+
+      yield query
     end
     alias past_races completed_races
 
@@ -87,14 +103,9 @@ module SRL
       raise NetworkError, res unless res.is_a?(Net::HTTPSuccess)
 
       JSON.parse(res.body)
-    end
-
-    # Alias camelCase argument names to snake_case. :nodoc:
-    def rewrite_args(args)
-      { pageSize: args.fetch(:page_size, 25) }.merge(args)
-    end
-
+    end 
   end
+
   # Raised when an HTTP request to the SRL API server fails,
   # whether due to a malformed request or the server being down.
   #

data/lib/srl/query.rb

@@ -0,0 +1,62 @@
+module SRL
+  class Query # :nodoc:
+    def initialize(url, klass, args = {})
+      @url = url
+      @klass = klass
+      @args = rewrite_args(args)
+
+      @page = @args.fetch(:page, 1)
+      @per_page = @args.fetch(:pageSize, 20)
+    end
+
+    def each_page
+      return enum_for(:each_page) unless block_given?
+
+      loop do
+        res = fetch_page
+        break if res.records.empty?
+
+        yield res.records
+
+        break if res.last_page?
+      end
+    end
+    alias each each_page
+
+    def page
+      fetch_page
+    end
+
+    private
+
+    # Return a hash with the results of a query to the SRL API. :nodoc:
+    def fetch_page
+      url = URI([API, @url].join) # *hiss* "URI" has been wrong for years!
+
+      unless @args.empty?
+        url.query = URI.encode_www_form(@args.merge({ page: @page }))
+      end
+
+      res = Net::HTTP.get_response(url)
+      raise SRL::NetworkError, res unless res.is_a?(Net::HTTPSuccess)
+
+      data = JSON.parse(res.body)
+      @page += 1
+
+      ResultSet.new(
+        SRL::Utils.collection(data.fetch(@args[:pkey]), @klass),
+        count: data.fetch('count', data.fetch(@args[:pkey]).size),
+        page: (@page - 1),
+        page_size: @args.fetch(:pageSize, 25)
+      )
+    end
+
+    # SpeedRunsLive API URL. :nodoc:
+    API = 'http://api.speedrunslive.com/'.freeze
+
+    # Alias camelCase argument names to snake_case. :nodoc:
+    def rewrite_args(args)
+      { pageSize: args.fetch(:page_size, 25) }.merge(args)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: srl-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Brian 'Artea' Edmonds
@@ -68,6 +68,7 @@ files:
 - lib/srl/game.rb
 - lib/srl/past_race.rb
 - lib/srl/player.rb
+- lib/srl/query.rb
 - lib/srl/race.rb
 - lib/srl/result_set.rb
 - lib/srl/unmarshalable.rb