behance 0.5.1 → 0.6.0

data/lib/behance/fields.rb

@@ -2,7 +2,7 @@
 module Behance
   class Client
     module Fields
-      # Public: Retrieve all Creative Fields.
+      # Public: Retrieve all Creative Fields (in 'fields').
       #
       # Examples
       #
@@ -12,6 +12,17 @@ module Behance
       def fields
         request("fields")["fields"]
       end
+
+      # Public: Retrieve all Creative Fields (in 'popular').
+      #
+      # Examples
+      #
+      #   @client.popular
+      #
+      # Returns an array of popular creative fields in JSON format.
+      def popular
+        request("fields")["popular"]
+      end
     end
   end
 end

data/lib/behance/project.rb

@@ -3,29 +3,35 @@ module Behance
   class Client
     module Project
       # Public: Search for projects.
-      # 
-      # options - The Hash of options that the API would expect:
-      #           :q       - Free text query string.
-      #           :sort    - The order the results are returned in. 
-      #                      Possible values: featured_date (default), apprecia-
-      #                      tions, views, comments, 
-      #                      published_date.
-      #           :time    - Limits the search by time. 
-      #                      Possible values: all (default), today, week, month.
-      #           :field   - Limits the search by creative field. 
-      #                      Accepts a URL-encoded field name from the list of 
-      #                      defined creative fields.
-      #           :country - Limits the search by a 2-letter FIPS country code.
-      #           :state   - Limits the search by state or province name.
-      #           :city    - Limits the search by city name.
-      #           :page    - The page number of the results, always starting 
-      #                      with 1.
-      #           :tags    - Limits the search by tags. 
-      #                      Accepts one tag name or a pipe-separated list of 
-      #                      tag names.
+      #
+      # options - The Hash with options that the API would expect:
+      #           :q           - Free text query string.
+      #           :sort        - The order the results are returned in.
+      #                          Possible values: featured_date (default),
+      #                          appreciations, views, comments, published_date.
+      #           :time        - Limits the search by time.
+      #                          Possible values: all (default), today, week,
+      #                          month.
+      #           :field       - Limits the search by creative field.
+      #                          Accepts a URL-encoded field name from the list
+      #                          of defined creative fields.
+      #           :country     - Limits the search by a 2-letter FIPS country
+      #                          code.
+      #           :state       - Limits the search by state or province name.
+      #           :city        - Limits the search by city name.
+      #           :page        - The page number of the results, always starting
+      #                          with 1.
+      #           :tags        - Limits the search by tags. Accepts one tag name
+      #                          or a pipe-separated list of tag names.
+      #           :color_hex   - Limit results to an RGB hex value (without #)
+      #           :color_range - How closely to match the requested color_hex,
+      #                          in color shades (default: 20) [0-255]
+      #           :license     - Filter by creative license.
+      #                          Acronyms found here:
+      #                          http://creativecommons.org/licenses/
       #
       # Examples
-      # 
+      #
       #   @client.projects
       #   @client.projects(q: "Freelance", state: "CA", field: "Branding")
       #
@@ -48,20 +54,20 @@ module Behance
       end
 
       # Public: Get the comments for a project
-      # 
-      # project_id - The ID (Integer) of the project. 
-      # options    - The Hash of options that the API would expect:
-      #              :page - The page number of the results, always 
-      #              starting with 1.
-      # 
+      #
+      # project_id - The ID (Integer) of the project.
+      # options    - The Hash with options that the API would expect:
+      #              :page - The page number of the results, always starting
+      #                      with 1.
+      #
       # Examples
-      # 
+      #
       #   @client.project_comments(1)
       #   @client.project_comments(1, page: 1)
-      # 
+      #
       # Returns an array of project comments in JSON format.
       def project_comments(project_id, options={})
-        request("projects/#{project_id}/comments", options)["comments"] 
+        request("projects/#{project_id}/comments", options)["comments"]
       end
     end
   end

data/lib/behance/user.rb

@@ -4,28 +4,28 @@ module Behance
     module User
       # Public: Search for users.
       #
-      # options - The Hash of options that the API would expect:
+      # options - The Hash with options that the API would expect:
       #           :q       - Free text query string.
-      #           :field   - Limits the search by creative field. 
-      #                      Accepts a URL-encoded field name from the list of 
+      #           :field   - Limits the search by creative field.
+      #                      Accepts a URL-encoded field name from the list of
       #                      defined creative fields.
       #           :country - Limits the search by a 2-letter FIPS country code.
       #           :state   - Limits the search by state or province name.
       #           :city    - Limits the search by city name.
-      #           :page    - The page number of the results, always starting 
+      #           :page    - The page number of the results, always starting
       #                      with 1.
-      #           :sort    - The order the results are returned in. 
-      #                      Possible values: featured_date (default), apprecia-
-      #                      tions, views, comments, 
-      #                      published_date, followed.
-      #           :tags    - Limits the search by tags. 
-      #                      Accepts one tag name or a pipe-separated list of 
+      #           :sort    - The order the results are returned in.
+      #                      Possible values: featured_date (default),
+      #                      appreciations, views, comments, published_date,
+      #                      followed.
+      #           :tags    - Limits the search by tags.
+      #                      Accepts one tag name or a pipe-separated list of
       #                      tag names.
       #
       # Examples
       #
       #   @client.users
-      #   @client.users(q: "Juan", state: "California", :tags "freelance")
+      #   @client.users(q: "Juan", state: "California", tags: "freelance")
       #
       # Returns an array of users in JSON format.
       def users(options={})
@@ -46,16 +46,16 @@ module Behance
         request("users/#{user}")["user"]
       end
 
-      # Public: Get the projects published by an user. 
+      # Public: Get the projects published by a user.
       #
       # user    - Can be an ID (Integer) or username (String)
-      # options - The Hash of options that the API would expect:
-      #           :sort - The order the results are returned in. 
-      #                   Possible values: featured_date (default), apprecia-
-      #                   tions, views, comments, published_date.
-      #           :time - Limits the search by time. 
+      # options - The Hash with options that the API would expect:
+      #           :sort - The order the results are returned in.
+      #                   Possible values: featured_date (default),
+      #                   appreciations, views, comments, published_date.
+      #           :time - Limits the search by time.
       #                   Possible values: all (default), today, week, month.
-      #           :page - The page number of the results, always starting 
+      #           :page - The page number of the results, always starting
       #                   with 1.
       #
       # Examples
@@ -64,7 +64,7 @@ module Behance
       #   @client.user_projects("foo")
       #   @client.user_projects("foo", page: 2, sort: "views")
       #
-      # Returns an array of projects published an user in JSON format.
+      # Returns an array of projects in JSON format.
       def user_projects(user, options={})
         request("users/#{user}/projects", options)["projects"]
       end
@@ -72,13 +72,13 @@ module Behance
       # Public: Get the works-in-progress published by a user.
       #
       # user    - can be an ID (Integer) or username (String).
-      # options - The Hash of options that the API would expect:
+      # options - The Hash with options that the API would expect:
       #           :sort - The order the results are returned in.
-      #                   Possible values: featured_date (default), apprecia-
-      #                   tions, views, comments, published_date.
-      #           :time - Limits the search by time. Possible values: all 
-      #                   (default), today, week, month.
-      #           :page - The page number of the results, always starting 
+      #                   Possible values: featured_date (default),
+      #                   appreciations, views, comments, published_date.
+      #           :time - Limits the search by time.
+      #                   Possible values: all (default), today, week, month.
+      #           :page - The page number of the results, always starting
       #                   with 1.
       #
       # Examples
@@ -87,29 +87,37 @@ module Behance
       #   @client.user_wips(1, page: 2)
       #   @client.user_wips("foo", sort: "comments", page: 3)
       #
-      # Returns an array of work-in-progress of an user in JSON format.
+      # Returns an array of work-in-progress in JSON format.
       def user_wips(user, options={})
         request("users/#{user}/wips", options)["wips"]
       end
 
       # Public: Get a list of user's recently appreciated projects.
       #
-      # user - can be an ID (Integer) or username (String).
+      # user    - can be an ID (Integer) or username (String).
+      # options - The Hash with options that the API would expect:
+      #           :page - The page number of the results, always starting
+      #                   with 1.
       #
       # Examples
       #
       #   @client.user_appreciations(1)
-      #   @client.user_appreciations("foo")
+      #   @client.user_appreciations("foo", page: 2)
       #
       # Returns an array of user's recently appreciated projects in JSON
       # format.
-      def user_appreciations(user)
-        request("users/#{user}/appreciations")["appreciations"]
+      def user_appreciations(user, options={})
+        request("users/#{user}/appreciations", options)["appreciations"]
       end
 
-      # Public: Get a list of user's public collections.
+      # Public: Get a list of a user's collections.
       #
-      # user - can be an ID (Integer) or username (String).
+      # user    - can be an ID (Integer) or username (String).
+      # options - The Hash with options that the API would expect:
+      #           :time - Limits the search by time.
+      #                   Possible values: all (default), today, week, month.
+      #           :page - The page number of the results, always starting
+      #                   with 1.
       #
       # Examples
       #
@@ -118,8 +126,8 @@ module Behance
       #
       # Returns an array of user's public collections in JSON
       # format.
-      def user_collections(user)
-        request("users/#{user}/collections")["collections"]
+      def user_collections(user, options={})
+        request("users/#{user}/collections", options)["collections"]
       end
 
       # Public: Get user's statistics (all-time and today).
@@ -136,7 +144,55 @@ module Behance
         request("users/#{user}/stats")["stats"]
       end
 
-      # Public: A list of the user's professional experience.
+      # Public: Get a list of creatives who follow the user.
+      #
+      # user    - can be an ID (Integer) or username (String).
+      # options - The Hash with options that the API would expect:
+      #           :page       - The page number of the results, always starting
+      #                         with 1.
+      #           :sort       - The order the results are returned in.
+      #                         Possible values: created_date (default),
+      #                         appreciations, views, comments, followed, alpha.
+      #           :sort_order - The direction in which the results are returned.
+      #                         Possible values: asc, desc.
+      #           :per_page   - The number of results per page. (Max: 20)
+      #
+      # Examples
+      #
+      #   @client.user_followers(1)
+      #   @client.user_followers(1, page: 2)
+      #   @client.user_followers("foo", sort: "alpha", page: 3)
+      #
+      # Returns an array of creatives who follow the user in JSON format.
+      def user_followers(user, options={})
+        request("users/#{user}/followers", options)["followers"]
+      end
+
+      # Public: Get a list of creatives followed by the user.
+      #
+      # user    - can be an ID (Integer) or username (String).
+      # options - The Hash with options that the API would expect:
+      #           :page       - The page number of the results, always starting
+      #                         with 1.
+      #           :sort       - The order the results are returned in.
+      #                         Possible values: created_date (default),
+      #                         appreciations, views, comments, followed, alpha.
+      #           :sort_order - The direction in which the results are returned.
+      #                         Possible values: asc, desc.
+      #           :per_page   - The number of results per page. (Max: 20)
+      #
+      # Examples
+      #
+      #   @client.user_following(1)
+      #   @client.user_following(1, page: 2)
+      #   @client.user_following("foo", sort: "alpha", page: 3)
+      #
+      # Returns an array of creatives followed by the user in JSON format.
+      def user_following(user, options={})
+        request("users/#{user}/following", options)["following"]
+      end
+
+      # Public: A list of the user's professional experience
       #
       # user - can be an ID (Integer) or username (String).
       #

data/lib/behance/version.rb

@@ -1,3 +1,3 @@
 module Behance
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/behance/wips.rb

@@ -5,17 +5,14 @@ module Behance
       # Public: Search for works-in-progress.
       #
       # options - The Hash with options that the API would expect:
-      #           :time - Limits the search by time. 
-      #                   Possible values: all (default), today, 
-      #                   week, month.
-      #           :page - The page number of the results, always 
-      #                   starting with 1.
-      #           :sort - The order the results are returned in. 
-      #                   Possible values: comments (default), 
-      #                   views, last_item_added_date.
-      #           :tags - Limits the search by tags. Accepts one 
-      #                   tag name or a pipe-separated list of tag 
-      #                   names.
+      #           :q    - Free text query string.
+      #           :page - The page number of the results, always starting
+      #                   with 1.
+      #           :sort - The order the results are returned in.
+      #                   Possible values: comments (default), views,
+      #                   last_item_added_date.
+      #           :time - Limits the search by time.
+      #                   Possible values: all, today (default), week, month.
       #
       # Examples
       #
@@ -32,7 +29,7 @@ module Behance
       # wip_id - The ID (Integer) of a wip.
       #
       # Examples
-      # 
+      #
       #   @client.wip(69)
       #
       # Returns a wip in JSON format.
@@ -40,13 +37,11 @@ module Behance
         request("wips/#{wip_id}")["wip"]
       end
 
-      # Public: Get information and contents of a revision of a 
+      # Public: Get information and contents of a revision of a
       # work in progress.
       #
-      # wip_id      - The ID (Integer) from the work in progress
-      #               to look for.
-      # revision_id - The ID (Integer) from the revision to look 
-      #               for.
+      # wip_id      - The ID (Integer) from the work in progress to look for.
+      # revision_id - The ID (Integer) from the revision to look for.
       #
       # Examples
       #
@@ -61,17 +56,19 @@ module Behance
       #
       # wip_id      - The ID (Integer) from the work in progress
       #               to look for.
-      # revision_id - The ID (Integer) from the revision to look 
+      # revision_id - The ID (Integer) from the revision to look
       #               for.
+      # options     - The Hash with options that the API would expect:
+      #              :page - The page number of the results, always starting
+      #                      with 1.
       #
       # Examples
       #
       #   @client.wip_revision_comments(69, 133)
       #
-      # Returns a work-in-progress revision comments in JSON
-      # format.
-      def wip_revision_comments(wip_id, revision_id)
-        request("wips/#{wip_id}/#{revision_id}/comments")["comments"]
+      # Returns a work-in-progress revision comments in JSON format.
+      def wip_revision_comments(wip_id, revision_id, options={})
+        request("wips/#{wip_id}/#{revision_id}/comments", options)["comments"]
       end
     end
   end

data/spec/behance/client_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Behance::Client do
 
   before do
-    @client = Behance::Client.new(:access_token => "abc123")
+    @client = Behance::Client.new(access_token: "abc123")
   end
 
   it "initializes properly" do

data/spec/behance/collections_spec.rb

@@ -24,7 +24,7 @@ describe Behance::Client::Collections do
       end
 
       it "gets an collections list" do
-        @collections.size.should == 3
+        @collections.size.should == 10
       end
     end
 
@@ -36,7 +36,7 @@ describe Behance::Client::Collections do
       end
 
       it "gets an collections list" do
-        @collections = @client.collections(@options).size.should == 3
+        @collections = @client.collections(@options).size.should == 10
       end
     end
   end
@@ -54,7 +54,7 @@ describe Behance::Client::Collections do
     end
 
     it "gets a single collection" do
-      @collection["id"].should == "4776629"
+      @collection["id"].should == 9866
     end
   end
 
@@ -72,7 +72,7 @@ describe Behance::Client::Collections do
       end
 
       it "gets a list of projects" do
-        @projects.size.should == 2
+        @projects.size.should == 12
       end
     end
 
@@ -85,7 +85,7 @@ describe Behance::Client::Collections do
 
       it "gets a list of projects" do
         @projects = @client.collection_projects(1, @options).
-          size.should == 2
+          size.should == 12
       end
     end
   end