gitter-badger / dribbble

Simple wrapper for the new Dribbble API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DribbbleAPI

Codeship Status for Calyhre/dribbble

Build Status

Dribbble API gem

Installation

Requirements

  • Ruby ~> 2.0

In a Gemfile

gem 'dribbble'

By yourself

gem install dribbble

Usage

First you need to instanciate a client with a client access token. You can get one by creating an application on developer.dribbble.com.

client = Dribbble::Client.new token: '0123456789abcdef'

User

You can get the current user logged in by calling client.user

client.get_user
#=> #<Dribbble::User ...>

Or you can get a specific user by knowing his ID

user = client.get_user(1)
#=> #<Dribbble::User id=1 ...>

You can access users attributes like this :

user.name
#=> "Charley D."

user.username
#=> "Calyhre"

A user also have buckets :

user.buckets
#=> [#<Dribbble::Bucket ...>, #<Dribbble::Bucket ...>]

Shots

You can create a shot by calling client.create_shot

shot = {
  title: 'Shot title',
  desciption: 'Shot description',
  image: File.new('some/directory/image.jpg', 'rb'),
  tags: %w(tag1 tag2)
}

client.create_shot(shot)
#=> True

Contributing

Feel free to help me make this gem awesome !

Contributors and CONTRIBUTING

Licence

Released under the MIT License. See the LICENSE file for further details.

About

Simple wrapper for the new Dribbble API

License:MIT License