xmlstats 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5be7411c6d2ad7bae23b819c9f14fb8cb166008d
-  data.tar.gz: 9f5b9b1155487f6117310bfde1058d5fab94ab19
+  metadata.gz: b31c84b7c1f9671819850ab76351b19c8efa673c
+  data.tar.gz: fe6157c6daf19ec7ff3e65f2b492333b820dd707
 SHA512:
-  metadata.gz: 94ff895441f09658c3a073f4628174c5f4eecdf055f9f7579de14fa95a9d7edc5cbe0844af9c8844dce8a781fa6a0600575fa6646a96263ade9d4619c043d07e
-  data.tar.gz: 531d4f81ef5adb8f90b415ebf83b9565fef91139bdd64fa9a2a96911aef05aab70f1784fdd7ab41e29282d44036de91830dec7119dbafb5bf2cf38b5212ef405
+  metadata.gz: 4b4b3a9ceaaa0d3fa8da0a04273196c48e7c37881f85bf1a0f5cc1576a62c440d0e5a70675585cc3cfe5193154954a53f764591832c6ce300f5bab38a91929dc
+  data.tar.gz: f1ba997f1c0905e52620d6ed526fb29cbe0aa1adb10d1a6e46e1dfa5057267df79160775cadeb8d0a64f8b6c397ec33d1fd52b916fd022c7526eea8b8700cb08

data/README.md

@@ -26,6 +26,13 @@ Configuration
 Configure xmlstats-ruby as follows with your API key and contact info. The
 contact info is used in the User-Agent string.
 
+You can choose to set this via environment variables:
+
+    export XMLSTATS_API_KEY="my api key"
+    export XMLSTATS_CONTACT_INFO="alex@anticlever.com"
+
+Or in Ruby:
+
     Xmlstats.api_key = "my api key"
     Xmlstats.contact_info = "alex@anticlever.com"
 
@@ -39,6 +46,11 @@ The cacher can be any object which responds to the get(key) and set(key, value)
 methods. The Redis cacher will automatically expire keys after 1 hour. The
 memory cacher never expires keys.
 
+The Redis cacher can accept a hash for options which will be passed to
+Redis.new, or a previously instantiated Redis object. Note that this gem does
+not depend on the redis gem, so you will need to add that as your own
+dependency if you choose to use that cacher.
+
 Usage
 -----
 

data/examples/events_today.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "xmlstats"
+require "date"
+
+Xmlstats.api_key      = ENV["XMLSTATS_API_KEY"]
+Xmlstats.contact_info = ENV["XMLSTATS_CONTACT_INFO"] || "alex@anticlever.com"
+
+date = Date.today
+
+printf("Events on %s\n\n", date.strftime("%A, %B %e, %Y"));
+printf("%-35s %5s %34s\n", "Time", "Event", "Status");
+
+Xmlstats.events(date).each do |event|
+  printf("%-12s %24s vs. %-24s %9s\n",
+    event.start_date_time.strftime("%l:%M %p"),
+    event.away_team.full_name,
+    event.home_team.full_name,
+    event.event_status)
+end

data/lib/xmlstats/version.rb

@@ -1,3 +1,3 @@
 module Xmlstats
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/xmlstats.rb

@@ -42,7 +42,7 @@ require "xmlstats/endpoints/nba_leaders"
 module Xmlstats
 
   def self.api_key
-    @api_key
+    @api_key ||= ENV["XMLSTATS_API_KEY"]
   end
 
   def self.api_key= api_key
@@ -51,6 +51,7 @@ module Xmlstats
 
   def self.contact_info
     error = "specify user-agent contact info with: Xmlstats.contact_info = 'you@example.com'"
+    @contact_info ||= ENV["XMLSTATS_CONTACT_INFO"]
     @contact_info or raise(error)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlstats
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alex McHale
@@ -50,6 +50,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/events_today.rb
 - lib/xmlstats.rb
 - lib/xmlstats/cachers/memory.rb
 - lib/xmlstats/cachers/redis.rb