Code Monkey home page Code Monkey logo

school_friend's Introduction

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

# Init the SchoolFriend Module
SchoolFriend.application_id = ''
SchoolFriend.application_key = ''
SchoolFriend.secret_key = ''
SchoolFriend.api_server = 'http://api.odnoklassniki.ru'

# Example call to a method that doesn't require a session or oauth2 access token  
puts SchoolFriend.users.is_app_user(:uid => "425634635") # Note that method name is underscored

# Init an Oauth2 Session
# You can init an oauth session in two ways:
# 1. By providing the oauth code and let this gem to acquire the access token for you
session = SchoolFriend.session(:oauth_code => code)

# 2. By providing an access token and a refresh token you already have
session = SchoolFriend.session(:access_token => access_token, :refresh_token => refresh_token)

# 3. Refreshing the access token:
# According to Odnoklassniki's API doc access token is valid for 30 minutes
# You can extend this time by refreshing the access token this will give
# you a new token that will be valid for 30 days
# http://dev.odnoklassniki.ru/wiki/pages/viewpage.action?pageId=12878032
session.refresh_access_token

# Alternative - non oauth: Acquire a session with user's user_name and password (not recommanded)
# Odnoklassniki's sandbox has no oauth2 support so you have to use this method there
session = SchoolFriend.session(SchoolFriend.auth.login(:user_name => username, :password => password))

# Once you have a session you can perform actions with it:
puts session.users.get_current_user

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

school_friend's People

Contributors

kostyantyn avatar phoet avatar theosp avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.