SWGOH-API 0.3.19 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ab79511050879440c37f9a3bb2d9d8536d4388953fe2cdbc15b6b99fe563cb1
-  data.tar.gz: 323a779049f568c2ee3d710bc471bccd4f1234095d935b2e1205c72a9c702c85
+  metadata.gz: '08c450a93858d8f9ecad0bee9c8fb33c84b779d29aa5a750e535261b5e869fb5'
+  data.tar.gz: 4f86c4f8f9512351227f8e428dabf39992ca1ebdd449be3b9938ee8fdfc3ae60
 SHA512:
-  metadata.gz: 2cce68fb87a9e43fbd7f310b3cad0aeeab0a4e6c4f471d7f6aa8efe1195a7b2462bd89feb5f9a437512d8f824f45302c380f7cb25f5e28a2d49abc5c2cc788c4
-  data.tar.gz: c0adfc835eb04a633d59a837ea525110717400028d1f3337349804b5d64366f0a411fea4c93aa031b984cc0e7cf7f43e4af64bc45b6bdc9b3b89f8c84a3f4027
+  metadata.gz: f25e29323f14dab0e2fdb93fa67e8583d23a955f557622670c32242a1d148477cf7ada91420ae23148c8419183470f092eb776366fb7d442c959c0d1b2c85b7d
+  data.tar.gz: 5e766736283e5e0430b0dafeeb6ed6b2cd2f9f95ce0dc7d406d2b8c979a193cfbd3510c4d9aece83164ba76aea93bbce18dca3b8d73665e9fed45b73af887544

data/CHANGELOG.md

@@ -2,7 +2,21 @@ 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.4.0] - 2020-10-16
+## Added
+- Added methods to make requests to the data endpoint by [@jquass](https://github.com/jquass)
+- Added client data endpoint unit tests by [@jquass](https://github.com/jquass)
+- Added project param by [@jquass](https://github.com/jquass)
+## Changed
+- Removed ally_codes param from get_zetas and changed name to zetas by [@jquass](https://github.com/jquass)
+- Removed ally_codes param from get_squads and changed name to squads by [@jquass](https://github.com/jquass)
+- Removed ally_codes param from get_events and changed name to events by [@jquass](https://github.com/jquass)
+- Removed ally_codes param from get_battles and changed name to battles by [@jquass](https://github.com/jquass)
+- Renamed get_players to players by [@jquass](https://github.com/jquass)
+- Renamed get_guilds to guilds by [@jquass](https://github.com/jquass)
+- Renamed get_rosters to rosters by [@jquass](https://github.com/jquass)
+- Renamed get_units to units by [@jquass](https://github.com/jquass)
 
 ## [0.3.19] - 2020-10-16
 ## Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    SWGOH-API (0.3.19)
+    SWGOH-API (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -33,13 +33,15 @@ 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.
+After checking out the repo, run `bin/setup` to install dependencies.
 
-To install this gem onto your local machine, run `gem install 'SWGOH-API'`. 
+To build your changes, run `gem build SWGOH-API.gemspec`
+
+To install the build onto your local machine, run `gem install 'SWGOH-API'`. 
 
 ### irb
 ```
-$ irb -rubygems               
+$ irb
 irb(main):001:0> require 'SWGOH/API/CLIENT/client'
 => true
 irb(main):002:0> client = CLIENT.new
@@ -52,15 +54,19 @@ irb(main):005:0> client.authorized?
 => true
 ```
 
+### Unit Tests
+
+Run `rake test` to run the unit tests.
+
 ### 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`  
+- Run `gem build SWGOH-API.gemspec` to build the new gem version
+- Run the release once to generate all files to commit `bundle exec rake release`  
 - Create a new version commit with all changes
-- Release the new version `bundle exec rake release` 
+- Release the new version `bundle exec rake release`
 
 ## Contributing
 

data/lib/SWGOH/API.rb

@@ -36,5 +36,40 @@ module SWGOH
       THA_TH = 'THA_TH'
       TUR_TR = 'TUR_TR'
     end
+
+    module COLLECTION
+      ABILITY = 'abilityList'
+      BATTLE_ENVIRONMENT = 'battleEnvironmentsList'
+      BATTLE_TARGETING_RULE = 'battleTargetingRuleList'
+      CATEGORY = 'categoryList'
+      CHALLENGE = 'challengeList'
+      CHALLENGE_STYLE = 'challengeStyleList'
+      EFFECT = 'effectList'
+      ENVIRONMENT_COLLECTION = 'environmentCollectionList'
+      EQUIPMENT = 'equipmentList'
+      EVENT_SAMPLING = 'eventSamplingList'
+      GUILD_EXCHANGE_ITEM = 'guildExchangeItemList'
+      GUILD_RAID = 'guildRaidList'
+      HELP_ENTRY = 'helpEntryList'
+      MATERIAL = 'materialList'
+      PLAYER_TITLE = 'playerTitleList'
+      POWER_UP_BUNDLE = 'powerUpBundleList'
+      RAID_CONFIG = 'raidConfigList'
+      RECIPE = 'recipeList'
+      REQUIREMENT = 'requirementList'
+      SKILL = 'skillList'
+      STARTER_GUILD = 'starterGuildList'
+      STAT_MOD = 'statModList'
+      STAT_MOD_SET = 'statModSetList'
+      STAT_PROGRESSION = 'statProgressionList'
+      TABLE = 'tableList'
+      TARGETING_SET = 'targetingSetList'
+      TERRITORY_BATTLE_DEFINITION = 'territoryBattleDefinitionList'
+      TERRITORY_WAR_DEFINITION = 'territoryWarDefinitionList'
+      UNIT = 'unitsList'
+      UNLOCK_ANNOUNCEMENT_DEFINITION = 'unlockAnnouncementDefinitionList'
+      WAR_DEFINITION = 'warDefinitionList'
+      XP_TABLE = 'xpTableList'
+    end
   end
 end

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

@@ -7,7 +7,7 @@ require 'json'
 
 # The CLIENT class makes requests to api.swgoh.api
 class CLIENT
-  attr_accessor :language, :enums, :structure
+  attr_accessor :language, :enums, :structure, :project
   attr_writer :access_token
 
   def initialize
@@ -15,6 +15,7 @@ class CLIENT
     @enums = false
     @structure = false
     @access_token = nil
+    @project = nil
   end
 
   # @return [Boolean]
@@ -36,69 +37,258 @@ class CLIENT
 
   # @param [Array] ally_codes
   # @return [JSON || nil]
-  def get_players(ally_codes)
-    request(SWGOH::API::PATH::PLAYER, ally_codes)
+  def players(ally_codes)
+    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)
+  def guilds(ally_codes)
+    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)
+  def rosters(ally_codes)
+    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)
+  def units(ally_codes)
+    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)
+  def zetas
+    request(SWGOH::API::PATH::ZETAS)
   end
 
-  # @param [Array] ally_codes
   # @return [JSON || nil]
-  def get_squads(ally_codes)
-    request(SWGOH::API::PATH::SQUADS, ally_codes)
+  def squads
+    request(SWGOH::API::PATH::SQUADS)
   end
 
-  # @param [Array] ally_codes
   # @return [JSON || nil]
-  def get_events(ally_codes)
-    request(SWGOH::API::PATH::EVENTS, ally_codes)
+  def events
+    request(SWGOH::API::PATH::EVENTS)
+  end
+
+  # @return [JSON || nil]
+  def battles
+    request(SWGOH::API::PATH::BATTLES)
+  end
+
+  # @return [JSON || nil]
+  def abilities
+    data_request(SWGOH::API::COLLECTION::ABILITY)
+  end
+
+  # @return [JSON || nil]
+  def battle_environments
+    data_request(SWGOH::API::COLLECTION::BATTLE_ENVIRONMENT)
+  end
+
+  # @return [JSON || nil]
+  def battle_targeting_rules
+    data_request(SWGOH::API::COLLECTION::BATTLE_TARGETING_RULE)
+  end
+
+  # @return [JSON || nil]
+  def categories
+    data_request(SWGOH::API::COLLECTION::CATEGORY)
+  end
+
+  # @return [JSON || nil]
+  def challenges
+    data_request(SWGOH::API::COLLECTION::CHALLENGE)
+  end
+
+  # @return [JSON || nil]
+  def challenge_styles
+    data_request(SWGOH::API::COLLECTION::CHALLENGE_STYLE)
+  end
+
+  # @return [JSON || nil]
+  def effects
+    data_request(SWGOH::API::COLLECTION::EFFECT)
+  end
+
+  # @return [JSON || nil]
+  def environment_collections
+    data_request(SWGOH::API::COLLECTION::ENVIRONMENT_COLLECTION)
+  end
+
+  # @return [JSON || nil]
+  def equipment
+    data_request(SWGOH::API::COLLECTION::EQUIPMENT)
+  end
+
+  # @return [JSON || nil]
+  def event_samples
+    data_request(SWGOH::API::COLLECTION::EVENT_SAMPLING)
+  end
+
+  # @return [JSON || nil]
+  def guild_exchange_items
+    data_request(SWGOH::API::COLLECTION::GUILD_EXCHANGE_ITEM)
+  end
+
+  # @return [JSON || nil]
+  def guild_raids
+    data_request(SWGOH::API::COLLECTION::GUILD_RAID)
+  end
+
+  # @return [JSON || nil]
+  def help_entries
+    data_request(SWGOH::API::COLLECTION::HELP_ENTRY)
+  end
+
+  # @return [JSON || nil]
+  def materials
+    data_request(SWGOH::API::COLLECTION::MATERIAL)
+  end
+
+  # @return [JSON || nil]
+  def player_titles
+    data_request(SWGOH::API::COLLECTION::PLAYER_TITLE)
+  end
+
+  # @return [JSON || nil]
+  def power_up_bundles
+    data_request(SWGOH::API::COLLECTION::POWER_UP_BUNDLE)
+  end
+
+  # @return [JSON || nil]
+  def raid_configs
+    data_request(SWGOH::API::COLLECTION::RAID_CONFIG)
+  end
+
+  # @return [JSON || nil]
+  def recipes
+    data_request(SWGOH::API::COLLECTION::RECIPE)
+  end
+
+  # @return [JSON || nil]
+  def requirements
+    data_request(SWGOH::API::COLLECTION::REQUIREMENT)
+  end
+
+  # @return [JSON || nil]
+  def skills
+    data_request(SWGOH::API::COLLECTION::SKILL)
+  end
+
+  # @return [JSON || nil]
+  def starter_guilds
+    data_request(SWGOH::API::COLLECTION::STARTER_GUILD)
+  end
+
+  # @return [JSON || nil]
+  def stat_mods
+    data_request(SWGOH::API::COLLECTION::STAT_MOD)
+  end
+
+  # @return [JSON || nil]
+  def stat_mod_sets
+    data_request(SWGOH::API::COLLECTION::STAT_MOD_SET)
+  end
+
+  # @return [JSON || nil]
+  def stat_progressions
+    data_request(SWGOH::API::COLLECTION::STAT_PROGRESSION)
+  end
+
+  # @return [JSON || nil]
+  def tables
+    data_request(SWGOH::API::COLLECTION::TABLE)
+  end
+
+  # @return [JSON || nil]
+  def targeting_sets
+    data_request(SWGOH::API::COLLECTION::TARGETING_SET)
+  end
+
+  # @return [JSON || nil]
+  def territory_battle_definitions
+    data_request(SWGOH::API::COLLECTION::TERRITORY_BATTLE_DEFINITION)
+  end
+
+  # @return [JSON || nil]
+  def territory_war_definitions
+    data_request(SWGOH::API::COLLECTION::TERRITORY_WAR_DEFINITION)
+  end
+
+  # @return [JSON || nil]
+  def units_list
+    data_request(SWGOH::API::COLLECTION::UNIT)
   end
 
-  # @param [Array] ally_codes
   # @return [JSON || nil]
-  def get_battles(ally_codes)
-    request(SWGOH::API::PATH::BATTLES, ally_codes)
+  def unlock_announcement_defs
+    data_request(SWGOH::API::COLLECTION::UNLOCK_ANNOUNCEMENT_DEFINITION)
+  end
+
+  # @return [JSON || nil]
+  def war_definitions
+    data_request(SWGOH::API::COLLECTION::WAR_DEFINITION)
+  end
+
+  # @return [JSON || nil]
+  def xp_tables
+    data_request(SWGOH::API::COLLECTION::XP_TABLE)
   end
 
   private
 
   attr_reader :access_token
 
+  # @param [PATH] path
+  # @return [JSON || nil]
+  def request(path)
+    return unless authorized?
+
+    uri = URI("https://#{SWGOH::API::PATH::BASE}/#{path}")
+    data = request_data
+    data[:project] = @project unless @project.nil?
+    response = Net::HTTP.post(uri, data.to_json, request_headers)
+    return log_error(response) unless response.is_a?(Net::HTTPSuccess)
+
+    JSON.parse(response.body)
+  end
+
   # @param [PATH] path
   # @param [Array] ally_codes
   # @return [JSON || nil]
-  def request(path, ally_codes)
+  def ally_codes_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)
+    data = request_data
+    data[:allyCodes] = ally_codes
+    data[:project] = @project unless @project.nil?
+    response = Net::HTTP.post(uri, data.to_json, request_headers)
     return log_error(response) unless response.is_a?(Net::HTTPSuccess)
 
     JSON.parse(response.body)
   end
 
+  # @param [SWGOH::API::PATH::COLLECTION] collection
+  # @return [JSON || nil]
+  def data_request(collection)
+    return unless authorized?
+
+    uri = URI("https://#{SWGOH::API::PATH::BASE}/#{SWGOH::API::PATH::DATA}")
+    data = request_data
+    data[:collection] = collection
+    data[:project] = @project unless @project.nil?
+    response = Net::HTTP.post(uri, data.to_json, request_headers)
+    return log_error(response) unless response.is_a?(Net::HTTPSuccess)
+
+    JSON.parse(response.body)
+  end
+
+  # @return [Hash]
   def request_headers
     {
       Authorization: 'Bearer ' + @access_token,
@@ -106,6 +296,9 @@ class CLIENT
     }
   end
 
+  # @param [String]  username
+  # @param [String] password
+  # @return [Hash]
   def auth_request_form(username, password)
     {
       username: username,
@@ -116,14 +309,13 @@ class CLIENT
     }
   end
 
-  # @return [JSON]
-  def request_data(ally_codes)
+  # @return [Hash]
+  def request_data
     {
-      allyCodes: ally_codes,
       language: language,
       enums: enums,
       structure: structure
-    }.to_json
+    }
   end
 
   def log_error(result)

data/lib/SWGOH/API/version.rb

@@ -2,6 +2,6 @@
 
 module SWGOH
   module API
-    VERSION = '0.3.19'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SWGOH-API
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.4.0
 platform: ruby
 authors:
 - Jonathan Quass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies: []
 description: A ruby gem client for api.swgoh.help
 email: