restiny 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366f1afb92a72c9adbc817eb5e8651fcd2df0656584c138660708525343b8407
-  data.tar.gz: 7fa7f9df35a0ee12206627a43c7ffb4d299819c5d26340c83186f520e30de99e
+  metadata.gz: 7a11b1fe287424ab29d345e8598b810afd733d59f634e00badf837ac7f16ec3d
+  data.tar.gz: fb704f715f42ad34aa722435079e7aae31c9660d5b9e7b32e1f0d9e82efafabd
 SHA512:
-  metadata.gz: 8c71e268039ac692949adf704883eda27bc2da5d747dab7d610a09621921ef3e64e4909bca9456431f404a0ff4211a19f31efbdf7eb57701bf852bacf360cf90
-  data.tar.gz: 77c6af1bf576b0e590a6659565af7739316cbc3a72b159a26c8b3077308c3713f1cb8cf45c103d3a0993c2012957feaeb372c6bdaec0436b85b4af0b2f290261
+  metadata.gz: b32846afdb0a3f1d89c837064f2809d772b8eb1d74903ed449484c75c70975a82a367f591c958a217a616fd55066beef55db5fb6fbff8350787dc163ffe04b6b
+  data.tar.gz: 2b8b0b66fdaedcf77cb1b3b308ad54aafd92d5aaa175e9238b28d98ce4ad41da9bc6d6fb4e0c4fdd78dd7c23d6de247bdf7263e28ff4fec1723892866ddae596

data/lib/restiny/api/authentication.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+require 'securerandom'
+
+module Restiny
+  module Api
+    module Authentication
+      include Base
+
+      CODE_RESPONSE_TYPE = 'code'
+      AUTH_CODE_GRANT_TYPE = 'authorization_code'
+
+      def get_authorise_url(redirect_url: nil, state: nil)
+        check_oauth_client_id
+
+        params = {
+          response_type: CODE_RESPONSE_TYPE,
+          client_id: @oauth_client_id,
+          state: state || SecureRandom.hex(15)
+        }
+
+        params['redirect_url'] = redirect_url unless redirect_url.nil?
+
+        query = params.map { |k, v| "#{k}=#{v}" }.join('&')
+
+        "#{BUNGIE_URL}/en/oauth/authorize/?#{query}"
+      end
+
+      def request_access_token(code, redirect_url: nil)
+        check_oauth_client_id
+
+        params = { code: code, grant_type: AUTH_CODE_GRANT_TYPE, client_id: @oauth_client_id }
+        params['redirect_url'] = redirect_url unless redirect_url.nil?
+
+        response = http_client.post('/platform/app/oauth/token/', form: params)
+        response.raise_for_status
+
+        response.json
+      rescue HTTPX::Error => e
+        handle_authentication_error(e)
+      end
+
+      private
+
+      def handle_authentication_error(error)
+        raise Restiny::AuthenticationError,
+              "#{error.response.json['error_description']} (#{error.response.json['error']})"
+      rescue HTTPX::Error
+        raise Restiny::AuthenticationError,
+              "#{error.response.status}: #{error.response.headers['x-selfurl']}"
+      end
+
+      def check_oauth_client_id
+        return if @oauth_client_id
+
+        raise Restiny::RequestError,
+              'You need to set an OAuth client ID (Restiny.oauth_client_id)'
+      end
+    end
+  end
+end

data/lib/restiny/api/base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'restiny/constants'
+require 'restiny/errors'
+require 'httpx'
+require 'json'
+
+module Restiny
+  BUNGIE_URL = 'https://www.bungie.net'
+
+  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token, :user_agent
+
+  module Api
+    module Base
+      def get(endpoint)
+        make_api_request(endpoint, method: :get)
+      end
+
+      def post(endpoint, params: {})
+        make_api_request(endpoint, method: :post, params: params)
+      end
+
+      private
+
+      def http_client
+        HTTPX.with(origin: BUNGIE_URL, headers: api_headers).plugin(:follow_redirects, follow_insecure_redirects: true)
+      end
+
+      def make_api_request(endpoint, method: :get, params: {})
+        raise Restiny::InvalidParamsError, 'You need to set an API key (Restiny.api_key)' if @api_key.nil?
+
+        response = http_client.with(base_path: '/platform/').request(method, endpoint, json: params)
+        response.raise_for_status
+
+        response.json['Response']
+      rescue HTTPX::TimeoutError, HTTPX::ResolveError => e
+        raise Restiny::RequestError, e.message
+      rescue HTTPX::HTTPError => e
+        handle_api_error(e)
+      end
+
+      def handle_api_error(error)
+        klass = case error.response.status
+                when 400..499 then ::Restiny::RequestError
+                when 500..599 then ::Restiny::ResponseError
+                else ::Restiny::Error
+                end
+
+        raise klass, if error.response.headers['content-type'].match?(%r{^application/json})
+                       error_message_from_json(error.response.json)
+                     else
+                       error.status
+                     end
+      end
+
+      def error_message_from_json(json)
+        "#{json['ErrorStatus']} (#{json['ErrorCode']}): #{json['Message']}"
+      end
+
+      def api_headers
+        {}.tap do |headers|
+          headers['x-api-key'] = @api_key
+          headers['user-agent'] = @user_agent || "restiny v#{Restiny::VERSION}"
+          headers['authentication'] = "Bearer #{@access_token}" unless @access_token.nil?
+        end
+      end
+
+      def valid_array_param?(param)
+        param.is_a?(Array) && !param.empty?
+      end
+    end
+  end
+end

