Merge pull request #105 from betacraft/fix_twitter_profile_images

Fix twitter profile images

app/helpers/application_helper.rb

@@ -1,5 +1,27 @@
 module ApplicationHelper
-  def get_twitter_image(twitter_handle)
-    image_tag "https://res.cloudinary.com/#{ENV['CLOUDINARY_HANDLE']}/image/twitter_name/#{twitter_handle}.jpg", onerror: 'this.error=null;this.src="https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"'
+  def get_twitter_image(user)
+    image_tag image_for_twitter_handle(user), onerror: 'this.error=null;this.src="https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png"'
+  end
+
+  private
+
+  RubyConfIndia2023 = Date.parse('2023-08-26')
+
+  def image_for_twitter_handle(user)
+    if user.updated_at.after?(RubyConfIndia2023) && user.image.present?
+      # this is a quick workaround for being unable to fetch images via Cloudinary for new twitter sign_ins due to Twitter API policy changes.
+      # one problem with continuing to use this long term would be:
+      #   - if a user changes their profile picture, the url saved on our model will become invalid
+      #      we do have a fallback to default image in place, but it's not ideal
+      #   - As an improvement, we can try to cache it (more like a permanent snapshot until their next login)
+      #   - But a proper solution would be to fetch their current profile picture via a service or to periodically refresh it ourself
+      user.image
+    else
+      cloudinary_image_url(user.twitter_handle)
+    end
+  end
+
+  def cloudinary_image_url(twitter_handle)
+    "https://res.cloudinary.com/#{ENV['CLOUDINARY_HANDLE']}/image/twitter_name/#{twitter_handle}.jpg"
   end
 end

app/models/user.rb

@@ -15,6 +15,10 @@ def find_for_twitter_oauth(auth)
       user = User.where(uid: auth.uid, provider: auth.provider).first
 
       if user
+        profile_image_url = auth["info"]["image"]
+        user.update(image: profile_image_url) if profile_image_url.present?
+
+        # TODO: handle exceptions later. For now, continue to sign in the user, regardless of whether image url is saved
         user
       else
         User.create(

app/views/home/index.html.haml

@@ -38,7 +38,7 @@
                     = time_ago_in_words letter.created_at
                     ago
               .pull-right.thumbnail.imageWrapper{ style: 'max-height: 50px; max-width: 50px' }
-                = get_twitter_image(letter.user.twitter_handle)
+                = get_twitter_image(letter.user)
 
         -#          TODO refactor this
         - unless letter.user_id == 43

app/views/layouts/application.html.haml

@@ -107,7 +107,7 @@
                     %tr
                       %td
                         .thumbnail.pull-left{ style: 'max-height: 50px; max-width: 50px' }
-                          = get_twitter_image(l.user.twitter_handle)
+                          = get_twitter_image(l.user)
                         .info.pull-left
                           = truncate("#{l.user.name} (#{l.user.twitter_handle})", length: 27)
                           %br

app/views/letters/show.html.haml

@@ -23,7 +23,7 @@
                   = time_ago_in_words @letter.created_at
                   ago
             .pull-right.thumbnail.imageWrapper{ style: 'max-height: 50px; max-width: 50px' }
-              = get_twitter_image(@letter.user.twitter_handle)
+              = get_twitter_image(@letter.user)
       = markdown(@letter.description)
       %br
       %div

config/initializers/devise.rb

@@ -211,9 +211,9 @@
   # Add a new OmniAuth provider. Check the wiki for more information on setting
   # up on your models and hooks.
   # config.omniauth :github, 'APP_ID', 'APP_SECRET', :scope => 'user,public_repo'
-  config.omniauth :twitter, ENV['TWITTER_CONSUMER_KEY'], ENV['TWITTER_CONSUMER_SECRET']
+  config.omniauth :twitter, ENV['TWITTER_CONSUMER_KEY'], ENV['TWITTER_CONSUMER_SECRET'],
+                  { secure_image_url: 'true', image_size: 'original' }
 
-
   # ==> Warden configuration
   # If you want to use other strategies, that are not supported by Devise, or
   # change the failure app, you can configure them inside the config.warden block.

config/routes.rb

@@ -13,6 +13,8 @@
     end
   end
 
+  get 'profile_picture/twitter/:twitter_handle', to: 'profile_picture#twitter', as: :twitter_image
+
   root 'home#index'
 
   # The priority is based upon order of creation:

spec/helpers/application_helper_spec.rb

@@ -11,11 +11,30 @@
 #   end
 # end
 RSpec.describe ApplicationHelper, type: :helper do
-  describe 'application heler' do
-    context 'get_twitter_image method' do
+  describe 'application helper' do
+    # actual context: We realized just in time before RubyConfIndia2023 that due to Twitter API changes
+    # we are unable to retrieve profile pictures for new twitter sign_ups through Cloudinary
+
+    context 'get_twitter_image for User who last signed in before RubyIndiaConf 2023' do
       it 'should render image tag with the twitter handle' do
-        twitter_handle = 'foobar'
-        expect(helper.get_twitter_image(twitter_handle)).to match("#{twitter_handle}\.jpg")
+        user = User.new(twitter_handle: 'my_twitter_handle', updated_at: Date.parse('2022-12-31').end_of_day)
+        expect(helper.get_twitter_image(user)).to match("cloudinary.*my_twitter_handle\.jpg")
+      end
+    end
+    context 'get_twitter_image for User who last signed in after RubyIndiaConf 2023' do
+      it 'should render image tag with twitter handle (in the unlikely case, our User model does not contain the image url)' do
+        user = User.new(twitter_handle: 'my_twitter_handle', updated_at: Date.parse('2024-01-01').end_of_day)
+        expect(helper.get_twitter_image(user)).to match("cloudinary.*my_twitter_handle\.jpg")
+      end
+      it 'should render image tag using the URL saved on the User model' do
+        user = User.new(
+          twitter_handle: 'my_twitter_handle',
+          image: 'https://pbs.twimg.com/profile_images/123456789/my_selfie.jpg',
+          updated_at: Date.parse('2024-01-01').end_of_day
+        )
+        image_url = helper.get_twitter_image(user)
+        expect(image_url).to_not match("my_twitter_handle\.jpg")
+        expect(image_url).to match("my_selfie\.jpg")
       end
     end
   end