restiny 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2ff82944ba14279df69b4c5e8d151a4d0b18c5176273af3ed68142327473993
+  data.tar.gz: a214d550713959f482943f2120d491a91227f46599ab5f5da46e55abed7174be
+SHA512:
+  metadata.gz: 269e932d167058936ac4ccc092493b72da71026dbf5947467367671e2a64421496f0f9d40b99962eb1f1dc416754734ed241dfaaee53440ea03bee610efdb2d2
+  data.tar.gz: def65d2d7fc397ca3e833a6eec1b922d78639d7c800f763f4e15740a9bde08d8e2e36e5db020dd9654594575c11b1f1c078d3d57f0b9f1eb1bbaf2197e70729a

data/lib/restiny/character.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Restiny
+  class Character
+    attr_accessor :id, :playtime, :light_level, :stats, :emblem, :progression
+
+    def initialize(id:, session_playtime:, total_playtime:, light_level:, stats:, emblem:, progression:)
+      @id = id
+      @playtime = { session: session_playtime, total: total_playtime }
+      @light_level = light_level
+      @stats = stats
+      @emblem = emblem
+      @progression = progression
+    end
+  end
+end
+

data/lib/restiny/client.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/follow_redirects'
+
+module Restiny
+  class Client
+    BUNGIE_URL = "https://www.bungie.net"
+    API_BASE_URL = BUNGIE_URL + "/Platform"
+
+    attr_accessor :api_key, :manifest
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    # Manifest methods
+
+    def download_manifest(locale = 'en')
+      response = get("/Destiny2/Manifest/")
+
+      manifest_path = response.body.dig('Response', 'mobileWorldContentPaths', locale)
+      raise "Unable to determine manifest URL" if manifest_path.nil?
+
+      Manifest.download(BUNGIE_URL + manifest_path)
+    end
+
+    # Profile methods
+
+    def get_profile(membership_id, membership_type, components = [])
+      raise "You must provide at least one component" if components.empty?
+
+      component_query = components.join(",")
+      response = get("/Destiny2/#{membership_type}/Profile/#{membership_id}?components=#{component_query}")
+
+      {}.tap do |output|
+        components.each do |component|
+          case component.downcase
+          when 'characters'
+            output[:characters] = parse_profile_characters_response(response)
+          end
+        end
+      end
+    end
+
+    # Account methods
+
+    def get_user_by_bungie_name(full_display_name, membership_type = PLATFORM_ALL)
+      display_name, display_name_code = full_display_name.split('#')
+      raise "You must provide a valid Bungie name" if display_name.nil? || display_name_code.nil?
+
+      params = {
+        displayName: display_name,
+        displayNameCode: display_name_code
+      }
+
+      response = post("/Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/", params)
+      result = response.body.dig('Response')
+
+      return [] if result.nil?
+
+      Restiny::User.new(
+        display_name: result[0]['bungieGlobalDisplayName'],
+        display_name_code: result[0]['bungieGlobalDisplayNameCode'],
+        memberships: result
+      )
+    end
+
+    def search_users(name, page = 0)
+      params = { displayNamePrefix: name }
+      response = post("/User/Search/GlobalName/#{page}", params).body
+      return [] if response.nil?
+
+      search_results = response.dig('Response', 'searchResults')
+      return [] if search_results.nil?
+
+      search_results.map do |user|
+        Restiny::User.new(
+          display_name: user['bungieGlobalDisplayName'],
+          display_name_code: user['bungieGlobalDisplayNameCode'],
+          memberships: user['destinyMemberships']
+        )
+      end
+    end
+
+    def get(endpoint_url, params = {})
+      connection.get(API_BASE_URL + endpoint_url, params)
+    end
+
+    def post(endpoint_url, body, headers = {})
+      connection.post(API_BASE_URL + endpoint_url, body, headers) 
+    end
+
+    private
+
+    def parse_profile_characters_response(response)
+      characters = response.body.dig('Response', 'characters', 'data')
+      return [] if characters.nil?
+
+      result = []
+
+      [].tap do |result|
+        characters.each_value do |character|
+          result << Restiny::Character.new(
+            id: character['characterId'],
+            session_playtime: character['minutesPlayedThisSession'],
+            total_playtime: character['minutesPlayedTotal'],
+            light_level: character['light'],
+            stats: [],
+            emblem: [],
+            progression: character['progression']
+          )
+        end
+      end
+    end
+
+    def default_headers
+      {
+        'User-Agent': "restiny v#{Restiny::VERSION}",
+        'X-API-KEY': @api_key
+      }
+    end
+
+    def connection
+      @connection ||= Faraday.new(headers: default_headers) do |faraday|
+        faraday.request :json
+        faraday.request :url_encoded
+        faraday.response :json
+        faraday.response :follow_redirects
+        faraday.response :raise_error
+      end
+    end
+  end
+end

data/lib/restiny/constants.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+PLATFORM_ALL = -1
+PLATFORM_XBOX = 1
+PLATFORM_PSN = 2
+PLATFORM_STEAM = 3
+PLATFORM_EPIC = 6
+
+COMPONENT_TYPE_PROFILES = 'Profiles'.freeze
+COMPONENT_TYPE_PROFILE_INVENTORIES = 'ProfileInventories'.freeze
+COMPONENT_TYPE_CHARACTERS = 'Characters'.freeze
+COMPONENT_TYPE_CHARACTER_INVENTORIES = 'CharacterInventories'.freeze

data/lib/restiny/manifest.rb

@@ -0,0 +1,139 @@
+# frozen_string/literal: true
+
+require 'down'
+require 'json'
+require 'sqlite3'
+require 'zip'
+
+module Restiny
+  class Manifest
+    TABLES = {
+      'DestinyAchievementDefinition': { item: 'achievement', items: 'achievements' },
+      'DestinyActivityDefinition': { item: 'activity', items: 'activities' },
+      'DestinyActivityGraphDefinition': { item: 'activity_graph', items: 'activity_graphs' },
+      'DestinyActivityModeDefinition': { item: 'activity_modes', items: 'activity_modes' },
+      'DestinyActivityModifierDefinition': { item: 'activity_modifier', items: 'activity_modifiers' },
+      'DestinyActivityTypeDefinition': { item: 'activity_type', items: 'activity_types' },
+      'DestinyArtifactDefinition': { item: 'artifact', items: 'artifacts' },
+      'DestinyBondDefinition': { item: 'bond', items: 'bonds' },
+      'DestinyBreakerTypeDefinition': { item: 'breaker_type', items: 'breaker_types' },
+      'DestinyChecklistDefinition': { item: 'checklist', items: 'checklists' },
+      'DestinyClassDefinition': { item: 'class', items: 'classes' },
+      'DestinyCollectibleDefinition': { item: 'collectible', items: 'collectibles' },
+      'DestinyDamageTypeDefinition': { item: 'damage_type', items: 'damage_types' },
+      'DestinyDestinationDefinition': { item: 'destination', items: 'destinations' },
+      'DestinyEnergyTypeDefinition': { item: 'energy_type', items: 'energy_types' },
+      'DestinyEquipmentSlotDefinition': { item: 'eqiupment_slot', items: 'equipment_slots' },
+      'DestinyEventCardDefinition': { item: 'event_card', items: 'event_cards' },
+      'DestinyFactionDefinition': { item: 'faction', items: 'factions' },
+      'DestinyGenderDefinition': { item: 'gender', items: 'genders' },
+      'DestinyHistoricalStatsDefinition': { item: 'historical_stat', items: 'historical_stats' },
+      'DestinyInventoryBucketDefinition': { item: 'inventory_bucket', items: 'inventory_buckets' },
+      'DestinyInventoryItemDefinition': { item: 'inventory_item', items: 'inventory_items' },
+      'DestinyItemCategoryDefinition': { item: 'item_category', items: 'item_categories' },
+      'DestinyItemTierTypeDefinition': { item: 'item_tier_type', items: 'item_tier_types' },
+      'DestinyLocationDefinition': { item: 'location', items: 'locations' },
+      'DestinyLoreDefinition': { item: 'lore', items: 'lore_entries' },
+      'DestinyMaterialRequirementSetDefinition': { item: 'material_requirement_set', items: 'material_requirement_sets' },
+      'DestinyMedalTierDefinition': { item: 'medal_tier', items: 'medal_tiers' },
+      'DestinyMetricDefinition': { item: 'metric', items: 'metrics' },
+      'DestinyMilestoneDefinition': { item: 'milestone', items: 'milestones' },
+      'DestinyObjectiveDefinition': { item: 'objective', items: 'objectives' },
+      'DestinyPlaceDefinition': { item: 'place', items: 'places' },
+      'DestinyPlugSetDefinition': { item: 'plug_set', items: 'plug_sets' },
+      'DestinyPowerCapDefinition': { item: 'power_cap', items: 'power_caps' },
+      'DestinyPresentationNodeDefinition': { item: 'presentation_node', items: 'presentation_nodes' },
+      'DestinyProgressionDefinition': { item: 'progression', items: 'progression_data' },
+      'DestinyProgressionLevelRequirementDefinition': { item: 'progression_level_requirement', items: 'progression_level_requirements' },
+      'DestinyRaceDefinition': { item: 'race', items: 'races' },
+      'DestinyRecordDefinition': { item: 'record', items: 'records' },
+      'DestinyReportReasonCategoryDefinition': { item: 'report_reason_category', items: 'report_reason_categories' },
+      'DestinyRewardSourceDefinition': { item: 'reward_source', items: 'reward_sources' },
+      'DestinySackRewardItemListDefinition': { item: 'sack_reward_item_list', items: 'sack_reward_item_lists' },
+      'DestinySandboxPatternDefinition': { item: 'sandbox_pattern', items: 'sandbox_patterns' },
+      'DestinySandboxPerkDefinition': { item: 'sandbox_perk', items: 'sandbox_perks' },
+      'DestinySeasonDefinition': { item: 'season', items: 'seasons' },
+      'DestinySeasonPassDefinition': { item: 'season_pass', items: 'season_passes' },
+      'DestinySocketCategoryDefinition': { item: 'socket_category', items: 'socket_categories' },
+      'DestinySocketTypeDefinition': { item: 'socket_type', items: 'socket_types' },
+      'DestinyStatDefinition': { item: 'stat', items: 'stats' },
+      'DestinyStatGroupDefinition': { item: 'stat_group', items: 'stat_groups' },
+      'DestinyTalentGridDefinition': { item: 'talent_grid', items: 'talent_grids' },
+      'DestinyTraitCategoryDefinition': { item: 'trait_category', items: 'trait_categories' },
+      'DestinyTraitDefinition': { item: 'trait', items: 'traits' },
+      'DestinyUnlockDefinition': { item: 'unlock', items: 'unlocks' },
+      'DestinyVendorDefinition': { item: 'vendor', items: 'vendors' },
+      'DestinyVendorGroupDefinition': { item: 'vendor_group', items: 'vendor_groups' }
+    }
+
+    attr_reader :file_path
+
+    TABLES.each do |table_name, method_names|
+      define_method method_names[:item] do |id|
+        query_table(table_name, id: id)[0]
+      end
+
+      define_method method_names[:items] do |limit: nil|
+        query_table(table_name, limit: limit)
+      end
+    end
+
+    def self.download(url)
+      zipped_file = Down.download(url)
+      manifest_path = zipped_file.path + ".db" 
+
+      Zip::File.open(zipped_file) { |file| file.first.extract(manifest_path) }
+
+      self.new(manifest_path)
+    rescue Down::Error
+      raise "Unable to download the manifest from Bungie"
+    rescue Zip::Error
+      raise "Unable to unzip the manifest file"
+    end
+
+    def initialize(file_path)
+      raise "You must provide the file path for the manifest file" if file_path.empty?
+
+      @database = SQLite3::Database.new(file_path, results_as_hash: true)
+      @file_path = file_path
+    end
+
+    private
+
+    def self.clean_row_keys(row_hash)
+      OpenStruct.new.tap do |output|
+        row_hash.each_pair do |key, value|
+          key = key.gsub(/(\B[A-Z])/, '_\1') if key =~ /\B[A-Z]/
+          output[key.downcase] = if value.is_a?(Hash)
+                                   clean_row_keys(value)
+                                 else
+                                   value
+                                 end
+        end
+      end
+    end
+
+    def query_table(table_name, id: nil, limit: nil)
+      query = "SELECT json FROM #{table_name}"
+      bindings = []
+
+      if id
+        query << " WHERE id=?"
+        bindings << id
+      end
+
+      query << " ORDER BY json_extract(json, '$.index')" unless id
+
+      if limit
+        query << " LIMIT ?"
+        bindings << limit
+      end
+
+      @database.execute(query, bindings).map do |row|
+        Manifest::clean_row_keys(JSON.parse(row['json'])) unless row['json'].nil?
+      end
+    rescue SQLite3::Exception => e
+      raise "Error while querying the manifest (#{e})"
+    end
+  end
+end

