restiny 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9250ce97e7698687ee6cc64362dc0ff0cfe222115a544f60290dbccbfa4255b
-  data.tar.gz: a33846e9b1a017a1a357f0ea51aeaa74f71d296d02f61f1a1da68a89bcf90498
+  metadata.gz: 64bba6028ea7ef4119e6019011b4d35cf1fb850903b446387b3aae0ba47c03e7
+  data.tar.gz: 629969c98d6d518c3cefb7f9c85d177a404408f6d88dd8d979be5e2be75c1027
 SHA512:
-  metadata.gz: 06d7bfcdd5a4263a4ac1db64ab4c55bf6986378fe5fa1a592616a2d03662f15f3cce91398b40a2fe3a03e2950c9eb8005bc64202980d1c4d41c4be54c82014d7
-  data.tar.gz: 7ec6297618ebaa28d3ef6f1ba5b96761a7beb04911201c2f80dd63aa671b48a072d0df9d4e26525ec962379245cbed3ff2d404b8d78efc541233eb0d9d8e12a4
+  metadata.gz: 65a76e2738de6da2e4e3dfaf6015f689d8c95d8fea9daa952d153fdf251feec6a145fa16b627bfd2baea1eb3c05cc7d83058e1670b1715d9ea21c18409f081c5
+  data.tar.gz: 70565f0ddc5c22d76f32cb1e4883261e3bbf181bd7e330a125a3c6982db1b95f6e14342aae7600379ded28697eef9f369ce4b50896b6388de984eea520aec971

data/lib/faraday/destiny/api.rb

@@ -7,11 +7,10 @@ module Faraday
 
     class Api < Middleware
       def on_complete(env)
-        return if env["response_body"].empty?
+        return if env["response_body"].empty? || !env["response_body"].dig("ErrorCode")
 
-        payload = JSON.parse(env["response_body"])
-        if payload["ErrorCode"] == 1
-          env[:body] = payload.dig("Response")
+        if env["response_body"]["ErrorCode"] == 1
+          env[:body] = env["response_body"].dig("Response")
           return
         end
 
@@ -25,9 +24,7 @@ module Faraday
             ::Restiny::Error
           end
 
-        raise klass.new(payload["Message"], payload["ErrorStatus"])
-      rescue JSON::ParserError
-        raise ::Restiny::ResponseError.new("Unable to parse API response")
+        raise klass.new(env["response_body"]["Message"], env["response_body"]["ErrorStatus"])
       end
     end
   end

data/lib/faraday/destiny/auth.rb

@@ -0,0 +1,21 @@
+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/
+
+        if env["response_body"]["error"]
+          raise ::Restiny::AuthenticationError.new(
+                  env["response_body"]["error_description"],
+                  env["response_body"]["error"]
+                )
+        end
+      end
+    end
+  end
+end

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/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.0"
+  VERSION = "3.0.0"
 end

data/lib/restiny.rb

@@ -10,7 +10,12 @@ 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"
 
 module Restiny
   extend self
@@ -18,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
 
   # OAuth methods
 
@@ -28,36 +33,45 @@ 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?
 
-    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["redirect_url"] = redirect_url unless redirect_url.nil?
 
-    connection.post(
-      "app/oauth/token",
-      params,
-      "Content-Type" => "application/x-www-form-urlencoded"
-    ).body
+    auth_post("app/oauth/token/", params)
   end
 
   # Manifest methods
 
-  def get_manifest_url(locale: "en")
-    result = connection.get("Destiny2/Manifest/").body.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")
+
+    if force_download || @manifest.nil? || @manifest_version != live_version
+      url = BUNGIE_URL + result.dig("mobileWorldContentPaths", locale)
+
+      zipped_file = Down.download(url)
+      database_file_path = zipped_file.path + ".db"
 
-  def download_manifest(locale: "en")
-    manifest_url = get_manifest_url
-    raise Restiny::ResponseError.new("Unable to determine manifest URL") if manifest_url.nil?
+      Zip::File.open(zipped_file) { |file| file.first.extract(database_file_path) }
 
-    Manifest.download_by_url(BUNGIE_URL + manifest_url)
+      @manifest = Manifest.new(database_file_path, live_version)
+      @manifest_version = live_version
+    end
+
+    @manifest
+  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})")
   end
 
   # Profile and related methods
@@ -71,7 +85,7 @@ module Restiny
     url += type_url if type_url
     url += "?components=#{components.join(",")}"
 
-    connection.get(url).body
+    api_get(url)
   end
 
   def get_character_profile(character_id:, membership_id:, membership_type:, components:)
@@ -79,7 +93,7 @@ module Restiny
       membership_id: membership_id,
       membership_type: membership_type,
       components: components,
-      type_url: "Character/#{character_id}"
+      type_url: "Character/#{character_id}/"
     )
   end
 
@@ -88,7 +102,7 @@ module Restiny
       membership_id: membership_id,
       membership_type: membership_type,
       components: components,
-      type_url: "Item/#{item_id}"
+      type_url: "Item/#{item_id}/"
     )
   end
 
@@ -96,8 +110,7 @@ module Restiny
 
   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?
-
-    connection.get("User/GetMembershipsById/#{membership_id}/#{membership_type}/").body
+    api_get("User/GetMembershipsById/#{membership_id}/#{membership_type}/")
   end
 
   def search_player_by_bungie_name(name, membership_type: Platform::ALL)
@@ -106,19 +119,33 @@ module Restiny
       raise Restiny::InvalidParamsError.new("You must provide a valid Bungie name")
     end
 
-    connection.post(
+    api_post(
       "Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/",
-      displayName: display_name,
-      displayNameCode: display_name_code
-    ).body
+      params: {
+        displayName: display_name,
+        displayNameCode: display_name_code
+      }
+    )
   end
 
   def search_users_by_global_name(name:, page: 0)
-    connection.post("User/Search/GlobalName/#{page}", displayNamePrefix: name).body
+    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
+
+  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
@@ -126,24 +153,37 @@ module Restiny
   end
 
   def default_headers
-    {
-      "User-Agent": "restiny v#{Restiny::VERSION}",
-      "X-API-KEY": @api_key,
-      "Content-Type": "application/json"
-    }
+    { "User-Agent": "restiny v#{Restiny::VERSION}" }
   end
 
-  def connection
+  def api_connection
     raise Restiny::InvalidParamsError.new("You need to set an API key") unless @api_key
 
-    headers = default_headers
-    headers["authorization"] = "Bearer #{@oauth_token}" if @oauth_token
+    @connection ||=
+      Faraday.new(
+        url: API_BASE_URL,
+        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
+        faraday.response :json
+      end
+  end
 
-    Faraday.new(url: API_BASE_URL, headers: headers) do |faraday|
-      faraday.request :url_encoded
-      faraday.request :json
-      faraday.response :follow_redirects
-      faraday.response :destiny_api
-    end
+  def auth_connection
+    @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
+      end
+  end
+
+  def token_header
+    {}.tap { |headers| headers["authorization"] = "Bearer #{@oauth_token}" if @oauth_token }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restiny
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/faraday/destiny/api.rb
+- lib/faraday/destiny/auth.rb
 - lib/restiny.rb
 - lib/restiny/constants.rb
 - lib/restiny/errors.rb