data/lib/restiny/api/manifest.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+require 'tmpdir'
+require 'uri'
+
+module Restiny
+  module Api
+    module Manifest
+      include Base
+
+      def fetch_manifest
+        result = get('/Destiny2/Manifest/')
+        return result unless result.nil?
+
+        raise Restiny::ResponseError, 'Unable to fetch manifest details'
+      end
+
+      def download_manifest_json(locale: 'en', definitions: [])
+        raise Restiny::InvalidParamsError, 'No definitions provided' unless valid_array_param?(definitions)
+        raise Restiny::InvalidParamsError, 'Unknown definitions provided' unless known_definitions?(definitions)
+
+        paths = fetch_manifest.dig('jsonWorldComponentContentPaths', locale)
+        raise Restiny::ResponseError, "Unable to find manifest JSON for locale '#{locale}'" if paths.nil?
+
+        {}.tap do |files|
+          definitions.each do |definition|
+            files[definition] = download_manifest_json_by_url(BUNGIE_URL + paths[definition])
+          end
+        end
+      end
+
+      def known_definitions?(definitions)
+        definitions.difference(Restiny::ManifestDefinition.values).empty?
+      end
+
+      def download_manifest_json_by_url(url)
+        filename = URI(url).path.split('/').last
+        path = File.join(Dir.tmpdir, filename)
+
+        HTTPX.get(url).copy_to(path)
+        raise Restiny::Error, "Unable to download JSON from #{url}" unless File.exist?(path)
+
+        path
+      rescue HTTPX::Error
+        raise Restiny::ResponseError, "Unable to download #{definition} JSON file"
+      end
+    end
+  end
+end

data/lib/restiny/api/membership.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Restiny
+  module Api
+    module Membership
+      include Base
+
+      def get_user_memberships_by_id(membership_id, membership_type: Platform::ALL)
+        raise Restiny::InvalidParamsError, 'Please provide a membership ID' if membership_id.nil?
+        raise Restiny::InvalidParamsError, 'Please provide a membership type' if membership_type.nil?
+
+        get("/User/GetMembershipsById/#{membership_id}/#{membership_type}/")
+      end
+
+      def get_primary_user_membership(membership_id, use_fallback: true)
+        raise Restiny::InvalidParamsError, 'Please provide a membership ID' if membership_id.nil?
+
+        result = get_user_memberships_by_id(membership_id)
+        return nil if result.nil?
+
+        unless result['primaryMembershipId'].nil?
+          result['destinyMemberships'].each do |membership|
+            return membership if membership['membershipID'] == result['primaryMembershipId']
+          end
+        end
+
+        result['destinyMemberships'][0] if use_fallback
+      end
+    end
+  end
+end

data/lib/restiny/api/profile.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Restiny
+  module Api
+    module Profile
+      include Base
+
+      def get_profile(membership_id:, membership_type:, components:, type_url: nil)
+        raise Restiny::InvalidParamsError, 'No components provided' unless valid_array_param?(components)
+
+        url = "/Destiny2/#{membership_type}/Profile/#{membership_id}/"
+        url += type_url if type_url
+        url += "?components=#{components.join(',')}"
+
+        get(url)
+      end
+
+      def get_character_profile(character_id:, membership_id:, membership_type:, components:)
+        get_profile(
+          membership_id: membership_id,
+          membership_type: membership_type,
+          components: components,
+          type_url: "Character/#{character_id}/"
+        )
+      end
+
+      def get_instanced_item_profile(item_id:, membership_id:, membership_type:, components:)
+        get_profile(
+          membership_id: membership_id,
+          membership_type: membership_type,
+          components: components,
+          type_url: "Item/#{item_id}/"
+        )
+      end
+    end
+  end
+end

data/lib/restiny/api/search.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Restiny
+  module Api
+    module Search
+      include Base
+
+      def search_player_by_bungie_name(name, membership_type: Platform::ALL)
+        display_name, display_name_code = name.split('#')
+        if display_name.nil? || display_name_code.nil?
+          raise Restiny::InvalidParamsError, 'You must provide a valid Bungie name'
+        end
+
+        post("/Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/", params: {
+               displayName: display_name, displayNameCode: display_name_code
+             })
+      end
+
+      def search_users_by_global_name(name:, page: 0)
+        post("/User/Search/GlobalName/#{page}/", params: { displayNamePrefix: name })
+      end
+    end
+  end
+end

