shopify_api 9.5 → 9.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c73a80fab5607e57486b42ce37c750797bfc5ac391012b0ca4b8ad2e8dee7e
-  data.tar.gz: 7b4df963e1f9163d23a51623aa845f32a0bf996abf5f447f22a7226f0b6f0b5d
+  metadata.gz: f24aa6fda25253f8eaa77769a3e911da6eee1b3640da54d2d5cd1b21e2456edc
+  data.tar.gz: 40077cf4eca48ec27872dfba720594872ffe50118424edc99b065e92e43720a3
 SHA512:
-  metadata.gz: 87c1fdb069d8f3946eb2136c99eede3f03eb86373ccd60a1e7e46188b7fd141fd418e92a665802949b6b196625aafd6e4065af815cc52f5ff5d437e25517b7d1
-  data.tar.gz: ca85757c71561e6956f1e7499142a45f44d511e9256fb112fc594302d12bdca3d0071d68534a2e8061e0949251aec1c00cd8c5c977a7cfc040f3419ab7a9a1bb
+  metadata.gz: 4e9e85ec74d6e9c09342f51057d738cf2cf0d77d745ec1313a70663248c989e77524138170661a73ed02d7b1b70c6b569d0a1a866922bab6035ef73b8b29510f
+  data.tar.gz: 25349d3d9802381d96cdbbff0b3180950f6685ebf8d863edfe642090da6bb15d1c3fcb9fe7eb4927a281c7f8d95b93f0095db78e8568d762a79f762fd08f8504

data/.github/workflows/build.yml

@@ -12,8 +12,6 @@ jobs:
     strategy:
       matrix:
         version:
-          - "2.4"
-          - "2.5"
           - "2.6"
           - "2.7"
           - "3.0"
@@ -21,7 +19,8 @@ jobs:
           - Gemfile_ar41
           - Gemfile_ar50
           - Gemfile_ar51
