omniauth-printful 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45383fdf829db5fb0dea0ce95bc6cd7347cb5d141822a41e6efc30768b6a0391
-  data.tar.gz: 4b640f6aa97b5676817d6a0f89ce9b884508cffa24d3ed198d1c76f7365da229
+  metadata.gz: 58664dfbd8e5f6485d4e2f32f05aefbb90e724bd613ead985812d9f682db5817
+  data.tar.gz: fe0bf6739cd84d7de300ba3bc4dce86151600a5a07eecefb31a89259255b574a
 SHA512:
-  metadata.gz: 7e97cc80e439bb783d04c28864bd558f2f82edc698bb229a6d420770dbc5da046bcec62d8cd30a164e5cf52708691f6d5b45cf611e640aaa710891efa07c08b8
-  data.tar.gz: 3b760a46dfaac71ec26df9c6c7cd375ea15b949e5d376d963f812cf174498a154a9198c7ee4b1150b010450da2db597d23e21171f1157d01e02646ff78912331
+  metadata.gz: 53693119000626bf058d789d8727d14743005739811cb1bd28e0f7ae514b56affde32ac8b581126750b560bd79f49f36217e69802e803c74a9687aa623995090
+  data.tar.gz: a4f1056f09514658feb81071967e69a39150f4b064b7f9d1159092dcd54ec542b1ef785c0cac180021978640134e74206e574b117a6ccaba017e147ee085a182

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-07-10
+
+### Fixed
+- Token exchange now sends the client credentials in the request body
+  (`auth_scheme: :request_body`). oauth2 2.x defaults to HTTP Basic auth, which
+  Printful's token endpoint does not accept.
+- Token exchange no longer sends a `redirect_uri`. Printful rejects it at
+  exchange time (the callback location is supplied as `redirect_url` during the
+  authorize step only).
+
+### Added
+- A denied authorization (Printful returns `success=0` rather than the standard
+  `error` parameter) now fails cleanly as `:access_denied` instead of surfacing
+  as a misleading `:csrf_detected` or `:invalid_credentials` error.
+
+### Notes
+- State verification remains enabled by default. If Printful does not echo the
+  `state` parameter back on the callback, configure the provider with
+  `provider_ignores_state: true`. See the README.
+
+## [0.1.0] - 2026-06-15
+
+### Fixed
+- The packaged gem now includes the strategy source files. Previously only
+  `lib/omniauth-printful.rb` was shipped, so the installed gem raised a
+  `LoadError`.
+- `uid` is now the authenticated store's id instead of a random UUID, so host
+  applications can recognise returning users.
+
+### Added
+- `info` now exposes the store `name`, and `extra.raw_info` contains the full
+  `GET /stores` response.
+- Gem metadata (homepage, source code, changelog, and bug tracker URIs).
+- MIT `LICENSE` file.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 David English
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README.md

