twttr 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e199840acca6799e8d3e0e5624510cf9f1a0ba060177dad0b24d9b37b57fb0d9
-  data.tar.gz: 29a188421066cf6de970656874f8cc36d238f5aba1b51430c7d6a019618597bf
+  metadata.gz: a0b322657f3a30ce0b0d95982d37f869bac57f5a388cd72bd5ec0674ffd280ec
+  data.tar.gz: f5a7ceef4eed89d1f62200c27e1a793474721c9dffc2abf074fb04372917541a
 SHA512:
-  metadata.gz: 4bd17869256489e6c5878173cab9251b10bdce1332442cc4d35da4cbc566a8948171ae4bfcc953e368dc85180afe36753468ffa2ec808b25ec34b8e3f51aee2d
-  data.tar.gz: e291aa2e6bdbfe2fd7b350e092e729c33f0e342eb4f2091f62b1ce2ac51cec35fb3b7467e2b57b3fdd5b658a740c31a0debae7b750d84c9c8166d2aef1a8cb69
+  metadata.gz: 3d93cfe971f58080b87a2213c2a46249b931e89e192d9115287a61e78decc48893449f9c8803557b07abffdd457f09b71c96c68040a5de95cc4ef6fc06c81597
+  data.tar.gz: 940d45503a781eaf9efdb4ef246b23c386219ca0bdfc69b0d9f0e36cb6cec444f868d24e822307ba8e15c73a8a779cba6a9ea44bc5288e7f772f8d1d5ba8162a

data/lib/twttr/client/endpoint/v2/users/follows.rb

@@ -8,8 +8,41 @@ module Twttr
           # Twitter API V2 User Follow related endpoints
           # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference
           module Follows
+            FOLLOWERS_PATH = "#{Users::USER_PATH}/followers"
             FOLLOWING_PATH = "#{Users::USER_PATH}/following"
 
+            # GET /2/users/:id/followers
+            # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers
+            #
+            # Returns paginated list of users following user_id.
+            #
+            # @param user_id [String] The user ID whose followers you would like to retrieve.
+            # @param max_results [Integer] Max number of results per peage.
+            # @param pagination_token [String] Initial page pagination token.
+            # @yield [Array<Twttr::Model::User>] User followers page.
+            # @yield [String,NilClass] Pagination token.
+            # @return [Array<Twttr::Model::User>] Follower Users.
+            def followers(user_id, max_results: nil, pagination_token: nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              response = get(FOLLOWERS_PATH, params: { user_id: user_id },
+                                             query_params: {
+                                               'user.fields': config.user_fields,
+                                               max_results: max_results,
+                                               pagination_token: pagination_token
+                                             }.compact)
+
+              return [] if response['meta']['result_count'].zero?
+
+              users = response['data'].map { |v| Model::User.new(v, self) }
+
+              pagination_token = response['meta']['pagination_token']
+
+              yield users, pagination_token if block_given?
+
+              return users if pagination_token.nil?
+
+              users + followers(user_id, pagination_token: pagination_token, &block)
+            end
+
             # GET /2/users/:id/following
             # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
             #
@@ -29,7 +62,7 @@ module Twttr
                                                pagination_token: pagination_token
                                              }.compact)
 
-              return [], nil if response['meta']['result_count'].zero?
+              return [] if response['meta']['result_count'].zero?
 
               users = response['data'].map { |v| Model::User.new(v, self) }
 

data/lib/twttr/client/endpoint/v2/users.rb

@@ -9,6 +9,7 @@ module Twttr
         module Users
           ME_PATH = "#{V2::V2_PATH}/users/me"
           USERS_PATH = "#{V2::V2_PATH}/users"
+          USERS_BY_PATH = "#{V2::V2_PATH}/users/by"
           USER_BY_USERNAME_PATH = "#{V2::V2_PATH}/users/by/username/%<username>s"
           USER_PATH = "#{V2::V2_PATH}/users/%<user_id>s"
 
@@ -73,6 +74,19 @@ module Twttr
                            query_params: { ids: user_ids.join(','), 'user.fields': config.user_fields })
             response['data'].map { |v| Model::User.new(v, self) }
           end
+
+          # GET /2/users/by
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by
+          #
+          # Returns target users by username
+          #
+          # @param usernames [Array<String>] Traget usernames.
+          # @return [Array<Twttr::Model::User>] Target users.
+          def users_by(usernames)
+            response = get(USERS_BY_PATH,
+                           query_params: { usernames: usernames.join(','), 'user.fields': config.user_fields })
+            response['data'].map { |v| Model::User.new(v, self) }
+          end
         end
       end
     end

data/lib/twttr/model/user.rb

@@ -15,6 +15,20 @@ module Twttr
         @client = client
       end
 
+      # GET /2/users/:id/followers
+      # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers
+      #
+      # Returns paginated list of users following user_id.
+      #
+      # @param max_results [Integer] Max number of results per peage.
+      # @param pagination_token [String] Initial page pagination token.
+      # @yield [Array<Twttr::Model::User>] User followers page.
+      # @yield [String,NilClass] Pagination token.
+      # @return [Array<Twttr::Model::User>] Follower Users.
+      def followers(max_results: nil, pagination_token: nil, &block)
+        client.followers(id, max_results: max_results, pagination_token: pagination_token, &block)
+      end
+
       # Forwards to Follows#following setting user_id to current user's id.
       #
       # GET /2/users/:id/following

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twttr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Roberto Decurnex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth