shopify_api 9.0.3 → 12.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9f98c9f7ec2a7834c9b4f69c4dfa346e23b220173a03690cabc753e9d0b4318
-  data.tar.gz: 5245b531946faf49fc3213e7faadc5b8372ba71ccfa8e26f14d8b2630bff0d36
+  metadata.gz: 7fee0ac74bfc70897541951eb87b46e750e0ed650c11b77d3a1c582451c3f4c0
+  data.tar.gz: 2e935108619f59022b9101a838582311bb5824a268fe2c1034b629339613dce3
 SHA512:
-  metadata.gz: a8b09cb70ebd5ff98dfe08bb4adfb6f25cfa2a2f5023b7e9d703a6e97d33dd6beaac6dfbae29780cf6cab8f9de87718c1e3c5e6cdc8fe2b85b1258a9315c1fa9
-  data.tar.gz: f17ae5b2022d64fe91391dda645e9684b57449dd274f3de0ebbf8c8117072c67d78849646ba914c1432f60b4cfce46ed4b62432e7ecdb00651e1f59210d26c2a
+  metadata.gz: f5830157e403f197fedd154dbd5b69653026fc8ec9cce3d4427764b8e1e189ff303e1104b82faf124e7093f92979003b33be5061db81d825e2219fd7a70e8bef
+  data.tar.gz: e8fac7416a292ade97b591fa86e91034ae04a50e1d0f870b1f5289dcf40df0b1ccada6210b4255aae8c4e1d57e263bd38a8d0b990da0fa3e3383ef83a1333c60

data/.github/CODEOWNERS

@@ -1 +1 @@
-*       @shopify/platform-dev-tools-education
+*       @shopify/learn-libs-superteam

data/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,40 @@
+---
+name: "🐛 Bug Report"
+about: Something isn't working
+labels: "Type: Bug 🐛"
+---
+
+# Issue summary
+
+<!--
+
+Write a short description of the issue here. Please provide any details or logs that
+can help us debug it.
+
+Increase the logs as described in the README by setting log_level to :debug, and paste the relevant portion here.
+
+Learn more: https://github.com/Shopify/shopify-api-ruby#setup-shopify-context
+
+-->
+
+- `shopify_api` version:
+- Ruby version:
+- Operating system:
+
+```
+// Paste any relevant logs here
+```
+
+## Expected behavior
+
+<!-- What do you think should happen? -->
+
+## Actual behavior
+
+<!-- What actually happens? -->
+
+## Steps to reproduce the problem
+
+1.
+1.
+1.

data/.github/ISSUE_TEMPLATE/ENHANCEMENT.md

@@ -0,0 +1,9 @@
+---
+name: '📈 Enhancement'
+about: Enhancement to our codebase that isn't a adding or changing a feature
+labels: 'Type: Enhancement 📈'
+---
+
+## Overview/summary
+
+<!-- Write a short description of the enhancement here ↓ -->

data/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,9 @@
+---
+name: "🙌 Feature Request"
+about: Suggest a new feature, or changes to an existing one
+labels: "Type: Feature Request :raised_hands:"
+---
+
+## Overview
+
+<!-- Write a short description of the request here ↓ -->

data/.github/api_update_reminder.md

@@ -0,0 +1,25 @@
+---
+title: A new release of the Shopify API is due soon
+labels: automated
+---
+
+This is an automated reminder for the maintainers that a new Stable release of the Shopify API is due soon, so the library needs to be updated.
+
+A new library release should be prepared to:
+* add the upcoming Stable release
+* remove the oldest Stable release which will no longer be supported.
+
+The PR should be created as a **draft** but not yet be merged.
+
+The release schedule can be found at https://shopify.dev/concepts/about-apis/versioning
+
+Review the changelog and consider if anything in the library needs to change:
+
+https://shopify.dev/changelog
+
+Test against the upcoming release by using the Release Candidate.
+
+Another reminder issue will be created on the date of the next release.
+When that happens, test again using the now Stable API version, and aim to release an update of the library within one week.
+
+Thank you!

data/.github/api_update_reminder_on_release.md

