dribbble 1.0.0.beta2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d46c451ba190bda80438f296081283e89c089ac
-  data.tar.gz: 0bb8dc6141ec990797129ce5c399b79c369b33d2
+  metadata.gz: 18cd848202fc891ab28292a51dc036f64125d085
+  data.tar.gz: d913356962f8e04f18370d311dfe1dc3db316976
 SHA512:
-  metadata.gz: f60447a7217a53c00902de8d97990ec3148081dc723dd830880b8815c6ba3a6493e9f24365f2bc1d24a7797dafcbfa1de8d85a1e864f3b6d24ff26e9384b9e61
-  data.tar.gz: eb41db304a4d384c7d8d698cbcc25c5ed5159d6095d4d591f765b4786554b47132439c93427b4f8bc2f0f7545c4e659130d4013c74d7d06b57c94b37d20b5f16
+  metadata.gz: 2f884da43284d7c6cf7bf988b2af6f748ebd10daccfbfbdbd4fe1705c79cf18f17dea38ed4dc6be7b9035a7db301ab96c394b3513374f513ee9f6b970dc74312
+  data.tar.gz: 1a5ccdecd5ca1d38ff301ce9e3cdca166705bd2e15a357121b83fef7bcf4cd7322a94012261bb1e56302ddcf8e0034dae88d620e6bc5c9389278a385125781b6

data/.travis.yml

@@ -1,10 +1,14 @@
+sudo: false
 language: ruby
 
 cache: bundler
 rvm:
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.1.7
+  - 2.2.3
+  - 2.3.0-dev
 
 matrix:
   fast_finish: true
+  allow_failures:
+    - rvm: 2.3.0-dev

data/README.md

