Module: Restiny

Extended by:
Restiny
Includes:
Api::Authentication, Api::Manifest, Api::Membership, Api::Profile, Api::Search, Api::Stats
Included in:
Restiny
Defined in:
lib/restiny.rb,
lib/restiny/errors.rb,
lib/restiny/version.rb,
lib/restiny/api/base.rb,
lib/restiny/manifest.rb,
lib/restiny/api/stats.rb,
lib/restiny/constants.rb,
lib/restiny/api/search.rb,
lib/restiny/api/profile.rb,
lib/restiny/api/manifest.rb,
lib/restiny/api/membership.rb,
lib/restiny/api/authentication.rb

Overview

The main Restiny module.

Defined Under Namespace

Modules: Ammunition, Api, ComponentType, Gender, GuardianClass, ItemLocation, Platform, Race, TierType Classes: AuthenticationError, Error, InvalidParamsError, Manifest, NetworkError, RateLimitedError, RequestError, ResponseError

Constant Summary collapse

VERSION = 
'5.0.1'
BUNGIE_URL = 
'https://www.bungie.net'
API_BASE_URL = 
"#{BUNGIE_URL}/platform".freeze

Instance Attribute Summary collapse

Method Summary

Methods included from Api::Stats

#get_post_game_carnage_report

Methods included from Api::Base

#api_get, #api_post

Methods included from Api::Search

#search_player_by_bungie_name, #search_users_by_global_name

Methods included from Api::Profile

#get_character_profile, #get_instanced_item_profile, #get_profile

Methods included from Api::Membership

#get_primary_user_membership, #get_user_memberships_by_id

Methods included from Api::Manifest

#download_manifest, #download_manifest_by_url, #extract_manifest_from_zip_file, #manifest_version?, #manifests

Methods included from Api::Authentication

#get_authorise_url, #request_access_token

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.



14
15
16
 
# File 'lib/restiny/api/base.rb', line 14

def access_token
  @access_token
end

#api_key ⇒ Object

Returns the value of attribute api_key.



14
15
16
 
# File 'lib/restiny/api/base.rb', line 14

def api_key
  @api_key
end

#oauth_client_id ⇒ Object

Returns the value of attribute oauth_client_id.



14
15
16
 
# File 'lib/restiny/api/base.rb', line 14

def oauth_client_id
  @oauth_client_id
end

#oauth_state ⇒ Object

Returns the value of attribute oauth_state.



14
15
16
 
# File 'lib/restiny/api/base.rb', line 14

def oauth_state
  @oauth_state
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.



14
15
16
 
# File 'lib/restiny/api/base.rb', line 14

def user_agent
  @user_agent
end