shopify_api 12.0.0 → 12.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6e4e09aa88812707194b0ec0726f1e61f448647a01a9d0709201808c05ad99c
-  data.tar.gz: ac3fcdb640bb6d1c1614e82d5faf9cd2fce496117187d2daca803a5d96ef8036
+  metadata.gz: 2112fae23baafc5b3615a58d54d1c8a2b0a1bfcc4c9a9235b6d76bf80bcdff0e
+  data.tar.gz: 438373f5072f981e9449daac622b55101002df6139cd24e6bff0cfa5601275ce
 SHA512:
-  metadata.gz: c05d906a83000f3a2134875532798224afac9cf270787fadd493b2cc3d820771eac5e3b609766ff9c3d08138a774d8e681d3d93d3c13079d4b655d7a857dddf3
-  data.tar.gz: 1b4088cd2457c8d39ec04b466a5dcf492ac62df751c44f359a12a1176ed4b30f4289ae2d8dc0a400c491b377ffc522d71e86b33f898b8ce086b39cec0729495e
+  metadata.gz: 700912ad225f507b09b1aef17c8df1f139eb9b951cc7c42115c0db95dd77b3dd4698fdd164744c5312730de7ecaae70b770b4f5b3370d7913150afcab44dfb28
+  data.tar.gz: bfd499fc0c32a7e8fc6f523b74b77452ee7edb3581cf045982088d792cb45073846c7138b1c0035b61d1c9420b77500e1be8d2e0cbf89d1e2ff0f2d4f0ba8d90

data/.github/workflows/stale.yml

@@ -12,11 +12,12 @@ jobs:
     steps:
       - uses: actions/stale@v5
         with:
-          days-before-issue-stale: 90
+          days-before-issue-stale: 60
           days-before-issue-close: 14
+          operations-per-run: 1000
           stale-issue-label: "Stale"
           stale-issue-message: >
-            This issue is stale because it has been open for 90 days with no activity. It will be closed if no further action occurs in 14 days. 
+            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. 

data/CHANGELOG.md

@@ -4,10 +4,17 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 
 ## Unreleased
 
