ow_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f3fc3e47de9f4e6a2eb3b2e917180bb85b6b312
+  data.tar.gz: e35762effc844522215b618f4727f42fd6207011
+SHA512:
+  metadata.gz: 9988013fbbca113b3ae36b5e62079ea66e3a52dd089c4e55500389aeecc19d49062b851ce60aa335b923b0c83bf3927c37b2516751833de42c7a1a1fd55ca698
+  data.tar.gz: ae7e55f2d541ac6a09f464cb661b06a732e708b7ad1a4fb8764ff05d43b3e3af26823072aedb89f97d84bdad9d74008ff6e651c783fad13ee217ef326ce0f93a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ow_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,44 @@
+# OwApi
+
+Ruby wrapper for the [OW-API](https://ow-api.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ow_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ow_api
+
+## Usage
+
+```
+require 'ow_api`
+
+client = OwApi.new
+profile = client.profile(platform: 'pc', region: 'us', battletag: 'Asal-1502')
+```
+
+For additional information on the expected arguments, see the [OW-API documenation](https://ow-api.com/docs/).
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[jgayfer]/ow_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "ow_api"
+
+# 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/fixtures/vcr_cassettes/profile.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://ow-api.com/v1/stats/pc/us/Asal-1502/profile
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.14.1
+      Date:
+      - Mon, 07 Jan 2019 04:23:37 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1085'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+    body:
+      encoding: UTF-8
+      string: '{"competitiveStats":{"awards":{"cards":9,"medals":70,"medalsBronze":23,"medalsSilver":23,"medalsGold":24},"games":{"played":28,"won":17}},"endorsement":2,"endorsementIcon":"https://d3hmvhl7ru3t12.cloudfront.net/svg/icons/endorsement-frames-aa182c1f63b51afa951daec63595791283ab97ea3a07f8d47abf9dc7aeda5cc67c786041042de0b8e427194ed084f7cee6b56fa984532199e7ea95bc12bbd995.svg#_2","gamesWon":869,"icon":"https://d15f34w2p8l1cc.cloudfront.net/overwatch/de972a209037f7cadafa6b46130de2e5a87636220a4dea317348d7b3c7ce12e3.png","level":45,"levelIcon":"https://d15f34w2p8l1cc.cloudfront.net/overwatch/888c84f2dfd211cde0c595036574040ca96b1698578daab90ce6822d89f7fe0e.png","name":"Asal#1502","prestige":3,"prestigeIcon":"https://d15f34w2p8l1cc.cloudfront.net/overwatch/888c84f2dfd211cde0c595036574040ca96b1698578daab90ce6822d89f7fe0e.png","private":false,"quickPlayStats":{"awards":{"cards":284,"medals":1676,"medalsBronze":482,"medalsSilver":549,"medalsGold":645},"games":{"played":0,"won":362}},"rating":2390,"ratingIcon":"https://d1u1mce87gyfbn.cloudfront.net/game/rank-icons/rank-GoldTier.png"}'
+    http_version: 
+  recorded_at: Mon, 07 Jan 2019 04:23:37 GMT
+recorded_with: VCR 4.0.0

data/lib/ow_api/client/profile.rb

@@ -0,0 +1,12 @@
+require 'ow_api/response/profile'
+
+module OwApi
+  class Client
+    module Profile
+      def profile(platform:, region:, battletag:)
+        response = get("stats/#{platform}/#{region}/#{battletag}/profile")
+        handle_response(response, Response::Profile)
+      end
+    end
+  end
+end

data/lib/ow_api/client.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'open-uri'
+
+require 'ow_api/client/profile'
+require 'ow_api/interactors/hash_keys_to_snake_case'
+
+module OwApi
+  class Client
+    include Profile
+
+    BASE_URL = 'https://ow-api.com'
+
+    private
+
+    def get(path)
+      URI.parse("#{BASE_URL}/v1/#{path}").read
+    end
+
+    def handle_response(response, klass)
+      json_response = JSON.parse(response)
+      snake_case_response = Interactors::HashKeysToSnakeCase.new.call(json_response)
+      klass.new(snake_case_response)
+    end
+  end
+end

data/lib/ow_api/interactors/hash_keys_to_snake_case.rb

@@ -0,0 +1,32 @@
+module OwApi
+  module Interactors
+    class HashKeysToSnakeCase
+      def call(hash)
+        convert_hash_keys(hash)
+      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(key)
+        key.
+          to_s.
+          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/ow_api/response/base.rb

@@ -0,0 +1,20 @@
+module OwApi
+  module Response
+    class Base
+      attr_reader :attrs
+      alias to_h attrs
+
+      class << self
+        def attr_reader(*attrs)
+          attrs.each do |attr|
+            define_method(attr) { @attrs && @attrs[attr.to_s] }
+          end
+        end
+      end
+
+      def initialize(attrs = {})
+        @attrs = attrs
+      end
+    end
+  end
+end

data/lib/ow_api/response/profile.rb

@@ -0,0 +1,11 @@
+require 'ow_api/response/base'
+
+module OwApi
+  module Response
+    class Profile < Base
+      attr_reader :icon, :name, :level, :level_icon, :prestige, :prestige_icon,
+        :rating, :rating_icon, :games_won, :private, :endorsement_icon,
+        :endorsement
+    end
+  end
+end

data/lib/ow_api/version.rb

@@ -0,0 +1,3 @@
+module OwApi
+  VERSION = "0.1.1"
+end

data/lib/ow_api.rb

@@ -0,0 +1,10 @@
+require 'ow_api/version'
+require 'ow_api/client'
+
+module OwApi
+  class << self
+    def new
+      Client.new
+    end
+  end
+end

data/ow_api.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ow_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ow_api"
+  spec.version       = OwApi::VERSION
+  spec.authors       = ["James Gayfer"]
+  spec.email         = ["gayfer.james@gmail.com"]
+
+  spec.summary       = "A Ruby client to consume the OW-API (https://ow-api.com/)"
+  spec.homepage      = "https://github.com/jgayfer/overwatch-api"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.5"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ow_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- James Gayfer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- gayfer.james@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/profile.yml
+- lib/ow_api.rb
+- lib/ow_api/client.rb
+- lib/ow_api/client/profile.rb
+- lib/ow_api/interactors/hash_keys_to_snake_case.rb
+- lib/ow_api/response/base.rb
+- lib/ow_api/response/profile.rb
+- lib/ow_api/version.rb
+- ow_api.gemspec
+homepage: https://github.com/jgayfer/overwatch-api
+licenses:
+- MIT
+metadata: {}
+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.3
+signing_key: 
+specification_version: 4
+summary: A Ruby client to consume the OW-API (https://ow-api.com/)
+test_files: []