restiny 3.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64bba6028ea7ef4119e6019011b4d35cf1fb850903b446387b3aae0ba47c03e7
-  data.tar.gz: 629969c98d6d518c3cefb7f9c85d177a404408f6d88dd8d979be5e2be75c1027
+  metadata.gz: 366f1afb92a72c9adbc817eb5e8651fcd2df0656584c138660708525343b8407
+  data.tar.gz: 7fa7f9df35a0ee12206627a43c7ffb4d299819c5d26340c83186f520e30de99e
 SHA512:
-  metadata.gz: 65a76e2738de6da2e4e3dfaf6015f689d8c95d8fea9daa952d153fdf251feec6a145fa16b627bfd2baea1eb3c05cc7d83058e1670b1715d9ea21c18409f081c5
-  data.tar.gz: 70565f0ddc5c22d76f32cb1e4883261e3bbf181bd7e330a125a3c6982db1b95f6e14342aae7600379ded28697eef9f369ce4b50896b6388de984eea520aec971
+  metadata.gz: 8c71e268039ac692949adf704883eda27bc2da5d747dab7d610a09621921ef3e64e4909bca9456431f404a0ff4211a19f31efbdf7eb57701bf852bacf360cf90
+  data.tar.gz: 77c6af1bf576b0e590a6659565af7739316cbc3a72b159a26c8b3077308c3713f1cb8cf45c103d3a0993c2012957feaeb372c6bdaec0436b85b4af0b2f290261

data/lib/faraday/destiny/api.rb

@@ -1,21 +1,23 @@
-require "faraday"
-require "restiny/errors"
+# frozen_string_literal: true
+
+require 'faraday'
+require 'restiny/errors'
 
 module Faraday
   module Restiny
-    Faraday::Response.register_middleware(destiny_api: "Faraday::Restiny::Api")
+    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"].dig("ErrorCode")
+        return if env['response_body'].empty? || !env['response_body']['ErrorCode']
 
-        if env["response_body"]["ErrorCode"] == 1
-          env[:body] = env["response_body"].dig("Response")
+        if env['response_body']['ErrorCode'] == 1
+          env[:body] = env['response_body']['Response']
           return
         end
 
         klass =
-          case env["status"]
+          case env['status']
           when 400..499
             ::Restiny::RequestError
           when 500..599
@@ -24,7 +26,7 @@ module Faraday
             ::Restiny::Error
           end
 
-        raise klass.new(env["response_body"]["Message"], env["response_body"]["ErrorStatus"])
+        raise klass.new(env['response_body']['Message'], env['response_body']['ErrorStatus'])
       end
     end
   end

data/lib/faraday/destiny/auth.rb

@@ -1,20 +1,22 @@
-require "faraday"
-require "restiny/errors"
+# frozen_string_literal: true
+
+require 'faraday'
+require 'restiny/errors'
 
 module Faraday
   module Restiny
-    Faraday::Response.register_middleware(destiny_auth: "Faraday::Restiny::Auth")
+    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 if env['response_body'].empty? || env['url'].to_s !~ /oauth/
+
+        return unless env['response_body']['error']
 
-        if env["response_body"]["error"]
-          raise ::Restiny::AuthenticationError.new(
-                  env["response_body"]["error_description"],
-                  env["response_body"]["error"]
-                )
-        end
+        raise ::Restiny::AuthenticationError.new(
+          env['response_body']['error_description'],
+          env['response_body']['error']
+        )
       end
     end
   end

data/lib/restiny/constants.rb

@@ -56,16 +56,16 @@ module Restiny
   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"
+    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,6 +1,6 @@
-# frozen_string/literal: true
+# frozen_string_literal: true
 
-require "sqlite3"
+require 'sqlite3'
 
 module Restiny
   class Manifest
@@ -68,49 +68,36 @@ module Restiny
       Unlock: %w[unlock unlocks],
       Vendor: %w[vendor vendors],
       VendorGroup: %w[vendor_group vendor_groups]
-    }
+    }.freeze
 
-    attr_reader :file_path, :version
+    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 do |id|
-        fetch_item(table_name: full_table_name, id: id)
-      end
-
-      define_method plural_method_name do |limit: nil|
-        fetch_items(table_name: full_table_name, limit: limit)
-      end
+      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.new("You must provide a valid path for the manifest file")
+        raise Restiny::InvalidParamsError, '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
 
-    def get_entity_names
-      query = "SELECT name from sqlite_schema WHERE name LIKE 'Destiny%'"
-      @database.execute(query).map { |row| row["name"].gsub(/(Destiny|Definition)/, "") }
-    end
-
     def fetch_item(table_name:, id:)
       query = "SELECT json FROM #{table_name} WHERE json_extract(json, '$.hash')=?"
       result = @database.execute(query, id)
 
-      return nil if result.nil? || result.count < 1 || !result[0].include?("json")
-
-      JSON.parse(result[0]["json"])
+      JSON.parse(result[0]['json']) unless result.nil? || result.count < 1 || !result[0].include?('json')
     rescue SQLite3::Exception => e
-      raise Restiny::RequestError.new("Error while fetching item (#{e})")
+      raise Restiny::RequestError, "Error while fetching item (#{e})"
     end
 
     def fetch_items(table_name:, limit: nil)
@@ -119,14 +106,14 @@ module Restiny
       query = "SELECT json FROM #{table_name} ORDER BY json_extract(json, '$.index')"
 
       if limit
-        query << " LIMIT ?"
+        query << ' LIMIT ?'
         bindings << limit
       end
 
       items = []
 
       @database.execute(query, bindings) do |row|
-        item = JSON.parse(row["json"])
+        item = JSON.parse(row['json'])
         yield item if block_given?
 
         items << item
