vkontakte_api 1.0.rc2 → 1.0.rc3

data/.yardopts

@@ -1,3 +1,3 @@
---files README.md
+--files README.md,CHANGELOG.md
 --markup markdown
 --markup-provider redcarpet

data/README.md

@@ -6,7 +6,7 @@
 
 ``` ruby
 # Gemfile
-gem 'vkontakte_api', '~> 1.0.rc2'
+gem 'vkontakte_api', '~> 1.0.rc3'
 ```
 
 или просто
@@ -165,6 +165,17 @@ VkontakteApi.configure do |config|
   
   # faraday-адаптер для сетевых запросов
   config.adapter = :net_http
+  # параметры для faraday-соединения
+  config.faraday_options = {
+    ssl: {
+      ca_path:  '/usr/lib/ssl/certs'
+    },
+    proxy: {
+      uri:      'http://proxy.example.com',
+      user:     'foo',
+      password: 'bar'
+    }
+  }
   
   # логгер
   config.logger        = Rails.logger
@@ -172,10 +183,15 @@ VkontakteApi.configure do |config|
   config.log_errors    = true  # ошибки
   config.log_responses = false # удачные ответы
 end
+
+# создание короткого алиаса VK для модуля VkontakteApi
+VkontakteApi.register_alias
 ```
 
 По умолчанию для HTTP-запросов используется `Net::HTTP`; можно выбрать [любой другой адаптер](https://github.com/technoweenie/faraday/blob/master/lib/faraday/adapter.rb), поддерживаемый `faraday`.
 
+При необходимости можно указать параметры для faraday-соединения - например, параметры прокси-сервера или путь к SSL-сертификатам.
+
 Чтобы сгенерировать файл с настройками по умолчанию в rails-приложении, можно воспользоваться генератором `vkontakte_api:install`:
 
 ``` sh
@@ -191,6 +207,6 @@ $ rails generate vkontakte_api:install
 
 ## Участие в разработке
 
