omniauth-twitter2 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f46f460692cde04fdefa508e5ee2393ba6aa4e330987ea760c3cf9671c6015c6
-  data.tar.gz: 83e8e366704f172d37c5d5dc005f4bcdbb1fb6f9d71b2ee79eac558e62cf9bd5
+  metadata.gz: a9a5bf9460fa81e2e1400a60879f0f2c067aed70e32e76733195513a9d2741bf
+  data.tar.gz: a74dcf8886af81af0005b972ce6eb349f63e40b3514b7cce02d4b330bb3b38db
 SHA512:
-  metadata.gz: 280543b64cbeccc177c4bbecb9714b84d63e97da6abdd864cedcb90c6be6e147aeb6ad3847409a6a8c67456794270fa6e2e04b73b14c7425636805ca6eb44e02
-  data.tar.gz: b634f91a0b28fc6d3bf1d5da2d2a78101bf5da8a070691da193c59c51d038cadb7fe172c603273ab08ae07f63b03fb987e8fbf8d8e8f175024965592e5967fc7
+  metadata.gz: 04b4f31d5af0fc0a9e2eb38402bf18619b506e6e8989622513f3334215fe0c7d27f5e643d74c7fd34bc2b2f9342f504e528ca3aab3bc2f75f7041c1410276162
+  data.tar.gz: b87bb2d9a05795bcfd9f96f7fdef4daa9ee7c53738039f60d6372c7772dd1b1dec54239b1e03045ccaa2e97db418849801ff8707e83653d197e3e409cff46286

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-01-10
+## [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))
+
+## [0.1.0] - 2022-01-13
 
 - Initial release

data/Gemfile

@@ -5,8 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in omniauth-twitter2.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "minitest"
+gem "rake"
+gem "rubocop"
 
-gem "minitest", "~> 5.0"
-
-gem "rubocop", "~> 1.21"
+gem "minitest-mock" if Gem::Version.create(RUBY_VERSION) >= Gem::Version.create("3.1")

data/README.md

@@ -1,7 +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
 
@@ -30,7 +51,7 @@ $ gem install omniauth-twitter2
 ```ruby
 # config/initializers/omniauth.rb
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :twitter2, ENV["TWITTER_API_KEY"], ENV["TWITTER_API_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
 ```
 
@@ -41,13 +62,13 @@ 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",
       "urls" => {
         "Website" => "https://t.co/NCFLB8wDkx",
-        "Twitter" => "https://twitter.com/yu_suke1994"
+        "Twitter" => "https://x.com/yu_suke1994"
       }
     },
     "credentials" => {
@@ -58,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" => {
@@ -98,12 +120,17 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## References
 
 * Twitter official resources
-  * [twitterdev/Twitter-API-v2-sample-code: Sample code for the Twitter API v2 endpoints](https://github.com/twitterdev/Twitter-API-v2-sample-code)
-  * [OAuth 2.0 Making requests on behalf of users | Docs | Twitter Developer Platform](https://developer.twitter.com/en/docs/authentication/oauth-2-0/user-access-token)
+  * [xdevplatform/Twitter-API-v2-sample-code: Sample code for the Twitter API v2 endpoints](https://github.com/xdevplatform/Twitter-API-v2-sample-code)
+  * [OAuth 2.0 - X](https://docs.x.com/fundamentals/authentication/oauth-2-0/overview)
 * [arunagw/omniauth-twitter: OmniAuth strategy for Twitter](https://github.com/arunagw/omniauth-twitter)
 * [omniauth/omniauth-oauth2: An abstract OAuth2 strategy for OmniAuth.](https://github.com/omniauth/omniauth-oauth2)
 * [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>
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/unasuke/omniauth-twitter2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/unasuke/omniauth-twitter2/blob/main/CODE_OF_CONDUCT.md).

data/lib/omniauth/strategies/twitter2.rb

@@ -7,10 +7,11 @@ module OmniAuth
   module Strategies
     class Twitter2 < OmniAuth::Strategies::OAuth2 # :nodoc:
       option :name, "twitter2"
+      # https://docs.x.com/fundamentals/authentication/oauth-2-0/overview
       option :client_options, {
-        site: "https://api.twitter.com",
+        site: "https://api.x.com",
         token_url: "2/oauth2/token",
-        authorize_url: "https://twitter.com/i/oauth2/authorize"
+        authorize_url: "https://x.com/i/oauth2/authorize"
       }
       option :pkce, true
 
@@ -19,13 +20,13 @@ 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"],
           urls: {
             Website: raw_info["data"]["url"],
-            Twitter: "https://twitter.com/#{raw_info["data"]["username"]}"
+            Twitter: "https://x.com/#{raw_info["data"]["username"]}"
           }
         }
       end
@@ -37,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 = "0.1.0"
+    VERSION = "1.1.0"
   end
 end

data/omniauth-twitter2.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  # spec.metadata["changelog_uri"] = "TBA"
+  spec.metadata["changelog_uri"] = "https://github.com/unasuke/omniauth-twitter2/blob/main/CHANGELOG.md"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-twitter2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yusuke Nakamura
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2026-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -46,10 +45,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -66,8 +65,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/unasuke/omniauth-twitter2
   source_code_uri: https://github.com/unasuke/omniauth-twitter2
+  changelog_uri: https://github.com/unasuke/omniauth-twitter2/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Twitter OAuth2 strategy for OmniAuth
 test_files: []

data/Gemfile.lock

@@ -1,89 +0,0 @@
-PATH
-  remote: .
-  specs:
-    omniauth-twitter2 (0.1.0)
-      omniauth
-      omniauth-oauth2 (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    faraday (1.9.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    hashie (5.0.0)
-    jwt (2.3.0)
-    minitest (5.15.0)
-    multi_json (1.15.0)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    oauth2 (1.4.7)
-      faraday (>= 0.8, < 2.0)
-      jwt (>= 1.0, < 3.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (2.0.4)
-      hashie (>= 3.4.6)
-      rack (>= 1.6.2, < 3)
-      rack-protection
-    omniauth-oauth2 (1.7.2)
-      oauth2 (~> 1.4)
-      omniauth (>= 1.9, < 3)
-    parallel (1.21.0)
-    parser (3.1.0.0)
-      ast (~> 2.4.1)
-    rack (2.2.3)
-    rack-protection (2.1.0)
-      rack
-    rainbow (3.0.0)
-    rake (13.0.6)
-    regexp_parser (2.2.0)
-    rexml (3.2.5)
-    rubocop (1.24.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  omniauth-twitter2!
-  rake (~> 13.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.3.4