omniauth-twitter2 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b48323455ad42312548826f0ac3744440d158379a99da8be7eac364dceef0197
-  data.tar.gz: f6173a09259fb8e82ba02be3061dea0d57c426b749207a0b6d618c522c857047
+  metadata.gz: a9a5bf9460fa81e2e1400a60879f0f2c067aed70e32e76733195513a9d2741bf
+  data.tar.gz: a74dcf8886af81af0005b972ce6eb349f63e40b3514b7cce02d4b330bb3b38db
 SHA512:
-  metadata.gz: 94d5e8d0597b524e9071f5171ddd8dc8dc2476fba13ba4d1d3455f84e839afbda25f58aa78827ed96ed939de6606b832564957bb30e3d5e8cdfcd0e75886bf54
-  data.tar.gz: c6a2a55f31c2fe8f246593979ead4f429a89f94b36ebd695dea0201429bdb8d8d0c3531ddffedb62a3d8677b201c15369b1ad278f85e905de2bcf7797e1f4d62
+  metadata.gz: 04b4f31d5af0fc0a9e2eb38402bf18619b506e6e8989622513f3334215fe0c7d27f5e643d74c7fd34bc2b2f9342f504e528ca3aab3bc2f75f7041c1410276162
+  data.tar.gz: b87bb2d9a05795bcfd9f96f7fdef4daa9ee7c53738039f60d6372c7772dd1b1dec54239b1e03045ccaa2e97db418849801ff8707e83653d197e3e409cff46286

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.1.0] - 2026-03-12
+
+- feat: add email support via confirmed_email field ([#10](https://github.com/unasuke/omniauth-twitter2/pull/10))
+
 ## [1.0.0] - 2025-08-03
 
 - Update api endpoints from `twitter.com` to `x.com` ([#7](https://github.com/unasuke/omniauth-twitter2/pull/7))

data/Gemfile

@@ -8,3 +8,5 @@ gemspec
 gem "minitest"
 gem "rake"
 gem "rubocop"
+
+gem "minitest-mock" if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create("3.1")

data/README.md

@@ -1,10 +1,28 @@
 # OmniAuth::Twitter2
+
 [![test](https://github.com/unasuke/omniauth-twitter2/actions/workflows/main.yml/badge.svg)](https://github.com/unasuke/omniauth-twitter2/actions/workflows/main.yml)
 [![GitHub license](https://img.shields.io/github/license/unasuke/omniauth-twitter2)](https://github.com/unasuke/omniauth-twitter2/blob/main/LICENSE.txt)
 [![Gem Version](https://badge.fury.io/rb/omniauth-twitter2.svg)](https://rubygems.org/gems/omniauth-twitter2)
 
 This gem provides a OmniAuth strategy for authenticating with Twitter OAuth2.
 
+## Email Support
+
+As of April 2025, Twitter/X API v2 supports returning the user's email address via the `confirmed_email` field. See the [X Developer Community announcement](https://devcommunity.x.com/t/introducing-confirmed-email-in-user-object/233461).
+
+To request the email, include the `users.email` scope:
+
+```ruby
+scope: "tweet.read users.read users.email"
+```
+
+**Note:** The email will only be returned if:
+
+1. Your Twitter app has "Request email from users" enabled in the Developer Portal
+2. The user has a confirmed email address on their Twitter account
+3. The user grants permission during OAuth
+
+If these conditions aren't met, `email` will be `nil` in the auth hash.
 
 ## Installation
 
@@ -33,7 +51,7 @@ $ gem install omniauth-twitter2
 ```ruby
 # config/initializers/omniauth.rb
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :twitter2, ENV["TWITTER_CLIENT_ID"], ENV["TWITTER_CLIENT_SECRET"], callback_path: '/auth/twitter2/callback', scope: "tweet.read users.read"
+  provider :twitter2, ENV["TWITTER_CLIENT_ID"], ENV["TWITTER_CLIENT_SECRET"], callback_path: '/auth/twitter2/callback', scope: "tweet.read users.read users.email"
 end
 ```
 
@@ -44,7 +62,7 @@ end
     "uid" => "108252390",
     "info" => {
       "name" => "うなすけ",
-      "email" => nil,
+      "email" => "user@example.com", # nil if users.email scope not granted or email not confirmed
       "nickname" => "yu_suke1994",
       "description" => "帰って寝たい",
       "image" => "https://pbs.twimg.com/profile_images/580019517608218624/KzEZSzUy_normal.jpg",
@@ -61,6 +79,7 @@ end
     "extra" => {
       "raw_info" => {
         "data" => {
+          "confirmed_email" => "user@example.com", # only present if users.email scope granted
           "profile_image_url" => "https://pbs.twimg.com/profile_images/580019517608218624/KzEZSzUy_normal.jpg",
           "url" => "https://t.co/NCFLB8wDkx",
           "public_metrics" => {
@@ -108,6 +127,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 * [nov/twitter_oauth2: Twitter OAuth 2.0 Client Library in Ruby](https://github.com/nov/twitter_oauth2)
 
 ## Sample App
+
 * <https://twitter-login-app.onrender.com/>
   * <https://github.com/unasuke/twitter-login-app>
 

data/lib/omniauth/strategies/twitter2.rb

@@ -20,7 +20,7 @@ module OmniAuth
       info do
         {
           name: raw_info["data"]["name"],
-          email: nil,
+          email: raw_info["data"]["confirmed_email"],
           nickname: raw_info["data"]["username"],
           description: raw_info["data"]["description"],
           image: raw_info["data"]["profile_image_url"],
@@ -38,7 +38,7 @@ module OmniAuth
       def raw_info
         @raw_info ||= access_token.get(
           "/2/users/me?" \
-          "&user.fields=created_at,description,entities,id,location,name,pinned_tweet_id," \
+          "user.fields=confirmed_email,created_at,description,entities,id,location,name,pinned_tweet_id," \
           "profile_image_url,protected,public_metrics,url,username,verified,withheld",
           { headers: { "Authorization" => "Bearer #{access_token.token}" } }
         ).parsed || {}

data/lib/omniauth/twitter2/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAuth
   module Twitter2
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-twitter2
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yusuke Nakamura
 bindir: exe
 cert_chain: []
-date: 2025-08-02 00:00:00.000000000 Z
+date: 2026-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth