shopify_api 9.0.0 → 12.4.0

data/README.md

@@ -1,447 +1,138 @@
-Shopify API
-===========
-[![Version][gem]][gem_url] [![Build Status](https://travis-ci.org/Shopify/shopify_api.svg?branch=master)](https://travis-ci.org/Shopify/shopify_api)
+# Shopify API Library for Ruby
 
-[gem]: https://img.shields.io/gem/v/shopify_api.svg
-[gem_url]: https://rubygems.org/gems/shopify_api
+<!-- ![Build Status]() -->
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+![Build Status](https://github.com/Shopify/shopify-api-ruby/workflows/CI/badge.svg?branch=main)
 
+This library provides support for Ruby [Shopify apps](https://apps.shopify.com/) to access the [Shopify Admin API](https://shopify.dev/api/admin), by making it easier to perform the following actions:
 
-The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
+- Creating [online](https://shopify.dev/apps/auth/oauth/access-modes#online-access) or [offline](https://shopify.dev/apps/auth/oauth/access-modes#offline-access) access tokens for the Admin API via OAuth
+- Making requests to the [REST API](https://shopify.dev/api/admin-rest)
+- Making requests to the [GraphQL API](https://shopify.dev/api/admin-graphql)
+- Registering/processing webhooks
 
-The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
+In addition to the Admin API, this library also allows querying the [Storefront API](https://shopify.dev/docs/storefront-api).
 
-### !! Breaking change notice for version 8.0.0 !!
+You can use this library in any application that has a Ruby backend, since it doesn't rely on any specific framework — you can include it alongside your preferred stack and use the features that you need to build your app.
 
-ApiVersion was introduced in Version 7.0.0 and known versions were hard coded into the gem. Manually defining api versions is no longer required for versions not listed in the gem. Version 8.0.0 removes the following:
-* `ShopifyAPI::ApiVersion::Unstable`
-* `ShopifyAPI::ApiVersion::Release`
-* `ShopifyAPI::ApiVersion.define_version`
+**Note**: These instructions apply to v10 or later of this package. If you're running v9 in your app, you can find the documentation [in this branch](https://github.com/Shopify/shopify-api-ruby/tree/v9).
 
-The following methods on `ApiVersion` have been deprecated:
-- `.coerce_to_version` deprecated. use `.find_version`
-- `.define_known_versions` deprecated. Use `.fetch_known_versions`
-- `.clear_defined_versions` deprecated. Use. `.clear_known_versions`
-- `.latest_stable_version` deprecated. Use `ShopifyAPI::Meta.admin_versions.find(&:latest_supported)` (this fetches info from Shopify servers. No authentication required.)
-- `#name` deprecated. Use `#handle`
-- `#stable?` deprecated. Use `#supported?`
+## Requirements
 
-Version 8.0.0 introduces a _version lookup mode_. By default, `ShopifyAPI::ApiVersion.version_lookup_mode` is `:define_on_unknown`. When setting the api_version on `Session` or `Base`, the `api_version` attribute takes a version handle (ie `'2019-07'` or `:unstable`) and sets an instance of `ShopifyAPI::ApiVersion` matching the handle. When the version_lookup_mode is set to `:define_on_unknown`, any handle will naïvely create a new `ApiVersion` if the version is not in the known versions returned by `ShopifyAPI::ApiVersion.versions`.
+To follow these usage guides, you will need to:
 
-To ensure only known and active versions can be set, call
+- have a working knowledge of ruby and a web framework such as Rails or Sinatra
+- have a Shopify Partner account and development store
+- have an app already set up in your test store or partner account
+- add the URL and the appropriate redirect for your OAuth callback route to your app settings
 
-```ruby
-ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
-ShopifyAPI::ApiVersion.fetch_known_versions
-```
-
-Known and active versions are fetched from https://app.shopify.com/services/apis.json and cached. Trying to use a version outside this cached set will raise an error. To switch back to naïve lookup and create a version if its not found, call `ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown`.
-
-
-## !! Breaking change notice for version 7.0.0 !!
-
-### Changes to ShopifyAPI::Session
-Session creation requires `api_version` to be set and now uses keyword arguments
-
-To upgrade your use of ShopifyAPI you will need to make the following changes.
-
-```ruby
-ShopifyAPI::Session.new(domain, token, extras)
-```
-is now
-```ruby
-ShopifyAPI::Session.new(domain: domain, token: token, api_version: api_version, extras: extras)
-```
-Note `extras` is still optional the other arguments are required.
-
-```ruby
-ShopifyAPI::Session.temp(domain, token, extras) do
-  ...
-end
-```
-is now
-```ruby
-ShopifyAPI::Session.temp(domain: domain, token: token, api_version: api_version) do
-  ...
-end
-```
-
-For example if you want to use the `2019-04` version you would create a session like this:
-```ruby
-session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: '2019-04')
-```
-if you want to use the `unstable` version you would create a session like this:
-```ruby
-session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: :unstable)
-```
+## Installation
 
-### Changes to how to define resources
+Add the following to your Gemfile:
 
-If you have defined or customized Resources, classes that extend `ShopifyAPI::Base`:
-The use of `self.prefix =` has been deprecated you should now use `self.resource =` and not include `/admin`.
-For example if you specified a prefix like this before:
-```ruby
-class MyResource < ShopifyAPI::Base
-  self.prefix = '/admin/shop/'
-end
-```
-You will update this to:
-```ruby
-class MyResource < ShopifyAPI::Base
-  self.resource_prefix = 'shop/'
-end
+```sh
+gem "shopify_api"
 ```
 
-### URL construction
-
-If you have specifed any full paths for API calls in find
-```ruby
-def self.current(options={})
-  find(:one, options.merge(from: "/admin/shop.#{format.extension}"))
-end
-```
-would be changed to
+or use [bundler](https://bundler.io):
 
-```ruby
-def self.current(options = {})
-  find(:one, options.merge(
-    from: api_version.construct_api_path("shop.#{format.extension}")
-  ))
-end
+```sh
+bundle add shopify_api
 ```
 
-### URLs that have not changed
-
-- OAuth URLs for `authorize`, getting the `access_token` from a code, `access_scopes`, and using a `refresh_token` have _not_ changed.
-  - get: `/admin/oauth/authorize`
-  - post: `/admin/oauth/access_token`
-  - get: `/admin/oauth/access_scopes`
-- URLs for the merchant’s web admin have _not_ changed. For example: to send the merchant to the product page the url is still `/admin/product/<id>`
-
-## Usage
-
-### Requirements
-
-All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
-
-* Shop owners can create applications for themselves through their own admin: https://docs.shopify.com/api/authentication/creating-a-private-app
-* Shopify Partners create applications through their admin: http://app.shopify.com/services/partners
-
-For more information and detailed documentation about the API visit https://developers.shopify.com/
+## Steps to use the Gem
 
-#### Ruby version
+### Setup Shopify Context
 
-This gem requires Ruby 2.4 as of version 7.0.
-
-### Installation
-
-Add `shopify_api` to your `Gemfile`:
+Start by initializing the `ShopifyAPI::Context` with the parameters of your app by calling `ShopifyAPI::Context.setup` (example below) when your app starts (e.g `application.rb` in a Rails app).
 
 ```ruby
-gem 'shopify_api'
+ShopifyAPI::Context.setup(
+  api_key: "<api-key>",
+  api_secret_key: "<api-secret-key>",
+  host: "<https://application-host-name.com>",
+  scope: "read_orders,read_products,etc",
+  session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below
+  is_embedded: true, # Set to true if you are building an embedded app
+  api_version: "2022-01" # The version of the API you would like to use
+  is_private: false, # Set to true if you have an existing private app
+)
 ```
 
-Or install via [gem](http://rubygems.org/)
-
-```bash
-gem install shopify_api
-```
-
-### Getting Started
-
-ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
-
-1. First create a new application in either the partners admin or your store admin. For a private App you'll need the API_KEY and the PASSWORD otherwise you'll need the API_KEY and SHARED_SECRET.
-
-   If you're not sure how to create a new application in the partner/store admin and/or if you're not sure how to generate the required credentials, you can [read the related shopify docs](https://docs.shopify.com/api/guides/api-credentials) on the same.
-
-2. For a private App you just need to set the base site url as follows:
-
-   ```ruby
-   shop_url = "https://#{API_KEY}:#{PASSWORD}@#{SHOP_NAME}.myshopify.com"
-   ShopifyAPI::Base.site = shop_url
-   ShopifyAPI::Base.api_version = '<version_name>' # find the latest stable api_version [here](https://help.shopify.com/api/versioning)
-   ```
-
-   That's it, you're done, skip to step 6 and start using the API!
-
-   For a partner app you will need to supply two parameters to the Session class before you instantiate it:
-
-   ```ruby
-   ShopifyAPI::Session.setup(api_key: API_KEY, secret: SHARED_SECRET)
-   ```
-
-   Shopify maintains [`omniauth-shopify-oauth2`](https://github.com/Shopify/omniauth-shopify-oauth2) which securely wraps the OAuth flow and interactions with Shopify (steps 3 and 4 above). Using this gem is the recommended way to use OAuth authentication in your application.
-
-3. In order to access a shop's data, apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:
-
-   ```
-   GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize
-   ```
-
-   with the following parameters:
-
-   * ``client_id`` – Required – The API key for your app
-   * ``scope`` – Required – The list of required scopes (explained here: https://help.shopify.com/api/guides/authentication/oauth#scopes)
-   * ``redirect_uri`` – Required – The URL where you want to redirect the users after they authorize the client. The complete URL specified here must be identical to one of the Application Redirect URLs set in the App's section of the Partners dashboard. Note: in older applications, this parameter was optional, and redirected to the Application Callback URL when no other value was specified.
-   * ``state`` – Optional – A randomly selected value provided by your application, which is unique for each authorization request. During the OAuth callback phase, your application must check that this value matches the one you provided during authorization. [This mechanism is important for the security of your application](https://tools.ietf.org/html/rfc6819#section-3.6).
-   * ``grant_options[]`` - Optional - Set this parameter to `per-user` to receive an access token that respects the user's permission level when making API requests (called online access). This is strongly recommended for embedded apps.
-
-   We've added the create_permission_url method to make this easier, first instantiate your session object:
-
-   ```ruby
-   shopify_session = ShopifyAPI::Session.new(domain: "SHOP_NAME.myshopify.com", api_version: api_version, token: nil)
-   ```
+### Setup a Session Store
 
-   Then call `create_permission_url` with the redirect_uri you've registered for your application:
+In order for the Shopify API gem to properly store sessions it needs an implementation of `ShopifyAPI::Auth::SessionStorage`. We provide one implementation in the gem, `ShopifyAPI::Auth::FileSessionStorage`, which is suitable for testing/development, but isn't intended for production apps. See the [Session Storage doc](docs/usage/session_storage.md) for instructions on how to create a custom session store for a production application.
 
-   ```ruby
-   permission_url = shopify_session.create_permission_url(scope, "https://my_redirect_uri.com")
-   ```
+Session information would is typically stored in cookies on the browser. However, due to restrictions with modern browsers we highly discourage using cookies for embedded apps. For this reason, an app needs to define a storage implementation that the library can use to store and retrieve a session given its ID. In a non-embedded app this ID will come from a cookie, whereas in an embedded app this ID will come from [App Bridge](https://shopify.dev/apps/tools/app-bridge).
 
-   You can also pass a state parameter in the options hash as a last argument:
+### Performing OAuth
 
-   ```ruby
-   permission_url = shopify_session.create_permission_url(scope, "https://my_redirect_uri.com", { state: "My Nonce" })
-   ```
+You need to go through OAuth as described [here](https://shopify.dev/apps/auth/oauth) to create sessions for shops using your app.
+The Shopify API gem tries to make this easy by providing functions to begin and complete the OAuth process. See the [Oauth doc](docs/usage/oauth.md) for instructions on how to use these.
 
-4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token.
+### Register Webhooks and a Webhook Handler
 
-   Before you proceed, make sure your application performs the following security checks. If any of the checks fails, your application must reject the request with an error, and must not proceed further.
+If you intend to use webhooks in your application follow the steps in the [Webhooks doc](docs/usage/webhooks.md) for instructions on registering and handling webhooks.
 
-   * Ensure the provided ``state`` is the same one that your application provided to Shopify during Step 3.
-   * Ensure the provided hmac is valid. The hmac is signed by Shopify as explained below, in the Verification section.
-   * Ensure the provided hostname parameter is a valid hostname, ends with myshopify.com, and does not contain characters other than letters (a-z), numbers (0-9), dots, and hyphens.
+### Start Making Authenticated Shopify Requests
 
-   If all security checks pass, the authorization code can be exchanged once for a permanent access token. The exchange is made with a request to the shop.
+Once your app can perform OAuth, it can now make authenticated Shopify API calls using the Admin [REST](docs/usage/rest.md) or [GraphQL](docs/usage/graphql.md) Clients, or the [Storefront API GraphQL Client](docs/usage/graphql_storefront.md).
 
-   ```
-   POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
-   ```
+## Breaking Change Notices
 
-   with the following parameters:
+### Breaking change notice for version 10.0.0
 
-   * ``client_id`` – Required – The API key for your app
-   * ``client_secret`` – Required – The shared secret for your app
-   * ``code`` – Required – The token you received in step 3
+We've rewritten this library for v10, so that it provides all essential features for a Shopify app without depending on the [Active Resource](https://github.com/rails/activeresource) or [graphql-client](https://github.com/github/graphql-client) libraries.
 
-   and you'll get your permanent access token back in the response.
+Here are the main features it provides:
 
-   There is a method to make the request and get the token for you. Pass
-   all the params received from the previous call and the method will verify
-   the params, extract the temp code and then request your token:
+- OAuth support, both with online and offline tokens.
+- Full, transparent support for JWT sessions for embedded apps and cookies for non-embedded ones.
+  - Removal of support for 3rd party cookies which are increasingly more difficult to use with modern browsers.
+- Admin API support
+  - Auto-generated, version-specific REST resources which are similar to `ActiveResource` (though not identical), that provide methods for all endpoints defined in our [REST API reference](https://shopify.dev/api/admin-rest), as well as direct definition of known attributes.
+  - A GraphQL client that doesn't rely on the ActiveResource implementation for REST.
+- Webhook management, with features for adding handlers and registering them with Shopify.
+- Storefront GraphQL API support
 
-   ```ruby
-   token = shopify_session.request_token(params)
-   ```
+Please refer to [the documentation](docs/getting_started.md) in this repository for instructions on how to use each of these components.
 
-   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://help.shopify.com/api/guides/authentication/oauth#confirming-installation). If you requested an access token that is associated with a specific user, you can retreive information about this user from the `extra` hash:
+With this, a lot changed in how apps access the library. Here are the updates you should make when migrating to v10:
 
-   ```ruby
-   # a list of all granted scopes
-   granted_scopes = shopify_session.extra['scope']
-   # a hash containing the user information
-   user = shopify_session.extra['associated_user']
-   # the access scopes available to this user, which may be a subset of the access scopes granted to this app.
-   active_scopes = shopify_session.extra['associated_user_scope']
-   # the time at which this token expires; this is automatically converted from 'expires_in' returned by Shopify
-   expires_at = shopify_session.extra['expires_at']
-   ```
+- Call `ShopifyAPI::Context.setup` when setting up your app. This class holds global configurations for your app and defines how the library behaves.
+- If not using the `shopify_app` gem, your app needs to provide an implementation of `ShopifyAPI::Auth::SessionStorage` for production. Read more about this [in our documentation](docs/usage/session_storage.md).
+- To change the `User-Agent` header, use `user_agent_prefix` in `ShopifyAPI::Context.setup`.
+- Usages of the `ActiveResource` classes for REST API requests need to be refactored into the new format. You can find detailed examples on how each of the endpoints work in our [reference documentation](https://shopify.dev/api/admin-rest).
 
-   For the security of your application, after retrieving an access token you must validate the following:
-   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.
+    Please see below a (non-exhaustive) list of common replacements to guide you in your updates, using the `Order` resource as an example.
 
-   For future sessions simply pass in the `token` and `extra` hash (optional) when creating the session object:
+    | Before                                             | After |
+    | ---                                                | --- |
+    | `Order.find(:all, params: {param1: value1})`       | `Order.all(param1: value1)` |
+    | `Order.find(<id>)`                                 | `Order.find(id: <id>)` |
+    | `order = Order.new(<id>)`<br/>`order.post(:close)` | `order = Order.new`<br/>`order.close` |
+    | `order = Order.new(<id>)`<br/>`order.delete`       | `Order.delete(id: <id>)` |
 
-   ```ruby
-   shopify_session = ShopifyAPI::Session.new(domain: "SHOP_NAME.myshopify.com", token: token, api_version: api_version, extra: extra)
-   ```
+## Breaking changes for older versions
 
-5. The session must be activated before use:
+See [BREAKING_CHANGES_FOR_OLDER_VERSIONS](BREAKING_CHANGES_FOR_OLDER_VERSIONS.md)
 
-   ```ruby
-   ShopifyAPI::Base.activate_session(shopify_session)
-   ```
+## Developing this gem
 
-6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:
-
-   ```ruby
-   shop = ShopifyAPI::Shop.current
-
-   # Get a specific product
-   product = ShopifyAPI::Product.find(179761209)
-
-   # Create a new product
-   new_product = ShopifyAPI::Product.new
-   new_product.title = "Burton Custom Freestlye 151"
-   new_product.product_type = "Snowboard"
-   new_product.vendor = "Burton"
-   new_product.save
-
-   # Update a product
-   product.handle = "burton-snowboard"
-   product.save
-   ```
-
-   Alternatively, you can use #temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:
-
-   ```ruby
-   products = ShopifyAPI::Session.temp(domain: "SHOP_NAME.myshopify.com", token: token, api_version: api_version) do
-     ShopifyAPI::Product.find(:all)
-   end
-   ```
-
-7. If you would like to run a small number of calls against a different API version you can use this block syntax:
-
-   ```ruby
-   ShopifyAPI::Session.temp(domain: "SHOP_NAME.myshopify.com", token: token, api_version: '2019-04') do
-     ShopifyAPI::Product.find(:all)  # find call against version `2019-04`
-
-     ShopifyAPI::Session.with_version(:unstable) do
-       ShopifyAPI::Product.find(:all)  # find call against version `unstable`
-     end
-
-     ShopifyAPI::Product.find(:all)  # find call against version `2019-04`
-   end
-   ```
-
-8. If you want to work with another shop, you'll first need to clear the session:
-
-   ```ruby
-   ShopifyAPI::Base.clear_session
-   ```
-
-### Console
-
-This package also supports the ``shopify-api`` executable to make it easy to open up an interactive console to use the API with a shop.
-
-1. Install the ``shopify_api_console`` gem.
+After cloning the repository, you can install the dependencies with bundler:
 
 ```bash
-gem install shopify_api_console
-```
-
-2. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")
-
-3. Use the ``shopify-api`` script to save the credentials for the shop to quickly log in.
-
-   ```bash
-   shopify-api add yourshopname
-   ```
-
-   Follow the prompts for the shop domain, API key and password.
-
-4. Start the console for the connection.
-
-   ```bash
-   shopify-api console
-   ```
-
-5. To see the full list of commands, type:
-
-   ```bash
-   shopify-api help
-   ```
-
-## GraphQL
-
-Note: the GraphQL client has improved and changed in version 9.0. See the [client documentation](docs/graphql.md)
-for full usage details and a [migration guide](docs/graphql.md#migration-guide).
-
-This library also supports Shopify's [GraphQL Admin API](https://help.shopify.com/api/graphql-admin-api)
-via integration with the [graphql-client](https://github.com/github/graphql-client) gem.
-The authentication process (steps 1-5 under [Getting Started](#getting-started))
-is identical. Once your session is activated, simply access the GraphQL client
-and use `parse` and `query` as defined by
-[graphql-client](https://github.com/github/graphql-client#defining-queries).
-
-```ruby
-client = ShopifyAPI::GraphQL.client
-
-SHOP_NAME_QUERY = client.parse <<-'GRAPHQL'
-  {
-    shop {
-      name
-    }
-  }
-GRAPHQL
-
-result = client.query(SHOP_NAME_QUERY)
-result.data.shop.name
-```
-
-[GraphQL client documentation](docs/graphql.md)
-
-## Threadsafety
-
-ActiveResource is threadsafe as of version 4.1 (which works with Rails 4.x and above).
-
-If you were previously using Shopify's [activeresource fork](https://github.com/shopify/activeresource) then you should remove it and use ActiveResource 4.1.
-
-## Pagination
-
-Pagination can occur in one of two ways.
-
-Page based pagination
-```ruby
-page = 1
-products = ShopifyAPI::Product.find(:all, params: { limit: 50, page: page })
-process_products(products)
-while(products.count == 50)
-  page += 1
-  products = ShopifyAPI::Product.find(:all, params: { limit: 50, page: page })
-  process_products(products)
-end
-```
-
-Page based pagination will be deprecated in the `2019-10` API version, in favor of the second method of pagination:
-
-[Relative cursor based pagination](https://help.shopify.com/en/api/guides/paginated-rest-results)
-```ruby
-products = ShopifyAPI::Product.find(:all, params: { limit: 50 })
-process_products(products)
-while products.next_page?
-  products = products.fetch_next_page
-  process_products(products)
-end
-```
-
-If you want cursor based pagination to work across page loads, or want to distribute workload across multiple background jobs, you can use #next_page_info or #previous_page_info methods that return strings:
-
-```
-  first_batch_products = ShopifyAPI::Product.find(:all, params: { limit: 50 })
-  second_batch_products = ShopifyAPI::Product.find(:all, params: { limit: 50, page_info: first_batch_products.next_page_info })
-  ...
+bundle install
 ```
 
-Relative cursor pagination is currently available for all endpoints using the `2019-10` and later API versions.
-
-## Using Development Version
-
-Download the source code and run:
+To run the automated tests:
 
 ```bash
-bundle install
 bundle exec rake test
 ```
 
-or if you'd rather use docker just run:
-```bash
-docker run -it --name shopify_api -v "$PWD:/shopify_api" -w="/shopify_api" ruby:2.6 bundle install
-docker exec -it shopify_api bash
-```
+We use [rubocop](https://rubocop.org) to lint/format the code. You can run it with the following command:
 
-or you can even use our automated rake task for docker:
 ```bash
-bundle exec rake docker
+bundle exec rubocop
 ```
-
-## Additional Resources
-
-* [API Reference](https://help.shopify.com/api/reference)
-* [Ask questions on the forums](http://ecommerce.shopify.com/c/shopify-apis-and-technology)
-
-## Copyright
-
-Copyright (c) 2014 "Shopify Inc.". See LICENSE for details.

data/RELEASING.md

@@ -0,0 +1,19 @@
+# Releasing ShopifyAPI
+
+1. Before releasing, make sure `sorbet` and related gems are up to date:
+   `bundle update sorbet sorbet-runtime sorbet-static tapioca --conservative`
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+1. Update the version of ShopifyAPI in lib/shopify_api/version.rb
+1. Run `bundle`
+1. Add a CHANGELOG entry for the new release
+1. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+1. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+   $ git tag vX.Y.Z REV
+1. Push out the changes
+   $ git push
+1. Push out the tags
+   $ git push --tags
+1. Publish the gem using Shipit
+1. Consider if the dependency in Shopify/shopify needs updated. It's used only by the tests so is a low risk change.
+   Also consider Shopify/shopify_app whose gemspec depends on this.
+   We don't need to do this for every release, but we should try to keep them relatively up to date.

data/Rakefile

@@ -1,44 +1,23 @@
-require 'rake'
-require "bundler/gem_tasks"
+# typed: false
+# frozen_string_literal: true
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.warning = false
-end
+require "rake/testtask"
+require "bundler/gem_tasks"
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+namespace :test do
+  Rake::TestTask.new(:library) do |t|
+    t.test_files = FileList["test/**/*_test.rb"].exclude("test/rest/**/*.rb")
   end
-end
 
-task :default => :test
+  Rake::TestTask.new(:rest_wrappers) do |t|
+    pattern = if ENV.key?("API_VERSION")
+      "test/rest/**/#{ENV.fetch("API_VERSION")}/*.rb"
+    else
+      "test/rest/**/*.rb"
+    end
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
+    t.pattern = pattern
   end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "shopify_api #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :docker do
-  cmd = "docker-compose up -d && docker exec -i -t shopify_api bash"
-  exec(cmd, err: File::NULL)
-end
+task test: ["test:library"]