peddler 5.0.0.pre.1 → 5.0.0.pre.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d0c406e3251609fdef8fe5669557eea8bb2ceb6673daa4eba35e6b7aae0c705
-  data.tar.gz: 51bbdc9b06c899c9484aae73ccff292d78a08ef7c280e9c82c41ca2bb753dcad
+  metadata.gz: 20b378be071f3a0cade83e11f4c9970aa5d00ad4077097fd4ac22d709b20bf3d
+  data.tar.gz: 86420f4e6823a302e9785c2f795714f3769dce647e7880dcdee0bf5cdfd6b94b
 SHA512:
-  metadata.gz: deb8c6851661129e96b2447e6ede291cac59454e56c50eff3a071c9b81afaae6f7ad9d5d843d8fdebaa59889007b77209bbd061899335eb319a7ac9e8c8f2d53
-  data.tar.gz: 551d460e69641c2607d524e47fab94eda8435f7a065438e7a364b898dd51e424e515c0eac226438ae8b88811f00036902ba2687b67c84a8d1d3e2b7bea2b2e55
+  metadata.gz: 6cd309742cd1cc9594c570171553137ab43966cb3060f1af36a6da17a8c15f56cb4f93cd60f06bb06425a05e2d97108209f4e164890c5d574fabe0ac237e62c5
+  data.tar.gz: c5762d1e6b36d83dd7cbc0348d3ae6500bc983015e5efdd6c772d56d853aa8155f92a485e8292f2d4acc2501c333437685dd41fde8871d13f247b6db812ae518

data/README.md

@@ -55,35 +55,35 @@ require "peddler/apis/orders_v0"
 A seller or vendor [provides you a refresh token][authorization] to access their data on Amazon.
 
 ```ruby
-refresh_token = Peddled::Token.request(
+refresh_token = Peddler::LWA.request(
   code: "<AUTHORIZATION_CODE>"
-).parse["refresh_token"]
+).parse.refresh_token
 ```
 
 You use this to generate a temporary access token to authenticate individual API requests.
 
 ```ruby
-access_token = Peddler::Token.request(
+access_token = Peddler::LWA.request(
   refresh_token: "<REFRESH_TOKEN>",
-).parse["access_token"]
+).parse.access_token
 ```
 
 Similarly, you can request a token for grantless operations.
 
 ```ruby
-access_token = Peddler::Token.request(
+access_token = Peddler::LWA.request(
   scope: "sellingpartnerapi::notifications",
-).parse["access_token"]
+).parse.access_token
 ```
 
 If you haven't set your LWA credentials as environment variables, pass them directly when requesting the token.
 
 ```ruby
-access_token = Peddler::Token.request(
+access_token = Peddler::LWA.request(
   client_id: "<YOUR_CLIENT_ID>",
   client_secret: "<YOUR_CLIENT_SECRET>",
   refresh_token: "<REFRESH_TOKEN>",
-).parse["access_token"]
+).parse.access_token
 ```
 
 Access tokens are valid for one hour. To optimize performance, cache the token and reuse across calls.
@@ -96,9 +96,9 @@ class Seller
 
   def access_token
     Rails.cache.fetch("#{cache_key}/access_key", expires_in: 1.hour) do
-      Peddler::Token.request(
+      Peddler::LWA.request(
         refresh_token:,
-      ).parse["access_token"]
+      ).parse.access_token
     end
   end
 end

data/lib/peddler/{token.rb → lwa.rb}

@@ -4,14 +4,18 @@ require "http"
 
 require "peddler/error"
 require "peddler/response"
+require "peddler/types/lwa_token"
 
 module Peddler
-  # Requests refresh and access tokens that authorize your application to take actions on behalf of a selling partner.
+  # Requests Login with Amazon (LWA) access tokens that authorize your application to make SP-API requests.
   #
-  # The refresh token allows you to generate access tokens. Access tokens expire one hour after they are issued.
+  # Supports three OAuth 2.0 grant types:
+  # - authorization_code: Exchange authorization code for refresh token (initial authorization)
+  # - refresh_token: Exchange refresh token for access token (most common)
+  # - client_credentials: Get access token for grantless operations (e.g., notifications)
   #
   # @see https://developer-docs.amazon.com/sp-api/docs/connecting-to-the-selling-partner-api
-  class Token
+  class LWA
     URL = "https://api.amazon.com/auth/o2/token"
 
     attr_reader :client_id, :client_secret, :options
@@ -30,7 +34,7 @@ module Peddler
 
     def request
       http_response = HTTP.post(URL, form: params)
-      Response.wrap(http_response)
+      Response.wrap(http_response, parser: -> { Types::LWAToken })
     end
 
     def grant_type

