freelancer4r 1.0.0

data/lib/freelancer/employer.rb

@@ -0,0 +1,122 @@
+module Freelancer
+  module Employer
+    #Post a new project.
+    #
+    #http://developer.freelancer.com/PostNewProject
+    #
+    #<b>Required:</b>
+    #:projectType    => The type of tye project (:normal,:trial,:draft)
+    #:projectname    => Project name to post
+    #:projectdesc    => Project description
+    #:jobtypecsv     => Job category associated with project
+    #:budget         => Budget of the project
+    #:duration       => Period of the project
+    #
+    #<b>Optional:</b> (available on :normal and :draft)
+    #:isfeatured     => Set to 1 if post as a featured project.(Default: 0)
+    #:isnonpublic    => Set to 1 if post as a nonpublic project.(Default: 0)
+    #:isbidhidden    => Set to 1 if post as a sealbids project.(Default: 0)
+    def postNewProject *args
+      options=fill_args [
+        :projectType,
+        :projectname,
+        :projectdesc,
+        :jobtypecsv,
+        :budget,
+        :duration,
+        :isfeatured,
+        :isnonpublic,
+        :isbidhidden
+      ],[
+        :projectType,
+        :projectname,
+        :projectdesc,
+        :jobtypecsv,
+        :budget,
+        :duration
+      ],*args
+      type=options.delete(:projectType)
+      case type
+      when :normal
+        request "/Employer/postNewProject.json",options
+      when :draft
+        request "/Employer/postNewDraftProject.json",options
+      when :trial
+        options.delete(:isfeatured)
+        options.delete(:isnonpublic)
+        options.delete(:isbidhidden)
+        request "/Employer/postNewTrialProject.json",options
+      end
+    end
+
+    #Allows a project creator to select a freelancer for their project.
+    #
+    #http://developer.freelancer.com/ChooseWinnerForProject
+    #
+    #<b>Required:</b>
+    #:projectid    => Project identifier
+    #:useridcsv    => Allows multiple winner for ALL except full-time jobs. At-least one ID mandatory
+    def chooseWinnerForProject *args
+      options=fill_args [:projectid,:useridcsv],[:projectid,:useridcsv],*args
+      request "/Employer/chooseWinnerForProject.json", options
+    end
+
+    #Retrieve the list of projects posted by the current user.
+    #
+    #http://developer.freelancer.com/GetPostedProjectList
+    #
+    #<b>Required:</b>
+    #:status
+    #         1 - All
+    #         2 - Open And Frozen – Default
+    #         3 - Frozen Awaiting your action
+    #         4 - Awaiting Bidder Action
+    #         5 - Closed Won
+    #         6 - Closed Lost
+    #         7 - Closed Canceled
+    #
+    #<b>Optional:</b>
+    #:userid     => UserID of the Poster
+    #:projectid  => Project ID filter
+    #:count      => (Default: 50)
+    #:page       => (Default: 0)
+    def getPostedProjectList *args
+      options=fill_args [:status,:userid,:projectid,:count,:page],[:status],*args
+      request "/Employer/getPostedProjectList.json", options
+    end
+
+    #Invite a freelancer to bid on a created project.
+    #
+    #http://developer.freelancer.com/InviteUserForProject
+    #
+    #<b>Required:</b>
+    #:useridcsv         => :useridcsv <b>OR</b> :usernamecsv
+    #:usernamecsv       => Can be CSV also to allow multiple user invite
+    #:projectid         => Project identifier
+    def inviteUserForProject *args
+      options=fill_args [:useridcsv,:usernamecsv,:projectid],[:projectid],*args
+      if options[:useridcsv]==nil && options[:usernamecsv]==nil
+        raise "useridcsv or usernamecsv is required"
+      end
+      if options[:useridcsv]!=nil && options[:usernamecsv]!=nil
+        raise "Both useridcsv and usernamecsv is not allowed"
+      end
+      request "/Employer/inviteUserForProject.json", options
+    end
+  end
+
+  #Update the details for a posted project.
+  #
+  #http://developer.freelancer.com/UpdateProjectDetails
+  #
+  #<b>Required:</b>
+  #:projectid
+  #
+  #<b>Optional:</b>
+  #:projectdesc
+  #:jobtypecsv
+  def updateProjectDetails *args
+    options=fill_args [:projectid,:projectdesc,:jobtypecsv],[:projectid],*args
+    request "/Employer/updateProjectDetails.json", options
+  end
+end

data/lib/freelancer/freelancer.rb

@@ -0,0 +1,82 @@
+module Freelancer
+  module FreelancersCall
+    #Get the list of projects that have been bid by the current user.
+    #
+    #http://developer.freelancer.com/GetProjectListForPlacedBids
+    #
+    #<b>Required:</b>
+    #:status
+    #         1 - All
+    #         2 - Open And Frozen – Default
+    #         3 - Frozen Awaiting your action
+    #         4 - Awaiting Bidder Action
+    #         5 - Closed Won
+    #         6 - Closed Lost
+    #         7 - Closed Canceled
+    #
+    #<b>Optional:</b>
+    #:userid     => UserID of the Poster
+    #:projectid  => Project ID filter
+    #:count      => (Default: 50)
+    #:page       => (Default: 0)
+    def getProjectListForPlacedBids
+      options=fill_args [:status,:userid,:projectid,:count,:page],[:status],*args
+      request "/Freelancer/getProjectListForPlacedBids.json", options
+    end
+
+    #Place bid on project.
+    #
+    #http://developer.freelancer.com/PlaceBidOnProject
+    #
+    #<b>Required:</b>
+    #:amount        => amount
+    #:days          => days
+    #:description   => description
+    #:projectid     => project identifier
+    #
+    #<b>Optional:</b>
+    #:notificationStatus    => Notification on anyone else bid on this project at a lower price. 0 - no notification, 1 - notification (Default: 0)
+    #:highlighted           => Highlight bids. 0 - not highlighted, 1 - highlighted. (Default: 0)
+    #:milestone             => The initial milestone percentage declares the terms of your bid. This tells the employer that you require the specified percentage as a milestone payment before you start work.
+    def placeBidOnProject *args
+      options=fill_args [
+        :amount,
+        :days,
+        :description,
+        :projectid,
+        :notificationStatus,
+        :highlighted,
+        :milestone
+      ],[
+        :amount,
+        :days,
+        :description,
+        :projectid
+      ],*args
+      request "/Freelancer/placeBidOnProject.json", options
+    end
+
+    #Retract a bid that has been placed on a project.
+    #
+    #http://developer.freelancer.com/RetractBidFromProject
+    #
+    #<b>Required:</b>
+    #:projectid     => project identifier
+    def retractBidFromProject *args
+      options=fill_args [:projectid],[:projectid],*args
+      request "/Freelancer/retractBidFromProject.json", options
+    end
+
+    #After a freelancer has been selected for a project, this method should be called to accept the offer.
+    #
+    #http://developer.freelancer.com/AcceptBidWon
+    #
+    #<b>Required:</b>
+    #:projectid     => project identifier
+    #:state         => 0 - decline , 1 - Accept (default)
+    def acceptBidWon *args
+      options=fill_args [:projectid,:state],[:projectid],*args
+      request "/Freelancer/acceptBidWon.json", options
+    end
+  end
+end

data/lib/freelancer/job.rb

@@ -0,0 +1,10 @@
+module Freelancer
+  module Job
+    #Retrieve the list of current job categories. We frequently tune our job categories. As a result, applications are expected to retrieve and update jobs list dynamically.
+    #
+    #http://developer.freelancer.com/GetJobList
+    def getJobList
+      request "/Job/getJobList.json"
+    end
+  end
+end

data/lib/freelancer/message.rb

@@ -0,0 +1,70 @@
+module Freelancer
+  module Message
+    #Retrieve private messages sent to the current user.
+    #
+    #http://developer.freelancer.com/GetInboxMessages
+    #
+    #<b>Optional:</b>
+    #:projectid     => Get the private messages for the specific project
+    #:count
+    #:page
+    def getInboxMessages *args
+      options=fill_args [:projectid,:count,:page],[],*args
+      request "/Message/getInboxMessages.json", options
+    end
+
+    #Retrieve private messages sent by the current user.
+    #
+    #http://developer.freelancer.com/GetSentMessages
+    #
+    #<b>Optional:</b>
+    #:count
+    #:page
+    def getSentMessages *args
+      options=fill_args [:count,:page],[],*args
+      request "/Message/getSentMessages.json", options
+    end
+
+    #Retrieve the number of unread messages received by the current user.
+    #
+    #http://developer.freelancer.com/GetUnreadCount
+    def getUnreadCount
+      request "/Message/getUnreadCount.json"
+    end
+
+    #Send a private message.
+    #
+    #http://developer.freelancer.com/SendMessage
+    #
+    #<b>Required:</b>
+    #:projectid     => Project Id to identify the message send with
+    #:messagetext   => Message text to send
+    #:userid        => Receiver userid or username
+    #:username      => Receiver userid or username
+    def sendMessage *args
+      options=fill_args [
+        :projectid,:messagetext,:userid,:username
+      ],[
+        :projectid,:messagetext
+      ],*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 "/Message/sendMessage.json", options
+    end
+
+    #Mark an income message as read.
+    #
+    #http://developer.freelancer.com/MarkMessageAsRead
+    #
+    #<b>Required:</b>
+    #:id            => Message Id to be marked as read
+    def markMessageAsRead *args
+      options=fill_args [:id],[:id],*args
+      request "/Message/markMessageAsRead.json", options
+    end
+  end
+end

data/lib/freelancer/notification.rb

@@ -0,0 +1,17 @@
+module Freelancer
+  module Notification
+    #Get alert messages for the current user. This information is quite important if exists, applications are advised to show this information as soon as possible if it is available.
+    #
+    #http://developer.freelancer.com/GetNotification
+    def getNotification
+      request "/Notification/getNotification.json"
+    end
+
+    #Get the current news items posted by the Freelancer.com staff. Like the coming events.
+    #
+    #http://developer.freelancer.com/GetNews
+    def getNews
+      request "/Notification/getNews.json"
+    end
+  end
+end

data/lib/freelancer/payment.rb

@@ -0,0 +1,153 @@
+module Freelancer
+  module Payment
+    #Retrieve the current user's balance and the details of the last transaction.
+    #
+    #http://developer.freelancer.com/GetAccountBalanceStatus
+    def getAccountBalanceStatus
+      request "/Payment/getAccountBalanceStatus.json"
+    end
+
+    #Retrieve the list of transactions and details for an account.
+    #
+    #http://developer.freelancer.com/GetAccountTransactionList
+    #
+    #<b>Optional:</b>
+    #:count     => (Default: 50)
+    #:page      => (Default: 0)
+    #:datefrom  => Get transactions from the date
+    #:dateto    => Get transactions up to the date
+    def getAccountTransactionList *args
+      options=fill_args [
+        :count,:page,:datefrom,:dateto
+      ],[],*args
+      request "/Payment/getAccountTransactionList.json", options
+    end
+
+    #Make a request to withdraw funds.
+    #
+    #http://developer.freelancer.com/RequestWithdrawal
+    #
+    #<b>Required:</b>
+    #:amount          => Withdraw amount
+    #:method          => :paypal | :moneybooker | :wire | :paynoneer (default)
+    #:additionaltext  => Required for wire withdraw
+    #:paypalemail     => Required for paypal withdraw
+    #:mb_account      => Required for moneybooker withdraw
+    #:description     => Required for wire withedraw
+    #:country_code    => Required for wire withdraw
+    def requestWithdrawal *args
+      options=fill_args [
+        :amount,
+        :method,
+        :additionaltext,
+        :paypalemail,
+        :mb_account,
+        :description,
+        :country_code
+      ],[
+        :amount,
+        :method,
+        :additionaltext,
+        :paypalemail,
+        :mb_account,
+        :description,
+        :country_code
+      ],*args
+      request "/Payment/requestWithdrawal.json", options
+    end
+
+    #Create a milestone (escrow) payment.
+    #
+    #http://developer.freelancer.com/CreateMilestonePayment
+    #
+    #<b>Required:</b>
+    #:projectid     => Mandatory if Partial or Full payment for a project.
+    #:amount        => Milestone amount
+    #:touserid      => Userid or username create milestone payment to
+    #:tousername    => Userid or username create milestone payment to
+    #:reasontext    => Text attached to transfer
+    #:reasontype    => partial|full|other
+    def createMilestonePayment *args
+      options=fill_args [
+        :projectid,
+        :amount,
+        :touserid,
+        :tousername,
+        :reasontext,
+        :reasontype
+      ],[
+        :projectid,
+        :amount,
+        :reasontext,
+        :reasontype
+      ],*args
+      if options[:touserid]==nil && options[:tousername]==nil
+        raise "touserid or tousername is required"
+      end
+      if options[:touserid]!=nil && options[:tousername]!=nil
+        raise "Both touserid and tousername is not allowed"
+      end
+      request "/Payment/createMilestonePayment.json", options
+    end
+
+    #Cancel milestone
+    #
+    #http://developer.freelancer.com/CancelMilestone
+    #
+    #<b>Required:</b>
+    #:transactionid     => Transaction Id
+    def cancelMilestone *args
+      options=fill_args [:transactionid],[:transactionid],*args
+      request "/Payment/cancelMilestone.json", options
+    end
+
+    #Get the list of incoming and outgoing milestone(escrow) payments.
+    #
+    #http://developer.freelancer.com/GetAccountMilestoneList
+    #
+    #<b>Optional:</b>
+    #:type    => Incoming(default) or Outgoing
+    #:count   => (Default: 50)
+    #:page    => (Default: 0)
+    def getAccountMilestoneList *args
+      options=fill_args [:type,:count,:page],[],*args
+      request "/Payment/getAccountMilestoneList.json", options
+    end
+
+    #View the list of withdrawals that have been requested and are pending.
+    #
+    #http://developer.freelancer.com/GetAccountWithdrawalList
+    #
+    #<b>Optional:</b>
+    #:type    => Incoming(default) or Outgoing
+    #:count   => (Default: 50)
+    #:page    => (Default: 0)
+    def getAccountWithdrawalList *args
+      options=fill_args [:type,:count,:page],[],*args
+      request "/Payment/getAccountMilestoneList.json", options
+    end
+
+    #Send a request to payer for releasing an incoming milestone payment.
+    #
+    #http://developer.freelancer.com/RequestReleaseMilestone
+    #
+    #<b>Required:</b>
+    #:transactionid     => Transaction Id
+    def requestReleaseMilestone *args
+      options=fill_args [:transactionid],[:transactionid],*args
+      request "/Payment/requestReleaseMilestone.json", options
+    end
+
+    #Release a milestone payment.
+    #
+    #http://developer.freelancer.com/ReleaseMilestone
+    #
+    #<b>Required:</b>
+    #:transactionid     => Transaction Id
+    #:fullname          => Fullname of the payer
+    def releaseMilestone *args
+      options=fill_args [:transactionid,:fullname],[:transactionid,:fullname],*args
+      request "/Payment/releaseMilestone.json", options
+    end
+  end
+end