data/lib/restiny/api/stats.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Restiny
+  module Api
+    module Stats
+      include Base
+
+      def get_post_game_carnage_report(activity_id:)
+        raise Restiny::InvalidParamsError, 'Please provide an activity ID' if activity_id.nil?
+
+        get("/Destiny2/Stats/PostGameCarnageReport/#{activity_id}/")
+      end
+
+      alias get_pgcr get_post_game_carnage_report
+    end
+  end
+end

data/lib/restiny/constants.rb

@@ -1,22 +1,45 @@
 # frozen_string_literal: true
 
 module Restiny
+  # Definitions for the gaming platforms supported by Destiny 2.
   module Platform
     ALL = -1
     XBOX = 1
     PSN = 2
     STEAM = 3
     EPIC = 6
+
+    def self.names
+      {
+        ALL => 'All',
+        XBOX => 'Xbox',
+        PSN => 'PSN',
+        STEAM => 'Steam',
+        EPIC => 'Epic'
+      }
+    end
   end
 
   module ItemLocation
+    # Definitions for the possible locations an item can be related to a character.
     UNKNOWN = 0
     INVENTORY = 1
     VAULT = 2
     VENDOR = 3
     POSTMASTER = 4
+
+    def self.names
+      {
+        UNKNOWN => 'Unknown',
+        INVENTORY => 'Inventory',
+        VAULT => 'Vault',
+        VENDOR => 'Vendor',
+        POSTMASTER => 'Postmaster'
+      }
+    end
   end
 
+  # Definitions for the tier/rarity of a particular item.
   module TierType
     UNKNOWN = 0
     CURRENCY = 1
@@ -25,47 +48,215 @@ module Restiny
     RARE = 4
     SUPERIOR = 5
     EXOTIC = 6
+
+    def self.names
+      {
+        UNKNOWN => 'Unknown',
+        CURRENCY => 'Currency',
+        BASIC => 'Basic',
+        COMMON => 'Common',
+        RARE => 'Rare',
+        SUPERIOR => 'Superior',
+        EXOTIC => 'Exotic'
+      }
+    end
   end
 
+  # Definitions for a Guardian's class.
   module GuardianClass
     TITAN = 0
     HUNTER = 1
     WARLOCK = 2
     UNKNOWN = 3
+
+    def self.names
+      {
+        TITAN => 'Titan',
+        HUNTER => 'Hunter',
+        WARLOCK => 'Warlock',
+        UNKNOWN => 'Unknown'
+      }
+    end
   end
 
+  # Definitions for a Guardian's race.
   module Race
     HUMAN = 0
     AWOKEN = 1
     EXO = 2
     UNKNOWN = 3
+
+    def self.names
+      {
+        HUMAN => 'Human',
+        AWOKEN => 'Awoken',
+        EXO => 'Exo',
+        UNKNOWN => 'Unknown'
+      }
+    end
   end
 
+  # Definitions for a Guardian's gender.
   module Gender
     MASCULINE = 0
     FEMININE = 1
     UNKNOWN = 2
+
+    def self.names
+      {
+        MASCULINE => 'Masculine',
+        FEMININE => 'Feminine',
+        UNKNOWN => 'Unknown'
+      }
+    end
   end
 
+  # Definitions for the various types of ammunition used in the game.
   module Ammunition
     NONE = 0
     PRIMARY = 1
     SPECIAL = 2
     HEAVY = 3
     UNKNOWN = 4
+
+    def self.names
+      {
+        NONE => 'None',
+        PRIMARY => 'Primary',
+        SPECIAL => 'Special',
+        HEAVY => 'Heavy',
+        UNKNOWN => 'Unknown'
+      }
+    end
   end
 
+  # Definitions for the various component types used when requesting a profile entry.
   module ComponentType
