restiny 2.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d5b81f9aadd44def19fb9af625b26692992457edaf57eeba97b46896f26e032
-  data.tar.gz: f058584408a167934ae67f9e8c160f75e542f80558446ee312fa2ce34b763ace
+  metadata.gz: b1d08e2f02105ea2a6330679fe9cae0534bbb4a7d3c0fb7803d43fc70ae4ebdd
+  data.tar.gz: 80ab03d4fdbbf65ae276265f89e7c00d9a4f55870fdc0398893e45d429f44179
 SHA512:
-  metadata.gz: 5b737a79ec4728c34106b701db09f654c9d642cfd62b3ff311501a70afcf954f07ad92f0d1282c9a59686bffef568ef2b1fb5466e97cd267b389c1634c28b742
-  data.tar.gz: 99c7c3c4519a6a539a11a2970f18a38443ee4a9587b6df980cb74b03e425f1ce134e48c075af0d5b8d29339e086310eda6c44ac352e0b4daf80997923fded98b
+  metadata.gz: 4abf818ba76d6f6fefbf2070a1d56162462ac2d5a22dae7725383c34ae884d901be3539b78342510beaa93ddc9c3a554e90fcee473825bdcad144ab9a88af8c5
+  data.tar.gz: 78f09f843a2e5c00067b95e1e5aad5a938d181c56081b744e1ae0638605af65548de6d4b117d3667e326bc9ed2ef61aaa80b673990f15cc490045aa2aa9f95ca

data/lib/restiny/constants.rb

@@ -9,20 +9,6 @@ module Restiny
     EPIC = 6
   end
 
-  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"
-  end
-
   module ItemLocation
     UNKNOWN = 0
     INVENTORY = 1
@@ -41,7 +27,7 @@ module Restiny
     EXOTIC = 6
   end
 
-  module Class
+  module GuardianClass
     TITAN = 0
     HUNTER = 1
     WARLOCK = 2
@@ -68,4 +54,18 @@ module Restiny
     HEAVY = 3
     UNKNOWN = 4
   end
+
+  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"
+  end
 end

data/lib/restiny/errors.rb

@@ -8,6 +8,9 @@ module Restiny
     end
   end
 
+  class NetworkError < Error
+  end
+
   class RequestError < Error
   end
 

data/lib/restiny/manifest.rb

@@ -1,8 +1,6 @@
 # frozen_string/literal: true
-require "down"
-require "json"
+
 require "sqlite3"
-require "zip"
 
 module Restiny
   class Manifest
@@ -72,7 +70,7 @@ module Restiny
       VendorGroup: %w[vendor_group vendor_groups]
     }
 
-    attr_reader :file_path
+    attr_reader :file_path, :version
 
     ENTITIES.each do |entity, method_names|
       full_table_name = "Destiny#{entity}Definition"
@@ -87,26 +85,14 @@ module Restiny
       end
     end
 
-    def self.download_by_url(url)
-      zipped_file = Down.download(url)
-      manifest_path = zipped_file.path + ".db"
-
-      Zip::File.open(zipped_file) { |file| file.first.extract(manifest_path) }
-
-      new(manifest_path)
-    rescue Down::ResponseError => error
-      raise Restiny::NetworkError.new("Unable to download the manifest file", error.response.code)
-    rescue Zip::Error => error
-      raise Restiny::Error.new("Unable to unzip the manifest file (#{error})")
-    end
-
-    def initialize(file_path)
+    def initialize(file_path, version)
       if file_path.empty? || !File.exist?(file_path) || !File.file?(file_path)
         raise Restiny::InvalidParamsError.new("You must provide a valid path for the manifest file")
       end
 
       @database = SQLite3::Database.new(file_path, results_as_hash: true)
       @file_path = file_path
+      @version = version
     end
 
     private

data/lib/restiny/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restiny
-  VERSION = "2.0.1"
+  VERSION = "3.1.0"
 end

data/lib/restiny.rb

@@ -11,7 +11,11 @@ require "faraday"
 require "faraday/follow_redirects"
 require "faraday/destiny/api"
 require "faraday/destiny/auth"
+
+require "down"
+require "json"
 require "securerandom"
+require "zip"
 
 module Restiny
   extend self
@@ -19,7 +23,7 @@ module Restiny
   BUNGIE_URL = "https://www.bungie.net"
   API_BASE_URL = BUNGIE_URL + "/platform"
 
-  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token, :refresh_token, :manifest
+  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token, :user_agent
 
   # OAuth methods
 
@@ -29,7 +33,7 @@ module Restiny
     @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?
+    params["redirect_url"] = redirect_url unless redirect_url.nil?
 
     auth_connection.build_url(BUNGIE_URL + "/en/oauth/authorize/", params).to_s
   end
@@ -38,23 +42,39 @@ module Restiny
     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?
+    params["redirect_url"] = redirect_url unless redirect_url.nil?
 
     auth_post("app/oauth/token/", params)
   end
 
   # Manifest methods
 
-  def get_manifest_url(locale: "en")
-    result = api_get("Destiny2/Manifest/").dig("mobileWorldContentPaths", locale)
-    BUNGIE_URL + result
-  end
+  def get_manifest(locale: "en", force_download: false)
+    result = api_get("Destiny2/Manifest/")
+    raise Restiny::ResponseError.new("Unable to determine manifest details") if result.nil?
+
+    live_version = result.dig("version")
+
+    @manifests ||= {}
+    @manifest_versions ||= {}
 
-  def download_manifest(locale: "en")
-    manifest_url = get_manifest_url
-    raise Restiny::ResponseError.new("Unable to determine manifest URL") if manifest_url.nil?
+    if force_download || @manifests[locale].nil? || @manifest_versions[locale] != live_version
+      url = BUNGIE_URL + result.dig("mobileWorldContentPaths", locale)
 
-    Manifest.download_by_url(BUNGIE_URL + manifest_url)
+      zipped_file = Down.download(url)
+      database_file_path = zipped_file.path + ".db"
+
+      Zip::File.open(zipped_file) { |file| file.first.extract(database_file_path) }
+
+      @manifests[locale] = Manifest.new(database_file_path, live_version)
+      @manifest_versions[locale] = live_version
+    end
+
+    @manifests[locale]
+  rescue Down::Error => error
+    raise Restiny::NetworkError.new("Unable to download the manifest file", error.response.code)
+  rescue Zip::Error => error
+    raise Restiny::Error.new("Unable to unzip the manifest file (#{error})")
   end
 
   # Profile and related methods
@@ -96,6 +116,17 @@ module Restiny
     api_get("User/GetMembershipsById/#{membership_id}/#{membership_type}/")
   end
 
+  def get_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
+
+    return 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?
@@ -136,7 +167,7 @@ module Restiny
   end
 
   def default_headers
-    { "User-Agent": "restiny v#{Restiny::VERSION}" }
+    { "User-Agent": @user_agent || "restiny v#{Restiny::VERSION}" }
   end
 
   def api_connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restiny
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday