school_friend 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kostyantyn
+
+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,29 @@
+# SchoolFriend
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'school_friend'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install school_friend
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/school_friend/api_methods.rb

@@ -0,0 +1,39 @@
+module SchoolFriend
+  module APIMethods
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+        base.send(:attr_reader, :session)
+      end
+    end
+
+    module ClassMethods
+      def api_method(*methods)
+        options = methods.last.is_a?(Hash) ? methods.pop : {}
+
+        namespace    = name.sub(/^.+::/, '')
+        namespace[0] = namespace[0].downcase
+
+        methods.each do |method|
+          call  = "session.api_call('#{namespace}.#{method.to_s.gsub(/_([a-z])/) { $1.upcase }}', params"
+          call += options[:session_only] ? ', true)' : ')'
+
+          class_eval <<-OES, __FILE__, __LINE__ + 1
+            def #{method}(params = {})             # def get_widgets(params = {})
+              response = #{call}                   #   response = session.api_call('widget.getWidgets', params, true)
+              if response.is_a?(Net::HTTPSuccess)  #   if response.is_a?(Net::HTTPSuccess)
+                JSON(response.body)                #     JSON(response.body)
+              else                                 #   else
+                response.error!                    #     response.error!
+              end                                  #   end
+            end                                    # end
+          OES
+        end
+      end
+    end
+
+    def initialize(session)
+      @session = session
+    end
+  end
+end

data/lib/school_friend/rest/auth.rb

@@ -0,0 +1,12 @@
+module SchoolFriend
+  module REST
+    class Auth
+      include APIMethods
+
+      api_method :login
+      api_method :login_by_token
+      api_method :expire_session, session_only: true
+      api_method :touch_session,  session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/callbacks.rb

@@ -0,0 +1,15 @@
+module SchoolFriend
+  module REST
+    class Callbacks
+
+      attr_reader :session
+
+      def initialize(session)
+        @session = session
+      end
+
+      def payment(params = {})
+      end
+    end
+  end
+end

data/lib/school_friend/rest/discussions.rb

@@ -0,0 +1,14 @@
+module SchoolFriend
+  module REST
+    class Discussions
+      include APIMethods
+
+      api_method :get_discussions,               session_only: true
+      api_method :get_discussion_comments_count, session_only: true
+      api_method :add_discussion_comment,        session_only: true
+      api_method :delete_discussion_comment,     session_only: true
+      api_method :get_discussion_comments,       session_only: true
+      api_method :mark_discussion_as_read,       session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/events.rb

@@ -0,0 +1,10 @@
+module SchoolFriend
+  module REST
+    class Events
+      include APIMethods
+
+      api_method :get,           session_only: true
+      api_method :get_type_info
+    end
+  end
+end

data/lib/school_friend/rest/friends.rb

@@ -0,0 +1,14 @@
+module SchoolFriend
+  module REST
+    class Friends
+      include APIMethods
+
+      api_method :get
+      api_method :get_mutual_friends
+      api_method :get_online
+      api_method :get_app_users,     session_only: true
+      api_method :get_birthdays
+      api_method :are_friends,       session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/messages.rb

@@ -0,0 +1,15 @@
+module SchoolFriend
+  module REST
+    class Messages
+      include APIMethods
+
+      api_method :get_conversations, session_only: true
+      api_method :get_list,          session_only: true
+      api_method :get,               session_only: true
+      api_method :send
+      api_method :mark_as_read,      session_only: true
+      api_method :mark_as_spam,      session_only: true
+      api_method :delete,            session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/notifications.rb

@@ -0,0 +1,10 @@
+module SchoolFriend
+  module REST
+    class Notifications
+      include APIMethods
+
+      api_method :send_simple
+      api_method :send_mass
+    end
+  end
+end

data/lib/school_friend/rest/payment.rb

@@ -0,0 +1,9 @@
+module SchoolFriend
+  module REST
+    class Payment
+      include APIMethods
+
+      api_method :get_user_account_balance, session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/photos.rb

@@ -0,0 +1,18 @@
+module SchoolFriend
+  module REST
+    class Photos
+      include APIMethods
+
+      api_method :create_album
+      api_method :delete_album
+      api_method :edit_album
+      api_method :get_albums
+      api_method :get_photo_info
+      api_method :get_photo_marks,       session_only: true
+      api_method :get_user_album_photos
+      api_method :get_user_photos
+      api_method :mark_user_photo,       session_only: true
+      api_method :set_album_main_photo
+    end
+  end
+end

data/lib/school_friend/rest/photos_v2.rb

@@ -0,0 +1,10 @@
+module SchoolFriend
+  module REST
+    class PhotosV2
+      include APIMethods
+
+      api_method :get_upload_url
+      api_method :commit,         method: 'POST'
+    end
+  end
+end

data/lib/school_friend/rest/share.rb

@@ -0,0 +1,9 @@
+module SchoolFriend
+  module REST
+    class Share
+      include APIMethods
+
+      api_method :add_link, session_only: true
+    end
+  end
+end

data/lib/school_friend/rest/stream.rb

@@ -0,0 +1,9 @@
+module SchoolFriend
+  module REST
+    class Stream
+      include APIMethods
+
+      api_method :publish
+    end
+  end
+end

data/lib/school_friend/rest/users.rb

@@ -0,0 +1,20 @@
+module SchoolFriend
+  module REST
+    class Users
+      include APIMethods
+
+      api_method :set_status
+      api_method :get_logged_in_user,    session_only: true
+      api_method :get_info,              session_only: true
+      api_method :is_app_user
+      api_method :has_app_permission
+      api_method :remove_app_permission
+      api_method :get_guests,            session_only: true
+      api_method :get_calls_left
+      api_method :get_current_user,      session_only: true
+      api_method :get_settings
+      api_method :set_settings
+      api_method :get_mobile_operator
+    end
+  end
+end

data/lib/school_friend/rest/widget.rb

@@ -0,0 +1,10 @@
+module SchoolFriend
+  module REST
+    class Widget
+      include APIMethods
+
+      api_method :get_widgets
+      api_method :get_widget_content
+    end
+  end
+end

data/lib/school_friend/session.rb

@@ -0,0 +1,114 @@
+require 'net/http'
+require 'digest'
+
+module SchoolFriend
+  class Session
+    class RequireSessionScopeError < ArgumentError
+    end
+
+    attr_reader :options, :session_scope
+
+    def initialize(options = {})
+      @options       = options
+      @session_scope = options[:session_key] && options[:session_secret_key]
+    end
+
+    # Returns true if API call is performed in session scope
+    #
+    # @return [TrueClass, FalseClass]
+    alias_method :session_scope?, :session_scope
+
+    # Returns true if API call is performed in application scope
+    #
+    # @return [TrueClass, FalseClass]
+    def application_scope?
+      not session_scope?
+    end
+
+    # Returns application key
+    #
+    # @return [String]
+    def application_key
+      SchoolFriend.application_key
+    end
+
+    # Returns signature for signing request params
+    #
+    # @return [String]
+    def signature
+      @signature ||= session_scope? ? options[:session_secret_key] : SchoolFriend.secret_key
+    end
+
+    # Returns API server
+    #
+    # @@return [String]
+    def api_server
+      SchoolFriend.api_server
+    end
+
+    # Signs params
+    #
+    # @param [Hash] params
+    # @return [Hash] returns modified params
+    def sign(params = {})
+      params = additional_params.merge(params)
+      digest = params.sort_by(&:first).map{ |key, value| "#{key}=#{value}" }.join
+      params[:sig] = Digest::MD5.hexdigest("#{digest}#{signature}")
+      params
+    end
+
+    # Returns additional params which are required for all requests.
+    # Depends on request scope.
+    #
+    # @return [Hash]
+    def additional_params
+      @additional_params ||= if session_scope?
+        {application_key: application_key, session_key: options[:session_key]}
+      else
+        {application_key: application_key}
+      end
+    end
+
+    # Performs API call to Odnoklassniki
+    #
+    # @example Performs API call in current scope
+    #   school_friend = SchoolFriend::Session.new
+    #   school_friend.api_call('widget.getWidgets', wids: 'mobile-header,mobile-footer') # Net::HTTPResponse
+    #
+    # @example Force performs API call in session scope
+    #   school_friend = SchoolFriend::Session.new
+    #   school_friend.api_call('widget.getWidgets', {wids: 'mobile-header,mobile-footer'}, true) # SchoolFriend::Session::RequireSessionScopeError
+    #
+    #
+    # @param [String] method API method
+    # @param [Hash] params params which should be sent to portal
+    # @param [FalseClass, TrueClass] force_session_call says if this call should be performed in session scope
+    # @return [Net::HTTPResponse]
+    def api_call(method, params = {}, force_session_call = false)
+      raise RequireSessionScopeError.new('This API call requires session scope') if force_session_call and application_scope?
+
+      uri = build_uri(method, params)
+      Net::HTTP.get_response(uri)
+    end
+
+    # Builds URI object
+    #
+    # @param [String] method request method
+    # @param [Hash] params request params
+    # @return [URI::HTTP]
+    def build_uri(method, params = {})
+      uri = URI(api_server)
+      uri.path  = '/api/' + method.sub('.', '/')
+      uri.query = URI.encode_www_form(sign(params))
+      uri
+    end
+
+    SchoolFriend::REST_NAMESPACES.each do |namespace|
+      class_eval <<-EOS, __FILE__, __LINE__ + 1
+        def #{namespace}
+          SchoolFriend::REST::#{namespace.capitalize.gsub(/_([a-z])/) { $1.upcase }}.new(self)
+        end
+      EOS
+    end
+  end
+end

data/lib/school_friend/version.rb

@@ -0,0 +1,3 @@
+module SchoolFriend
+  VERSION = '0.0.1'
+end

data/lib/school_friend.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+
+module SchoolFriend
+  REST_NAMESPACES = %w[auth callbacks discussions events friends messages notifications payment photos photos_v2 share stream stream users widget].freeze
+
+  class << self
+    extend Forwardable
+
+    attr_accessor :application_key, :secret_key, :api_server
+
+    def_delegators :session, *REST_NAMESPACES
+
+    def session(options = {})
+      Session.new(options)
+    end
+  end
+end
+
+require 'school_friend/version'
+require 'school_friend/session'
+require 'school_friend/api_methods'
+require 'school_friend/rest/auth'
+require 'school_friend/rest/callbacks'
+require 'school_friend/rest/discussions'
+require 'school_friend/rest/events'
+require 'school_friend/rest/friends'
+require 'school_friend/rest/messages'
+require 'school_friend/rest/notifications'
+require 'school_friend/rest/payment'
+require 'school_friend/rest/photos'
+require 'school_friend/rest/photos_v2'
+require 'school_friend/rest/share'
+require 'school_friend/rest/stream'
+require 'school_friend/rest/users'
+require 'school_friend/rest/widget'

data/school_friend.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'school_friend/version'
+
+Gem::Specification.new do |gem|
+  gem.name                  = 'school_friend'
+  gem.version               = SchoolFriend::VERSION
+  gem.authors               = 'Kostyantyn Stepanyuk'
+  gem.email                 = 'kostya.stepanyuk@gmail.com'
+  gem.description           = 'A Ruby interface to the Odnoklassniki API'
+  gem.summary               = 'A Ruby interface to the Odnoklassniki API'
+  gem.homepage              = 'https://github.com/kostyantyn/school_friend'
+  gem.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+
+  gem.files                 = `git ls-files`.split($/)
+  gem.executables           = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files            = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths         = %w[lib]
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: school_friend
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kostyantyn Stepanyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby interface to the Odnoklassniki API
+email: kostya.stepanyuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/school_friend.rb
+- lib/school_friend/api_methods.rb
+- lib/school_friend/rest/auth.rb
+- lib/school_friend/rest/callbacks.rb
+- lib/school_friend/rest/discussions.rb
+- lib/school_friend/rest/events.rb
+- lib/school_friend/rest/friends.rb
+- lib/school_friend/rest/messages.rb
+- lib/school_friend/rest/notifications.rb
+- lib/school_friend/rest/payment.rb
+- lib/school_friend/rest/photos.rb
+- lib/school_friend/rest/photos_v2.rb
+- lib/school_friend/rest/share.rb
+- lib/school_friend/rest/stream.rb
+- lib/school_friend/rest/users.rb
+- lib/school_friend/rest/widget.rb
+- lib/school_friend/session.rb
+- lib/school_friend/version.rb
+- school_friend.gemspec
+homepage: https://github.com/kostyantyn/school_friend
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: A Ruby interface to the Odnoklassniki API
+test_files: []