File: x.rb

package info (click to toggle)
ruby-faker 3.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 9,360 kB
  • sloc: ruby: 20,654; makefile: 6; sh: 6
file content (189 lines) | stat: -rw-r--r-- 5,498 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# frozen_string_literal: true

module Faker
  class X < Base
    class << self
      ##
      # Produces a random X user based on X's v2 API.
      #
      # @return [Hash]
      #
      # @example
      #   Faker::X.user #=>  { data: [{:id=>"8821452687517076614", :name=>"Lincoln Paucek", :screen_name=>"cody"...
      #
      # @faker.version 1.7.3
      def user
        author_id = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)

        {
          data: [
            {
              author_id: author_id.to_s,
              id: id.to_s,
              text: Faker::Lorem.sentence
            }
          ],
          includes: {
            users: [
              {
                public_metrics: {
                  followers_count: Faker::Number.between(to: 1, from: 1_000),
                  following_count: Faker::Number.between(to: 1, from: 200),
                  tweet_count: Faker::Number.between(to: 1, from: 10_000),
                  listed_count: Faker::Number.between(to: 1, from: 1_000)
                },
                username: screen_name,
                pinned_tweet_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
                entities: user_entities,
                description: Faker::Lorem.sentence,
                name: Faker::Name.name,
                verified: Faker::Boolean.boolean(true_ratio: 0.1),
                location: Faker::Internet.public_ip_v4_address,
                id: author_id.to_s,
                protected: Faker::Boolean.boolean(true_ratio: 0.1),
                url: url,
                profile_image_url: Faker::Avatar.image(slug: id, size: '48x48'),
                created_at: created_at
              }
            ]
          }
        }
      end

      ##
      # Produces a random X tweet with default attributes.
      #
      # @param include_user [Boolean] Include user details
      # @param include_media [Boolean] Include user media (photo) details
      # @return [Hash]
      #
      # @example
      #   Faker::X.tweet #=> { data: [{:id=>"8821452687517076614", :text=>"Ea et laboriosam vel non."...
      #   Faker::X.tweet(include_media: true) # Get a tweet object with a photo media attachment
      #   Faker::X.tweet(include_user: true) # Get a tweet object with an user details
      #
      # @faker.version 1.7.3
      def tweet(include_media: false, include_user: false)
        tweet = {}
        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_object[:attachments] = { media_keys: [media_key] }
        end

        includes[:users] = user[:includes][:users] if include_user

        tweet[:data] = [
          tweet_object
        ]

        unless includes.empty?
          tweet[:includes] = includes
        end

        tweet
      end

      ##
      # Produces a random screen_name.
      #
      # @return [String]
      #
      # @example
      #   Faker::X.screen_name #=> "audreanne_hackett"
      #
      # @faker.version 1.7.3
      def screen_name
        Faker::Internet.username(specifier: nil, separators: ['_'])[0...20]
      end

      private

      def id
        Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)
      end

      def created_at
        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 user_entities
        entities = tweet_entities

        {
          url: {
            urls: entities[:urls]
          },
          description: {
            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')

        [{
          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),
          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