devise-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b573587b480d33fc2b6615142cdc7ca1c0215497fc3d3755d6a88b303a1788
-  data.tar.gz: 4151e896ab7a40573a92bffa88383758dd96c4af22998ebc61a6167a82b9cfe1
+  metadata.gz: 4f6b2f86ff9cf332790f64f74212b25afff00bc6ff02ffe66389925db4b8fdc6
+  data.tar.gz: a7e8420897cf4e587a73a297d2121fcd0d20f4750deb01e9a7685bf4e635059b
 SHA512:
-  metadata.gz: f5d4f26d865ea6d3341726017a82f66c911d088f518ca55fb4af10e4a01b5ed783cbee87aae6f5bca1e4fe6207d7db3404626ac6528fe1cf7b647d9e5b637bea
-  data.tar.gz: 5789da3efd48c951b8199663f02a2bba978664b5a38a5c58c1fc752db5fb6eafdabb41af67d48241ff4bd7823a00b3b680a53e58f32ddb521164e05e858c5d83
+  metadata.gz: d5a5ec029117561416f93e6748f278f8489aeef2ec4ce832bce7136790a7587d93de2f5490bbbbfe4a202ccb4275c2f371012e435fdb7cb077999189372039f5
+  data.tar.gz: 43cad74cafb53ce017ebcf1e7ae41e250138eb9d8b0407ee89baf4ed8e2137394d4008f60c7c4f1f7116859aca43571361906a95ebbc1888348f71884f03a817

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise-api (0.0.0)
+    devise-api (0.1.2)
       devise (>= 4.7.2)
       dry-configurable (~> 1.0, >= 1.0.1)
       dry-initializer (>= 3.1.1)

data/README.md

@@ -69,6 +69,8 @@ Your user model is now ready to use `devise-api` gem. It will draw routes for to
 | sign_in_user_tokens | POST | /users/tokens/sign_in | devise/api/tokens#sign_in |
 | info_user_tokens | GET | /users/tokens/info | devise/api/tokens#info |
 
+### You can look up the [example requests](#example-api-requests).
+
 ## Configuration
 
 `devise-api` is a full configurable gem. You can configure it to your needs. Here is a basic usage example:
@@ -226,9 +228,49 @@ class Api::V1::TokensController < YourBaseController
 end
 ```
 
+## Example API requests
+
+### Sign in
+```curl
+curl --location --request POST 'http://127.0.0.1:3000/users/tokens/sign_in' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "email": "test@development.com",
+    "password": "123456"
+}'
+```
+
+### Sign up
+```curl
+curl --location --request POST 'http://127.0.0.1:3000/users/tokens/sign_up' \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "email": "test@development.com",
+    "password": "123456"
+}'
+```
+
+### Refresh token
+```curl
+curl --location --request POST 'http://127.0.0.1:3000/users/tokens/refresh' \
+--header 'Authorization: Bearer <refresh_token>'
+```
+
+### Revoke
+```curl
+curl --location --request POST 'http://127.0.0.1:3000/users/tokens/revoke' \
+--header 'Authorization: Bearer <access_token>'
+```
+
+### Info
+```curl
+curl --location --request GET 'http://127.0.0.1:3000/users/tokens/info' \
+--header 'Authorization: Bearer <access_token>'
+```
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/devise/api/generators/install_generator.rb

@@ -40,22 +40,6 @@ module Devise
         def migration_version
           "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
         end
-
-        def primary_key_type
-          fallback = :integer
-
-          begin
-            ActiveRecord::Base.connection.supports_pgcrypto_uuid? ? :uuid : fallback
-          rescue StandardError
-            fallback
-          end
-        end
-
-        def table_defaults_for_primary_key_type
-          return ', type: :uuid' if primary_key_type == :uuid
-
-          ''
-        end
       end
     end
   end

data/lib/devise/api/generators/templates/migration.rb.erb

@@ -2,8 +2,11 @@
 
 class CreateDeviseApiTables < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :devise_api_tokens<%= table_defaults_for_primary_key_type %>  do |t|
-      t.belongs_to :resource_owner, null: false<%= table_defaults_for_primary_key_type %>, polymorphic: true, index: true
+    # Use Active Record's configured type for primary and foreign keys
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+
+    create_table :devise_api_tokens, id: primary_key_type  do |t|
+      t.belongs_to :resource_owner, null: false, polymorphic: true, index: true, type: foreign_key_type
       t.string :access_token, null: false, index: true
       t.string :refresh_token, null: true, index: true
       t.integer :expires_in, null: false
@@ -13,4 +16,14 @@ class CreateDeviseApiTables < ActiveRecord::Migration<%= migration_version %>
       t.timestamps
     end
   end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
 end

data/lib/devise/api/version.rb

@@ -2,6 +2,6 @@
 
 module Devise
   module Api
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - nejdetkadir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: The devise-api gem is a convenient way to add authentication to your Ruby