restiny 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366f1afb92a72c9adbc817eb5e8651fcd2df0656584c138660708525343b8407
-  data.tar.gz: 7fa7f9df35a0ee12206627a43c7ffb4d299819c5d26340c83186f520e30de99e
+  metadata.gz: 19b9e9cb2183fde785169d457628f4f7517c74feed228aacee4d45cdfe901fff
+  data.tar.gz: bebc650be6668d5a46a284a2aeb6912f2309cce7a7100ec4de57d3a95b11805e
 SHA512:
-  metadata.gz: 8c71e268039ac692949adf704883eda27bc2da5d747dab7d610a09621921ef3e64e4909bca9456431f404a0ff4211a19f31efbdf7eb57701bf852bacf360cf90
-  data.tar.gz: 77c6af1bf576b0e590a6659565af7739316cbc3a72b159a26c8b3077308c3713f1cb8cf45c103d3a0993c2012957feaeb372c6bdaec0436b85b4af0b2f290261
+  metadata.gz: c4fbe785ad70936712f351e1f3453f1915220af599ea9d89a09dc3c67713b208c6232e12d52d20fb25153c6a9b04b706b4bf1b367a2c8ded96a79da10f9764af
+  data.tar.gz: ed736dce127c0c76cebec7051b89ba02505452a4f9d2aa6bce6beb836b8fc6169586a6970fea1db3387db7700e3cee2b032edcb9952abd7ba9f85940e1a320e4

data/lib/restiny/api/authentication.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+require 'securerandom'
+
+module Restiny
+  module Api
+    module Authentication
+      include Base
+
+      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
+    end
+  end
+end

data/lib/restiny/api/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'restiny/constants'
+require 'restiny/errors'
+require 'faraday'
+require 'faraday/follow_redirects'
+require 'faraday/destiny/api'
+require 'faraday/destiny/auth'
+
+module Restiny
+  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
+
+  module Api
+    module Base
+      def api_get(endpoint:, params: {})
+        api_connection.get(endpoint, params, token_header).body
+      end
+
+      def api_post(endpoint:, params: {})
+        api_connection.post(endpoint, 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
+
+        @api_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
+    end
+  end
+end

data/lib/restiny/api/manifest.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+require 'restiny/manifest'
+
+require 'down'
+require 'tmpdir'
+require 'zip'
+
+module Restiny
+  module Api
+    module Manifest
+      include Base
+
+      def download_manifest(locale: 'en', force_download: false)
+        result = api_get(endpoint: 'Destiny2/Manifest/')
+        raise Restiny::ResponseError, 'Unable to determine manifest details' if result.nil?
+
+        return manifests[locale] if !force_download && manifest_version?(locale, result['version'])
+
+        manifests[locale] = download_manifest_by_url(result.dig('mobileWorldContentPaths', locale), result['version'])
+      end
+
+      def download_manifest_by_url(url, version)
+        raise Restiny::RequestError, 'Unknown locale' if url.nil?
+
+        database_file_path = extract_manifest_from_zip_file(Down.download(BUNGIE_URL + url), version)
+
+        Restiny::Manifest.new(database_file_path, version)
+      rescue Down::Error => e
+        raise Restiny::NetworkError.new('Unable to download the manifest file', e.response.code)
+      end
+
+      def extract_manifest_from_zip_file(source_path, version)
+        Zip::File.open(source_path) do |zip_file|
+          File.join(Dir.tmpdir, "#{version}.en.content.db").tap do |path|
+            zip_file.first.extract(path) unless File.exist?(path)
+          end
+        end
+      rescue Zip::Error => e
+        raise Restiny::Error, "Unable to unzip the manifest file (#{e})"
+      end
+
+      def manifests
+        @manifests ||= {}
+      end
+
+      def manifest_version?(locale, version)
+        manifests[locale] && manifests[locale].version == version
+      end
+    end
+  end
+end

data/lib/restiny/api/membership.rb

@@ -0,0 +1,28 @@
+# 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?
+
+        api_get(endpoint: "User/GetMembershipsById/#{membership_id}/#{membership_type}/")
+      end
+
+      def get_primary_user_membership(membership_id:, use_fallback: true)
+        result = get_user_memberships_by_id(membership_id: 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
+    end
+  end
+end

data/lib/restiny/api/profile.rb

@@ -0,0 +1,41 @@
+# 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)
+        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(endpoint: 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,31 @@
+# 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
+
+        api_post(
+          endpoint: "Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/",
+          params: {
+            displayName: display_name,
+            displayNameCode: display_name_code
+          }
+        )
+      end
+
+      def search_users_by_global_name(name:, page: 0)
+        api_post(endpoint: "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?
+
+        api_get(endpoint: "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,36 +48,89 @@ 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 typos of ammunition 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'

data/lib/restiny/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restiny
-  VERSION = '5.0.0'
+  VERSION = '5.0.1'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restiny
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -90,6 +90,13 @@ 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