@@ -0,0 +1,19 @@
+---
+title: A new release of the Shopify API occurred
+labels: automated
+---
+
+This is an automated reminder for the maintainers that a new Stable release of the Shopify API is scheduled for today
+at 12pm Eastern Time, so a new release of the library is now due.
+
+A draft PR should already exist for this.
+
+Review the changelog again and consider if anything in the library needs to change:
+
+https://shopify.dev/changelog
+
+Test against the new release by using the Stable version just released.
+
+Aim to release an update of the library within one week.
+
+Thank you!

data/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+registries:
+  rubygems-server-pkgs-shopify-io:
+    type: rubygems-server
+    url: https://pkgs.shopify.io
+    username: ${{secrets.RUBYGEMS_SERVER_PKGS_SHOPIFY_IO_USERNAME}}
+    password: ${{secrets.RUBYGEMS_SERVER_PKGS_SHOPIFY_IO_PASSWORD}}
+  github-com:
+    type: git
+    url: https://github.com
+    username: ${{secrets.DEPENDENCIES_GITHUB_USER}}
+    password: ${{secrets.DEPENDENCIES_GITHUB_TOKEN}}
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 100
+    insecure-external-code-execution: allow
+    registries: '*'

data/.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+
+Fixes #<issue-number>
+
+Please, include a summary of what the PR is for:
+- What is the problem it is solving?
+- What is the context of these changes?
+- What is the impact of this PR?
+
+## How has this been tested?
+
+Please, describe the tests that you ran to verify your changes.
+
+## Checklist:
+
+- [ ] My commit message follow the pattern described in [here](https://chris.beams.io/posts/git-commit/)
+- [ ] I have performed a self-review of my own code.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have updated the project documentation.
+- [ ] I have added a changelog line.

data/.github/workflows/api_update_reminder.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: "0 0 1 3,6,9,12 *" # At 00:00 on 1st of March, June, September, and December
+
+name: API update reminder
+jobs:
+  reminder:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JasonEtco/create-an-issue@v2.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/api_update_reminder.md

data/.github/workflows/api_update_reminder_on_release.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_dispatch: ~
+  schedule:
+    - cron: "0 0 1 1,4,7,10 *" # At 00:00 on 1st of January, April, July, and October
+
+name: API update reminder on release
+jobs:
+  reminder:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: JasonEtco/create-an-issue@v2.4.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/api_update_reminder_on_release.md

data/.github/workflows/build.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version:
+          - 2.7
+          - 3.0
+          - 3.1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.version }}
+      - name: Run Bundle Commands
+        run: |
+          bundle config set --with docs
+          bundle config set ignore_messages true
+          bundle
+      - name: Run RuboCop
+        run: |
+          bundle exec rubocop
+      - name: Run Typecheck
+        run: |
+          bundle exec srb tc
+      - name: Run tests
+        run: |
+          bundle exec rake test:library
+      - name: Run REST wrapper tests
+        run: |
+          bundle exec rake test:rest_wrappers

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.github/workflows/close-waiting-for-response-issues.yml

@@ -0,0 +1,20 @@
+name: Close Waiting for Response Issues
+on:
+  schedule:
+    - cron: "30 1 * * *"
+  workflow_dispatch:
+jobs:
+  check-need-info:
+    runs-on: ubuntu-latest
+    steps:
+      - name: close-issues
+        uses: actions-cool/issues-helper@v3
+        with:
+          actions: 'close-issues'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          labels: 'Waiting for Response'
+          inactive-day: 7
+          body: |
+            We are closing this issue because we did not hear back regarding additional details we needed to resolve this issue. If the issue persists and you are able to provide the missing clarification we need, feel free to respond and reopen this issue.
+
+            We appreciate your understanding as we try to manage our number of open issues.

data/.github/workflows/remove-labels-on-activity.yml

@@ -0,0 +1,16 @@
+name: Remove Stale or Waiting Labels
+on:
+  issue_comment:
+    types: [created]
+  workflow_dispatch:
+jobs:
+  remove-labels-on-activity:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-ecosystem/action-remove-labels@v1
+        if: contains(github.event.issue.labels.*.name, 'Waiting for Response')
+        with:
+          labels: |
+            Waiting for Response
+

data/.github/workflows/stale.yml

