Add refresh_token and refresh_token_expires to Session class

Author: zzooeeyy

lib/shopify_api/auth/session.rb

@@ -30,6 +30,12 @@ class Session
       sig { returns(T.nilable(String)) }
       attr_accessor :shopify_session_id
 
+      sig { returns(T.nilable(String)) }
+      attr_accessor :refresh_token
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :refresh_token_expires
+
       sig { returns(T::Boolean) }
       def online?
         @is_online
@@ -40,6 +46,11 @@ def expired?
         @expires ? @expires < Time.now : false
       end
 
+      sig { returns(T::Boolean) }
+      def refresh_token_expired?
+        @refresh_token_expires ? @refresh_token_expires < Time.now : false
+      end
+
       sig do
         params(
           shop: String,
@@ -52,10 +63,12 @@ def expired?
           is_online: T.nilable(T::Boolean),
           associated_user: T.nilable(AssociatedUser),
           shopify_session_id: T.nilable(String),
+          refresh_token: T.nilable(String),
+          refresh_token_expires: T.nilable(Time),
         ).void
       end
       def initialize(shop:, id: nil, state: nil, access_token: "", scope: [], associated_user_scope: nil, expires: nil,
-        is_online: nil, associated_user: nil, shopify_session_id: nil)
+        is_online: nil, associated_user: nil, shopify_session_id: nil, refresh_token: nil, refresh_token_expires: nil)
         @id = T.let(id || SecureRandom.uuid, String)
         @shop = shop
         @state = state
@@ -68,6 +81,8 @@ def initialize(shop:, id: nil, state: nil, access_token: "", scope: [], associat
         @associated_user = associated_user
         @is_online = T.let(is_online || !associated_user.nil?, T::Boolean)
         @shopify_session_id = shopify_session_id
+        @refresh_token = refresh_token
+        @refresh_token_expires = refresh_token_expires
       end
 
       class << self
@@ -105,6 +120,10 @@ def from(shop:, access_token_response:)
             expires = Time.now + access_token_response.expires_in.to_i
           end
 
+          if access_token_response.refresh_token_expires_in
+            refresh_token_expires = Time.now + access_token_response.refresh_token_expires_in.to_i
+          end
+
           new(
             id: id,
             shop: shop,
@@ -115,6 +134,8 @@ def from(shop:, access_token_response:)
             associated_user: associated_user,
             expires: expires,
             shopify_session_id: access_token_response.session,
+            refresh_token: access_token_response.refresh_token,
+            refresh_token_expires: refresh_token_expires,
           )
         end
 
@@ -153,8 +174,9 @@ def ==(other)
             (!(expires.nil? ^ other.expires.nil?) && (expires.nil? || expires.to_i == other.expires.to_i)) &&
             online? == other.online? &&
             associated_user == other.associated_user &&
-            shopify_session_id == other.shopify_session_id
-
+            shopify_session_id == other.shopify_session_id &&
+            refresh_token == other.refresh_token &&
+            refresh_token_expires&.to_i == other.refresh_token_expires&.to_i
         else
           false
         end

test/auth/session_test.rb

@@ -52,6 +52,24 @@ def test_expired_with_passed_expiry_date
         assert(session.expired?)
       end
 
+      def test_refresh_token_expired_with_no_expiry_date
+        session = ShopifyAPI::Auth::Session.new(shop: "test-shop", refresh_token_expires: nil)
+
+        assert_equal(false, session.refresh_token_expired?)
+      end
+
+      def test_refresh_token_expired_with_future_expiry_date
+        session = ShopifyAPI::Auth::Session.new(shop: "test-shop", refresh_token_expires: Time.now + 1 * 60 * 60)
+
+        assert_equal(false, session.refresh_token_expired?)
+      end
+
+      def test_refresh_token_expired_with_passed_expiry_date
+        session = ShopifyAPI::Auth::Session.new(shop: "test-shop", refresh_token_expires: Time.now - 1)
+
+        assert(session.refresh_token_expired?)
+      end
+
       def test_temp
         session = ShopifyAPI::Auth::Session.new(shop: "test-shop1", access_token: "token1")
 
@@ -96,6 +114,8 @@ def test_from_with_offline_access_token_response_with_no_expires_in
           associated_user: nil,
           expires: nil,
           shopify_session_id: response.session,
+          refresh_token: nil,
+          refresh_token_expires: nil,
         )
 
         session = ShopifyAPI::Auth::Session.from(shop: shop, access_token_response: response)
@@ -121,6 +141,36 @@ def test_from_with_offline_access_token_response_with_expires_in
           associated_user: nil,
           expires: Time.now + response.expires_in,
           shopify_session_id: response.session,
+          refresh_token: nil,
+          refresh_token_expires: nil,
+        )
+
+        session = ShopifyAPI::Auth::Session.from(shop: shop, access_token_response: response)
+        assert_equal(expected_session, session)
+      end
+
+      def test_from_with_expiring_offline_access_token_response
+        shop = "test-shop"
+        response = ShopifyAPI::Auth::Oauth::AccessTokenResponse.new(
+          access_token: "token",
+          scope: "scope1, scope2",
+          expires_in: 1000,
+          refresh_token: "refresh_token",
+          refresh_token_expires_in: 2000,
+        )
+
+        expected_session = ShopifyAPI::Auth::Session.new(
+          id: "offline_#{shop}",
+          shop: shop,
+          access_token: response.access_token,
+          scope: response.scope,
+          is_online: false,
+          associated_user_scope: nil,
+          associated_user: nil,
+          expires: Time.now + response.expires_in,
+          shopify_session_id: response.session,
+          refresh_token: response.refresh_token,
+          refresh_token_expires: Time.now + response.refresh_token_expires_in,
         )
 
         session = ShopifyAPI::Auth::Session.from(shop: shop, access_token_response: response)
