atkhayar-spree-dev-api 0.0.0

data/db/migrate/20180320110726_create_doorkeeper_tables.rb

@@ -0,0 +1,69 @@
+class CreateDoorkeeperTables < ActiveRecord::Migration[5.1]
+  def change
+    create_table :spree_oauth_applications do |t|
+      t.string  :name,         null: false
+      t.string  :uid,          null: false
+      t.string  :secret,       null: false
+      t.text    :redirect_uri, null: false
+      t.string  :scopes,       null: false, default: ''
+      t.boolean :confidential, null: false, default: true
+      t.timestamps             null: false
+    end
+
+    add_index :spree_oauth_applications, :uid, unique: true
+
+    create_table :spree_oauth_access_grants do |t|
+      t.integer  :resource_owner_id, null: false
+      t.references :application,     null: false
+      t.string   :token,             null: false
+      t.integer  :expires_in,        null: false
+      t.text     :redirect_uri,      null: false
+      t.datetime :created_at,        null: false
+      t.datetime :revoked_at
+      t.string   :scopes
+    end
+
+    add_index :spree_oauth_access_grants, :token, unique: true
+    add_foreign_key(
+      :spree_oauth_access_grants,
+      :spree_oauth_applications,
+      column: :application_id
+    )
+
+    create_table :spree_oauth_access_tokens do |t|
+      t.integer  :resource_owner_id
+      t.references :application
+
+      # If you use a custom token generator you may need to change this column
+      # from string to text, so that it accepts tokens larger than 255
+      # characters. More info on custom token generators in:
+      # https://github.com/doorkeeper-gem/doorkeeper/tree/v3.0.0.rc1#custom-access-token-generator
+      #
+      # t.text     :token,             null: false
+      t.string   :token,                  null: false
+
+      t.string   :refresh_token
+      t.integer  :expires_in
+      t.datetime :revoked_at
+      t.datetime :created_at,             null: false
+      t.string   :scopes
+
+      # If there is a previous_refresh_token column,
+      # refresh tokens will be revoked after a related access token is used.
+      # If there is no previous_refresh_token column,
+      # previous tokens are revoked as soon as a new access token is created.
+      # Comment out this line if you'd rather have refresh tokens
+      # instantly revoked.
+      t.string   :previous_refresh_token, null: false, default: ""
+    end
+
+    add_index :spree_oauth_access_tokens, :token, unique: true
+    add_index :spree_oauth_access_tokens, :resource_owner_id
+    add_index :spree_oauth_access_tokens, :refresh_token, unique: true
+    add_foreign_key(
+      :spree_oauth_access_tokens,
+      :spree_oauth_applications,
+      column: :application_id
+    )
+  end
+end

data/db/migrate/20210727102516_change_integer_id_columns_type.rb

@@ -0,0 +1,9 @@
+class ChangeIntegerIdColumnsType < ActiveRecord::Migration[5.2]
+  def change
+    change_column :spree_oauth_access_grants, :resource_owner_id, :bigint
+    change_column :spree_oauth_access_grants, :application_id, :bigint
+
+    change_column :spree_oauth_access_tokens, :resource_owner_id, :bigint
+    change_column :spree_oauth_access_tokens, :application_id, :bigint
+  end
+end

data/db/migrate/20210902162826_create_spree_webhooks_tables.rb

@@ -0,0 +1,16 @@
+class CreateSpreeWebhooksTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_subscribers do |t|
+      t.string :url, null: false
+      t.boolean :active, default: false, index: true
+
+      if t.respond_to? :jsonb
+        t.jsonb :subscriptions
+      else
+        t.json :subscriptions
+      end
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210919183228_enable_polymorphic_resource_owner.rb