data/lib/peddler/types/lwa_token.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "structure"
+
+module Peddler
+  module Types
+    # Login with Amazon (LWA) OAuth 2.0 token response
+    #
+    # This type represents the response from Amazon's token endpoint for all grant types:
+    # - authorization_code: Returns access_token, refresh_token, token_type, expires_in
+    # - refresh_token: Returns access_token, token_type, expires_in (refresh_token rarely included)
+    # - client_credentials: Returns access_token, token_type, expires_in, scope
+    #
+    # @see https://developer-docs.amazon.com/sp-api/docs/connecting-to-the-selling-partner-api
+    # @see https://developer.amazon.com/docs/login-with-amazon/documentation-overview.html
+    LWAToken = Structure.new do
+      # @return [String] The access token used to authenticate SP-API requests
+      attribute(:access_token, String)
+
+      # @return [String] The token type (always "bearer")
+      attribute(:token_type, String)
+
+      # @return [Integer] Number of seconds until the access token expires (typically 3600)
+      attribute?(:expires_in, Integer)
+
+      # @return [String, nil] The refresh token (present for authorization_code grant, rarely for refresh_token grant)
+      attribute?(:refresh_token, String)
+
+      # @return [String, nil] The scope granted (only present for client_credentials grant)
+      attribute?(:scope, String)
+    end
+  end
+end

data/lib/peddler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Peddler
-  VERSION = "5.0.0.pre.1"
+  VERSION = "5.0.0.pre.2"
 end

data/lib/peddler.rb

@@ -63,7 +63,7 @@ require "peddler/apis/vendor_invoices_v1"
 require "peddler/apis/vendor_orders_v1"
 require "peddler/apis/vendor_shipments_v1"
 require "peddler/apis/vendor_transaction_status_v1"
-require "peddler/token"
+require "peddler/lwa"
 
 module Peddler
   class << self

data/sig/peddler/{token.rbs → lwa.rbs}

@@ -1,9 +1,8 @@
 module Peddler
-  class Token
+  # Requests Login with Amazon (LWA) access tokens for SP-API authorization
+  class LWA
     URL: String
 
-    class Error < Peddler::Error
-    end
     @client_id: String?
     @client_secret: String?
     @options: Hash[Symbol, untyped]

data/sig/peddler/types/lwa_token.rbs

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Peddler
+  module Types
+    # Login with Amazon (LWA) OAuth 2.0 token response
+    #
+    # This type represents the response from Amazon's token endpoint for all grant types:
+    # - authorization_code: Returns access_token, refresh_token, token_type, expires_in
+    # - refresh_token: Returns access_token, token_type, expires_in (refresh_token rarely included)
+    # - client_credentials: Returns access_token, token_type, expires_in, scope
+    class LWAToken < Data
+      # The access token used to authenticate SP-API requests
+      def access_token: () -> String
+
+      # The token type (always "bearer")
+      def token_type: () -> String
+
+      # Number of seconds until the access token expires (typically 3600)
+      def expires_in: () -> Integer?
+
+      # The refresh token (present for authorization_code grant, rarely for refresh_token grant)
+      def refresh_token: () -> String?
+
+      # The scope granted (only present for client_credentials grant)
+      def scope: () -> String?
+
+      def self.parse: (untyped value) -> LWAToken
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peddler
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre.1
+  version: 5.0.0.pre.2
 platform: ruby
 authors:
 - Hakan Ensari
@@ -126,9 +126,9 @@ files:
 - lib/peddler/error.rb
 - lib/peddler/helpers/feeds_2021_06_30.rb
 - lib/peddler/helpers/reports_2021_06_30.rb
+- lib/peddler/lwa.rb
 - lib/peddler/marketplace.rb
 - lib/peddler/response.rb
-- lib/peddler/token.rb
 - lib/peddler/types/amazon_warehousing_and_distribution_2024_05_09.rb
 - lib/peddler/types/amazon_warehousing_and_distribution_2024_05_09/address.rb
 - lib/peddler/types/amazon_warehousing_and_distribution_2024_05_09/carrier_code.rb
@@ -960,6 +960,7 @@ files:
 - lib/peddler/types/listings_restrictions_2021_08_01/reason.rb
 - lib/peddler/types/listings_restrictions_2021_08_01/restriction.rb
 - lib/peddler/types/listings_restrictions_2021_08_01/restriction_list.rb
+- lib/peddler/types/lwa_token.rb
 - lib/peddler/types/merchant_fulfillment_v0.rb
 - lib/peddler/types/merchant_fulfillment_v0/additional_inputs.rb
 - lib/peddler/types/merchant_fulfillment_v0/additional_inputs_list.rb
@@ -2074,9 +2075,9 @@ files:
 - sig/peddler/error.rbs
 - sig/peddler/helpers/feeds_2021_06_30.rbs
 - sig/peddler/helpers/reports_2021_06_30.rbs
+- sig/peddler/lwa.rbs
 - sig/peddler/marketplace.rbs
 - sig/peddler/response.rbs
-- sig/peddler/token.rbs
 - sig/peddler/types/amazon_warehousing_and_distribution_2024_05_09.rbs
 - sig/peddler/types/aplus_content_2020_11_01.rbs
 - sig/peddler/types/application_integrations_2024_04_01.rbs
@@ -2102,6 +2103,7 @@ files:
 - sig/peddler/types/listings_items_2020_09_01.rbs
 - sig/peddler/types/listings_items_2021_08_01.rbs
 - sig/peddler/types/listings_restrictions_2021_08_01.rbs
+- sig/peddler/types/lwa_token.rbs
 - sig/peddler/types/merchant_fulfillment_v0.rbs
 - sig/peddler/types/messaging_v1.rbs
 - sig/peddler/types/money.rbs