vkontakte_api: VK API के लिए रूबी एडाप्टर

इस वर्ष की शुरुआत में, मुझे एक रेल एप्लिकेशन से वीके एपीआई के साथ काम करने की आवश्यकता थी। काश, मुझे ऐसा कोई रत्न नहीं मिला जो मुझे अनुकूल लगे: कहीं न कहीं मुझे कैमलकेस में तरीकों के नाम लिखने के लिए मजबूर किया गया था (जो रूबी कोड में अप्राकृतिक दिखता है), कहीं न कहीं यह प्राधिकरण पुस्तकालय से गुजरना अनिवार्य है (इस तथ्य के बावजूद कि मैंने ओम्न्यूथ का इस्तेमाल किया था ) और आम तौर पर हर जगह, एपीआई तक पहुँचने के लिए, हार्डकोड Net::HTTP , जो इवेंट मशीन रिएक्टर को अवरुद्ध करता था, जिसे मैं तब निशाना बनाता था। साथ ही, प्रलेखन के संदर्भ में, किसी कारण से सब कुछ बहुत दुखद था, और मुझे लगातार स्रोत कोड पढ़ना पड़ा।

तो vkontakte_api का जन्म हुआ। रेल परियोजना, जो इस पुस्तकालय को लिखने के बहाने के रूप में काम करती थी, पहले से ही आराम करने में कामयाब रही - लेकिन मणि रहता है और विकसित करना जारी है, जुलाई में 1.0 संस्करण तक पहुंच गया (जो महत्वपूर्ण परिवर्तनों के लिए एक बहाने के रूप में सेवा की)। faraday का उपयोग करते हुए, प्रोग्रामर के लिए पिछले पैराग्राफ में उल्लिखित निर्णयों को न लेकर, पुस्तकालय किसी भी एपीआई विधियों को कॉल करने, VKontakte सर्वर और वैकल्पिक प्राधिकरण में फाइल अपलोड करने का समर्थन करता है।

आइए देखें कि vkontakte_api का उपयोग करके एपीआई के साथ कैसे काम किया जाए। एक उदाहरण एक साधारण वेब एप्लिकेशन होगा जो OAuth2 प्राधिकरण पारित कर चुके उपयोगकर्ता के मित्रों ( दोस्तों ) और दोस्तों ( मित्रों ) की सूची (समूह) को एक समाचार फ़ीड (एपीआई विधि न्यूजफीड.गेट ) प्रदर्शित करता है। और यह कुछ इस तरह दिखेगा:

समायोजन

प्राधिकरण एप्लिकेशन आईडी और सुरक्षित कुंजी का उपयोग करता है, जिसे VKontakte पर एप्लिकेशन संपादन पृष्ठ पर प्राप्त किया जा सकता है; साथ ही रीडायरेक्ट_यूरी, जिसे बाद में वर्णित किया जाएगा। ये पैरामीटर VkontakteApi.configure ब्लॉक में निर्दिष्ट किए गए हैं, जो आसानी से config/initializers/vkontakte_api.rb में स्थित है; रेल एप्लिकेशन में, आप इस फाइल को बिल्ट-इन जनरेटर का उपयोग करके डिफ़ॉल्ट सेटिंग्स के साथ जेनरेट कर सकते हैं।

 $ rails generate vkontakte_api:install 

सेटिंग्स निम्नानुसार इंगित की गई हैं।

 # config/initializers/vkontakte_api.rb VkontakteApi.configure do |config| config.app_id = '123' # ID  config.app_secret = 'AbCdE654' #   config.redirect_uri = 'http://vkontakte-on-rails.herokuapp.com/callback' end 

(वास्तव में, बहुत अधिक विकल्प उपलब्ध हैं, लेकिन बाकी की यहां आवश्यकता नहीं होगी)

प्राधिकरण

आपको केवल VKontakte के माध्यम से साइट पर omniauth इन करना होगा, इसलिए omniauth का उपयोग omniauth व्यावहारिक नहीं होगा - हम vkontakte_api की क्षमताओं का उपयोग करते हैं।

VKontakte पर एप्लिकेशन का प्राधिकरण OAuth2 प्रोटोकॉल का उपयोग करता है। इसका अर्थ है कि प्राधिकरण के परिणामस्वरूप, एक एक्सेस टोकन प्राप्त किया जाएगा, जिसे एपीआई विधियों को कॉल करते समय स्थानांतरित किया जाना चाहिए।

इसे प्राप्त करने की योजना इस प्रकार है: उपयोगकर्ता VKontakte पर प्राधिकरण पृष्ठ के लिंक का अनुसरण करता है, "अनुमति दें" बटन पर क्लिक करके अपने (उपयोगकर्ता) डेटा को एप्लिकेशन एक्सेस देने के लिए सहमत होता है, और VKontakte URL पर code पैरामीटर पारित करते हुए, एप्लिकेशन पर वापस रीडायरेक्ट करता है। इसके अलावा, एप्लिकेशन, इस कोड का उपयोग करते हुए, एक अलग अनुरोध में उपयोगकर्ता user_id टोकन और user_id प्राप्त करता है और सत्र में उन्हें बचाता है।

CSRF हमलों से बचाने के लिए, OAuth2 प्रोटोकॉल एक सुरक्षित स्थान पर इसे सहेजने के बाद, प्राधिकरण के लिए उपयोगकर्ता को भेजते समय अपरिवर्तित मूल्य के साथ state पैरामीटर पारित करने की सिफारिश करता है; और जब उपयोगकर्ता वापस लौटता है, तो सहेजे गए मान के साथ पैरामीटर में प्राप्त state जांच करें।

तो, लॉगिन पृष्ठ पर आपको VKontakte पर एप्लिकेशन प्राधिकरण पृष्ठ पर जाने वाले लिंक को प्रदर्शित करना होगा। vkontakte_api इस पृष्ठ पर URL उत्पन्न करने के लिए VkontakteApi.authorization_url सहायक प्रदान करता है; मापदंडों में आपको scope पारित करने की आवश्यकता है - ये अधिकार हैं जो आवेदन प्राप्त करेंगे, वर्णों के एक सरणी के रूप में (या अल्पविराम द्वारा अलग किए गए नामों के साथ तार) - और ऊपर वर्णित state ।

 # app/controllers/sessions_controller.rb class SessionsController < ApplicationController def new #   state srand session[:state] ||= Digest::MD5.hexdigest(rand.to_s) #  URL   @vk_url = VkontakteApi.authorization_url(scope: [:friends, :groups, :offline, :notify], state: session[:state]) end end 

 <!-- app/views/sessions/new.html.erb --> <%= link_to @vk_url, class: 'btn btn-primary' do %> <i class="icon-home icon-white"></i>    <% end %> 

यहां यह ध्यान दिया जाना चाहिए कि कुछ अज्ञात कारणों से VKontakte state अनदेखा करता state यदि notify scope में निर्दिष्ट नहीं है।

जब उपयोगकर्ता आवेदन के अधिकारों की पुष्टि करता है, तो उसे सेटिंग्स में पहले बताए गए रीडायरेक्ट_यूरी पर भेज दिया जाएगा (जिसमें SessionsController#callback लिए रास्ता शामिल है), और state और code पैरामीटर URL पर पारित हो जाएंगे। जैसा कि ऊपर उल्लेख किया गया है, state को पहले से ही सहेजे गए के खिलाफ जांच करने की आवश्यकता है; और अधिक विस्तार से code पर रहते हैं।

कोड का उपयोग करके, आप एक पहुंच टोकन प्राप्त कर सकते हैं, इसके लिए आपको VKontakte के लिए एक अनुरोध पूरा करना होगा। उपयोगकर्ता किसी भी तरह से इस अनुरोध में भाग नहीं लेता है - यह अनुरोध हमारे सर्वर से सीधे vk.com पर जाता है। इसके लिए, vkontakte_api एक सहायक भी प्रदान करता है - VkontakteApi.authorize , एकमात्र पैरामीटर कुख्यात code ।

 # encoding: utf-8 class SessionsController < ApplicationController def callback #  state if session[:state].present? && session[:state] != params[:state] redirect_to root_url, alert: ' ,    .' and return end #   @vk = VkontakteApi.authorize(code: params[:code]) #      session[:token] = @vk.token #   id    -    session[:vk_id] = @vk.user_id redirect_to root_url end end 

जब कोई उपयोगकर्ता हमारे आवेदन से बाहर निकलता है, तो हम केवल सत्र को साफ करते हैं:

 class SessionsController < ApplicationController def destroy session[:token] = nil session[:vk_id] = nil redirect_to root_url end end 

टोकन प्राप्त होता है, आप एपीआई के साथ ही काम कर सकते हैं।

एपीआई विधि कॉल

एपीआई विधियों को कॉल करने के लिए, आपको एक VkontakteApi::Client ऑब्जेक्ट की आवश्यकता है। आपको बस कंस्ट्रक्टर को टोकन पास करना होगा।

इसके बाद, आप क्लाइंट पर ही कॉल कर सकते हैं। यौगिक नामों के साथ तरीके एक श्रृंखला में लागू होते हैं: vk.users.get(params) । रूबी समुदाय में अपनाए गए सम्मेलनों के अनुसार, विधि के नाम snake_case में लिखे गए हैं: API पसंद likes.getList पद्धति को vk.likes.get_list कहा जा सकता है।

सभी एपीआई मापदंडों को नाम दिया गया है और पैरामीटर नामों से अनुक्रमित हैश के रूप में पारित किया गया है, उदाहरण के लिए vk.users.get(uid: 1) । यदि API को पैरामीटर में अल्पविराम द्वारा अलग किए गए ऑब्जेक्ट का संग्रह प्राप्त करने की उम्मीद है, तो उन्हें एक सरणी के रूप में पारित किया जा सकता है - vkontakte_api इसे स्वचालित रूप vkontakte_api गोंद करेगा (प्राधिकरण में scope पैरामीटर उसी तरह से संसाधित होता है)। इस स्थिति में, आप तार के बजाय वर्णों का उपयोग कर सकते हैं।

इसलिए, हमें वर्तमान उपयोगकर्ता के लिए समाचार फ़ीड, मित्रों और समूहों की आवश्यकता है। नेविगेशन में उपयोगकर्ता नाम और अवतार भी प्रदर्शित करें। क्रमशः इस डेटा को प्राप्त करने के लिए newsfeed.get , friends.get , groups.get और users.get विधियां हैं (हम अपने उपयोगकर्ता आईडी पैरामीटर को पारित करके उत्तरार्द्ध कहेंगे)। newsfeed.get का परिणाम अलग-अलग समाचारों में ही होता है, जिसमें उपयोगकर्ताओं और समूहों की आईडी होती है, और उल्लिखित उपयोगकर्ताओं और समूहों के साथ अलग-अलग सरणियाँ होती हैं; MainController#process_feed विधि यहां नहीं दिखाई गई है प्रत्येक समाचार में इसका स्रोत (उपयोगकर्ता या समूह जिसने पोस्ट लिखा है) प्रमुख source तहत जोड़ता है।

 class MainController < ApplicationController def index #    API vk = VkontakteApi::Client.new(session[:token]) #     @user = vk.users.get(uid: session[:vk_id], fields: [:screen_name, :photo]).first #   @friends = vk.friends.get(fields: [:screen_name, :sex, :photo, :last_seen]) #   ,      @friends_online = @friends.select { |friend| friend.online == 1 } #  @groups = vk.groups.get(extended: 1) #    - - ;    @groups.shift #    raw_feed = vk.newsfeed.get(filters: 'post') #     @newsfeed = process_feed(raw_feed) end end 

तरीकों के परिणामों को Hashie::Mash के रूप में Hashie::Mash हैशी मणि से मानक Hash का एक विस्तार है, जिससे आप एक विधि के माध्यम से एक तत्व का उपयोग कर सकते हैं जिसका नाम हैश में इस तत्व की कुंजी से मेल खाता है ( user.name == user[:name] )।

नेविगेशन में आपको VKontakte से प्राप्त वर्तमान उपयोगकर्ता का अवतार और नाम दिखाना होगा।

 <%= link_to vk_url(@user), target: '_blank' do %> <%= image_tag(@user.photo, width: 20) %> <%= "#{@user.first_name} #{@user.last_name}" %> <% end %> 

इसके बाद, कई सरल सहायकों ( vk_url , name_for , avatar_for आदि) का उपयोग किया जाता है जो अनुप्रयोग में परिभाषित किए गए हैं - वे सभी काफी तुच्छ हैं, आप चाहें तो यहां कोड पढ़ सकते हैं।

अब हम पृष्ठ पर समाचार फ़ीड प्रदर्शित करते हैं।

 <!-- app/views/main/index.html.erb --> <% @newsfeed.each do |item| %> <tr> <td> <%= link_to vk_url(item.source), target: '_blank' do %> <%= image_tag avatar_for(item.source) %> <% end %> </td> <td class="wide"> <div class="pull-right"><%= formatted_time_for(item.date) %></div> <%= link_to name_for(item.source), vk_url(item.source), target: '_blank' %> <p><%=raw render_links(item.text) %></p> <% item.attachments.each do |attachment| %> <%= render 'attachment', attachment: attachment %> <% end if item.attachments? %> </td> </tr> <% end %> <!-- app/views/main/_attachment.html.erb --> <p> <% case attachment.type %> <% when 'link' %> <%= link_to attachment.link.title, attachment.link.url, target: '_blank' %> <% when 'photo' %> <%= image_tag attachment.photo.src_big %> <% when 'video' %> <%= image_tag attachment.video.image_big %> <% end %> </p> <div class="clearfix"></div> 

और अंत में, साइड बार दोस्तों और उपयोगकर्ता समूहों में प्रदर्शित करें।

 <!-- app/views/main/_sidebar.html.erb --> <div class="tab-pane active" id="friends_online"> <h6> </h6> <%= render 'friends', friends: @friends_online %> </div> <div class="tab-pane" id="friends"> <h6> </h6> <%= render 'friends', friends: @friends %> </div> <div class="tab-pane" id="groups"> <h6></h6> <%= render 'groups' %> </div> <!-- app/views/main/_friends.html.erb --> <table class="table"> <% if friends.empty? %> <tr> <td>  </td> </tr> <% else %> <% friends.each do |friend| %> <tr> <td> <%= link_to image_tag(friend.photo), vk_url(friend), target: '_blank' %> </td> <td class="wide"> <i class="icon-user"></i> <%= link_to "#{friend.first_name} #{friend.last_name}", vk_url(friend), target: '_blank' %> <br /> <%= online_status(friend) %> </td> </tr> <% end %> <% end %> </table> <!-- app/views/main/_groups.html.erb --> <table class="table"> <% if @groups.empty? %> <tr> <td>    </td> </tr> <% else %> <% @groups.each do |group| %> <tr> <td> <%= link_to image_tag(group.photo), vk_url(group), target: '_blank' %> </td> <td class="wide"> <i class="icon-comment"></i> <%= link_to group.name, vk_url(group), target: '_blank' %> </td> </tr> <% end %> <% end %> </table> 

आप यहां लाइव डेमो देख सकते हैं (सावधानी, मुफ्त हेरोकू)। यह VKontakte पर कुछ भी नहीं लिखता है - सभी एपीआई तरीकों का उपयोग केवल डेटा पढ़ने और उन्हें एक पृष्ठ पर प्रदर्शित करने के लिए किया जाता है। सभी कोड Github पर है।

vkontakte_api पर कुछ और सामग्री

• प्रोजेक्ट होमपेज
• README.md
• 100% कवरेज के साथ RDoc प्रलेखन
• vkontakte_api (वेब ​​सॉकेट पर अतुल्यकालिक संदेशवाहक अनुप्रयोग) का उपयोग करने का एक और अधिक उन्नत उदाहरण