@@ -0,0 +1,43 @@
+name: Close inactive issues / prs
+on:
+  schedule:
+    - cron: "30 1 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/stale@v7
+        with:
+          days-before-issue-stale: 60
+          days-before-issue-close: 14
+          days-before-pr-stale: 60
+          days-before-pr-close: 14
+          operations-per-run: 1000
+          stale-issue-label: "Stale"
+          stale-pr-label: "Stale"
+          stale-issue-message: >
+            This issue is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days.
+          close-issue-message: |
+            We are closing this issue because it has been inactive for a few months.
+            This probably means that it is not reproducible or it has been fixed in a newer version.
+            If it’s an enhancement and hasn’t been taken on since it was submitted, then it seems other issues have taken priority.
+
+            If you still encounter this issue with the latest stable version, please reopen using the issue template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify-api-ruby/blob/main/CONTRIBUTING.md) file for guidelines
+
+            Thank you!
+          stale-pr-message: >
+            This pull request is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days.
+          close-pr-message: |
+            We are closing this pull request because it has been inactive for a few months.
+            This probably means that it is not reproducible or it has been fixed in a newer version.
+            If it’s an enhancement and hasn’t been taken on since it was submitted, then it seems other issues have taken priority.
+
+            If you still encounter this pull request with the latest stable version, please reopen using the pull request template. You can also contribute directly by submitting a pull request– see the [CONTRIBUTING.md](https://github.com/Shopify/shopify-api-ruby/blob/main/CONTRIBUTING.md) file for guidelines
+
+            Thank you!
+          repo-token: ${{ github.token }}
+          close-issue-reason: "not_planned"

data/.rubocop.yml

@@ -1,8 +1,59 @@
-inherit_from:
-  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - "sorbet/**/*"
+    - "bin/**/*"
+    - "lib/shopify_api/rest/resources/**/*"
+    - "test/rest/**/*"
+
+Sorbet:
+  Enabled: true
+Sorbet/HasSigil:
+  Enabled: true
+  Exclude:
+    - Gemfile*
+Sorbet/StrictSigil:
+  Enabled: true
+  Exclude:
+    - Gemfile*
+    - "lib/shopify_api/auth/session.rb"
+    - Rakefile
+    - "test/**/*"
+Sorbet/TrueSigil:
+  Enabled: true
+  Exclude:
+    - Gemfile*
+    - Rakefile
+    - "test/**/*"
+Sorbet/ValidSigil:
+  Enabled: true
+Sorbet/EnforceSigilOrder:
+  Enabled: true
+Sorbet/AllowIncompatibleOverride:
+  Enabled: true
+Sorbet/CheckedTrueInSignature:
+  Enabled: true
+Sorbet/KeywordArgumentOrdering:
+  Enabled: true
+Sorbet/SignatureBuildOrder:
+  Enabled: true
+Sorbet/BindingConstantWithoutTypeAlias:
+  Enabled: true
+Sorbet/ConstantsFromStrings:
+  Enabled: true
+Sorbet/ForbidIncludeConstLiteral:
+  Enabled: true
+Sorbet/ForbidSuperclassConstLiteral:
+  Enabled: true
 
-Rails:
-  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: true

data/BREAKING_CHANGES_FOR_OLDER_VERSIONS.md

@@ -0,0 +1,110 @@
+# Breaking changes for older versions
+
+The breaking changes for the previous major release are listed in the main [README](README.md).
+The breaking changes for older major releases are listed below.
+
+### Breaking change notice for version 8.0.0
+
+Version 7.0.0 introduced ApiVersion, and known versions were hardcoded 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`
+
+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?`
+
+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 (i.e. `'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 ensure you're setting only known and active versions, call :
+
+```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 one is not found, call `ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown`.
+
+### Breaking change notice for version 7.0.0
+
+#### Changes to ShopifyAPI::Session
+When creating sessions, `api_version`is now required and 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 will 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 will create a session like this:
+```ruby
+session = ShopifyAPI::Session.new(domain: domain, token: token, api_version: :unstable)
+```
+
+#### Changes to how to define resources
+
+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
+```
+
+#### URL construction
+
+If you have specified 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
+
+```ruby
+def self.current(options = {})
+  find(:one, options.merge(
+    from: api_version.construct_api_path("shop.#{format.extension}")
+  ))
+end
+```
+
+#### 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>`