shopify_api 11.1.0 → 12.4.0

data/lib/shopify_api/rest/resources/2023_01/variant.rb

@@ -0,0 +1,212 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Variant < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @barcode = T.let(nil, T.nilable(String))
+      @compare_at_price = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @fulfillment_service = T.let(nil, T.nilable(String))
+      @grams = T.let(nil, T.nilable(Integer))
+      @id = T.let(nil, T.nilable(Integer))
+      @image_id = T.let(nil, T.nilable(Integer))
+      @inventory_item_id = T.let(nil, T.nilable(Integer))
+      @inventory_management = T.let(nil, T.nilable(String))
+      @inventory_policy = T.let(nil, T.nilable(String))
+      @inventory_quantity = T.let(nil, T.nilable(Integer))
+      @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
+      @old_inventory_quantity = T.let(nil, T.nilable(Integer))
+      @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
+      @position = T.let(nil, T.nilable(Integer))
+      @presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @price = T.let(nil, T.nilable(String))
+      @product_id = T.let(nil, T.nilable(Integer))
+      @requires_shipping = T.let(nil, T.nilable(T::Boolean))
+      @sku = T.let(nil, T.nilable(String))
+      @tax_code = T.let(nil, T.nilable(String))
+      @taxable = T.let(nil, T.nilable(T::Boolean))
+      @title = T.let(nil, T.nilable(String))
+      @updated_at = T.let(nil, T.nilable(String))
+      @weight = T.let(nil, T.nilable(Float))
+      @weight_unit = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:product_id, :id], path: "products/<product_id>/variants/<id>.json"},
+      {http_method: :get, operation: :count, ids: [:product_id], path: "products/<product_id>/variants/count.json"},
+      {http_method: :get, operation: :get, ids: [:product_id], path: "products/<product_id>/variants.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "variants/<id>.json"},
+      {http_method: :post, operation: :post, ids: [:product_id], path: "products/<product_id>/variants.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+    @read_only_attributes = T.let([
+      :inventory_quantity,
+      :inventory_quantity_adjustment
+    ], T::Array[Symbol])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :barcode
+    sig { returns(T.nilable(String)) }
+    attr_reader :compare_at_price
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(String)) }
+    attr_reader :fulfillment_service
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :grams
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :image_id
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :inventory_item_id
+    sig { returns(T.nilable(String)) }
+    attr_reader :inventory_management
+    sig { returns(T.nilable(String)) }
+    attr_reader :inventory_policy
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :inventory_quantity
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :inventory_quantity_adjustment
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :old_inventory_quantity
+    sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
+    attr_reader :option
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :position
+    sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
+    attr_reader :presentment_prices
+    sig { returns(T.nilable(String)) }
+    attr_reader :price
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :product_id
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :requires_shipping
+    sig { returns(T.nilable(String)) }
+    attr_reader :sku
+    sig { returns(T.nilable(String)) }
+    attr_reader :tax_code
+    sig { returns(T.nilable(T::Boolean)) }
+    attr_reader :taxable
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+    sig { returns(T.nilable(Float)) }
+    attr_reader :weight
+    sig { returns(T.nilable(String)) }
+    attr_reader :weight_unit
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Variant))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Variant))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          product_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        product_id: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id, product_id: product_id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          product_id: T.nilable(T.any(Integer, String)),
+          limit: T.untyped,
+          presentment_currencies: T.untyped,
+          since_id: T.untyped,
+          fields: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Variant])
+      end
+      def all(
+        product_id: nil,
+        limit: nil,
+        presentment_currencies: nil,
+        since_id: nil,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {product_id: product_id},
+          params: {limit: limit, presentment_currencies: presentment_currencies, since_id: since_id, fields: fields}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Variant])
+      end
+
+      sig do
+        params(
+          product_id: T.nilable(T.any(Integer, String)),
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        product_id: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {product_id: product_id},
+          params: {}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/rest/resources/2023_01/webhook.rb

@@ -0,0 +1,168 @@
+# typed: false
+# frozen_string_literal: true
+
+########################################################################################################################
+# This file is auto-generated. If you have an issue, please create a GitHub issue.                                     #
+########################################################################################################################
+
+module ShopifyAPI
+  class Webhook < ShopifyAPI::Rest::Base
+    extend T::Sig
+
+    @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+    @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
+
+    sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
+    def initialize(session: ShopifyAPI::Context.active_session)
+      super(session: session)
+
+      @address = T.let(nil, T.nilable(String))
+      @topic = T.let(nil, T.nilable(String))
+      @api_version = T.let(nil, T.nilable(String))
+      @created_at = T.let(nil, T.nilable(String))
+      @fields = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @format = T.let(nil, T.nilable(String))
+      @id = T.let(nil, T.nilable(Integer))
+      @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @private_metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
+      @updated_at = T.let(nil, T.nilable(String))
+    end
+
+    @has_one = T.let({}, T::Hash[Symbol, Class])
+    @has_many = T.let({}, T::Hash[Symbol, Class])
+    @paths = T.let([
+      {http_method: :delete, operation: :delete, ids: [:id], path: "webhooks/<id>.json"},
+      {http_method: :get, operation: :count, ids: [], path: "webhooks/count.json"},
+      {http_method: :get, operation: :get, ids: [], path: "webhooks.json"},
+      {http_method: :get, operation: :get, ids: [:id], path: "webhooks/<id>.json"},
+      {http_method: :post, operation: :post, ids: [], path: "webhooks.json"},
+      {http_method: :put, operation: :put, ids: [:id], path: "webhooks/<id>.json"}
+    ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :address
+    sig { returns(T.nilable(String)) }
+    attr_reader :topic
+    sig { returns(T.nilable(String)) }
+    attr_reader :api_version
+    sig { returns(T.nilable(String)) }
+    attr_reader :created_at
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :fields
+    sig { returns(T.nilable(String)) }
+    attr_reader :format
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :id
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :metafield_namespaces
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :private_metafield_namespaces
+    sig { returns(T.nilable(String)) }
+    attr_reader :updated_at
+
+    class << self
+      sig do
+        params(
+          id: T.any(Integer, String),
+          fields: T.untyped,
+          session: Auth::Session
+        ).returns(T.nilable(Webhook))
+      end
+      def find(
+        id:,
+        fields: nil,
+        session: ShopifyAPI::Context.active_session
+      )
+        result = base_find(
+          session: session,
+          ids: {id: id},
+          params: {fields: fields},
+        )
+        T.cast(result[0], T.nilable(Webhook))
+      end
+
+      sig do
+        params(
+          id: T.any(Integer, String),
+          session: Auth::Session
+        ).returns(T.untyped)
+      end
+      def delete(
+        id:,
+        session: ShopifyAPI::Context.active_session
+      )
+        request(
+          http_method: :delete,
+          operation: :delete,
+          session: session,
+          ids: {id: id},
+          params: {},
+        )
+      end
+
+      sig do
+        params(
+          address: T.untyped,
+          created_at_max: T.untyped,
+          created_at_min: T.untyped,
+          fields: T.untyped,
+          limit: T.untyped,
+          since_id: T.untyped,
+          topic: T.untyped,
+          updated_at_min: T.untyped,
+          updated_at_max: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T::Array[Webhook])
+      end
+      def all(
+        address: nil,
+        created_at_max: nil,
+        created_at_min: nil,
+        fields: nil,
+        limit: nil,
+        since_id: nil,
+        topic: nil,
+        updated_at_min: nil,
+        updated_at_max: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        response = base_find(
+          session: session,
+          ids: {},
+          params: {address: address, created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, topic: topic, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
+        )
+
+        T.cast(response, T::Array[Webhook])
+      end
+
+      sig do
+        params(
+          address: T.untyped,
+          topic: T.untyped,
+          session: Auth::Session,
+          kwargs: T.untyped
+        ).returns(T.untyped)
+      end
+      def count(
+        address: nil,
+        topic: nil,
+        session: ShopifyAPI::Context.active_session,
+        **kwargs
+      )
+        request(
+          http_method: :get,
+          operation: :count,
+          session: session,
+          ids: {},
+          params: {address: address, topic: topic}.merge(kwargs).compact,
+          body: {},
+          entity: nil,
+        )
+      end
+
+    end
+
+  end
+end

data/lib/shopify_api/utils/graphql_proxy.rb

@@ -12,7 +12,7 @@ module ShopifyAPI
             headers: T::Hash[String, T.untyped],
             body: String,
             cookies: T.nilable(T::Hash[String, String]),
-            tries: Integer
+            tries: Integer,
           ).returns(Clients::HttpResponse)
         end
         def proxy_query(headers:, body:, cookies: nil, tries: 1)
@@ -21,7 +21,7 @@ module ShopifyAPI
           normalized_headers = HttpUtils.normalize_headers(headers)
 
           session = Utils::SessionUtils.load_current_session(
-            auth_header: normalized_headers["authorization"], cookies: cookies, is_online: true
+            auth_header: normalized_headers["authorization"], cookies: cookies, is_online: true,
           )
 
           if session.nil? || !session.online?

data/lib/shopify_api/utils/session_utils.rb

@@ -13,30 +13,33 @@ module ShopifyAPI
           params(
             auth_header: T.nilable(String),
             cookies: T.nilable(T::Hash[String, String]),
-            is_online: T::Boolean
+            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
 
-          Context.session_storage.load_session(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
+            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
 
-          Context.session_storage.delete_session(session_id)
+          T.must(Context.session_storage).delete_session(session_id)
         end
 
         sig do
@@ -46,8 +49,10 @@ module ShopifyAPI
           ).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 = Context.session_storage.load_session(session_id)
+          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
@@ -55,42 +60,31 @@ module ShopifyAPI
 
         sig do
           params(
-            shop: String
+            shop: String,
           ).returns(T::Boolean)
         end
         def delete_offline_session(shop:)
-          session_id = offline_session_id(shop)
-          Context.session_storage.delete_session(session_id)
-        end
-
-        private
-
-        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
+          validate_session_storage_for_deprecated_utils
 
-          Auth::Session.new(
-            shop: T.must(Context.private_shop),
-            access_token: Context.api_secret_key,
-            scope: Context.scope.to_a
-          )
+          session_id = offline_session_id(shop)
+          T.must(Context.session_storage).delete_session(session_id)
         end
 
         sig do
           params(
             auth_header: T.nilable(String),
             cookies: T.nilable(T::Hash[String, String]),
-            online: T::Boolean
+            online: T::Boolean,
           ).returns(T.nilable(String))
         end
         def current_session_id(auth_header, cookies, online)
           if Context.embedded?
             if auth_header
               matches = auth_header.match(/^Bearer (.+)$/)
-              raise Errors::MissingJwtTokenError,
-                "Missing Bearer token in authorization header" unless matches
+              unless matches
+                ShopifyAPI::Logger.warn("Missing Bearer token in authorization header")
+                raise Errors::MissingJwtTokenError, "Missing Bearer token in authorization header"
+              end
 
               jwt_payload = Auth::JwtPayload.new(T.must(matches[1]))
               shop = jwt_payload.shop
@@ -129,6 +123,29 @@ 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 = "11.1.0"
+  VERSION = "12.4.0"
 end

data/lib/shopify_api/webhooks/registrations/http.rb

@@ -9,7 +9,13 @@ module ShopifyAPI
 
         sig { override.returns(String) }
         def callback_address
-          "https://#{Context.host_name}/#{@path}"
+          if @path.match?(%r{^https?://})
+            @path
+          elsif @path.match?(/^#{Context.host_name}/)
+            "#{Context.host_scheme}://#{@path}"
+          else
+            "#{Context.host}/#{@path}"
+          end
         end
 
         sig { override.returns(T::Hash[Symbol, String]) }

data/lib/shopify_api/webhooks/registry.rb

@@ -41,7 +41,7 @@ module ShopifyAPI
         sig do
           params(
             topic: String,
-            session: Auth::Session
+            session: Auth::Session,
           ).returns(RegisterResult)
         end
         def register(topic:, session:)
@@ -61,11 +61,11 @@ module ShopifyAPI
             register_body = send_register_request(
               client,
               registration,
-              register_check_result[:webhook_id]
+              register_check_result[:webhook_id],
             )
             registered = registration_sucessful?(
               register_body,
-              registration.mutation_name(register_check_result[:webhook_id])
+              registration.mutation_name(register_check_result[:webhook_id]),
             )
           end
 
@@ -74,7 +74,7 @@ module ShopifyAPI
 
         sig do
           params(
-            session: Auth::Session
+            session: Auth::Session,
           ).returns(T::Array[RegisterResult])
         end
         def register_all(session:)
@@ -83,7 +83,7 @@ module ShopifyAPI
           topics.each do |topic|
             register_response = register(
               topic: topic,
-              session: session
+              session: session,
             )
             result.push(register_response)
           end
@@ -93,7 +93,7 @@ module ShopifyAPI
         sig do
           params(
             topic: String,
-            session: T.nilable(Auth::Session)
+            session: T.nilable(Auth::Session),
           ).returns(T::Hash[String, T.untyped])
         end
         def unregister(topic:, session:)
@@ -130,7 +130,7 @@ module ShopifyAPI
         sig do
           params(
             topic: String,
-            client: Clients::Graphql::Admin
+            client: Clients::Graphql::Admin,
           ).returns(T.nilable(String))
         end
         def get_webhook_id(topic:, client:)
@@ -194,7 +194,7 @@ module ShopifyAPI
           params(
             client: Clients::Graphql::Admin,
             registration: Registration,
-            webhook_id: T.nilable(String)
+            webhook_id: T.nilable(String),
           ).returns(T::Hash[String, T.untyped])
         end
         def send_register_request(client, registration, webhook_id)

data/service.yml

@@ -1,2 +1 @@
 audience: partner
-classification: library

data/shopify_api.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.6"
 
+  s.add_runtime_dependency("activesupport")
   s.add_runtime_dependency("concurrent-ruby")
   s.add_runtime_dependency("hash_diff")
   s.add_runtime_dependency("httparty")
@@ -40,13 +41,14 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("openssl")
   s.add_runtime_dependency("securerandom")
   s.add_runtime_dependency("sorbet-runtime")
-  s.add_runtime_dependency("zeitwerk", "~> 2.5")
+  s.add_runtime_dependency("zeitwerk", "~> 2.5", "< 2.6.5") # https://github.com/Shopify/shopify-api-ruby/issues/1058
 
-  s.add_development_dependency("activesupport")
+  s.add_development_dependency("pry-byebug")
   s.add_development_dependency("rake")
   s.add_development_dependency("rubocop")
   s.add_development_dependency("rubocop-shopify")
   s.add_development_dependency("rubocop-sorbet")
+  s.add_development_dependency("ruby-lsp")
   s.add_development_dependency("sorbet")
   s.add_development_dependency("tapioca")
 end