-    CHARACTERS = 'Characters'
-    CHARACTER_EQUIPMENT = 'CharacterEquipment'
-    CHARACTER_INVENTORIES = 'CharacterInventories'
-    CHARACTER_LOADOUTS = 'CharacterLoadouts'
-    PROFILES = 'Profiles'
-    PROFILE_INVENTORIES = 'ProfileInventories'
-    ITEM_INSTANCES = 'ItemInstances'
-    ITEM_SOCKETS = 'ItemSockets'
-    ITEM_COMMON_DATA = 'ItemCommonData'
-    ITEM_PLUG_STATES = 'ItemPlugStates'
-    ITEM_REUSABLE_PLUGS = 'ItemReusablePlugs'
+    PROFILES = '100'
+    VENDOR_RECEIPTS = '101'
+    PROFILE_INVENTORIES = '102'
+    PROFILE_CURRENCIES = '103'
+    PROFILE_PROGRESSION = '104'
+    PLATFORM_SILVER = '105'
+    CHARACTERS = '200'
+    CHARACTER_INVENTORIES = '201'
+    CHARACTER_PROGRESSIONS = '202'
+    CHARACTER_RENDERDATA = '203'
+    CHARACTER_ACTIVITIES = '204'
+    CHARACTER_EQUIPMENT = '205'
+    CHARACTER_LOADOUTS = '206'
+    ITEM_INSTANCES = '300'
+    ITEM_OBJECTIVES = '301'
+    ITEM_PERKS = '302'
+    ITEM_RENDER_DATA = '303'
+    ITEM_STATS = '304'
+    ITEM_SOCKETS = '305'
+    ITEM_TALENT_GRIDS = '306'
+    ITEM_COMMON_DATA = '307'
+    ITEM_PLUG_STATES = '308'
+    ITEM_PLUG_OBJECTIVES = '309'
+    ITEM_REUSABLE_PLUGS = '310'
+    VENDORS = '400'
+    VENDOR_CATEGORIES = '401'
+    VENDOR_SALES = '402'
+    KIOSKS = '500'
+    CURRENCY_LOOKUPS = '600'
+    PRESENTATION_NODES = '700'
+    COLLECTIBLES = '800'
+    RECORDS = '900'
+    TRANSITORY = '1000'
+    METRICS = '1100'
+    STRING_VARIABLES = '1200'
+    CRAFTABLES = '1300'
+    SOCIAL_COMMENDATIONS = '1400'
+  end
+
+  # The categories of data stored in the manifest.
+  module ManifestDefinition
+    def self.values
+      constants.map { |c| const_get(c) }
+    end
+
+    ACHIEVEMENT = 'DestinyAchievementDefinition'
+    ACTIVITY = 'DestinyActivityDefinition'
+    ACTIVITY_GRAPH = 'DestinyActivityGraphDefinition'
+    ACTIVITY_INTERACTABLE = 'DestinyActivityInteractableDefinition'
+    ACTIVITY_MODE = 'DestinyActivityModeDefinition'
+    ACTIVITY_MODIFIER = 'DestinyActivityModifierDefinition'
+    ACTIVITY_TYPE = 'DestinyActivityTypeDefinition'
+    ART_DYE_CHANNEL = 'DestinyArtDyeChannelDefinition'
+    ART_DYE_REFERENCE = 'DestinyArtDyeReferenceDefinition'
+    ARTIFACT = 'DestinyArtifactDefinition'
+    BOND = 'DestinyBondDefinition'
+    BREAKER_TYPE = 'DestinyBreakerTypeDefinition'
+    CHARACTER_CUSTOMIZATION_CATEGORY = 'DestinyCharacterCustomizationCategoryDefinition'
+    CHARACTER_CUSTOMIZATION_OPTION = 'DestinyCharacterCustomizationOptionDefinition'
+    CHECKLIST = 'DestinyChecklistDefinition'
+    CLASS = 'DestinyClassDefinition'
+    COLLECTIBLE = 'DestinyCollectibleDefinition'
+    DAMAGE_TYPE = 'DestinyDamageTypeDefinition'
+    DESTINATION = 'DestinyDestinationDefinition'
+    ENERGY_TYPE = 'DestinyEnergyTypeDefinition'
+    ENTITLEMENT_OFFER = 'DestinyEntitlementOfferDefinition'
+    EQUIPMENT_SLOT = 'DestinyEquipmentSlotDefinition'
+    EVENT_CARD = 'DestinyEventCardDefinition'
+    FACTION = 'DestinyFactionDefinition'
+    GENDER = 'DestinyGenderDefinition'
+    GUARDIAN_RANK_CONSTANTS = 'DestinyGuardianRankConstantsDefinition'
+    GUARDIAN_RANK = 'DestinyGuardianRankDefinition'
+    INVENTORY_BUCKET = 'DestinyInventoryBucketDefinition'
+    INVENTORY_ITEM = 'DestinyInventoryItemDefinition'
+    INVENTORY_ITEM_LITE = 'DestinyInventoryItemLiteDefinition'
+    ITEM_CATEGORY = 'DestinyItemCategoryDefinition'
+    ITEM_TIER_TYPE = 'DestinyItemTierTypeDefinition'
+    LOADOUT_COLOR = 'DestinyLoadoutColorDefinition'
+    LOADOUT_CONSTANTS = 'DestinyLoadoutConstantsDefinition'
+    LOADOUT_ICON = 'DestinyLoadoutIconDefinition'
+    LOADOUT_NAME = 'DestinyLoadoutNameDefinition'
+    LOCATION = 'DestinyLocationDefinition'
+    LORE = 'DestinyLoreDefinition'
+    MATERIAL_REQUIREMENT_SET = 'DestinyMaterialRequirementSetDefinition'
+    MEDAL_TIER = 'DestinyMedalTierDefinition'
+    METRIC = 'DestinyMetricDefinition'
+    MILESTONE = 'DestinyMilestoneDefinition'
+    NODE_STEP_SUMMARY = 'DestinyNodeStepSummaryDefinition'
+    OBJECTIVE = 'DestinyObjectiveDefinition'
+    PLACE = 'DestinyPlaceDefinition'
+    PLATFORM_BUCKET_MAPPING = 'DestinyPlatformBucketMappingDefinition'
+    PLUG_SET = 'DestinyPlugSetDefinition'
+    POWER_CAP = 'DestinyPowerCapDefinition'
+    PRESENTATION_NODE = 'DestinyPresentationNodeDefinition'
+    PROGRESSION = 'DestinyProgressionDefinition'
+    PROGRESSION_LEVEL_REQUIREMENT = 'DestinyProgressionLevelRequirementDefinition'
+    PROGRESSION_MAPPING = 'DestinyProgressionMappingDefinition'
+    RACE = 'DestinyRaceDefinition'
+    RECORD = 'DestinyRecordDefinition'
+    REPORT_REASON_CATEGORY = 'DestinyReportReasonCategoryDefinition'
+    REWARD_ADJUSTER_POINTER = 'DestinyRewardAdjusterPointerDefinition'
+    REWARD_ADJUSTER_PROGRESSION_MAP = 'DestinyRewardAdjusterProgressionMapDefinition'
+    REWARD_ITEM_LIST = 'DestinyRewardItemListDefinition'
+    REWARD_MAPPING = 'DestinyRewardMappingDefinition'
+    REWARD_SHEET = 'DestinyRewardSheetDefinition'
+    REWARD_SOURCE = 'DestinyRewardSourceDefinition'
+    SACK_REWARD_ITEM_LIST = 'DestinySackRewardItemListDefinition'
+    SANDBOX_PATTERN = 'DestinySandboxPatternDefinition'
+    SANDBOX_PERK = 'DestinySandboxPerkDefinition'
+    SEASON = 'DestinySeasonDefinition'
+    SEASON_PASS = 'DestinySeasonPassDefinition'
+    SOCIAL_COMMENDATION = 'DestinySocialCommendationDefinition'
+    SOCIAL_COMMENDATION_NODE = 'DestinySocialCommendationNodeDefinition'
+    SOCKET_CATEGORY = 'DestinySocketCategoryDefinition'
+    SOCKET_TYPE = 'DestinySocketTypeDefinition'
+    STAT = 'DestinyStatDefinition'
+    STAT_GROUP = 'DestinyStatGroupDefinition'
+    TALENT_GRID = 'DestinyTalentGridDefinition'
+    TRAIT = 'DestinyTraitDefinition'
+    UNLOCK_COUNT_MAPPING = 'DestinyUnlockCountMappingDefinition'
+    UNLOCK = 'DestinyUnlockDefinition'
+    UNLOCK_EVENT = 'DestinyUnlockEventDefinition'
+    UNLOCK_EXPRESSION_MAPPING = 'DestinyUnlockExpressionMappingDefinition'
+    UNLOCK_VALUE = 'DestinyUnlockValueDefinition'
+    VENDOR = 'DestinyVendorDefinition'
+    VENDOR_GROUP = 'DestinyVendorGroupDefinition'
   end
 end

