freelancer4r 1.0.0

data/CHANGELOG

@@ -0,0 +1,6 @@
+== Freelancer4r 1.0.1 (2010.07.15)
+* Added widget api for call http://www.freelancer.com/affiliate-api.html API
+* First public release
+
+== Freelancer4r 1.0.0 (2010.07.13)
+* First release to Freelancer API

data/LICENSE.txt

@@ -0,0 +1 @@
+Copyright (c) 2010 Janos Haber

data/README.rdoc

@@ -0,0 +1,50 @@
+== Introduction
+Freelancer API for ruby
+
+This api allow to call freelancer api from ruby code.
+
+It's can login to freelancer with "mechanize", using oauth library 
+
+== Installation
+
+gem install freelancer4r
+
+== Usage
+
+* Shortest way, to login
+
+   freelancer=Freelancer.new false,"application_token","application_secret","username","password"
+   projects=freelancer.searchProjects
+
+* Custom one step login
+
+   freelancer=Freelancer.new false
+   freelancer.application_token=token
+   freelancer.application_secret=secret
+   freelancer.username=username
+   freelancer.password=password
+
+   freelancer.login
+   freelancer.searchprojects
+
+* Hand staged login
+   (no username and password)
+
+   freelancer=Freelancer.new false,"application_token","application_secret"
+   freelancer.login_stage1
+   authorize_url=freelancer.login_stage2
+   #.... wait for user login and get the verifier key from user...
+   freelancer.login_stage3
+   freelancer.searchProjects
+
+* Usage for webpages with callback
+   (no username and password)
+
+   freelancer=Freelancer.new false,"application_token","application_secret"
+   freelancer.callback="http://example.com/callbackurl"
+   freelancer.login_stage1
+   authorize_url=freelancer.login_stage2
+   #... redirect user to authorize url ...
+   #... user come back to callback page ...
+   freelancer.login_stage3
+   freelancer.serchProjects

data/Rakefile.rb

@@ -0,0 +1,35 @@
+require 'lib/freelancer'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'generate API documentation to doc/rdocs/index.html'
+
+spec=Gem::Specification.new do |s|
+  s.name = 'freelancer4r'
+  s.version = Freelancer::VERSION
+
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Freelancer API for ruby'
+  s.description = 'Freelancer API for ruby. More informaito about freelancer api see http://developer.freelancer.com'
+
+  s.require_paths = ['lib']
+
+  s.files  = ['README.rdoc', 'Rakefile.rb', 'LICENSE.txt']
+  s.files += ['lib/freelancer.rb'] + Dir['lib/freelancer/**/*.rb']
+
+  s.has_rdoc = true
+  s.rdoc_options = ['--main', 'README.rdoc', '--inline-source']
+  s.extra_rdoc_files = ['README.rdoc','CHANGELOG']
+
+  s.authors = ['Janos Haber']
+  s.email = 'freelancer4r@googlegroups.com'
+  s.homepage = 'http://github.com/b0c1/freelancer4r'
+
+  s.add_dependency(%q<json>, [">= 1.4.0"])
+  s.add_dependency(%q<oauth>, [">= 0.4.1"])
+  s.add_dependency(%q<mechanize>, [">= 1.0.0"])
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end 

data/lib/freelancer.rb

@@ -0,0 +1,75 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'freelancer/core'
+require 'freelancer/authentication'
+require 'freelancer/util'
+require 'freelancer/api'
+require 'freelancer/common'
+require 'freelancer/employer'
+require 'freelancer/freelancer'
+require 'freelancer/job'
+require 'freelancer/message'
+require 'freelancer/notification'
+require 'freelancer/profile'
+require 'freelancer/project'
+require 'freelancer/user'
+require 'freelancer/widget'
+require 'net/http'
+
+#Freelancer for Ruby
+#
+#Load all Freelancer modules
+module Freelancer
+  VERSION = "1.0.0"
+  #Initialize the Freelancer Wrapper Class
+  #
+  #Parameters
+  #
+  #<b>sandbox</b>   true if we are using freelancer sandbox, default: false
+  #<b>username</b>  the username for the automatic authorization, default: nil
+  #<b>password</b>  the password for the automatic authorization, default: nil
+  #<b>application token</b>   the application token from freelancer
+  #<b>application secret</b>   the application secret from freelancer
+  def self.new sandbox=false,application_token=nil,application_secret=nil,username=nil,password=nil
+    freelancer=Freelancer.new
+    freelancer.sandbox=sandbox
+    freelancer.application_token||=application_token
+    freelancer.application_secret||=application_secret
+    freelancer.callback||=OAuth::OUT_OF_BAND
+    freelancer.username||=username
+    freelancer.password||=password
+    if ENV['http_proxy'] != nil
+      freelancer.proxy||=URI.parse(ENV['http_proxy'])
+    end
+    freelancer
+  end
+
+  class Freelancer
+    include Core
+    include Api
+    include Auth
+    include Util
+
+    include Common
+    include Employer
+    include FreelancersCall
+    include Job
+    include Message
+    include Notification
+    include Profile
+    include Project
+    include User
+  end
+
+  def self.new_widget sandbox=false
+    widget=FreelancerWidget.new
+    widget.sandbox=sandbox
+    widget
+  end
+
+  class FreelancerWidget
+    include Core
+    include Util
+    include Widget
+  end
+end

data/lib/freelancer/api.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'net/http'
+require 'cgi'
+
+module Freelancer
+  #= Freelancer API module
+  #== required for using freelancer api calls
+  module Api
+    #Method to call request
+    #
+    #If you not logged in, try to log in.
+    def request path, parameters={}
+      parameters||={}
+      params=parameters.map do |k,v|
+        if v.is_a?(TrueClass) || v.is_a?(FalseClass)
+          v = v ? "1" : "0"
+        end
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+      end.join("&")
+      if @request_token == nil
+        login
+      end
+      if @access_token == nil
+        login_stage3
+      end
+      result=@access_token.post(path,params)
+      JSON.parse(result.body)
+    end
+  end
+end

data/lib/freelancer/authentication.rb

@@ -0,0 +1,104 @@
+require 'oauth'
+require 'uri'
+
+#Freelancer Authentication Module
+#
+#Author::     Janos Haber <boci.boci@gmail.com>
+#Copyright::  Copyright (c) 2010 Javaportal.hu
+#License::
+#
+#The class automatically detect environment http_proxy variable
+#If you need to modify the proxy manual, set the instance.proxy to the proxy
+#example:
+#freelancer_auth.proxy='http://username:password@proxyhost:proxyport'
+module Freelancer
+  module Auth
+
+    attr_accessor :application_token, :application_secret, :callback
+    attr_accessor :username,:password, :verifier, :authorized
+    attr_reader :request_token, :access_token
+    #Login stage one
+    #
+    #Request the token from freelancer
+    def login_stage1
+      @consumer=OAuth::Consumer.new( @application_token, @application_secret, {
+        :site=>api_url,
+        :scheme=>:query_string,
+        :http_method=>:get,
+        :request_token_path=>"/RequestRequestToken/requestRequestToken.json",
+        :access_token_path=>"/RequestAccessToken/requestAccessToken.json",
+        :authorize_url=>"#{web_url}/users/api-token/auth.php",
+        :callback=>@callback,
+        :proxy=>proxy
+      })
+      @request_token=@consumer.get_request_token
+    end
+
+    #Login stage two
+    #
+    #If username and password present and the login_stage1 completed
+    #try to login in freelancer website and authorize the application
+    #And set the oauth verifier number
+    def login_stage2
+      if @request_token == nil
+        login_stage1
+      end
+      if @username != nil && @password != nil && @callback == OAuth::OUT_OF_BAND
+        try_to_authorize
+        login_stage3
+      else
+        @request_token.authorize_url
+      end
+    end
+
+    #Login stage three
+    #
+    #Set the access token require login stage 1 and stage 2 (authorized user)
+    def login_stage3
+      result=@consumer.token_request @consumer.http_method, "/RequestAccessToken/getRequestTokenVerifier.json",@request_token
+      @verifier=result[:verifier]
+      @access_token=@request_token.get_access_token({:oauth_verifier=>@verifier})
+    end
+
+    #One step login method
+    #
+    #If you set the username, password it's try to authorize the request
+    #If the verifier not set (bad username/password or username/password not set)
+    #it's return the authorize url (need manual set the verifier number)
+    def login
+      login_stage1              #login stage 1, request unauthorized token
+      login_stage2              #login stage 2, try to log in ang get the verifier
+      if @authorized            
+        login_stage3            #if we have verifier, we get the access token key
+      else                      #if we not have verifier, authentication or not oob callback selected, request manual login, return the url
+        return @request_token.authorize_url
+      end
+    end
+
+    protected
+
+    #Try to emulate user authorization
+    def try_to_authorize
+      require 'mechanize'
+      @agent ||= Mechanize.new
+      @agent.user_agent_alias='Mac Safari'
+
+      @agent.set_proxy(proxy.host, proxy.port, proxy.user,proxy.password) if proxy != nil
+      page = @agent.get(web_url)
+      login_form=page.form_with(:name=>'login_form')
+      if login_form != nil
+        login_form.field_with(:name=>'username').value=@username
+        login_form.field_with(:name=>'passwd').value=@password
+        @agent.submit(login_form)
+      end
+      initial_page=@agent.get(@request_token.authorize_url)
+      initial_page.forms.each do |form|
+        if form.has_field? 'oauth_token'
+          result=form.submit
+          return
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/freelancer/common.rb

@@ -0,0 +1,120 @@
+module Freelancer
+  module Common
+    #Submit a request to cancel a project
+    #
+    #http://developer.freelancer.com/RequestCancelProject
+    #
+    #<b>Required:</b>
+    #:projectid
+    #:commenttext
+    #:reasoncancellation
+    #         1 - Mutual – Default
+    #         2 - Service Done,Not Paid
+    #         3 - Service Not Done.
+    #         4 - No Communication
+    #         5 - Quality of Service
+    #         6 - Other
+    #
+    #<b>Optional:</b>
+    #:followedguidelinesstatus
+    #         1 - I followed
+    #         0 - I didn't follow
+    #         (This is option is not needed unless felt necessary)
+    def requestCancelProject *args
+      options=fill_args [
+        :projectid,
+        :commenttext,
+        :reasoncancellation,
+        :followedguidelinesstatus
+      ],[
+        :projectid,
+        :commenttext,
+        :reasoncancellation
+      ],*args
+      request "/Common/requestCancelProject.json", options
+    end
+
+    #Post a feedback for a user
+    #
+    #http://developer.freelancer.com/PostFeedback
+    #
+    #<b>Required:</b>
+    #:rating              => 1 to 10
+    #:feedbacktext        => Text of feedback
+    #:userid              => UserId or username the feedback posted to
+    #:username            => UserId or username the feedback posted to
+    #:projectid           => Project Id associated with the feedback
+    def postFeedback *args
+      options=fill_args [
+        :rating,:feedbacktext,:userid,:username,:projectid
+      ],[
+        :rating,:feedbacktext,:projectid
+      ],*args
+
+      if options[:username]==nil && options[:userid]==nil
+        raise "Username or userid is required"
+      end
+      if options[:username]!=nil && options[:userid]!=nil
+        raise "Both username and userid is not allowed"
+      end
+      request "/Common/postFeedback.json", options
+    end
+
+    #Post a comment in reply to a feedback given to you by another user.
+    #
+    #http://developer.freelancer.com/PostReplyForFeedback
+    #
+    #<b>Required:</b>
+    #:feedbacktext    => Text of the feedback
+    #:userid          => UserId or username the reply posted to
+    #:username        => UserId or username the reply posted to
+    #:projectid       => Project Id associated with the feedback
+    def postReplyForFeedback *args
+      options=fill_args [
+        :feedbacktext,:userid,:username,:projectid
+      ],[
+        :feedbacktext,:projectid
+      ],*args
+      if options[:username]==nil && options[:userid]==nil
+        raise "Username or userid is required"
+      end
+      if options[:username]!=nil && options[:userid]!=nil
+        raise "Both username and userid is not allowed"
+      end
+      request "/Common/postReplyForFeedback.json", options
+    end
+
+    #Submit a request to withdraw a feedback posted by another user on a finished project
+    #
+    #http://developer.freelancer.com/RequestWithdrawFeedback
+    #
+    #<b>Required:</b>
+    #:userid          => UserId or username the reply posted to
+    #:username        => UserId or username the reply posted to
+    #:projectid       => Project Id associated with the feedback
+    def requestWithdrawFeedback *args
+      options=fill_args [:userid,:username,:projectid],[:projectid],*args
+      if options[:username]==nil && options[:userid]==nil
+        raise "Username or userid is required"
+      end
+      if options[:username]!=nil && options[:userid]!=nil
+        raise "Both username and userid is not allowed"
+      end
+      request "/Common/requestWithdrawFeedback.json", options
+    end
+
+    #Get the list of projects that can be rated
+    #
+    #http://developer.freelancer.com/GetPendingFeedback
+    #
+    #<b>Optional:</b>
+    #:type
+    #     P - Provider
+    #     B - Buyer,Default
+    def getPendingFeedback *args
+      options=fill_args [:type],[],*args
+      request "/Common/getPendingFeedback.json", options
+    end
+
+  end
+end

data/lib/freelancer/core.rb

@@ -0,0 +1,26 @@
+module Freelancer
+  module Core
+    attr_accessor :sandbox
+
+    public
+    #Get the proxy settings
+    def proxy
+      @proxy
+    end
+
+    #Set the proxy settings, you can use URI or String
+    def proxy=value
+      @proxy=value.is_a?(URI) ? value:URI.parse(value)
+    end
+
+    #return the used web url
+    def web_url
+      @sandbox ? "http://www.sandbox.freelancer.com":"http://www.freelancer.com"
+    end
+
+    #return the used api url
+    def api_url
+      @sandbox ? "http://api.sandbox.freelancer.com":"http://api.freelancer.com"
+    end
+  end
+end