twitter_oauth2 0.0.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0419576dd3cc8963503f733895c8ad852ae70acb24128dff23bf97abbf3ca785'
-  data.tar.gz: 94722540e2acd589fc6498b216fe6c818de1a34f76d650300050e3100fe0065d
+  metadata.gz: f122e87aaf15c361806ef0e5b433d4581e5917602ccb1ecdc3ffc143dccb8c9a
+  data.tar.gz: ab48249dd3d6ef1d43028bb9fd80896a3b6f9dd051dd3def027cc92d6f6da7a9
 SHA512:
-  metadata.gz: 9b89d5d4e00dc7c79fa391954dd3d4068944ab554c4b854c4c9920132ba1c369a9f8665114d67364d8ed993458a0614e973e5f5f6a97d604299175197e6d0653
-  data.tar.gz: db47363df8d70c8f0786d65eb07a714218dbe2448b000f3004bbf3788485064fbd014df9b4d94e01cc6f9aa186addd35a996e7339df0ad6d738ab2e4aa59a425
+  metadata.gz: 3e28f5eef3c5b78cc78ef8fe46afb019bed576d9ee45a7f6ae74a9618fda9d3e6e549bd189c702dcaafa85d4ee148745b034c2fb5cefac1bfe9c849683e7b035
+  data.tar.gz: bc2708b3af710699168313319fa51b47a63cd640a1998b65b5890143f450203e20f5e948040577420adf2f8d2871f718e219e16c1f7a697e8655bcf5097e3e97

data/.travis.yml

@@ -1,6 +1,7 @@
----
-language: ruby
-cache: bundler
+before_install:
+  - gem install bundler
+
 rvm:
-  - 2.7.2
-before_install: gem install bundler -v 2.2.28
+  - 2.5.8
+  - 2.6.6
+  - 2.7.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/Rakefile

@@ -1,8 +1,19 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+namespace :coverage do
+  desc 'Open coverage report'
+  task :report do
+    require 'simplecov'
+    `open "#{File.join SimpleCov.coverage_path, 'index.html'}"`
+  end
+end
+
+task :spec do
+  Rake::Task[:'coverage:report'].invoke unless ENV['TRAVIS_RUBY_VERSION']
+end
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.4.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,37 @@ 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 = {})
+    def access_token!(*args)
+      options = args.extract_options!
       super :body, {
-        code_verifier: code_verifier
+        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.0.1
+  version: 0.4.0
 platform: ruby
 authors:
 - nov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-14 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