Module: ExTwitter::Utils

Included in:
Client
Defined in:
lib/ex_twitter/utils.rb

Constant Summary collapse

PROFILE_SAVE_KEYS = 
%i(
  id
  name
  screen_name
  location
  description
  url
  protected
  followers_count
  friends_count
  listed_count
  favourites_count
  utc_offset
  time_zone
  geo_enabled
  verified
  statuses_count
  lang
  status
  profile_image_url_https
  profile_banner_url
  profile_link_color
  suspended
  verified
  entities
  created_at
)
STATUS_SAVE_KEYS = 
%i(
  created_at
  id
  text
  source
  truncated
  coordinates
  place
  entities
  user
  contributors
  is_quote_status
  retweet_count
  favorite_count
  favorited
  retweeted
  possibly_sensitive
  lang
)

Instance Method Summary collapse

Instance Method Details

#__screen_name ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/ex_twitter/utils.rb', line 27

def __screen_name
  ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
    `ExTwitter::Utils#__screen_name` is deprecated.
  MESSAGE
  screen_name
end

#__uid ⇒ Object 



8
9
10
11
12
13
 
# File 'lib/ex_twitter/utils.rb', line 8

def __uid
  ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
    `ExTwitter::Utils#__uid` is deprecated.
  MESSAGE
  uid
end

#__uid_i ⇒ Object 



15
16
17
18
19
20
 
# File 'lib/ex_twitter/utils.rb', line 15

def __uid_i
  ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
    `ExTwitter::Utils#__uid_i` is deprecated.
  MESSAGE
  uid
end

#authenticating_user?(target) ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/ex_twitter/utils.rb', line 38

def authenticating_user?(target)
  user.id.to_i == user(target).id.to_i
end

#authorized_user?(target) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
 
# File 'lib/ex_twitter/utils.rb', line 42

def authorized_user?(target)
  target_user = user(target)
  !target_user.protected? || friendship?(user.id.to_i, target_user.id.to_i)
end

#call_old_method(method_name, *args) ⇒ Object 



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
 
# File 'lib/ex_twitter/utils.rb', line 53

def call_old_method(method_name, *args)
  options = args.extract_options!
  begin
    self.call_count += 1
    _options = {method_name: method_name, call_count: self.call_count, args: args}.merge(options)
    instrument('api call', args[0], _options) { send(method_name, *args, options) }
  rescue Twitter::Error::TooManyRequests => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} Retry after #{e.rate_limit.reset_in} seconds."
    raise e
  rescue Twitter::Error::ServiceUnavailable => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} #{e.message}"
    raise e
  rescue Twitter::Error::InternalServerError => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} #{e.message}"
    raise e
  rescue Twitter::Error::Forbidden => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} #{e.message}"
    raise e
  rescue Twitter::Error::NotFound => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} #{e.message}"
    raise e
  rescue => e
    logger.warn "#{__method__}: call=#{method_name} #{args.inspect} #{e.class} #{e.message}"
    raise e
  end
end

#collect_with_cursor(method_name, *args) ⇒ Object

friends, followers



101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/ex_twitter/utils.rb', line 101

def collect_with_cursor(method_name, *args)
  options = args.extract_options!
  last_response = call_old_method(method_name, *args, options).attrs
  return_data = (last_response[:users] || last_response[:ids])

  while (next_cursor = last_response[:next_cursor]) && next_cursor != 0
    options[:cursor] = next_cursor
    last_response = call_old_method(method_name, *args, options).attrs
    return_data += (last_response[:users] || last_response[:ids])
  end

  return_data
end

#collect_with_max_id(method_name, *args) ⇒ Object

user_timeline, search



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/ex_twitter/utils.rb', line 81

def collect_with_max_id(method_name, *args)
  options = args.extract_options!
  call_limit = options.delete(:call_limit) || 3
  last_response = call_old_method(method_name, *args, options)
  last_response = yield(last_response) if block_given?
  return_data = last_response
  call_count = 1

  while last_response.any? && call_count < call_limit
    options[:max_id] = last_response.last.kind_of?(Hash) ? last_response.last[:id] : last_response.last.id
    last_response = call_old_method(method_name, *args, options)
    last_response = yield(last_response) if block_given?
    return_data += last_response
    call_count += 1
  end

  return_data.flatten
end

#decode_json(json_str, caller_name, options = {}) ⇒ Object

decode



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/ex_twitter/utils.rb', line 262

def decode_json(json_str, caller_name, options = {})
  obj = json_str.kind_of?(String) ? JSON.parse(json_str) : json_str
  result =
    case
      when obj.nil?
        obj

      when obj.kind_of?(Array) && obj.first.kind_of?(Hash)
        obj.map { |o| Hashie::Mash.new(o) }

      when obj.kind_of?(Array) && obj.first.kind_of?(Integer)
        obj

      when obj.kind_of?(Hash)
        Hashie::Mash.new(obj)

      when obj === true || obj === false
        obj

      when obj.kind_of?(Array) && obj.empty?
        obj

      else
        raise "#{__method__}: caller=#{caller_name} key=#{options[:key]} obj=#{obj.inspect}"
    end
  result
end

#encode_json(obj, caller_name, options = {}) ⇒ Object

encode



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/ex_twitter/utils.rb', line 206

