twttr 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e5bcf2caf8b35685648f7ea2f2e3ded03f29a2d645c3fefd0dd201c40a29063
-  data.tar.gz: e4abe1c561235477fa18e53a99712f6c81dff499a084597f05c076a7db47bdc1
+  metadata.gz: f243e0ac613090cfeabaeb49b72f9fa3cca1b210bf8578313d23ce264f7fb76e
+  data.tar.gz: 320ed5bcce042083e80be627237eab12459d3694a86b3033b576b03f65f6eca2
 SHA512:
-  metadata.gz: ba330361302ab0f8cb28ab17235baae529674fd02b766a6e55c5e48b10fd960d682b4efcb05d594216cf40288606fb87f77b50fbe8f2ef66cfde75d2a075165a
-  data.tar.gz: '04890ed05e20b2e710d3a3f7697b21823542da9e8e88e35e9361a73251d89b1a18a12a0dddd3dbf031cf390a3d344894b775cb80daf1b37978993c8e2d3ad6f5'
+  metadata.gz: 36181b93842dd22bdf49759f92e970a63b59121e3a025d229820fe75e0ce101d6eeafdb87459c063d3826b86d23e5908601d2ffb1f0e2a7e83da4261c4182cce
+  data.tar.gz: 8e44f6b807d3abe417b78a563bb341ba3297a193701846a06885ef6cf8f590bb16720d84647c9b723b51bb91d7c7ac2c519054bd042b59a8789ed6e1293eabbd

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

@@ -13,31 +13,33 @@ module Twttr
             # GET /2/users/:id/following
             # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
             #
+            # Returns paginated list of users followed by user_id.
+            #
             # @param user_id [String] The user ID whose following 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>] Users followed by page.
+            # @yield [String,NilClass] Pagination token.
             # @return [Array<Twttr::Model::User>] Users followed.
-            # @return [String,NilClass] Pagination token.
-            def following(user_id, max_results: nil, pagination_token: nil) # rubocop:disable Metrics/MethodLength
-              loop do
-                response = get(FOLLOWING_PATH, params: { user_id: user_id },
-                                               query_params: {
-                                                 'user.fields': config.user_fields,
-                                                 max_results: max_results,
-                                                 pagination_token: pagination_token
-                                               }.compact)
+            def following(user_id, max_results: nil, pagination_token: nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+              response = get(FOLLOWING_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) }
+              users = response['data'].map { |v| Model::User.new(v, self) }
 
-                pagination_token = response['meta']['pagination_token']
+              pagination_token = response['meta']['pagination_token']
 
-                return users, pagination_token unless block_given?
+              yield users, pagination_token if block_given?
 
-                yield users, pagination_token
+              return users if pagination_token.nil?
 
-                break if pagination_token.nil?
-              end
+              users + following(user_id, pagination_token: pagination_token, &block)
             end
           end
         end

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

@@ -12,23 +12,62 @@ module Twttr
           USER_BY_USERNAME_PATH = "#{V2::V2_PATH}/users/by/username/%<username>s"
           USER_PATH = "#{V2::V2_PATH}/users/%<user_id>s"
 
+          # GET /2/users/:id/following
+          # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
+          #
+          # Returns paginated list of users followed by user_id.
+          #
+          # @param user_id [String] The user ID whose following 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>] Users followed by page.
+          # @yield [String,NilClass] Pagination token.
+          # @return [Array<Twttr::Model::User>] Users followed.
+
+          # GET /2/users/me
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me
+          #
+          # Returns current authenticated user
+          #
+          # @return [Twttr::Model::User] Current user.
           def me
             response = get(ME_PATH, query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users/:id
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id
+          #
+          # Returns target user by id
+          #
+          # @param user_id [String] Traget user id.
+          # @return [Twttr::Model::User] Target user.
           def user(user_id)
             response = get(USER_PATH, params: { user_id: user_id },
                                       query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users/by/username/:username
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username
+          #
+          # Returns target user by username
+          #
+          # @param username [String] Traget username.
+          # @return [Twttr::Model::User] Target user.
           def user_by_username(username)
             response = get(USER_BY_USERNAME_PATH, params: { username: username },
                                                   query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users
+          #
+          # Returns target users by id
+          #
+          # @param user_ids [Array<String>] Traget user ids.
+          # @return [Array<Twttr::Model::User>] Target users.
           def users(user_ids)
             response = get(USERS_PATH,
                            query_params: { ids: user_ids.join(','), 'user.fields': config.user_fields })

data/lib/twttr/model/user.rb

@@ -15,8 +15,20 @@ module Twttr
         @client = client
       end
 
-      def following(pagination_token: nil, &block)
-        client.following(id, pagination_token: pagination_token, &block)
+      # Forwards to Follows#following setting user_id to current user's id.
+      #
+      # GET /2/users/:id/following
+      # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
+      #
+      # Returns paginated list of users followed by 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>] Users followed by page.
+      # @yield [String,NilClass] Pagination token.
+      # @return [Array<Twttr::Model::User>] Users followed.
+      def following(max_results: nil, pagination_token: nil, &block)
+        client.following(id, max_results: max_results, pagination_token: pagination_token, &block)
       end
 
       private

metadata

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