Module: ShopifyAPI::Auth::Oauth

Extended by:
T::Sig
Defined in:
lib/shopify_api/auth/oauth.rb,
lib/shopify_api/auth/oauth/auth_query.rb,
lib/shopify_api/auth/oauth/session_cookie.rb

Defined Under Namespace

Classes: AuthQuery, SessionCookie

Constant Summary collapse

NONCE_LENGTH =
15

Class Method Summary collapse

Class Method Details

.begin_auth(shop:, redirect_path:, is_online: true, scope_override: nil) ⇒ Object



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/shopify_api/auth/oauth.rb', line 22

def begin_auth(shop:, redirect_path:, is_online: true, scope_override: nil)
  scope = if scope_override.nil?
    ShopifyAPI::Context.scope
  elsif scope_override.is_a?(ShopifyAPI::Auth::AuthScopes)
    scope_override
  else
    ShopifyAPI::Auth::AuthScopes.new(scope_override)
  end

  unless Context.setup?
    raise Errors::ContextNotSetupError, "ShopifyAPI::Context not setup, please call ShopifyAPI::Context.setup"
  end
  raise Errors::UnsupportedOauthError, "Cannot perform OAuth for private apps." if Context.private?

  state = SecureRandom.alphanumeric(NONCE_LENGTH)

  cookie = SessionCookie.new(value: state, expires: Time.now + 60)

  query = {
    client_id: ShopifyAPI::Context.api_key,
    scope: scope.to_s,
    redirect_uri: "#{ShopifyAPI::Context.host}#{redirect_path}",
    state: state,
    "grant_options[]": is_online ? "per-user" : "",
  }

  query_string = URI.encode_www_form(query)

  auth_route = "https://#{shop}/admin/oauth/authorize?#{query_string}"
  { auth_route: auth_route, cookie: cookie }
end

.validate_auth_callback(cookies:, auth_query:) ⇒ Object



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/shopify_api/auth/oauth.rb', line 60

def validate_auth_callback(cookies:, auth_query:)
  unless Context.setup?
    raise Errors::ContextNotSetupError, "ShopifyAPI::Context not setup, please call ShopifyAPI::Context.setup"
  end
  raise Errors::InvalidOauthError, "Invalid OAuth callback." unless Utils::HmacValidator.validate(auth_query)
  raise Errors::UnsupportedOauthError, "Cannot perform OAuth for private apps." if Context.private?

  state = cookies[SessionCookie::SESSION_COOKIE_NAME]
  raise Errors::NoSessionCookieError unless state

  raise Errors::InvalidOauthError,
    "Invalid state in OAuth callback." unless state == auth_query.state

  # TODO: replace this call with the HTTP client once it is built
  body = { client_id: Context.api_key, client_secret: Context.api_secret_key, code: auth_query.code }
  response = HTTParty.post("https://#{auth_query.shop}/admin/oauth/access_token", body: body)
  unless response.ok?
    raise Errors::RequestAccessTokenError,
      "Cannot complete OAuth process. Received a #{response.code} error while requesting access token."
  end
  session_params = response.to_h

  session = create_new_session(session_params, auth_query.shop)

  cookie = if Context.embedded?
    SessionCookie.new(
      value: "",
      expires: Time.now,
    )
  else
    SessionCookie.new(
      value: session.id,
      expires: session.online? ? session.expires : nil,
    )
  end

  { session: session, cookie: cookie }
end