behance 0.0.1 → 0.1.0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Amed Rodriguez
+Copyright (c) 2012-2013 Tractical
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,24 +1,89 @@
-# Behance
+# The Behance Ruby Gem
 
-TODO: Write a gem description
+A Ruby wrapper for the Behance API.
+
+More information about the API capabilities can be found [here][api].
+
+[api]: http://www.behance.net/devi
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install behance
 
-    gem 'behance'
+## API Usage Examples
 
-And then execute:
+First of all, you will need to get an access token [here][register].
 
-    $ bundle
+[register]: http://www.behance.net/dev/register
 
-Or install it yourself as:
+Once you get it, you'll be able to start playing
 
-    $ gem install behance
+    # 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
+
+    $ 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
+
+    $ client.project(5133725)
+
+[Get the comments for a project][project_comments]
+
+[project_comments]: http://www.behance.net/dev/api/endpoints/1#projects-get-5
+
+    $ client.project_comments(5133725)
+
+### Users
+
+[Search for users][users] 
+
+[users]: http://www.behance.net/dev/api/endpoints/2#users-get-9
 
-## Usage
+    $ client.users
+    $ client.users(state: "California", city: "San Francisco")
 
-TODO: Write usage instructions here
+[Get basic information about an user][user]
+
+[user]: http://www.behance.net/dev/api/endpoints/2#users-get-1
+
+    $ client.user(920309)
+    $ client.user("foo")
+
+[Get the projects published by an user][user_projects]
+
+[user_projects]: http://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")
+
+[Get the works-in-progress published by an user][user_wips]
+
+[user_wips]: http://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)
+
+[Get a list of user's recently appreciated projects][user_appreciations]
+
+[user_appreciations]: http://www.behance.net/dev/api/endpoints/2#users-get-13
+
+    $ client.user_appreciations(920309)
+    $ client.user_appreciations("jonkap1")
+
+### Works in Progress
+
+**This is an actual work in progress ;-)**
 
 ## Contributing
 
@@ -27,3 +92,10 @@ TODO: Write usage instructions here
 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][license] for details.
+
+[license]: https://github.com/tractical/behance/blob/master/LICENSE.txt

data/behance.gemspec

@@ -17,6 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'faraday', '~> 0.8.4'
-  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_runtime_dependency     'faraday',            '~> 0.8.4'
+  gem.add_runtime_dependency     'faraday_middleware', '~> 0.8'
+  gem.add_runtime_dependency     'json',               '1.7.5'
+  gem.add_development_dependency 'webmock',            '~> 1.8.10'
+  gem.add_development_dependency 'rspec',              '~> 2.6'
 end

data/lib/behance.rb

@@ -1,5 +1,2 @@
-require "behance/version"
-
-module Behance
-  # Your code goes here...
-end
+require File.expand_path('../behance/version', __FILE__)
+require File.expand_path('../behance/client', __FILE__)

data/lib/behance/client.rb

@@ -0,0 +1,58 @@
+require File.expand_path('../project', __FILE__)
+require File.expand_path('../user', __FILE__)
+require 'faraday'
+require 'faraday_middleware'
+
+# Public: Methods handled by the Client connection.
+module Behance
+
+  class Client
+
+    API_URL = "http://www.behance.net/v2/"
+
+    include Behance::Client::Project
+    include Behance::Client::User
+
+    attr_accessor :access_token, :connection
+
+    # Public: Initialize a client for API requests.
+    #
+    # options - The Hash with options required by Behance:
+    #           :access_token - Behance API token.
+    #
+    # Examples
+    #
+    #   @client = Behance::Client.new(access_token: "aKlie12MCJa5")
+    #
+    # Returns a Faraday instance object.
+    def initialize(options={})
+      @access_token = options[:access_token]
+      @connection = Faraday.new(:url => Behance::Client::API_URL) do |b|
+        b.adapter Faraday.default_adapter
+        b.use     FaradayMiddleware::ParseJson
+      end
+    end
+
+    # Public: Makes a http request to the API.
+    #
+    # path     - A String that represents the endpoint path.
+    # options  - Hash of parameters to pass along.
+    #
+    # Examples
+    #
+    #   request("users/1")
+    #   request("projects", page: 2)
+    #
+    # Returns a response body from the API.
+    def request(path, options={})
+      response = @connection.get do |req|
+        req.url path
+        req.params[:api_key] = @access_token
+        options.each do |key, val|
+          req.params[key] = val
+        end
+      end
+      response.body
+    end
+  end
+end

data/lib/behance/project.rb

@@ -0,0 +1,68 @@
+# Projects Endpoints.
+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.
+      #
+      # Examples
+      # 
+      #   @client.projects
+      #   @client.projects(q: "Freelance", state: "CA", field: "Branding")
+      #
+      # Returns an array of projects in JSON format.
+      def projects(options={})
+        request("projects", options)["projects"]
+      end
+
+      # Public: Get the information and content of a project.
+      #
+      # project_id - the ID (Integer) of the project.
+      #
+      # Examples
+      #
+      #   @client.project(1123)
+      #
+      # Returns a single project in JSON format.
+      def project(project_id)
+        request("projects/#{project_id}")["project"]
+      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.
+      # 
+      # 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"] 
+      end
+    end
+  end
+end

data/lib/behance/user.rb

@@ -0,0 +1,111 @@
+# Users Endpoints.
+module Behance
+  class Client
+    module User
+      # Public: Search for users.
+      #
+      # options - The Hash of 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 
+      #                      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.
+      #           :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 
+      #                      tag names.
+      #
+      # Examples
+      #
+      #   @client.users
+      #   @client.users(q: "Juan", state: "California", :tags "freelance")
+      #
+      # Returns an array of users in JSON format.
+      def users(options={})
+        request("users", options)["users"]
+      end
+
+      # Public: Get basic information about a user.
+      #
+      # user - can be an ID (Integer) or username (String).
+      #
+      # Examples
+      #
+      #   @client.user(1)
+      #   @client.user("foo")
+      #
+      # Returns a single user object.
+      def user(user)
+        request("users/#{user}")["user"]
+      end
+
+      # Public: Get the projects published by an 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. 
+      #                   Possible values: all (default), today, week, month.
+      #           :page - The page number of the results, always starting 
+      #                   with 1.
+      #
+      # Examples
+      #
+      #   @client.user_projects(1)
+      #   @client.user_projects("foo")
+      #   @client.user_projects("foo", page: 2, sort: "views")
+      #
+      # Returns an array of projects published an user in JSON format.
+      def user_projects(user, options={})
+        request("users/#{user}/projects", options)["projects"]
+      end
+
+      # 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:
+      #           :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 
+      #                   with 1.
+      #
+      # Examples
+      #
+      #   @client.user_wips(1)
+      #   @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.
+      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).
+      #
+      # Examples
+      #
+      #   @client.user_appreciations(1)
+      #   @client.user_appreciations("foo")
+      #
+      # Returns an array of user's recently appreciated projects in JSON
+      # format.
+      def user_appreciations(user)
+        request("users/#{user}/appreciations")["appreciations"]
+      end
+    end
+  end
+end

data/lib/behance/version.rb

@@ -1,3 +1,3 @@
 module Behance
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/behance/client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Behance::Client do
+
+  before do
+    @client = Behance::Client.new(:access_token => "abc123")
+  end
+
+  it "initializes properly" do
+    @client.should be_a_kind_of Behance::Client
+  end
+
+end

data/spec/behance/project_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Behance::Client::Project do
+
+  before(:all) do
+    @client = Behance::Client.new(:access_token => "abc123")
+  end
+
+  before do
+    @options = { api_key: @client.access_token }
+  end
+
+  describe "#projects" do
+    context "without parameters" do
+      before do
+        stub_get("projects").with(query: @options).
+          to_return(body: fixture("projects.json"))
+        @projects = @client.projects
+      end
+
+      it "makes a http request" do
+        a_get("projects").
+          with(query: @options).should have_been_made
+      end
+
+      it "gets a list of projects" do
+        @projects.size.should == 7
+      end
+    end
+
+    context "with parameters" do
+      before do
+        @options.merge!(q: "yolo", page: 2)
+        stub_get("projects").with(query: @options).
+          to_return(body: fixture("projects.json"))
+      end
+
+      it "gets a list of projects" do
+        @client.projects(@options).size.should == 7
+      end
+    end
+  end
+
+  describe "#project" do
+    before do
+      stub_get("projects/4889175").with(query: @options).
+        to_return(body: fixture("project.json"))
+      @project = @client.project(4889175)
+    end
+
+    it "makes a http request" do
+      a_get("projects/4889175").
+        with(query: @options).should have_been_made
+    end
+
+    it "gets a single project" do
+      @project["id"].should == 4889175
+    end
+  end
+
+  describe "#project_comments" do
+    before do
+      stub_get("projects/1/comments").with(query: @options).
+        to_return(body: fixture("project_comments.json"))
+      @comments = @client.project_comments(1)
+    end
+
+    it "makes a http request" do
+      a_get("projects/1/comments").
+        with(query: @options).should have_been_made
+    end
+
+    it "gets a list of comments" do
+      @comments.size.should == 9
+    end
+  end
+end