behance 0.5.1 → 0.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Yjg4OTVlY2M2ZDU5NzYyMDg0YTRmNDU1ZmMxOTY2MzhkNjQ2NDQzMA==
-  data.tar.gz: !binary |-
-    YWJjY2E2YjY1ZGQ2ODBkYTJiYjNjNWQ5NDM3YTdhMTBiZmRiZDlhNQ==
+SHA1:
+  metadata.gz: 984c4d17b922fb3a353824caf5f37589aef0903d
+  data.tar.gz: 7d2ba3866bb1cb2e8bbc1b874a8bbf3cf7cbe0c3
 SHA512:
-  metadata.gz: !binary |-
-    N2EzNTQ3ZjM3OTQzNzE3YTEwMzA2MWMwMGNlYTI5NTc0NDg5ZmUzZWNlOTFj
-    OWU2NGM1ZjM2YzQxZjc1ZTI0ZmJlZmE2N2Q3MTI5MjQzYTBmZmI5NmY4OWFk
-    ZTU5Yzg3MGZmZjNhZDQzMWQwMGMyZWI4YjUwMTk4MWVjMTM1Nzg=
-  data.tar.gz: !binary |-
-    NzJkYWUwMTA2YTk3ZTVhNzRiY2QwZjlmNDZhOTc1MzIwMGIzYjgyMzg3YWYx
-    YTk4YTQ2YzhjODQ3Nzk5YmIxNTZjZTA0ZDllZWY1NjkxOWQzZjdjNTZmY2Zm
-    N2RlMmFiYWMwY2RjOTM0ZjQyYzA0YjIzOTdmZjc4NTUyNjcwYTE=
+  metadata.gz: 58129857a0e5474dd71860c1fceefd971e6c1eaebc20119666877f2f3db73399df2b022f6339c99d349994277f44f42c4a63f22f06338b5d0f2e1717482f966f
+  data.tar.gz: b4b556c770059adba40cef49d792cb3e333a2201de0398b2ff7dc5c2b15a9acf4cd2f2f41b60e720da4f292be3e00d9b52c9c1220b92b6d554193d22b7a1f52b

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+master
+===
+...
+
+0.6.0
+===
+* Introducing CHANGELOG.md.
+* [Creatives To Follow Endpoint](https://www.behance.net/dev/api/endpoints/9) added.
+* `@client.popular` retrieves all Creative Fields (in 'popular').
+* `@client.user_appreciations`, `@client.user_collections` and `@client.wip_revision_comments` now accepts options hash.
+* `@client.user_followers` and `@client.user_following` added.
+
+0.5.1
+===
+...

data/README.md

@@ -4,161 +4,241 @@ A Ruby wrapper for the Behance API.
 
 More information about the API capabilities can be found [here][api].
 
-[api]: http://www.behance.net/dev
+[api]: https://www.behance.net/dev
 
 ## Installation
 
-    $ gem install behance
+```
+$ gem install behance
+```
 
 ## API Usage Examples
 
 First of all, you will need to get an access token [here][register].
 
-[register]: http://www.behance.net/dev/register
+[register]: https://www.behance.net/dev/register
 
 Once you get it, you'll be able to start playing
 
-    # initializing the client
-    $ client = Behance::Client.new(access_token: "access-token")
+```ruby
+# initializing the client
+client = Behance::Client.new(access_token: "access-token")
+```
 
 ### Projects
 
 [Search for projects][projects]
 
-[projects]: http://www.behance.net/dev/api/endpoints/1#projects-get-10
+[projects]: https://www.behance.net/dev/api/endpoints/1#projects-get-10
 
-    $ client.projects
-    $ client.projects(city: "San Francisco", state: "California", field: "branding")
+```ruby
+client.projects
+client.projects(city: "San Francisco", state: "California", field: "branding")
+```
 
 [Get the information and content of a project][project]
 
-[project]: http://www.behance.net/dev/api/endpoints/1#projects-get-4
+[project]: https://www.behance.net/dev/api/endpoints/1#projects-get-4
 
-    $ client.project(5133725)
+```ruby
+client.project(5133725)
+```
 
 [Get the comments for a project][project_comments]
 
-[project_comments]: http://www.behance.net/dev/api/endpoints/1#projects-get-5
+[project_comments]: https://www.behance.net/dev/api/endpoints/1#projects-get-5
 
-    $ client.project_comments(5133725)
+```ruby
+client.project_comments(5133725)
+```
 
 ### Users
 
-[Search for users][users] 
+[Search for users][users]
 
-[users]: http://www.behance.net/dev/api/endpoints/2#users-get-9
+[users]: https://www.behance.net/dev/api/endpoints/2#users-get-9
 
-    $ client.users
-    $ client.users(state: "California", city: "San Francisco")
+```ruby
+client.users
+client.users(state: "California", city: "San Francisco")
+```
 
-[Get basic information about an user][user]
+[Get basic information about a user][user]
 
-[user]: http://www.behance.net/dev/api/endpoints/2#users-get-1
+[user]: https://www.behance.net/dev/api/endpoints/2#users-get-1
 
-    $ client.user(920309)
-    $ client.user("jonkap1")
+```ruby
+client.user(920309)
+client.user("jonkap1")
+```
 
-[Get the projects published by an user][user_projects]
+[Get the projects published by a user][user_projects]
 
-[user_projects]: http://www.behance.net/dev/api/endpoints/2#users-get-2
+[user_projects]: https://www.behance.net/dev/api/endpoints/2#users-get-2
 
-    $ client.user_projects(920309)
-    $ client.user_projects("jonkap1")
-    $ client.user_projects("jonkap1", page: 2, sort: "views")
+```ruby
+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][user_wips]
+[Get the works-in-progress published by a user][user_wips]
 
-[user_wips]: http://www.behance.net/dev/api/endpoints/2#users-get-3
+[user_wips]: https://www.behance.net/dev/api/endpoints/2#users-get-3
 
-    $ client.user_wips(920309)
-    $ client.user_wips(920309, page: 2)
-    $ client.user_wips("jonkap1", sort: "comments", page: 3)
+```ruby
+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][user_appreciations]
 
-[user_appreciations]: http://www.behance.net/dev/api/endpoints/2#users-get-13
+[user_appreciations]: https://www.behance.net/dev/api/endpoints/2#users-get-13
 
-    $ client.user_appreciations(920309)
-    $ client.user_appreciations("jonkap1")
+```ruby
+client.user_appreciations(920309)
+client.user_appreciations("jonkap1", page: 2)
+```
 
-[Get a list of a user's collections. The user argument can be an ID or username.][user_collections]
+[Get a list of a user's collections][user_collections]
 
-[user_collections]: http://www.behance.net/dev/api/endpoints/2#users-get-21
+[user_collections]: https://www.behance.net/dev/api/endpoints/2#users-get-21
 
-    $ client.user_collections(42)
-    $ client.user_collections(42, page: 2)
-    $ client.user_collections("rur", page: 2)
+```ruby
+client.user_collections(42)
+client.user_collections(42, page: 2)
+client.user_collections("rur", page: 2)
+```
 
-[Get user's statistics (all-time and today).][user_stats]
+[Get user's statistics (all-time and today)][user_stats]
 
 [user_stats]: https://www.behance.net/dev/api/endpoints/2#users-get-55
 
-    $ client.user_stats(42)
-    $ client.user_stats("jonkap1")
+```ruby
+client.user_stats(42)
+client.user_stats("jonkap1")
+```
 
-[A list of the user's professional experience.][user_work_experience]
+[Get a list of creatives who follow the user][user_followers]
+
+[user_followers]: https://www.behance.net/dev/api/endpoints/2#users-get-57
+
+```ruby
+client.user_followers(1)
+client.user_followers("foo", sort: "alpha", page: 2)
+```
+
+[Get a list of creatives followed by the user][user_following]
+
+[user_following]: https://www.behance.net/dev/api/endpoints/2#users-get-59
+
+```ruby
+client.user_following(1)
+client.user_following("foo", sort: "alpha", page: 2)
+```
+
+[A list of the user's professional experience][user_work_experience]
 
 [user_work_experience]: https://www.behance.net/dev/api/endpoints/2#users-get-71
 
-    $ client.user_work_experience(42)
-    $ client.user_work_experience("jonkap1")
+```ruby
+client.user_work_experience(42)
+client.user_work_experience("jonkap1")
+```
 
 ### Works in Progress
 
 [Search for works-in-progress][wips]
 
-[wips]: http://www.behance.net/dev/api/endpoints/3#work-in-progress-get-11
+[wips]: https://www.behance.net/dev/api/endpoints/3#work-in-progress-get-11
 
-    $ client.wips
-    $ client.wips(time: "today", page: 2)
+```ruby
+client.wips
+client.wips(time: "today", page: 2)
+```
 
 [Get information about a work in progress][wip]
 
-[wip]: http://www.behance.net/dev/api/endpoints/3#work-in-progress-get-6
+[wip]: https://www.behance.net/dev/api/endpoints/3#work-in-progress-get-6
 
-    $ client.wip(69)
+```ruby
+client.wip(69)
+```
 
 [Get information and contents of a revision of a work in progress][wip_revision]
 
-[wip_revision]: http://www.behance.net/dev/api/endpoints/3#work-in-progress-get-7
+[wip_revision]: https://www.behance.net/dev/api/endpoints/3#work-in-progress-get-7
 
-    $ client.wip_revision(69, 133)
+```ruby
+client.wip_revision(69, 133)
+```
 
 [Get comments on a revision of a work in progress][wip_revision_comments]
 
-[wip_revision_comments]: http://www.behance.net/dev/api/endpoints/3#work-in-progress-get-8
+[wip_revision_comments]: https://www.behance.net/dev/api/endpoints/3#work-in-progress-get-8
 
-    $ client.wip_revision_comments(69, 133)
+```ruby
+client.wip_revision_comments(69, 133)
+client.wip_revision_comments(69, 133, page: 2)
+```
 
 ### Collections
 
 [Search for collections][collections]
 
-[collections]: http://www.behance.net/dev/api/endpoints/5#collections-get-15
+[collections]: https://www.behance.net/dev/api/endpoints/5#collections-get-15
 
-    $ client.collections
-    $ client.collections(time: "today", page: 2)
+```ruby
+client.collections
+client.collections(time: "today", page: 2)
+```
 
 [Get basic information about a collection][collection]
 
-[collection]: http://www.behance.net/dev/api/endpoints/5#collections-get-17
+[collection]: https://www.behance.net/dev/api/endpoints/5#collections-get-17
 
-    $ client.collection(5074147)
+```ruby
+client.collection(5074147)
+```
 
 [Get projects from a collection][collection_projects]
 
-[collection_projects]: http://www.behance.net/dev/api/endpoints/5#collections-get-19
+[collection_projects]: https://www.behance.net/dev/api/endpoints/5#collections-get-19
 
-    $ client.collection_projects(5074147)
-    $ client.collection_projects(5074147, page: 2)
+```ruby
+client.collection_projects(5074147)
+client.collection_projects(5074147, page: 2)
+```
 
 ### Creative Fields
 
-[Retrieve all Creative Fields][fields]
+[Retrieves all Creative Fields][fields]
 
 [fields]: https://www.behance.net/dev/api/endpoints/11#creative-fields-get-75
 
-    $ client.fields
+```ruby
+client.fields
+```
+
+[Retrieves popular Creative Fields][popular]
+
+[popular]: https://www.behance.net/dev/api/endpoints/11#creative-fields-get-75
+
+```ruby
+client.popular
+```
+
+### Creatives To Follow
+
+[Provides a list of creatives you might be interested in following][creatives_to_follow]
+
+[creatives_to_follow]: https://www.behance.net/dev/api/endpoints/9#creatives-to-follow-get-69
+
+```ruby
+client.creatives_to_follow
+client.creatives_to_follow(page: 2)
+```
 
 ## Contributing
 

data/lib/behance/client.rb

@@ -3,6 +3,7 @@ require File.expand_path('../user', __FILE__)
 require File.expand_path('../wips', __FILE__)
 require File.expand_path('../collections', __FILE__)
 require File.expand_path('../fields', __FILE__)
+require File.expand_path('../creatives_to_follow', __FILE__)
 require 'faraday'
 require 'faraday_middleware'
 
@@ -18,6 +19,7 @@ module Behance
     include Behance::Client::Wips
     include Behance::Client::Collections
     include Behance::Client::Fields
+    include Behance::Client::CreativesToFollow
 
     attr_accessor :access_token, :connection
 
@@ -33,7 +35,7 @@ module Behance
     # Returns a Faraday instance object.
     def initialize(options={})
       @access_token = options[:access_token]
-      @connection = Faraday.new(:url => Behance::Client::API_URL) do |b|
+      @connection = Faraday.new(url: Behance::Client::API_URL) do |b|
         b.adapter Faraday.default_adapter
         b.use     FaradayMiddleware::ParseJson
       end

data/lib/behance/collections.rb

@@ -4,13 +4,15 @@ module Behance
     module Collections
       # Public: Search for collections.
       #
-      # options - The Hash of options that the API would expect:
-      #           :q       - Free text query string.
-      #           :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.
+      # options - The Hash with options that the API would expect:
+      #           :q    - Free text query string.
+      #           :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.
       #
       # Examples
       #
@@ -30,29 +32,35 @@ module Behance
       #
       #   @client.collection(1)
       #
-      # Returns a single user object.
+      # Returns a single collection object.
       def collection(collection)
         request("collections/#{collection}")["collection"]
       end
 
       # Public: Get projects from a collection.
       #
-      # collection      - it has to be an ID (Integer).
-      # options - The Hash of 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.
+      # collection - it has to be an ID (Integer).
+      # 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: featured_date (default),
+      #                          appreciations, views, comments, published_date,
+      #                          followed.
+      #              :per_page - The number of results per page. (Max: 20)
       #
       # Examples
       #
       #   @client.collections_projects(1)
       #   @client.collections_projects(1, page: 2)
       #
-      # Returns an array of projects published an user in JSON format.
+      # Returns an array of projects from a collection in JSON format.
       def collection_projects(collection, options={})
         request("collections/#{collection}/projects", options)["projects"]
       end
     end
   end
-end
+end

data/lib/behance/creatives_to_follow.rb

@@ -0,0 +1,23 @@
+# Creatives To Follow Endpoints.
+module Behance
+  class Client
+    module CreativesToFollow
+      # Public: Provides a list of creatives you might be interested
+      #         in following
+      #
+      # options - The Hash with options that the API would expect:
+      #           :page - The page number of the results, always
+      #                   starting with 1.
+      #
+      # Examples
+      #
+      #   @client.creatives_to_follow
+      #   @client.creatives_to_follow(page: 2)
+      #
+      # Returns an array of creatives in JSON format.
+      def creatives_to_follow(options={})
+        request("creativestofollow", options)["creatives_to_follow"]
+      end
+    end
+  end
+end