@@ -0,0 +1,21 @@
+class EnablePolymorphicResourceOwner < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_oauth_access_tokens, :resource_owner_type, :string
+    add_column :spree_oauth_access_grants, :resource_owner_type, :string
+    change_column_null :spree_oauth_access_grants, :resource_owner_type, false
+
+    add_index :spree_oauth_access_tokens,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_tokens'
+
+    add_index :spree_oauth_access_grants,
+              [:resource_owner_id, :resource_owner_type],
+              name: 'polymorphic_owner_oauth_access_grants'
+
+    Spree::OauthAccessToken.reset_column_information
+    Spree::OauthAccessToken.update_all(resource_owner_type: Spree.user_class)
+
+    Spree::OauthAccessGrant.reset_column_information
+    Spree::OauthAccessGrant.update_all(resource_owner_type: Spree.user_class)
+  end
+end

data/db/migrate/20211025162826_create_spree_webhooks_events.rb

@@ -0,0 +1,14 @@
+class CreateSpreeWebhooksEvents < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_webhooks_events do |t|
+      t.integer "execution_time"
+      t.string "name", null: false
+      t.string "request_errors"
+      t.string "response_code", index: true
+      t.belongs_to "subscriber", null: false, index: true
+      t.boolean "success", index: true
+      t.string "url", null: false
+      t.timestamps
+    end
+  end
+end

data/docs/oauth/index.yml

