twitter_oauth2 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6415db5f928fd04caf2f787b1a1b99ca9d7c1498a6a46ffea311f91243f517
-  data.tar.gz: f7019063e3d717403ce74f9424cf859f869f6e61c097a8ec5aeb1575cb3c97a6
+  metadata.gz: b4e38a68d54be58e74f4ffc2236f0df0c2aa9a9d872eb180af0f902dcb0f3a1e
+  data.tar.gz: e0f00e6f8bf166574fdf636f6228c3a6adbcd0e7cfc79ac3ff280654411d8a05
 SHA512:
-  metadata.gz: a0c5a13f221bfbbbd2235fb3d27d55a01c26183a9bf0bb178c61122019ecf0488662daed083e7feb776056ea9ec59be0d0f20ae3298a0d8b38b4eddd3e1bb565
-  data.tar.gz: cfe02be16384a8da3a6f08c3f53d80b2b1e0647b9fb3e4d9c6c8600857d90990edb7ea713a632ee11a07846e036d9ef44320b00d4c3365aa37a152a6125ceb36
+  metadata.gz: a9b38da9a8e90292815b6a8fbe162886780c93225ff6006f9d4c9fb64213958340c1e833aa4678aa1883ce31f74478fb1a058bfc4619b09697e899d31765dd02
+  data.tar.gz: 719fbeadae3a8813317e50a4ea5fa1c0e746f528440405f5534f0f690aea8a6bc0d3eab52b8b8c2938180f3c2d28d380d68afb8937c9d429e7bfa4810c2a37cb

data/.travis.yml

@@ -1,6 +1,8 @@
----
-language: ruby
-cache: bundler
+before_install:
+  - gem install bundler
+
 rvm:
+  - 2.5.8
+  - 2.6.6
   - 2.7.2
-before_install: gem install bundler -v 2.2.28
+  - 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,50 @@ 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>',
+  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!
+```
+
+For more usage, read [the underling gem's wiki](https://github.com/nov/rack-oauth2/wiki).
 
 ## Development
 
@@ -40,4 +81,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.1.0
+0.5.0

data/lib/twitter_oauth2/client.rb

@@ -1,5 +1,7 @@
 module TwitterOAuth2
   class Client < Rack::OAuth2::Client
+    attr_accessor :code_verifier, :code_challenge, :code_challenge_method, :state
+
     def initialize(attributes)
       attributes_with_default = {
         authorization_endpoint: 'https://twitter.com/i/oauth2/authorize',
@@ -9,29 +11,43 @@ module TwitterOAuth2
     end
 
     def authorization_uri(params = {})
-      code_challenge, code_verifier = setup_pkce_session
+      authorization_session!
       authorization_uri = 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!(code_verifier, options = {})
-      super :body, {
-        code_verifier: code_verifier
-      }.merge(options)
+    def access_token!(*args)
+      options = args.extract_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 = SecureRandom.hex(8)
-      code_challenge = 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
+      )
+      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.1.0
+  version: 0.5.0
 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