mailru-api 0.4.1

data/lib/mailru-api.rb

@@ -0,0 +1,136 @@
+#:encoding: utf-8
+
+require 'mailru-api/error'
+require 'mailru-api/request'
+require 'mailru-api/audio'
+require 'mailru-api/events'
+require 'mailru-api/friends'
+require 'mailru-api/guestbook'
+require 'mailru-api/mail'
+require 'mailru-api/mobile'
+require 'mailru-api/notifications'
+require 'mailru-api/photos'
+require 'mailru-api/stream'
+require 'mailru-api/users'
+
+module MailRU
+  class APIConfiguration
+    attr_accessor :app_id, :secret_key, :private_key, :session_key, :uid, :format
+  end
+
+  class APIConfigurationBuilder
+    attr_reader :configuration
+  
+    def initialize(&block)
+      if block_given?
+        @configuration = APIConfiguration.new
+        instance_eval(&block)
+      end
+    end
+
+    def app_id value
+      @configuration.app_id = value
+    end
+
+    def secret_key value
+      @configuration.secret_key = value
+    end
+
+    def private_key value
+      @configuration.private_key = value
+    end
+
+    def session_key value
+      @configuration.session_key = value
+    end
+    
+    def uid value
+      @configuration.uid = value
+    end
+    
+    def format value
+      @configuration.format = value
+    end
+  end
+
+  class API
+    module Format
+      XML = 'xml'
+      JSON = 'json'
+    end
+
+    PATH = 'http://www.appsmail.ru/platform/api'
+  
+    attr_accessor :app_id, :secret_key, :private_key, :session_key, :uid, :format
+  
+    def initialize options = {}, &block
+      @app_id = options[:app_id]
+      @secret_key = options[:secret_key]
+      @private_key = options[:private_key]
+      @session_key = options[:session_key]
+      @uid = options[:uid]
+      @format = options[:format]
+
+      if block_given?
+        if block.arity == 1
+          yield self
+        else
+          configuration = APIConfigurationBuilder.new(&block).configuration
+
+          unless configuration.nil?
+            @app_id = configuration.app_id || @app_id
+            @secret_key = configuration.secret_key || @secret_key
+            @private_key = configuration.private_key || @private_key
+            @session_key = configuration.session_key || @session_key
+            @uid = configuration.uid || @uid
+            @format = configuration.format || @format
+          end
+        end
+      end
+    end
+    
+    def audio
+      return Audio.new(self)
+    end
+    
+    def events
+      return Events.new(self)
+    end
+    
+    def friends
+      return Friends.new(self)
+    end
+    
+    def guestbook
+      return Guestbook.new(self)
+    end
+    
+    def mail
+      return Mail.new(self)
+    end
+    
+    def messages
+      return Messages.new(self)
+    end
+    
+    def mobile
+      return Mobile.new(self)
+    end
+    
+    def notifications
+      return Notifications.new(self)
+    end
+
+    def photos
+      return Photos.new(self)
+    end
+    
+    def stream
+      return Stream.new(self)
+    end
+    
+    def users
+      return Users.new(self)
+    end
+  end
+end

data/lib/mailru-api/audio.rb

@@ -0,0 +1,23 @@
+#:encoding: utf-8
+
+module MailRU
+  class API
+    class Audio
+			def initialize api
+				@api = api
+			end
+
+      def get params = {}
+        GetRequest.new(@api, 'audio.get', params).get
+      end
+      
+      def link params = {}
+        GetRequest.new(@api, 'audio.link', params).get
+      end
+      
+      def search params = {}
+        GetRequest.new(@api, 'audio.search', params).get
+      end
+    end
+	end
+end

data/lib/mailru-api/error.rb

@@ -0,0 +1,43 @@
+#:encoding: utf-8
+
+module MailRU
+  class API
+    class Error < RuntimeError
+      attr_accessor :code, :description
+
+      def initialize code, description
+        @code = Integer(code)
+        @description = description
+      end
+
+      def self.create(code, description)
+        case code
+          when 1 then UnknwonError.new(code, description)
+          when 2 then UnknownMethodCalledError.new(code, description)
+          when 3 then MethodIsDeprecatedError.new(code, description)
+          when 100 then InvalidParameterError.new(code, description)
+          when 102 then AuthorizationFailedError.new(code, description)
+          when 103 then ApplicationLookupFailedError.new(code, description)
+          when 104 then IncorrectSignatureError.new(code, description)
+          when 105 then ApplicationIsNotInstalledError.new(code, description)
+          when 200 then PermissionDeniedError.new(code, description)
+          when 202 then AccessToObjectDeniedError.new(code, description)
+          when 501 then IncorrectImageError.new(code, description)
+          else Error.new(code, description)
+        end
+      end
+    end
+
+    class UnknownError < Error; end
+    class UnknownMethodCalledError < Error; end
+    class MethodIsDeprecatedError < Error; end
+    class InvalidParameterError < Error; end
+    class AuthorizationFailedError < Error; end
+    class ApplicationLookupFailedError < Error; end
+    class IncorrectSignatureError < Error; end
+    class ApplicationIsNotInstalledError < Error; end
+    class PermissionDeniedError < Error; end
+    class AccessToObjectDeniedError < Error; end
+    class IncorrectImageError < Error; end
+  end
+end