-Если вы хотите поучаствовать в разработке проекта, форкните репозиторий, положите свои изменения в отдельную ветку и отправьте мне pull request.
+Если вы хотите поучаствовать в разработке проекта, форкните репозиторий, положите свои изменения в отдельную ветку, покройте их спеками и отправьте мне pull request.
 
 `vkontakte_api` тестируется под MRI `1.8.7`, `1.9.2` и `1.9.3`. Если в одной из этих сред что-то работает неправильно, либо вообще не работает, то это следует считать багом, и написать об этом в [issues на Github](https://github.com/7even/vkontakte_api/issues).

data/lib/generators/vkontakte_api/install/templates/initializer.rb

@@ -20,3 +20,6 @@ VkontakteApi.configure do |config|
   # log response JSON after successful responses
   # config.log_responses = false
 end
+
+# create a short alias VK for VkontakteApi module
+# VkontakteApi.register_alias

data/lib/vkontakte_api.rb

@@ -25,7 +25,16 @@ module VkontakteApi
   extend VkontakteApi::Configuration
   extend VkontakteApi::Authorization
   extend VkontakteApi::Uploading
+  
+  class << self
+    # Creates a short alias `VK` for `VkontakteApi` module.
+    def register_alias
+      Object.const_set(:VK, VkontakteApi)
+    end
+    
+    # Removes the `VK` alias.
+    def unregister_alias
+      Object.send(:remove_const, :VK) if defined?(VK)
+    end
+  end
 end
-
-# short alias
-VK = VkontakteApi unless defined?(VK)

data/lib/vkontakte_api/api.rb

@@ -4,7 +4,7 @@ module VkontakteApi
   # It uses Faraday with middleware underneath the hood.
   module API
     # URL prefix for calling API methods.
-    URL_PREFIX = 'https://api.vkontakte.ru/method'
+    URL_PREFIX = 'https://api.vk.com/method'
     
     class << self
       # API method call.
@@ -26,7 +26,7 @@ module VkontakteApi
         url   = options.delete(:url)
         token = options.delete(:token)
         
-        Faraday.new(url) do |builder|
+        Faraday.new(url, VkontakteApi.faraday_options) do |builder|
           builder.request  :oauth2, token unless token.nil?
           builder.request  :multipart
           builder.response :vk_logger

data/lib/vkontakte_api/configuration.rb

@@ -6,7 +6,7 @@ module VkontakteApi
   # @note `VkontakteApi::Configuration` extends `VkontakteApi` so these methods should be called from the latter.
   module Configuration
     # Available options.
-    OPTION_NAMES = [:app_id, :app_secret, :redirect_uri, :adapter, :logger, :log_requests, :log_errors, :log_responses]
+    OPTION_NAMES = [:app_id, :app_secret, :redirect_uri, :adapter, :faraday_options, :logger, :log_requests, :log_errors, :log_responses]
     
     attr_accessor *OPTION_NAMES
     
@@ -37,11 +37,12 @@ module VkontakteApi
     
     # Reset all configuration options to defaults.
     def reset
-      @adapter       = DEFAULT_ADAPTER
-      @logger        = ::Logger.new(STDOUT)
-      @log_requests  = DEFAULT_LOGGER_OPTIONS[:requests]
-      @log_errors    = DEFAULT_LOGGER_OPTIONS[:errors]
-      @log_responses = DEFAULT_LOGGER_OPTIONS[:responses]
+      @adapter         = DEFAULT_ADAPTER
+      @faraday_options = {}
+      @logger          = ::Logger.new(STDOUT)
+      @log_requests    = DEFAULT_LOGGER_OPTIONS[:requests]
+      @log_errors      = DEFAULT_LOGGER_OPTIONS[:errors]
+      @log_responses   = DEFAULT_LOGGER_OPTIONS[:responses]
     end
     
     # When this module is extended, set all configuration options to their default values.

data/lib/vkontakte_api/version.rb

@@ -1,4 +1,4 @@
 module VkontakteApi
   # Library version.
-  VERSION = '1.0.rc2'
+  VERSION = '1.0.rc3'
 end

data/spec/integration_spec.rb

@@ -3,8 +3,9 @@ require 'spec_helper'
 
 describe "Integration" do
   before(:all) do
+    VkontakteApi.register_alias
     # turn off all the logging
-    VkontakteApi.configure do |config|
+    VK.configure do |config|
       config.log_requests  = false
       config.log_errors    = false
       config.log_responses = false
@@ -13,20 +14,20 @@ describe "Integration" do
   
   describe "unauthorized requests" do
     before(:each) do
-      @vk = VkontakteApi::Client.new
+      @vk = VK::Client.new
     end
     
     it "get users" do
       user = @vk.users.get(:uid => 1).first
       user.uid.should        == 1
-      user.last_name.should  == 'Дуров'
-      user.first_name.should == 'Павел'
+      user.last_name.should_not  be_empty
+      user.first_name.should_not be_empty
     end
   end
   
   describe "authorized requests" do
     before(:each) do
-      @vk = VkontakteApi::Client.new(ENV['TOKEN'])
+      @vk = VK::Client.new(ENV['TOKEN'])
     end
     
     it "get groups" do
@@ -37,7 +38,7 @@ describe "Integration" do
   
   describe "requests with camelCase and predicate methods" do
     before(:each) do
-      @vk = VkontakteApi::Client.new(ENV['TOKEN'])
+      @vk = VK::Client.new(ENV['TOKEN'])
     end
     
     it "convert method names to vk.com format" do
@@ -47,12 +48,12 @@ describe "Integration" do
   
   describe "requests with array arguments" do
     before(:each) do
-      @vk = VkontakteApi::Client.new
+      @vk = VK::Client.new
     end
     
     it "join arrays with a comma" do
       users = @vk.users.get(:uids => [1, 2, 3], :fields => %w[first_name last_name screen_name])
-      users.first.screen_name.should == 'durov'
+      users.first.screen_name.should_not be_empty
     end
   end
   
@@ -66,19 +67,20 @@ describe "Integration" do
         "#{user.last_name} #{user.first_name}"
       end
       
-      users.first.should == 'Дуров Павел'
+      users.first.should_not be_empty
     end
   end
   
   describe "authorization" do
     context "with a scope" do
       it "returns a correct url" do
-        VkontakteApi.authorization_url(:scope => %w[friends groups]).should include('scope=friends%2Cgroups')
+        VK.authorization_url(:scope => %w[friends groups]).should include('scope=friends%2Cgroups')
       end
     end
   end
   
   after(:all) do
-    VkontakteApi.reset
+    VK.reset
+    VK.unregister_alias
   end
 end

data/spec/vkontakte_api/api_spec.rb

@@ -34,9 +34,11 @@ describe VkontakteApi::API do
   end
   
   describe ".connection" do
-    it "uses the :url parameter" do
+    it "uses the :url parameter and VkontakteApi.faraday_options" do
+      faraday_options = stub("Faraday options")
+      VkontakteApi.stub(:faraday_options).and_return(faraday_options)
       url = stub("URL")
-      Faraday.should_receive(:new).with(url)
+      Faraday.should_receive(:new).with(url, faraday_options)
       connection = subject.connection(:url => url)
     end
     

data/spec/vkontakte_api/configuration_spec.rb

@@ -24,6 +24,7 @@ describe VkontakteApi::Configuration do
       Configurable.app_id.should be_nil
       Configurable.app_secret.should be_nil
       Configurable.adapter.should == VkontakteApi::Configuration::DEFAULT_ADAPTER
+      Configurable.faraday_options.should == {}
       
       Configurable.logger.should be_a(Logger)
       Configurable.should log_requests

data/spec/vkontakte_api_spec.rb

@@ -15,4 +15,37 @@ describe VkontakteApi do
       VkontakteApi.reset
     end
   end
+  
+  describe ".register_alias" do
+    it "creates a VK alias" do
+      VkontakteApi.register_alias
+      VK.should == VkontakteApi
+    end
+    
+    after(:each) do
+      VkontakteApi.unregister_alias
+    end
+  end
+  
+  describe ".unregister_alias" do
+    context "after calling .register_alias" do
+      before(:each) do
+        VkontakteApi.register_alias
+      end
+      
+      it "removes the alias" do
+        VkontakteApi.unregister_alias
+        expect {
+          VK
+        }.to raise_error(NameError)
+      end
+    end
+    
+    context "without creating an alias" do
+      it "does nothing" do
+        Object.should_not_receive(:remove_const)
+        VkontakteApi.unregister_alias
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vkontakte_api
 version: !ruby/object:Gem::Version
-  version: 1.0.rc2
+  version: 1.0.rc3
   prerelease: 4
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2012-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday