shopify has slowly been deprecating the rest api, lets move it to its own repo

Author: hez

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+- BREAKING: Moving REST client to its own repo. Check the new REST entry in the [README](./#REST)
+  If the REST client is used you must include the new REST client repo:
+  `{:shopify_api_rest, github: "orbit-apps/elixir-shopifyapi-rest", tag: "v0.1.0"}`
 - BREAKING: AppServer now defaults to a single app instance, this is a compile env if you want to use the old multi app config add `config :shopify_api, :app_server, :multi_app` to your `config/config.exs`
 - New: Single app mode for AppServer, is API compatible with the multi app setup. This greatly simplifies the most common setup, one app <> one phoenix setup.
 - New: Add handle and raw app config to the App struct

README.md

@@ -13,6 +13,7 @@
     - [AuthTokens](#AuthTokens)
   - [Webhooks](#Webhooks)
   - [GraphQL](#GraphQL)
+  - [REST](#REST)
   - [Telemetry](#Telemetry)
 
 ## Installation
@@ -223,6 +224,17 @@ config :shopify_api, ShopifyAPI.GraphQL, graphql_version: "2024-10"
 
 We are soft deprecating the old `ShopifyAPI.graphql_request/4`. It will not be marked as deprecated until people have had a chance to move over to the new method. The reasons for the move include 1) moving away from HTTPoison and towards Req. 2) Better handling of partial failures. 3) Overall cleaner implementations and more access to proper errors.
 
+## REST
+
+The REST client has been moved to its [own repo](https://github.com/orbit-apps/elixir-shopifyapi-rest)
+
+Using:
+
+- include the new dependency `{:shopify_api, github: "pixelunion/elixir-shopifyapi-rest", tag: "v0.1.0"}`
+- make clean and compile `mix clean && mix compile`, as there is an optional endpoint `ShopifyAPI.request/2`
+  that is not compiled in unless the REST client is included.
+- make a REST call `iex> ShopifyAPI.REST.Product.all(token)`
+
 ## Telemetry
 
 The `shopify_api` library will emit events using the [`:telemetry`](https://github.com/beam-telemetry/telemetry) library. Consumers of `shopify_api` can then use these events for customized metrics aggregation and more.

lib/shopify_api.ex

@@ -1,7 +1,6 @@
 defmodule ShopifyAPI do
   alias ShopifyAPI.GraphQL.GraphQLQuery
   alias ShopifyAPI.GraphQL.GraphQLResponse
-  alias ShopifyAPI.RateLimiting
   alias ShopifyAPI.Throttled
 
   @shopify_admin_uri URI.new!("https://admin.shopify.com")
@@ -40,7 +39,11 @@ defmodule ShopifyAPI do
   def execute_graphql(%GraphQLQuery{} = query, scope, opts \\ []),
     do: ShopifyAPI.GraphQL.execute(query, scope, opts)
 
-  def request(token, func), do: Throttled.request(func, token, RateLimiting.RESTTracker)
+
+  if function_exported?(ShopifyAPI.RateLiting.RESTTracker, :init, 0) do
+    def request(token, func),
+      do: ShopifyAPIThrottled.request(func, token, ShopifyAPI.RateLimiting.RESTTracker)
+  end
 
   @doc false
   # Accessor for API transport layer, defaults to `https://`.

lib/shopify_api/application.ex

@@ -6,7 +6,6 @@ defmodule ShopifyAPI.Application do
   # See https://hexdocs.pm/elixir/Application.html
   # for more information on OTP Applications
   def start(_type, _args) do
-    RateLimiting.RESTTracker.init()
     RateLimiting.GraphQLTracker.init()
 
     # Define workers and child supervisors to be supervised