social 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3becb7a8ded7114cb92fbe39b3aa334e8f1c058
-  data.tar.gz: b40e98c12f7143e7dd9332b227ffeb09c2a373ea
+  metadata.gz: 3d6c163dc76e920f4691c6d3555d27bf855add2c
+  data.tar.gz: d180dbf80378b05f4e953498551caea3909687ba
 SHA512:
-  metadata.gz: 038fbcc6d9745a44cfad4750a2933efcc77bc92361ae9df9c2b9dfcb12c2467cdf5baccbaeb90cdbbbaafef5f7905356ab0e3eb8dae64c68a8d44336d7e7bed9
-  data.tar.gz: 861d167d64dac6f76c0f8525c907f9e512dec581c5d019d910c14bbc40bedc567b7a0786ed4b4647d7c4f4d86898b725ba227e9b27fadbf338b2a4a66e8626bf
+  metadata.gz: 3cd8bf8cb022574745256ff2eed2aa9e9e3e9c71870e0557d1c1a61af63fe2c99f410a37e39897f2d186c5f7848456a62be218b2226e9736eae3d73c1244faab
+  data.tar.gz: 28a732ef46c40ae158540f25508dd4634a80e047a75f463f7e444e9c398f105a288afe4e3a05a246c29d3c90ed348e66e87a3f2efaf9dff7404902402223a151

data/README.md

@@ -29,6 +29,13 @@ Social
 
     gem 'social'
 
+Концепция API
+---------------------
+
+- Интерфейс API социальной сети представлена одним объектом (синглтоном), чтобы иметь легкий доступ к этому API из разных мест без необходимости каждый раз конструировать объект.
+- Интерфейс API социальной сети разделен на блоки которые представленны соответствующими цепочками вызова, например api.user.get_info
+- Конфигурация API социальной сети должна каходится в файле (с учетом различных окруженйи), но также должна быть возможность переопределить ее простым объектом
+
 Использование
 ---------------------
 
@@ -48,11 +55,12 @@ Social
 
     Social::Network.current.user.get_info(uid)
 
+Инциализация по запросу (и по SocialPrefix)
 
 Глобальное определение типа социальной сети
 ---------------------
 
-    Social::Env.init(params[:social_types])
+    Social::Env.init(params[:social_type])
 
 Определение соцсети с помощью SocialPrefix
 ---------------------
@@ -94,16 +102,71 @@ config.ru
 Предпологается, что все запросы все запросы осуществляются с помощью
 SocialPrefix
 
-Определение соцсети с помощью
+Определение соцсети с помощью SocialParam
 ---------------------
 
 Помимо SocialPrefix определение соцсети можно осуществлять
-с помощью параметров запроса. Например если запрос содержит
-параметры viewer_id и sid, то можно сказать что это 
-соцсеть ВКонтакт.
+с помощью параметров запроса - SocialParam, если нет поддержки SocialPrefix. Например если запрос содержит параметры viewer_id и sid, то можно сказать что это соцсеть ВКонтакт.
 
 Этот способ также предпологает использование Rack::Builder.
 
+Глобальная инициализация окружения для SocialPrefix и SocialPrams
+---------------------
+
+Осуществляет вызовом метода Social::Env.init_by_params, например
+
+    before_filter ->{ Social::Env.init_by_params(params) }
+
+Определение конфигурации
+---------------------
+
+Определение конфигурации задает данные для обращения к соц.сети. К этим данным относятся, например, секретный ключ, публичный ключ, ID приложения.
+
+По-умолчанию конфигурация загружается из конфигурационного файла (см. далее), но также конфигурацию можно задать первым вызовом #Network этого хеша, например
+
+    Social::Network(:ok, config_hash)
+
+Или определить с помощью у объекта
+
+    Social::Network::Ok.instance.params = { config: config_hash }
+    Social::Network::Ok.instance.reload_config
+
+или
+
+    Social::Network(:ok).params = { config: config_hash }
+    Social::Network(:ok).reload_config
+
+Определение конфигурации через конфигурационный файл
+---------------------
+
+Конфигурационный файл должен иметь имя "social.yml"
+
+При использовании Rails конфигурационный файл должн находится в папаке
+
+    APP_ROOT/config
+
+Также путь к папке с конфигурационным файлом может быть определен в переменной окружения "SOCIAL_CONFIG_PATH".
+
+Конфигурационный файл может иметь следующее содержание
+
+```yml
+ok:
+  development:
+    api_server: 'http://api.odnoklassniki.ru/'
+    application_key: 'APPLICATION_KEY'
+    secret_key: 'SECRET_KEY'
+  production:
+  test:
+vk:
+  development:
+    key: "KEY"
+    app_id: 123
+  production:
+  test:
+```
+
+Название окружение для чтения конфига задается через переменные окружения "APP_ENV", "RACK_ENV", "RAILS_ENV". По-умолчанию окружение "development".
+
 TODO
 ---------------------
 

data/lib/social.rb

@@ -6,8 +6,9 @@ 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/driver'
+require 'social/config/driver/file'
+require 'social/config/provider'
 require 'social/env'
 require 'social/network'
 require 'social/network/graph'
@@ -90,8 +91,8 @@ module Social
       end
     end
 
-    def request_session_token(params)
-      case request_social_type(params)
+    def request_session_token(params, type = nil)
+      case (type || request_social_type(params))
       when :vk then "vk::#{params[:sid]}"
       when :ok then "ok::#{params[:session_key]}"
       else
@@ -99,8 +100,8 @@ module Social
       end
     end
 
-    def request_uid(params)
-      case request_social_type(params)
+    def request_uid(params, type = nil)
+      case (type || request_social_type(params))
       when :vk then "vk::#{params[:user_id]}"
       when :ok then "ok::#{params[:logged_user_id]}"
       else

data/lib/social/config.rb

@@ -1,43 +1,4 @@
 module Social
   class Config
-
-    def initialize(network_name)
-      @network_name = network_name
-      @config_file_data = {}
-    end
-
-    def network_name
-      @network_name
-    end
-    
-    def config
-      @config_data ||= load_config_file[@network_name]
-    end
-
-    def config_file_path=(new_path)
-      @config_file_path = new_path
-      @config           = load_config_file if @config_data
-    end
-
-    def config_root=(new_root)
-      @config_root = new_root
-    end
-
-    def config_root
-      @config_root ||= File.join(Rails.root, 'config') if defined?(Rails)
-      @config_root ||= ENV['SOCIAL_CONFIG_ROOT']
-      @config_root ||= File.join('.', 'config')
-    end
-
-    def config_file_path
-      @config_file_path ||= ENV['SOCIAL_CONFIG_PATH']
-      @config_file_path ||= File.join(self.config_root, 'social.yml')
-    end
-
-    def load_config_file
-      @config_file_data[config_file_path] ||= YAML.load_file(config_file_path).with_indifferent_access
-    end
-
-
   end
 end

data/lib/social/config/driver.rb

@@ -0,0 +1,9 @@
+class Social::Config
+  class Driver
+
+    def config_data
+      raise NotImplementedError.new
+    end
+
+  end
+end

data/lib/social/config/driver/file.rb

@@ -0,0 +1,42 @@
+class Social::Config::Driver
+  class File < self
+
+    def initialize(network_name)
+      @network_name = network_name
+      @config_file_data = {}
+    end
+
+    def network_name
+      @network_name
+    end
+    
+    def config_data
+      @config_data ||= load_config_file[@network_name]
+    end
+
+    def config_file_path=(new_path)
+      @config_file_path = new_path
+      @config           = load_config_file if @config_data
+    end
+
+    def config_root=(new_root)
+      @config_root = new_root
+    end
+
+    def config_root
+      @config_root ||= ::File.join(Rails.root, 'config') if defined?(Rails)
+      @config_root ||= ENV['SOCIAL_CONFIG_ROOT']
+      @config_root ||= ::File.join('.', 'config')
+    end
+
+    def config_file_path
+      @config_file_path ||= ENV['SOCIAL_CONFIG_PATH']
+      @config_file_path ||= ::File.join(self.config_root, 'social.yml')
+    end
+
+    def load_config_file
+      @config_file_data[config_file_path] ||= YAML.load_file(config_file_path).with_indifferent_access
+    end
+
+  end
+end

