Git Product home page Git Product logo

klout's Introduction

Klout

Klout is a Ruby gem that provides a wrapper for interacting with the Klout API. Note: this gem only supports {version 2}[http://klout.com/s/developers/v2] of the Klout API. Use the {V1 branch}[https://github.com/terra-firma/klout/tree/v1] if you need legacy support.

Requirements

You will need a Klout API Key in order to get started.

Installation

(sudo) gem install klout

Usage

Please refer to the Klout API Documentation for more information about the API, or follow the examples below:

require 'klout'

Klout.api_key = ENV['KLOUT_API_KEY']
klout_id = Klout::Identity.find_by_screen_name('screen_name')

user = Klout::User.new(klout_id.id)
user.details
user.score
user.score.scoreDelta.dayChange
user.topics
user.influence

And that’s it!

Caching

The Klout API Documentation has great information about what data can be cached safely, and for how long, in order to improve the performance of your app.

Errors

Errors are based on the HTTP response of the request, so that you can rescue accordingly:

rescue Klout::ClientError > req
rescue Klout::BadRequest > req
rescue Klout::NotFound > req
rescue Klout::Unauthorized > req

Contributing to Klout

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.

  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.

  • Fork the project.

  • Start a feature/bugfix branch.

  • Commit and push until you are happy with your contribution.

  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright © 2011 Terra Firma Design & Consulting. See LICENSE.txt for further details.

klout's People

Contributors

bgetting avatar jasontorres avatar jbnunn avatar markmcspadden avatar murtuzakz 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.