data/lib/restiny/errors.rb

@@ -1,28 +1,11 @@
 # frozen_string_literal: true
 
 module Restiny
-  class Error < StandardError
-    def initialize(message, status = nil)
-      @status = status
-      super(message)
-    end
-  end
-
-  class NetworkError < Error
-  end
-
-  class RequestError < Error
-  end
-
-  class InvalidParamsError < RequestError
-  end
-
-  class RateLimitedError < RequestError
-  end
-
-  class AuthenticationError < RequestError
-  end
-
-  class ResponseError < Error
-  end
+  class Error < StandardError; end
+  class NetworkError < Error; end
+  class RequestError < Error; end
+  class InvalidParamsError < RequestError; end
+  class RateLimitedError < RequestError; end
+  class AuthenticationError < RequestError; end
+  class ResponseError < Error; end
 end

data/lib/restiny/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restiny
-  VERSION = '5.0.0'
+  VERSION = '6.0.0'
 end

data/lib/restiny.rb

@@ -3,198 +3,21 @@
 $LOAD_PATH.unshift(__dir__)
 
 require 'restiny/version'
-require 'restiny/constants'
-require 'restiny/errors'
-require 'restiny/manifest'
-
-require 'down'
-require 'faraday'
-require 'faraday/follow_redirects'
-require 'faraday/destiny/api'
-require 'faraday/destiny/auth'
-require 'json'
-require 'securerandom'
-require 'tmpdir'
-require 'zip'
-
+require 'restiny/api/authentication'
+require 'restiny/api/manifest'
+require 'restiny/api/membership'
+require 'restiny/api/profile'
+require 'restiny/api/search'
+require 'restiny/api/stats'
+
+# The main Restiny module.
 module Restiny
   extend self
 
