retriable_x 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3aca1612fd5c6ca9f4f7aa4c0bd7fadc3d0b105c7f22f9cfbebf02f9534c660d
-  data.tar.gz: 3905910316783c900a90f5db2dc8349a0c878eee2a3d3bb18e72a06c3cbb3c7f
+  metadata.gz: 92e750042df55480f9181738fc2f74f331146f90243d5cb7534bf61ed7630b9c
+  data.tar.gz: a1321fb9515f8013d6526a58b5919424b1f05b56716635dfc3df90a690093e54
 SHA512:
-  metadata.gz: 9a54bf01707af52ed15f3d03920309c7366ff7967e054aa31e39520d1cf271c56fd7a3ff414655cb7c3f7d4c97475a06f80e6ddb22d02970551791ab2398d4cf
-  data.tar.gz: 454ec863e48e73c742c1a35c13ef000a2ff2ebaea5252e461885d1f64bbe2c1e87812e8a21d6df0b070e5247245aa5c09df5bea1b139e46470fbcb949afdcf77
+  metadata.gz: b265ea6a5efecf64b46587093b28aa3e34c5e943aa32950f5f124aa177268d25cc2608d87b0c5dda4f4d859afd9a4b6b63656adf2ebe2fea4ac144747de02225
+  data.tar.gz: a0bdfa34e1f16986d04eae7be4bef87b6ede08c8610da96a49fdd224117232a5ca4249c5465b6bdf167c20b4eca422284467c2382fdaa8163c8f927971a59240

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
-## [0.1.0] - 2024-04-28
+## [0.1.1] - 2024-04-29
+
+- Change oauth2_client initialize
+
+
+## [0.1.0] - 2024-04-29
 
 - Initial release

data/lib/retriable_x/client.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'x'
+require "json"
+require "x"
 
 module RetriableX
+  # X Client
   class Client
     # @param access_token [String] OAuth2 access token
     # @param refresh_token [String] OAuth2 refresh token
@@ -19,27 +20,22 @@ module RetriableX
       @args = args
       @try_count = @args[:try_count] || 1
       @retry_delay = @args[:retry_delay] || 0
-      @client = RetriableX::Client::make_client(@args)
+      @client = make_client(@args)
     end
 
-    def me()
-      execute do |count|
+    def me
+      execute do |_count|
         @client.get("users/me")
       end
     end
 
     def follow_check_screenname(screenname)
-      res = execute do |count|
+      res = execute do |_count|
         @client.get("users/by/username/#{screenname}?user.fields=connection_status")
       end
       follow?(res)
     end
 
-    def refresh(refresh_token)
-      @client.refresh_token = refresh_token
-      @client.access_token!
-    end
-
     private
 
     def execute
@@ -47,31 +43,32 @@ module RetriableX
       refreshed_flag = false
       loop do
         return yield(count)
-      rescue => e
-        if e.is_a?(X::Unauthorized)
-          # try once refresh
-          if is_refresh?() && !refreshed_flag
-            refreshed_flag = true
-            refresh()
-            continue
-          else
-            raise e
-          end
-        end
-        raise e if @try_count <= count
-        count += 1
-        sleep @retry_delay if @retry_delay > 0
+      rescue StandardError => e
+        count, refreshed_flag = check_err(e, count, refreshed_flag)
+      end
+    end
+
+    def check_err(err, count, refreshed_flag)
+      if err.is_a?(X::Unauthorized)
+        raise err unless refresh? && !refreshed_flag
+
+        refresh
+        return [count, true]
       end
+      raise err if @try_count <= count
+
+      sleep @retry_delay if @retry_delay.positive?
+      [count + 1, refreshed_flag]
     end
 
-    def is_refresh?
+    def refresh?
       !@args[:refresh_token].nil? &&
         !@args[:client_key].nil? &&
         !@args[:client_secret].nil?
     end
 
     def refresh
-      client = RetriableX::Oauth2Client::new(@args[:client_key], @args[:client_secret], '')
+      client = RetriableX::Oauth2Client.new(@args)
       token = client.refresh(@args[:refresh_token])
       @args[:refresh_token] = token.refresh_token
       @args[:access_token] = token.access_token
@@ -83,20 +80,23 @@ module RetriableX
       connection_status.include?("following")
     end
 
-    def self.make_client(args)
+    def make_client(args)
       if !args[:api_key].nil?
-        X::Client.new(
-          api_key: args[:consumer_key],
-          api_key_secret: args[:consumer_secret],
-          access_token: args[:access_key],
-          access_token_secret: args[:access_secret] )
+        make_client_oauth1(args)
       elsif !args[:access_token].nil?
         X::Client.new(bearer_token: args[:access_token])
       else
         raise "OAuth key not found"
       end
     end
+
+    def make_client_oauth1(args)
+      X::Client.new(
+        api_key: args[:consumer_key],
+        api_key_secret: args[:consumer_secret],
+        access_token: args[:access_key],
+        access_token_secret: args[:access_secret]
+      )
+    end
   end
 end
-
-

data/lib/retriable_x/oauth2_client.rb

@@ -1,14 +1,19 @@
 # frozen_string_literal: true
 
-require 'twitter_oauth2'
+require "twitter_oauth2"
 
 module RetriableX
+  # OAuth2 Client
   class Oauth2Client
-    def initialize(client_id, client_secret, redirect_uri)
+    # @param client_key [String] OAuth2 client_key
+    # @param client_secret [String] OAuth2 client_secret
+    # @param redirect_uri [String] OAuth2 redirect_uri
+    def initialize(**args)
+      @args = args
       @client = TwitterOAuth2::Client.new(
-        identifier: client_id,
-        secret: client_secret,
-        redirect_uri: redirect_uri
+        identifier: @args[:client_id],
+        secret: @args[:client_secret],
+        redirect_uri: @args[:redirect_uri] || ""
       )
     end
 
@@ -17,12 +22,12 @@ module RetriableX
       [authorization_uri, @client.code_verifier, @client.state]
     end
 
-    def access_token(code, code_verifier)
+    def access_token!(code, code_verifier)
       @client.authorization_code = code
       @client.access_token! code_verifier
     end
 
-    def refresh(refresh_token)
+    def refresh!(refresh_token)
       @client.refresh_token = refresh_token
       @client.access_token!
     end

data/lib/retriable_x/scope.rb

@@ -2,29 +2,30 @@
 
 module RetriableX
   module Scope
-    TweetRead = :"tweet.read"
-    TweetWrite = :"tweet.write"
-    TweetModerateWrite = :"tweet.moderate.write"
-    UsersRead = :"users.read"
-    FollowsRead = :"follows.read"
-    FollowsWrite = :"follows.write"
-    OfflineAccess = :"offline.access"
-    SpaceRead = :"space.read"
-    MuteRead = :"mute.read"
-    MuteWrite = :"mute.write"
-    LikeRead = :"like.read"
-    LikeWrite = :"like.write"
-    ListRead = :"list.read"
-    ListWrite = :"list.write"
-    BlockRead = :"block.read"
-    BlockWrite = :"block.write"
-    BookmarkRead = :"bookmark.read"
-    BookmarkWrite = :"bookmark.write"
-    DmRead = :"dm.read"
-    DmWrite = :"dm.write"
+    TWEET_READ = :"tweet.read"
+    TWEET_WRITE = :"tweet.write"
+    TWEET_MODERATE_WRITE = :"tweet.moderate.write"
+    USERS_READ = :"users.read"
+    FOLLOWS_READ = :"follows.read"
+    FOLLOWS_WRITE = :"follows.write"
+    OFFLINE_ACCESS = :"offline.access"
+    SPACE_READ = :"space.read"
+    MUTE_READ = :"mute.read"
+    MUTE_WRITE = :"mute.write"
+    LIKE_READ = :"like.read"
+    LIKE_WRITE = :"like.write"
+    LIST_READ = :"list.read"
+    LIST_WRITE = :"list.write"
+    BLOCK_READ = :"block.read"
+    BLOCK_WRITE = :"block.write"
+    BOOKMARK_READ = :"bookmark.read"
+    BOOKMARK_WRITE = :"bookmark.write"
+    DM_READ = :"dm.read"
+    DM_WRITE = :"dm.write"
   end
 
   module Scopes
-    FollowCheck = [RetriableX::Scope::TweetRead, RetriableX::Scope::UsersRead, RetriableX::Scope::OfflineAccess]
+    FOLLOW_CHECK = [RetriableX::Scope::TWEET_READ, RetriableX::Scope::USERS_READ,
+                    RetriableX::Scope::OFFLINE_ACCESS].freeze
   end
 end

data/lib/retriable_x/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RetriableX
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/retriable_x.rb

@@ -5,7 +5,6 @@ require_relative "retriable_x/oauth2_client"
 require_relative "retriable_x/scope"
 require_relative "retriable_x/version"
 
-
 module RetriableX
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable_x
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - aoyagikouhei
@@ -73,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="