SWGOH-API 0.3.19

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ab79511050879440c37f9a3bb2d9d8536d4388953fe2cdbc15b6b99fe563cb1
+  data.tar.gz: 323a779049f568c2ee3d710bc471bccd4f1234095d935b2e1205c72a9c702c85
+SHA512:
+  metadata.gz: 2cce68fb87a9e43fbd7f310b3cad0aeeab0a4e6c4f471d7f6aa8efe1195a7b2462bd89feb5f9a437512d8f824f45302c380f7cb25f5e28a2d49abc5c2cc788c4
+  data.tar.gz: c0adfc835eb04a633d59a837ea525110717400028d1f3337349804b5d64366f0a411fea4c93aa031b984cc0e7cf7f43e4af64bc45b6bdc9b3b89f8c84a3f4027

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+*.sassc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rspec
+.sass-cache
+.DS_Store
+Gemfile.lock # gem projects only!
+InstalledFiles
+_yardoc
+doc/
+coverage
+lib/bundler/man
+capybara-*.html
+pkg
+rdoc
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp
+.idea/*

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,63 @@
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+N/A
+
+## [0.3.19] - 2020-10-16
+## Changed
+- Set ally code request header type to json by [@jquass](https://github.com/jquass)
+- Add request error logging by [@jquass](https://github.com/jquass)
+
+## [0.3.17] - 2020-10-16
+## Changed
+- Format ally code request bodies to json by [@jquass](https://github.com/jquass)
+
+## [0.3.15] - 2020-10-16
+## Changed
+- Fix how ally code request bodies are formatted by [@jquass](https://github.com/jquass)
+- Fix CLIENT_REQUESTS_test by [@jquass](https://github.com/jquass)
+- Fix API_test by [@jquass](https://github.com/jquass)
+
+## [0.3.12] - 2020-10-16
+## Changed
+- *Really* use https when making requests to auth/signin by [@jquass](https://github.com/jquass)
+
+## [0.3.11] - 2020-10-16
+### Changed
+- Fixed bug setting port making ally code requests by [@jquass](https://github.com/jquass)
+
+## [0.3.10] - 2020-10-16
+### Changed
+- Fixed CLIENT_AUTH_test by [@jquass](https://github.com/jquass)
+- Secure requests with ally code by [@jquass](https://github.com/jquass)
+
+## [0.3.8] - 2020-10-15
+### Changed
+- Use https when making requests to auth/signin by [@jquass](https://github.com/jquass)
+
+## [0.3.7] - 2020-08-22
+### Changed
+- Updated the README to follow [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) by [@jquass](https://github.com/jquass)
+
+## [0.3.6] - 2020-07-20
+### Added
+- Unit tests to test client auth by [@jquass](https://github.com/jquass)
+- Unit tests to test client requests by [@jquass](https://github.com/jquass) 
+- Unit test helper by [@jquass](https://github.com/jquass)
+- Updated REAMDE by [@jquass](https://github.com/jquass)
+
+### Changed
+- Fixed relative paths on module constants by [@jquass](https://github.com/jquass)
+
+## [0.3.5] - 2020-07-13
+### Changed
+- Fixed auth field validation by [@jquass](https://github.com/jquass)
+- Fix how auth token is stored [@jquass](https://github.com/jquass)
+
+## Legacy CHANGELOG
+
+- v0.3.5 Fix bad imports so it can actually work
+- v0.3.4 Add CHANGELOG.md
+- v0.3.3 Update README.md and various fixes
+- v0.3.0 Make the client a configurable object

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at quassj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in SWGOH-API.gemspec
+gemspec
+
+gem 'http', '~> 4.4.1'
+gem 'json', '~> 2.3.1'
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'
+gem 'rspec-core', '~> 3.9.2'
+gem 'rspec-expectations', '~> 3.9.2'
+gem 'webmock', '~> 3.8.3'

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    SWGOH-API (0.3.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hashdiff (1.0.1)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    json (2.3.1)
+    minitest (5.14.1)
+    public_suffix (4.0.5)
+    rake (12.3.3)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  SWGOH-API!
+  http (~> 4.4.1)
+  json (~> 2.3.1)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rspec-core (~> 3.9.2)
+  rspec-expectations (~> 3.9.2)
+  webmock (~> 3.8.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jon Quass
+
+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,75 @@
+# SWGOH::API [![Gem Version](https://badge.fury.io/rb/SWGOH-API.svg)](https://badge.fury.io/rb/SWGOH-API)
+Ruby client wrapper for the API at https://api.swgoh.help .
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'SWGOH-API'
+```
+
+And then rake:
+
+    $ bundle exec rake
+
+## Usage
+```ruby
+# Require the gem
+require 'SWGOH/API/CLIENT/client'
+
+# Create a new client
+client = CLIENT.new
+
+# Generate a new access_token
+access_token = client.authorize("username", "password")
+
+# Or authenticate with a saved access_token
+client.access_token = access_token
+
+# Then start making requests
+json = client.get_players([123456789])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `gem install 'SWGOH-API'`. 
+
+### irb
+```
+$ irb -rubygems               
+irb(main):001:0> require 'SWGOH/API/CLIENT/client'
+=> true
+irb(main):002:0> client = CLIENT.new
+=> #<CLIENT:0x00007fdf90087b28 @language="ENG_US", @enums=false, @structure=false, @access_token=nil>
+irb(main):003:0> client.authorized?
+=> false
+irb(main):004:0> client.access_token = 'myexistingtoken'
+=> "myexistingtoken"
+irb(main):005:0> client.authorized?
+=> true
+```
+
+### Release
+These are the steps to create and tag a new version, push git commits and tags, and push the new gem version to [rubygems.org](https://rubygems.org).
+
+- Update the CHANGELOG and assign version number
+- Update the version number in `version.rb`
+- Run `gem build SWGOH-API.gemspec`
+- Run the release to generate all files `bundle exec rake release`  
+- Create a new version commit with all changes
+- Release the new version `bundle exec rake release` 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jquass/SWGOH-API. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jquass/SWGOH-API/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SWGOH::API project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jquass/SWGOH-API/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/SWGOH-API.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/SWGOH/API/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'SWGOH-API'
+  spec.version       = SWGOH::API::VERSION
+  spec.authors       = ['Jonathan Quass']
+  spec.email         = ['quassj@gmail.com']
+  spec.summary       = 'Client for api.swgoh.help'
+  spec.description   = 'A ruby gem client for api.swgoh.help'
+  spec.homepage      = 'https://github.com/jquass/SWGOH-API'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jquass/SWGOH-API'
+  spec.metadata['changelog_uri'] = 'https://github.com/jquass/SWGOH-API/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) 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']
+end

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/SWGOH/API.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SWGOH
+  # The API module supports the client
+  module API
+    class Error < StandardError; end
+
+    module PATH
+      BASE = 'api.swgoh.help'
+      AUTH_SIGNIN = 'auth/signin'
+      PLAYER = 'swgoh/player'
+      GUILD = 'swgoh/guild'
+      UNITS = 'swgoh/units'
+      ROSTER = 'swgoh/roster'
+      DATA = 'swgoh/data'
+      ZETAS = 'swgoh/zetas'
+      SQUADS = 'swgoh/squads'
+      EVENTS = 'swgoh/events'
+      BATTLES = 'swgoh/battles'
+      REGISTRATION = 'registration'
+    end
+
+    module LANGUAGE
+      CHS_CN = 'CHS_CN'
+      CHT_CN = 'CHT_CN'
+      ENG_US = 'ENG_US'
+      FRE_FR = 'FRE_FR'
+      GER_DE = 'GER_DE'
+      IND_ID = 'IND_ID'
+      ITA_IT = 'ITA_IT'
+      JPN_JP = 'JPN_JP'
+      KOR_KR = 'KOR_KR'
+      POR_BR = 'POR_BR'
+      RUS_RU = 'RUS_RU'
+      SPA_XM = 'SPA_XM'
+      THA_TH = 'THA_TH'
+      TUR_TR = 'TUR_TR'
+    end
+  end
+end

data/lib/SWGOH/API/CLIENT/client.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'SWGOH/API'
+require 'uri'
+require 'net/http'
+require 'json'
+
+# The CLIENT class makes requests to api.swgoh.api
+class CLIENT
+  attr_accessor :language, :enums, :structure
+  attr_writer :access_token
+
+  def initialize
+    @language = SWGOH::API::LANGUAGE::ENG_US
+    @enums = false
+    @structure = false
+    @access_token = nil
+  end
+
+  # @return [Boolean]
+  def authorized?
+    !@access_token.nil?
+  end
+
+  # @param [String] username
+  # @param [String] password
+  # @return [String | nil]
+  def authorize(username, password)
+    form = auth_request_form(username, password)
+    path = "https://#{SWGOH::API::PATH::BASE}/#{SWGOH::API::PATH::AUTH_SIGNIN}"
+    res = Net::HTTP.post_form(URI(path), form)
+    return log_error(res) unless res.is_a?(Net::HTTPSuccess)
+
+    @access_token = JSON.parse(res.body)['access_token']
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_players(ally_codes)
+    request(SWGOH::API::PATH::PLAYER, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_guilds(ally_codes)
+    request(SWGOH::API::PATH::GUILD, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_rosters(ally_codes)
+    request(SWGOH::API::PATH::ROSTER, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_units(ally_codes)
+    request(SWGOH::API::PATH::UNITS, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_zetas(ally_codes)
+    request(SWGOH::API::PATH::ZETAS, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_squads(ally_codes)
+    request(SWGOH::API::PATH::SQUADS, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_events(ally_codes)
+    request(SWGOH::API::PATH::EVENTS, ally_codes)
+  end
+
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def get_battles(ally_codes)
+    request(SWGOH::API::PATH::BATTLES, ally_codes)
+  end
+
+  private
+
+  attr_reader :access_token
+
+  # @param [PATH] path
+  # @param [Array] ally_codes
+  # @return [JSON || nil]
+  def request(path, ally_codes)
+    return unless authorized?
+
+    uri = URI("https://#{SWGOH::API::PATH::BASE}/#{path}")
+    response = Net::HTTP.post(uri, request_data(ally_codes), request_headers)
+    return log_error(response) unless response.is_a?(Net::HTTPSuccess)
+
+    JSON.parse(response.body)
+  end
+
+  def request_headers
+    {
+      Authorization: 'Bearer ' + @access_token,
+      'Content-Type': 'application/json;charset=utf-8'
+    }
+  end
+
+  def auth_request_form(username, password)
+    {
+      username: username,
+      password: password,
+      grant_type: 'password',
+      client_id: 123,
+      client_secret: 'abc'
+    }
+  end
+
+  # @return [JSON]
+  def request_data(ally_codes)
+    {
+      allyCodes: ally_codes,
+      language: language,
+      enums: enums,
+      structure: structure
+    }.to_json
+  end
+
+  def log_error(result)
+    puts result.inspect
+    puts result.body if result.is_a?(Net::HTTPResponse)
+  end
+end

data/lib/SWGOH/API/version.rb

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

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: SWGOH-API
+version: !ruby/object:Gem::Version
+  version: 0.3.19
+platform: ruby
+authors:
+- Jonathan Quass
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-17 00:00:00.000000000 Z
+dependencies: []
+description: A ruby gem client for api.swgoh.help
+email:
+- quassj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SWGOH-API.gemspec
+- bin/setup
+- lib/SWGOH/API.rb
+- lib/SWGOH/API/CLIENT/client.rb
+- lib/SWGOH/API/version.rb
+homepage: https://github.com/jquass/SWGOH-API
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jquass/SWGOH-API
+  source_code_uri: https://github.com/jquass/SWGOH-API
+  changelog_uri: https://github.com/jquass/SWGOH-API/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Client for api.swgoh.help
+test_files: []