-  BUNGIE_URL = 'https://www.bungie.net'
-  API_BASE_URL = "#{BUNGIE_URL}/platform".freeze
-
-  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token, :user_agent
-
-  # OAuth methods
-
-  def get_authorise_url(redirect_url: nil, state: nil)
-    check_oauth_client_id
-
-    @oauth_state = state || SecureRandom.hex(15)
-
-    params = { response_type: 'code', client_id: @oauth_client_id, state: @oauth_state }
-    params['redirect_url'] = redirect_url unless redirect_url.nil?
-
-    auth_connection.build_url("#{BUNGIE_URL}/en/oauth/authorize/", params).to_s
-  end
-
-  def request_access_token(code:, redirect_url: nil)
-    check_oauth_client_id
-
-    params = { code: code, grant_type: 'authorization_code', client_id: @oauth_client_id }
-    params['redirect_url'] = redirect_url unless redirect_url.nil?
-
-    auth_connection.post('app/oauth/token/', params).body
-  end
-
-  # Manifest methods
-
-  def download_manifest(locale: 'en', force_download: false)
-    result = api_get('Destiny2/Manifest/')
-    raise Restiny::ResponseError, 'Unable to determine manifest details' if result.nil?
-
-    live_version = result['version']
-
-    @manifests ||= {}
-    @manifest_versions ||= {}
-
-    if force_download || @manifests[locale].nil? || @manifest_versions[locale] != live_version
-      manifest_db_url = result.dig('mobileWorldContentPaths', locale)
-      raise Restiny::RequestError, 'Unknown locale' if manifest_db_url.nil?
-
-      database_file_path = Zip::File.open(Down.download(BUNGIE_URL + manifest_db_url)) do |zip_file|
-        File.join(Dir.tmpdir, "#{live_version}.en.content.db").tap do |path|
-          zip_file.first.extract(path) unless File.exist?(path)
-        end
-      end
-
-      @manifests[locale] = Manifest.new(database_file_path, live_version)
-      @manifest_versions[locale] = live_version
-    end
-
-    @manifests[locale]
-  rescue Down::Error => e
-    raise Restiny::NetworkError.new('Unable to download the manifest file', e.response.code)
-  rescue Zip::Error => e
-    raise Restiny::Error, "Unable to unzip the manifest file (#{e})"
-  end
-
-  # Profile and related methods
-
-  def get_profile(membership_id:, membership_type:, components:, type_url: nil)
-    if !components.is_a?(Array) || components.empty?
-      raise Restiny::InvalidParamsError, 'Please provide at least one component'
-    end
-
-    url = "Destiny2/#{membership_type}/Profile/#{membership_id}/"
-    url += type_url if type_url
-    url += "?components=#{components.join(',')}"
-
-    api_get(url)
-  end
-
-  def get_character_profile(character_id:, membership_id:, membership_type:, components:)
-    get_profile(
-      membership_id: membership_id,
-      membership_type: membership_type,
-      components: components,
-      type_url: "Character/#{character_id}/"
-    )
-  end
-
-  def get_instanced_item_profile(item_id:, membership_id:, membership_type:, components:)
-    get_profile(
-      membership_id: membership_id,
-      membership_type: membership_type,
-      components: components,
-      type_url: "Item/#{item_id}/"
-    )
-  end
-
-  # User methods.
-
-  def get_user_memberships_by_id(membership_id, membership_type: Platform::ALL)
-    raise Restiny::InvalidParamsError, 'Please provide a membership ID' if membership_id.nil?
-
-    api_get("User/GetMembershipsById/#{membership_id}/#{membership_type}/")
-  end
-
-  def get_user_primary_membership(parent_membership_id, use_fallback: true)
-    result = get_user_memberships_by_id(parent_membership_id)
-    return nil if result.nil? || result['primaryMembershipId'].nil?
-
-    result['destinyMemberships'].each do |membership|
-      return membership if membership['membershipID'] == result['primaryMembershipId']
-    end
-
-    result['destinyMemberships'][0] if use_fallback
-  end
-
-  def search_player_by_bungie_name(name, membership_type: Platform::ALL)
-    display_name, display_name_code = name.split('#')
-    if display_name.nil? || display_name_code.nil?
-      raise Restiny::InvalidParamsError, 'You must provide a valid Bungie name'
-    end
-
-    api_post(
-      "Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/",
-      params: {
-        displayName: display_name,
-        displayNameCode: display_name_code
-      }
-    )
-  end
-
-  def search_users_by_global_name(name, page: 0)
-    api_post("User/Search/GlobalName/#{page}/", params: { displayNamePrefix: name })
-  end
-
-  # General request methods
-
-  def api_get(url, params: {})
-    api_connection.get(url, params, token_header).body
-  end
-
-  def api_post(url, params: {})
-    api_connection.post(url, params, token_header).body
-  end
-
-  private
-
-  def check_oauth_client_id
-    raise Restiny::RequestError, 'You need to set an OAuth client ID' unless @oauth_client_id
-  end
-
-  def default_headers
-    { 'User-Agent': @user_agent || "restiny v#{Restiny::VERSION}" }
-  end
-
-  def api_connection
-    raise Restiny::InvalidParamsError, 'You need to set an API key' unless @api_key
-
-    @connection ||=
-      Faraday.new(
-        url: API_BASE_URL,
-        headers: default_headers.merge('X-API-KEY': @api_key)
-      ) do |faraday|
-        faraday.request :json
-        faraday.response :follow_redirects
-        faraday.response :destiny_api
-        faraday.response :json
-      end
-  end
-
-  def auth_connection
-    @auth_connection ||=
-      Faraday.new(url: API_BASE_URL, headers: default_headers) do |faraday|
-        faraday.request :url_encoded
-        faraday.response :follow_redirects
-        faraday.response :destiny_auth
-        faraday.response :json
-      end
-  end
-
-  def token_header
-    {}.tap { |headers| headers['authorization'] = "Bearer #{@access_token}" if @access_token }
-  end
+  include Api::Authentication
+  include Api::Manifest
+  include Api::Membership
+  include Api::Profile
+  include Api::Search
+  include Api::Stats
 end