data/lib/mailru-api/events.rb

@@ -0,0 +1,15 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Events
+      def initialize api
+        @api = api
+      end
+
+      def get_new_count
+        GetRequest.new(@api, 'events.getNewCount', {}).get
+      end
+    end
+	end
+end

data/lib/mailru-api/friends.rb

@@ -0,0 +1,31 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Friends
+      RETURN_OBJECTS = 1
+      RETURN_UIDS = 0
+
+      def initialize api
+        @api = api
+      end
+
+      def get params = {}
+        GetRequest.new(@api, 'friends.get', params).get
+      end
+      
+      def get_app_users params = {}
+        GetRequest.new(@api, 'friends.getAppUsers', params).get
+      end
+      
+      def get_invitations_count params = {}
+        GetRequest.new(@api, 'friends.getInvitationsCount', params).get
+      end
+      
+      def get_online params = {}
+        GetRequest.new(@api, 'friends.getOnline', params).get
+      end
+    end
+	end
+end
+

data/lib/mailru-api/guestbook.rb

@@ -0,0 +1,19 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Guestbook
+      def initialize api
+        @api = api
+      end
+
+      def get params = {}
+        GetRequest.new(@api, 'guestbook.get', params).get
+      end
+
+      def post params = {}
+        PostRequest.new(@api, 'guestbook.post', params).post
+      end
+    end
+	end
+end

data/lib/mailru-api/mail.rb

@@ -0,0 +1,15 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Mail
+      def initialize api
+        @api = api
+      end
+
+      def get_unread_count params = {}
+        GetRequest.new(@api, 'mail.getUnreadCount', params).get
+      end
+    end
+	end
+end

data/lib/mailru-api/messages.rb

@@ -0,0 +1,23 @@
+#:encoding: utf-8
+ 
+module MyMailRU
+	class API
+    class Messages
+      def get_thread params = {}
+        GetRequest.new(@api, 'messages.getThread', params).get
+      end
+      
+      def get_threads_list params = {}
+        GetRequest.new(@api, 'messages.getThreadsList', params).get
+      end
+      
+      def get_unread_count params = {}
+        GetRequest.new(@api, 'messages.getUnreadCount', params).get
+      end
+
+      def post params = {}
+        PostRequest.new(@api, 'messages.post', params).post
+      end
+    end
+	end
+end

data/lib/mailru-api/mobile.rb

@@ -0,0 +1,18 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Mobile
+      BASIC = 'basic'
+      SMARTPHONE = 'smartphone'
+
+      def initialize api
+        @api = api
+      end
+
+      def get_canvas params = {}
+        GetRequest.new(@api, 'mobile.getCanvas', params, Request::Secure::No).get
+      end
+    end
+	end
+end

data/lib/mailru-api/notifications.rb

@@ -0,0 +1,15 @@
+#:encoding: utf-8
+
+module MailRU
+  class API
+    class Notifications
+      def initialize api
+        @api = api
+      end
+
+      def send params = {}
+        GetRequest.new(@api, 'notifications.send', params, Request::Secure::Yes).get
+      end
+    end
+  end
+end

data/lib/mailru-api/photos.rb

@@ -0,0 +1,27 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Photos
+      def initialize api
+        @api = api
+      end
+
+      def create_album params = {}
+        GetRequest.new(@api, 'photos.createAlbum', params).get
+      end
+      
+      def get params = {}
+        GetRequest.new(@api, 'photos.get', params).get
+      end
+      
+      def get_albums params = {}
+        GetRequest.new(@api, 'photos.getAlbums', params).get
+      end
+
+      def upload params = {}
+        PostRequest.new(@api, 'photos.upload', params).post
+      end
+    end
+	end
+end

data/lib/mailru-api/request.rb