def encode_json(obj, caller_name, options = {})
  options[:reduce] = true unless options.has_key?(:reduce)
  result =
    case caller_name
      when :user_timeline, :home_timeline, :mentions_timeline, :favorites # Twitter::Tweet
        JSON.pretty_generate(obj.map { |o| o.attrs })

      when :search # Hash
        data =
          if options[:reduce]
            obj.map { |o| o.to_hash.slice(*STATUS_SAVE_KEYS) }
          else
            obj.map { |o| o.to_hash }
          end
        JSON.pretty_generate(data)

      when :friends, :followers # Hash
        data =
          if options[:reduce]
            obj.map { |o| o.to_hash.slice(*PROFILE_SAVE_KEYS) }
          else
            obj.map { |o| o.to_hash }
          end
        JSON.pretty_generate(data)

      when :friend_ids, :follower_ids # Integer
        JSON.pretty_generate(obj)

      when :verify_credentials # Twitter::User
        JSON.pretty_generate(obj.to_hash.slice(*PROFILE_SAVE_KEYS))

      when :user # Twitter::User
        JSON.pretty_generate(obj.to_hash.slice(*PROFILE_SAVE_KEYS))

      when :users, :friends_parallelly, :followers_parallelly # Twitter::User
        data =
          if options[:reduce]
            obj.map { |o| o.to_hash.slice(*PROFILE_SAVE_KEYS) }
          else
            obj.map { |o| o.to_hash }
          end
        JSON.pretty_generate(data)

      when :user? # true or false
        obj

      when :friendship? # true or false
        obj

      else
        raise "#{__method__}: caller=#{caller_name} key=#{options[:key]} obj=#{obj.inspect}"
    end
  result
end

#fetch_cache_or_call_api(method_name, user, options = {}) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/ex_twitter/utils.rb', line 290

def fetch_cache_or_call_api(method_name, user, options = {})
  key = namespaced_key(method_name, user, options)
  options.update(key: key)

  data =
    if options[:cache] == :read
      instrument('Cache Read(Force)', key, caller: method_name) { cache.read(key) }
    else
      cache.fetch(key, expires_in: 1.hour, race_condition_ttl: 5.minutes) do
        _d = yield
        instrument('serialize', key, caller: method_name) { encode_json(_d, method_name, options) }
      end
    end

  instrument('deserialize', key, caller: method_name) { decode_json(data, method_name, options) }
end

#file_cache_key(method_name, user, options = {}) ⇒ Object 



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
 
# File 'lib/ex_twitter/utils.rb', line 117

def file_cache_key(method_name, user, options = {})
  delim = ':'
  identifier =
    case
      when method_name == :verify_credentials
        "object-id#{delim}#{object_id}"
      when method_name == :search
        "str#{delim}#{user.to_s}"
      when method_name == :mentions_timeline
        "#{user.kind_of?(Integer) ? 'id' : 'sn'}#{delim}#{user.to_s}"
      when method_name == :home_timeline
        "#{user.kind_of?(Integer) ? 'id' : 'sn'}#{delim}#{user.to_s}"
      when method_name.in?([:users, :replying]) && options[:super_operation].present?
        case
          when user.kind_of?(Array) && user.first.kind_of?(Integer)
            "#{options[:super_operation]}-ids#{delim}#{Digest::MD5.hexdigest(user.join(','))}"
          when user.kind_of?(Array) && user.first.kind_of?(String)
            "#{options[:super_operation]}-sns#{delim}#{Digest::MD5.hexdigest(user.join(','))}"
          else raise "#{method_name.inspect} #{user.inspect}"
        end
      when user.kind_of?(Integer)
        "id#{delim}#{user.to_s}"
      when user.kind_of?(Array) && user.first.kind_of?(Integer)
        "ids#{delim}#{Digest::MD5.hexdigest(user.join(','))}"
      when user.kind_of?(Array) && user.first.kind_of?(String)
        "sns#{delim}#{Digest::MD5.hexdigest(user.join(','))}"
      when user.kind_of?(String)
        "sn#{delim}#{user}"
      when user.kind_of?(Twitter::User)
        "user#{delim}#{user.id.to_s}"
      else raise "#{method_name.inspect} #{user.inspect}"
    end

  "#{method_name}#{delim}#{identifier}"
end

#instrument(operation, key, options = nil) ⇒ Object 



47
48
49
50
51
 
# File 'lib/ex_twitter/utils.rb', line 47

def instrument(operation, key, options = nil)
  payload = {operation: operation, key: key}
  payload.merge!(options) if options.is_a?(Hash)
  ActiveSupport::Notifications.instrument('call.ex_twitter', payload) { yield(payload) }
end

#namespaced_key(method_name, user, options = {}) ⇒ Object 



153
154
155
 
# File 'lib/ex_twitter/utils.rb', line 153

def namespaced_key(method_name, user, options = {})
  file_cache_key(method_name, user, options)
end

#screen_name ⇒ Object

for backward compatibility



23
24
25
 
# File 'lib/ex_twitter/utils.rb', line 23

def screen_name
  @screen_name || user.screen_name
end

#uid ⇒ Object

for backward compatibility



4
5
6
 
# File 'lib/ex_twitter/utils.rb', line 4

def uid
  @uid || user.id.to_i
end

#uid_or_screen_name?(object) ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/ex_twitter/utils.rb', line 34

def uid_or_screen_name?(object)
  object.kind_of?(String) || object.kind_of?(Integer)
end