shopify_api 12.4.0 → 13.0.0

data/lib/shopify_api/utils/graphql_proxy.rb

@@ -9,22 +9,19 @@ module ShopifyAPI
 
         sig do
           params(
+            session: Auth::Session,
             headers: T::Hash[String, T.untyped],
             body: String,
             cookies: T.nilable(T::Hash[String, String]),
             tries: Integer,
           ).returns(Clients::HttpResponse)
         end
-        def proxy_query(headers:, body:, cookies: nil, tries: 1)
+        def proxy_query(session:, headers:, body:, cookies: nil, tries: 1)
           raise Errors::PrivateAppError, "GraphQL proxing is unsupported for private apps." if Context.private?
 
           normalized_headers = HttpUtils.normalize_headers(headers)
 
-          session = Utils::SessionUtils.load_current_session(
-            auth_header: normalized_headers["authorization"], cookies: cookies, is_online: true,
-          )
-
-          if session.nil? || !session.online?
+          unless session.online?
             raise Errors::SessionNotFoundError,
               "Failed to load an online session from the provided parameters."
           end

data/lib/shopify_api/utils/session_utils.rb

@@ -9,67 +9,6 @@ module ShopifyAPI
       class << self
         extend T::Sig
 
-        sig do
-          params(
-            auth_header: T.nilable(String),
-            cookies: T.nilable(T::Hash[String, String]),
-            is_online: T::Boolean,
-          ).returns(T.nilable(Auth::Session))
-        end
-        def load_current_session(auth_header: nil, cookies: nil, is_online: false)
-          validate_session_storage_for_deprecated_utils
-          return load_private_session if Context.private?
-
-          session_id = current_session_id(auth_header, cookies, is_online)
-          return nil unless session_id
-
-          T.must(Context.session_storage).load_session(session_id)
-        end
-
-        sig do
-          params(
-            auth_header: T.nilable(String),
-            cookies: T.nilable(T::Hash[String, String]),
-            is_online: T::Boolean,
-          ).returns(T::Boolean)
-        end
-        def delete_current_session(auth_header: nil, cookies: nil, is_online: false)
-          validate_session_storage_for_deprecated_utils
-
-          session_id = current_session_id(auth_header, cookies, is_online)
-          return false unless session_id
-
-          T.must(Context.session_storage).delete_session(session_id)
-        end
-
-        sig do
-          params(
-            shop: String,
-            include_expired: T::Boolean,
-          ).returns(T.nilable(Auth::Session))
-        end
-        def load_offline_session(shop:, include_expired: false)
-          validate_session_storage_for_deprecated_utils
-
-          session_id = offline_session_id(shop)
-          session = T.must(Context.session_storage).load_session(session_id)
-          return nil if session && !include_expired && session.expires && T.must(session.expires) < Time.now
-
-          session
-        end
-
-        sig do
-          params(
-            shop: String,
-          ).returns(T::Boolean)
-        end
-        def delete_offline_session(shop:)
-          validate_session_storage_for_deprecated_utils
-
-          session_id = offline_session_id(shop)
-          T.must(Context.session_storage).delete_session(session_id)
-        end
-
         sig do
           params(
             auth_header: T.nilable(String),
@@ -123,29 +62,6 @@ module ShopifyAPI
         def cookie_session_id(cookies)
           cookies[Auth::Oauth::SessionCookie::SESSION_COOKIE_NAME]
         end
-
-        private
-
-        sig { void }
-        def validate_session_storage_for_deprecated_utils
-          unless Context.session_storage
-            raise ShopifyAPI::Errors::SessionStorageError,
-              "session_storage is required in ShopifyAPI::Context when using deprecated Session utility methods."
-          end
-        end
-
-        sig { returns(Auth::Session) }
-        def load_private_session
-          unless Context.private_shop
-            raise Errors::SessionNotFoundError, "Could not load private shop, Context.private_shop is nil."
-          end
-
-          Auth::Session.new(
-            shop: T.must(Context.private_shop),
-            access_token: Context.api_secret_key,
-            scope: Context.scope.to_a,
-          )
-        end
       end
     end
   end

data/lib/shopify_api/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ShopifyAPI
-  VERSION = "12.4.0"
+  VERSION = "13.0.0"
 end

data/lib/shopify_api/webhooks/registry.rb

@@ -136,7 +136,7 @@ module ShopifyAPI
         def get_webhook_id(topic:, client:)
           fetch_id_query = <<~QUERY
             {
-              webhookSubscriptions(first: 1, topics: #{topic.gsub("/", "_").upcase}) {
+              webhookSubscriptions(first: 1, topics: #{topic.gsub(%r{/|\.}, "_").upcase}) {
                 edges {
                   node {
                     id

data/shopify_api.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
     section of Shopify stores.
   HERE
   s.email = "developers@shopify.com"
-  s.homepage = "https://shopify.dev/apps"
+  s.homepage = "https://shopify.dev/docs/apps"
 
   s.metadata["allowed_push_host"] = "https://rubygems.org"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 12.4.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -282,8 +282,12 @@ files:
 - ".github/ISSUE_TEMPLATE/BUG_REPORT.md"
 - ".github/ISSUE_TEMPLATE/ENHANCEMENT.md"
 - ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
+- ".github/api_update_reminder.md"
+- ".github/api_update_reminder_on_release.md"
 - ".github/dependabot.yml"
 - ".github/pull_request_template.md"
+- ".github/workflows/api_update_reminder.yml"
+- ".github/workflows/api_update_reminder_on_release.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/cla.yml"
 - ".github/workflows/close-waiting-for-response-issues.yml"
@@ -316,13 +320,11 @@ files:
 - lib/shopify_api/auth.rb
 - lib/shopify_api/auth/associated_user.rb
 - lib/shopify_api/auth/auth_scopes.rb
-- lib/shopify_api/auth/file_session_storage.rb
 - lib/shopify_api/auth/jwt_payload.rb
 - lib/shopify_api/auth/oauth.rb
 - lib/shopify_api/auth/oauth/auth_query.rb
 - lib/shopify_api/auth/oauth/session_cookie.rb
 - lib/shopify_api/auth/session.rb
-- lib/shopify_api/auth/session_storage.rb
 - lib/shopify_api/clients/graphql/admin.rb
 - lib/shopify_api/clients/graphql/client.rb
 - lib/shopify_api/clients/graphql/storefront.rb
@@ -359,80 +361,6 @@ files:
 - lib/shopify_api/logger.rb
 - lib/shopify_api/rest/base.rb
 - lib/shopify_api/rest/base_errors.rb
-- lib/shopify_api/rest/resources/2022_01/abandoned_checkout.rb
-- lib/shopify_api/rest/resources/2022_01/access_scope.rb
-- lib/shopify_api/rest/resources/2022_01/android_pay_key.rb
-- lib/shopify_api/rest/resources/2022_01/apple_pay_certificate.rb
-- lib/shopify_api/rest/resources/2022_01/application_charge.rb
-- lib/shopify_api/rest/resources/2022_01/application_credit.rb
-- lib/shopify_api/rest/resources/2022_01/article.rb
-- lib/shopify_api/rest/resources/2022_01/asset.rb
-- lib/shopify_api/rest/resources/2022_01/assigned_fulfillment_order.rb
-- lib/shopify_api/rest/resources/2022_01/balance.rb
-- lib/shopify_api/rest/resources/2022_01/blog.rb
-- lib/shopify_api/rest/resources/2022_01/cancellation_request.rb
-- lib/shopify_api/rest/resources/2022_01/carrier_service.rb
-- lib/shopify_api/rest/resources/2022_01/checkout.rb
-- lib/shopify_api/rest/resources/2022_01/collect.rb
-- lib/shopify_api/rest/resources/2022_01/collection.rb
-- lib/shopify_api/rest/resources/2022_01/collection_listing.rb
-- lib/shopify_api/rest/resources/2022_01/comment.rb
-- lib/shopify_api/rest/resources/2022_01/country.rb
-- lib/shopify_api/rest/resources/2022_01/currency.rb
-- lib/shopify_api/rest/resources/2022_01/custom_collection.rb
-- lib/shopify_api/rest/resources/2022_01/customer.rb
-- lib/shopify_api/rest/resources/2022_01/customer_address.rb
-- lib/shopify_api/rest/resources/2022_01/customer_saved_search.rb
-- lib/shopify_api/rest/resources/2022_01/deprecated_api_call.rb
-- lib/shopify_api/rest/resources/2022_01/discount_code.rb
-- lib/shopify_api/rest/resources/2022_01/dispute.rb
-- lib/shopify_api/rest/resources/2022_01/draft_order.rb
-- lib/shopify_api/rest/resources/2022_01/event.rb
-- lib/shopify_api/rest/resources/2022_01/fulfillment.rb
-- lib/shopify_api/rest/resources/2022_01/fulfillment_event.rb
-- lib/shopify_api/rest/resources/2022_01/fulfillment_order.rb
-- lib/shopify_api/rest/resources/2022_01/fulfillment_request.rb
-- lib/shopify_api/rest/resources/2022_01/fulfillment_service.rb
-- lib/shopify_api/rest/resources/2022_01/gift_card.rb
-- lib/shopify_api/rest/resources/2022_01/gift_card_adjustment.rb
-- lib/shopify_api/rest/resources/2022_01/image.rb
-- lib/shopify_api/rest/resources/2022_01/inventory_item.rb
-- lib/shopify_api/rest/resources/2022_01/inventory_level.rb
-- lib/shopify_api/rest/resources/2022_01/location.rb
-- lib/shopify_api/rest/resources/2022_01/locations_for_move.rb
-- lib/shopify_api/rest/resources/2022_01/marketing_event.rb
-- lib/shopify_api/rest/resources/2022_01/metafield.rb
-- lib/shopify_api/rest/resources/2022_01/mobile_platform_application.rb
-- lib/shopify_api/rest/resources/2022_01/order.rb
-- lib/shopify_api/rest/resources/2022_01/order_risk.rb
-- lib/shopify_api/rest/resources/2022_01/page.rb
-- lib/shopify_api/rest/resources/2022_01/payment.rb
-- lib/shopify_api/rest/resources/2022_01/payment_gateway.rb
-- lib/shopify_api/rest/resources/2022_01/payment_transaction.rb
-- lib/shopify_api/rest/resources/2022_01/payout.rb
-- lib/shopify_api/rest/resources/2022_01/policy.rb
-- lib/shopify_api/rest/resources/2022_01/price_rule.rb
-- lib/shopify_api/rest/resources/2022_01/product.rb
-- lib/shopify_api/rest/resources/2022_01/product_listing.rb
-- lib/shopify_api/rest/resources/2022_01/product_resource_feedback.rb
-- lib/shopify_api/rest/resources/2022_01/province.rb
-- lib/shopify_api/rest/resources/2022_01/recurring_application_charge.rb
-- lib/shopify_api/rest/resources/2022_01/redirect.rb
-- lib/shopify_api/rest/resources/2022_01/refund.rb
-- lib/shopify_api/rest/resources/2022_01/report.rb
-- lib/shopify_api/rest/resources/2022_01/resource_feedback.rb
-- lib/shopify_api/rest/resources/2022_01/script_tag.rb
-- lib/shopify_api/rest/resources/2022_01/shipping_zone.rb
-- lib/shopify_api/rest/resources/2022_01/shop.rb
-- lib/shopify_api/rest/resources/2022_01/smart_collection.rb
-- lib/shopify_api/rest/resources/2022_01/storefront_access_token.rb
-- lib/shopify_api/rest/resources/2022_01/tender_transaction.rb
-- lib/shopify_api/rest/resources/2022_01/theme.rb
-- lib/shopify_api/rest/resources/2022_01/transaction.rb
-- lib/shopify_api/rest/resources/2022_01/usage_charge.rb
-- lib/shopify_api/rest/resources/2022_01/user.rb
-- lib/shopify_api/rest/resources/2022_01/variant.rb
-- lib/shopify_api/rest/resources/2022_01/webhook.rb
 - lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb
 - lib/shopify_api/rest/resources/2022_04/access_scope.rb
 - lib/shopify_api/rest/resources/2022_04/android_pay_key.rb
@@ -685,6 +613,8 @@ files:
 - lib/shopify_api/rest/resources/2023_01/deprecated_api_call.rb
 - lib/shopify_api/rest/resources/2023_01/discount_code.rb
 - lib/shopify_api/rest/resources/2023_01/dispute.rb
+- lib/shopify_api/rest/resources/2023_01/dispute_evidence.rb
+- lib/shopify_api/rest/resources/2023_01/dispute_file_upload.rb
 - lib/shopify_api/rest/resources/2023_01/draft_order.rb
 - lib/shopify_api/rest/resources/2023_01/event.rb
 - lib/shopify_api/rest/resources/2023_01/fulfillment.rb
@@ -732,6 +662,81 @@ files:
 - lib/shopify_api/rest/resources/2023_01/user.rb
 - lib/shopify_api/rest/resources/2023_01/variant.rb
 - lib/shopify_api/rest/resources/2023_01/webhook.rb
+- lib/shopify_api/rest/resources/2023_04/abandoned_checkout.rb
+- lib/shopify_api/rest/resources/2023_04/access_scope.rb
+- lib/shopify_api/rest/resources/2023_04/apple_pay_certificate.rb
+- lib/shopify_api/rest/resources/2023_04/application_charge.rb
+- lib/shopify_api/rest/resources/2023_04/application_credit.rb
+- lib/shopify_api/rest/resources/2023_04/article.rb
+- lib/shopify_api/rest/resources/2023_04/asset.rb
+- lib/shopify_api/rest/resources/2023_04/assigned_fulfillment_order.rb
+- lib/shopify_api/rest/resources/2023_04/balance.rb
+- lib/shopify_api/rest/resources/2023_04/blog.rb
+- lib/shopify_api/rest/resources/2023_04/cancellation_request.rb
+- lib/shopify_api/rest/resources/2023_04/carrier_service.rb
+- lib/shopify_api/rest/resources/2023_04/checkout.rb
+- lib/shopify_api/rest/resources/2023_04/collect.rb
+- lib/shopify_api/rest/resources/2023_04/collection.rb
+- lib/shopify_api/rest/resources/2023_04/collection_listing.rb
+- lib/shopify_api/rest/resources/2023_04/comment.rb
+- lib/shopify_api/rest/resources/2023_04/country.rb
+- lib/shopify_api/rest/resources/2023_04/currency.rb
+- lib/shopify_api/rest/resources/2023_04/custom_collection.rb
+- lib/shopify_api/rest/resources/2023_04/customer.rb
+- lib/shopify_api/rest/resources/2023_04/customer_address.rb
+- lib/shopify_api/rest/resources/2023_04/customer_saved_search.rb
+- lib/shopify_api/rest/resources/2023_04/deprecated_api_call.rb
+- lib/shopify_api/rest/resources/2023_04/discount_code.rb
+- lib/shopify_api/rest/resources/2023_04/dispute.rb
+- lib/shopify_api/rest/resources/2023_04/dispute_evidence.rb
+- lib/shopify_api/rest/resources/2023_04/dispute_file_upload.rb
+- lib/shopify_api/rest/resources/2023_04/draft_order.rb
+- lib/shopify_api/rest/resources/2023_04/event.rb
+- lib/shopify_api/rest/resources/2023_04/fulfillment.rb
+- lib/shopify_api/rest/resources/2023_04/fulfillment_event.rb
+- lib/shopify_api/rest/resources/2023_04/fulfillment_order.rb
+- lib/shopify_api/rest/resources/2023_04/fulfillment_request.rb
+- lib/shopify_api/rest/resources/2023_04/fulfillment_service.rb
+- lib/shopify_api/rest/resources/2023_04/gift_card.rb
+- lib/shopify_api/rest/resources/2023_04/gift_card_adjustment.rb
+- lib/shopify_api/rest/resources/2023_04/image.rb
+- lib/shopify_api/rest/resources/2023_04/inventory_item.rb
+- lib/shopify_api/rest/resources/2023_04/inventory_level.rb
+- lib/shopify_api/rest/resources/2023_04/location.rb
+- lib/shopify_api/rest/resources/2023_04/locations_for_move.rb
+- lib/shopify_api/rest/resources/2023_04/marketing_event.rb
+- lib/shopify_api/rest/resources/2023_04/metafield.rb
+- lib/shopify_api/rest/resources/2023_04/mobile_platform_application.rb
+- lib/shopify_api/rest/resources/2023_04/order.rb
+- lib/shopify_api/rest/resources/2023_04/order_risk.rb
+- lib/shopify_api/rest/resources/2023_04/page.rb
+- lib/shopify_api/rest/resources/2023_04/payment.rb
+- lib/shopify_api/rest/resources/2023_04/payment_gateway.rb
+- lib/shopify_api/rest/resources/2023_04/payment_transaction.rb
+- lib/shopify_api/rest/resources/2023_04/payout.rb
+- lib/shopify_api/rest/resources/2023_04/policy.rb
+- lib/shopify_api/rest/resources/2023_04/price_rule.rb
+- lib/shopify_api/rest/resources/2023_04/product.rb
+- lib/shopify_api/rest/resources/2023_04/product_listing.rb
+- lib/shopify_api/rest/resources/2023_04/product_resource_feedback.rb
+- lib/shopify_api/rest/resources/2023_04/province.rb
+- lib/shopify_api/rest/resources/2023_04/recurring_application_charge.rb
+- lib/shopify_api/rest/resources/2023_04/redirect.rb
+- lib/shopify_api/rest/resources/2023_04/refund.rb
+- lib/shopify_api/rest/resources/2023_04/report.rb
+- lib/shopify_api/rest/resources/2023_04/resource_feedback.rb
+- lib/shopify_api/rest/resources/2023_04/script_tag.rb
+- lib/shopify_api/rest/resources/2023_04/shipping_zone.rb
+- lib/shopify_api/rest/resources/2023_04/shop.rb
+- lib/shopify_api/rest/resources/2023_04/smart_collection.rb
+- lib/shopify_api/rest/resources/2023_04/storefront_access_token.rb
+- lib/shopify_api/rest/resources/2023_04/tender_transaction.rb
+- lib/shopify_api/rest/resources/2023_04/theme.rb
+- lib/shopify_api/rest/resources/2023_04/transaction.rb
+- lib/shopify_api/rest/resources/2023_04/usage_charge.rb
+- lib/shopify_api/rest/resources/2023_04/user.rb
+- lib/shopify_api/rest/resources/2023_04/variant.rb
+- lib/shopify_api/rest/resources/2023_04/webhook.rb
 - lib/shopify_api/utils/graphql_proxy.rb
 - lib/shopify_api/utils/hmac_validator.rb
 - lib/shopify_api/utils/http_utils.rb
@@ -802,7 +807,7 @@ files:
 - sorbet/rbi/todo.rbi
 - sorbet/tapioca/config.yml
 - sorbet/tapioca/require.rb
-homepage: https://shopify.dev/apps
+homepage: https://shopify.dev/docs/apps
 licenses:
 - MIT
 metadata:
@@ -823,7 +828,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.13
 signing_key: 
 specification_version: 4
 summary: The gem for accessing the Shopify API

data/lib/shopify_api/auth/file_session_storage.rb

@@ -1,72 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "fileutils"
-
-module ShopifyAPI
-  module Auth
-    class FileSessionStorage
-      extend T::Sig
-      extend T::Helpers
-      include ShopifyAPI::Auth::SessionStorage
-
-      sig { returns(String) }
-      attr_accessor :path
-
-      sig { params(path: String).void }
-      def initialize(path: "/tmp/shopify_api_sessions")
-        @path = path
-        FileUtils.mkdir_p(path) unless Dir.exist?(path)
-      end
-
-      sig do
-        override.params(session: Session)
-          .returns(T::Boolean)
-      end
-      def store_session(session)
-        File.write(session_file_path(session.id), session.serialize) > 0
-      end
-
-      sig do
-        override.params(id: String)
-          .returns(T.nilable(Session))
-      end
-      def load_session(id)
-        session_path = session_file_path(id)
-        if File.exist?(session_path)
-          ShopifyAPI::Auth::Session.deserialize(File.read(session_path))
-        end
-      end
-
-      sig do
-        override.params(id: String)
-          .returns(T::Boolean)
-      end
-      def delete_session(id)
-        session_path = session_file_path(id)
-        File.delete(session_path) if File.exist?(session_path)
-        true
-      end
-
-      alias_method :eql?, :==
-      sig { params(other: T.nilable(FileSessionStorage)).returns(T::Boolean) }
-      def ==(other)
-        if other
-          @path == other.path
-        else
-          false
-        end
-      end
-
-      private
-
-      sig do
-        params(id: String)
-          .returns(String)
-      end
-      def session_file_path(id)
-        "#{@path}/#{id}"
-      end
-    end
-  end
-end

data/lib/shopify_api/auth/session_storage.rb

@@ -1,30 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-module ShopifyAPI
-  module Auth
-    module SessionStorage
-      extend T::Sig
-      extend T::Helpers
-      interface!
-
-      sig do
-        abstract.params(session: Session)
-          .returns(T::Boolean)
-      end
-      def store_session(session); end
-
-      sig do
-        abstract.params(id: String)
-          .returns(T.nilable(Session))
-      end
-      def load_session(id); end
-
-      sig do
-        abstract.params(id: String)
-          .returns(T::Boolean)
-      end
-      def delete_session(id); end
-    end
-  end
-end