RoR. Как правильно обработать ошибку приходящую от API?

Question

[Максим Валерьевич]

Всем привет. Есть у меня значит контроллер vk_tracks, в нем есть метод add, Этот метод добавляет аудиозапись к пользователю. Иногда при большом кол-ве запросов вылетает captcha и эту капчу надо обработать. Для vk api я пользуюсь этим гемом: https://github.com/7even/vkontakte_api
Все запросы выполняются через ajax.
Вот код:

def add
    @vk_track = VkTrack.find(params[:id])
    if params[:captcha]
      id = @vk.audio.add(audio_id: @vk_track.vk_id, owner_id: @vk_track.owner_id, captcha_sid: params[:captcha_sid], captcha_key: params[:captcha])
      respond_to do |format|
        format.html {}
        format.js   {}
      end
    else
      begin
        @vk.audio.add(audio_id: @vk_track.vk_id, owner_id: @vk_track.owner_id)

        respond_to do |format|
          format.html {}
          format.js   {}
        end
      rescue VkontakteApi::Error => @e
        if @e.error_code == 14
          respond_to do |format|
            # тут мы просто выводим модальное окно а в нем картинку с капчей и форму
            format.js { render :file => "vk_tracks/captcha.js.erb" }
          end
        else
          raise
        end
      end
    end
  end

Я в руби новенький и не могу понять как сделать правильно. Сейчас у меня при сработке капчи вылетает модальное окно с капчей и формой. Эта форма отправляет данные в тот же контроллер и метод. Есть ли путь проще? И как правильнее сделать обработку капчи.

Answer 1

[Ринат Шайхутдинов]

def add
  vk_track = VkTrack.find(params[:id])
  
  @vk.audio.add(audio_params(vk_track))
rescue VkontakteApi::Error => e
  raise e unless e.error_code == 14

  respond_to do |format|
    # Старайтесь не делать ваши вьюхи зависимыми от инстанс-переменных (@var)
    # По возможности, старайтесь использовать partials и передавать
    # зависимости явным образом
    # file: app/views/controller_name/_captcha.js.erb
    # в нем будет доступна переменная exception
    format.js { render partial: 'captcha', exception: e }
  end
end

def audio_params(vk_track)
  {
    audio_id: vk_track.vk_id,
    owner_id: vk_track.owner_id
  }.merge(captcha_params)
end

def captcha_params
  return {} unless params[:captha]

  {
    captcha_sid: params[:captcha_sid],
    captcha_key: params[:captcha]
  }
end

Скажу честно, я не проверял работоспособность кода, но вроде проблем возникнуть не должно никаких.

Comments

[Максим Валерьевич]

Красиво =) Спасибо.

[Максим Валерьевич]

И вот тут: format.js { render partial: 'captcha', exception: e }
Наверно так: format.js { render partial: 'captcha', locals: { exception: e } }

[Ринат Шайхутдинов]

Максим Валерьевич: да, Вы правы. Либо вот так: render partial: 'captcha', object: e и переменная тогда будет доступна с тем же именем, что и паршиал.

[Ринат Шайхутдинов]

Максим Валерьевич: подробнее можно почитать тут: guides.rubyonrails.org/layouts_and_rendering.html в разделе "3.4.4 Passing Local Variables".

[Максим Валерьевич]

Ринат Шайхутдинов: Ага, уже прочитал про это =)
А почему лучше использовать локальные переменные нежели инстанс?

[Ринат Шайхутдинов]

Максим Валерьевич: используя инстанс переменную вы создаете неявную зависимость от наличия переменной, в другом случае – явно передаете все необходимые зависимости во вьюху, что делает код более читаемым и переиспользуемым.

Есть ещё такое правило: "Share no more than two instance variables between a controller and a view.", его тоже неплохо придерживаться (одна переменная – объект, который нужно отрендерить, вторая – current_user обычно). Для тех же, собсно, целей, придумано.

Рекомендую ознакомиться на досуге с https://github.com/bbatsov/rails-style-guide и ruby style guide (гуглится легко), наверняка что-то интересное для себя почерпнете.

[Ринат Шайхутдинов]

а, да, ещё rails_best_practices посоветую (и как ресурс для чтения и как гем для проектов). теперь вроде всё :)

[Максим Валерьевич]

Ринат Шайхутдинов: Спасибо. style guide листал, но надо вникать серьезнее.
Трудно сразу делать правильно =) Сейчас вот программа работает, но исправляю чтоб было красиво. Да и не мешало бы тесты написать, но всё боюсь к ним приступать =)

[Ринат Шайхутдинов]

Максим Валерьевич: о, не так страшен черт как его малюют :) Жаль, в паре слов не рассказать, но направить в нужное русло могу: railscasts.com/episodes/275-how-i-test. Ну и вообще советую там подписку оформить, она стоит $6 в месяц (но т.к. эпизодов новых пока не выходит – платите только за 1 месяц), но оно того стоит, хоть и местами эти скринкасты устарели уже.

А, ещё очень хорошо upcase.com заходит при желании. Прогресс после него заметен невооруженным глазом, всех своих разработчиков туда отправляю.

[Ринат Шайхутдинов]

upd: $9, обманул

[Максим Валерьевич]

Ринат Шайхутдинов: Да, я там уже глядел не так мало скринкастов, но оформлять сейчас подписку вообще не вариант, ноль в кармане =) Работаю за еду и жилье... И одновременно учу ruby и rails. С тестами работал когда писал по этой книге: railstutorial.ru, пришлось код местами править, так как там руби 1.9 а я на 2.2 писал. В принципе было не страшно =)
Но сейчас пишу парсер музыки, пишу на коленке можно сказать, что в голову приходит то и реализовываю.
А вам не нужны новички на обучение с дальнейшей у вас работой? =)

[Ринат Шайхутдинов]

Максим Валерьевич: нам пока что только если миддлы нужны, готовы из них сеньёров вырастить и озадачить работой. Напишите мне через пару-тройку проектов сделанных, возможно, что-то сможем придумать или, как минимум, подскажу направления для дальнейшего развития.

[Максим Валерьевич]

Ринат Шайхутдинов: Хорошо. Спасибо =)