overwatch_league 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa49ef54153776b3eb7ff02c1141999242842db7
+  data.tar.gz: dca207c46b26d78c6eb03eed06efebc9520b241d
+SHA512:
+  metadata.gz: cca08bac209d2edf669f696670567713a8cb52c42bd6a1a90afce778d674b23b6b96768b432cc052b1651b5ea5c875ebdade36b523a52c36ed7052bbd64b7633
+  data.tar.gz: c4a582e5b3c6e0c2ecd1d043e70278b72122318ce2696f77ffb235413fe121675cac8b589714527a762a12d320ed3afd7536322816ff9528cd62070e7ada9780

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,17 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=2bec143035c2451c97f1c1761c9be318546d69de3706a797410f57b5deaf3186
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2
+notifications:
+  - false
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+scripts:
+  - bundle exec rspec spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2018-04-02
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 James Gayfer
+
+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,65 @@
+[![Gem Version](https://badge.fury.io/rb/overwatch_league.svg)](https://badge.fury.io/rb/overwatch_league)
+[![Build Status](https://travis-ci.org/jgayfer/overwatch_league.svg?branch=master)](https://travis-ci.org/jgayfer/overwatch_league)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/398b860d65874c9ea715/test_coverage)](https://codeclimate.com/github/jgayfer/overwatch_league/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/398b860d65874c9ea715/maintainability)](https://codeclimate.com/github/jgayfer/overwatch_league/maintainability)
+
+# Overwatch League
+
+A Ruby wrapper around the Overwatch League API
+
+## Installation
+    $ gem install overwatch_league
+
+## Basic Example
+
+```
+require 'overwatch_league'
+
+owl = OverwatchLeague.new
+teams = owl.teams
+```
+
+## Usage
+
+There is no official documentation for the API. However, [this Reddit post](https://www.reddit.com/r/Competitiveoverwatch/comments/7p0e8d/owl_api_analysis/) documents the API reasonably well.
+
+The following methods are supported as part of the basic client.
+
+> `teams`
+
+> `team(team_id)`
+
+> `ranking`
+
+> `standings`
+
+> `matches`
+
+> `match(match_id)`
+
+> `schedule`
+
+> `streams`
+
+> `vods`
+
+> `maps`
+
+> `news`
+
+> `videos`
+
+Rather than just returning a JSON `Hash`, each method returns an `OpenStruct` representation of the JSON where the keys have been converted to snake case. This is done for convenience, as it allows for `object.key.another_key` instead of `object['key']['another_key']` when parsing the response.
+
+## Development & Contributions
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgayfer/overwatch_league.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "overwatch_league"
+
+# 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

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/overwatch_league.rb

@@ -0,0 +1,15 @@
+require_relative "overwatch_league/version"
+require_relative "overwatch_league/url"
+require_relative "overwatch_league/request"
+require_relative "overwatch_league/api"
+require_relative "overwatch_league/response_error"
+require_relative "overwatch_league/client"
+require_relative "overwatch_league/build_response"
+
+module OverwatchLeague
+  class << self
+    def new
+      Client.new
+    end
+  end
+end

data/lib/overwatch_league/api.rb

@@ -0,0 +1,65 @@
+require_relative 'request'
+require_relative 'response_error'
+require_relative 'build_response'
+
+module OverwatchLeague
+  module API
+    BASE_URL = 'https://api.overwatchleague.com'
+    HTTP_OK = 200
+
+    def teams
+      handle_response(Request.get(URL.new("#{BASE_URL}/teams")))
+    end
+
+    def team(team_id)
+      handle_response(Request.get(URL.new("#{BASE_URL}/teams/#{team_id}")))
+    end
+
+    def ranking
+      handle_response(Request.get(URL.new("#{BASE_URL}/ranking")))
+    end
+
+    def standings
+      handle_response(Request.get(URL.new("#{BASE_URL}/standings")))
+    end
+
+    def matches
+      handle_response(Request.get(URL.new("#{BASE_URL}/matches")))
+    end
+
+    def match(match_id)
+      handle_response(Request.get(URL.new("#{BASE_URL}/matches/#{match_id}")))
+    end
+
+    def schedule
+      handle_response(Request.get(URL.new("#{BASE_URL}/schedule")))
+    end
+
+    def streams
+      handle_response(Request.get(URL.new("#{BASE_URL}/streams")))
+    end
+
+    def vods
+      handle_response(Request.get(URL.new("#{BASE_URL}/vods")))
+    end
+
+    def maps
+      handle_response(Request.get(URL.new("#{BASE_URL}/maps")))
+    end
+
+    def news
+      handle_response(Request.get(URL.new("#{BASE_URL}/news")))
+    end
+
+    def videos
+      handle_response(Request.get(URL.new("#{BASE_URL}/playlist/owl-app-playlist")))
+    end
+
+    private
+
+    def handle_response(response)
+      raise ResponseError.new(response) unless response.code == HTTP_OK
+      BuildResponse.(response)
+    end
+  end
+end

data/lib/overwatch_league/build_response.rb

@@ -0,0 +1,35 @@
+module OverwatchLeague
+  module BuildResponse
+    class << self
+      def call(response)
+        snake_case_json_string = convert_hash_keys(JSON.parse(response.body.to_s)).to_json
+        JSON.parse(snake_case_json_string, object_class: OpenStruct)
+      end
+
+      private
+
+      def convert_hash_keys(value)
+        case value
+          when Array
+            value.map { |v| convert_hash_keys(v) }
+          when Hash
+            Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] }]
+          else
+            value
+         end
+      end
+  
+      def underscore_key(k)
+        to_snake_case(k.to_s)
+      end
+  
+      def to_snake_case(string)
+        string.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+  end
+end

data/lib/overwatch_league/client.rb

@@ -0,0 +1,7 @@
+module OverwatchLeague
+  class Client
+    include OverwatchLeague::API
+
+    def initialize; end
+  end
+end

data/lib/overwatch_league/request.rb

@@ -0,0 +1,11 @@
+require 'http'
+
+module OverwatchLeague
+  module Request
+    class << self
+      def get(url)
+        HTTP.get(url.to_str)
+      end
+    end
+  end
+end

data/lib/overwatch_league/response_error.rb

@@ -0,0 +1,10 @@
+module OverwatchLeague
+  class ResponseError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super("#{response.code}: #{response.body}")
+    end
+  end
+end

data/lib/overwatch_league/url.rb

@@ -0,0 +1,17 @@
+require 'net/http'
+
+module OverwatchLeague
+  class URL
+    def initialize(path, params: {})
+      @path = path
+      @params = params
+    end
+
+    def to_str
+      String.new.tap do |url|
+        url << @path
+        url << '?' + URI.encode_www_form(@params) unless @params.empty?
+      end
+    end
+  end
+end

data/lib/overwatch_league/version.rb

@@ -0,0 +1,3 @@
+module OverwatchLeague
+  VERSION = "1.0.0"
+end

data/overwatch_league.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overwatch_league/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overwatch_league"
+  spec.version       = OverwatchLeague::VERSION
+  spec.authors       = ["James Gayfer"]
+  spec.email         = ["gayfer.james@gmail.com"]
+
+  spec.summary       = 'Ruby wrapper for the Overwatch League API'
+  spec.description   = 'Ruby wrapper for the Overwatch League API'
+  spec.homepage      = 'http://www.github.com/jgayfer/overwatch_league'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+  spec.add_dependency "http", "~> 3.0"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: overwatch_league
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Gayfer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for the Overwatch League API
+email:
+- gayfer.james@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/overwatch_league.rb
+- lib/overwatch_league/api.rb
+- lib/overwatch_league/build_response.rb
+- lib/overwatch_league/client.rb
+- lib/overwatch_league/request.rb
+- lib/overwatch_league/response_error.rb
+- lib/overwatch_league/url.rb
+- lib/overwatch_league/version.rb
+- overwatch_league.gemspec
+homepage: http://www.github.com/jgayfer/overwatch_league
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Overwatch League API
+test_files: []