twitter_oauth2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827bf119b3a6ce09f1cb0e5afd2da4cc1dada8a67ad5caffb4a1cb284276cfa1
-  data.tar.gz: 4add740d26df68fc78afabceb8b3015750866791650b083449b8f99e15e4e116
+  metadata.gz: a3fd74a639d0b5217a59d0d8f1dd573f57458fac49ca9ec80eb41e061d061c0e
+  data.tar.gz: a688d0dc6bb2d8bf702d95149bfa5f184825de78cde6e9d2fa1c287343d529c1
 SHA512:
-  metadata.gz: 51eff08e3be05ed15c69a73afafa562c585f5a32753146a8208091abe9aee515a85fe73b44fd4c5744377fda6d1d2ddc7a33289b17f94d04eac469a9327472b6
-  data.tar.gz: 2b18c3fb47704081604502ddda4c242de8d4c99f3f19bd14f8eb1106b6346ffd975f4c308f43b590b321dbdb77f1d97296962997eda142cc7ba8a3e512d7a71b
+  metadata.gz: b29998b2bf147f510b8e82cdfa576d7f262da34f9717229cd8495bba0d473542a5275a86b1d30f7a2c6bbd4b4142fb8823c3030428e4273b636b3835f1acd251
+  data.tar.gz: 2433d26ad4187321ba4af6c0b3f8b059a95b3ffb616fcacd8becc7fa8dc2fab672c6628937eec7bc68a11f43181e3387ec6d24ee6ef55bcc7cfeb857497d5346

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'
+  ],
+  state: SecureRandom.hex(16)
+)
+
+# NOTE:
+#  When 'TwitterOAuth2::Client#authorization_uri is called,
+#  PKCE `code_verifier` is automatically generated.
+#  You can get it here.
+code_verifier = client.code_verifier
+
+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.2.0
+0.3.0

data/lib/twitter_oauth2/client.rb

@@ -1,5 +1,7 @@
 module TwitterOAuth2
   class Client < Rack::OAuth2::Client
+    attr_accessor :code_verifier
+
     def initialize(attributes)
       attributes_with_default = {
         authorization_endpoint: 'https://twitter.com/i/oauth2/authorize',
@@ -9,33 +11,31 @@ module TwitterOAuth2
     end
 
     def authorization_uri(params = {})
-      code_challenge, code_verifier = setup_pkce_session
+      code_challenge = pkce_session!
       authorization_uri = super({
         code_challenge: code_challenge,
         code_challenge_method: :s256
       }.merge(params))
-      [authorization_uri, code_verifier]
     end
 
     def access_token!(*args)
       options = args.extract_options!
       super :body, {
-        code_verifier: args.first
+        code_verifier: args.first || self.code_verifier
       }.merge(options)
     end
 
     private
 
-    def setup_pkce_session
-      code_verifier = Base64.urlsafe_encode64(
+    def pkce_session!
+      self.code_verifier = Base64.urlsafe_encode64(
         SecureRandom.random_bytes(32),
         padding: false
       )
-      code_challenge = Base64.urlsafe_encode64(
+      Base64.urlsafe_encode64(
         OpenSSL::Digest::SHA256.digest(code_verifier),
         padding: false
       )
-      [code_challenge, code_verifier]
     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.3.0
 platform: ruby
 authors:
 - nov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-02 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
 signing_key: 
 specification_version: 4
 summary: Twitter OAuth 2.0 Client