vkontakte_api 0.2.1 → 1.0.rc

data/spec/vkontakte_api/result_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe VkontakteApi::Result do
+  describe ".process" do
+    before(:each) do
+      @response = stub("Response")
+      @result = stub("Result")
+      subject.stub(:extract_result).and_return(@result)
+    end
+    
+    it "calls .extract_result passing it the response" do
+      subject.should_receive(:extract_result).with(@response)
+      subject.process(@response, @type, nil)
+    end
+    
+    context "with a non-enumerable result" do
+      before(:each) do
+        @type = stub("Type")
+        @typecasted_value = stub("Typecasted value")
+        subject.stub(:typecast).and_return(@typecasted_value)
+      end
+      
+      it "returns #typecast-ed value" do
+        subject.should_receive(:typecast).with(@result, @type).and_return(@typecasted_value)
+        subject.send(:process, @result, @type, nil).should == @typecasted_value
+      end
+      
+      context "when block_given?" do
+        it "yields the #typecast-ed value and returns the result of the block" do
+          block_result = stub("Block result")
+          @typecasted_value.should_receive(:result_method).and_return(block_result)
+          block = proc(&:result_method)
+          
+          subject.send(:process, @response, @type, block).should == block_result
+        end
+      end
+    end
+    
+    context "with an enumerable result" do
+      before(:each) do
+        @element1 = stub("First element")
+        @element2 = stub("Second element")
+        @enumerable_result = [@element1, @element2]
+        subject.stub(:extract_result).and_return(@enumerable_result)
+      end
+      
+      it "returns the untouched value" do
+        subject.send(:process, @enumerable_result, :anything, nil).should == @enumerable_result
+      end
+      
+      context "when block_given?" do
+        it "yields each element untouched to the block" do
+          result1 = stub("First element after result_method")
+          result2 = stub("Second element after result_method")
+          @element1.should_receive(:result_method).and_return(result1)
+          @element2.should_receive(:result_method).and_return(result2)
+          block = proc(&:result_method)
+          
+          subject.send(:process, @enumerable_result, :anything, block).should == [result1, result2]
+        end
+      end
+    end
+  end
+  
+  describe ".extract_result" do
+    before(:each) do
+      @result_response  = {'key' => 'value'}
+      @result_error     = {'request_params' => [{'key' => 'error', 'value' => 'description'}]}
+    end
+    
+    context "with a successful response" do
+      before(:each) do
+        @result = Hashie::Mash.new(:response => @result_response)
+      end
+      
+      it "returns the response part" do
+        subject.send(:extract_result, @result).should == @result_response
+      end
+    end
+    
+    context "with an error response" do
+      before(:each) do
+        @result = Hashie::Mash.new(:error => @result_error)
+      end
+      
+      it "raises a VkontakteApi::Error" do
+        expect {
+          subject.send(:extract_result, @result)
+        }.to raise_error(VkontakteApi::Error)
+      end
+    end
+  end
+  
+  describe ".typecast" do
+    context "with an :anything type" do
+      it "returns it's argument untouched" do
+        subject.send(:typecast, :some_arg, :anything).should == :some_arg
+      end
+    end
+    
+    context "with a :boolean type" do
+      context "and zero result" do
+        it "returns false" do
+          subject.send(:typecast, '0', :boolean).should == false
+        end
+      end
+      
+      context "and non-zero parameter" do
+        it "returns true" do
+          subject.send(:typecast, '1', :boolean).should == true
+        end
+      end
+    end
+  end
+end

data/spec/vkontakte_api/uploading_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe VkontakteApi::Uploading do
+  before(:each) do
+    @uploader = Object.new
+    @uploader.extend VkontakteApi::Uploading
+  end
+  
+  describe "#upload" do
+    before(:each) do
+      @upload_io = stub("Faraday::UploadIO instance")
+      Faraday::UploadIO.stub(:new).and_return(@upload_io)
+      
+      @response_body = stub("Server response body")
+      response       = stub("Server response", :body => @response_body)
+      @connection    = stub("Faraday connection", :post => response)
+      VkontakteApi::API.stub(:connection).and_return(@connection)
+    end
+    
+    context "without a :url param" do
+      it "raises an ArgumentError" do
+        expect {
+          @uploader.upload
+        }.to raise_error(ArgumentError)
+      end
+    end
+    
+    it "creates a Faraday::UploadIO for each file passed in" do
+      path = stub("File path")
+      type = stub("File mime type")
+      Faraday::UploadIO.should_receive(:new).with(path, type)
+      @uploader.upload(:url => 'http://example.com', :file1 => [path, type])
+    end
+    
+    it "POSTs the files through the connection to a given URL" do
+      url  = stub("URL")
+      file = stub("File")
+      @connection.should_receive(:post).with(url, :file1 => @upload_io)
+      @uploader.upload(:url => url, :file1 => file)
+    end
+    
+    it "returns the server response" do
+      @uploader.upload(:url => 'http://example.com').should == @response_body
+    end
+  end
+end

data/spec/vkontakte_api/utils_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe VkontakteApi::Utils do
+  describe ".flatten_arguments" do
+    before(:each) do
+      @arg1 = stub("First argument")
+      @arg2 = stub("Second argument")
+      @flat_arg1 = stub("Flattened first argument")
+      @flat_arg2 = stub("Flattened second argument")
+      
+      VkontakteApi::Utils.stub(:flatten_argument) do |arg|
+        case arg
+        when @arg1 then @flat_arg1
+        when @arg2 then @flat_arg2
+        end
+      end
+    end
+    
+    it "sends each value to .flatten_argument" do
+      flat_arguments = VkontakteApi::Utils.flatten_arguments(:arg1 => @arg1, :arg2 => @arg2)
+      flat_arguments.should == {:arg1 => @flat_arg1, :arg2 => @flat_arg2}
+    end
+  end
+  
+  describe ".flatten_argument" do
+    context "with a flat argument" do
+      before(:each) do
+        @argument = :flat
+      end
+      
+      it "leaves it untouched" do
+        subject.send(:flatten_argument, @argument).should == @argument
+      end
+    end
+    
+    context "with an array argument" do
+      before(:each) do
+        @array_argument = [1, 2, 3]
+      end
+      
+      it "joins the elements with a comma" do
+        flat_argument = subject.send(:flatten_argument, @array_argument)
+        flat_argument.should == '1,2,3'
+      end
+    end
+  end
+end

data/spec/vkontakte_api_spec.rb

@@ -10,5 +10,9 @@ describe VkontakteApi do
         end
       end
     end
+    
+    after(:each) do
+      VkontakteApi.reset
+    end
   end
 end

data/vkontakte_api.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = VkontakteApi::VERSION
   s.authors     = ['Vsevolod Romashov']
   s.email       = ['7@7vn.ru']
-  s.homepage    = 'https://github.com/7even/vkontakte_api'
+  s.homepage    = 'http://7even.github.com/vkontakte_api'
   s.summary     = %q{Ruby-way wrapper for VKontakte API}
   s.description = %q{A transparent wrapper for API of vk.com social network called VKontakte. Supports ruby-way method naming (without any method lists inside), result typecasting and any faraday-supported http adapter of your choice (no hardcoded Net::HTTP).}
   
@@ -16,10 +16,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
   
-  s.add_runtime_dependency 'activesupport', '~> 3.0'
-  s.add_runtime_dependency 'i18n',          '~> 0.6'
-  s.add_runtime_dependency 'faraday',       '~> 0.7.6'
-  s.add_runtime_dependency 'yajl-ruby',     '~> 1.0'
+  s.add_runtime_dependency 'faraday',                     '~> 0.8'
+  s.add_runtime_dependency 'faraday_middleware',          '~> 0.8'
+  s.add_runtime_dependency 'faraday_middleware-parse_oj', '~> 0.1'
+  s.add_runtime_dependency 'oauth2',                      '~> 0.8'
+  s.add_runtime_dependency 'hashie',                      '~> 1.2'
   
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

metadata

@@ -1,63 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: vkontakte_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 1.0.rc
+  prerelease: 4
 platform: ruby
 authors:
 - Vsevolod Romashov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-30 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70165295935300 !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70165295935300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &70165295934660 !ruby/object:Gem::Requirement
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70165295934660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70165295934200 !ruby/object:Gem::Requirement
+  name: faraday_middleware-parse_oj
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: '0.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70165295934200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &70165295933740 !ruby/object:Gem::Requirement
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70165295933740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70165295933300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165295933300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70165295932800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165295932800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70165295932360 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165295932360
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70165295931900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +149,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70165295931900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A transparent wrapper for API of vk.com social network called VKontakte.
   Supports ruby-way method naming (without any method lists inside), result typecasting
   and any faraday-supported http adapter of your choice (no hardcoded Net::HTTP).