metadata

@@ -1,85 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: restiny
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2023-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: down
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: faraday-follow_redirects
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.1'
 description: A gem for interacting with Bungie's Destiny API.
 email:
 - d+restiny@waferbaby.com
@@ -87,12 +31,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/faraday/destiny/api.rb
-- lib/faraday/destiny/auth.rb
 - lib/restiny.rb
+- lib/restiny/api/authentication.rb
+- lib/restiny/api/base.rb
+- lib/restiny/api/manifest.rb
+- lib/restiny/api/membership.rb
+- lib/restiny/api/profile.rb
+- lib/restiny/api/search.rb
+- lib/restiny/api/stats.rb
 - lib/restiny/constants.rb
 - lib/restiny/errors.rb
-- lib/restiny/manifest.rb
 - lib/restiny/version.rb
 homepage: http://github.com/waferbaby/restiny
 licenses:

data/lib/faraday/destiny/api.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'restiny/errors'
-
-module Faraday
-  module Restiny
-    Faraday::Response.register_middleware(destiny_api: 'Faraday::Restiny::Api')
-
-    class Api < Middleware
-      def on_complete(env)
-        return if env['response_body'].empty? || !env['response_body']['ErrorCode']
-
-        if env['response_body']['ErrorCode'] == 1
-          env[:body] = env['response_body']['Response']
-          return
-        end
-
-        klass =
-          case env['status']
-          when 400..499
-            ::Restiny::RequestError
-          when 500..599
-            ::Restiny::ResponseError
-          else
-            ::Restiny::Error
-          end
-
-        raise klass.new(env['response_body']['Message'], env['response_body']['ErrorStatus'])
-      end
-    end
-  end
-end

data/lib/faraday/destiny/auth.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'restiny/errors'
-
-module Faraday
-  module Restiny
-    Faraday::Response.register_middleware(destiny_auth: 'Faraday::Restiny::Auth')
-
-    class Auth < Middleware
-      def on_complete(env)
-        return if env['response_body'].empty? || env['url'].to_s !~ /oauth/
-
-        return unless env['response_body']['error']
-
-        raise ::Restiny::AuthenticationError.new(
-          env['response_body']['error_description'],
-          env['response_body']['error']
-        )
-      end
-    end
-  end
-end

data/lib/restiny/manifest.rb

