Address review comments

Author: stefannibrasil

doc/default/x.md

@@ -1,8 +1,8 @@
-`Faker::Twitter` has been deprecated. While it's still maintained, its docs can be found at [Faker::Twitter](#fakertwitter).
+`Faker::Twitter` has been deprecated in favor of `Faker::X`. While it's still maintained, its docs can be found at [Faker::Twitter](#fakertwitter).
 
 # Faker::X
 
-Generates approximate X (previous Twitter) user and tweet objects, based on X's API v2 responses.
+Generates approximate X (previously Twitter) user and tweet objects, based on X's API v2 responses.
 
 The generators are not a comprehensive match of the API. However, they are enough to create a demo app using X’s user or tweet data, for example.
 

lib/faker/default/twitter.rb

@@ -246,7 +246,7 @@ def user
                 },
                 username: screen_name,
                 pinned_tweet_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
-                entities: entities(url: url),
+                entities: user_entities,
                 description: Faker::Lorem.sentence,
                 name: Faker::Name.name,
                 verified: Faker::Boolean.boolean(true_ratio: 0.1),
@@ -277,38 +277,21 @@ def user
       # @faker.version 1.7.3
       def tweet(include_media: false, include_user: false)
         tweet = {}
-        conversation_id = id.to_s
-
-        data = [
-          {
-            id: conversation_id,
-            text: Faker::Lorem.sentence,
-            lang: Faker::Address.country_code,
-            conversation_id: conversation_id,
-            created_at: created_at,
-            public_metrics: {
-              retweet_count: Faker::Number.between(to: 1, from: 100),
-              reply_count: Faker::Number.between(to: 1, from: 20),
-              like_count: Faker::Number.between(to: 1, from: 25),
-              quote_count: Faker::Number.between(to: 1, from: 10)
-            },
-            possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
-            entities: entities(url: url),
-            in_reply_to_user_id: Faker::Boolean.boolean(true_ratio: 0.1)
-          }
-        ]
-
-        tweet[:data] = data
+        tweet_object = tweet_item
         includes = {}
 
         if include_media
           media_key = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s
 
           includes[:media] = media(media_key)
-          tweet[:data] << { attachments: { media_keys: [media_key] } }
+          tweet_object[:attachments] = { media_keys: [media_key] }
         end
 
-        includes[:users] = Faker::X.user[:includes][:users] if include_user
+        includes[:users] = user[:includes][:users] if include_user
+
+        tweet[:data] = [
+          tweet_object
+        ]
 
         unless includes.empty?
           tweet[:includes] = includes
@@ -337,52 +320,82 @@ def id
       end
 
       def created_at
-        Faker::Date.between(from: '2006-03-21', to: ::Date.today).strftime('%Y-%m-%dT%H:%M:%S%:z')
+        Faker::Date.between(from: '2006-03-21', to: ::Date.today).to_time.utc.iso8601(3)
       end
 
       def url
         "https://t.co/#{Faker::Lorem.characters(number: 10)}"
       end
 
-      def entities(url:)
-        display_url = Faker::Internet.url(host: 'example.com')
+      def user_entities
+        entities = tweet_entities
 
         {
           url: {
-            urls: [
-              {
-                url: url,
-                expanded_url: display_url,
-                display_url: display_url.sub('http://', '')
-              }
-            ]
+            urls: entities[:urls]
           },
           description: {
-            hashtags: [
-              {
-                tag: Faker::Lorem.word.capitalize
-              }
-            ]
+            hashtags: entities[:hashtags]
           }
         }
       end
 
+      def tweet_entities
+        display_url = Faker::Internet.url(host: 'example.com')
+
+        {
+          urls: [
+            {
+              start: 0,
+              end: 5,
+              url: url,
+              expanded_url: display_url,
+              display_url: display_url.sub('http://', '')
+            }
+          ],
+          hashtags: [
+            {
+              start: 0,
+              end: 5,
+              tag: Faker::Lorem.word.capitalize
+            }
+          ]
+        }
+      end
+
       def media(media_key)
         expanded_url = Faker::LoremFlickr.image(size: '1064x600')
 
         [{
-          type: 'photo',
-          indices: [103, 126],
           height: Faker::Number.between(to: 1, from: 1000),
           media_key: media_key,
+          type: 'photo',
           preview_image_url: expanded_url,
           width: Faker::Number.between(to: 1, from: 2000),
-          url: "https://t.co/#{Faker::Lorem.characters(number: 10)}",
-          expanded_url: expanded_url,
-          display_url: expanded_url.sub('https://', ''),
           alt_text: Faker::Lorem.sentence
         }]
       end
+
+      def tweet_item
+        conversation_id = id.to_s
+
+        {
+          id: conversation_id,
+          text: Faker::Lorem.sentence,
+          lang: sample(%w[en fr es pt it ja]),
+          conversation_id: conversation_id,
+          created_at: created_at,
+          author_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
+          public_metrics: {
+            retweet_count: Faker::Number.between(to: 1, from: 100),
+            reply_count: Faker::Number.between(to: 1, from: 20),
+            like_count: Faker::Number.between(to: 1, from: 25),
+            quote_count: Faker::Number.between(to: 1, from: 10)
+          },
+          possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
+          entities: tweet_entities
+        }
+      end
     end
   end
 end