Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A Ruby wrapper for the Behance API.

branch: master
README.md

The Behance Ruby Gem

A Ruby wrapper for the Behance API.

More information about the API capabilities can be found here.

Installation

$ gem install behance

API Usage Examples

First of all, you will need to get an access token here.

Once you get it, you'll be able to start playing

# initializing the client
$ client = Behance::Client.new(access_token: "access-token")

Projects

Search for projects

$ client.projects
$ client.projects(city: "San Francisco", state: "California", field: "branding")

Get the information and content of a project

$ client.project(5133725)

Get the comments for a project

$ client.project_comments(5133725)

Users

Search for users

$ client.users
$ client.users(state: "California", city: "San Francisco")

Get basic information about an user

$ client.user(920309)
$ client.user("jonkap1")

Get the projects published by an user

$ client.user_projects(920309)
$ client.user_projects("jonkap1")
$ client.user_projects("jonkap1", page: 2, sort: "views")

Get the works-in-progress published by an user

$ client.user_wips(920309)
$ client.user_wips(920309, page: 2)
$ client.user_wips("jonkap1", sort: "comments", page: 3)

Get a list of user's recently appreciated projects

$ client.user_appreciations(920309)
$ client.user_appreciations("jonkap1")

Get a list of a user's collections. The user argument can be an ID or username.

$ client.user_collections(42)
$ client.user_collections(42, page: 2)
$ client.user_collections("rur", page: 2)

Works in Progress

Search for works-in-progress

$ client.wips
$ client.wips(time: "today", page: 2)

Get information about a work in progress

$ client.wip(69)

Get information and contents of a revision of a work in progress

$ client.wip_revision(69, 133)

Get comments on a revision of a work in progress

$ client.wip_revision_comments(69, 133)

Collections

Search for collections

$ client.collections
$ client.collections(time: "today", page: 2)

Get basic information about a collection

$ client.collection(5074147)

Get projects from a collection

$ client.collection_projects(5074147)
$ client.collection_projects(5074147, page: 2)

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

Copyright

Copyright (c) 2012-2013 Tractical. See LICENSE for details.

Something went wrong with that request. Please try again.