@@ -23,70 +23,380 @@ gem 'dribbble'
 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](http://developer.dribbble.com/).
+Lets assume you have your token set:
 
 ```ruby
-client = Dribbble::Client.new token: '0123456789abcdef'
+token = 'my_access_token'
 ```
 
-### User
-
-You can get the current user logged in by calling `client.user`
+Some calls are through a client:
 
 ```ruby
-client.get_user
-#=> #<Dribbble::User ...>
+client = Dribbble::Client.new(token)
 ```
 
-Or you can get a specific user by knowing his ID
 
+
+
+### Buckets
+
+##### Find a bucket
+```ruby
+bucket = Dribbble::Bucket.find(token, '2754')
+```
+
+##### Create a bucket
 ```ruby
-user = client.get_user(1)
-#=> #<Dribbble::User id=1 ...>
+bucket = Dribbble::Bucket.create(token, name: 'A new bucket', description: 'A description')
 ```
 
-You can access users attributes like this :
+##### Update a bucket
+```ruby
+bucket.update name: 'An updated bucket name'
+```
 
+##### Delete a bucket
 ```ruby
-user.name
-#=> "Charley D."
+bucket.delete
+```
+
+#### Bucket shots
 
-user.username
-#=> "Calyhre"
+##### List bucket shots
+```ruby
+shots = bucket.shots
 ```
 
-A user also have buckets :
+##### Add shot to a bucket
+```ruby
+bucket.add_shot(329335)
+# or
+bucket.add_shot(shot) # shot is a Dribbble::Shot
+```
 
+##### Remove shot from a bucket
 ```ruby
-user.buckets
-#=> [#<Dribbble::Bucket ...>, #<Dribbble::Bucket ...>]
+bucket.remove_shot(329335)
+# or
+bucket.remove_shot(shot) # shot is a Dribbble::Shot
 ```
 
-... And shots :
 
+
+
+### Projects
+
+##### Find a Projects
+```ruby
+project = Dribbble::Project.find(token, 3)
+```
+
+#### Project shots
 ```ruby
-user.shots
-#=> [#<Dribbble::Shot ...>, #<Dribbble::Shot ...>]
+shots = project.shots
 ```
 
+
+
+
 ### Shots
 
-You can create a shot by calling `client.create_shot`
+##### List shots
+```ruby
+shots = Dribbble::Shot.all(token)
+```
+
+##### Find a shot
+```ruby
+shot = Dribbble::Shot.find(token, 1971500)
+```
+
+##### Create a shot
+```ruby
+params = {
+  title: 'A new shot',
+  description: 'Shot description',
+  tags: %w(tag1 tag2),
+  team_id: 1234,
+  rebound_source_id: 1234,
+}
+shot = Dribbble::Shot.create(token, params)
+```
 
+##### Update a shot
 ```ruby
-shot = {
-  title: 'Shot title',
-  desciption: 'Shot description',
-  image: File.new('some/directory/image.jpg', 'rb'),
-  tags: %w(tag1 tag2)
+params = {
+  title: 'A new shot',
+  description: 'Shot description',
+  tags: %w(tag1 tag2),
+  team_id: 1234
 }
+shot.update(params)
+```
+
+##### Delete a shot
+```ruby
+shot.delete
+```
+
+#### Shot attachments
 
-client.create_shot(shot)
-#=> True
+##### List attachments for a shot
+```ruby
+shot.attachments
+```
+
+##### Create an attachment
+```ruby
+shot.create_attachment(file: File.open('attachment_path'))
 ```
 
+##### Get a single attachment
+```ruby
+shot.find_attachment(206165)
+```
+
+##### Delete an attachment
+```ruby
+shot.delete_attachment(206165)
+```
+
+
+#### Shot buckets
+##### List buckets for a shot
+```ruby
+shot.buckets
+```
+
+
+#### Shot comments
+##### List comments for a shot
+```ruby
+shot.comments
+```
+
+##### Create a comment
+```ruby
+comment = shot.create_comment(body: 'A comment')
+```
+
+##### Get a single comment
+```ruby
+comment = shot.find_comment(1145736)
+```
+
+##### Update a comment
+```ruby
+comment = shot.update_comment(1145736, body: 'Comment body')
+```
+
+##### Delete a comment
+```ruby
+shot.delete_comment(1145736)
+```
+
+##### List likes for a comment
+```ruby
+comment.likes
+```
+
+##### Check if you like a comment
+```ruby
+comment.like?
+```
+
+##### Like a comment
+```ruby
+comment.like!
+```
+
+##### Unlike a comment
+```ruby
+comment.unlike!
+```
+
+#### Shot likes
+##### List the likes for a shot
+```ruby
+shot.likes
+```
+
+##### Check if you like a shot
+```ruby
+shot.like?
+```
+
+##### Like a shot
+```ruby
+shot.like!
+```
+
+##### Unlike a shot
+```ruby
+shot.unlike!
+```
+
+#### Shot projects
+##### List projects for a shot
+```ruby
+projects = shot.projects
+```
+
+#### Shot rebounds
+##### List rebounds for a shot
+```ruby
+shots = shot.rebounds
+```
+
+
+
+
+### Teams
+
+Let's assume you have a team:
+```ruby
+user = Dribbble::User.find(token, 483195)
+team = user.teams.first
+```
+
+#### Team members
+##### List a team’s members
+```ruby
+users = team.members
+```
+
+
+#### Team shots
+##### List shots for a team
+```ruby
+shots = team.shots
+```
+
+
+
+
+### Users
+##### Get a single user
+```ruby
+user = Dribbble::User.find(token, 483195)
+```
+
+##### Get the authenticated user
+```ruby
+user = client.user
+```
+
+
+#### User buckets
+##### List a user’s buckets
+```ruby
+user.buckets
+```
+
+##### List authenticated user’s buckets
+```ruby
+buckets = client.buckets
+```
+
+
+#### User followers
+##### List followers of a user
+```ruby
+users = user.followers
+```
+
+##### List followers of authenticated user
+```ruby
+users = client.followers
+```
+
+##### List users followed by a user
+```ruby
+users = user.following
+```
+
+##### List shots for users followed by a authenticated user
+```ruby
+shots = client.following_shots
+```
+
+##### Check if you are following a user
+```ruby
+user.following?
+```
+
+##### Check if one user is following another
+```ruby
+user.following?(483195)
+```
+
+##### Follow a user
+```ruby
+user.follow!
+```
+
+##### Unfollow a user
+```ruby
+user.unfollow!
+```
+
+
+#### User likes
+##### List shot likes for a user
+```ruby
+shots = user.likes
+```
+
+##### List shot likes for authenticated user
+```ruby
+shots = client.likes
+```
+
+
+#### User projects
+##### List a user’s projects
+```ruby
+projects = user.projects
+```
+
+##### List authenticated user’s projects
+```ruby
+projects = client.projects
+```
+
+
+#### User shots
+##### List shots for a user
+```ruby
+shots = user.shots
+```
+
+##### List shots for authenticated user
+```ruby
+shots = client.shots
+```
+
+
+#### User teams
+##### List a user’s teams
+```ruby
+teams = user.teams
+```
+
+##### List authenticated user’s teams
+```ruby
+teams = client.teams
+```
+
+
+
 ### Pagination & parameters
 
 All requests are paginated, defaults params are :
@@ -99,13 +409,11 @@ All requests are paginated, defaults params are :
 You override them or adding some by passing a `Hash` to every request :
 
 ```ruby
-client.user page: 2, custom_param: 'My param'
+user.shots page: 2, custom_param: 'My param'
 ```
 
 ## Contributing
 
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Calyhre/dribbble?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 Feel free to help me make this gem awesome !
 
 [Contributors](https://github.com/Calyhre/dribbble/graphs/contributors) and [CONTRIBUTING](https://github.com/Calyhre/dribbble/blob/master/CONTRIBUTING.md)

data/lib/dribbble/base.rb

@@ -32,66 +32,6 @@ module Dribbble
       end
     end
 
-    # Get a single bucket
-    def get_bucket(id)
-      Dribbble::Bucket.new @token, html_get("/buckets/#{id}")
-    end
-
-    # Get authenticated user's buckets
-    def get_buckets(attrs = {})
-      Dribbble::Bucket.batch_new token, html_get('/user/buckets', attrs)
-    end
-
-    # Get authenticated user's followers
-    def get_followers(attrs = {})
-      Dribbble::User.batch_new token, html_get('/user/followers', attrs)
-    end
-
-    # Get authenticated user's likes
-    def get_likes(attrs = {})
-      Dribbble::Shot.batch_new token, html_get('/user/likes', attrs), 'shot'
-    end
-
-    # Get a single project
-    def get_project(id)
-      Dribbble::Project.new @token, html_get("/projects/#{id}")
-    end
-
-    # Get authenticated user's followers
-    def get_projects(attrs = {})
-      Dribbble::Project.batch_new token, html_get('/user/projects', attrs)
-    end
-
-    # Get a single Shot
-    def get_shot(id)
-      Dribbble::Shot.new @token, html_get("/shots/#{id}")
-    end
-
-    # Get authenticated user's shots
-    def get_shots(attrs = {})
-      Dribbble::Shot.batch_new token, html_get('/user/shots', attrs)
-    end
-
-    # Get authenticated user's followees shots
-    # Limited to first 600 shots regardless of the pagination
-    def get_following_shots(attrs = {})
-      Dribbble::Shot.batch_new token, html_get('/user/following/shots', attrs)
-    end
-
-    # Get authenticated user's teams
-    def get_teams(attrs = {})
-      Dribbble::Team.batch_new token, html_get('/user/teams', attrs)
-    end
-
-    # Get a single User or the authenticated one
-    def get_user(id = nil)
-      if id
-        Dribbble::User.new @token, html_get("/users/#{id}")
-      else
-        Dribbble::User.new @token, html_get('/user')
-      end
-    end
-
     private
 
     def build_dribbble_url(id, dribbble_url)

data/lib/dribbble/bucket.rb

@@ -10,9 +10,7 @@ module Dribbble
     include Dribbble::Utils::Updatable
     include Dribbble::Utils::Deletable
 
-    def shots(attrs = {})
-      Dribbble::Shot.batch_new token, html_get("/bucket/#{id}/shots", attrs)
-    end
+    has_many :shots
 
     def add_shot(shot)
       shot_id = shot.is_a?(Dribbble::Shot) ? shot.id : shot

data/lib/dribbble/client.rb

@@ -13,9 +13,51 @@ module Dribbble
   class Client < Dribbble::Base
     include Dribbble::Utils
 
-    def initialize(token: nil)
+    def initialize(token = nil)
+      token = token.is_a?(Hash) ? token[:token] : token
       @token = token
       fail Dribbble::Error::MissingToken if @token.nil?
     end
+
+    # Get authenticated user's buckets
+    def buckets(attrs = {})
+      Dribbble::Bucket.batch_new token, html_get('/user/buckets', attrs)
+    end
+
+    # Get authenticated user's followers
+    def followers(attrs = {})
+      Dribbble::User.batch_new token, html_get('/user/followers', attrs)
+    end
+
+    # Get authenticated user's likes
+    def likes(attrs = {})
+      Dribbble::Shot.batch_new token, html_get('/user/likes', attrs), 'shot'
+    end
+
+    # Get authenticated user's followers
+    def projects(attrs = {})
+      Dribbble::Project.batch_new token, html_get('/user/projects', attrs)
+    end
+
+    # Get authenticated user's shots
+    def shots(attrs = {})
+      Dribbble::Shot.batch_new token, html_get('/user/shots', attrs)
+    end
+
+    # Get authenticated user's followees shots
+    # Limited to first 600 shots regardless of the pagination
+    def following_shots(attrs = {})
+      Dribbble::Shot.batch_new token, html_get('/user/following/shots', attrs)
+    end
+
+    # Get authenticated user's teams
+    def teams(attrs = {})
+      Dribbble::Team.batch_new token, html_get('/user/teams', attrs)
+    end
+
+    # Get a single User or the authenticated one
+    def user
+      Dribbble::User.new @token, html_get('/user')
+    end
   end
 end

data/lib/dribbble/utils/findable.rb

@@ -3,9 +3,7 @@ module Dribbble
     module Findable
       module ClassMethods
         def find(token, id)
-          @token = token
-          @client = Dribbble::Client.new token: @token
-          @client.send "get_#{name.split('::').last.downcase}", id
+          new token, html_get("/#{pluralized_class_name}/#{id}")
         end
       end
 

data/lib/dribbble/version.rb

@@ -1,4 +1,4 @@
 # Dribbble Version
 module Dribbble
-  VERSION = '1.0.0.beta2'
+  VERSION = '1.0.0'
 end

data/spec/lib/dribbble/base_spec.rb

@@ -48,143 +48,4 @@ describe Dribbble::Client do
       end
     end
   end
-
-  describe 'on #get_bucket' do
-    subject do
-      stub_dribbble :get, '/buckets/2754', DribbbleAPI::BucketSuccess
-      @base.get_bucket 2754
-    end
-
-    it 'return a bucket' do
-      expect(subject).to be_a Dribbble::Bucket
-      expect(subject.id).to eq(2754)
-    end
-  end
-
-  describe 'on #get_buckets' do
-    subject do
-      stub_dribbble :get, '/user/buckets', DribbbleAPI::BucketsSuccess
-      @base.get_buckets
-    end
-
-    it 'return buckets' do
-      expect(subject.first).to be_a Dribbble::Bucket
-    end
-  end
-
-  describe 'on #get_followers' do
-    subject do
-      stub_dribbble :get, '/user/followers', DribbbleAPI::FollowersSuccess
-      @base.get_followers
-    end
-
-    it 'return users' do
-      expect(subject.first).to be_a Dribbble::User
-    end
-  end
-
-  describe 'on #get_likes' do
-    subject do
-      stub_dribbble :get, '/user/likes', DribbbleAPI::UserLikesSuccess
-      @base.get_likes
-    end
-
-    it 'return shots' do
-      expect(subject.first).to be_a Dribbble::Shot
-    end
-  end
-
-  describe 'on #get_project' do
-    subject do
-      stub_dribbble :get, '/projects/3', DribbbleAPI::ProjectSuccess
-      @base.get_project 3
-    end
-
-    it 'return a project' do
-      expect(subject).to be_a Dribbble::Project
-      expect(subject.id).to eq(3)
-    end
-  end
-
-  describe 'on #get_projects' do
-    subject do
-      stub_dribbble :get, '/user/projects', DribbbleAPI::ProjectsSuccess
-      @base.get_projects
-    end
-
-    it 'return projects' do
-      expect(subject.first).to be_a Dribbble::Project
-    end
-  end
-
-  describe 'on #get_shot' do
-    subject do
-      stub_dribbble :get, '/shots/471756', DribbbleAPI::ShotSuccess
-      @base.get_shot 471_756
-    end
-
-    it 'return a shot' do
-      expect(subject).to be_a Dribbble::Shot
-      expect(subject.id).to eq(471_756)
-    end
-  end
-
-  describe 'on #get_shots' do
-    subject do
-      stub_dribbble :get, '/user/shots', DribbbleAPI::ShotsSuccess
-      @base.get_shots
-    end
-
-    it 'return shots' do
-      expect(subject.first).to be_a Dribbble::Shot
-    end
-  end
-
-  describe 'on #get_following_shots' do
-    subject do
-      stub_dribbble :get, '/user/following/shots', DribbbleAPI::ShotsSuccess
-      @base.get_following_shots
-    end
-
-    it 'return shots' do
-      expect(subject.first).to be_a Dribbble::Shot
-    end
-  end
-
-  describe 'on #get_teams' do
-    subject do
-      stub_dribbble :get, '/user/teams', DribbbleAPI::TeamsSuccess
-      @base.get_teams
-    end
-
-    it 'return teams' do
-      expect(subject.first).to be_a Dribbble::Team
-    end
-  end
-
-  describe 'on #get_user' do
-    describe 'without id' do
-      subject do
-        stub_dribbble :get, '/user', DribbbleAPI::CurrentUserSuccess
-        @base.get_user
-      end
-
-      it 'return current user' do
-        expect(subject).to be_a Dribbble::User
-        expect(subject.id).to eq(8_008_135)
-      end
-    end
-
-    describe 'with id' do
-      subject do
-        stub_dribbble :get, '/users/483195', DribbbleAPI::UserSuccess
-        @base.get_user 483_195
-      end
-
-      it 'return current user' do
-        expect(subject).to be_a Dribbble::User
-        expect(subject.id).to eq(483_195)
-      end
-    end
-  end
 end

data/spec/lib/dribbble/bucket_spec.rb

@@ -44,7 +44,7 @@ describe Dribbble::Bucket do
 
     describe 'on #shots' do
       subject do
-        stub_dribbble :get, '/bucket/2754/shots', DribbbleAPI::ShotsSuccess
+        stub_dribbble :get, '/buckets/2754/shots', DribbbleAPI::ShotsSuccess
         @bucket.shots
       end
 

data/spec/lib/dribbble/client_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe Dribbble::Client do
+  before :all do
+    @client = Dribbble::Client.new 'valid_token'
+  end
+
   describe 'without token' do
     it 'raises Dribbble::Error::MissingToken' do
       expect do
@@ -18,7 +22,7 @@ describe Dribbble::Client do
 
       it 'raise Dribbble::Error::Unauthorized' do
         expect do
-          subject.get_user
+          subject.user
         end.to raise_error(Dribbble::Error::Unauthorized)
       end
     end
@@ -30,9 +34,98 @@ describe Dribbble::Client do
       end
 
       it 'return a Dribbble::User' do
-        expect(subject.get_user).to be_a Dribbble::User
-        expect(subject.get_user.name).to be_a String
+        expect(subject.user).to be_a Dribbble::User
+        expect(subject.user.name).to be_a String
       end
     end
   end
+
+  describe 'on #buckets' do
+    subject do
+      stub_dribbble :get, '/user/buckets', DribbbleAPI::BucketsSuccess
+      @client.buckets
+    end
+
+    it 'return buckets' do
+      expect(subject.first).to be_a Dribbble::Bucket
+    end
+  end
+
+  describe 'on #followers' do
+    subject do
+      stub_dribbble :get, '/user/followers', DribbbleAPI::FollowersSuccess
+      @client.followers
+    end
+
+    it 'return users' do
+      expect(subject.first).to be_a Dribbble::User
+    end
+  end
+
+  describe 'on #likes' do
+    subject do
+      stub_dribbble :get, '/user/likes', DribbbleAPI::UserLikesSuccess
+      @client.likes
+    end
+
+    it 'return shots' do
+      expect(subject.first).to be_a Dribbble::Shot
+    end
+  end
+
+  describe 'on #projects' do
+    subject do
+      stub_dribbble :get, '/user/projects', DribbbleAPI::ProjectsSuccess
+      @client.projects
+    end
+
+    it 'return projects' do
+      expect(subject.first).to be_a Dribbble::Project
+    end
+  end
+
+  describe 'on #shots' do
+    subject do
+      stub_dribbble :get, '/user/shots', DribbbleAPI::ShotsSuccess
+      @client.shots
+    end
+
+    it 'return shots' do
+      expect(subject.first).to be_a Dribbble::Shot
+    end
+  end
+
+  describe 'on #following_shots' do
+    subject do
+      stub_dribbble :get, '/user/following/shots', DribbbleAPI::ShotsSuccess
+      @client.following_shots
+    end
+
+    it 'return shots' do
+      expect(subject.first).to be_a Dribbble::Shot
+    end
+  end
+
+  describe 'on #teams' do
+    subject do
+      stub_dribbble :get, '/user/teams', DribbbleAPI::TeamsSuccess
+      @client.teams
+    end
+
+    it 'return teams' do
+      expect(subject.first).to be_a Dribbble::Team
+    end
+  end
+
+  describe 'on #user' do
+    subject do
+      stub_dribbble :get, '/user', DribbbleAPI::CurrentUserSuccess
+      @client.user
+    end
+
+    it 'return current user' do
+      expect(subject).to be_a Dribbble::User
+      expect(subject.id).to eq(8_008_135)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dribbble
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0
 platform: ruby
 authors:
 - Calyhre
@@ -182,9 +182,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2