school_friend 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+**0.1.0 (June 28, 2013)**
+* Add OAuth2 support ([Daniel Chcouri](https://github.com/theosp))
+
+**0.0.1 (December 3, 2012)** (initial release)
+* Create gem skeleton

data/README.md

@@ -17,9 +17,38 @@ Or install it yourself as:
     $ gem install school_friend
 
 ## Usage
-
-TODO: Write usage instructions here
-
+```ruby
+# Init the SchoolFriend Module
+SchoolFriend.application_id = ''
+SchoolFriend.application_key = ''
+SchoolFriend.secret_key = ''
+SchoolFriend.api_server = 'http://api.odnoklassniki.ru'
+
+# Example call to a method that doesn't require a session or oauth2 access token  
+puts SchoolFriend.users.is_app_user(:uid => "425634635") # Note that method name is underscored
+
+# Init an Oauth2 Session
+# You can init an oauth session in two ways:
+# 1. By providing the oauth code and let this gem to acquire the access token for you
+session = SchoolFriend.session(:oauth_code => code)
+
+# 2. By providing an access token and a refresh token you already have
+session = SchoolFriend.session(:access_token => access_token, :refresh_token => refresh_token)
+
+# 3. Refreshing the access token:
+# According to Odnoklassniki's API doc access token is valid for 30 minutes
+# You can extend this time by refreshing the access token this will give
+# you a new token that will be valid for 30 days
+# http://dev.odnoklassniki.ru/wiki/pages/viewpage.action?pageId=12878032
+session.refresh_access_token
+
+# Alternative - non oauth: Acquire a session with user's user_name and password (not recommanded)
+# Odnoklassniki's sandbox has no oauth2 support so you have to use this method there
+session = SchoolFriend.session(SchoolFriend.auth.login(:user_name => username, :password => password))
+
+# Once you have a session you can perform actions with it:
+puts session.users.get_current_user
+```
 ## Contributing
 
 1. Fork it

data/examples/basic_auth.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'yaml'
+require 'school_friend'
+require 'time'
+require 'socket'
+
+log = Logger.new(STDOUT)
+log.level = Logger::DEBUG
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+example_settings = YAML.load_file(File.dirname(__FILE__) + '/examples_settings.yaml')
+
+puts "Login using Odnoklassniki: \"#{example_settings['oauth_server']}/oauth/authorize?client_id=#{example_settings['application_id']}&scope=#{example_settings['permission']}&response_type=code&redirect_uri=http://127.0.0.1:#{example_settings['listener_port']}\""
+
+log.debug "Initiating server to catch the oauth code"
+server = TCPServer.new(example_settings['listener_port'])
+loop {
+  log.debug "Server initiated"
+
+  client = server.accept
+  headers = "HTTP/1.1 200 OK\r\nDate: #{Time.now.httpdate}\r\nServer: Ruby\r\nContent-Type: text/html; charset=iso-8859-1\r\n\r\n"
+  
+  lines = "" 
+  while line = client.gets and line !~ /^\s*$/
+    lines << line.chomp
+  end
+
+  if match = /code=(\S*)/.match(lines)
+    code = match[1]
+    log.debug "Oauth code received: #{code}"
+
+    # Init SchoolFriend module class vars
+    SchoolFriend.application_id = example_settings['application_id']
+    SchoolFriend.application_key = example_settings['application_key']
+    SchoolFriend.secret_key = example_settings['secret_key']
+    SchoolFriend.api_server = example_settings['api_server']
+    log.debug "SchoolFriend module class variables initiated: #{SchoolFriend.application_id} #{SchoolFriend.application_key} #{SchoolFriend.secret_key} #{SchoolFriend.api_server} "
+
+    # Set SchoolFriend's logger
+    SchoolFriend.logger = log
+
+    begin
+      # Example for oauth_code based init
+      session = SchoolFriend.session(:oauth_code => code)
+
+      puts session.users.is_app_user
+      puts session.users.get_current_user
+      puts session.users.get_info
+
+      # Example for access_token based init
+      session = SchoolFriend.session(:access_token => session.options[:access_token], :refresh_token => session.options[:refresh_token])
+      puts session.users.is_app_user
+      puts session.users.get_current_user
+      puts session.users.get_info
+    rescue SchoolFriend::Session::OauthCodeAuthenticationFailedError
+      puts "Failed to authenticate oauth code, try again in a few moments..."
+    end
+  end
+
+  client.puts headers
+  client.puts "OK"
+  client.close
+}

data/examples/examples_settings.yaml

@@ -0,0 +1,10 @@
+# Your app settings
+oauth_server: https://www.odnoklassniki.ru
+api_server: http://api.odnoklassniki.ru
+application_id: 1
+application_key: C
+secret_key: C
+permission: SET STATUS;VALUABLE ACCESS;PHOTO CONTENT
+
+# Options related to the TCPServer we open to receive the oauth code
+listener_port: 2000

data/examples/operations.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'yaml'
+require 'school_friend'
+require 'time'
+require 'socket'
+
+log = Logger.new(STDOUT)
+log.level = Logger::INFO
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+example_settings = YAML.load_file(File.dirname(__FILE__) + '/examples_settings.yaml')
+
+puts "Login using Odnoklassniki: \"#{example_settings['oauth_server']}/oauth/authorize?client_id=#{example_settings['application_id']}&scope=#{example_settings['permission']}&response_type=code&redirect_uri=http://127.0.0.1:#{example_settings['listener_port']}\""
+
+def operation_pretty_print title, result
+  puts "*" * 80
+  puts title
+  puts "*" * 80
+
+  puts ""
+  begin
+    puts JSON.pretty_generate(result)
+  rescue JSON::GeneratorError
+    puts result
+  end
+end
+
+log.debug "Initiating server to catch the oauth code"
+server = TCPServer.new(example_settings['listener_port'])
+loop {
+  log.debug "Server initiated"
+
+  client = server.accept
+  headers = "HTTP/1.1 200 OK\r\nDate: #{Time.now.httpdate}\r\nServer: Ruby\r\nContent-Type: text/html; charset=iso-8859-1\r\n\r\n"
+  
+  lines = "" 
+  while line = client.gets and line !~ /^\s*$/
+    lines << line.chomp
+  end
+
+  if match = /code=(\S*)/.match(lines)
+    code = match[1]
+    log.debug "Oauth code received: #{code}"
+
+    # Init SchoolFriend module class vars
+    SchoolFriend.application_id = example_settings['application_id']
+    SchoolFriend.application_key = example_settings['application_key']
+    SchoolFriend.secret_key = example_settings['secret_key']
+    SchoolFriend.api_server = example_settings['api_server']
+    log.debug "SchoolFriend module class variables initiated: #{SchoolFriend.application_id} #{SchoolFriend.application_key} #{SchoolFriend.secret_key} #{SchoolFriend.api_server} "
+
+    # Set SchoolFriend's logger
+    SchoolFriend.logger = log
+
+    begin
+      # Example for oauth_code based init
+      session = SchoolFriend.session(:oauth_code => code)
+      session.refresh_access_token
+
+      current_user = session.users.get_current_user
+      operation_pretty_print "users.get_current_user", current_user
+      operation_pretty_print "friends.get_app_users (Returns IDs of users who are friends of the current user and authorize the calling application)", session.friends.get_app_users
+      operation_pretty_print "friends.get", friends = session.friends.get
+
+      operation_pretty_print "users.get_info", session.users.get_info(:uids => friends.join(","), :fields => "uid,first_name,last_name,name,gender,birthday,age,locale,location,current_location,current_status,current_status_id,current_status_date,online,pic_1,pic_2,pic_3,pic_4,pic_5,url_profile,url_profile_mobile,url_chat,url_chat_mobile,has_email,allows_anonym_access")
+
+      operation_pretty_print "discussions.get_list", session.discussions.get_list
+
+      status = "Cool Status #{Random.rand(0...1000)}"
+      operation_pretty_print "users.set_status - #{status}", session.users.set_status(:status => status)
+
+      message = "Cool Message #{Random.rand(0...1000)}"
+      operation_pretty_print "share.add_link - #{message}", session.share.add_link(:comment => message, :linkUrl => "http://www.imdb.com/title/tt0110413/")
+      message = "Cool Message #{Random.rand(0...1000)}"
+      operation_pretty_print "share.add_link - #{message}", session.share.add_link(:comment => message, :linkUrl => "http://www.imdb.com/title/tt0137523/")
+      message = "Cool Message #{Random.rand(0...1000)}"
+      operation_pretty_print "share.add_link - #{message}", session.share.add_link(:comment => message, :linkUrl => "http://www.youtube.com/watch?v=wxaFANthouM")
+
+      operation_pretty_print "users.get_calls_left", session.users.get_calls_left(:methods => "users.getInfo,stream.publish")
+    rescue SchoolFriend::Session::OauthCodeAuthenticationFailedError
+      puts "Failed to authenticate oauth code, try again in a few moments..."
+    end
+  end
+
+  client.puts headers
+  client.puts "OK"
+  client.close
+}

data/examples/refresh_token.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'yaml'
+require 'school_friend'
+require 'time'
+require 'socket'
+
+log = Logger.new(STDOUT)
+log.level = Logger::DEBUG
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+example_settings = YAML.load_file(File.dirname(__FILE__) + '/examples_settings.yaml')
+
+puts "Login using Odnoklassniki: \"#{example_settings['oauth_server']}/oauth/authorize?client_id=#{example_settings['application_id']}&scope=#{example_settings['permission']}&response_type=code&redirect_uri=http://127.0.0.1:#{example_settings['listener_port']}\""
+
+log.debug "Initiating server to catch the oauth code"
+server = TCPServer.new(example_settings['listener_port'])
+loop {
+  log.debug "Server initiated"
+
+  client = server.accept
+  headers = "HTTP/1.1 200 OK\r\nDate: #{Time.now.httpdate}\r\nServer: Ruby\r\nContent-Type: text/html; charset=iso-8859-1\r\n\r\n"
+  
+  lines = "" 
+  while line = client.gets and line !~ /^\s*$/
+    lines << line.chomp
+  end
+
+  if match = /code=(\S*)/.match(lines)
+    code = match[1]
+    log.debug "Oauth code received: #{code}"
+
+    # Init SchoolFriend module class vars
+    SchoolFriend.application_id = example_settings['application_id']
+    SchoolFriend.application_key = example_settings['application_key']
+    SchoolFriend.secret_key = example_settings['secret_key']
+    SchoolFriend.api_server = example_settings['api_server']
+    log.debug "SchoolFriend module class variables initiated: #{SchoolFriend.application_id} #{SchoolFriend.application_key} #{SchoolFriend.secret_key} #{SchoolFriend.api_server} "
+
+    # Set SchoolFriend's logger
+    SchoolFriend.logger = log
+
+    begin
+      # Example for oauth_code based init
+      session = SchoolFriend.session(:oauth_code => code)
+      session.refresh_access_token
+      session.refresh_access_token
+      puts session.users.get_current_user
+    rescue SchoolFriend::Session::OauthCodeAuthenticationFailedError
+      puts "Failed to authenticate oauth code, try again in a few moments..."
+    end
+  end
+
+  client.puts headers
+  client.puts "OK"
+  client.close
+}

data/examples/using_these_examples.md

@@ -0,0 +1,9 @@
+# Running Examples
+
+First set examples_settings.yaml params.
+
+In order to run an example you just have to execute it, example:
+
+   ./basic_auth.rb
+
+and follow its instructions.

data/lib/school_friend.rb

@@ -6,7 +6,7 @@ module SchoolFriend
   class << self
     extend Forwardable
 
-    attr_accessor :application_key, :secret_key, :api_server
+    attr_accessor :application_id, :application_key, :secret_key, :api_server, :logger
 
     def_delegators :session, *REST_NAMESPACES
 
@@ -14,6 +14,10 @@ module SchoolFriend
       Session.new(options)
     end
   end
+
+  self.logger = Logger.new(STDOUT)
+  self.logger.level = Logger::WARN
+
 end
 
 require 'school_friend/version'
@@ -32,4 +36,4 @@ require 'school_friend/rest/photos_v2'
 require 'school_friend/rest/share'
 require 'school_friend/rest/stream'
 require 'school_friend/rest/users'
-require 'school_friend/rest/widget'
+require 'school_friend/rest/widget'

data/lib/school_friend/api_methods.rb

@@ -19,14 +19,14 @@ module SchoolFriend
           call += options[:session_only] ? ', true)' : ')'
 
           class_eval <<-OES, __FILE__, __LINE__ + 1
-            def #{method}(params = {})             # def get_widgets(params = {})
-              response = #{call}                   #   response = session.api_call('widget.getWidgets', params, true)
-              if response.is_a?(Net::HTTPSuccess)  #   if response.is_a?(Net::HTTPSuccess)
-                JSON(response.body)                #     JSON(response.body)
-              else                                 #   else
-                response.error!                    #     response.error!
-              end                                  #   end
-            end                                    # end
+            def #{method}(params = {})                          # def get_widgets(params = {})
+              response = #{call}                                #   response = session.api_call('widget.getWidgets', params, true)
+              if response.is_a?(Net::HTTPSuccess)               #   if response.is_a?(Net::HTTPSuccess)
+                JSON.parse(response.body, :quirks_mode => true) #     JSON(response.body, :quirks_mode => true)
+              else                                              #   else
+                response.error!                                 #     response.error!
+              end                                               #   end
+            end                                                 # end
           OES
         end
       end

data/lib/school_friend/rest/discussions.rb

@@ -3,6 +3,7 @@ module SchoolFriend
     class Discussions
       include APIMethods
 
+      api_method :get_list,                      session_only: true
       api_method :get_discussions,               session_only: true
       api_method :get_discussion_comments_count, session_only: true
       api_method :add_discussion_comment,        session_only: true

data/lib/school_friend/session.rb

@@ -1,16 +1,101 @@
 require 'net/http'
 require 'digest'
+require 'json'
+
+def keys_to_symbols! (_hash)
+  _hash.keys.each do |key|
+    _hash[(key.to_sym rescue key) || key] = _hash.delete(key)
+  end
+
+  return _hash
+end
 
 module SchoolFriend
   class Session
     class RequireSessionScopeError < ArgumentError
     end
 
+    class OauthCodeAuthenticationFailedError < StandardError  
+    end  
+
     attr_reader :options, :session_scope
 
+    def _post_request(url, params)
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, 80)
+      data = URI.encode_www_form(params)
+
+      headers = {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+
+      http.post(uri.path, data, headers)
+    end
+
     def initialize(options = {})
-      @options       = options
-      @session_scope = options[:session_key] && options[:session_secret_key]
+      @options       = keys_to_symbols!(options)
+      @session_scope = (options[:session_key] && options[:session_secret_key]) || \
+                           options[:oauth_code] || \
+                           (options[:access_token] && options[:refresh_token])
+
+    # only has oauth_code, get access_token
+    if options[:oauth_code]
+      response, data = \
+        _post_request(api_server + "/oauth/token.do",
+                      {"code" => options[:oauth_code], "redirect_uri" => "http://127.0.0.1:2000",
+                       "client_id" => SchoolFriend.application_id, "client_secret" => SchoolFriend.secret_key,
+                       "grant_type" => 'authorization_code'})
+
+        if response.is_a?(Net::HTTPSuccess)
+          response = JSON(response.body)
+
+          if response.has_key?("error")
+              raise OauthCodeAuthenticationFailedError, "failed to use oauth_code for authentication: #{response["error"]}: #{response["error_description"]}"
+          end
+
+          options[:access_token] = response["access_token"]
+          options[:refresh_token] = response["refresh_token"]
+
+          SchoolFriend.logger.debug "Tokens received: #{options[:access_token]} #{options[:refresh_token]}"
+        else
+          raise OauthCodeAuthenticationFailedError, "failed to use oauth_code for authentication - Request Failed"
+        end
+
+        options.delete(:oauth_code)
+      end
+    end
+
+    def refresh_access_token
+      # true on success false otherwise
+      if oauth2_session?
+        response, data = \
+          _post_request(api_server + "/oauth/token.do",
+                        {"refresh_token" => options[:refresh_token],\
+                         "client_id" => SchoolFriend.application_id, "client_secret" => SchoolFriend.secret_key,
+                         "grant_type" => 'refresh_token'})
+
+        if response.is_a?(Net::HTTPSuccess)
+          response = JSON(response.body)
+
+          if response.has_key?("error")
+            SchoolFriend.logger.warn "#{__method__}: failed to refresh access token - #{response["error"]}"
+
+            return false
+          end
+
+          options[:access_token] = response["access_token"]
+
+          SchoolFriend.logger.debug "#{__method__}: Token received: #{options[:access_token]}"
+          
+          return true
+        el
+          SchoolFriend.logger.warn "#{__method__}: Failed to refresh access token - request Failed"
+
+          return false
+        end
+      else
+        return false
+      end
     end
 
     # Returns true if API call is performed in session scope
@@ -25,6 +110,10 @@ module SchoolFriend
       not session_scope?
     end
 
+    def oauth2_session?
+      options[:access_token] && options[:refresh_token]
+    end
+
     # Returns application key
     #
     # @return [String]
@@ -36,7 +125,11 @@ module SchoolFriend
     #
     # @return [String]
     def signature
-      @signature ||= session_scope? ? options[:session_secret_key] : SchoolFriend.secret_key
+      unless session_scope?
+        return SchoolFriend.secret_key
+      end
+
+      options[:access_token] || options[:session_secret_key]
     end
 
     # Returns API server
@@ -53,7 +146,14 @@ module SchoolFriend
     def sign(params = {})
       params = additional_params.merge(params)
       digest = params.sort_by(&:first).map{ |key, value| "#{key}=#{value}" }.join
-      params[:sig] = Digest::MD5.hexdigest("#{digest}#{signature}")
+
+      if oauth2_session?
+        params[:sig] = Digest::MD5.hexdigest("#{digest}" + Digest::MD5.hexdigest(options[:access_token] + SchoolFriend.secret_key))
+        params[:access_token] = options[:access_token]
+      else
+        params[:sig] = Digest::MD5.hexdigest("#{digest}#{signature}")
+      end
+
       params
     end
 
@@ -63,7 +163,11 @@ module SchoolFriend
     # @return [Hash]
     def additional_params
       @additional_params ||= if session_scope?
-        {application_key: application_key, session_key: options[:session_key]}
+        if oauth2_session?
+          {application_key: application_key}
+        else
+          {application_key: application_key, session_key: options[:session_key]}
+        end
       else
         {application_key: application_key}
       end
@@ -100,6 +204,9 @@ module SchoolFriend
       uri = URI(api_server)
       uri.path  = '/api/' + method.sub('.', '/')
       uri.query = URI.encode_www_form(sign(params))
+
+      SchoolFriend.logger.debug "API Request: #{uri}"
+
       uri
     end
 
@@ -111,4 +218,4 @@ module SchoolFriend
       EOS
     end
   end
-end
+end

data/lib/school_friend/version.rb

@@ -1,3 +1,3 @@
 module SchoolFriend
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: school_friend
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby interface to the Odnoklassniki API
 email: kostya.stepanyuk@gmail.com
@@ -18,10 +18,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/basic_auth.rb
+- examples/examples_settings.yaml
+- examples/operations.rb
+- examples/refresh_token.rb
+- examples/using_these_examples.md
 - lib/school_friend.rb
 - lib/school_friend/api_methods.rb
 - lib/school_friend/rest/auth.rb
@@ -61,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the Odnoklassniki API