smart_vk_api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc114237623563fcc0840b489143865529dc4353
-  data.tar.gz: 9d1c7c33d2a3da851e6d21db9d7245506b92dfc5
+  metadata.gz: 8354ecbe8304332b16d0b43a4c69060d19ef0cf5
+  data.tar.gz: fafd8588f05532cb2609a04a36ec0f9e4099edc5
 SHA512:
-  metadata.gz: 586a88970465808274559974e6a2d267caa5e8d980676451075a19ebab55688475cbd001e06f83e7b0b0728a46e64349dc5528fd04763c2efb10f21610be9aef
-  data.tar.gz: 50b3e36b5f5a8c420274b1927962dbb378451757f5eaeb5a32a862a5767ca64fd3d30463dd5e25a810e68872fd61ecfd107bc8caa19a663a7fb9e03a4e0ddb10
+  metadata.gz: 9a23dfe06a3160339651dbc49244401d8d9202bf6bc86c3d2f1c11c5822869d7494fc7cd1ec22e2453a5269433dfcb7dd001e25e6357a19a6181227d11294302
+  data.tar.gz: 4cc3ebfc7cc1aea74f878d46c1635d343a6efadc50077bab16b6fd12ce9c86a3102220e8300ab6449d592b4c0133372f07198edc7e0ed328f2235189fe146418

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Версия 1.1.1
+
+* В `Proxy` обработка методов API в camelCase нотации. Например, вызвать `users.isAppUser` можно так:
+  
+  ```ruby
+    SmartVkApi.vk.users.is_app_user(:user_id => 'kimrgrey')
+  ```
 
 ## Версия 1.1.0
 

data/README.md

@@ -39,6 +39,58 @@ $ bundle install
 $ gem install smart_vk_api
 ```
 
+## Прямое использование API
+
+В простейшем случае можно вызвать произвольный метод VK API и передать ему параметры следующим образом:
+
+```ruby
+SmartVkApi.call('users.get', :user_ids => 'kimrgrey') # [{:uid=>3710412, ...}]
+```
+
+Для вызова нескольких методов разумно создать враппер один раз и использовать его повторно:
+
+```ruby
+vk = SmartVkApi.vk
+vk.call('users.get', :user_ids => 'kimrgrey') # [{:uid=>3710412, ...}]
+vk.call('photos.get', :owner_id => '3710412', :album_id => 'wall')
+```
+
+По умолчанию, `access_token` не передается, так что для вызова доступны только публичные методы. При попытке вызвать метод, требующий наличие токена, возникнет исключение `SmartVkApi::MethodCallError`. Например:
+
+```ruby
+SmartVkApi.call('wall.get', :owner_id => '3710412') # SmartVkApi::MethodCallError: {"error":{..., "error_msg":"Access denied: user hid his wall from accessing from outside"}}
+```
+
+Чтобы вызвать приватные методы, можно задать глобальный конфиг, токен из которого будет использоваться по умолчанию, если он задан:
+
+```ruby
+SmartVkApi.configure do |config|
+  config.access_token = ACCESS_TOKEN
+end
+```
+
+Если при этом передать другой `access_token` в качестве параметра для метода `call`, ему будет отдано предпочтение:
+
+```ruby
+SmartVkApi.call('users.get', :user_ids => 'kimrgrey', :access_token => ANOTHER_ACCESS_TOKEN)
+```
+
+## Проксирующий объект
+
+Вместо прямых обращений к API через передачу имени метода в качестве параметра для `call` можно использовать более удобный вариант, позволяющий вызывать методы VK API как собственные методы враппера. Пример:
+
+```ruby
+  vk = SmartVkApi.vk
+  vk.users.get(:user_ids => 'kimrgrey')
+```
+
+Токен доступа, как и для прямых вызовов, можно задать в конфиге или передать в качестве параметра метода.
+
+```ruby
+  vk = SmartVkApi.vk
+  vk.users.get(:user_ids => 'kimrgrey', :access_token => ACCESS_TOKEN)
+```
+
 ## Как помочь в разработке?
 
 Все как обычно:

data/lib/smart_vk_api/methods.rb

@@ -12,12 +12,19 @@ module SmartVkApi
       attr_accessor :vk
       attr_accessor :scope
 
+      def self.camelcase(method_name)
+        result = method_name.to_s.split('_').map(&:capitalize).join
+        result[0] = result[0].downcase
+        result
+      end
+
       def initialize(vk, scope)
         self.vk = vk
         self.scope = scope
       end
 
       def method_missing(method_name, *arguments, &block)
+        method_name = Proxy.camelcase(method_name)
         vk.call("#{scope}.#{method_name}", arguments.first)
       end
 

data/lib/smart_vk_api/version.rb

@@ -1,3 +1,3 @@
 module SmartVkApi
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/methods_spec.rb

@@ -26,6 +26,12 @@ describe SmartVkApi::VK do
       vk.users.get({:user_ids => "kimrgrey"})
       expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get?user_ids=kimrgrey")
     end
+
+    it 'should convert method name using CamelCase' do
+      stub_request(:get, "https://api.vk.com/method/users.isAppUser?user_id=kimrgrey").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.users.is_app_user(:user_id => 'kimrgrey')
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.isAppUser?user_id=kimrgrey")
+    end
   end
 
   describe 'configuration' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_vk_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sergey Tsvetkov