@@ -0,0 +1,121 @@
+# OmniAuth Printful
+
+This gem contains the [Printful](https://www.printful.com) strategy for
+[OmniAuth](https://github.com/omniauth/omniauth).
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-printful'
+```
+
+Then run `bundle install`.
+
+## Usage
+
+Register an application in the [Printful Developer
+Portal](https://developers.printful.com/) to obtain a client id and client
+secret, and configure its redirect URL to point at your callback route (by
+default `/auth/printful/callback`).
+
+Add the strategy to your OmniAuth builder:
+
+```ruby
+use OmniAuth::Builder do
+  provider :printful, ENV['PRINTFUL_CLIENT_ID'], ENV['PRINTFUL_CLIENT_SECRET']
+end
+```
+
+In Rails, this typically lives in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :printful, ENV['PRINTFUL_CLIENT_ID'], ENV['PRINTFUL_CLIENT_SECRET']
+end
+```
+
+### Scopes
+
+Printful uses scopes to limit what an access token may do (for example
+`orders`, `stores_list`, `sync_products`, `file_library`, `webhooks`). The
+scopes available to your token are configured for your app in the Developer
+Portal. You can request a specific set at runtime with the `scope` option:
+
+```ruby
+provider :printful, ENV['PRINTFUL_CLIENT_ID'], ENV['PRINTFUL_CLIENT_SECRET'],
+         scope: 'orders stores_list'
+```
+
+### Printful-specific behaviour
+
+Printful's OAuth 2.0 implementation departs from the specification in a few
+ways. This strategy handles them for you, but they are worth knowing about:
+
+- **Authorize request** uses a `redirect_url` parameter instead of the standard
+  `redirect_uri`.
+- **Token exchange** sends the client credentials in the request body and does
+  **not** accept a `redirect_uri`. The strategy sets `auth_scheme: :request_body`
+  and omits the redirect parameter accordingly.
+- **Denied authorization** comes back as `success=0` rather than a standard
+  `error` parameter. The strategy translates this into a clean OmniAuth
+  `:access_denied` failure.
+
+#### CSRF / `state`
+
+State verification is enabled by default. If you find authentications failing
+with `:csrf_detected`, Printful is not echoing the `state` parameter back on the
+callback; disable the check with:
+
+```ruby
+provider :printful, ENV['PRINTFUL_CLIENT_ID'], ENV['PRINTFUL_CLIENT_SECRET'],
+         provider_ignores_state: true
+```
+
+In Rails, the request phase is still protected against CSRF by
+[omniauth-rails_csrf_protection](https://github.com/cookpad/omniauth-rails_csrf_protection),
+which requires the request phase to be initiated with a POST.
+
+## Auth Hash
+
+After a successful authentication, `request.env['omniauth.auth']` looks like
+this (the `uid` is the authenticated Printful store's id):
+
+```ruby
+{
+  "provider" => "printful",
+  "uid" => "10",
+  "info" => {
+    "name" => "My Store"
+  },
+  "credentials" => {
+    "token" => "...",
+    "refresh_token" => "...",
+    "expires_at" => 1718000000,
+    "expires" => true
+  },
+  "extra" => {
+    "raw_info" => {
+      "code" => 200,
+      "result" => [
+        { "id" => 10, "name" => "My Store", "type" => "native" }
+      ]
+    }
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bundle install`, then run the tests and
+linter:
+
+```sh
+bundle exec rspec
+bundle exec rubocop
+```
+
+## License
+
+Released under the [MIT License](LICENSE).

data/lib/omniauth/printful/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Printful
+    VERSION = '0.2.0'
+  end
+end

data/lib/omniauth/strategies/printful.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Printful < OmniAuth::Strategies::OAuth2
+      API_SITE = 'https://api.printful.com'
+
+      option :name, 'printful'
+
+      option :client_options, {
+        site: 'https://www.printful.com',
+        authorize_url: 'https://www.printful.com/oauth/authorize',
+        token_url: 'https://www.printful.com/oauth/token',
+        auth_scheme: :request_body
+      }
+
+      uid { store['id']&.to_s }
+
+      info do
+        {
+          name: store['name']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("#{API_SITE}/stores").parsed || {}
+      end
+
+      def store
+        @store ||= Array(raw_info['result']).first || {}
+      end
+
+      def request_phase
+        redirect client.auth_code.authorize_url({ redirect_url: callback_url }.merge(authorize_params))
+      end
+
+      def callback_phase
+        if request.params['error'].nil? && request.params['success'] == '0'
+          error = CallbackError.new('access_denied', 'The user denied the Printful authorization request')
+          return fail!(:access_denied, error)
+        end
+
+        super
+      end
+
+      protected
+
+      def build_access_token
+        client.auth_code.get_token(
+          request.params['code'],
+          token_params.to_hash(symbolize_keys: true),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+    end
+  end
+end

data/lib/omniauth-printful.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require 'omniauth/printful/version'
 require 'omniauth/strategies/printful'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-printful
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David English
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -17,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,19 +26,30 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
-description: 
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: An OmniAuth OAuth2 strategy for authenticating with Printful.
 email: davidenglishcodes@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 - lib/omniauth-printful.rb
-homepage: 
+- lib/omniauth/printful/version.rb
+- lib/omniauth/strategies/printful.rb
+homepage: https://github.com/davidenglishmusic/omniauth-printful
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/davidenglishmusic/omniauth-printful
+  source_code_uri: https://github.com/davidenglishmusic/omniauth-printful
+  changelog_uri: https://github.com/davidenglishmusic/omniauth-printful/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/davidenglishmusic/omniauth-printful/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,15 +57,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Printful strategy for OmniAuth
 test_files: []