social 0.0.11 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3becb7a8ded7114cb92fbe39b3aa334e8f1c058
+  data.tar.gz: b40e98c12f7143e7dd9332b227ffeb09c2a373ea
+SHA512:
+  metadata.gz: 038fbcc6d9745a44cfad4750a2933efcc77bc92361ae9df9c2b9dfcb12c2467cdf5baccbaeb90cdbbbaafef5f7905356ab0e3eb8dae64c68a8d44336d7e7bed9
+  data.tar.gz: 861d167d64dac6f76c0f8525c907f9e512dec581c5d019d910c14bbc40bedc567b7a0786ed4b4647d7c4f4d86898b725ba227e9b27fadbf338b2a4a66e8626bf

data/README.md

@@ -1,82 +1,114 @@
-Social API wrapper and Tools
+Social
 ====================
 
-This is social networks api wrapper and authorization tools for social applications.
+Библиотека для обращения к API социальных сетей со стороны сервера. Содержит методы API и средства определения текущей социальной сети. 
 
-Now it is a compilation of terrible code from various projects. Without tests and benchmark. =(
+Данная библиотека была создана в рамках проекта SocialFrame - Шаблон для IFrame приложений на базе Sinatra (Padrino). Но библиотеку можно также использовать и для Rails-приложений и других. 
 
-## NOT RECOMMENDED USE IN PRODUCTION
+Библиотека решает следующие задачи:
+* Определение типа соцсети до создания сессии и авторизации по средствам Rack::Builder
+* Осуществление общих запросов к API соцсети
+* Генерирует уникальный пользовательский UID и уникальный SESSION_ID для сессии на основе SID соцсети
 
-Now supported networks:
-
-* vk.com 
+Поддержка социальных сетей:
+* vk.com
 * odnoklassniki.ru
-* mail.ru (plans to support)
-* facebook.com (plans to support)
-
-Now supported features:
 
-* Get user profile
-* Get user friend profiles
-* Get user balance and charge off (only vk.com)
-* Initialize environment by request (example /odkl/*, /vk/* and other) - Rack Middleware
-* Authorization user for Rails application (support transition between pages)
-* Parameterized wrapper to call the API methods
+Поддерживаемые методы API:
+* Получает профиль пользователя
+* Получить список друзей для пользователя
+* Получить профили друзей
+* Работа с балансом пользователя (только для vk.com)
 
-Install
+Установка
+---------------------
 
     gem install social
 
+Для Gemfile
 
-Use wrapper
+    gem 'social'
+
+Использование
 ---------------------
 
+Получение профиля пользователя (get user profile)
+
     Social::Network(:ok).user.get_info(uid)
 
-or
+или
 
     Social::Network::Vk.user.get_info(uid)
 
-or
+или отправка нотификации
 
-    Social::Network(socio_type).notification.send(:message => msg, :uids => [ ... ])
+    Social::Network(social_type).notification.send(:message => msg, :uids => [ ... ])
 
-Use environment tools
+Обращение к текущей социальной сети осуществляется после Глобального определения этого типа (см. ниже). При этом возможны следующие вызовы.
+
+    Social::Network.current.user.get_info(uid)
+
+
+Глобальное определение типа социальной сети
 ---------------------
 
-In config.ru
+    Social::Env.init(params[:social_types])
 
-    builder = Social::Builder::produce(App::Application)
+Определение соцсети с помощью SocialPrefix
+---------------------
+
+SocialPrefix позволяет определять социальную сеть по строке запроса т.е.
+
+- без использования субдоменов
+- без определения соц.сети по параметрам запроса (что также поддерживается)
+- без добавления доп.роутов в приложение
+
+Также пользоволяет решить проблему с показам аватаров пользователей в Одноклассниках, для которых в REFERRAL должно быть слово "odnoklassniki" или "odkl".
+
+config.ru
+
+    builder = Social::Builder::produce(Example::Application)
     run builder
 
-Adds an initializing environment.
+При этом в параметры запроса добавляется ключ social_env
+со следующим содержанием
 
-    request['social_env'] = {
+    request.params['social_env'] = {
       'prefix' => <SOCIAL_PREFIX>, 
       'type'   => <SOCIAL_TYPE_NAME>,
       'id'     => <SOCIAL_TYPE_ID>
     }
 
-For example, on request /odkl/*
+Например, при запросе /odkl/*
 
     params[:social_env][:id] # => 1
+    params[:social_env][:prefix] # => 'odkl'
+    params[:social_env][:type] # => :ok
+
+Для SinglePage приложения:
+Предпологается, что первый GET запрос приходит на URL из SocialPrefix,
+а последующие запросы идут уже без без SocialPrefix и тип соцсети
+берется из сессии и передается в метод Social::Env.init(<SOCIAL_TYPE>).
 
-and after 
-    
-    include Social::Helper::Controller 
+Для "Многостраничного" приложения:
+Предпологается, что все запросы все запросы осуществляются с помощью
+SocialPrefix
+
+Определение соцсети с помощью
+---------------------
 
-in your Rails application controller
+Помимо SocialPrefix определение соцсети можно осуществлять
+с помощью параметров запроса. Например если запрос содержит
+параметры viewer_id и sid, то можно сказать что это 
+соцсеть ВКонтакт.
 
-    Social::Env.id # => 1
-    Social::Env.type # => :ok
-    Social::Env.prefix # => :odkl
+Этот способ также предпологает использование Rack::Builder.
 
 TODO
 ---------------------
 
-* Tests, tests, tests ...
-* More network
-* More and beautiful API for Rails, Sinatra and Rack applications
-* More supported features
+* Тесты с использованием VCR
+* Поддержка Mail.ru
+* Поддержка Facebook
+* Больше поддерживаемых "общих" методов API
 
-### Welcome to contributing!

data/lib/social.rb

@@ -2,32 +2,27 @@ require 'singleton'
 require 'active_support/all'
 require 'rack'
 require 'social/version'
-require 'social/provider'
-require 'social/builder'
-require 'social/cache'
+require 'social/determinant'
+require 'social/determinant/social_prefix'
+require 'social/determinant/request_param'
+require 'social/config'
 require 'social/config/vk'
 require 'social/config/ok'
-require 'social/config'
 require 'social/env'
-require 'social/helper/controller'
-require 'social/helper/model'
-require 'social/helper'
-require 'social/auth/controller'
-require 'social/auth'
-require 'social/network/graph/tail'
-require 'social/network/params'
-require 'social/network/base'
+require 'social/network'
 require 'social/network/graph'
+require 'social/network/base'
 require 'social/network/ok'
 require 'social/network/vk'
+require 'social/network/graph/tail'
+require 'social/network/graph/ok'
 require 'social/network/graph/ok/base'
 require 'social/network/graph/ok/notification'
 require 'social/network/graph/ok/user'
-require 'social/network/graph/ok'
+require 'social/network/graph/vk'
 require 'social/network/graph/vk/base'
 require 'social/network/graph/vk/notification'
 require 'social/network/graph/vk/user'
-require 'social/network/graph/vk'
 require 'social/network/stub'
 require 'social/network'
 require 'social/networks'
@@ -46,30 +41,71 @@ module Social
     :fb => 'fb'
   }
 
+  VK_PARAMS = %w(
+    api_url api_id api_settings viewer_id
+    viewer_type sid secret access_token
+    user_id group_id is_app_user auth_key
+    language parent_language ad_info
+    is_secure ads_app_id referrer lc_name hash
+  )
+
+  OK_PARAMS = %w(
+    authorized ip_geo_location api_server
+    new_sig apiconnection first_start
+    clientLog session_secret_key
+    application_key auth_sig web_server
+    session_key logged_user_id sig
+  )
+
   class << self
 
-    def current_id=(id)
-      @id = id
+    def social_params(params)
+      params.slice(VK_PARAMS + OK_PARAMS)
     end
 
-    def current_id
-      @id
+    def social_request?(params)
+      request_social_type(params).present?
     end
-    
-    def current_type=(type)
-      @type = type
+
+    def request_social_type(params)
+      if social_env = (params[:social_env])
+        # Если параметр задается с помощью RackBuilder
+        # через SocialPrefix и передается как social_env
+        # через параметры приложения
+        params[:social_env][:type]
+      else
+        params_social_type(params)
+      end
     end
 
-    def current_type
-      @type
+    # Определяем тип социальной сети по параметрам
+    # первоначального запроса. Например если передан параметр
+    # viewer_id и sid, то это Вконтакте
+    def params_social_type(params)
+      case 
+      when params[:viewer_id].present? && params[:sid].present? then :vk
+      when params[:logged_user_id].present? && params[:session_key].present? then :ok
+      else
+        nil
+      end
     end
 
-    def current_prefix=(prefix)
-      @prefix = prefix
+    def request_session_token(params)
+      case request_social_type(params)
+      when :vk then "vk::#{params[:sid]}"
+      when :ok then "ok::#{params[:session_key]}"
+      else
+        raise 'Not defined social type'
+      end
     end
 
-    def current_prefix
-      @prefix
+    def request_uid(params)
+      case request_social_type(params)
+      when :vk then "vk::#{params[:user_id]}"
+      when :ok then "ok::#{params[:logged_user_id]}"
+      else
+        raise 'Not defined social type'
+      end
     end
 
     def Network(network, params = nil)
@@ -100,9 +136,8 @@ module Social
       id_by_type(type_by_prefix(prefix))
     end
 
-    def typing(index)
-      return type_by_id(index) if SOCIAL_TYPES.keys.include?(index.to_i)
-      return index.to_sym if SOCIAL_TYPES.values.include?(index.to_sym)
+    def prefix_by_type(type)
+      SOCIAL_PREFIX[type]
     end
 
     def type_codes

data/lib/social/balance.rb

@@ -1,6 +1,7 @@
 module Social
   module Balance
 
+    # @deprecated
     def self.included(base)
       base.instance_eval do
         
@@ -21,20 +22,6 @@ module Social
       end
     end
 
-    def payments
-      Payment.where(:uid => self.uid, :social_type_id => self.social_type_id)
-    end
-
-    def payments_create(hash)
-      param = {:uid => self.uid, :social_type_id => self.social_type_id, :user_id => nil}.merge(hash)
-      param.delete(:initiatable) if param[:initiatable].is_a? Profile
-      Payment.create(param)
-    end
-
-    def initiated
-      []
-    end
-
   end
 
 end

data/lib/social/config/ok.rb

@@ -1,24 +1,22 @@
-module Social
-  class Config
-    module Ok
+class Social::Config
+  module Ok
 
-      def config
-        
-        unless @config
-          @env = ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
-          @config_ins = Social::Config.new(:ok)
-          @config = @config_ins.config[@env]
-        end
-
-        @config
+    def config
+      
+      unless @config
+        @env = ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+        @config_ins = Social::Config.new(:ok)
+        @config = @config_ins.config[@env]
       end
 
-      def safe_config(auth_params = {})
-        auth_params.merge \
-          :api_server       => Social::Network(:ok).config[:api_server],
-          :application_key  => Social::Network(:ok).config[:application_key],
-          :logged_user_id   => auth_params['uid']
-      end
+      @config
+    end
+
+    def safe_config(auth_params = {})
+      auth_params.merge \
+        :api_server       => Social::Network(:ok).config[:api_server],
+        :application_key  => Social::Network(:ok).config[:application_key],
+        :logged_user_id   => auth_params['uid']
     end
   end
 end

data/lib/social/config/vk.rb

@@ -1,24 +1,22 @@
-module Social
-  class Config
-    module Vk
+class Social::Config
+  module Vk
+    
+    def config
       
-      def config
-        
-        unless @config
-          @env = ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
-          @config_ins = Social::Config.new(:vk)
-          @config = @config_ins.config[@env]
-        end
-
-        @config
+      unless @config
+        @env = ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+        @config_ins = Social::Config.new(:vk)
+        @config = @config_ins.config[@env]
       end
 
-      def safe_config(auth_params = {})
-        auth_params.merge \
-          :app_id         => Social::Network(:vk).config['app_id'],
-          :logged_user_id => auth_params['uid']
-      end
+      @config
+    end
 
+    def safe_config(auth_params = {})
+      auth_params.merge \
+        :app_id         => Social::Network(:vk).config['app_id'],
+        :logged_user_id => auth_params['uid']
     end
+
   end
 end

data/lib/social/determinant.rb

@@ -0,0 +1,4 @@
+module Social
+  class Determinant < Rack::Builder
+  end
+end

data/lib/social/determinant/request_param.rb

@@ -0,0 +1,56 @@
+require 'active_support/hash_with_indifferent_access'
+
+class Social::Determinant
+  class RequestParam < self
+
+    class Provider
+
+      def self.build(social_type)
+        klass = Class.new do
+
+          class << self
+            attr_accessor :social_type
+          end
+
+          def initialize(app)
+            @app = app
+          end
+
+          def call(env)
+            request      = Rack::Request.new(env)
+            social_type  = self.class.social_type
+            prefix       = Social.prefix_by_type(social_type)
+            id           = Social.id_by_type(social_type)
+            
+            request.GET['social_env'] = {
+              'prefix' => prefix, 'type' => social_type, 'id' => id
+            }
+
+            @app.call(request.env)
+          end
+
+        end
+
+        klass.social_type = social_type
+        klass
+      end
+
+    end
+
+    def self.produce(app)
+      new do
+
+        map '/' do
+          params = HashWithIndifferentAccess.new(Social.social_params(request.GET))
+          if params.present? && type = Social.params_social_type(params)
+            use Provider.build(type)
+            run app
+          else
+            run app
+          end
+        end
+
+      end
+    end
+  end
+end