-          - Gemfile_ar_master
+          - Gemfile_ar60
+          - Gemfile_ar_main
         exclude:
           - version: "2.7"
             gemfile: Gemfile_ar41

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## Unreleased
+
+## Version 9.5.2
+
+- [#1356](https://github.com/Shopify/shopify-api-ruby/pull/1356) Autoload ActiveResource classes to improve load time for Rails apps.
+
+## Version 9.5.1
+
+- [#891](https://github.com/Shopify/shopify_api/pull/891) Removed the upper bound on the `activeresource` dependency to allow apps to use the latest version
+
 ## Version 9.5
 
 * [#883](https://github.com/Shopify/shopify_api/pull/883) Add support for Ruby 3.0

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    shopify_api (9.5)
-      activeresource (>= 4.1.0, < 6.0.0)
+    shopify_api (9.5.2)
+      activeresource (>= 4.1.0)
       graphql-client
       rack
-      webrick
 
 GEM
   remote: https://rubygems.org/
@@ -42,7 +41,7 @@ GEM
     eventmachine (1.2.7)
     ffi (1.12.2)
     forwardable-extended (2.6.0)
-    graphql (1.12.16)
+    graphql (1.13.4)
     graphql-client (0.17.0)
       activesupport (>= 3.0)
       graphql (~> 1.10)
@@ -130,7 +129,6 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
     zeitwerk (2.3.0)
 
 PLATFORMS

data/Gemfile_ar60

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "activeresource", "~> 6.0"

data/README.md

@@ -61,6 +61,8 @@ For more information and detailed documentation about the API visit https://deve
 
 This gem requires Ruby 2.4 as of version 7.0.
 
+**Note**: when we release the next major version, we will be dropping support for Ruby 2.4 and 2.5, which have now reached EOL, as per [the releases page](https://www.ruby-lang.org/en/downloads/branches/).
+
 ## Installation
 
 Add `shopify_api` to your `Gemfile`:
@@ -87,13 +89,13 @@ ShopifyAPI sessions need to be configured with a fully authorized URL of a parti
 
 ### 1) Create an app
 
-First, create a new application in either the partners admin or your store admin. 
+First, create a new application in either the partners admin or your store admin.
 
 **Private apps** are used for merchant-owned scripts and apps that run silently in the background on a single shop. Private apps aren't able to render any content in the admin. Private apps are created through the store admin.
 
 **Custom apps** are also used for a single shop, but they have access to [app extensions](https://shopify.dev/docs/app-extensions) that allow the app to render content in the admin and are managed and created through the partners dashboard.
 
-**Public apps** can be installed on many stores, and can be added to the Shopify App Store to generate revenue for the developer. 
+**Public apps** can be installed on many stores, and can be added to the Shopify App Store to generate revenue for the developer.
 
 For a private app, you'll need the API_KEY and the PASSWORD; otherwise, you'll need the API_KEY and SHARED_SECRET.
 
@@ -112,7 +114,7 @@ For a private App you just need to set the base site url as follows:
    That's it; you're done! Next, skip to step 6 and start using the API!
 
 ### 2B) Public and Custom Apps
-   
+
    For public and custom apps, you will need to supply two parameters to the Session class before you instantiate it:
 
    ```ruby
@@ -130,11 +132,11 @@ Public and Custom apps need an access token from each shop to access that shop's
    ```ruby
    # We need to instantiate the session object before using it
    shopify_session = ShopifyAPI::Session.new(domain: "#{SHOP_NAME}.myshopify.com", api_version: api_version, token: nil)
-   
+
 # Then, create a permission URL with the session
    permission_url = shopify_session.create_permission_url(scope, "https://my_redirect_uri.com", { state: "My Nonce" })
    ```
-   
+
 After creating the permission URL, the user should be directed to this URL to approve the app.
 
 Under the hood, the `create_permission_url` method is preparing the app to make the following request :
@@ -167,8 +169,8 @@ Once authorized, the shop redirects the owner to the return URL of your applicat
    token = shopify_session.request_token(params)
    ```
 
-   This method will save the token to the session object and return it. All fields returned by Shopify, other than the access token itself, are stored in the session's `extra` attribute. For a list of all fields returned by Shopify, read [our OAuth documentation](https://shopify.dev/tutorials/authenticate-with-oauth#confirming-installation). 
-   
+   This method will save the token to the session object and return it. All fields returned by Shopify, other than the access token itself, are stored in the session's `extra` attribute. For a list of all fields returned by Shopify, read [our OAuth documentation](https://shopify.dev/tutorials/authenticate-with-oauth#confirming-installation).
+
    If you prefer to exchange the token manually, you can make a POST request to the shop with the following parameters :
 
    ```
@@ -198,7 +200,7 @@ Once authorized, the shop redirects the owner to the return URL of your applicat
    1) The list of scopes in `shopify_session.extra['scope']` is the same as you requested.
    2) If you requested an online-mode access token, `shopify_session.extra['associated_user']` must be present.
    Failing either of these tests means the end-user may have tampered with the URL parameters during the OAuth authentication phase. You should avoid using this access token and revoke it immediately. If you use the [`omniauth-shopify-oauth2`](https://github.com/Shopify/omniauth-shopify-oauth2) gem, these checks are done automatically for you.
-   
+
 ### 5) Activating the session
 
 Once you have a token, simply pass in the `token` and `extra` hash (optional) when creating the session object:
@@ -333,7 +335,7 @@ If you were previously using Shopify's [activeresource fork](https://github.com/
 
 ## Bulk Operations
 
-With the GraphQL Admin API, you can use bulk operations to asynchronously fetch data in bulk. The API is designed to reduce complexity and improve performance when dealing with large volumes of data. 
+With the GraphQL Admin API, you can use bulk operations to asynchronously fetch data in bulk. The API is designed to reduce complexity and improve performance when dealing with large volumes of data.
 
 Instead of manually paginating results and managing a client-side throttle, you can instead run a bulk query operation. Shopify’s infrastructure does the hard work of executing your query, and then provides you with a URL where you can download all of the data.
 
@@ -465,7 +467,7 @@ end
 
 ## Pagination
 
-Shopify uses [Relative cursor-based pagination](https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api) to provide more than a single page of results. 
+Shopify uses [Relative cursor-based pagination](https://shopify.dev/tutorials/make-paginated-requests-to-rest-admin-api) to provide more than a single page of results.
 
 ```ruby
 products = ShopifyAPI::Product.find(:all, params: { limit: 50 })
@@ -628,9 +630,9 @@ or you can even use our automated rake task for docker:
 bundle exec rake docker
 ```
 
-# Logging 
+# Logging
 
-Enable ActiveResource's logger with 
+Enable ActiveResource's logger with
 
 `export SHOPIFY_LOG_PATH={your_log_path}`
 

data/lib/active_resource/json_errors.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'active_resource/base'
+require 'active_resource/validations'
 
 module ActiveResource
   class Errors < ActiveModel::Errors

data/lib/shopify_api/api_version.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require "active_support/core_ext/hash"
+
 module ShopifyAPI
   class ApiVersion
     class UnknownVersion < StandardError; end

data/lib/shopify_api/graphql/railtie.rb

@@ -4,6 +4,8 @@ require 'rails/railtie'
 module ShopifyAPI
   module GraphQL
     class Railtie < Rails::Railtie
+      config.eager_load_namespaces << ShopifyAPI
+
       initializer 'shopify_api.initialize_graphql_clients' do |app|
         ShopifyAPI::GraphQL.schema_location = app.root.join('db', ShopifyAPI::GraphQL.schema_location)
         ShopifyAPI::GraphQL.initialize_clients

data/lib/shopify_api/hmac_params.rb

@@ -1,23 +1,33 @@
 # frozen_string_literal: true
-require 'webrick/httputils'
 
 module ShopifyAPI
   module HmacParams
-    extend WEBrick::HTTPUtils
+    class << self
+      def encode(params)
+        params
+          .except(:signature, :hmac, :action, :controller)
+          .map { |k,v| sprintf("%s=%s", encode_key(k), encode_value(v)) }
+          .sort.join("&")
+      end
 
-    def self.encode(params)
-      params
-        .except(:signature, :hmac, :action, :controller)
-        .map { |k,v| sprintf("%s=%s", encode_key(k), encode_value(v)) }
-        .sort.join("&")
-    end
+      KEY_REGEXP = /([#{Regexp.escape("&=%")}])/n
+      def encode_key(key)
+        _escape(key.to_s, KEY_REGEXP)
+      end
 
-    def self.encode_key(key)
-      _escape(key.to_s, _make_regex('&=%'))
-    end
+      VALUE_REGEXP = /([#{Regexp.escape("&%")}])/n
+      def encode_value(value)
+        _escape(value.to_s, VALUE_REGEXP)
+      end
+
+      private
 
-    def self.encode_value(value)
-      _escape(value.to_s, _make_regex('&%'))
+      def _escape(str, regex)
+        str = str.b
+        str.gsub!(regex) {"%%%02X" % $1.ord}
+        # %-escaped string should contain US-ASCII only
+        str.force_encoding(Encoding::US_ASCII)
+      end
     end
   end
 end

data/lib/shopify_api/resources/base.rb

@@ -164,3 +164,10 @@ module ShopifyAPI
     end
   end
 end
+
+
+if ShopifyAPI::Base.respond_to?(:connection_class)
+  ShopifyAPI::Base.connection_class = ShopifyAPI::Connection
+else
+  require 'active_resource/connection_ext'
+end

data/lib/shopify_api/resources.rb

@@ -1,4 +1,98 @@
 # frozen_string_literal: true
-require 'shopify_api/resources/base'
-require 'shopify_api/resources/array_base'
-Dir.glob("#{File.dirname(__FILE__)}/resources/*").each { |file| require(file) }
+
+module ShopifyAPI
+  eager_autoload do
+    autoload_under('resources') do
+      autoload(:Base)
+      autoload(:ArrayBase)
+      autoload(:AbandonedCheckout)
+      autoload(:AccessScope)
+      autoload(:AccessToken)
+      autoload(:Address)
+      autoload(:Announcement)
+      autoload(:ApiPermission)
+      autoload(:ApplicationCharge)
+      autoload(:ApplicationCredit)
+      autoload(:ArrayBase)
+      autoload(:Article)
+      autoload(:Asset)
+      autoload(:AssignedFulfillmentOrder)
+      autoload(:Base)
+      autoload(:BillingAddress)
+      autoload(:Blog)
+      autoload(:CarrierService)
+      autoload(:Cart)
+      autoload(:Checkout)
+      autoload(:Collect)
+      autoload(:Collection)
+      autoload(:CollectionListing)
+      autoload(:CollectionPublication)
+      autoload(:Comment)
+      autoload(:Country)
+      autoload(:Currency)
+      autoload(:CustomCollection)
+      autoload(:Customer)
+      autoload(:CustomerGroup)
+      autoload(:CustomerInvite)
+      autoload(:CustomerSavedSearch)
+      autoload(:DiscountCode)
+      autoload(:DiscountCodeBatch)
+      autoload(:DraftOrder)
+      autoload(:DraftOrderInvoice)
+      autoload(:Event)
+      autoload(:Fulfillment)
+      autoload(:FulfillmentEvent)
+      autoload(:FulfillmentOrder)
+      autoload(:FulfillmentOrderLocationsForMove)
+      autoload(:FulfillmentRequest)
+      autoload(:FulfillmentService)
+      autoload(:FulfillmentV2)
+      autoload(:GiftCard)
+      autoload(:Image)
+      autoload(:InventoryItem)
+      autoload(:InventoryLevel)
+      autoload(:LineItem)
+      autoload(:Location)
+      autoload(:MarketingEvent)
+      autoload(:Metafield)
+      autoload(:NoteAttribute)
+      autoload(:Option)
+      autoload(:Order)
+      autoload(:OrderRisk)
+      autoload(:Page)
+      autoload(:Payment)
+      autoload(:PaymentDetails)
+      autoload(:Policy)
+      autoload(:PriceRule)
+      autoload(:Product)
+      autoload(:ProductListing)
+      autoload(:ProductPublication)
+      autoload(:Province)
+      autoload(:Publication)
+      autoload(:Receipt)
+      autoload(:RecurringApplicationCharge)
+      autoload(:Redirect)
+      autoload(:Refund)
+      autoload(:Report)
+      autoload(:ResourceFeedback)
+      autoload(:Rule)
+      autoload(:ScriptTag)
+      autoload(:ShippingAddress)
+      autoload(:ShippingLine)
+      autoload(:ShippingRate)
+      autoload(:ShippingZone)
+      autoload(:Shop)
+      autoload(:SmartCollection)
+      autoload(:StorefrontAccessToken)
+      autoload(:TaxLine)
+      autoload(:TaxService)
+      autoload(:TenderTransaction)
+      autoload(:Theme)
+      autoload(:Transaction)
+      autoload(:UsageCharge)
+      autoload(:User)
+      autoload(:Variant)
+      autoload(:Webhook)
+    end
+  end
+end

data/lib/shopify_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ShopifyAPI
-  VERSION = "9.5"
+  VERSION = "9.5.2"
 end

data/lib/shopify_api.rb

@@ -5,36 +5,40 @@ require 'active_support/core_ext/class/attribute_accessors'
 require 'digest/md5'
 require 'base64'
 require 'active_resource/detailed_log_subscriber'
-require 'shopify_api/limits'
-require 'shopify_api/api_version'
-require 'shopify_api/meta'
 require 'active_resource/json_errors'
-require 'shopify_api/paginated_collection'
-require 'shopify_api/disable_prefix_check'
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.6")
+  puts("\nshopify_api: NOTE: Support for Ruby #{RUBY_VERSION} will be dropped in the next major release. Please update to Ruby 2.6 or newer before updating this gem.\n\n")
+end
 
 module ShopifyAPI
+  extend ActiveSupport::Autoload
+
+  require 'shopify_api/limits'
+  require 'shopify_api/api_version'
+  require 'shopify_api/paginated_collection'
+  require 'shopify_api/disable_prefix_check'
+  require 'shopify_api/events'
+  require 'shopify_api/metafields'
+  require 'shopify_api/countable'
+  require 'shopify_api/resources'
+  require 'shopify_api/session'
+  require 'shopify_api/hmac_params'
+  require 'shopify_api/api_access'
+  require 'shopify_api/message_enricher'
+  require 'shopify_api/connection'
+  require 'shopify_api/pagination_link_headers'
+  require 'shopify_api/graphql'
+
+  eager_autoload do
+    autoload(:Meta)
+  end
+
   include Limits
 end
 
-require 'shopify_api/events'
-require 'shopify_api/metafields'
-require 'shopify_api/countable'
-require 'shopify_api/resources'
-require 'shopify_api/session'
-require 'shopify_api/hmac_params'
-require 'shopify_api/api_access'
-require 'shopify_api/message_enricher'
-require 'shopify_api/connection'
-require 'shopify_api/pagination_link_headers'
-require 'shopify_api/graphql'
 require 'shopify_api/graphql/railtie' if defined?(Rails)
 
-if ShopifyAPI::Base.respond_to?(:connection_class)
-  ShopifyAPI::Base.connection_class = ShopifyAPI::Connection
-else
-  require 'active_resource/connection_ext'
-end
-
 if ENV["SHOPIFY_LOG_PATH"]
   ActiveResource::Base.logger = Logger.new(ENV["SHOPIFY_LOG_PATH"])
   ActiveResource::DetailedLogSubscriber.attach_to(:active_resource_detailed)

data/shopify_api.gemspec

@@ -32,10 +32,9 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.4"
 
-  s.add_runtime_dependency("activeresource", ">= 4.1.0", "< 6.0.0")
+  s.add_runtime_dependency("activeresource", ">= 4.1.0")
   s.add_runtime_dependency("rack")
   s.add_runtime_dependency("graphql-client")
-  s.add_runtime_dependency("webrick")
 
   s.add_development_dependency("mocha", ">= 1.4.0")
   s.add_development_dependency("webmock")

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: '9.5'
+  version: 9.5.2
 platform: ruby
 authors:
 - Shopify
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -17,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -58,20 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +191,8 @@ files:
 - Gemfile_ar41
 - Gemfile_ar50
 - Gemfile_ar51
-- Gemfile_ar_master
+- Gemfile_ar60
+- Gemfile_ar_main
 - LICENSE
 - README.md
 - RELEASING
@@ -305,7 +285,6 @@ files:
 - lib/shopify_api/resources/page.rb
 - lib/shopify_api/resources/payment.rb
 - lib/shopify_api/resources/payment_details.rb
-- lib/shopify_api/resources/ping.rb
 - lib/shopify_api/resources/policy.rb
 - lib/shopify_api/resources/price_rule.rb
 - lib/shopify_api/resources/product.rb
@@ -548,7 +527,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -564,8 +542,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web
   services

data/lib/shopify_api/resources/ping.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Dir.glob("#{File.dirname(__FILE__)}/ping/*").each { |file| require file }