smart_vk_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e42c24b1492eecfa6a9c1f2fb33054b0ae6bbe8f
-  data.tar.gz: 821f6c14fcee0bea3f505376563e0b31057817dd
+  metadata.gz: cc114237623563fcc0840b489143865529dc4353
+  data.tar.gz: 9d1c7c33d2a3da851e6d21db9d7245506b92dfc5
 SHA512:
-  metadata.gz: c7e49fe118e49fb980b823f460e7593b1e625aa53a845bdef82afe65b30a2bf3ce3ff3df0d16c7d29e0cd4abdbb570d196c9c49f8795d10992909954d89f55e4
-  data.tar.gz: b47a63e748a1083a4bd54b8428e20e3663f11a9020a558b23e3eaf8dac813304ae6d744ea05f12133086f0893073ba5dd2bd68249a13a77a61af1ae92d8446b4
+  metadata.gz: 586a88970465808274559974e6a2d267caa5e8d980676451075a19ebab55688475cbd001e06f83e7b0b0728a46e64349dc5528fd04763c2efb10f21610be9aef
+  data.tar.gz: 50b3e36b5f5a8c420274b1927962dbb378451757f5eaeb5a32a862a5767ca64fd3d30463dd5e25a810e68872fd61ecfd107bc8caa19a663a7fb9e03a4e0ddb10

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+
+## Версия 1.1.0
+
+* Добавлена возможность вызывать методы API, используя обычные методы Ruby.
+  
+  Пример:
+  
+  ```ruby
+    vk = SmartVkApi::VK.new
+    vk.users.get
+  ```
+
+* Добавлена возможность задать конфигурацию для обращений к API.
+
+  Пример:
+
+  ```ruby
+    SmartVkApi.configure do |conf|
+      conf.access_token = '7a6fa4dff77a228eeda56603'
+    end
+  ```
+
+  При этом токены, которые записаны в конфиг, будут автоматически использованы, если в методы не передано другого значения:
+
+  ```ruby
+    SmartVkApi.configure do |conf|
+      conf.access_token = '7a6fa4dff77a228eeda56603'
+    end
+    vk = SmartVkApi::VK.new
+    vk.access_token # => 7a6fa4dff77a228eeda56603
+  ```
+
+  Но можно также передать более специфичный конфиг, если это требуется:
+
+  ```ruby
+    SmartVkApi.configure do |conf|
+      conf.access_token = '7a6fa4dff77a228eeda56603'
+    end
+    config = SmartVkApi::Configuration.new
+    config.access_token = '36fb063aa7f0ad997b5f96e91fd362857b'
+    vk = SmartVkApi::VK.new(config)
+    vk.access_token # => 36fb063aa7f0ad997b5f96e91fd362857b
+  ```
+
+* Добавлена возможность прямого вызова API через метод модуля:
+  
+  Пример:
+
+  ```ruby
+    SmartVkApi.call('users.get', :user_ids => 'kimrgrey') # [{:uid=>3710412, :first_name=>"Сергей", :last_name=>"Цветков", :hidden=>1}]
+  ```
+
+Чтобы посомотреть предыдущие изменения, пожалуйста, откройте соответствующий релиз - [v1.0.0](https://github.com/kimrgrey/smart_vk_api/tree/v1.0.0)

data/README.md

@@ -1,5 +1,6 @@
 # SmartVkApi
 
+[![Gem Version](https://badge.fury.io/rb/smart_vk_api.svg)](http://badge.fury.io/rb/smart_vk_api)
 [![Build Status](https://travis-ci.org/kimrgrey/smart_vk_api.svg)](https://travis-ci.org/kimrgrey/smart_vk_api)
 [![Code Climate](https://codeclimate.com/github/kimrgrey/smart_vk_api/badges/gpa.svg)](https://codeclimate.com/github/kimrgrey/smart_vk_api)
 

data/lib/smart_vk_api/call.rb

@@ -1,7 +1,6 @@
 module SmartVkApi
   module Call
-    def call(method_name, *options)
-      params = options.last if options && options.last.is_a?(Hash)
+    def call(method_name, params = {})
       http(method_name, params) do |response|
         raise SmartVkApi::MethodCallError, response.body unless response.is_a?(Net::HTTPSuccess)
         json = response.body
@@ -24,6 +23,10 @@ module SmartVkApi
       if method_name.nil? || method_name.empty?
         raise ArgumentError, 'Method name could not be empty'
       end
+      if access_token && (params.nil? || !params.key?(:access_token))
+        params ||= {}
+        params[:access_token] = access_token
+      end
       url = SmartVkApi::Constants::METHOD_CALL_URL + "/#{method_name}"
       url += "?#{URI.encode_www_form(params)}" if params && params.any?
       url

data/lib/smart_vk_api/configuration.rb

@@ -0,0 +1,7 @@
+module SmartVkApi
+  class Configuration
+    attr_accessor :app_id
+    attr_accessor :app_token
+    attr_accessor :access_token
+  end
+end

data/lib/smart_vk_api/constants.rb

@@ -2,5 +2,6 @@ module SmartVkApi
   module Constants
     API_URL = "https://api.vk.com".freeze
     METHOD_CALL_URL = "#{SmartVkApi::Constants::API_URL}/method".freeze
+    METHOD_NAME_REGEXP = /\A([a-z,A-Z]+)\.([a-z,A-Z]+)\Z/
   end
 end

data/lib/smart_vk_api/methods.rb

@@ -0,0 +1,29 @@
+module SmartVkApi
+  module Methods
+    def method_missing(method_name, *arguments, &block)
+      Proxy.new(self, method_name)
+    end
+
+    def respond_to?(method_name, include_private = false)
+      true # we should respond to any method using Proxy
+    end
+
+    class Proxy
+      attr_accessor :vk
+      attr_accessor :scope
+
+      def initialize(vk, scope)
+        self.vk = vk
+        self.scope = scope
+      end
+
+      def method_missing(method_name, *arguments, &block)
+        vk.call("#{scope}.#{method_name}", arguments.first)
+      end
+
+      def respond_to?(method_name, include_private = false)
+        true # we should respond to any method using Proxy
+      end
+    end
+  end
+end

data/lib/smart_vk_api/version.rb

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

data/lib/smart_vk_api.rb

@@ -4,10 +4,54 @@ require 'json'
 module SmartVkApi
   autoload :Constants, "smart_vk_api/constants"
   autoload :Call, "smart_vk_api/call"
+  autoload :Methods, "smart_vk_api/methods"
+  autoload :Configuration, "smart_vk_api/configuration"
 
   class MethodCallError < StandardError; end;
 
   class VK
     include SmartVkApi::Call
+    include SmartVkApi::Methods
+
+    def initialize(configuration = nil)
+      @configuration = configuration
+    end
+
+    def configuration
+      @configuration || SmartVkApi.configuration
+    end
+
+    def access_token
+      configuration.access_token unless configuration.nil?
+    end
+
+    def app_id
+      configuration.app_id unless configuration.nil?
+    end
+
+    def app_token
+      configuration.app_token unless configuration.nil?
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.reset_configuration
+    self.configuration = nil
+  end
+
+  def self.configure
+    self.configuration ||= SmartVkApi::Configuration.new
+    yield(configuration)
+  end
+
+  def self.vk
+    SmartVkApi::VK.new
+  end
+
+  def self.call(method_name, params = {})
+    vk.call(method_name, params)
   end
 end

data/spec/call_spec.rb

@@ -8,37 +8,63 @@ describe SmartVkApi::VK do
   let (:vk) { SmartVkApi::VK.new }
   let (:default_response_body) { {:response => {:test => 'yes'} } }
 
-  describe '#method_url' do
-    it 'should raise ArgumentError when method name is nil' do
-      expect{ vk.method_url(nil) }.to raise_error(ArgumentError, 'Method name could not be empty')
-    end
-    
-    it 'should raise ArgumentError when method name is empty string' do
-      expect{ vk.method_url('') }.to raise_error(ArgumentError, 'Method name could not be empty')
-    end
-    
-    it 'should take care of method name' do
-      expect(vk.method_url('scope.method')).to eq('https://api.vk.com/method/scope.method')
+  before do
+    SmartVkApi.reset_configuration
+  end
+
+  describe '#method_url' do    
+    context 'without access token' do
+      it 'should raise ArgumentError when method name is nil' do
+        expect{ vk.method_url(nil) }.to raise_error(ArgumentError, 'Method name could not be empty')
+      end
+      
+      it 'should raise ArgumentError when method name is empty string' do
+        expect{ vk.method_url('') }.to raise_error(ArgumentError, 'Method name could not be empty')
+      end
+      
+      it 'should take care of method name' do
+        expect(vk.method_url('users.get')).to eq('https://api.vk.com/method/users.get')
+      end
+
+      it 'should take care of parameters' do
+        expect(vk.method_url('users.get', {:aaa => :bbb, :user_ids => :kimrgrey})).to eq('https://api.vk.com/method/users.get?aaa=bbb&user_ids=kimrgrey')
+      end
     end
 
-    it 'should take care of parameters' do
-      expect(vk.method_url('scope.method', {:aaa => :bbb, :xxx => :yyy})).to eq('https://api.vk.com/method/scope.method?aaa=bbb&xxx=yyy')
+    context 'with access token' do
+      it 'should add access token when no parameters given' do
+        expect(vk.method_url('users.get', :access_token => '7a6fa4dff77a228eeda56603')).to eq('https://api.vk.com/method/users.get?access_token=7a6fa4dff77a228eeda56603')
+      end
+
+      it 'should use access token from configuration by default' do
+        SmartVkApi.configure do |conf|
+          conf.access_token = '7a6fa4dff77a228eeda56603'
+        end
+        expect(vk.method_url('users.get')).to eq('https://api.vk.com/method/users.get?access_token=7a6fa4dff77a228eeda56603')
+      end
+
+      it 'should use specified access token if it was given' do
+        SmartVkApi.configure do |conf|
+          conf.access_token = '7a6fa4dff77a228eeda56603'
+        end
+        expect(vk.method_url('users.get', :access_token => '7a6fa4dff77a228eeda56604')).to eq('https://api.vk.com/method/users.get?access_token=7a6fa4dff77a228eeda56604')
+      end
     end
   end
 
   describe '#http' do
     it 'should return http connection if block was not given' do
-      expect( vk.http('scope.method')).to be_a(Net::HTTP)
+      expect( vk.http('users.get')).to be_a(Net::HTTP)
     end
     
     it 'should return result of block call if block was given' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => default_response_body.to_json)
-      expect( vk.http('scope.method') { |_| 'result of block' }).to eq('result of block')
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      expect( vk.http('users.get') { |_| 'result of block' }).to eq('result of block')
     end
 
     it 'should pass http connection as parameter into block' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => default_response_body.to_json)
-      expect(vk.http('scope.method') { |http| http }).to be_a(Net::HTTPResponse)
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      expect(vk.http('users.get') { |http| http }).to be_a(Net::HTTPResponse)
     end
 
     it 'should setup appropriate headers' do
@@ -46,54 +72,54 @@ describe SmartVkApi::VK do
         'Content-Type' =>'application/json',
         'Content-Type' =>'application/json'
       }
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => default_response_body.to_json)
-      vk.call('scope.method')
-      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/scope.method").with(:headers => headers)
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.call('users.get')
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get").with(:headers => headers)
     end
   end
 
   describe '#call' do
     it 'should send request to appropriate url according to method name' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => default_response_body.to_json)
-      vk.call('scope.method')
-      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/scope.method")
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.call('users.get')
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get")
     end
 
     it 'should send request to appropriate url according params' do
-      stub_request(:get, "https://api.vk.com/method/scope.method?xxx=yyy").to_return(:status => 200, :body => default_response_body.to_json)
-      vk.call('scope.method', {:xxx => 'yyy'})
-      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/scope.method?xxx=yyy")
+      stub_request(:get, "https://api.vk.com/method/users.get?user_ids=kimrgrey").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.call('users.get', {:user_ids => 'kimrgrey'})
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get?user_ids=kimrgrey")
     end
 
     it 'should return raise MethodCallError if body of response is nil' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => nil)
-      expect { vk.call('scope.method') }.to raise_error(SmartVkApi::MethodCallError, 'Response could not be empty')
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => nil)
+      expect { vk.call('users.get') }.to raise_error(SmartVkApi::MethodCallError, 'Response could not be empty')
     end
 
     it 'should return raise MethodCallError if body of response is empty string' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => "")
-      expect { vk.call('scope.method') }.to raise_error(SmartVkApi::MethodCallError, 'Response could not be empty')
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => "")
+      expect { vk.call('users.get') }.to raise_error(SmartVkApi::MethodCallError, 'Response could not be empty')
     end
 
     it 'should return raise MethodCallError if body of response has no key :response' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => { :bad => :response }.to_json)
-      expect { vk.call('scope.method') }.to raise_error(SmartVkApi::MethodCallError, 'Response should include key named :response')
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => { :bad => :response }.to_json)
+      expect { vk.call('users.get') }.to raise_error(SmartVkApi::MethodCallError, 'Response should include key named :response')
     end
 
     it 'should raise MethodCallError error in case of internal server error' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 500, :body => 'Internal Server Error')
-      expect { vk.call('scope.method') }.to raise_error(SmartVkApi::MethodCallError, 'Internal Server Error')
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 500, :body => 'Internal Server Error')
+      expect { vk.call('users.get') }.to raise_error(SmartVkApi::MethodCallError, 'Internal Server Error')
     end
 
     it 'should raise MethodCallError in case of method call error' do
       response = { :error => { :error_code => 113, :error_msg => 'Invalid user id' } }
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => response.to_json)
-      expect { vk.call('scope.method') }.to raise_error(SmartVkApi::MethodCallError, response.to_json)
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => response.to_json)
+      expect { vk.call('users.get') }.to raise_error(SmartVkApi::MethodCallError, response.to_json)
     end
 
     it 'should return value of :response key of returned json' do
-      stub_request(:get, "https://api.vk.com/method/scope.method").to_return(:status => 200, :body => default_response_body.to_json)
-      expect(vk.call('scope.method')).to eq(default_response_body[:response])
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      expect(vk.call('users.get')).to eq(default_response_body[:response])
     end
   end
 end

data/spec/methods_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe SmartVkApi::VK do
+  it { is_expected.to respond_to(:users, :wall, :photos, :friends, :audio, :groups) }
+  
+  before do
+    SmartVkApi.reset_configuration
+  end
+    
+  describe 'methods proxy' do
+    let (:vk) { SmartVkApi::VK.new }
+    let (:default_response_body) { {:response => {:test => 'yes'} } }
+
+    it 'should allow to call API methods using scope.method notation' do
+      expect(vk.users).to respond_to(:get, :search, :report)
+    end
+
+    it 'should perform API request on method call' do
+      stub_request(:get, "https://api.vk.com/method/users.get").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.users.get
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get")
+    end
+
+    it 'should pass parameters to API request' do
+      stub_request(:get, "https://api.vk.com/method/users.get?user_ids=kimrgrey").to_return(:status => 200, :body => default_response_body.to_json)
+      vk.users.get({:user_ids => "kimrgrey"})
+      expect(WebMock).to have_requested(:get, "https://api.vk.com/method/users.get?user_ids=kimrgrey")
+    end
+  end
+
+  describe 'configuration' do
+    it { is_expected.to respond_to(:configuration) }
+
+    before do
+      SmartVkApi.configure do |conf|
+        conf.app_id = '0000000'
+        conf.app_token = '7a6fa4dff77a228eeda56603'
+        conf.access_token = '7a6fa4dff77a228eeda220349'
+      end
+    end
+    
+    it 'should use global configuration by default' do
+      vk = SmartVkApi::VK.new
+      expect(vk.configuration).to eq(SmartVkApi.configuration)
+    end
+
+    it 'should provide direct access to configuration fields' do
+      vk = SmartVkApi::VK.new
+      expect(vk.app_id).to eq('0000000')
+      expect(vk.app_token).to eq('7a6fa4dff77a228eeda56603')
+      expect(vk.access_token).to eq('7a6fa4dff77a228eeda220349')
+    end
+
+    it 'should be ready that configuration will be nil' do
+      SmartVkApi.reset_configuration
+      vk = SmartVkApi::VK.new
+      expect(vk.configuration).to be nil
+      expect(vk.app_id).to be nil
+      expect(vk.app_token).to be nil
+      expect(vk.access_token).to be nil
+    end
+
+    it 'should use specific configuration if is was given' do
+      config = SmartVkApi::Configuration.new
+      vk = SmartVkApi::VK.new(config)
+      expect(vk.configuration).to eq(config)
+    end
+  end
+end

data/spec/smart_vk_api_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe SmartVkApi do
+
+  describe 'call' do
+    it { is_expected.to respond_to(:vk) }
+    it { is_expected.to respond_to(:call) }
+
+    it 'should delegate call to VK instance' do
+      vk = SmartVkApi.vk
+      allow(SmartVkApi).to receive(:vk) { vk }
+      expect(vk).to receive(:call)
+      SmartVkApi.call('users.get', {:user_ids => 'kimrgrey'})
+    end
+  end
+
+  describe 'configuration' do
+    it { is_expected.to respond_to(:configure) }
+
+    before do
+      SmartVkApi.configure do |conf|
+        conf.app_id = '0000000'
+        conf.app_token = '7a6fa4dff77a228eeda56603'
+      end
+    end
+
+    it 'should allow to reset configuration' do
+      SmartVkApi.reset_configuration
+      expect(SmartVkApi.configuration).to be nil
+    end
+
+    it 'should allow to read global configuration' do
+      expect(SmartVkApi.configuration.app_id).to eq('0000000')
+      expect(SmartVkApi.configuration.app_token).to eq('7a6fa4dff77a228eeda56603')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_vk_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sergey Tsvetkov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,16 +76,21 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/smart_vk_api.rb
 - lib/smart_vk_api/call.rb
+- lib/smart_vk_api/configuration.rb
 - lib/smart_vk_api/constants.rb
+- lib/smart_vk_api/methods.rb
 - lib/smart_vk_api/version.rb
 - smart_vk_api.gemspec
 - spec/call_spec.rb
+- spec/methods_spec.rb
+- spec/smart_vk_api_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kimrgrey/smart_vk_api
 licenses:
@@ -113,4 +118,6 @@ specification_version: 4
 summary: Small, thin and fast client for VK API
 test_files:
 - spec/call_spec.rb
+- spec/methods_spec.rb
+- spec/smart_vk_api_spec.rb
 - spec/spec_helper.rb