swgoh_comlink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9c4144173f292a053e64ace25b86b5f3937db8cd4de91c95420414f7edb942b
+  data.tar.gz: 3f194112a1082053ff9cea729522efca2ee1c7e0fc770d4666964eaaec6360b2
+SHA512:
+  metadata.gz: 261e30c5d1efbd7732d9d1c63495850611a1e53e1a1cf104b5f259b9784d64086edb6290c86fdd6d7fcbc7c3f54d2b00bd0997f9afdb8aea2c5e711a029e63e6
+  data.tar.gz: 334865c1ac341fdaea813ae8071ba92cf94f31a9eca900471f4352f6f0163e5d9e9a59df8c9a80d2db504f110d0394e183dba4e3b785abd77a73969222310ad1

data/lib/comlink_api_request.rb

@@ -0,0 +1,62 @@
+require 'openssl'
+require 'digest'
+require 'json'
+require 'net/http'
+require 'uri'
+require 'active_support/core_ext/hash/indifferent_access'
+
+class ComlinkApiRequest
+  attr_accessor :hmac_enabled, :comlink_url
+
+  def initialize(comlink_url, keys)
+    @comlink_url = comlink_url.start_with?('http') ? comlink_url : "https://#{comlink_url}"
+    @hmac_enabled = false
+    return if keys.empty?
+
+    keys = keys.with_indifferent_access
+    @secret_key = keys['secret_key']
+    @access_key = keys['access_key']
+
+    raise ArgumentError, 'Secret key missing' unless @secret_key
+    raise ArgumentError, 'Access key missing' unless @access_key
+
+    @hmac_enabled = true
+  end
+
+  def get(path)
+    uri = URI.parse("#{@comlink_url}#{path}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    request = Net::HTTP::Get.new(uri.request_uri)
+
+    http.request(request).body
+  end
+
+  def post(path, body)
+    uri = URI.parse("#{@comlink_url}#{path}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    request = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
+    add_hmac_headers(request, 'POST', path, body)
+    request.body = body
+
+    http.request(request).body
+  end
+
+  private
+
+  def add_hmac_headers(request, type, endpoint, payload = '')
+    return unless @hmac_enabled
+
+    req_time = (Time.now.to_i * 1000).to_s
+
+    payload_hash_digest = Digest::MD5.hexdigest(payload)
+
+    hmac_obj = OpenSSL::HMAC.new(@secret_key, OpenSSL::Digest.new('sha256'))
+    hmac_obj.update(req_time + type + endpoint + payload_hash_digest)
+
+    request['X-Date'] = req_time
+    request['Authorization'] = "HMAC-SHA256 Credential=#{@access_key},Signature=#{hmac_obj.hexdigest}"
+  end
+end

data/lib/swgoh_comlink.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require_relative 'comlink_api_request'
+
+# Base class for the gem, a wrapper for Comlink
+# See https://github.com/swgoh-utils/swgoh-comlink for more info on Comlink
+class SwgohComlink
+  def initialize(comlink_url, keys = {})
+    @api_requester = ComlinkApiRequest.new(comlink_url, keys)
+  end
+
+  def enums
+    JSON.parse(@api_requester.get('/enums'))
+  end
+
+  def localization(id, unzip = false, enums = false)
+    body = {
+      payload: {
+        id: id
+      },
+      unzip: unzip,
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/localization', body.to_json))
+  end
+
+  def metadata(client_specs = {}, enums = false)
+    body = {}
+    body['payload'] = { "clientSpecs" => verify_parameters(client_specs, ['platform', 'bundleId', 'externalVersion', 'internalVersion', 'region']) } unless client_specs.empty?
+    body['enums'] = false
+
+    JSON.parse(@api_requester.post('/metadata', body.to_json))
+  end
+
+  def data(version, include_pve_units = true, request_segment = 0, enums = false)
+    body = {
+      payload: {
+        version: version,
+        includePveUnits: include_pve_units,
+        requestSegment: request_segment
+      },
+      enums: enums
+    }
+
+    body_validation(body, [ { validation: (0..4), error_message: 'Request segment must be between 0 and 4', path: [:payload, :requestSegment] } ])
+
+    JSON.parse(@api_requester.post('/data', body.to_json))
+  end
+
+  def player(player_id, enums = false)
+    body = {
+      payload: format_player_id_hash(player_id),
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/player', body.to_json))
+  end
+
+  def player_arena(player_id, enums = false)
+    body = {
+      payload: format_player_id_hash(player_id),
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/playerArena', body.to_json))
+  end
+
+  def guild(guild_id, include_recent_guild_activity = false, enums = false)
+    body = {
+      payload: {
+        guildId: guild_id,
+        includeRecentGuildActivityInfo: include_recent_guild_activity
+      },
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/guild', body.to_json))
+  end
+
+  def get_guilds(filter_type, name = nil, search_criteria = nil, count = 10, enums = false)
+    body = {
+      payload: {
+        filterType: filter_type,
+        count: count,
+        enums: enums
+      }
+    }
+
+    validations = [ { validation: [4, 5], error_message: 'filterType must be 4 or 5', path: [:payload, :filterType], required: true } ]
+
+    if filter_type == 4
+      body[:payload][:name] = name
+      validations << { error_message: 'Name is required when filterType is 4', path: [:payload, :name], required: true }
+    elsif filter_type == 5
+      body[:payload][:searchCriteria] = search_criteria && verify_parameters(search_criteria, ['minMemberCount', 'maxMemberCount', 'includeInviteOnly', 'minGuildGalacticPower', 'maxGuildGalacticPower', 'recentTbParticipatedIn'])
+      validations << { error_message: 'searchCriteria is required when filterType is 5', path: [:payload, :searchCriteria], required: true }
+    end
+
+    body_validation(body, validations)
+
+    JSON.parse(@api_requester.post('/getGuilds', body.to_json))
+  end
+
+  def get_events(enums = false)
+    body = {
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/getEvents', body.to_json))
+  end
+
+  def get_leaderboard(payload, enums = false)
+    body_validation(payload, [ { validation: [4, 6], error_message: 'leaderboardType must be 4 or 6', path: [:leaderboardType] } ])
+
+    if payload[:leaderboardType] == 4 || payload[:leaderboard_type] == 4
+      payload = verify_parameters(payload, ['leaderboardType', 'eventInstanceId', 'groupId'])
+      body_validation(payload, [
+        { error_message: 'eventInstanceId must be present', path: [:eventInstanceId], required: true },
+        { error_message: 'groupId must be present', path: [:groupId], required: true }
+      ])
+    else
+      payload = verify_parameters(payload, ['leaderboardType', 'league', 'division'])
+      body_validation(payload, [
+        { validation: [20, 40, 60, 80, 100], error_message: 'league must be in [20, 40, 60, 80, 100]', path: [:league], required: true },
+        { validation: [5, 10, 15, 20, 25], error_message: 'division must be in [5, 10, 15, 20, 25]', path: [:division], required: true }
+      ])
+    end
+
+    body = {
+      payload: payload,
+      enums: false
+    }
+
+    JSON.parse(@api_requester.post('/getLeaderboard', body.to_json))
+  end
+
+  def get_guild_leaderboard(leaderboards, count, enums = false)
+    def_ids = [
+      'sith_raid',
+      'rancor',
+      'aat',
+      'kraytdragon',
+      'speederbike',
+      't01D',
+      't02D',
+      't03D',
+      't04D',
+      't05D',
+      'TERRITORY_WAR_LEADERBOARD',
+      'GUILD:RAIDS:NORMAL_DIFF:RANCOR:DIFF06',
+      'GUILD:RAIDS:NORMAL_DIFF:RANCOR:HEROIC80',
+      'GUILD:RAIDS:NORMAL_DIFF:AAT:DIFF06',
+      'GUILD:RAIDS:NORMAL_DIFF:AAT:HEROIC85',
+      'GUILD:RAIDS:NORMAL_DIFF:SITH_RAID:DIFF06',
+      'GUILD:RAIDS:NORMAL_DIFF:SITH_RAID:HEROIC85',
+      'GUILD:RAIDS:NORMAL_DIFF:KRAYTDRAGON:DIFF01',
+      'GUILD:RAIDS:NORMAL_DIFF:ROTJ:SPEEDERBIKE'
+    ]
+
+    leaderboards.each do |leaderboard|
+      payload = verify_parameters(leaderboard, ['leaderboardType', 'defId', 'monthOffset'])
+      body_validation(leaderboard, [
+        { validation: [0, 2, 3, 4, 5, 6], error_message: 'leaderboardType must in [0, 2, 3, 4, 5, 6]', path: [:leaderboardType], required: true },
+        { validation: def_ids, error_message: 'defId must be certain values, see docs', path: [:defId], required: [2, 4, 5, 6].include?(leaderboard.with_indifferent_access[:leaderboardType]) },
+        { validation: [0, 1], error_message: 'monthOffset must 0 or 1', path: [:monthOffset] }
+      ])
+    end
+
+    body = {
+      payload: {
+        leaderboardId: leaderboards,
+        count: count
+      },
+      enums: enums
+    }
+
+    JSON.parse(@api_requester.post('/getGuildLeaderboard', body.to_json))
+  end
+
+  private
+
+  def format_player_id_hash(player_id_original)
+    # This can accept the 9 digit ally code (ex: 123-456-789)
+    # OR it can accept the full playerId (ex: HFuvf-OURK202WASUgpayw)
+    player_id = player_id_original.dup
+    player_id.gsub!('-', '') if player_id.length == 11
+    player_id.length == 9 ? { allyCode: player_id } : { playerID: player_id }
+  end
+
+  def verify_parameters(original_hash, permitted_keys)
+    original_hash = original_hash.with_indifferent_access
+
+    original_hash.transform_keys! { |key| key.to_s.camelize(:lower) }
+    original_hash.slice!(*permitted_keys)
+
+    original_hash
+  end
+
+  def body_validation(body, requirements)
+    requirements.each do |req_set|
+      value = body.dig(*req_set[:path])
+      next if !value && !req_set[:required]
+      next if value && (!req_set[:validation] || req_set[:validation].include?(value))
+
+      raise ArgumentError, req_set[:error_message]
+    end
+
+    true
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: swgoh_comlink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zach Moses
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-09 00:00:00.000000000 Z
+dependencies:
+- !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: sinatra
+  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: A wrapper to connect to SWGOH Comlink APIs
+email: zmoses93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/comlink_api_request.rb
+- lib/swgoh_comlink.rb
+homepage: https://github.com/zmoses/SwgohComlink
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: 'Created to connect with deployed Star Wars: Galaxy of Heroes Comlink APIs.
+  For more information on Comlink, see their Github page: https://github.com/swgoh-utils/swgoh-comlink'
+test_files: []