@@ -1,127 +0,0 @@
-# frozen_string_literal: true
-
-require 'sqlite3'
-
-module Restiny
-  class Manifest
-    ENTITIES = {
-      Achievement: %w[achievement achievements],
-      Activity: %w[activity activities],
-      ActivityGraph: %w[activity_graph activity_graphs],
-      ActivityMode: %w[activity_mode activity_modes],
-      ActivityModifier: %w[activity_modifier activity_modifiers],
-      ActivityType: %w[activity_type activity_types],
-      Artifact: %w[artifact artifacts],
-      Bond: %w[bonds bonds],
-      BreakerType: %w[breaker_type breaker_types],
-      Checklist: %w[checklist checklists],
-      Class: %w[guardian_class guardian_classes],
-      Collectible: %w[collectible collectibles],
-      DamageType: %w[damage_type damage_types],
-      Destination: %w[destination destinations],
-      EnergyType: %w[energy_type energy_types],
-      EquipmentSlot: %w[equipment_slot equipment_slots],
-      EventCard: %w[event_card event_cards],
-      Faction: %w[faction factions],
-      Gender: %w[guardian_gender guardian_genders],
-      GuardianRank: %w[guardian_rank guardian_ranks],
-      GuardianRankConstants: %w[guardian_rank_constant guardian_rank_constants],
-      HistoricalStats: %w[historical_stat historical_stats],
-      InventoryBucket: %w[inventory_bucket inventory_buckets],
-      InventoryItem: %w[inventory_item inventory_items],
-      ItemCategory: %w[item_category item_categories],
-      ItemTierType: %w[item_tier_type item_tier_types],
-      LoadoutColor: %w[loadout_color loadout_colors],
-      LoadoutConstants: %w[loadout_constant loadout_constants],
-      LoadoutIcon: %w[loadout_icon loadout_icons],
-      LoadoutName: %w[loadout_name loadout_names],
-      Location: %w[location locations],
-      Lore: %w[lore_entry lore_entries],
-      MaterialRequirementSet: %w[material_requirement_set material_requirement_sets],
-      MedalTier: %w[medal_tier medal_tiers],
-      Metric: %w[metric metrics],
-      Milestone: %w[milestone milestones],
-      Objective: %w[objective objectives],
-      Place: %w[place places],
-      PlugSet: %w[plug_set plug_sets],
-      PowerCap: %w[power_cap power_caps],
-      PresentationNode: %w[presentation_node presentation_nodes],
-      Progression: %w[progression progressions],
-      ProgressionLevelRequirement: %w[progression_level_requirement progression_level_requirements],
-      Race: %w[guardian_race guardian_races],
-      Record: %w[record records],
-      ReportReasonCategory: %w[report_reason_category report_reason_categories],
-      RewardSource: %w[reward_source reward_sources],
-      SackRewardItemList: %w[sack_reward_item_list sack_reward_item_lists],
-      SandboxPattern: %w[sandbox_pattern sandbox_patterns],
-      SandboxPerk: %w[sandbox_perk sandbox_perks],
-      Season: %w[season seasons],
-      SeasonPass: %w[season_pass season_passes],
-      SocialCommendation: %w[commendation commendations],
-      SocialCommendationNode: %w[commendation_node commendation_nodes],
-      SocketCategory: %w[socket_category socket_categories],
-      SocketType: %w[socket_type socket_types],
-      Stat: %w[stat stats],
-      StatGroup: %w[stat_group stat_groups],
-      TalentGrid: %w[talent_grid talent_grids],
-      Trait: %w[trait traits],
-      Unlock: %w[unlock unlocks],
-      Vendor: %w[vendor vendors],
-      VendorGroup: %w[vendor_group vendor_groups]
-    }.freeze
-
-    attr_reader :version
-
-    ENTITIES.each do |entity, method_names|
-      full_table_name = "Destiny#{entity}Definition"
-      single_method_name, plural_method_name = method_names
-
-      define_method(single_method_name) { |id| fetch_item(table_name: full_table_name, id: id) }
-      define_method(plural_method_name) { |limit: nil| fetch_items(table_name: full_table_name, limit: limit) }
-    end
-
-    def initialize(file_path, version)
-      if file_path.empty? || !File.exist?(file_path) || !File.file?(file_path)
-        raise Restiny::InvalidParamsError, 'You must provide a valid path for the manifest file'
-      end
-
-      @database = SQLite3::Database.new(file_path, results_as_hash: true)
-      @version = version
-    end
-
-    private
-
-    def fetch_item(table_name:, id:)
-      query = "SELECT json FROM #{table_name} WHERE json_extract(json, '$.hash')=?"
-      result = @database.execute(query, id)
-
-      JSON.parse(result[0]['json']) unless result.nil? || result.count < 1 || !result[0].include?('json')
-    rescue SQLite3::Exception => e
-      raise Restiny::RequestError, "Error while fetching item (#{e})"
-    end
-
-    def fetch_items(table_name:, limit: nil)
-      bindings = []
-
-      query = "SELECT json FROM #{table_name} ORDER BY json_extract(json, '$.index')"
-
-      if limit
-        query << ' LIMIT ?'
-        bindings << limit
-      end
-
-      items = []
-
-      @database.execute(query, bindings) do |row|
-        item = JSON.parse(row['json'])
-        yield item if block_given?
-
-        items << item
-      end
-
-      items unless block_given?
-    rescue SQLite3::Exception => e
-      raise Restiny::RequestError, "Error while fetching items (#{e})"
-    end
-  end
-end