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.



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

def api_key
  @api_key
end

.api_secret_key ⇒ Object (readonly)

Returns the value of attribute api_secret_key.



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

def api_secret_key
  @api_secret_key
end

.api_version ⇒ Object (readonly)

Returns the value of attribute api_version.



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

def api_version
  @api_version
end

.host ⇒ Object (readonly)

Returns the value of attribute host.



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

def host
  @host
end

.logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

.old_api_secret_key ⇒ Object (readonly)

Returns the value of attribute old_api_secret_key.



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

def old_api_secret_key
  @old_api_secret_key
end

.private_shop ⇒ Object (readonly)

Returns the value of attribute private_shop.



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

def private_shop
  @private_shop
end

.scope ⇒ Object (readonly)

Returns the value of attribute scope.



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

def scope
  @scope
end

.session_storage ⇒ Object (readonly)

Returns the value of attribute session_storage.



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

def session_storage
  @session_storage
end

.user_agent_prefix ⇒ Object (readonly)

Returns the value of attribute user_agent_prefix.



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

def user_agent_prefix
  @user_agent_prefix
end

Class Method Details

.activate_session(session) ⇒ Object 



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

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

.active_session ⇒ Object 



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

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

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

.deactivate_session ⇒ Object 



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

def deactivate_session
  @active_session.value = nil
end

.embedded? ⇒ Boolean

Returns:

  • (Boolean) 


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

def embedded?
  @is_embedded
end

.host_name ⇒ Object 



161
162
163
 
# File 'lib/shopify_api/context.rb', line 161

def host_name
  T.must(URI(T.must(host)).host)
end

.host_scheme ⇒ Object 



156
157
158
 
# File 'lib/shopify_api/context.rb', line 156

def host_scheme
  T.must(URI.parse(T.must(host)).scheme)
end

.load_rest_resources(api_version:) ⇒ Object 



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
106
 
# File 'lib/shopify_api/context.rb', line 81

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) 


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

def private?
  @is_private
end

.setup(api_key:, api_secret_key:, api_version:, scope:, is_private:, is_embedded:, session_storage:, logger: Logger.new($stdout), host_name: nil, host: ENV["HOST"] || "https://#{host_name}", 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
78
 
# File 'lib/shopify_api/context.rb', line 44

def setup(
  api_key:,
  api_secret_key:,
  api_version:,
  scope:,
  is_private:,
  is_embedded:,
  session_storage:,
  logger: Logger.new($stdout),
  host_name: nil,
  host: ENV["HOST"] || "https://#{host_name}",
  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 version #{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 = T.let(host, T.nilable(String))
  @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) 


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

def setup?
  [api_key, api_secret_key, T.must(host)].none?(&:empty?)
end