restiny 0.6.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d746d115f85cce78834085e5a291555b9f3a04591d6533b31c569bf8a8ddc161
-  data.tar.gz: 2b7b6deb692271d86a6d0eb47217f239c97c7145154cb1ab7a04999939d943d0
+  metadata.gz: 2d5b81f9aadd44def19fb9af625b26692992457edaf57eeba97b46896f26e032
+  data.tar.gz: f058584408a167934ae67f9e8c160f75e542f80558446ee312fa2ce34b763ace
 SHA512:
-  metadata.gz: 495d10b083c4fcb3b8ff6697db0e206abab20e1b0fead5549f5b4d9a7fc467343eb82dcaef07e4fdece7590d392f3144e3eb25f2c23ed27740c7118fc7f25294
-  data.tar.gz: 64972701dd9a41ec8f835b8e4443d39020c097662ac98d7f50d08e7ae92997ea159c21a8a9d83c296fd04a330b4a7d395cb2c43651fe9bd87345cef2f5d303eb
+  metadata.gz: 5b737a79ec4728c34106b701db09f654c9d642cfd62b3ff311501a70afcf954f07ad92f0d1282c9a59686bffef568ef2b1fb5466e97cd267b389c1634c28b742
+  data.tar.gz: 99c7c3c4519a6a539a11a2970f18a38443ee4a9587b6df980cb74b03e425f1ce134e48c075af0d5b8d29339e086310eda6c44ac352e0b4daf80997923fded98b

data/lib/faraday/destiny/api.rb

@@ -0,0 +1,31 @@
+require "faraday"
+require "restiny/errors"
+
+module Faraday
+  module Restiny
+    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")
+
+        if env["response_body"]["ErrorCode"] == 1
+          env[:body] = env["response_body"].dig("Response")
+          return
+        end
+
+        klass =
+          case env["status"]
+          when 400..499
+            ::Restiny::RequestError
+          when 500..599
+            ::Restiny::ResponseError
+          else
+            ::Restiny::Error
+          end
+
+        raise klass.new(env["response_body"]["Message"], env["response_body"]["ErrorStatus"])
+      end
+    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

@@ -40,4 +40,32 @@ module Restiny
     SUPERIOR = 5
     EXOTIC = 6
   end
+
+  module Class
+    TITAN = 0
+    HUNTER = 1
+    WARLOCK = 2
+    UNKNOWN = 3
+  end
+
+  module Race
+    HUMAN = 0
+    AWOKEN = 1
+    EXO = 2
+    UNKNOWN = 3
+  end
+
+  module Gender
+    MASCULINE = 0
+    FEMININE = 1
+    UNKNOWN = 2
+  end
+
+  module Ammunition
+    NONE = 0
+    PRIMARY = 1
+    SPECIAL = 2
+    HEAVY = 3
+    UNKNOWN = 4
+  end
 end

data/lib/restiny/errors.rb

@@ -17,6 +17,9 @@ module Restiny
   class RateLimitedError < RequestError
   end
 
+  class AuthenticationError < RequestError
+  end
+
   class ResponseError < Error
   end
 end

data/lib/restiny/manifest.rb

@@ -79,15 +79,15 @@ module Restiny
       single_method_name, plural_method_name = method_names
 
       define_method single_method_name do |id|
-        fetch_item(full_table_name, id)
+        fetch_item(table_name: full_table_name, id: id)
       end
 
-      define_method plural_method_name do |limit = nil|
-        fetch_items(full_table_name, limit)
+      define_method plural_method_name do |limit: nil|
+        fetch_items(table_name: full_table_name, limit: limit)
       end
     end
 
-    def self.download(url)
+    def self.download_by_url(url)
       zipped_file = Down.download(url)
       manifest_path = zipped_file.path + ".db"
 
@@ -116,7 +116,7 @@ module Restiny
       @database.execute(query).map { |row| row["name"].gsub(/(Destiny|Definition)/, "") }
     end
 
-    def fetch_item(table_name, id)
+    def fetch_item(table_name:, id:)
       query = "SELECT json FROM #{table_name} WHERE json_extract(json, '$.hash')=?"
       result = @database.execute(query, id)
 
@@ -127,7 +127,7 @@ module Restiny
       raise Restiny::RequestError.new("Error while fetching item (#{e})")
     end
 
-    def fetch_items(table_name, limit = nil)
+    def fetch_items(table_name:, limit: nil)
       bindings = []
 
       query = "SELECT json FROM #{table_name} ORDER BY json_extract(json, '$.index')"

data/lib/restiny/version.rb

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

data/lib/restiny.rb

@@ -9,6 +9,8 @@ require "restiny/manifest"
 
 require "faraday"
 require "faraday/follow_redirects"
+require "faraday/destiny/api"
+require "faraday/destiny/auth"
 require "securerandom"
 
 module Restiny
@@ -21,7 +23,7 @@ module Restiny
 
   # OAuth methods
 
-  def authorise_url(redirect_url = nil, state = nil)
+  def get_authorise_url(redirect_url: nil, state: nil)
     check_oauth_client_id
 
     @oauth_state = state || SecureRandom.hex(15)
@@ -29,129 +31,142 @@ module Restiny
     params = { response_type: "code", client_id: @oauth_client_id, state: @oauth_state }
     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)
+  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?
 
-    make_api_request(
-      :post,
-      "app/oauth/token/",
-      params,
-      "Content-Type" => "application/x-www-form-urlencoded"
-    )
+    auth_post("app/oauth/token/", params)
   end
 
   # Manifest methods
 
-  def download_manifest(locale = "en")
-    response = get("Destiny2/Manifest/")
+  def get_manifest_url(locale: "en")
+    result = api_get("Destiny2/Manifest/").dig("mobileWorldContentPaths", locale)
+    BUNGIE_URL + result
+  end
 
-    manifest_path = response.dig("mobileWorldContentPaths", locale)
-    raise Restiny::ResponseError.new("Unable to determine manifest URL") if manifest_path.nil?
+  def download_manifest(locale: "en")
+    manifest_url = get_manifest_url
+    raise Restiny::ResponseError.new("Unable to determine manifest URL") if manifest_url.nil?
 
-    Manifest.download(BUNGIE_URL + manifest_path)
+    Manifest.download_by_url(BUNGIE_URL + manifest_url)
   end
 
-  # Profile methods
+  # Profile and related methods
 
-  def get_profile(membership_id, membership_type, components = [])
-    if components.empty?
+  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")
     end
 
-    get("Destiny2/#{membership_type}/Profile/#{membership_id}?components=#{components.join(",")}")
+    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
 
-  # Account methods
+  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
 
-  def get_user_by_membership_id(membership_id, membership_type = Platform::ALL)
-    raise Restiny::InvalidParamsError.new("Please provide a membership ID") if membership_id.nil?
+  # User methods.
 
-    get("User/GetMembershipsById/#{membership_id}/#{membership_type}/")
+  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?
+    api_get("User/GetMembershipsById/#{membership_id}/#{membership_type}/")
   end
 
-  def get_user_by_bungie_name(full_display_name, membership_type = Platform::ALL)
-    display_name, display_name_code = full_display_name.split("#")
+  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.new("You must provide a valid Bungie name")
     end
 
-    post(
+    api_post(
       "Destiny2/SearchDestinyPlayerByBungieName/#{membership_type}/",
-      { displayName: display_name, displayNameCode: display_name_code }
+      params: {
+        displayName: display_name,
+        displayNameCode: display_name_code
+      }
     )
   end
 
-  def search_users(name, page = 0)
-    post("User/Search/GlobalName/#{page}", displayNamePrefix: name)
+  def search_users_by_global_name(name:, page: 0)
+    api_post("User/Search/GlobalName/#{page}/", params: { displayNamePrefix: name })
   end
 
-  def get(endpoint_url, params = {}, headers = {})
-    make_api_request(:get, endpoint_url, params, headers).dig("Response")
-  end
+  # General request methods
 
-  def post(endpoint_url, body, headers = {})
-    make_api_request(:post, endpoint_url, body, headers).dig("Response")
+  def api_get(url, params: {})
+    api_connection.get(url, params, token_header).body
   end
 
-  private
-
-  def make_api_request(type, url, params, headers = {})
-    raise Restiny::InvalidParamsError.new("You need to set an API key") unless @api_key
-
-    headers[:authorization] = "Bearer #{@oauth_token}" if @oauth_token
-
-    response =
-      case type
-      when :get
-        connection.get(url, params, headers)
-      when :post
-        connection.post(url, params, headers)
-      end
-
-    response.body
-  rescue Faraday::Error => error
-    begin
-      error_body = JSON.parse(error.response_body)
-      status, message = error_body["ErrorStatus"], error_body["Message"]
-    rescue JSON::ParserError
-      status, message = error.response_status, error.message
-    end
-
-    klass =
-      case error
-      when Faraday::ClientError
-        Restiny::RequestError
-      when Faraday::ServerError
-        Restiny::ResponseError
-      else
-        Restiny::Error
-      end
+  def api_post(url, params: {})
+    api_connection.post(url, params, token_header).body
+  end
 
-    raise klass.new(message, status)
+  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
   end
 
   def default_headers
-    { "User-Agent": "restiny v#{Restiny::VERSION}", "X-API-KEY": @api_key }
+    { "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
+
     @connection ||=
-      Faraday.new(url: API_BASE_URL, headers: default_headers) do |faraday|
-        faraday.request :json
+      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
+
+  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 :raise_error
+        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: 0.6.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Daniel Bogan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-11 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,6 +157,8 @@ executables: []
 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