smart_vk_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e42c24b1492eecfa6a9c1f2fb33054b0ae6bbe8f
+  data.tar.gz: 821f6c14fcee0bea3f505376563e0b31057817dd
+SHA512:
+  metadata.gz: c7e49fe118e49fb980b823f460e7593b1e625aa53a845bdef82afe65b30a2bf3ce3ff3df0d16c7d29e0cd4abdbb570d196c9c49f8795d10992909954d89f55e4
+  data.tar.gz: b47a63e748a1083a4bd54b8428e20e3663f11a9020a558b23e3eaf8dac813304ae6d744ea05f12133086f0893073ba5dd2bd68249a13a77a61af1ae92d8446b4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+
+gemfile:
+  - Gemfile
+
+script: "bundle exec rspec"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smart_vk_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sergey Tsvetkov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# SmartVkApi
+
+[![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)
+
+Библиотека, обеспечивающая по-настоящему удобный и простой интерфейс для работы с API социальной сети "Вконтакте".
+
+## Что еще один?
+
+Да, в некотором роде. Но не совсем. 
+
+1. Почти все гемы для работы с VK API, которые можно [найти на rubygems.org](https://rubygems.org/search?utf8=%E2%9C%93&query=vkontakte), давно не обновлялись. 
+2. Один из самых [приятно реализованных](https://github.com/7even/vkontakte_api) и более или менее актуальных тянет за собой [количество зависимостей](https://github.com/7even/vkontakte_api/blob/master/vkontakte_api.gemspec#L21-L39), которое ставит в тупик.
+
+Поэтому при разработке этого гема используются три простых принципа:
+
+1. Он должен быть максимально удобным в использовании;
+2. Он должен быть настолько "тонким" по отношению к API, насколько это вообще возможно сделать, не жертвуя первым пунктом;
+3. Он должен тянуть за собой только **необходимый минимум** зависимостей, в идеале - **ни одной**;
+
+## Как установить?
+
+Добавьте в Gemfile вашего приложения:
+
+```ruby
+gem 'smart_vk_api'
+```
+
+После чего запустите:
+
+```
+$ bundle install
+```
+
+Или просто установите гем вручную:
+
+```
+$ gem install smart_vk_api
+```
+
+## Как помочь в разработке?
+
+Все как обычно:
+
+1. Сделайте форк (https://github.com/kimrgrey/smart_vk_api/fork)
+2. Добавьте ветку (`git checkout -b my-new-feature`)
+3. Сделайте коммит (`git commit -am 'Add some feature'`)
+4. Сделайте пуш (`git push origin my-new-feature`)
+5. Пришлите pull request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/smart_vk_api.rb

@@ -0,0 +1,13 @@
+require 'net/http'
+require 'json'
+
+module SmartVkApi
+  autoload :Constants, "smart_vk_api/constants"
+  autoload :Call, "smart_vk_api/call"
+
+  class MethodCallError < StandardError; end;
+
+  class VK
+    include SmartVkApi::Call
+  end
+end

data/lib/smart_vk_api/call.rb

@@ -0,0 +1,45 @@
+module SmartVkApi
+  module Call
+    def call(method_name, *options)
+      params = options.last if options && options.last.is_a?(Hash)
+      http(method_name, params) do |response|
+        raise SmartVkApi::MethodCallError, response.body unless response.is_a?(Net::HTTPSuccess)
+        json = response.body
+        raise SmartVkApi::MethodCallError, 'Response could not be empty' if json.nil? || json.empty?
+        parsed_json = JSON.parse(json, :symbolize_names => true)
+        raise SmartVkApi::MethodCallError, json if is_error?(parsed_json)
+        raise SmartVkApi::MethodCallError, 'Response should include key named :response' unless parsed_json.has_key?(:response)
+        parsed_json[:response]
+      end
+    end
+
+    def http(method_name, params = {})
+      uri = URI(method_url(method_name, params))
+      http = Net::HTTP.new(uri.host,uri.port)
+      http.use_ssl = true
+      block_given? ? yield(http.get(uri.request_uri, headers)) : http
+    end
+
+    def method_url(method_name, params = {})
+      if method_name.nil? || method_name.empty?
+        raise ArgumentError, 'Method name could not be empty'
+      end
+      url = SmartVkApi::Constants::METHOD_CALL_URL + "/#{method_name}"
+      url += "?#{URI.encode_www_form(params)}" if params && params.any?
+      url
+    end
+
+    protected
+
+    def is_error?(parsed_json)
+      parsed_json.has_key?(:error)
+    end
+
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' =>'application/json'
+      }
+    end
+  end
+end

data/lib/smart_vk_api/constants.rb

@@ -0,0 +1,6 @@
+module SmartVkApi
+  module Constants
+    API_URL = "https://api.vk.com".freeze
+    METHOD_CALL_URL = "#{SmartVkApi::Constants::API_URL}/method".freeze
+  end
+end

data/lib/smart_vk_api/version.rb

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

data/smart_vk_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_vk_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_vk_api"
+  spec.version       = SmartVkApi::VERSION
+  spec.authors       = ["Sergey Tsvetkov"]
+  spec.email         = ["sergey.a.tsvetkov@gmail.com"]
+  spec.summary       = %q{Small, thin and fast client for VK API}
+  spec.homepage      = "https://github.com/kimrgrey/smart_vk_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2"
+  spec.add_development_dependency 'webmock', "~> 1.20"
+end

data/spec/call_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe SmartVkApi::VK do
+  it { should respond_to(:call) }
+  it { should respond_to(:method_url) }
+  it { should respond_to(:http) }
+
+  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')
+    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')
+    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)
+    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')
+    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)
+    end
+
+    it 'should setup appropriate headers' do
+      headers = {
+        '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)
+    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")
+    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")
+    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')
+    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')
+    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')
+    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')
+    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)
+    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])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+
+Bundler.setup
+
+require 'webmock/rspec'
+require 'smart_vk_api'
+
+RSpec.configure do |config|
+  config.mock_with :rspec do |mocks|
+    mocks.verify_doubled_constant_names = true
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: smart_vk_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sergey Tsvetkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: 
+email:
+- sergey.a.tsvetkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smart_vk_api.rb
+- lib/smart_vk_api/call.rb
+- lib/smart_vk_api/constants.rb
+- lib/smart_vk_api/version.rb
+- smart_vk_api.gemspec
+- spec/call_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kimrgrey/smart_vk_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Small, thin and fast client for VK API
+test_files:
+- spec/call_spec.rb
+- spec/spec_helper.rb