mysportsfeeds-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4088910e542a2221ee24cb5b57d2ae99d3a3720b
+  data.tar.gz: 3c886b43fed4f6c550d2508d3990e45a396c219b
+SHA512:
+  metadata.gz: ee6cef774e07efe209514ea4b5ccad87bb90a64893c667933d3a3dd04c3703d04cd2d90b9d3d79f6a24ca7aeea36510d3eae4b3a08f6798359f6d1675ff09db4
+  data.tar.gz: 4c1694de7bccccf7aa59e727b3f03ae1ce7e81b5a3079b293246caf0c7c9899d2200394c9e71bef9c5e968fe1b465d548df2c8e7e6fda0c039659de6239ad69a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mysportsfeeds-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2012-2017 MySportsFeeds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,8 @@
+# mysportsfeeds-ruby
+
+MySportsFeeds Ruby Gem brought to you by [@MySportsFeeds](https://twitter.com/MySportsFeeds).
+
+Makes use of the [MySportsFeeds API](https://www.mysportsfeeds.com) - a flexible, developer-friendly Sports Data API.
+
+Free for Non-Commercial Use.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysportsfeeds/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mysportsfeeds.rb

@@ -0,0 +1,55 @@
+require "mysportsfeeds/api/API_v1_0"
+
+### Main class for all interaction with the MySportsFeeds API
+class MySportsFeeds
+
+    # Constructor
+    def initialize(version='1.0', verbose=False, store_type='file', store_location='results/')
+        __verify_version(version)
+        __verify_store(store_type, store_location)
+
+        @version = version
+        @verbose = verbose
+        @store_type = store_type
+        @store_location = store_location
+
+        # Instantiate an instance of the appropriate API depending on version
+        if @version == '1.0'
+            @api_instance = Mysportsfeeds::Api::API_v1_0.new(@verbose, @store_type, @store_location)
+        end
+    end
+
+    # Make sure the version is supported
+    def __verify_version(version)
+        if version != '1.0'
+            raise Exception.new("Unrecognized version specified.  Supported versions are: '1.0'")
+        end
+    end
+
+    # Verify the type and location of the stored data
+    def __verify_store(store_type, store_location)
+        if !store_type.nil? and store_type != 'file'
+            raiseException.new("Unrecognized storage type specified.  Supported values are: nil,'file'")
+        end
+
+        if store_type == 'file'
+            if store_location.nil?
+                raise Exception.new("Must specify a location for stored data.")
+        	end
+        end
+    end
+
+    # Authenticate against the API (for v1.0)
+    def authenticate(username, password)
+        if !@api_instance.supports_basic_auth()
+            raise Exception.new("BASIC authentication not supported for version " + @version)
+        end
+
+        @api_instance.set_auth_credentials(username, password)
+    end
+
+    # Request data (and store it if applicable)
+    def msf_get_data(league, season, feed, output_format, *kwargs)
+        return @api_instance.get_data(league, season, feed, output_format, kwargs)
+    end
+end

data/lib/mysportsfeeds/api/API_v1_0.rb

@@ -0,0 +1,251 @@
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'json'
+require 'fileutils'
+
+require 'mysportsfeeds/version'
+
+module Mysportsfeeds
+    module Api
+        # API class for dealing with v1.0 of the API
+        class API_v1_0
+
+            # Constructor
+            def initialize(verbose, store_type=nil, store_location=nil)
+                @base_uri = URI("https://www.mysportsfeeds.com/api/feed/pull")
+                @headers = {
+                    "Accept-Encoding" => "gzip",
+                    "User-Agent" => "MySportsFeeds Ruby/#{Mysportsfeeds::Ruby::VERSION} (#{RUBY_PLATFORM})"
+                }
+
+                @verbose = verbose
+                @store_type = store_type
+                @store_location = store_location
+
+                @valid_feeds = [
+                    'current_season',
+                    'cumulative_player_stats',
+                    'full_game_schedule',
+                    'daily_game_schedule',
+                    'daily_player_stats',
+                    'game_playbyplay',
+                    'game_boxscore',
+                    'scoreboard',
+                    'player_gamelogs',
+                    'team_gamelogs',
+                    'roster_players',
+                    'game_startinglineup',
+                    'active_players',
+                    'player_injuries',
+                    'latest_updates',
+                    'daily_dfs',
+                    'overall_team_standings',
+                    'conference_team_standings',
+                    'division_team_standings',
+                    'playoff_team_standings'
+                ]
+            end
+
+            # Verify a feed
+            def __verify_feed_name(feed)
+                is_valid = false
+
+                for value in @valid_feeds
+                    if value == feed
+                        is_valid = true
+                        break
+                    end
+                end
+
+                return is_valid
+            end
+
+            # Verify output format
+            def __verify_format(format)
+                is_valid = true
+
+                if format != 'json' and format != 'xml' and format != 'csv'
+                    is_valid = false
+                end
+
+                return is_valid
+            end
+
+            # Feed URL (with only a league specified)
+            def __league_only_url(league, feed, output_format, params)
+                url "#{@base_uri.to_s}/#{league}/#{feed}.#{output_format}"
+
+                delim = "?"
+                params.each do |key, value|
+                    url << delim << key << "=" << value
+                    delim = "&"
+                end
+
+                return url
+            end
+
+            # Feed URL (with league + season specified)
+            def __league_and_season_url(league, season, feed, output_format, params)
+                url = "#{@base_uri.to_s}/#{league}/#{season}/#{feed}.#{output_format}"
+
+                delim = "?"
+                params.each do |key, value|
+                    url << delim << key << "=" << value
+                    delim = "&"
+                end
+
+                return url
+            end
+
+            # Generate the appropriate filename for a feed request
+            def __make_output_filename(league, season, feed, output_format, params)
+                filename = "#{feed}-#{league.downcase}-#{season}"
+
+                if params.key?("gameid")
+                    filename << "-" << params["gameid"]
+                end
+
+                if params.key?("fordate")
+                    filename << "-" << params["fordate"]
+                end
+
+                filename << "." << output_format
+
+                return filename
+            end
+
+            # Save a feed response based on the store_type
+            def __save_feed(response, league, season, feed, output_format, params)
+                # Save to memory regardless of selected method
+                if output_format == "json"
+                    store_output = JSON.parse(response)
+                elsif output_format == "xml"
+                    store_output = response
+                elsif output_format == "csv"
+                    store_output = response
+                end
+
+                if @store_type == "file"
+                    if !File.exist?(@store_location)
+                        FileUtils::mkdir_p(@store_location)
+                    end
+
+                    filename = __make_output_filename(league, season, feed, output_format, params)
+
+                    outfile = File.open(@store_location + filename, "w")
+                    if output_format == "json"  # This is JSON
+                        json_out = response.to_json.gsub('\\', '').strip
+                        outfile.write(json_out[1..json_out.size-2])
+
+                    elsif output_format == "xml"  # This is xml
+                        outfile.write(store_output)
+
+                    elsif output_format == "csv"  # This is csv
+                        outfile.write(store_output)
+
+                    else
+                        raise Exception.new("Could not interpret feed output format")
+                    end
+                end
+            end
+
+            # Indicate this version does support BASIC auth
+            def supports_basic_auth()
+                return true
+            end
+
+            # Establish BASIC auth credentials
+            def set_auth_credentials(username, password)
+                @auth = {"username" => username, "password" => password}
+            end
+
+            # Request data (and store it if applicable)
+            def get_data(league, season, feed, output_format, kwargs)
+                if !@auth
+                    raise Exception.new("You must authenticate() before making requests.")
+                end
+
+                # establish defaults for all variables
+                params = {}
+
+                # add force=false parameter (helps prevent unnecessary bandwidth use)
+                kwargs.each do |kwarg|
+                    kwarg.each do |key, value|
+                        params[key] = value
+                    end
+                end
+
+                if !params.key?("force")
+                    params['force'] = 'false'
+                end
+
+                if __verify_feed_name(feed) == false
+                    raise Exception.new("Unknown feed '" + feed + "'.")
+                end
+
+                if __verify_format(output_format) == false
+                    raise Exception.new("Unsupported format '" + output_format + "'.")
+                end
+
+                if feed == 'current_season'
+                    url = __league_only_url(league, feed, output_format, params)
+                else
+                    url = __league_and_season_url(league, season, feed, output_format, params)
+                end
+
+                if @verbose
+                    puts "Making API request to '#{url}'."
+                    puts "  with headers:"
+                    puts @headers
+                end
+
+                http = Net::HTTP.new(@base_uri.host, @base_uri.port)
+                http.use_ssl = true
+                http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+                request = Net::HTTP::Get.new(url)
+                request.basic_auth(@auth["username"], @auth["password"])
+
+                r = http.request(request)
+                if @verbose
+                    puts "response = #{r}"
+                end
+
+                if r.code == "200"
+                    if @store_type != nil
+                        __save_feed(r.body, league, season, feed, output_format, params)
+                    end
+
+                    if output_format == "json"
+                        data = JSON.parse(r.body)
+                    elsif output_format == "xml"
+                        data = r.body
+                    else
+                        data = r.body
+                    end
+
+                elsif r.code == "304"
+                    if @verbose
+                        puts "Data hasn't changed since last call"
+                    end
+
+                    filename = __make_output_filename(league, season, feed, output_format, params)
+
+                    f = File.read(@store_location + filename)
+                    if output_format == "json"
+                        data = JSON.parse(f)
+                    elsif output_format == "xml"
+                        data = f
+                    else
+                        data = f
+                    end
+
+                else
+                    puts "API call failed with error: #{r.code}"
+                end
+
+                return data
+            end
+        end
+    end
+end

data/lib/mysportsfeeds/version.rb

@@ -0,0 +1,5 @@
+module Mysportsfeeds
+	module Ruby
+		VERSION = "0.1.0".freeze
+	end
+end

data/mysportsfeeds-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mysportsfeeds/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysportsfeeds-ruby"
+  spec.version       = Mysportsfeeds::Ruby::VERSION
+  spec.authors       = ["MySportsFeeds", "Brad Barkhouse"]
+  spec.email         = ["brad.barkhouse@mysportsfeeds.com"]
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.summary       = "MySportsFeeds API Ruby Client"
+  spec.description   = "Easily retrieve sports data from the MySportsFeeds API"
+  spec.homepage      = "https://github.com/MySportsFeeds/mysportsfeeds-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+#  spec.add_runtime_dependency "fileutils", "~> 0.7"
+#  spec.add_runtime_dependency "json", "~> 2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: mysportsfeeds-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MySportsFeeds
+- Brad Barkhouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Easily retrieve sports data from the MySportsFeeds API
+email:
+- brad.barkhouse@mysportsfeeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mysportsfeeds.rb
+- lib/mysportsfeeds/api/API_v1_0.rb
+- lib/mysportsfeeds/version.rb
+- mysportsfeeds-ruby.gemspec
+homepage: https://github.com/MySportsFeeds/mysportsfeeds-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: MySportsFeeds API Ruby Client
+test_files: []