Class: ShopifyAPI::Context

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/context.rb

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



108
109
110
 
# File 'lib/shopify_api/context.rb', line 108

def api_key
  @api_key
end

.api_secret_key ⇒ Object (readonly)

Returns the value of attribute api_secret_key.



108
109
110
 
# File 'lib/shopify_api/context.rb', line 108

def api_secret_key
  @api_secret_key
end

.api_version ⇒ Object (readonly)

Returns the value of attribute api_version.



108
109
110
 
# File 'lib/shopify_api/context.rb', line 108

def api_version
  @api_version
end

.host_name ⇒ Object (readonly)

Returns the value of attribute host_name.



108
109
110
 
# File 'lib/shopify_api/context.rb', line 108

def host_name
  @host_name
end

.logger ⇒ Object (readonly)

Returns the value of attribute logger.



117
118
119
 
# File 'lib/shopify_api/context.rb', line 117

def logger
  @logger
end

.old_api_secret_key ⇒ Object (readonly)

Returns the value of attribute old_api_secret_key.



125
126
127
 
# File 'lib/shopify_api/context.rb', line 125

def old_api_secret_key
  @old_api_secret_key
end

.private_shop ⇒ Object (readonly)

Returns the value of attribute private_shop.



125
126
127
 
# File 'lib/shopify_api/context.rb', line 125

def private_shop
  @private_shop
end

.scope ⇒ Object (readonly)

Returns the value of attribute scope.



111
112
113
 
# File 'lib/shopify_api/context.rb', line 111

def scope
  @scope
end

.session_storage ⇒ Object (readonly)

Returns the value of attribute session_storage.



114
115
116
 
# File 'lib/shopify_api/context.rb', line 114

def session_storage
  @session_storage
end

.user_agent_prefix ⇒ Object (readonly)

Returns the value of attribute user_agent_prefix.



125
126
127
 
# File 'lib/shopify_api/context.rb', line 125

def user_agent_prefix
  @user_agent_prefix
end

Class Method Details

.activate_session(session) ⇒ Object 



145
146
147
 
# File 'lib/shopify_api/context.rb', line 145

def activate_session(session)
  @active_session.value = session
end

.active_session ⇒ Object 



138
139
140
141
142
 
# File 'lib/shopify_api/context.rb', line 138

def active_session
  return @active_session.value unless @active_session.value.nil?

  private? ? Utils::SessionUtils.load_current_session : nil
end

.deactivate_session ⇒ Object 



150
151
152
 
# File 'lib/shopify_api/context.rb', line 150

def deactivate_session
  @active_session.value = nil
end

.embedded? ⇒ Boolean

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/shopify_api/context.rb', line 128

def embedded?
  @is_embedded
end

.load_rest_resources(api_version:) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/shopify_api/context.rb', line 80

def load_rest_resources(api_version:)
  # Unload any previous instances - mostly useful for tests where we need to reset the version
  @rest_resource_loader&.unload

  # No resources for the unstable version
  return if api_version == "unstable"

  version_folder_name = api_version.gsub("-", "_")
  path = "#{__dir__}/rest/resources/#{version_folder_name}"

  unless Dir.exist?(path)
    unless @notified_missing_resources_folder.key?(api_version)
      @logger.warn("Cannot autoload REST resources for API version '#{version_folder_name}', folder is missing")
      @notified_missing_resources_folder[api_version] = true
    end

    return
  end

  @rest_resource_loader = T.let(Zeitwerk::Loader.new, T.nilable(Zeitwerk::Loader))
  T.must(@rest_resource_loader).enable_reloading
  T.must(@rest_resource_loader).ignore("#{__dir__}/rest/resources")
  T.must(@rest_resource_loader).setup
  T.must(@rest_resource_loader).push_dir(path, namespace: ShopifyAPI)
  T.must(@rest_resource_loader).reload
end

.private? ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/shopify_api/context.rb', line 120

def private?
  @is_private
end

.setup(api_key:, api_secret_key:, api_version:, host_name:, scope:, is_private:, is_embedded:, session_storage:, logger: Logger.new($stdout), private_shop: nil, user_agent_prefix: nil, old_api_secret_key: nil) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shopify_api/context.rb', line 44

def setup(
  api_key:,
  api_secret_key:,
  api_version:,
  host_name:,
  scope:,
  is_private:,
  is_embedded:,
  session_storage:,
  logger: Logger.new($stdout),
  private_shop: nil,
  user_agent_prefix: nil,
  old_api_secret_key: nil
)
  unless ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS.include?(api_version)
    raise Errors::UnsupportedVersionError,
      "Invalid vession #{api_version}, supported versions: #{ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS}"
  end

  @api_key = api_key
  @api_secret_key = api_secret_key
  @api_version = api_version
  @host_name = host_name
  @is_private = is_private
  @scope = Auth::AuthScopes.new(scope)
  @is_embedded = is_embedded
  @session_storage = session_storage
  @logger = logger
  @private_shop = private_shop
  @user_agent_prefix = user_agent_prefix
  @old_api_secret_key = old_api_secret_key

  load_rest_resources(api_version: api_version)
end

.setup? ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/shopify_api/context.rb', line 133

def setup?
  !(api_key.empty? || api_secret_key.empty? || host_name.empty?)
end