overwatch_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd7728541afb8148e274b711c92d6d0239481045
+  data.tar.gz: 2cb7aa105c8f04971d4fc28c656f3bc4c81b005b
+SHA512:
+  metadata.gz: 18e01ef4d7b9fd77b9b5a4474622fc340a5bc3d833575876e875250e6126d69470ab0f906d13109a8b79c812091cd2040abc8c331bf747d773f7e789f66ab944
+  data.tar.gz: e22ef14cecfe867a8c95cc6b18179ff249e3bb9e5a61d3b5786913e05fbf27ae1386957a7fa6199a8f84ef9605f10222cea8bc5a877c17e0d58ece1772712134

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.swo
+*.swp
+.DS_Store
+.env
+*.gem
+.byebug_history

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015, 2016 Bryan Mytko
+
+MIT License
+
+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 @@
+![logo](http://i.imgur.com/uHMulGP.jpg)
+
+# OverwatchApi
+
+[![Gem Version](https://badge.fury.io/rb/overwatch_api.svg)](https://badge.fury.io/rb/overwatch_api)
+
+_This is a work in progress, namely because the Overwatch API isn't publicly exposed yet :P_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'overwatch_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install overwatch_api
+
+Create a .env file and add your [API Key]()
+
+    $ touch .env
+
+**In the .env file:**
+
+    OVERWATCH_API_KEY=xxxxxxxxxxxxxxxxxxxx
+
+## Endpoints
+
+All endpoints available via @TODO
+
+1. [Placeholder](#placeholder)
+
+Examples:
+
+#### Placeholder
+
+```ruby
+OverwatchApi::Placeholder.method(arguments)
+
+=> {"Response"=>[],
+    "Data"=>
+      [{"More Data"=>"Value",
+        "Even More Data"=>"Value",
+        [...]
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/overwatch_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Development
+
+    gem build overwatch_api.gemspec
+    gem install ./overwatch_api-0.0.1.gem

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/overwatch_api.rb

@@ -0,0 +1,16 @@
+require "httparty"
+require "dotenv"
+
+Dotenv.load
+
+require "overwatch_api/base_model"
+require "overwatch_api/configuration"
+require "overwatch_api/connection"
+require "overwatch_api/exceptions"
+require "overwatch_api/request"
+require "overwatch_api/version"
+
+module OverwatchApi
+  include HTTParty
+  extend Configuration
+end

data/lib/overwatch_api/base_model.rb

@@ -0,0 +1,21 @@
+module OverwatchApi
+  require "overwatch_api/request"
+
+  class BaseModel
+    class << self
+      include Request
+
+      private
+
+      def endpoint
+        OverwatchApi.endpoint
+      end
+    end
+
+    class ::String
+      def capitalize_all
+        split.map(&:capitalize).join(" ")
+      end
+    end
+  end
+end

data/lib/overwatch_api/configuration.rb

@@ -0,0 +1,22 @@
+module OverwatchApi
+  module Configuration
+    attr_accessor :endpoint
+    attr_accessor :api_key
+
+    DEFAULT_ENDPOINT = "" # @TODO TBD
+    DEFAULT_API_KEY = ENV["OVERWATCH_API_KEY"]
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.endpoint = DEFAULT_ENDPOINT
+      self.api_key = DEFAULT_API_KEY
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/overwatch_api/connection.rb

@@ -0,0 +1,4 @@
+module OverwatchApi
+  module Connection
+  end
+end

data/lib/overwatch_api/exceptions.rb

@@ -0,0 +1,6 @@
+module OverwatchApi
+  class Error < StandardError; end
+  class ResponseError < Error; end
+  class UnsupportedMethodError < Error; end
+  class NoApiKeyError < Error; end
+end

data/lib/overwatch_api/request.rb

@@ -0,0 +1,35 @@
+module OverwatchApi
+  module Request
+    require "uri"
+
+    def get(path, options = {})
+      response = request(:get, path, options)
+      raise OverwatchApi::ResponseError.new(response["message"]) unless response.code == 200
+      return response
+    end
+
+    private
+
+    def headers
+      raise OverwatchApi::NoApiKeyError
+        .new("No API key set.") unless OverwatchApi.api_key
+
+      { "X-Mashape-Key" => OverwatchApi.api_key } # @TODO if not on mashape...
+    end
+
+    def request(method, path, options = {})
+      # @TODO probably only GET requests, but to be determined
+      case method
+      when :get
+        options = { headers: headers, query: options }
+
+        response = OverwatchApi.get(
+          URI.encode(endpoint + path),
+          options
+        )
+      else
+        raise OverwatchApi::UnsupportedMethodError.new
+      end
+    end
+  end
+end

data/lib/overwatch_api/version.rb

@@ -0,0 +1,3 @@
+module OverwatchApi
+  VERSION = "0.1.0"
+end

data/overwatch_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overwatch_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overwatch_api"
+  spec.version       = OverwatchApi::VERSION
+  spec.authors       = ["Bryan Mytko"]
+  spec.email         = ["bryanmytko@gmail.com"]
+  spec.summary       = %q{API Wrapper for overwatchapi.com}
+  spec.description   = <<-EOF
+    A wrapper for the Overwatch API found at https://dev.battle.net/docs
+  EOF
+  spec.homepage      = "https://github.com/bryanmytko/overwatch_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.8"
+  spec.add_development_dependency "byebug", '~> 8.2', '>= 8.2.4'
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "dotenv", "~>2.0"
+end

data/spec/overwatch_api/overwatch_api_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe OverwatchApi do
+  it "is a module" do
+    expect(described_class).to be_a_kind_of(Module)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require "overwatch_api"
+require "rspec"
+require "vcr"
+require "byebug"
+require "dotenv"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/support/vcr_cassettes"
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = false
+  c.default_cassette_options = {:record => :new_episodes}
+end
+
+RSpec.configure do |config|
+  Dotenv.load
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: overwatch_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Mytko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.2.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |2
+      A wrapper for the Overwatch API found at https://dev.battle.net/docs
+email:
+- bryanmytko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/overwatch_api.rb
+- lib/overwatch_api/base_model.rb
+- lib/overwatch_api/configuration.rb
+- lib/overwatch_api/connection.rb
+- lib/overwatch_api/exceptions.rb
+- lib/overwatch_api/request.rb
+- lib/overwatch_api/version.rb
+- overwatch_api.gemspec
+- spec/overwatch_api/overwatch_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bryanmytko/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.4.5.1
+signing_key: 
+specification_version: 4
+summary: API Wrapper for overwatchapi.com
+test_files:
+- spec/overwatch_api/overwatch_api_spec.rb
+- spec/spec_helper.rb