+## Version 12.2.0
+
+- [#1023](https://github.com/Shopify/shopify-api-ruby/pull/1023) Allow custom scopes during the OAuth process
+
+## Version 12.1.0
+
+- [#1017](https://github.com/Shopify/shopify-api-ruby/pull/1017) Add support for `http` with localhost development without using a TLS tunnel
+
 ## Version 12.0.0
 
 - [#1027](https://github.com/Shopify/shopify-api-ruby/pull/1027) ⚠️ [Breaking] Remove support for deprecated API version `2021-10` and added support for version `2022-10`
-
 - [#1008](https://github.com/Shopify/shopify-api-ruby/pull/1008) Increase session token JWT validation leeway from 5s to 10s
 
 ## Version 11.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shopify_api (12.0.0)
+    shopify_api (12.2.0)
       concurrent-ruby
       hash_diff
       httparty
@@ -38,6 +38,7 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.2)
     jwt (2.5.0)
+    language_server-protocol (3.17.0.1)
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
@@ -51,6 +52,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    prettier_print (0.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -80,6 +82,10 @@ GEM
       rubocop (~> 1.35)
     rubocop-sorbet (0.6.11)
       rubocop (>= 0.90.0)
+    ruby-lsp (0.3.2)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 3.4)
     ruby-progressbar (1.11.0)
     securerandom (0.2.0)
     sorbet (0.5.10438)
@@ -94,6 +100,8 @@ GEM
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
+    syntax_tree (3.6.1)
+      prettier_print
     tapioca (0.10.2)
       bundler (>= 1.17.3)
       netrc (>= 0.11.0)
@@ -136,6 +144,7 @@ DEPENDENCIES
   rubocop
   rubocop-shopify
   rubocop-sorbet
+  ruby-lsp
   shopify_api!
   sorbet
   tapioca

data/README.md

@@ -6,7 +6,7 @@
 
 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:
 
-- Creating [online](https://shopify.dev/concepts/about-apis/authentication#online-access) or [offline](https://shopify.dev/concepts/about-apis/authentication#offline-access) access tokens for the Admin API via OAuth
+- 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
@@ -25,8 +25,7 @@ To follow these usage guides, you will need to:
 - have a Shopify Partner account and development store
 - _OR_ have a test store where you can create a private app
 - have an app already set up in your test store or partner account
-- use [ngrok](https://ngrok.com/download) to create a secure tunnel to your app running on your localhost
-- add the `ngrok` URL and the appropriate redirect for your OAuth callback route to your app settings
+- add the URL and the appropriate redirect for your OAuth callback route to your app settings
 
 ## Installation
 

data/docs/usage/session_storage.md

@@ -5,7 +5,7 @@ The implementation of session storage that you pass in `ShopifyAPI::Context.setu
 
 ## Create a New Session Storage Class
 
-You can create a session storage class that includes `ShopifyAPI::Auth::SessionStore` and override the methods as shown in the table and example below:
+You can create a session storage class that includes `ShopifyAPI::Auth::SessionStorage` and override the methods as shown in the table and example below:
 
 |       Method Name      |             Input Type            |           Return Type          |
 | ---------------------- | --------------------------------- | ------------------------------ |

data/lib/shopify_api/auth/oauth.rb

@@ -16,9 +16,18 @@ module ShopifyAPI
             shop: String,
             redirect_path: String,
             is_online: T.nilable(T::Boolean),
+            scope_override: T.nilable(T.any(ShopifyAPI::Auth::AuthScopes, T::Array[String], String)),
           ).returns(T::Hash[Symbol, T.any(String, SessionCookie)])
         end
-        def begin_auth(shop:, redirect_path:, is_online: true)
+        def begin_auth(shop:, redirect_path:, is_online: true, scope_override: nil)
+          scope = if scope_override.nil?
+            ShopifyAPI::Context.scope
+          elsif scope_override.is_a?(ShopifyAPI::Auth::AuthScopes)
+            scope_override
+          else
+            ShopifyAPI::Auth::AuthScopes.new(scope_override)
+          end
+
           unless Context.setup?
             raise Errors::ContextNotSetupError, "ShopifyAPI::Context not setup, please call ShopifyAPI::Context.setup"
           end
@@ -30,8 +39,8 @@ module ShopifyAPI
 
           query = {
             client_id: ShopifyAPI::Context.api_key,
-            scope: ShopifyAPI::Context.scope.to_s,
-            redirect_uri: "https://#{ShopifyAPI::Context.host_name}#{redirect_path}",
+            scope: scope.to_s,
+            redirect_uri: "#{ShopifyAPI::Context.host}#{redirect_path}",
             state: state,
             "grant_options[]": is_online ? "per-user" : "",
           }

data/lib/shopify_api/context.rb

@@ -36,6 +36,7 @@ module ShopifyAPI
           is_embedded: T::Boolean,
           session_storage: ShopifyAPI::Auth::SessionStorage,
           logger: Logger,
+          host: T.nilable(String),
           private_shop: T.nilable(String),
           user_agent_prefix: T.nilable(String),
           old_api_secret_key: T.nilable(String),
@@ -51,19 +52,21 @@ module ShopifyAPI
         is_embedded:,
         session_storage:,
         logger: Logger.new($stdout),
+        host: ENV["HOST"] || "https://#{host_name}",
         private_shop: nil,
         user_agent_prefix: nil,
         old_api_secret_key: nil
       )
         unless ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS.include?(api_version)
           raise Errors::UnsupportedVersionError,
-            "Invalid vession #{api_version}, supported versions: #{ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS}"
+            "Invalid version #{api_version}, supported versions: #{ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS}"
         end
 
         @api_key = api_key
         @api_secret_key = api_secret_key
         @api_version = api_version
         @host_name = host_name
+        @host = T.let(host, T.nilable(String))
         @is_private = is_private
         @scope = Auth::AuthScopes.new(scope)
         @is_embedded = is_embedded
@@ -122,7 +125,7 @@ module ShopifyAPI
       end
 
       sig { returns(T.nilable(String)) }
-      attr_reader :private_shop, :user_agent_prefix, :old_api_secret_key
+      attr_reader :private_shop, :user_agent_prefix, :old_api_secret_key, :host
 
       sig { returns(T::Boolean) }
       def embedded?
@@ -131,7 +134,7 @@ module ShopifyAPI
 
       sig { returns(T::Boolean) }
       def setup?
-        !(api_key.empty? || api_secret_key.empty? || host_name.empty?)
+        [api_key, api_secret_key, host_name, T.must(host)].none?(&:empty?)
       end
 
       sig { returns(T.nilable(Auth::Session)) }
@@ -150,6 +153,11 @@ module ShopifyAPI
       def deactivate_session
         @active_session.value = nil
       end
+
+      sig { returns(String) }
+      def host_scheme
+        T.must(URI.parse(T.must(host)).scheme)
+      end
     end
   end
 end

data/lib/shopify_api/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module ShopifyAPI
-  VERSION = "12.0.0"
+  VERSION = "12.2.0"
 end

data/lib/shopify_api/webhooks/registrations/http.rb

@@ -9,12 +9,12 @@ module ShopifyAPI
 
         sig { override.returns(String) }
         def callback_address
-          if @path.match?(%r{^https://})
+          if @path.match?(%r{^https?://})
             @path
           elsif @path.match?(/^#{Context.host_name}/)
-            "https://#{@path}"
+            "#{Context.host_scheme}://#{@path}"
           else
-            "https://#{Context.host_name}/#{@path}"
+            "#{Context.host}/#{@path}"
           end
         end
 

data/shopify_api.gemspec

@@ -47,6 +47,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rubocop")
   s.add_development_dependency("rubocop-shopify")
   s.add_development_dependency("rubocop-sorbet")
+  s.add_development_dependency("ruby-lsp")
   s.add_development_dependency("sorbet")
   s.add_development_dependency("tapioca")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-04 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -206,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement