shopify_api 9.5 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c73a80fab5607e57486b42ce37c750797bfc5ac391012b0ca4b8ad2e8dee7e
-  data.tar.gz: 7b4df963e1f9163d23a51623aa845f32a0bf996abf5f447f22a7226f0b6f0b5d
+  metadata.gz: c176457d998b9931226f755fdc278d952efab223a7575bdd56e940b7e581ead8
+  data.tar.gz: ec0fafe2ca693fd8e2797a8af64c0c7ec18c7b807d5744b3975588442e2dc338
 SHA512:
-  metadata.gz: 87c1fdb069d8f3946eb2136c99eede3f03eb86373ccd60a1e7e46188b7fd141fd418e92a665802949b6b196625aafd6e4065af815cc52f5ff5d437e25517b7d1
-  data.tar.gz: ca85757c71561e6956f1e7499142a45f44d511e9256fb112fc594302d12bdca3d0071d68534a2e8061e0949251aec1c00cd8c5c977a7cfc040f3419ab7a9a1bb
+  metadata.gz: dfc2828ff4b3c1c43ef5bacd2616425294089060031f87f455f1245130da17549f1167579744ae0a91c2ca1db7e88318a95f696f48e985aea193d09d417aa116
+  data.tar.gz: f1a072eb58fd2b718e58f76d6ec2f2f8a0f769290aaa56cfab4ce61d67f2225ef90bfc957cbadd5b9bc08113ecf9172342f7fc8a7bc6ed888f01b50b28f06dde

data/.github/CODEOWNERS

@@ -1 +1 @@
-*       @shopify/core-build-learn
+*       @shopify/learn-libs-superteam

data/.github/ISSUE_TEMPLATE.md

@@ -32,5 +32,4 @@ If applicable, enable the logs as described in the README, and paste the relevan
 ## Specifications
 
 - `shopify_api` version:
-- `activeresource` version:
-- Shopify API version used (example: `2020-07`):
+- Shopify API version used (example: `2020-07`):

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/probots.yml

@@ -1,2 +1,2 @@
 enabled:
-  - cla
+  - cla

data/.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+
+Fixes https://github.com/Shopify/first-party-library-planning/issues/<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/build.yml

@@ -5,28 +5,15 @@ on:
 
 jobs:
   build:
-    name: Ruby ${{ matrix.version }} ${{ matrix.gemfile }}
+    name: Ruby ${{ matrix.version }}
     runs-on: ubuntu-latest
-    env:
-      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     strategy:
       matrix:
         version:
-          - "2.4"
-          - "2.5"
-          - "2.6"
-          - "2.7"
-          - "3.0"
-        gemfile:
-          - Gemfile_ar41
-          - Gemfile_ar50
-          - Gemfile_ar51
-          - Gemfile_ar_master
-        exclude:
-          - version: "2.7"
-            gemfile: Gemfile_ar41
-          - version: "3.0"
-            gemfile: Gemfile_ar41
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
     steps:
       - uses: actions/checkout@v2
       - name: Remove Gemfile.lock
@@ -36,9 +23,20 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.version }}
-      - name: Run Tests
+      - name: Run Bundle Commands
         run: |
           bundle config set --with docs
           bundle config set ignore_messages true
           bundle
-          bundle exec rake test
+      - 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/.rubocop.yml

@@ -1,28 +1,59 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
-inherit_from:
-  - .rubocop_todo.yml
+require:
+  - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 2.4
-
-Lint/SuppressedException:
+  TargetRubyVersion: 2.6
+  NewCops: enable
   Exclude:
-    # Warning on test setup, the exception is expected
-    - 'test/test_helper.rb'
+    - "sorbet/**/*"
+    - "bin/**/*"
+    - "lib/shopify_api/rest/resources/**/*"
+    - "test/rest/**/*"
 
-Lint/MissingSuper:
+Sorbet:
+  Enabled: true
+Sorbet/HasSigil:
+  Enabled: true
   Exclude:
-    # We explicitly do not want to call super here
-    - 'lib/shopify_api/graphql/http_client.rb'
-
-Lint/UnderscorePrefixedVariableName:
+    - Gemfile*
+Sorbet/StrictSigil:
+  Enabled: true
   Exclude:
-    # This is an internal attribute and we want to make sure it's called _headers
-    - 'lib/shopify_api/resources/base.rb'
-
-Naming/AccessorMethodName:
+    - Gemfile*
+    - "lib/shopify_api/auth/session.rb"
+    - Rakefile
+    - "test/**/*"
+Sorbet/TrueSigil:
+  Enabled: true
   Exclude:
-    # This comes from activesupport, so we can't rename it
-    - 'test/detailed_log_subscriber_test.rb'
+    - 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
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Version 10.0.0
+
+- Major update to the library to provide _all_ essential functions needed for a Shopify app, supporting embedded apps with session tokens. See the [full list of changes](https://github.com/Shopify/shopify_api#breaking-change-notice-for-version-1000) here
+
+## 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/CONTRIBUTING.md

@@ -1,8 +1,9 @@
+
 Submitting Issues
 -----------------
 
-Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://docs.shopify.com/api but is missing from this package.
+Please open an issue here if you encounter a specific bug with this API client library or if something is documented here https://shopify.dev/apps but is missing from this package.
 
-General questions about the Shopify API and usage of this package (not necessarily a bug) should be posted on the [Shopify forums](https://ecommerce.shopify.com/c/shopify-apis-and-technology).
+General questions about the Shopify API and usage of this package (not necessarily a bug) should be posted on the [Shopify forums](https://community.shopify.com/c/partners-and-developers/ct-p/appdev).
 
-When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.
+When in doubt, post on the forum first. You'll likely have your questions answered more quickly if you post there; more people monitor the forum than Github.

data/Gemfile

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec
 
-gem "activeresource", "~> 5.1"
-
-group :docs, optional: true do
-  gem "jekyll"
+group :test do
+  gem "minitest"
+  gem "fakefs", require: false
+  gem "webmock"
+  gem "mocha"
 end

data/Gemfile.lock

@@ -1,153 +1,138 @@
 PATH
   remote: .
   specs:
-    shopify_api (9.5)
-      activeresource (>= 4.1.0, < 6.0.0)
-      graphql-client
-      rack
-      webrick
+    shopify_api (10.0.0)
+      concurrent-ruby
+      hash_diff
+      httparty
+      jwt
+      oj
+      openssl
+      securerandom
+      sorbet-runtime
+      zeitwerk (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activemodel-serializers-xml (1.0.2)
-      activemodel (> 5.x)
-      activesupport (> 5.x)
-      builder (~> 3.1)
-    activeresource (5.1.1)
-      activemodel (>= 5.0, < 7)
-      activemodel-serializers-xml (~> 1.0)
-      activesupport (>= 5.0, < 7)
-    activesupport (6.0.3.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    builder (3.2.4)
-    byebug (11.1.3)
-    coderay (1.1.2)
-    colorator (1.1.0)
-    concurrent-ruby (1.1.6)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    em-websocket (0.5.1)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.7)
-    ffi (1.12.2)
-    forwardable-extended (2.6.0)
-    graphql (1.12.16)
-    graphql-client (0.17.0)
-      activesupport (>= 3.0)
-      graphql (~> 1.10)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    fakefs (1.4.1)
+    hash_diff (1.0.0)
     hashdiff (1.0.1)
-    http_parser.rb (0.6.0)
-    i18n (1.8.2)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    jekyll (4.1.0)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 1.0)
-      jekyll-sass-converter (~> 2.0)
-      jekyll-watch (~> 2.0)
-      kramdown (~> 2.1)
-      kramdown-parser-gfm (~> 1.0)
-      liquid (~> 4.0)
-      mercenary (~> 0.4.0)
-      pathutil (~> 0.9)
-      rouge (~> 3.0)
-      safe_yaml (~> 1.0)
-      terminal-table (~> 1.8)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
-    jekyll-watch (2.2.1)
-      listen (~> 3.0)
-    kramdown (2.3.1)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.2.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.4.0)
+    jwt (2.3.0)
     method_source (1.0.0)
-    minitest (5.14.4)
-    mocha (1.11.2)
-    parallel (1.19.2)
-    parser (2.7.2.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
+    mocha (1.13.0)
+    multi_xml (0.6.0)
+    oj (3.13.11)
+    openssl (3.0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
-    pathutil (0.16.2)
-      forwardable-extended (~> 2.6)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
     public_suffix (4.0.6)
-    rack (2.2.3)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rb-fsevent (0.10.4)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (1.8.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbi (0.0.11)
+      ast
+      parser
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.2.0)
     rexml (3.2.5)
-    rouge (3.19.0)
-    rubocop (0.93.1)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.8.0)
-      parser (>= 2.7.1.5)
-    rubocop-shopify (1.0.6)
-      rubocop (>= 0.92, < 0.94)
-    ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
-    sassc (2.3.0)
-      ffi (~> 1.9)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thread_safe (0.3.6)
-    timecop (0.9.1)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-shopify (2.4.0)
+      rubocop (~> 1.24)
+    rubocop-sorbet (0.6.5)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.11.0)
+    securerandom (0.2.0)
+    sorbet (0.5.9623)
+      sorbet-static (= 0.5.9623)
+    sorbet-runtime (0.5.9619)
+    sorbet-static (0.5.9623-universal-darwin-21)
+    sorbet-static (0.5.9623-x86_64-linux)
+    spoom (1.1.8)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    tapioca (0.6.3)
+      bundler (>= 1.17.3)
+      pry (>= 0.12.2)
+      rbi (~> 0.0.0, >= 0.0.9)
+      sorbet-runtime (>= 0.5.9204)
+      sorbet-static (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.4)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    unparser (0.6.3)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
-    zeitwerk (2.3.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.5.4)
 
 PLATFORMS
-  ruby
+  arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
-  activeresource (~> 5.1)
-  jekyll
-  minitest (>= 5.14)
-  mocha (>= 1.4.0)
-  pry
-  pry-byebug
+  activesupport
+  fakefs
+  minitest
+  mocha
   rake
+  rubocop
   rubocop-shopify
+  rubocop-sorbet
   shopify_api!
-  timecop
+  sorbet
+  tapioca
   webmock
 
 BUNDLED WITH
-   2.2.22
+   2.3.4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 "JadedPixel inc."
+Copyright (c) 2022 Shopify Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.