data/lib/social/config/provider.rb

@@ -0,0 +1,22 @@
+class Social::Config::Provider
+
+  class << self
+
+    def factory_data(social_type, type = :file)
+      factory_driver(social_type, type).config_data[env]
+    end
+
+    def env
+      @env ||= ENV['APP_ENV'] || ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+    end
+
+    def factory_driver(social_type, type)
+      case type
+      when :file
+        Social::Config::Driver::File.new(social_type)
+      end
+    end
+
+  end
+
+end

data/lib/social/env.rb

@@ -17,7 +17,7 @@ module Social
 
       def init_by_params(params)
         unless social_type = Social.request_social_type(params)
-          raise "Can't find social env in params #{params.inspect}"
+          raise "Can't find social type into SocialEnv or SocialParams with params: #{params.inspect}"
         else
           init(social_type)
         end

data/lib/social/network/base.rb

@@ -14,24 +14,32 @@ class Social::Network::Base
     init_graph_for(root, list)
   end
 
+  def reload_config
+    if self.params[:config].present?
+      @config = self.params[:config]
+    else
+      provider_type = self.params[:config_provider] || :file
+      @config = Social::Config::Provider.factory_data(social_type, provider_type)
+    end
+  end
+
+  def config
+    reload_config if @config.nil?
+    @config
+  end
+
   def params
     @params
   end
 
-  def params!(params)
-    @params = params
-    self
+  def params=(params)
+    @params = params.with_indifferent_access
   end
 
   def param(key)
     @params[key]
   end
 
-  def param!(key, value)
-    @params[key] = value
-    self
-  end
-
   protected
 
   def init_params(params)

data/lib/social/network/graph/ok/base.rb

@@ -29,7 +29,10 @@ module Social::Network::Graph::Ok
   class Base
     
     include Social::Network::Graph::Tail
-    include Social::Config::Ok
+
+    def config
+      Social::Network(:ok).config
+    end
 
     def normalize_msg(msg)
       [ ['&nbps;', ' '],

data/lib/social/network/graph/vk/base.rb

@@ -2,7 +2,10 @@ module Social::Network::Graph::Vk
   class Base
             
     include Social::Network::Graph::Tail
-    include Social::Config::Vk
+
+    def config
+      Social::Network(:vk).config
+    end
 
     def http_query(query)
       Net::HTTP.start("api.vkontakte.ru", 80).get(query)

data/lib/social/network/ok.rb

@@ -1,6 +1,16 @@
 class Social::Network
   class Ok < Base
-    include Social::Config::Ok
+
+    def social_type
+      :ok
+    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
     
     def rate
       1

data/lib/social/network/vk.rb

@@ -1,6 +1,15 @@
 class Social::Network
   class Vk < Base
-    include Social::Config::Vk
+
+    def social_type
+      :vk
+    end
+
+    def safe_config(auth_params = {})
+      auth_params.merge \
+        :app_id         => Social::Network(:vk).config['app_id'],
+        :logged_user_id => auth_params['uid']
+    end
     
     def rate
       6

data/lib/social/networks.rb

@@ -8,11 +8,9 @@ module Social
 
     def site(network, params)
       @domains[network.to_sym] ||= deploy(network)
-      @domains[network.to_sym].params!(params)
-    end
-
-    def sites
-      @domains
+      @domains[network.to_sym].params = params || {}
+      @domains[network.to_sym].reload_config
+      @domains[network.to_sym]
     end
 
     protected

data/lib/social/version.rb

@@ -1,3 +1,3 @@
 module Social
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Kazantsev Nickolay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -169,8 +169,9 @@ files:
 - lib/social.rb
 - lib/social/balance.rb
 - lib/social/config.rb
-- lib/social/config/ok.rb
-- lib/social/config/vk.rb
+- lib/social/config/driver.rb
+- lib/social/config/driver/file.rb
+- lib/social/config/provider.rb
 - lib/social/determinant.rb
 - lib/social/determinant/request_param.rb
 - lib/social/determinant/social_prefix.rb

data/lib/social/config/ok.rb

@@ -1,22 +0,0 @@
-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
-    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,22 +0,0 @@
-class Social::Config
-  module Vk
-    
-    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
-    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