vkontakte_api 1.0.1 → 1.0.2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.0.2 (08.09.2012)
+
+* Пространство имен `widgets`
+* Возможность изменять HTTP-метод, используемый в методах API
+
 ## 1.0.1 (13.08.2012)
 
 * Пространство имен `leads`

data/README.md

@@ -178,6 +178,8 @@ VkontakteApi.configure do |config|
   
   # faraday-адаптер для сетевых запросов
   config.adapter = :net_http
+  # HTTP-метод для вызова методов API (:get или :post)
+  config.http_verb = :get
   # параметры для faraday-соединения
   config.faraday_options = {
     ssl: {
@@ -203,6 +205,8 @@ VkontakteApi.register_alias
 
 По умолчанию для HTTP-запросов используется `Net::HTTP`; можно выбрать [любой другой адаптер](https://github.com/technoweenie/faraday/blob/master/lib/faraday/adapter.rb), поддерживаемый `faraday`.
 
+ВКонтакте [позволяет](http://vk.com/developers.php?oid=-1&p=%D0%92%D1%8B%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%BE%D0%B2_%D0%BA_API) использовать как `GET`-, так и `POST`-запросы при вызове методов API. По умолчанию `vkontakte_api` использует `GET`, но в настройке `http_verb` можно указать `:post`, чтобы совершать `POST`-запросы.
+
 При необходимости можно указать параметры для faraday-соединения - например, параметры прокси-сервера или путь к SSL-сертификатам.
 
 Чтобы сгенерировать файл с настройками по умолчанию в rails-приложении, можно воспользоваться генератором `vkontakte_api:install`:
@@ -222,6 +226,7 @@ $ rails generate vkontakte_api:install
 
 * метод, возвращающий права текущего токена в читабельной форме (используя `getUserSettings` и кэшируя результат)
 * сохранение параметра `expires_in` токена в объекте `VkontakteApi::Client` после авторизации через `VkontakteApi.authorize`
+* `POST`-запросы по умолчанию
 
 ## Участие в разработке
 

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

@@ -7,6 +7,9 @@ VkontakteApi.configure do |config|
   # Faraday adapter to make requests with:
   # config.adapter = :net_http
   
+  # HTTP verb for API methods (:get or :post)
+  # config.http_verb = :get
+  
   # Logging parameters:
   # log everything through the rails logger
   config.logger = Rails.logger

data/lib/vkontakte_api/api.rb

@@ -14,7 +14,7 @@ module VkontakteApi
       # @return [Hashie::Mash] Mashed server response.
       def call(method_name, args = {}, token = nil)
         flat_arguments = Utils.flatten_arguments(args)
-        connection(:url => URL_PREFIX, :token => token).get(method_name, flat_arguments).body
+        connection(:url => URL_PREFIX, :token => token).send(VkontakteApi.http_verb, method_name, flat_arguments).body
       end
       
       # Faraday connection.
@@ -29,6 +29,7 @@ module VkontakteApi
         Faraday.new(url, VkontakteApi.faraday_options) do |builder|
           builder.request  :oauth2, token unless token.nil?
           builder.request  :multipart
+          builder.request  :url_encoded
           builder.response :vk_logger
           builder.response :mashify
           builder.response :oj, :preserve_raw => true

data/lib/vkontakte_api/configuration.rb

@@ -6,7 +6,18 @@ 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, :faraday_options, :logger, :log_requests, :log_errors, :log_responses]
+    OPTION_NAMES = [
+      :app_id,
+      :app_secret,
+      :redirect_uri,
+      :adapter,
+      :http_verb,
+      :faraday_options,
+      :logger,
+      :log_requests,
+      :log_errors,
+      :log_responses
+    ]
     
     attr_accessor *OPTION_NAMES
     
@@ -17,6 +28,9 @@ module VkontakteApi
     # Default HTTP adapter.
     DEFAULT_ADAPTER = Faraday.default_adapter
     
+    # Default HTTP verb for API methods.
+    DEFAULT_HTTP_VERB = :get
+    
     # Logger default options.
     DEFAULT_LOGGER_OPTIONS = {
       :requests  => true,
@@ -38,6 +52,7 @@ module VkontakteApi
     # Reset all configuration options to defaults.
     def reset
       @adapter         = DEFAULT_ADAPTER
+      @http_verb       = DEFAULT_HTTP_VERB
       @faraday_options = {}
       @logger          = ::Logger.new(STDOUT)
       @log_requests    = DEFAULT_LOGGER_OPTIONS[:requests]

data/lib/vkontakte_api/namespaces.yml

@@ -16,6 +16,7 @@
 - pages
 - stats
 - subscriptions
+- widgets
 - leads
 - messages
 - status

data/lib/vkontakte_api/version.rb

@@ -1,4 +1,4 @@
 module VkontakteApi
   # Library version.
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/vkontakte_api/api_spec.rb

@@ -31,6 +31,19 @@ describe VkontakteApi::API do
     it "returns the response body" do
       subject.call('apiMethod').should == @result
     end
+    
+    it "uses an HTTP verb from VkontakteApi.http_verb" do
+      http_verb = stub("HTTP verb")
+      VkontakteApi.http_verb = http_verb
+      
+      response = stub("Response", :body => stub)
+      @connection.should_receive(:send).with(http_verb, 'apiMethod', {}).and_return(response)
+      subject.call('apiMethod')
+    end
+    
+    after(:each) do
+      VkontakteApi.reset
+    end
   end
   
   describe ".connection" do

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.http_verb.should == VkontakteApi::Configuration::DEFAULT_HTTP_VERB
       Configurable.faraday_options.should == {}
       
       Configurable.logger.should be_a(Logger)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vkontakte_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday