twitter_oauth2 0.2.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827bf119b3a6ce09f1cb0e5afd2da4cc1dada8a67ad5caffb4a1cb284276cfa1
-  data.tar.gz: 4add740d26df68fc78afabceb8b3015750866791650b083449b8f99e15e4e116
+  metadata.gz: b2e1d31e068391f9c383c7763c0e9d8d24bb9b8d5a103f40d322a8c86c8a7085
+  data.tar.gz: 935ea49eda4bb324c81e2a79f492311a98edbc9e5684ba6c03ba676372506a2d
 SHA512:
-  metadata.gz: 51eff08e3be05ed15c69a73afafa562c585f5a32753146a8208091abe9aee515a85fe73b44fd4c5744377fda6d1d2ddc7a33289b17f94d04eac469a9327472b6
-  data.tar.gz: 2b18c3fb47704081604502ddda4c242de8d4c99f3f19bd14f8eb1106b6346ffd975f4c308f43b590b321dbdb77f1d97296962997eda142cc7ba8a3e512d7a71b
+  metadata.gz: f3745818e6df3d018fad281cadf2f5d1259302b72b842fdff04651002f10f8b86134bb679ffbc1e0bcd682e58dbf923b1943df67473fbb92b54f4fd48ee6ff3d
+  data.tar.gz: a04f256212a7c240f2a17ba5a118b77e9fdfbecdd6f8ed85cd2417f8efec564740f9263a1f4248e1972a88583045f97041aaab05bb028ed8ea3f1abc67cd1694

data/.travis.yml

@@ -4,4 +4,5 @@ before_install:
 rvm:
   - 2.5.8
   - 2.6.6
-  - 2.7.2
+  - 2.7.2
+  - 3.0.2

data/README.md

@@ -1,8 +1,6 @@
-# TwitterOauth2
+# TwitterOAuth2
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/twitter_oauth2`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Twitter OAuth2 Client Library in Ruby.
 
 ## Installation
 
@@ -22,7 +20,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem is built on `rack/oauth2` gem.   
+Basically, the usage is same with [the underling gem](https://github.com/nov/rack-oauth2/wiki).
+
+The only difference is that this gem is supporting PKCE as default, since [Twitter **requires** it](https://developer.twitter.com/en/docs/twitter-api/oauth2).
+
+```ruby
+require 'twitter_oauth2'
+
+client = TwitterOAuth2::Client.new(
+  identifier:   '<YOUR-CLIENT-ID>',
+  secret:       '<YOUR-CLIENT-SECRET>',
+  redirect_uri: '<YOUR-CALLBACK-URL>'
+)
+
+authorization_uri = client.authorization_uri(
+  scope: [
+    :'users.read',
+    :'tweet.read',
+    :'offline.access'
+  ]
+)
+
+# NOTE:
+#  When `TwitterOAuth2::Client#authorization_uri` is called,
+#  PKCE `code_verifier` and `state` are automatically generated.
+#  You can get it here.
+
+code_verifier = client.code_verifier
+state = client.state
+
+puts authorization_uri
+`open "#{authorization_uri}"`
+
+print 'code: ' and STDOUT.flush
+code = gets.chop
+
+# NOTE: Obtaining Access Token & Refresh Token using Authorization Code
+client.authorization_code = code
+token_response = client.access_token! code_verifier
+
+# NOTE: Refreshing Access Token using Refresh Token
+client.refresh_token = token_response.refresh_token
+client.access_token!
+```
+
+If you want to get App-only Bearer Token (via `grant_type=client_credentials`), you need some tweaks as below.
+
+```ruby
+require 'twitter_oauth2'
+
+client = TwitterOAuth2::Client.new(
+  # NOTE: not OAuth 2.0 Client ID, but OAuth 1.0 Consumer Key (a.k.a API Key)
+  identifier:   '<YOUR-CONSUMER-KEY>',
+  # NOTE: not OAuth 2.0 Client Secret, but OAuth 1.0 Consumer Secret (a.k.a API Key Secret)
+  secret:       '<YOUR-CONSUMER-SECRET>'
+  # NOTE: Twitter has Client Credentials Grant specific token endpoint.
+  token_endpoint: '/oauth2/token',
+)
+
+client.access_token!
+```
+
+For more usage, read [the underling gem's wiki](https://github.com/nov/rack-oauth2/wiki).
 
 ## Development
 
@@ -40,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TwitterOauth2 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/twitter_oauth2/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TwitterOAuth2 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/twitter_oauth2/blob/master/CODE_OF_CONDUCT.md).

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.5.1

data/lib/twitter_oauth2/client.rb

@@ -1,41 +1,54 @@
 module TwitterOAuth2
   class Client < Rack::OAuth2::Client
+    attr_accessor :code_verifier, :code_challenge, :code_challenge_method, :state
+
     def initialize(attributes)
       attributes_with_default = {
+        host: 'api.twitter.com',
         authorization_endpoint: 'https://twitter.com/i/oauth2/authorize',
-        token_endpoint: 'https://api.twitter.com/2/oauth2/token'
+        token_endpoint: '/2/oauth2/token'
       }.merge(attributes)
       super attributes_with_default
     end
 
     def authorization_uri(params = {})
-      code_challenge, code_verifier = setup_pkce_session
-      authorization_uri = super({
+      authorization_session!
+      super({
         code_challenge: code_challenge,
-        code_challenge_method: :s256
+        code_challenge_method: code_challenge_method,
+        state: state
       }.merge(params))
-      [authorization_uri, code_verifier]
     end
 
     def access_token!(*args)
       options = args.extract_options!
-      super :body, {
-        code_verifier: args.first
-      }.merge(options)
+      super({
+        # NOTE:
+        #  For some reason, Twitter requires client_id duplication both in body & header for confidentail clients.
+        #  Follow such behaviour for now.
+        #  Hopefully, I can remove this line in near future.
+        client_id: identifier,
+
+        code_verifier: args.first || self.code_verifier
+      }.merge(options))
     end
 
     private
 
-    def setup_pkce_session
-      code_verifier = Base64.urlsafe_encode64(
+    def authorization_session!
+      self.state = Base64.urlsafe_encode64(
+        SecureRandom.random_bytes(16),
+        padding: false
+      )
+      self.code_verifier = Base64.urlsafe_encode64(
         SecureRandom.random_bytes(32),
         padding: false
       )
-      code_challenge = Base64.urlsafe_encode64(
+      self.code_challenge = Base64.urlsafe_encode64(
         OpenSSL::Digest::SHA256.digest(code_verifier),
         padding: false
       )
-      [code_challenge, code_verifier]
+      self.code_challenge_method = :s256
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_oauth2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - nov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-oauth2
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Twitter OAuth 2.0 Client