vk 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+doc

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,49 @@
+# Vk: API wrapper for vk.com
+
+Vk is a wrapper for vk.com API
+
+## Installation
+
+    $ gem install vk
+
+## Usage
+
+### Initialization
+
+    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'}]
+
+### 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}]
+
+### Usage with object oriented DSL
+
+Currently implemented classes: {Vk::User}, {Vk::City}, {Vk::Country}.
+
+    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}>
+
+## License
+
+MIT License. © [Alexander Semyonov](http://al.semyonov.us/), <al@semyonov.us>, 2011

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run specs'
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(--color)
+    t.verbose = false
+  end
+rescue LoadError
+  task :spec do
+    abort 'install rspec to run specs ($ bundle install)'
+  end
+end
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  desc 'Generate documentation'
+  YARD::Rake::YardocTask.new(:doc)
+rescue LoadError
+  task :doc do
+    abort 'install yard to generate documentation ($ bundle install)'
+  end
+end

data/lib/vk.rb

@@ -0,0 +1,23 @@
+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'
+
+  class << self
+    attr_accessor :app_id, :app_secret
+  end
+
+  def request
+    @request ||= Request.new
+  end
+
+  def dsl!
+    Request.dsl!
+  end
+end

data/lib/vk/base.rb

@@ -0,0 +1,90 @@
+require 'vk'
+
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/hash_with_indifferent_access'
+
+module Vk
+  dsl! # require DSL methods in Vk::Request
+
+  class Base
+    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
+        end
+      end
+
+      def method_missing(method, *args)
+        if identity_map.respond_to?(method)
+          identity_map.send(method, *args)
+        else
+          super
+        end
+      end
+
+      def inherited(subclass)
+        subclass.identity_map = {}
+        subclass.fields = []
+      end
+    end
+
+    def initialize(id, options = {})
+      @attributes = ActiveSupport::HashWithIndifferentAccess.new
+
+      self.id = id
+      self.class.identity_map[id] = self
+
+      if options.key? :data
+        @attributes.merge!(options[:data])
+      else
+        load_data(options)
+      end
+    end
+
+    def id=(id)
+      @attributes[key_field] = id
+    end
+
+    def id
+      @attributes[key_field]
+    end
+
+    def read_attribute(name)
+      if !@attributes.key?(name) && fields.include?(name.to_sym)
+        load_data(fields: name)
+      end
+      @attributes[name]
+    end
+
+    def method_missing(method, *args)
+      if @attributes.key?(method)
+        @attributes[method.to_s]
+      else
+        super
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{id} @attributes=#{@attributes.inspect}>"
+    end
+
+    protected
+
+    def load_data(options = {})
+      raise 'Not implemented. Use subclasses'
+    end
+  end
+end

data/lib/vk/city.rb

@@ -0,0 +1,18 @@
+require 'vk/base'
+
+module Vk
+  class City < Base
+    self.key_field = :cid
+    self.fields = [:cid, :name]
+
+    def to_s
+      name
+    end
+
+    protected
+
+    def load_data(options = {})
+      @attributes = @attributes.merge(loader.get_city(id))
+    end
+  end
+end

data/lib/vk/country.rb

@@ -0,0 +1,18 @@
+require 'vk/base'
+
+module Vk
+  class Country < Base
+    self.key_field = :cid
+    self.fields = [:cid, :name]
+
+    def to_s
+      name
+    end
+
+    protected
+
+    def load_data(options = {})
+      @attributes = @attributes.merge(loader.get_country(id))
+    end
+  end
+end

data/lib/vk/dsl.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+require 'vk'
+
+module Vk
+  module DSL
+    # Have user installed app?
+    # @param  [String] uid user’s identifier
+    # @return [Boolean]             does user installed app
+    def app_user?(uid)
+      request('isAppUser', uid: uid) == '1'
+    end
+
+    # Profile information for provided uids or domain names
+    # @param [Array<String>] uids array of users’ identifiers in numbers or domain names
+    # @param [Hash] options the options to request profile information
+    # @option options [:uid, :first_name, :last_name, :nickname, :domain, :sex, :bdate, :birthdate, :city, :country, :timezone, :photo, :photo_medium, :photo_big, :has_mobile, :rate, :contacts, :education, :online] :fields ([:uid, :first_name, :last_name]) profile fields to requests
+    # @option options [:nom, :gen, :dat, :acc, :ins, :abl] :name_case (:nom) case of returned names
+    # @return [Array<Hash>] array of user profile data
+    def get_profiles(uids, options = {})
+      uids = Array(uids)
+      if uids.first.to_i == 0
+        options[:domains] = uids.join ','
+      else
+        options[:uids]    = uids.join ','
+      end
+      options[:fields] = Array(options[:fields]).join(',') if options.key?(:fields)
+      request('getProfiles', options)
+    end
+
+    def get_profile(uid, options = {})
+      get_profiles(uid, options)[0]
+    end
+
+    ## Identifiers of groups in which user participates
+    ## @param [Integer] uid user’s identifier
+    ## @return [Array] array of group identifiers
+    #def get_groups(uid)
+      #request('getGroups', uid: uid)
+    #end
+
+    # Cities’ names
+    # @param [Array<Fixnum>, Fixnum] cids cities identifiers
+    # @return [Array<Hash>] hash with city identifier and it’s name
+    def get_cities(cids)
+      cids = Array(cids).join(',')
+      request('getCities', cids: cids)
+    end
+
+    def get_city(cid)
+      get_cities(cid)[0]
+    end
+
+    # Countries’ names
+    # @param [Array<Fixnum>, Fixnum] cids cities identifiers
+    # @return [Array<Hash>] hash with city identifier and it’s name
+    def get_countries(cids)
+      cids = Array(cids).join(',')
+      request('getCountries', cids: cids)
+    end
+
+    def get_country(cid)
+      get_countries(cid)[0]
+    end
+
+    # Friends information
+    # @param [Fixnum] uid user identifier
+    # @param [Hash] options
+    # @option options [Array<String>] :fields ([:uid, :first_name, :last_name]) what fields to request
+    # @option options [Fixnum] :count how many friends to request
+    # @option options [Fixnum] :offset offset of friends to request
+    def get_friends(uid, options = {})
+      request('friends.get', options.merge(uid: uid))
+    end
+
+    # Statuses from user’s wall
+    # @param [Fixnum] uid user identifier
+    # @param [Hash] options
+    # @option options [Fixnum] :count how many statuses to request
+    # @option options [Fixnum] :offset offset of statuses to request
+    # @option options [:owner, :others, :all] :filter (:all) what kind of statuses to request
+    # @return [Array<Fixnum, *Hash>] count of statuses and each status in hash
+    def get_wall(uid, options = {})
+      request('wall.get', options.merge(owner_id: uid))
+    end
+  end
+end

data/lib/vk/request.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+require 'vk'
+
+require 'digest/md5'
+require 'uri'
+require 'net/http'
+
+require 'active_support/core_ext/object/to_query'
+require 'json'
+
+module Vk
+  # Class for requesting vk.com api data
+  # @author Alexander Semyonov
+  class Request
+    VERSION = '3.0'
+    SCHEME  = 'http'
+    HOST    = 'api.vk.com'
+    PATH    = '/api.php'
+    PORT    = 80
+
+    class << self
+      # Generates auth_key for viewer
+      # @param [Fixnum, String] viewer_id viewer’s identifier
+      def auth_key(viewer_id)
+        Digest::MD5.hexdigest("#{Vk.app_id}_#{viewer_id}_#{Vk.app_secret}")
+      end
+
+      def authenticated?(viewer_id, auth_key)
+        auth_key == self.auth_key(viewer_id)
+      end
+
+      def dsl!
+        require 'vk/dsl'
+        include Vk::DSL
+      end
+    end
+
+    def request(method_name, data = {})
+      data.merge!(
+        api_id: Vk.app_id,
+        format: :json,
+        method: method_name,
+        v:      VERSION
+      )
+      url           = URI.parse("#{SCHEME}://#{HOST}:#{PORT}#{PATH}?#{data.to_query}&sig=#{signature(data)}")
+      http_response = Net::HTTP.get_response(url).body
+      json_response = JSON.parse(http_response)
+      puts(json_response)
+      json_response['response']
+    end
+
+
+    def method_missing(method_name, options = {})
+      request(method_name, options)
+    end
+
+    private
+
+    def signature(data)
+      signature = data.keys.sort.inject('') { |result, key| result << "#{key}=#{data[key]}" } << Vk.app_secret
+      Digest::MD5.hexdigest(signature)
+    end
+  end
+end

data/lib/vk/user.rb

@@ -0,0 +1,59 @@
+require 'vk/base'
+
+module Vk
+  class User < Base
+    self.key_field = :uid
+    self.fields = [:uid, :first_name, :last_name, :nickname, :domain, :sex, :bdate, :birthdate, :city, :country, :timezone, :photo, :photo_medium, :photo_big, :has_mobile, :rate, :contacts, :education, :online]
+
+    class << self
+      def find_all(ids, options = {})
+        loaded_ids = ids & identity_map.keys
+        ids_to_load = ids - loaded_ids
+        identity_map.values_at(*loaded_ids).tap do |results|
+          if ids_to_load.any?
+            results << loader.get_profiles(ids - loaded_ids, options).map do |profile|
+              new(profile['uid'], data: profile)
+            end
+          end
+        end
+      end
+    end
+
+    def name
+      "#{first_name} #{last_name}"
+    end
+
+    def city_id
+      read_attribute(:city)
+    end
+
+    def city
+      Vk::City.find(city_id)
+    end
+
+    def country_id
+      read_attribute(:country)
+    end
+
+    def country
+      Vk::Country.find(country_id)
+    end
+
+    def friend_ids
+      @friend_ids ||= loader.get_friends(uid)
+    end
+
+    def friends(options = {})
+      @friends ||= User.find_all(friend_ids, options)
+    end
+
+    def to_s
+      name
+    end
+
+    protected
+    def load_data(options = {})
+      @attributes = @attributes.merge(loader.get_profile(id, options))
+    end
+  end
+end

data/lib/vk/version.rb

@@ -0,0 +1,3 @@
+module Vk
+  VERSION = '0.0.2'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'vk'
+
+Bundler.require(:development)
+
+Vk.app_id = 2311992
+Vk.app_secret = 'secret'
+
+VK_AUTH_KEY = '44b0a08fcf4039bf7919132a777b23ef'
+VK_VIEWER_ID = 34160
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/vk/request_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Vk::Request do
+  describe 'class' do
+    subject { Vk::Request }
+
+    it { should respond_to(:auth_key) }
+    it { should respond_to(:authenticated?) }
+    it { Vk::Request.auth_key(VK_VIEWER_ID).should == VK_AUTH_KEY }
+    it { Vk::Request.authenticated?(VK_VIEWER_ID, VK_AUTH_KEY).should be_true }
+  end
+
+  describe 'instance' do
+    let(:request) { Vk::Request.new }
+    subject { request }
+
+    it { should respond_to(:request) }
+  end
+end

data/spec/vk_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Vk do
+  it { should respond_to(:request) }
+end

data/vk.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'vk/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'vk'
+  s.version     = Vk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Alexander Semyonov']
+  s.email       = ['al@semyonov.us']
+  s.homepage    = 'http://github.com/alsemyonov/vk'
+  s.summary     = %q{Simple wrapper for vk.com API}
+  s.description = %q{Wrapper for calling vk.com API from vk.com application servers and sites using vk.com API}
+
+  s.rubyforge_project = 'vk'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency('activesupport', '~> 3.0')
+  s.add_dependency('json', '~> 1.5.1')
+
+  s.add_development_dependency('rspec', '~> 2.5.0')
+  s.add_development_dependency('yard', '~> 0.6.8')
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: vk
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alexander Semyonov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-03 00:00:00 +06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 8
+        version: 0.6.8
+  type: :development
+  version_requirements: *id004
+description: Wrapper for calling vk.com API from vk.com application servers and sites using vk.com API
+email: 
+- al@semyonov.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/vk.rb
+- lib/vk/base.rb
+- lib/vk/city.rb
+- lib/vk/country.rb
+- lib/vk/dsl.rb
+- lib/vk/request.rb
+- lib/vk/user.rb
+- lib/vk/version.rb
+- spec/spec_helper.rb
+- spec/vk/request_spec.rb
+- spec/vk_spec.rb
+- vk.gemspec
+has_rdoc: true
+homepage: http://github.com/alsemyonov/vk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: vk
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple wrapper for vk.com API
+test_files: []
+