xmlstats 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b31c84b7c1f9671819850ab76351b19c8efa673c
-  data.tar.gz: fe6157c6daf19ec7ff3e65f2b492333b820dd707
+  metadata.gz: 7f588cd5dfc99679e6be5ae6d0aa13432a281989
+  data.tar.gz: debca1c193278a183cc0b340fecd1a0b0fa2079c
 SHA512:
-  metadata.gz: 4b4b3a9ceaaa0d3fa8da0a04273196c48e7c37881f85bf1a0f5cc1576a62c440d0e5a70675585cc3cfe5193154954a53f764591832c6ce300f5bab38a91929dc
-  data.tar.gz: f1ba997f1c0905e52620d6ed526fb29cbe0aa1adb10d1a6e46e1dfa5057267df79160775cadeb8d0a64f8b6c397ec33d1fd52b916fd022c7526eea8b8700cb08
+  metadata.gz: a89b5bbddf16bf7572d6f7af4d2df1e3bce9815a0825e01063bfccb718913832aef4d156e554c923515a0a5486d82e72e7e0d3e40ae04d545df36e3ca5c540cc
+  data.tar.gz: d206fcd1c65df6ab74135f74f37f12d8daf4c8db6fb6fd65edc9edcc62922445e8a78c030e975fc28533a730a6e85cc60fdbfbbb68c2d1d1993298a1334a0d73

data/README.md

@@ -1,9 +1,7 @@
 xmlstats-ruby
 =============
 
-A ruby client for xmlstats, an easy to use API for obtaining MLB and NBA statistics in XML or JSON.
-
-See xmlstats here: https://erikberg.com/api
+A ruby client for [xmlstats](https://erikberg.com/api), an easy to use API for obtaining MLB and NBA statistics in XML or JSON.
 
 Installation
 ------------
@@ -166,6 +164,43 @@ Examples
 
 See https://github.com/alexmchale/xmlstats-ruby/tree/master/examples
 
+Troubleshooting
+---------------
+
+### Certificate Error on OSX ###
+
+On OSX you may see the following exception when trying to use xmlstats:
+
+    /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:918:in `connect': SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed (OpenSSL::SSL::SSLError)
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:918:in `block in connect'
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/timeout.rb:52:in `timeout'
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:918:in `connect'
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:862:in `do_start'
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:851:in `start'
+            from /Users/alexmchale/.rbenv-osx/versions/2.0.0-p247/lib/ruby/2.0.0/net/http.rb:1367:in `request'
+            from /Users/alexmchale/src/anticlever/xmlstats/lib/xmlstats/http_getters/net_http.rb:21:in `get'
+            from /Users/alexmchale/src/anticlever/xmlstats/lib/xmlstats/endpoint.rb:41:in `http_get'
+            from /Users/alexmchale/src/anticlever/xmlstats/lib/xmlstats/endpoint.rb:52:in `fetch_json'
+            from /Users/alexmchale/src/anticlever/xmlstats/lib/xmlstats/endpoints/events.rb:8:in `fetch'
+            from /Users/alexmchale/src/anticlever/xmlstats/lib/xmlstats.rb:91:in `events'
+            from test.rb:19:in `<main>'
+
+To get around this, install the curl-ca-bundle in [Homebrew](http://brew.sh):
+
+    [zeus ~/src/anticlever/xmlstats]$ brew install curl-ca-bundle
+    ==> Downloading https://downloads.sourceforge.net/project/machomebrew/mirror/curl-ca-bundle-1.87.tar.bz2
+    ######################################################################## 100.0%
+    ==> Caveats
+    To use these certificates with OpenSSL:
+
+      export SSL_CERT_FILE=/usr/local/opt/curl-ca-bundle/share/ca-bundle.crt
+    ==> Summary
+    🍺  /usr/local/Cellar/curl-ca-bundle/1.87: 2 files, 256K, built in 2 seconds
+
+Finally, add the following to your environment before your application starts:
+
+    export SSL_CERT_FILE=/usr/local/opt/curl-ca-bundle/share/ca-bundle.crt
+
 Contributing
 ------------
 

data/lib/xmlstats/http_getters/net_http.rb

@@ -7,7 +7,7 @@ module Xmlstats
       def get(uri)
         http                     = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl             = true
-        http.verify_mode         = OpenSSL::SSL::VERIFY_NONE
+        http.verify_mode         = OpenSSL::SSL::VERIFY_PEER
         headers                  = {}
         api_key                  = Xmlstats.api_key
         headers["User-Agent"]    = "xmlstats-ruby/#{Xmlstats::VERSION} (#{Xmlstats.contact_info})"

data/lib/xmlstats/version.rb

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

data/lib/xmlstats.rb

@@ -41,82 +41,96 @@ require "xmlstats/endpoints/nba_leaders"
 
 module Xmlstats
 
-  def self.api_key
-    @api_key ||= ENV["XMLSTATS_API_KEY"]
-  end
+  class << self
 
-  def self.api_key= api_key
-    @api_key = api_key
-  end
+    # Manage api key
 
-  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
+    def api_key
+      @api_key ||= ENV["XMLSTATS_API_KEY"]
+    end
 
-  def self.contact_info= contact_info
-    @contact_info = contact_info
-  end
+    def api_key= api_key
+      @api_key = api_key
+    end
 
-  def self.http_getter
-    @http_getter || Xmlstats::HttpGetters::NetHttp.new
-  end
+    # Manage contact info
 
-  def self.http_getter= http_getter
-    @http_getter = http_getter
-  end
+    def 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
 
-  def self.cacher
-    @cacher || Xmlstats::Cachers::Memory.new
-  end
+    def contact_info= contact_info
+      @contact_info = contact_info
+    end
 
-  def self.cacher= cacher
-    @cacher = cacher
-  end
+    # Manage http getter
 
-  def self.events *args
-    Xmlstats::Endpoints::Events.fetch *args
-  end
+    def http_getter
+      @http_getter || Xmlstats::HttpGetters::NetHttp.new
+    end
 
-  def self.mlb_box_score *args
-    Xmlstats::Endpoints::MlbBoxScore.fetch *args
-  end
+    def http_getter= http_getter
+      @http_getter = http_getter
+    end
 
-  def self.nba_box_score *args
-    Xmlstats::Endpoints::NbaBoxScore.fetch *args
-  end
+    # Manage cacher
 
-  def self.mlb_standing *args
-    Xmlstats::Endpoints::MlbStanding.fetch *args
-  end
+    def cacher
+      @cacher || Xmlstats::Cachers::Memory.new
+    end
 
-  def self.nba_standing *args
-    Xmlstats::Endpoints::NbaStanding.fetch *args
-  end
+    def cacher= cacher
+      @cacher = cacher
+    end
 
-  def self.mlb_wild_card_standing *args
-    Xmlstats::Endpoints::MlbWildCardStanding.fetch *args
-  end
+    # Wrapper methods to each endpoint
 
-  def self.mlb_team_results *args
-    Xmlstats::Endpoints::MlbTeamResults.fetch *args
-  end
+    def events *args
+      Xmlstats::Endpoints::Events.fetch *args
+    end
 
-  def self.nba_team_results *args
-    Xmlstats::Endpoints::NbaTeamResults.fetch *args
-  end
+    def mlb_box_score *args
+      Xmlstats::Endpoints::MlbBoxScore.fetch *args
+    end
 
-  def self.mlb_teams *args
-    Xmlstats::Endpoints::MlbTeams.fetch *args
-  end
+    def nba_box_score *args
+      Xmlstats::Endpoints::NbaBoxScore.fetch *args
+    end
 
-  def self.nba_teams *args
-    Xmlstats::Endpoints::NbaTeams.fetch *args
-  end
+    def mlb_standing *args
+      Xmlstats::Endpoints::MlbStanding.fetch *args
+    end
+
+    def nba_standing *args
+      Xmlstats::Endpoints::NbaStanding.fetch *args
+    end
+
+    def mlb_wild_card_standing *args
+      Xmlstats::Endpoints::MlbWildCardStanding.fetch *args
+    end
+
+    def mlb_team_results *args
+      Xmlstats::Endpoints::MlbTeamResults.fetch *args
+    end
+
+    def nba_team_results *args
+      Xmlstats::Endpoints::NbaTeamResults.fetch *args
+    end
+
+    def mlb_teams *args
+      Xmlstats::Endpoints::MlbTeams.fetch *args
+    end
+
+    def nba_teams *args
+      Xmlstats::Endpoints::NbaTeams.fetch *args
+    end
+
+    def nba_leaders *args
+      Xmlstats::Endpoints::NbaLeaders.fetch *args
+    end
 
-  def self.nba_leaders *args
-    Xmlstats::Endpoints::NbaLeaders.fetch *args
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmlstats
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Alex McHale