@@ -0,0 +1,103 @@
+#:encoding: utf-8
+
+require 'json'
+require 'net/http'
+require 'uri'
+require 'digest'
+require 'rexml/document'
+
+module MailRU
+  class API
+    class Request
+
+      module Secure
+        No = 0
+        Yes = 1
+        Any = 2
+      end
+
+      def initialize api, method, method_params, secure = Secure::Any
+        @api = api
+        @method = method
+        @method_params = method_params
+        @secure = secure
+      end
+
+      protected
+
+      def use_s2s?
+        @api.secret_key and (@secure == Secure::Yes or @secure == Secure::Any)
+      end
+
+      def use_c2s?
+        @api.private_key and (@secure == Secure::No or @secure == Secure::Any)
+      end
+
+			def signature
+				return s2s_signature if use_s2s?
+				return c2s_signature if use_c2s?
+        ''
+			end
+
+			def c2s_signature
+        Digest::MD5.hexdigest(@api.uid + parameters.sort.join + @api.private_key)
+			end
+      
+      def s2s_signature
+        Digest::MD5.hexdigest(parameters.sort.join + @api.secret_key)
+      end
+      
+      def parameters
+        params = {app_id: @api.app_id, method: @method}
+        params.merge!({session_key: @api.session_key}) if @api.session_key
+        params.merge!({format: @api.format}) if @api.format
+        params.merge!(@method_params) if @method_params
+        params.merge!({secure: 1}) if use_s2s?
+
+				params.to_a.map{|p| p.join('=')}
+      end
+      
+      def handle_response response
+        response = response.body unless response.is_a?(String)
+
+        if @api.format == Format::XML
+          response = REXML::Document.new(response).root
+
+          error = response if response.name == 'error'
+          if error
+            raise MailRU::API::Error.create(
+              error.elements['error_code'].text,
+              error.elements['error_msg'].text
+            )
+          end
+        else
+          response = JSON.parse(response)
+          if response.is_a?(Hash)
+            error = response['error']
+            if error
+              raise MailRU::API::Error.create(error['error_code'], error['error_msg'])
+            end
+          end
+        end
+
+        response
+      end
+    end
+    
+    class GetRequest < Request   
+      def get        
+        request = URI.escape(PATH + '?' + parameters.push("sig=#{signature}").join('&'))
+        handle_response(Net::HTTP.get(URI(request)))
+      end
+    end
+    
+    class PostRequest < Request
+      def post
+        uri = URI(PATH)
+        request = Net::HTTP::Post.new(uri.path)
+        request.body = parameters.push("sig=#{signature}").join('&')
+        handle_response(Net::HTTP.new(uri.host, uri.port).request(request))
+      end
+    end
+  end
+end

data/lib/mailru-api/stream.rb

@@ -0,0 +1,39 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Stream
+      def initialize api
+        @api = api
+      end
+
+      def comment params = {}
+        GetRequest.new(@api, 'stream.comment', params).get
+      end
+      
+      def get params = {}
+        GetRequest.new(@api, 'stream.get', params).get
+      end
+      
+      def get_by_author params = {}
+        GetRequest.new(@api, 'stream.getByAuthor', params).get
+      end
+      
+      def like params = {}
+        GetRequest.new(@api, 'stream.like', params).get
+      end
+
+      def post params = {}
+        PostRequest.new(@api, 'stream.post', params).post
+      end
+
+      def share params ={}
+        PostRequest.new(@api, 'stream.share', params).post
+      end
+      
+      def unlike params = {}
+        GetRequest.new(@api, 'stream.unlike', params).get
+      end
+    end
+	end
+end

data/lib/mailru-api/users.rb

@@ -0,0 +1,27 @@
+#:encoding: utf-8
+
+module MailRU
+	class API
+    class Users
+      def initialize api
+        @api = api
+      end
+
+      def get_balance
+        GetRequest.new(@api, 'users.getBalance', params).get
+      end
+      
+      def get_info params = {}
+        GetRequest.new(@api, 'users.getInfo', params).get
+      end
+      
+      def has_app_permission params = {}
+        GetRequest.new(@api, 'users.hasAppPermission', params).get
+      end
+      
+      def is_app_user
+        GetRequest.new(@api, 'users.isAppUser', params).get
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: mailru-api
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Demin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-04-28 00:00:00.000000000 Z
+dependencies: []
+description: MailRU API for Ruby
+email: demin.alexey@inbox.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailru-api.rb
+- lib/mailru-api/audio.rb
+- lib/mailru-api/error.rb
+- lib/mailru-api/events.rb
+- lib/mailru-api/friends.rb
+- lib/mailru-api/guestbook.rb
+- lib/mailru-api/mail.rb
+- lib/mailru-api/messages.rb
+- lib/mailru-api/mobile.rb
+- lib/mailru-api/notifications.rb
+- lib/mailru-api/photos.rb
+- lib/mailru-api/request.rb
+- lib/mailru-api/stream.rb
+- lib/mailru-api/users.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MailRU API for Ruby
+test_files: []
+has_rdoc: