freelancer4r 1.0.0

data/lib/freelancer/profile.rb

@@ -0,0 +1,83 @@
+module Freelancer
+  module Profile
+    #Retrieve the the profile information for the current user.
+    #
+    #http://developer.freelancer.com/GetAccountDetails
+    def getAccountDetails
+      request "/Profile/getAccountDetails.json"
+    end
+
+    #Retrieve the the profile information for the particular user.
+    #
+    #http://developer.freelancer.com/GetProfileInfo
+    #
+    #<b>Required:</b>
+    #:userid    => Retrieve the profile information of this user Id.
+    def getProfileInfo *args
+      options=fill_args [:userid],[:userid],*args
+      request "/Profile/getProfileInfo.json",options
+    end
+
+    #Update the account information for the current user.
+    #
+    #http://developer.freelancer.com/SetProfileInfo
+    #
+    #<b>Optional:</b> (minimum one required)
+    #:fullname
+    #:company_name
+    #:type_of_work
+    #:multipartpic
+    #:addressline1
+    #:addressline2
+    #:city
+    #:state
+    #:country
+    #:postalcode
+    #:phone
+    #:fax
+    #:notificationformat
+    #:emailnotificationstatus
+    #:receivenewsstatus
+    #:bidwonnotificationstatus
+    #:bidplacednotificationstatus
+    #:newprivatemessagestatus
+    #:qualificationcsv
+    #:profiletext
+    #:vision
+    #:keywords
+    #:hourlyrate
+    #:skills
+    def setProfileInfo *args
+      options=fill_args [
+        :fullname,
+        :company_name,
+        :type_of_work,
+        :multipartpic,
+        :addressline1,
+        :addressline2,
+        :city,
+        :state,
+        :country,
+        :postalcode,
+        :phone,
+        :fax,
+        :notificationformat,
+        :emailnotificationstatus,
+        :receivenewsstatus,
+        :bidwonnotificationstatus,
+        :bidplacednotificationstatus,
+        :newprivatemessagestatus,
+        :qualificationcsv,
+        :profiletext,
+        :vision,
+        :keywords,
+        :hourlyrate,
+        :skills
+      ],[],*args
+      if options.length==0
+        raise "One property requered to change"
+      end
+      request "/Profile/setProfileInfo.json",options
+    end
+  end
+end

data/lib/freelancer/project.rb

@@ -0,0 +1,97 @@
+module Freelancer
+  module Project
+    #Search Projects
+    #
+    #http://developer.freelancer.com/SearchProjects
+    #
+    #<b>Optional:</b>
+    #:isfeatured        => boolean
+    #:isnonpublic       => boolean
+    #:searchkeyword     => string
+    #:searchjobtypecsv  => coma separated job types [ PHP, .NET ]
+    #:status            => string [ Open | Frozen | Closed| ClosedAwarded| ClosedCanceled ]
+    #:budgetmin         => integer or String [ 250 | 750 |1500 |3000 | Any ]
+    #:budgetmax         => integer
+    #:isfulltime        => boolean
+    #:istrial           => boolean
+    #:isgoldmembersonly => boolean
+    #:bidendsduration   => string [ submitdate (default) | bid_enddate | id | state ]
+    #:count             => number
+    #:page              => number
+    #:tags              => string
+    #:sort              => string
+    def searchProjects *args
+      options=fill_args [
+        :isfeatured,
+        :isnonpublic,
+        :searchkeyword,
+        :searchjobtypecsv,
+        :status,
+        :budgetmin,
+        :budgetmax,
+        :isfulltime,
+        :istrial,
+        :isgoldmembersonly,
+        :bidendsduration,
+        :count,
+        :page,
+        :tags,
+        :sort
+      ],[], *args
+
+      request "/Project/searchProjects.json",options
+    end
+
+    #Get the cost all the project posting options.
+    #
+    #http://developer.freelancer.com/GetProjectFees
+    def getProjectFees
+      request "/Project/getProjectFees.json"
+    end
+
+    #Retrieve the details for a particular project
+    #
+    #http://developer.freelancer.com/GetProjectDetails
+    #
+    #<b>Required:</b>
+    #:projectid   => project id
+    def getProjectDetails *args
+      options = fill_args [:projectid],[:projectid],*args
+      request "/Project/getProjectDetails.json", options
+    end
+
+    #Get All bids details to the selected project
+    #
+    #http://developer.freelancer.com/GetBidsDetails
+    #
+    #<b>Required:</b>
+    #:projectid   => project id
+    def getBidsDetails *args
+      options = fill_args [:projectid],[:projectid],*args
+      request "/Project/getBidsDetails.json",options
+    end
+
+    #Retrieve the public messages posted to a project clarification board.
+    #
+    #http://developer.freelancer.com/GetPublicMessages
+    #
+    #<b>Required:</b>
+    #:projectid   => project id
+    def getPublicMessages *args
+      options = fill_args [:projectid],[:projectid],*args
+      request "/Project/getPublicMessages.json",options
+    end
+
+    #Post a public message to project clarification board.
+    #
+    #http://developer.freelancer.com/PostPublicMessage
+    #
+    #<b>Required:</b>
+    #:projectid   => Project Id associated with the message
+    #:messagetext => message text
+    def postPublicMessage *args
+      options = fill_args [:projectid,:messagetext],[:projectid,:messagetext],*args
+      request "/Project/postPublicMessage.json",options
+    end
+  end
+end

data/lib/freelancer/user.rb

@@ -0,0 +1,65 @@
+module Freelancer
+  module User
+    #Search for users using various search criteria.
+    #
+    #http://developer.freelancer.com/GetUsersBySearch
+    #
+    #<b>Optional:</b>
+    #:username        => Username of the person for who you are searching.
+    #:expertise_csv   => Comma separated list of job categories, refer to the main page for a list of categories.
+    #:country_csv     => Comma separated list of countries
+    #:rating          => Minimum rating for the user
+    #:count           => (default: 50)
+    #:page            => (default: 0)
+    def getUsersBySearch *args
+      options=fill_args [
+        :username,
+        :expertise_csv,
+        :country_csv,
+        :rating,
+        :count,
+        :page
+      ],[], *args
+      request "/User/getUsersBySearch.json",options
+    end
+
+    #Get feedback received by a particular user.
+    #
+    #http://developer.freelancer.com/GetUserFeedback
+    #
+    #<b>Required:</b>
+    #:username         => Username or userid is required
+    #:userid           => Username or userid is required
+    #
+    #<b>Optional:</b>
+    #:type             => [P = Provider Only, B = Buyer Only, A = Default, All]
+    def getUsersFeedback *args
+      options=fill_args [:username,:userid,:type],[],*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 "/User/getUserFeedback.json",options
+    end
+
+    #Get the profile information for a particular user.
+    #
+    #http://developer.freelancer.com/GetUserDetails
+    #
+    #<b>Required:</b>
+    #:username         => Username or userid is required
+    #:userid           => Username or userid is required
+    def getUserDetails *args
+      options=fill_args [:username,:userid],[],*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 "/User/getUserDetails.json",options
+    end
+  end
+end

data/lib/freelancer/util.rb

@@ -0,0 +1,35 @@
+module Freelancer
+  module Util
+    #Convert array parameters to hash, using field list
+    #
+    #def mymethod *args
+    #   options = fill_args [:param1,:param2,:param3],[:param1], *args
+    #....
+    #
+    #mymethod 1,2,3                 => {:param1=>1,:param2=>2,param3=>3}
+    #mymethod                       => exception, Required key not found
+    #mymethod 1,"x"                 => {:param1=>1,:param2=>"x"}
+    #mymethod :param1=>"y"          => {:param1=>"y"}
+    #mymethod :param1=>1,:param2=>2 => {:param1=>1,:param2=>2}
+    #
+    #fields   Required,the field list
+    #require  Required,the required field list (maybe empty array)
+    #arguments
+    def fill_args fields,required, *arguments
+      options={}
+      arguments.each_index do |index|
+        if arguments[index].is_a? Hash
+          options.merge! arguments[index]
+        else
+          options[fields[index]]=arguments[index]
+        end
+      end
+      required.each do |needed|
+        if !options.key? needed
+          raise "Required key not found"
+        end
+      end
+      return options
+    end
+  end
+end

data/lib/freelancer/widget.rb

@@ -0,0 +1,176 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+module Freelancer
+  module Widget
+    def request_widget path, parameters={}
+      params=parameters.map do |k,v|
+        if v.is_a?(TrueClass) || v.is_a?(FalseClass)
+          v = v ? "1" : "0"
+        end
+        if v.is_a?(Array)
+          v.map do |item|
+            "#{CGI.escape(k.to_s)}[]=#{CGI.escape(item.to_s)}"
+          end.join("&")
+        else
+          puts v
+          "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+        end
+      end.join("&")
+      url=api_url+path
+      url+="?#{params}" if params.length > 0
+      uri=URI.parse(url)
+      puts uri
+      #      response=Net::HTTP.get_response(uri)
+      #    puts response.body
+    end
+
+    #= Search projects
+    #
+    #http://www.freelancer.com/affiliate-api.html#ProjectSearch
+    #
+    #== Optional
+    #:keyword
+    #   Search keyword
+    #:owner
+    #   Username of ID of project owner
+    #:winner
+    #   Username of ID of project winner
+    #:jobs[]
+    #   Names of job categories from the available list on Freelancer.com (PHP, .NET, AJAX, etc.). This parameter may be repeated more than once
+    #:featured
+    #   If 1 - only featured projects, if 0 - only NON-featured projects
+    #:trial
+    #   If 1 - only trial projects, if 0 - only NON-trial projects
+    #:for_gold_members
+    #   If 1 - only "For gold members" projects, if 0 - only NON "For gold members" projects
+    #:nonpublic
+    #   If 1 - only nonpublic projects, if 0 - only public projects
+    #:min_budget
+    #   Only projects with budget higher or equal to min_budget
+    #:max_budget
+    #   Only projects with budget lower or equal to max_budget
+    #:bidding_ends
+    #   Only projects ending sooner than bidding_ends days
+    #:order
+    #   How to order projects in the result output. See available project order criteria.
+    #   types:
+    #       :id - order by project ID
+    #       :submitdate - order by date when project was added (default)
+    #       :state - order by state of project. Active/open projects will be listed first, next - frozen and then closed.
+    #       :bid_count - order by number of bids
+    #       :bid_avg - order by average bid
+    #       :bid_enddate - order by bidding end time
+    #       :buyer - order by buyer's username
+    #       :budget - order by budget
+    #       :relevance - order by relevance of search by keyword. This criterion should be used with the parameter keyword
+    #       :rand - order randomly
+    #:order_dir
+    #   Direction of sorting. If the parameter is equal to asc, results are ordered in ascending way, otherwise - descending (desc).
+    #:pg
+    #   Page number. Starts from 0. Default page is 0
+    #:count
+    #   Number of items on a page
+    #:apikey
+    #   API key, paramater is optional.
+    def search *args
+      options=fill_args [
+        :keyword,
+        :owner,
+        :winner,
+        :jobs,
+        :featured,
+        :trial,
+        :for_gold_members,
+        :nonpublic,
+        :min_budget,
+        :max_budget,
+        :bidding_ends,
+        :order,
+        :order_dir,
+        :pg,
+        :count,
+        :apikey
+      ],[],*args
+
+      request_widget("/Project/Search.json",options)
+    end
+
+    #= Get the project details
+    #
+    #http://www.freelancer.com/affiliate-api.html#ProjectProperties
+    #
+    #== Required
+    #:id
+    #   the project id
+    #
+    #== Optional
+    #:apikey
+    #   API key, paramater is optional.
+    def projectDetails *args
+      options=fill_args [:id,:apikey],[:id],*args
+      request_widget("/Project/Properties.json",options)
+    end
+
+    #Get the project details
+    #
+    #http://www.freelancer.com/affiliate-api.html#UserProperties
+    #
+    #== Required
+    #:id
+    #   the user id
+    #
+    #== Optional
+    #:apikey
+    #   API key
+    def userDetails *args
+      options=fill_args [:id,:apikey],[:id],*args
+      request_widget("/User/Properties.json",options)
+    end
+
+    #= Feedback search
+    #
+    #http://www.freelancer.com/affiliate-api.html#FeedbackSearch
+    #
+    #== Required
+    #:user
+    #   ID or username of a feedback receiver
+    #
+    #== Optional
+    #:project_id
+    #   ID of project for which the feedback was made
+    #:type
+    #   Type of the feedback. S - service provider's (seller's) feedbacks, B - buyer's feedbacks. By default provider's feedbacks are returned
+    #:positive
+    #   if positive equals to 1, only feedbacks with rating higher than average will be returned
+    #:order
+    #   How to order feedbacks in result output.  Types:
+    #       :active_date - order by date when feedback was activated (default)
+    #       :rand - order randomly
+    #
+    #:order_dir
+    #   Direction of sorting. If the parameter is equal to asc, results are ordered in ascending way, otherwise - descending ('desc').
+    #:pg
+    #   Page number. Starts from 0. Default page is 0
+    #:count
+    #   Number of items on a page
+    #:apikey
+    #   API key
+    def feedbackSearch
+      options=fill_args [
+        :user,
+        :project_id,
+        :type,
+        :positive,
+        :order,
+        :order_dir,
+        :pg,
+        :count,
+        :apikey
+      ],[:user],*args
+
+      request_widget("/Feedback/Search.json",options)
+    end
+  end
+end