vk 0.0.4 → 0.6.5.53

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5cf6cc3967a10795bac86e867d2f9572af40035
+  data.tar.gz: bad1ca740033624204e839e8b3519116349b7726
+SHA512:
+  metadata.gz: 48dd1970eeb9062d32c9824b102d15d4f259e9457b91468223ba36f17df6c81135dc713b59172f0e9faa4d4140cacfee08f95583bf70ce4346664106377715a1
+  data.tar.gz: 3da26495cbd61650bc26041b8a50b7409ab70fc43bd2a52a75c04744a654525859ecaa211b738b634108202b8580a5fc6f3256050d6fced2e0aa812e4b59cea2

data/.gitignore

@@ -3,3 +3,7 @@
 Gemfile.lock
 pkg/*
 doc
+.ruby-version
+.env
+.env.*
+/backups

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0

data/Gemfile

@@ -1,4 +1,8 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vk.gemspec
 gemspec
+
+group :development do
+  gem 'omniauth-vkontakte'
+end

data/README.markdown

@@ -2,55 +2,68 @@
 
 Vk is a wrapper for vk.com API
 
+## Project links
+
 * [Documentation](http://rubydoc.info/gems/vk)
-* [Source](http://github.com/alsemyonov/vk)
-* [Issues](http://github.com/alsemyonov/vk/issues)
-* [Wiki](http://github.com/alsemyonov/vk/wiki)
-* [Documentation for unreleased gem version](http://rubydoc.info/github/alsemyonov/vk)
+* [Source](https://github.com/alsemyonov/vk)
+* [Issues](https://github.com/alsemyonov/vk/issues)
+* [Wiki](https://github.com/alsemyonov/vk/wiki)
+* [![Code Climate](https://codeclimate.com/github/alsemyonov/vk.png)](https://codeclimate.com/github/alsemyonov/vk)
+* [![Build Status](https://travis-ci.org/alsemyonov/vk.png?branch=master)](https://travis-ci.org/alsemyonov/vk)
 
 ## Installation
 
-    $ gem install vk
+```bash
+gem install vk
+```
 
 ## Usage
 
 ### Initialization
 
-    Vk.app_id = 12345
-    Vk.app_secret = 'secret'
+```ruby
+Vk.app_id = 12345
+Vk.app_secret = 'secret'
+```
 
 ### Basic usage
 
 Simple request. Docs ad {Vk::Request}
 
-    vk = Vk.request
-    profiles = vk.request 'getProfiles', uids: 12345
-    puts profiles # [{uid: 12345, first_name: 'Ivan', last_name: 'Ivanov'}]
+```ruby
+vk = Vk.request
+profiles = vk.request 'getProfiles', uids: 12345
+puts profiles # [{uid: 12345, first_name: 'Ivan', last_name: 'Ivanov'}]
+```
 
 ### Usage with DSL
 
 View methods list at {Vk::DSL}.
 
-    Vk.dsl!
-    vk = Vk.request
-    profiles = vk.get_profiles([123, 456, 789], fields: %w('has_mobile'))
-    puts profiles # [{uid: 1234, ..., has_mobile: 1}]
+```ruby
+Vk.dsl!
+vk = Vk.request
+profiles = vk.get_profiles([123, 456, 789], fields: %w('has_mobile'))
+puts profiles # [{uid: 1234, ..., has_mobile: 1}]
+```
 
 ### Usage with object oriented DSL
 
 Currently implemented classes: {Vk::User}, {Vk::City}, {Vk::Country}, {Vk::Post}.
 
-    user = Vk::User.find 12345
-    user                    # #<Vk::User:12345 @attributes={first_name: 'Ivan', last_name: 'Ivanov', uid: 12345}>
-    user.first_name         # 'Ivan'
-    user.last_name          # 'Ivanov'
-    user.name               # 'Ivan Ivanov'
-    user.city               # #<Vk::City:1 @attributes={name: 'Moscow', cid: 1}>
-    user.country            # #<Vk::Country:1 @attributes={name: 'Russia', cid: 1}>
-    user.friends            # [#<Vk::User:1 @attributes={first_name: "Pavel", last_name: "Durov", uid: 1}>, ...]
-    user.friends.first.city # #<Vk::City:1 @attributes={name: 'Moscow', cid: 1}>
-    user.posts.first        # #<Vk::Post:1_123 @attributes={text: 'Preved!11'}>
+```ruby
+user = Vk::User.find 12345
+user                    # => #<Vk::User:12345 @attributes={first_name: 'Ivan', last_name: 'Ivanov', uid: 12345}>
+user.first_name         # => 'Ivan'
+user.last_name          # => 'Ivanov'
+user.name               # => 'Ivan Ivanov'
+user.city               # => #<Vk::City:1 @attributes={name: 'Moscow', cid: 1}>
+user.country            # => #<Vk::Country:1 @attributes={name: 'Russia', cid: 1}>
+user.friends            # => [#<Vk::User:1 @attributes={first_name: "Pavel", last_name: "Durov", uid: 1}>, ...]
+user.friends.first.city # => #<Vk::City:1 @attributes={name: 'Moscow', cid: 1}>
+user.posts.first        # => #<Vk::Post:1_123 @attributes={text: 'Preved!11'}>
+```
 
 ## License
 
-MIT License. © [Alexander Semyonov](http://al.semyonov.us/), <al@semyonov.us>, 2011
+MIT License. © [Alex Semyonov](http://al.semyonov.us/), <alex@semyonov.us>, 2011-2016

data/Rakefile

@@ -1,4 +1,4 @@
-require 'bundler'
+require 'bundler/setup'
 Bundler::GemHelper.install_tasks
 
 begin
@@ -26,3 +26,5 @@ rescue LoadError
     abort 'install yard to generate documentation ($ bundle install)'
   end
 end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'bundler/setup'
+begin
+  require 'dotenv'
+  Dotenv.load('.env')
+rescue LoadError
+end
+require 'vk'
+require 'vk/dsl'
+
+require 'pry'
+begin
+  require 'pry-byebug'
+rescue LoadError
+  STDERR.puts 'Byebug is enabled only in Ruby 2'
+end
+require 'pp'
+
+SPEC_ROOT = File.expand_path('..', __FILE__)
+
+Dir[File.join(SPEC_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
+
+Vk.app_id = ENV['VK_APP_ID']
+Vk.app_secret = ENV['VK_APP_SECRET']
+Vk.dsl!
+Vk.log!
+
+client = Vk.client
+binding.pry
+client

data/lib/vk.rb

@@ -1,37 +1,61 @@
 require 'active_support/core_ext/object/try'
+require 'vk/exceptions'
+require 'vk/version'
 
 module Vk
-  extend self
-
-  autoload :DSL,      'vk/dsl'
-  autoload :Request,  'vk/request'
-
-  autoload :Base,     'vk/base'
-  autoload :User,     'vk/user'
-  autoload :City,     'vk/city'
-  autoload :Country,  'vk/country'
-  autoload :Post,     'vk/post'
+  autoload :Client, 'vk/client'
+  autoload :DSL, 'vk/dsl'
+  autoload :Error, 'vk/error'
+  autoload :Result, 'vk/result'
+
+  autoload :Base, 'vk/base'
+  autoload :User, 'vk/user'
+  autoload :City, 'vk/city'
+  autoload :Country, 'vk/country'
+  autoload :Post, 'vk/post'
+  autoload :Stats, 'vk/stats'
+  autoload :Group, 'vk/group'
+  autoload :Album, 'vk/album'
 
   class << self
-    attr_accessor :app_id, :app_secret, :logger
+    # @return [String]
+    attr_accessor :app_id
+    # @return [String]
+    attr_accessor :app_secret
   end
 
-  # Request to vk.com API
-  # @return [Vk::Request] Request object
-  def request
-    @request ||= Request.new
+  # @return [Logger]
+  def self.logger
+    @logger ||=
+      begin
+        require 'logger'
+        Logger.new(STDOUT)
+      end
+  end
+
+  # @param [Logger] logger
+  # @return [Logger]
+  def self.logger=(logger)
+    @logger = logger
   end
 
-  def log(text, severity = :debug)
-    Vk.logger.try(severity, text)
+  module_function
+
+  # Request to vk.com API
+  # @return [Vk::Client] Request object
+  def client(access_token = ENV['VK_ACCESS_TOKEN'])
+    @client ||= Client.new(access_token)
   end
 
+  # @return [Vk::Client]
   def dsl!
-    Request.dsl!
+    Client.dsl!
   end
 
   def log!
     require 'logger'
     self.logger = Logger.new STDOUT
   end
+
+  dsl!
 end

data/lib/vk/access.rb

@@ -0,0 +1,28 @@
+require 'vk'
+
+module Vk
+  module Access
+    SCOPES = {
+      :notify => 1, # Пользователь разрешил отправлять ему уведомления (для flash/iframe-приложений).
+      :friends => 2, # Доступ к друзьям.
+      :photos => 4, # Доступ к фотографиям.
+      :audio => 8, # Доступ к аудиозаписям.
+      :video => 16, # Доступ к видеозаписям.
+      :docs => 131072, # Доступ к документам.
+      :notes => 2048, # Доступ к заметкам пользователя.
+      :pages => 128, # Доступ к wiki-страницам.
+      # +256	Добавление ссылки на приложение в меню слева.:status => 1024, # Доступ к статусу пользователя.
+      :offers => 32, # Доступ к предложениям (устаревшие методы).
+      :questions => 64, # Доступ к вопросам (устаревшие методы).
+      :wall => 8192, # Доступ к обычным и расширенным методам работы со стеной. Данное право доступа по умолчанию недоступно для сайтов при использовании OAuth-авторизации (игнорируется при попытке авторизации). : groups => 262144, # Доступ к группам пользователя.
+      :messages => 4096, # Доступ к расширенным методам работы с сообщениями (только для Standalone-приложений).
+      :email => 4194304, # Доступ к email пользователя.
+      :notifications => 524288, # Доступ к оповещениям об ответах пользователю.
+      :stats => 1048576, # Доступ к статистике групп и приложений пользователя, администратором которых он является.
+      :ads => 32768, # Доступ к расширенным методам работы с рекламным API.
+      :market => 134217728, # Доступ к товарам.
+      :offline => 65536, # Доступ к API в любое время (при использовании этой опции параметр expires_in, возвращаемый вместе с access_token, содержит 0 — токен бессрочный).
+      :nohttps => 0 # Возможность осуществлять запросы к API без HTTPS.
+    }
+  end
+end

data/lib/vk/album.rb

@@ -0,0 +1,30 @@
+require 'vk/base'
+
+module Vk
+  class Album < Base
+    self.key_field = :id
+    self.fields = %i[
+      id
+      thumb_id
+      owner_id
+      title description
+      created updated
+      size can_upload privacy_view privacy_comment
+      thumb_src
+    ]
+
+    def to_s
+      title.to_s
+    end
+
+    def photos(options = {})
+      loader.get_photos(owner_id, id, options)
+    end
+
+    protected
+
+    def load_data(options = {})
+      @attributes = @attributes.merge(loader.get_group_by_id(id, options)) unless @attributes.size > 1
+    end
+  end
+end

data/lib/vk/audio.rb

@@ -0,0 +1,73 @@
+require 'vk/base'
+
+module Vk
+  class Audio < Base
+    GENRES = {
+      1 => 'Rock',
+      2 => 'Pop',
+      3 => 'Rap & Hip-Hop',
+      4 => 'Easy Listening',
+      5 => 'House & Dance',
+      6 => 'Instrumental',
+      7 => 'Metal',
+      21 => 'Alternative',
+      8 => 'Dubstep',
+      1001 => 'Jazz & Blues',
+      10 => 'Drum & Bass',
+      11 => 'Trance',
+      12 => 'Chanson',
+      13 => 'Ethnic',
+      14 => 'Acoustic & Vocal',
+      15 => 'Reggae',
+      16 => 'Classical',
+      17 => 'Indie Pop',
+      19 => 'Speech',
+      22 => 'Electropop & Disco',
+      18 => 'Other',
+    }
+
+    self.fields = %i(
+      id
+      owner_id
+      album_id
+      genre_id
+      lyrics_id
+      artist
+      title
+      duration
+      url
+      date
+      no_search
+     )
+
+    # @return [Vk::Audio::Album]
+    def album
+      album_id = read_attribute(:album_id).to_s
+      @album ||= owner.audio_albums.detect { |album| album.id.to_s == album_id }
+    end
+
+    # @return [Vk::User]
+    def owner
+      @owner ||= Vk::User.find(owner_id)
+    end
+
+    # @return [String]
+    def genre
+      GENRES[genre_id]
+    end
+
+    # @return [String]
+    def lyrics
+      @lyrics ||= loader.get_lyrics(lyrics_id).text if lyrics_id
+    end
+
+    # @param [String] genre
+    # @return [Integer]
+    def genre=(genre)
+      self.genre_id = GENRES.key(genre)
+    end
+  end
+end
+
+require 'vk/audio/album'
+require 'vk/audio/lyrics'

data/lib/vk/audio/album.rb

@@ -0,0 +1,9 @@
+require 'vk/audio'
+
+module Vk
+  class Audio < Base
+    class Album < Base
+      self.fields = %i[id owner_id title]
+    end
+  end
+end

data/lib/vk/audio/lyrics.rb

@@ -0,0 +1,10 @@
+require 'vk/audio'
+
+module Vk
+  class Audio < Base
+    class Lyrics < Base
+      self.key_field = :lyrics_id
+      self.fields = %i[lyrics_id text]
+    end
+  end
+end

data/lib/vk/base.rb

@@ -2,87 +2,120 @@ require 'vk'
 
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/hash_with_indifferent_access'
-require 'active_support/memoizable'
 
 module Vk
   dsl! # require DSL methods in Vk::Request
 
   class Base
-    extend ActiveSupport::Memoizable
-
-    class_attribute :identity_map, :loader, :key_field, :fields
-    self.loader = Vk.request
-
-    class << self
-      # Find object in identity map or initialize object
-      def find(*ids)
-        options = ids.extract_options!
-        if ids.count == 1
-          id = ids.first.to_i
-          identity_map[id] ||= new(id, options)
-        elsif respond_to?(:find_all)
-          find_all(ids, options)
-        else
-          ids.map do |id|
-            find(id, options)
-          end
+    # @return [{Integer => self}]
+    class_attribute :identity_map
+
+    # @return [Vk::Client]
+    class_attribute :loader
+
+    # @return [Symbol]
+    class_attribute :key_field
+
+    # @return [<Symbol>]
+    class_attribute :fields
+
+    # Find object in identity map or initialize object
+    # @param [self, <self>] ids
+    def self.find(*ids)
+      options = ids.extract_options!
+      if ids.count == 1
+        id = ids.first.to_i
+        identity_map[id] ||= new(id, options)
+      elsif respond_to?(:find_all)
+        find_all(ids, options)
+      else
+        ids.map do |id|
+          find(id, options)
         end
       end
-      alias [] find
+    end
 
-      def method_missing(method, *args)
-        if identity_map.respond_to?(method)
-          identity_map.send(method, *args)
-        else
-          super
-        end
-      end
+    instance_eval { alias [] find }
 
-      def inherited(subclass)
-        subclass.identity_map = {}
-        subclass.fields = []
+    def self.method_missing(method, *args)
+      if identity_map.respond_to?(method)
+        identity_map.send(method, *args)
+      else
+        super
       end
     end
 
+    def self.inherited(subclass)
+      super(subclass)
+      subclass.identity_map = {}
+      subclass.fields = []
+      subclass.key_field = :id
+      subclass.fields = []
+      subclass.loader = Vk.client
+    end
+
     def initialize(id, options = {})
       @attributes = ActiveSupport::HashWithIndifferentAccess.new
 
+      if id.is_a?(Hash)
+        options[:data] = id
+        id = options[:data][key_field.to_s]
+      end
+
       self.id = id
       self.class.identity_map[id] = self
 
       if options.key? :data
-        @attributes.merge!(options[:data])
+        @attributes.merge!(options[:data].with_indifferent_access)
       else
         load_data(options)
       end
     end
 
+    attr_reader :attributes
+
     def id=(id)
       @attributes[key_field] = id
     end
 
+    # @return [String]
     def id
-      @attributes[key_field].to_i
+      @attributes[key_field].to_s
     end
 
     def read_attribute(name)
-      if !@attributes.key?(name) && fields.include?(name.to_sym)
+      if !@attributes.key?(name) && self.class.fields.include?(name.to_sym)
         load_data(fields: name)
       end
       @attributes[name]
     end
 
     def method_missing(method, *args)
-      if @attributes.key?(method)
+      if method =~ /\?\Z/
+        respond_to_missing?(method) && @attributes[method]
+      elsif @attributes.key?(method)
         @attributes[method]
-      elsif self.class.fields.include?(name.to_sym)
-        read_attribute(name)
+      elsif self.class.fields.include?(method.to_sym)
+        read_attribute(method.to_s)
       else
         super
       end
     end
 
+    def respond_to_missing?(method, include_all = false)
+      @attributes.key?(method) || self.class.fields.include?(method.to_sym) || super(method, include_all)
+    end
+
+    def logger
+      Vk.logger
+    end
+
+    def to_hash
+      attributes.to_hash
+    end
+
     def inspect
       "#<#{self.class.name}:#{id} @attributes=#{@attributes.inspect}>"
     end
@@ -90,7 +123,7 @@ module Vk
     protected
 
     def load_data(options = {})
-      raise 'Not implemented. Use subclasses'
+      # raise 'Not implemented. Use subclasses'
     end
   end
 end