data/lib/restiny/membership.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Restiny
+  class Membership
+    attr_reader :id, :type, :cross_save_override, :icon_path, :is_public, :types
+
+    def self.platform(type)
+      case type
+      when PLATFORM_XBOX
+        :xbox
+      when PLATFORM_PSN
+        :playstation
+      when PLATFORM_STEAM
+        :steam
+      when PLATFORM_EPIC
+        :epic
+      end
+    end
+
+    def initialize(id:, type:, cross_save_override:, icon_path:, is_public:, types:)
+      @id = id
+      @type = type
+      @cross_save_override = cross_save_override
+      @icon_path = icon_path
+      @is_public = is_public
+      @types = types
+    end
+  end
+end

data/lib/restiny/user.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Restiny
+  class User
+    attr_reader :display_name, :display_name_code, :memberships
+
+    def initialize(display_name:, display_name_code:, memberships:)
+      @display_name = display_name
+      @display_name_code = display_name_code
+      
+      self.memberships = memberships
+    end
+
+    def memberships=(raw_memberships)
+      @memberships = {}
+
+      raw_memberships.each do |ship|
+        platform = Restiny::Membership.platform(ship['membershipType'])
+
+        @memberships[platform] = Restiny::Membership.new(
+          id: ship['membershipId'],
+          type: ship['membershipType'],
+          cross_save_override: ship['crossSaveOverride'],
+          icon_path: ship['iconPath'],
+          is_public: ship['isPublic'],
+          types: ship['applicableMembershipTypes']
+        )
+      end
+    end
+  end
+end

data/lib/restiny/version.rb

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

data/lib/restiny.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(__dir__)
+
+require 'restiny/version'
+require 'restiny/constants'
+require 'restiny/client'
+require 'restiny/manifest'
+require 'restiny/user'
+require 'restiny/membership'
+require 'restiny/character'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: restiny
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Bogan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-19 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
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: A gem for interacting with Bungie's Destiny API.
+email:
+- d+restiny@waferbaby.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/restiny.rb
+- lib/restiny/character.rb
+- lib/restiny/client.rb
+- lib/restiny/constants.rb
+- lib/restiny/manifest.rb
+- lib/restiny/membership.rb
+- lib/restiny/user.rb
+- lib/restiny/version.rb
+homepage: http://github.com/waferbaby/restiny
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Destiny API gem
+test_files: []