@@ -158,6 +208,8 @@ def test_from_with_online_access_token_response
           associated_user: associated_user,
           expires: time_now + response.expires_in,
           shopify_session_id: response.session,
+          refresh_token: nil,
+          refresh_token_expires: nil,
         )
 
         session = Time.stub(:now, time_now) do
@@ -179,6 +231,8 @@ def test_copy_attributes_from
           associated_user: build_user,
           is_online: true,
           shopify_session_id: "123",
+          refresh_token: "to-refresh-token",
+          refresh_token_expires: Time.now - 7200,
         )
 
         session_from = ShopifyAPI::Auth::Session.new(
@@ -192,6 +246,8 @@ def test_copy_attributes_from
           associated_user: build_user,
           is_online: true,
           shopify_session_id: "456",
+          refresh_token: "from-refresh-token",
+          refresh_token_expires: Time.now + 7200,
         )
 
         assert_equal(session_to, session_to.copy_attributes_from(session_from))
@@ -204,6 +260,211 @@ def test_copy_attributes_from
         assert_equal(session_from.expires, session_to.expires)
         assert_equal(session_from.associated_user, session_to.associated_user)
         assert_equal(session_from.shopify_session_id, session_to.shopify_session_id)
+        assert_equal(session_from.refresh_token, session_to.refresh_token)
+        assert_equal(session_from.refresh_token_expires, session_to.refresh_token_expires)
+      end
+
+      def test_equality_with_all_fields_matching
+        id = "session-id"
+        shop = "test-shop"
+        state = "test-state"
+        scope = "read_products,write_products"
+        associated_user_scope = "read_products"
+        expires = Time.now + 3600
+        associated_user = build_user
+        shopify_session_id = "shopify-session-123"
+        refresh_token = "refresh-token-abc"
+        refresh_token_expires = Time.now + 7200
+
+        session1 = ShopifyAPI::Auth::Session.new(
+          id:,
+          shop:,
+          state:,
+          scope:,
+          associated_user_scope:,
+          expires:,
+          is_online: true,
+          associated_user:,
+          shopify_session_id:,
+          refresh_token:,
+          refresh_token_expires:,
+        )
+
+        session2 = ShopifyAPI::Auth::Session.new(
+          id:,
+          shop:,
+          state:,
+          scope:,
+          associated_user_scope:,
+          expires:,
+          is_online: true,
+          associated_user:,
+          shopify_session_id:,
+          refresh_token:,
+          refresh_token_expires:,
+        )
+
+        assert_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_id
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: "id-1", shop:)
+        session2 = ShopifyAPI::Auth::Session.new(id: "id-2", shop:)
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_shop
+        id = "session-id"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: "shop-1")
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: "shop-2")
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_state
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, state: "state-1")
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, state: "state-2")
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_scope
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, scope: "read_products")
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, scope: "write_products")
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_associated_user_scope
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          associated_user_scope: "read_products",
+        )
+        session2 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          associated_user_scope: "write_products",
+        )
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_expires
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, expires: Time.now + 3600)
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, expires: Time.now + 7200)
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_is_online
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, is_online: true)
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, is_online: false)
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_associated_user
+        id = "session-id"
+        shop = "test-shop"
+        user1 = ShopifyAPI::Auth::AssociatedUser.new(
+          id: 1,
+          first_name: "first",
+          last_name: "last",
+          email: "[email protected]",
+          email_verified: true,
+          account_owner: true,
+          locale: "en",
+          collaborator: false,
+        )
+        user2 = ShopifyAPI::Auth::AssociatedUser.new(
+          id: 2,
+          first_name: "other",
+          last_name: "user",
+          email: "[email protected]",
+          email_verified: true,
+          account_owner: false,
+          locale: "en",
+          collaborator: true,
+        )
+
+        session1 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, associated_user: user1)
+        session2 = ShopifyAPI::Auth::Session.new(id: id, shop: shop, associated_user: user2)
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_shopify_session_id
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          shopify_session_id: "shopify-session-1",
+        )
+        session2 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          shopify_session_id: "shopify-session-2",
+        )
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_refresh_token
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          refresh_token: "refresh-token-1",
+        )
+        session2 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          refresh_token: "refresh-token-2",
+        )
+
+        refute_equal(session1, session2)
+      end
+
+      def test_inequality_with_different_refresh_token_expires
+        id = "session-id"
+        shop = "test-shop"
+
+        session1 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          refresh_token_expires: Time.now + 3600,
+        )
+        session2 = ShopifyAPI::Auth::Session.new(
+          id: id,
+          shop: shop,
+          refresh_token_expires: Time.now + 7200,
+        )
+
+        refute_equal(session1, session2)
       end
 
       def teardown