@@ -109,30 +165,51 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
-- README.ru.md
 - Rakefile
+- lib/generators/vkontakte_api/install/USAGE
+- lib/generators/vkontakte_api/install/install_generator.rb
+- lib/generators/vkontakte_api/install/templates/initializer.rb
 - lib/vkontakte_api.rb
 - lib/vkontakte_api/api.rb
+- lib/vkontakte_api/authorization.rb
 - lib/vkontakte_api/client.rb
 - lib/vkontakte_api/configuration.rb
 - lib/vkontakte_api/error.rb
+- lib/vkontakte_api/logger.rb
+- lib/vkontakte_api/method.rb
+- lib/vkontakte_api/namespace.rb
 - lib/vkontakte_api/namespaces.yml
+- lib/vkontakte_api/resolvable.rb
 - lib/vkontakte_api/resolver.rb
+- lib/vkontakte_api/result.rb
+- lib/vkontakte_api/uploading.rb
+- lib/vkontakte_api/utils.rb
 - lib/vkontakte_api/version.rb
+- spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/vkontakte_api/api_spec.rb
+- spec/vkontakte_api/authorization_spec.rb
 - spec/vkontakte_api/client_spec.rb
 - spec/vkontakte_api/configuration_spec.rb
 - spec/vkontakte_api/error_spec.rb
+- spec/vkontakte_api/logger_spec.rb
+- spec/vkontakte_api/method_spec.rb
+- spec/vkontakte_api/namespace_spec.rb
+- spec/vkontakte_api/resolvable_spec.rb
 - spec/vkontakte_api/resolver_spec.rb
+- spec/vkontakte_api/result_spec.rb
+- spec/vkontakte_api/uploading_spec.rb
+- spec/vkontakte_api/utils_spec.rb
 - spec/vkontakte_api_spec.rb
 - vkontakte_api.gemspec
-homepage: https://github.com/7even/vkontakte_api
+homepage: http://7even.github.com/vkontakte_api
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -144,29 +221,33 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3384818246116410230
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3384818246116410230
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby-way wrapper for VKontakte API
 test_files:
+- spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/vkontakte_api/api_spec.rb
+- spec/vkontakte_api/authorization_spec.rb
 - spec/vkontakte_api/client_spec.rb
 - spec/vkontakte_api/configuration_spec.rb
 - spec/vkontakte_api/error_spec.rb
+- spec/vkontakte_api/logger_spec.rb
+- spec/vkontakte_api/method_spec.rb
+- spec/vkontakte_api/namespace_spec.rb
+- spec/vkontakte_api/resolvable_spec.rb
 - spec/vkontakte_api/resolver_spec.rb
+- spec/vkontakte_api/result_spec.rb
+- spec/vkontakte_api/uploading_spec.rb
+- spec/vkontakte_api/utils_spec.rb
 - spec/vkontakte_api_spec.rb
+has_rdoc: 

data/README.ru.md

@@ -1,115 +0,0 @@
-# vkontakte_api [![Build Status](https://secure.travis-ci.org/7even/vkontakte_api.png)](http://travis-ci.org/7even/vkontakte_api)
-
-`vkontakte_api` - ruby-обертка для API ВКонтакте. Она позволяет вызывать методы API настолько просто, насколько это возможно.
-
-Это русская версия readme. Английская версия лежит [здесь](https://github.com/7even/vkontakte_api/blob/master/README.md).
-
-## Установка
-
-``` bash
-gem install vkontakte_api
-```
-
-## Использование
-
-По умолчанию для HTTP-запросов используется `Net::HTTP`. Можно выбрать любой другой адаптер, поддерживаемый `faraday`, в блоке `VkontakteApi.configure` следующим образом:
-
-``` ruby
-VkontakteApi.configure do |config|
-  config.adapter = :net_http
-end
-```
-
-Все запросы к API отправляются через объект класса `VkontakteApi::Client`.
-
-``` ruby
-@app = VkontakteApi::Client.new
-```
-
-Чтобы создать клиент для отправки авторизованных запросов, нужно просто передать в конструктор токен доступа.
-
-``` ruby
-@app = VkontakteApi::Client.new('my_access_token')
-```
-
-Пожалуй, самый простой способ получить токен в веб-приложении - использовать [OmniAuth](https://github.com/intridea/omniauth), но если это неприемлемо, можно реализовать свой механизм авторизации. На данный момент `vkontakte_api` не умеет получать токен.
-
-Теперь можно вызывать методы API. Все названия методов переведены в underscore_case - в отличие от [официальной документации](http://vk.com/developers.php?oid=-17680044&p=API_Method_Description), где они в camelCase, т.е. `getGroups` становится `get_groups`. Можно по прежнему писать методы в camelCase, но это не соответствует стандартам стиля кода, принятым в ruby.
-
-``` ruby
-@app.get_user_settings  # => 327710
-@app.groups.get         # => [1, 31022447]
-```
-
-Предикатные методы (названия которых начинаются с `is`, например `is_app_user`) должны возвращать результат какого-то условия, поэтому в конец названия метода добавляется '?', и возвращается булево значение (`true` или `false`):
-
-``` ruby
-@app.is_app_user? # => true
-```
-
-Можно вызывать эти методы и без '?' на конце, тогда они будут возвращать `'0'` или `'1'`.
-
-Теперь о параметрах. Все параметры именованные, и передаются в методы в виде хэша, где ключи соответствуют названиям параметров, а значения - соответственно, их значениям:
-
-``` ruby
-@app.friends.get(fields: 'uid,first_name,last_name')
-# =>  [
-#       {
-#         :uid          => "1",
-#         :first_name   => "Павел",
-#         :last_name    => "Дуров"
-#       },
-#       {
-#         :uid          => "6492",
-#         :first_name   => "Andrew",
-#         :last_name    => "Rogozov"
-#       }
-#     ]
-```
-
-Если значение параметра - список, разделенный запятыми, то его можно передать в виде массива; он будет корректно обработан перед отправкой запроса:
-
-``` ruby
-users_ids = [1, 6492]
-@app.users.get(uids: users_ids) # => тот же вывод, что и выше
-```
-
-Также следует заметить, что все возвращаемые хэши имеют символьные ключи.
-
-Если результат метода - Enumerable, то методу можно передать блок, который будет вызван для каждого элемента результата. В этом случае метод вернет массив из результатов выполнения блока с каждым элементом (аналогично `Enumerable#map`):
-
-``` ruby
-@app.friends.get(fields: 'first_name,last_name') do |friend|
-  "#{friend[:first_name]} #{friend[:last_name]}"
-end
-# => ["Павел Дуров", "Andrew Rogozov"]
-```
-
-`vkontakte_api` не содержит списка названий методов (если не считать пространств имен, вроде `friends` или `groups`) - когда вызывается метод, его название переводится в camelCase, а уже потом отправляется запрос к ВКонтакте. Поэтому когда новый метод добавляется в API, не нужно ждать новой версии гема `vkontakte_api` - можно использовать этот новый метод сразу же. Если в названии запрошенного метода допущены ошибки, или вызван метод, на выполнение которого отсутствуют права, будет выброшено исключение с соответствующим сообщением (об исключениях чуть ниже).
-
-### Обработка ошибок
-
-Если ВКонтакте возвращает ошибку, выбрасывается исключение класса `VkontakteApi::Error` со всей значимой информацией, которую можно получить:
-
-``` ruby
-@app.audio.get_by_id
-# => VkontakteApi::Error: VKontakte returned an error 1: 'Unknown error occured' after calling method 'audio.getById' with parameters {}.
-```
-
-## Changelog
-
-* 0.1 Первая стабильная версия
-* 0.2 Поддержка аргументов-массивов, подчищенные неавторизованные запросы, обновленный список пространств имен, документация кода
-* 0.2.1 Пространство имен `stats`
-
-## Планы
-
-* Логирование запросов
-* Авторизация (получение токена доступа с ВКонтакте)
-* Возможно, Struct-подобные объекты в результатах запросов (вместо Hash)
-
-## Участие в разработке
-
-Если вы хотите поучаствовать в разработке проекта, форкните репозиторий, положите свои изменения в отдельную ветку и отправьте мне pull request.
-
-`vkontakte_api` тестируется под MRI `1.8.7`, `1.9.2` и `1.9.3`. Если в одной из этих сред что-то работает неправильно, либо вообще не работает, то это следует считать багом, и написать об этом в issues на Github.