swgoh_comlink 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9c4144173f292a053e64ace25b86b5f3937db8cd4de91c95420414f7edb942b
-  data.tar.gz: 3f194112a1082053ff9cea729522efca2ee1c7e0fc770d4666964eaaec6360b2
+  metadata.gz: 72d9903becab7ebfd24af4c0dd670d75d857c5c27805807ffadb290cad2dce1b
+  data.tar.gz: 3c133648ded6dd5f903ae9a18933609b1c0834ae4a02bc76aa7475b698b34c41
 SHA512:
-  metadata.gz: 261e30c5d1efbd7732d9d1c63495850611a1e53e1a1cf104b5f259b9784d64086edb6290c86fdd6d7fcbc7c3f54d2b00bd0997f9afdb8aea2c5e711a029e63e6
-  data.tar.gz: 334865c1ac341fdaea813ae8071ba92cf94f31a9eca900471f4352f6f0163e5d9e9a59df8c9a80d2db504f110d0394e183dba4e3b785abd77a73969222310ad1
+  metadata.gz: 9819959f94a67fe0d6e220eca9d01fed1f7382bb259477b0aa951b8c4314b05a4ec5fd8c8a9b15ea017863d307acd504106787694801da7ecad253c0d540208f
+  data.tar.gz: 6f17edc8b9df09cf3fe7d44fe58ad8310351a8fce7511a8bc185735a764c30943b6640535f7a4592a6cfb2ca5a557eb5b671e59a6dfe6bd8a997f8548de85563

data/lib/comlink_api_request.rb

@@ -3,7 +3,6 @@ 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
@@ -13,9 +12,9 @@ class ComlinkApiRequest
     @hmac_enabled = false
     return if keys.empty?
 
-    keys = keys.with_indifferent_access
-    @secret_key = keys['secret_key']
-    @access_key = keys['access_key']
+    keys = keys.transform_keys(&:to_sym)
+    @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
@@ -24,12 +23,7 @@ class ComlinkApiRequest
   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
+    Net::HTTP.get_response(URI("#{@comlink_url}#{path}")).body
   end
 
   def post(path, body)

data/lib/swgoh_comlink.rb

@@ -1,13 +1,11 @@
 # 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 = {})
+  def initialize(comlink_url, **keys)
     @api_requester = ComlinkApiRequest.new(comlink_url, keys)
   end
 
@@ -16,56 +14,51 @@ class SwgohComlink
   end
 
   def localization(id, unzip = false, enums = false)
-    body = {
-      payload: {
-        id: id
-      },
-      unzip: unzip,
-      enums: enums
-    }
+    body = { payload: { id: }, unzip:, enums: }
 
-    JSON.parse(@api_requester.post('/localization', body.to_json))
+    parse_post_response('/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
+    unless client_specs.empty?
+      body['payload'] = {
+        clientSpecs: verify_parameters(client_specs, [:platform, :bundleId, :externalVersion, :internalVersion, :region])
+      }
+    end
+    body['enums'] = enums
 
-    JSON.parse(@api_requester.post('/metadata', body.to_json))
+    parse_post_response('/metadata', body.to_json)
   end
 
   def data(version, include_pve_units = true, request_segment = 0, enums = false)
     body = {
       payload: {
-        version: version,
+        version:,
         includePveUnits: include_pve_units,
         requestSegment: request_segment
       },
-      enums: 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))
+    parse_post_response('/data', body.to_json)
   end
 
   def player(player_id, enums = false)
-    body = {
-      payload: format_player_id_hash(player_id),
-      enums: enums
-    }
+    body = { payload: format_player_id_hash(player_id), enums: }
 
-    JSON.parse(@api_requester.post('/player', body.to_json))
+    parse_post_response('/player', body.to_json)
   end
 
   def player_arena(player_id, enums = false)
     body = {
       payload: format_player_id_hash(player_id),
-      enums: enums
+      enums:
     }
 
-    JSON.parse(@api_requester.post('/playerArena', body.to_json))
+    parse_post_response('/playerArena', body.to_json)
   end
 
   def guild(guild_id, include_recent_guild_activity = false, enums = false)
@@ -74,18 +67,18 @@ class SwgohComlink
         guildId: guild_id,
         includeRecentGuildActivityInfo: include_recent_guild_activity
       },
-      enums: enums
+      enums:
     }
 
-    JSON.parse(@api_requester.post('/guild', body.to_json))
+    parse_post_response('/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
+        count:,
+        enums:
       }
     }
 
@@ -95,50 +88,45 @@ class SwgohComlink
       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'])
+      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))
+    parse_post_response('/getGuilds', body.to_json)
   end
 
   def get_events(enums = false)
-    body = {
-      enums: enums
-    }
+    body = { enums: }
 
-    JSON.parse(@api_requester.post('/getEvents', body.to_json))
+    parse_post_response('/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'])
+      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'])
+      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
-    }
+    body = { payload:, enums: }
 
-    JSON.parse(@api_requester.post('/getLeaderboard', body.to_json))
+    parse_post_response('/getLeaderboard', body.to_json)
   end
 
   def get_guild_leaderboard(leaderboards, count, enums = false)
-    def_ids = [
+    valid_def_ids = [
       'sith_raid',
       'rancor',
       'aat',
@@ -161,10 +149,10 @@ class SwgohComlink
     ]
 
     leaderboards.each do |leaderboard|
-      payload = verify_parameters(leaderboard, ['leaderboardType', 'defId', 'monthOffset'])
+      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: valid_def_ids, error_message: 'defId must be certain values, see docs', path: [:defId], required: [2, 4, 5, 6].include?(leaderboard.transform_keys(&:to_sym)[:leaderboardType]) },
         { validation: [0, 1], error_message: 'monthOffset must 0 or 1', path: [:monthOffset] }
       ])
     end
@@ -172,12 +160,12 @@ class SwgohComlink
     body = {
       payload: {
         leaderboardId: leaderboards,
-        count: count
+        count:
       },
-      enums: enums
+      enums:
     }
 
-    JSON.parse(@api_requester.post('/getGuildLeaderboard', body.to_json))
+    parse_post_response('/getGuildLeaderboard', body.to_json)
   end
 
   private
@@ -191,12 +179,10 @@ class SwgohComlink
   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 = original_hash.transform_keys(&:to_sym)
 
-    original_hash
+    original_hash.transform_keys! { |key| camelize(key.to_s).to_sym }
+    original_hash.select { |key| permitted_keys.include?(key) }
   end
 
   def body_validation(body, requirements)
@@ -210,4 +196,12 @@ class SwgohComlink
 
     true
   end
+
+  def parse_post_response(route, body)
+    JSON.parse(@api_requester.post(route, body.to_json))
+  end
+
+  def camelize(string)
+    string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swgoh_comlink
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zach Moses
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-09 00:00:00.000000000 Z
+date: 2024-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -72,14 +72,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: 'Created to connect with deployed Star Wars: Galaxy of Heroes Comlink APIs.