brawlhalla-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d4bbe6c465cb45317a9023e74f13261a95e6395a76b4b271aa5094de579217c
+  data.tar.gz: 7be550a6cc30bb13939b4672b15d3914ffbc912adee42663f54fa46f7a97714b
+SHA512:
+  metadata.gz: a850591ba67b7bb19f84658d85b5ecafd9dff7ba6910ccd143d9b7e7672d7b17782019f62186cc27f3585472b375de33171608be457bbb45fe5e9f65e8967e39
+  data.tar.gz: 0e2d2b4b4dac96302e51bc157861df87150d4cb95349f34343d98b018f9b5a28d4f8ff73c82cbacb68f5c0abf3f07474bd7770e01604468c0efce88c792036dc

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5.3
+
+# Don't force top level comments in every class
+Style/Documentation:
+  Enabled: false
+
+# This doesn't work on old Ruby versions
+Style/ExpandPathArguments:
+  Enabled: false
+
+# A good line length is 100 chars
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 30
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.10
+  - 2.3.7
+  - 2.4.4
+  - 2.5.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 rikas
+
+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,39 @@
+# Brawlhalla::Api
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/brawlhalla/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brawlhalla-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brawlhalla-api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/brawlhalla-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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :rubocop do
+  sh 'rubocop --format simple || true'
+end
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'brawlhalla/api'
+
+require 'dotenv'
+Dotenv.load
+
+bh = Brawlhalla::API::Client.new(ENV['API_KEY'])
+
+require 'pry'
+Pry.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/brawlhalla-api.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'brawlhalla/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'brawlhalla-api'
+  spec.version       = Brawlhalla::API::VERSION
+  spec.authors       = ['rikas']
+  spec.email         = ['oterosantos@gmail.com']
+
+  spec.summary       = 'Brawlhalla API Ruby wrapper'
+  spec.description   = 'Brawlhalla API Ruby wrapper'
+  spec.homepage      = 'https://github.com/rikas/brawlhalla-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_dependency 'addressable'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/brawlhalla/api/client.rb

@@ -0,0 +1,65 @@
+module Brawlhalla
+  module API
+    class Client
+      BASE_URL = 'https://api.brawlhalla.com'
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      # Search player by Steam ID.
+      #
+      # === Example
+      #   bh = Brawlhalla::API::Client.new(YOUR_API_KEY_HERE)
+      #   bh.search(76561198048321884)
+      def search(steamid)
+        request(
+          path: 'search',
+          params: { steamid: steamid }
+        )
+      end
+
+      # Get player stats by giving the Brawlhalla ID.
+      #
+      # === Example
+      #   bh = Brawlhalla::API::Client.new(YOUR_API_KEY_HERE)
+      #   bh.stats(8817417)
+      def stats(brawlhalla_id)
+        request(path: "player/#{brawlhalla_id}/stats")
+      end
+
+      # Get player ranked stats by giving the Brawlhalla ID.
+      #
+      # === Example
+      #   bh = Brawlhalla::API::Client.new(YOUR_API_KEY_HERE)
+      #   bh.ranked_stats(8817417)
+      def ranked_stats(brawlhalla_id)
+        request(path: "player/#{brawlhalla_id}/ranked")
+      end
+
+      private
+
+      def client
+        @client ||= Faraday.new(url: BASE_URL) do |conn|
+          conn.headers['Content-Type'] = 'application/json'
+          conn.use FaradayMiddleware::ParseJson
+          conn.response :json, parser_options: { symbolize_names: true }
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      def request(path:, params: {})
+        full_url = build_url(path, params)
+
+        response = client.get(full_url)
+        response.body
+      end
+
+      def build_url(path, params = {})
+        url = Addressable::URI.join(path)
+        url.query_values = { api_key: ENV['API_KEY'] }.merge(params)
+        url
+      end
+    end
+  end
+end

data/lib/brawlhalla/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Brawlhalla
+  module API
+    VERSION = '0.1.1'
+  end
+end

data/lib/brawlhalla/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'brawlhalla/api/version'
+require 'brawlhalla/api/client'
+require 'faraday'
+require 'faraday_middleware'
+require 'addressable'
+
+module Brawlhalla
+  module API
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: brawlhalla-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- rikas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: dotenv
+  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: pry-byebug
+  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: rake
+  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: rspec
+  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: rubocop
+  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: rubocop-rspec
+  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: vcr
+  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: webmock
+  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'
+description: Brawlhalla API Ruby wrapper
+email:
+- oterosantos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brawlhalla-api.gemspec
+- lib/brawlhalla/api.rb
+- lib/brawlhalla/api/client.rb
+- lib/brawlhalla/api/version.rb
+homepage: https://github.com/rikas/brawlhalla-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.7.6
+signing_key: 
+specification_version: 4
+summary: Brawlhalla API Ruby wrapper
+test_files: []