@@ -0,0 +1,233 @@
+openapi: 3.0.3
+servers:
+  - url: 'https://demo.spreecommerce.org'
+    description: demo
+  - url: 'http://localhost:3000'
+    description: localhost
+info:
+  version: 1.0.0
+  title: Authentication
+  description: Spree uses oAuth based Authentication via short-lived Bearer tokens. You can either create a new one or refresh existing token.
+  contact:
+    name: Spark Solutions
+    url: 'https://sparksolutions.co'
+    email: we@sparksolutions.co
+  license:
+    url: 'https://github.com/spree/spree/blob/master/license.md'
+    name: BSD-3-Clause
+paths:
+  /spree_oauth/token:
+    post:
+      description: |-
+        This endpoint creates a new Bearer Token or refreshes an existing Bearer Token.
+
+        The `token` found in the response body is required to authorize API calls.
+      operationId: create-or-refresh-token
+      responses:
+        '200':
+          description: Token was successfully created or refreshed.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Token'
+              examples:
+                Storefront User Token:
+                  value:
+                    access_token: SfM3k8kq5Wkc6xz6rgMlsl-mbygJ1ptq4DR0Ah51vjA
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+                    created_at: 1581873931
+                Platform User Token:
+                  value:
+                    access_token: 2480c16561d1391ea81ca5336b651e9a29f4524f6dee8c7f3f02a600159189c3
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: f5d78642252eeb3f3001f67b196ac21a27afc030462a54060b0ebbdae2b8dc9c
+                    scope: admin
+                    created_at: 1539863418
+                Refreshed Token:
+                  value:
+                    access_token: Es9lLPW2mVaDB80I-I_OdQCw3JfOT1s19YN1naFWx98
+                    token_type: Bearer
+                    expires_in: 7200
+                    refresh_token: j92BxulqIIYtiiaBsuAM1TzGsGSVxaykT4kk8OYHGNY
+                    created_at: 1581876572
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              oneOf:
+                - $ref: '#/components/schemas/CreateTokenBody'
+                - $ref: '#/components/schemas/ClientTokenBody'
+                - $ref: '#/components/schemas/RefreshTokenBody'
+            examples:
+              Create Storefront API User Token:
+                value:
+                  grant_type: password
+                  username: spree@example.com
+                  password: spree123
+              Create Platform API User Token:
+                value:
+                  client_id: 7ZY15L7crVZul8i3PZPrnpOkEURK7xnXEWRZdE6K39M
+                  client_secret: cxMZ0tbe604qj_13hibNmc3GDsXUQfpzHt9PvweihFc
+                  grant_type: password
+                  username: spree@example.com
+                  password: spree123
+                  scope: admin
+              Create Platform API Application Token:
+                value:
+                  grant_type: client_credentials
+                  client_id: 7ZY15L7crVZul8i3PZPrnpOkEURK7xnXEWRZdE6K39M
+                  client_secret: cxMZ0tbe604qj_13hibNmc3GDsXUQfpzHt9PvweihFc
+                  scope: admin
+              Refresh a Token:
+                value:
+                  grant_type: refresh_token
+                  refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+          application/xml:
+            schema:
+              type: object
+              properties: {}
+        description: ''
+      summary: Create or Refresh a Token
+      tags:
+        - Token
+components:
+  schemas:
+    Token:
+      x-examples:
+        create token:
+          access_token: SfM3k8kq5Wkc6xz6rgMlsl-mbygJ1ptq4DR0Ah51vjA
+          token_type: Bearer
+          expires_in: 7200
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+          created_at: 1581873931
+        refresh token:
+          access_token: Es9lLPW2mVaDB80I-I_OdQCw3JfOT1s19YN1naFWx98
+          token_type: Bearer
+          expires_in: 7200
+          refresh_token: j92BxulqIIYtiiaBsuAM1TzGsGSVxaykT4kk8OYHGNY
+          created_at: 1581876572
+      type: object
+      properties:
+        access_token:
+          type: string
+          example: 2480c16561d1391ea81ca5336b651e9a29f4524f6dee8c7f3f02a600159189c3
+        token_type:
+          type: string
+          example: Bearer
+          default: Bearer
+        expires_in:
+          type: integer
+          example: 7200
+          description: Time (in seconds) after which the access token will expire
+        refresh_token:
+          type: string
+          example: f5d78642252eeb3f3001f67b196ac21a27afc030462a54060b0ebbdae2b8dc9c
+        scope:
+          type: string
+          example: admin
+          default: admin
+        created_at:
+          type: integer
+          example: 1539863418
+      required:
+        - access_token
+        - token_type
+        - expires_in
+        - refresh_token
+        - created_at
+      x-internal: true
+    CreateTokenBody:
+      type: object
+      x-examples:
+        User Token:
+          grant_type: password
+          username: spree@example.com
+          password: spree123
+        Application Token:
+          grant_type: password
+          username: spree@example.com
+          password: spree123
+          scope: admin
+      x-internal: true
+      title: 'Create a new token (grant_type: password)'
+      description: ''
+      properties:
+        grant_type:
+          type: string
+          description: ''
+          example: password
+          enum:
+            - password
+        username:
+          type: string
+          description: User email address
+          example: spree@example.com
+        password:
+          type: string
+          description: User password
+          example: spree123
+        scope:
+          type: string
+          enum:
+            - admin
+          description: 'Pass the value `admin` to create a Platform User Token, allowing access to the Platform API.'
+          nullable: true
+      required:
+        - grant_type
+        - username
+        - password
+    ClientTokenBody:
+      type: object
+      x-examples:
+        example-1:
+          grant_type: refresh_token
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+      x-internal: true
+      title: 'Create a new token (grant_type: client_credentials)'
+      description: ''
+      properties:
+        grant_type:
+          type: string
+          example: client_credentials
+          enum:
+            - client_credentials
+        client_id:
+          type: string
+          description: Use the client id
+          example: 27af95fd57a424e5d01aaf5eab
+        client_secret:
+          type: string
+          example: 1324a8d5c0ca57daf384fae39f811a5144330143301'
+          description: Client secret key.
+      required:
+        - grant_type
+        - client_id
+        - client_secret
+    RefreshTokenBody:
+      type: object
+      x-examples:
+        example-1:
+          grant_type: refresh_token
+          refresh_token: SqJDIwX00fehqHxS6xmb-kzqAlrYe_0EHgekMexVT8k
+      x-internal: true
+      title: 'Refresh an existing token (grant_type: refresh_token)'
+      description: ''
+      properties:
+        grant_type:
+          type: string
+          example: refresh_token
+          enum:
+            - refresh_token
+        refresh_token:
+          type: string
+          description: Refresh token obtained from the create token response
+          example: 27af95fd57a424e5d01aaf5eab1324a8d5c0ca57daf384fae39f811a5144330143301'
+      required:
+        - grant_type
+        - refresh_token
+tags:
+  - name: Token