@@ -134,7 +121,7 @@ module Restiny
 
       items unless block_given?
     rescue SQLite3::Exception => e
-      raise Restiny::RequestError.new("Error while fetching items (#{e})")
+      raise Restiny::RequestError, "Error while fetching items (#{e})"
     end
   end
 end

data/lib/restiny/version.rb

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

data/lib/restiny.rb

@@ -2,28 +2,28 @@
 
 $LOAD_PATH.unshift(__dir__)
 
-require "restiny/version"
-require "restiny/constants"
-require "restiny/errors"
-require "restiny/manifest"
-
-require "faraday"
-require "faraday/follow_redirects"
-require "faraday/destiny/api"
-require "faraday/destiny/auth"
-
-require "down"
-require "json"
-require "securerandom"
-require "zip"
+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'
 
 module Restiny
   extend self
 
-  BUNGIE_URL = "https://www.bungie.net"
-  API_BASE_URL = BUNGIE_URL + "/platform"
+  BUNGIE_URL = 'https://www.bungie.net'
+  API_BASE_URL = "#{BUNGIE_URL}/platform".freeze
 
-  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token
+  attr_accessor :api_key, :oauth_state, :oauth_client_id, :access_token, :user_agent
 
   # OAuth methods
 
@@ -32,58 +32,63 @@ 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 = { 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
+    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?
+    params = { code: code, grant_type: 'authorization_code', client_id: @oauth_client_id }
+    params['redirect_url'] = redirect_url unless redirect_url.nil?
 
-    auth_post("app/oauth/token/", params)
+    auth_connection.post('app/oauth/token/', params).body
   end
 
   # Manifest methods
 
-  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?
+  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.dig("version")
+    live_version = result['version']
 
-    if force_download || @manifest.nil? || @manifest_version != live_version
-      url = BUNGIE_URL + result.dig("mobileWorldContentPaths", locale)
+    @manifests ||= {}
+    @manifest_versions ||= {}
 
-      zipped_file = Down.download(url)
-      database_file_path = zipped_file.path + ".db"
+    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?
 
-      Zip::File.open(zipped_file) { |file| file.first.extract(database_file_path) }
+      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
 
-      @manifest = Manifest.new(database_file_path, live_version)
-      @manifest_version = live_version
+      @manifests[locale] = Manifest.new(database_file_path, live_version)
+      @manifest_versions[locale] = live_version
     end
 
-    @manifest
+    @manifests[locale]
   rescue Down::Error => e
-    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})")
+    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.new("Please provide at least one component")
+      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(",")}"
+    url += "?components=#{components.join(',')}"
 
     api_get(url)
   end
@@ -109,14 +114,26 @@ module Restiny
   # User methods.
 
   def get_user_memberships_by_id(membership_id, membership_type: Platform::ALL)
-    raise Restiny::InvalidParamsError.new("Please provide a membership ID") if membership_id.nil?
+    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("#")
+    display_name, display_name_code = name.split('#')
     if display_name.nil? || display_name_code.nil?
-      raise Restiny::InvalidParamsError.new("You must provide a valid Bungie name")
+      raise Restiny::InvalidParamsError, 'You must provide a valid Bungie name'
     end
 
     api_post(
@@ -128,7 +145,7 @@ module Restiny
     )
   end
 
-  def search_users_by_global_name(name:, page: 0)
+  def search_users_by_global_name(name, page: 0)
     api_post("User/Search/GlobalName/#{page}/", params: { displayNamePrefix: name })
   end
 
@@ -142,29 +159,24 @@ module Restiny
     api_connection.post(url, params, token_header).body
   end
 
-  def auth_post(url, params)
-    auth_connection.post(url, params, "Content-Type" => "application/x-www-form-urlencoded").body
-  end
-
   private
 
   def check_oauth_client_id
-    raise Restiny::RequestError.new("You need to set an OAuth client ID") unless @oauth_client_id
+    raise Restiny::RequestError, 'You need to set an OAuth client ID' unless @oauth_client_id
   end
 
   def default_headers
-    { "User-Agent": "restiny v#{Restiny::VERSION}" }
+    { 'User-Agent': @user_agent || "restiny v#{Restiny::VERSION}" }
   end
 
   def api_connection
-    raise Restiny::InvalidParamsError.new("You need to set an API key") unless @api_key
+    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)
+        headers: default_headers.merge('X-API-KEY': @api_key)
       ) do |faraday|
-        faraday.request :url_encoded
         faraday.request :json
         faraday.response :follow_redirects
         faraday.response :destiny_api
@@ -176,7 +188,6 @@ module Restiny
     @auth_connection ||=
       Faraday.new(url: API_BASE_URL, headers: default_headers) do |faraday|
         faraday.request :url_encoded
-        faraday.request :json
         faraday.response :follow_redirects
         faraday.response :destiny_auth
         faraday.response :json
@@ -184,6 +195,6 @@ module Restiny
   end
 
   def token_header
-    {}.tap { |headers| headers["authorization"] = "Bearer #{@oauth_token}" if @oauth_token }
+    {}.tap { |headers| headers['authorization'] = "Bearer #{@access_token}" if @access_token }
   end
 end

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: restiny
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Daniel Bogan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-11-04 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: down
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: down
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -81,75 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.22'
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.28'
-- !ruby/object:Gem::Dependency
-  name: vcr
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '1.3'
 description: A gem for interacting with Bungie's Destiny API.
 email:
 - d+restiny@waferbaby.com
@@ -167,24 +97,25 @@ files:
 homepage: http://github.com/waferbaby/restiny
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: A Destiny API gem
 test_files: []