freelancer 0.1.0 → 0.1.1

data/lib/freelancer/api/freelancer.rb

@@ -30,6 +30,91 @@ module Freelancer
           
         end
 
+        # Place a bid on a project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to bid on
+        #   - amount: the amount of money to offer taking the project for
+        #   - description: the bid description
+        #   - days: the estimated number of days to complete the project
+        #   - notify_on_underbid: if notifications should be send when someone bids lower than this bid
+        #   - highlighted: if this bid is highlighted or not
+        #   - milestone: declares the initial milestone percentage for the bid
+        def bid_on_project(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Freelancer/placeBidOnProject.json", build_api_params({
+            :projectid => params[:project_id],
+            :amount => params[:amount],
+            :description => params[:description],
+            :days => params[:days],
+            :notificationStatus => params[:notify_on_underbid],
+            :highlighted => params[:highlighted],
+            :milestone => params[:milestone]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Retract a bid from a project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to withdraw bid from
+        def retract_bid_from_project(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Freelancer/retractBidFromProject.json", build_api_params({
+            :projectid => params[:project_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Accept a won bid
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to accept the offer on
+        def accept_won_bid(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Freelancer/acceptBidWon.json", build_api_params({
+            :projectid => params[:project_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Reject a won bid
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to reject the offer on
+        def reject_won_bid(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Freelancer/acceptBidWon.json", build_api_params({
+            :projectid => params[:project_id],
+            :state => 0
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+          
       end
     end
   end

data/lib/freelancer/api/message.rb

@@ -83,6 +83,48 @@ module Freelancer
           
         end
 
+        # Send a private message to another user
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to send message for
+        #   - text: the text of the message to send
+        #   - user_id: the id of the user to send the message to
+        #   - username: the username of the user to send the message to
+        def send_message(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Message/sendMessage.json", build_api_params({
+            :projectid => params[:project_id],
+            :messagetext => params[:text],
+            :userid => params[:user_id],
+            :username => params[:username]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Mark a message as read
+        #
+        # Valid parameters are:
+        #   - message_id: the id of the message to mark as read
+        def mark_message_as_read(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Message/markMessageAsRead.json", build_api_params({
+            :id => params[:message_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+
+        end
+
       end
     end
   end

data/lib/freelancer/api/payment.rb

@@ -117,6 +117,190 @@ module Freelancer
           
         end
 
+        # Request withdrawal of funds
+        #
+        # Valid parameters are:
+        #   - amount: the amount of money to withdraw
+        #   - method: the withdrawal method (paypal, moneybooker, wire, paynoneer)
+        #   - wire_comment: withdrawal comment for wire transfer
+        #   - paypal_email: paypal account to withdraw to
+        #   - moneybooker_account: moneybooker account to withdraw to
+        #   - description: description for wire transfer withdrawal
+        #   - country_code: country code for wire transfer withdrawal
+        def request_withdrawal(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/requestWithdrawal.json", build_api_params({
+            :amount => params[:amount],
+            :method => params[:method],
+            :additionaltext => params[:wire_comment],
+            :paypalemail => params[:paypal_email],
+            :mb_account => params[:moneybooker_account],
+            :description => params[:description],
+            :country_code => params[:country_code]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Create a new milestone payment
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to create the payment for
+        #   - amount: the amount of money to add to the milestone payment
+        #   - user_id: the id of the user to make out the payment to
+        #   - username: the username of the user to make out the payment to
+        #   - comment: the comment of the payment
+        #   - type: the milestone payment type (partial, full or other)
+        def create_milestone_payment(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/createMilestonePayment.json", build_api_params({
+            :projectid => params[:project_id],
+            :amount => params[:amount],
+            :touserid => params[:user_id],
+            :tousername => params[:username],
+            :reasontext => params[:comment],
+            :reasontype => params[:type]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Transfer money to another user
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to transfer money for
+        #   - amount: the amount of money to transfer
+        #   - user_id: the id of the user to transfer the money to
+        #   - username: the username of the user to transfer the money to
+        #   - comment: the comment of the transfer
+        #   - type: the transfer type (partial, full or other)
+        def transfer_money(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/transferMoney.json", build_api_params({
+            :projectid => params[:project_id],
+            :amount => params[:amount],
+            :touserid => params[:user_id],
+            :tousername => params[:username],
+            :reasontext => params[:comment],
+            :reasontype => params[:type]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Cancel a money withdrawal request
+        #
+        # Valid parameters are:
+        #   - withdrawal_id: the id of the withdrawal to cancel
+        def cancel_withdrawal(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/requestCancelWithdrawal.json", build_api_params({
+            :withdrawalid => params[:withdrawal_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Cancel a milestone payment
+        #
+        # Valid parameters are:
+        #   - transaction_id: the id of the milestone transaction to cancel
+        def cancel_milestone(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/cancelMilestone.json", build_api_params({
+            :transactionid => params[:transaction_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Request to release a milestone payment
+        #
+        # Valid parameters are:
+        #   - transaction_id: the id of the milestone transaction to release
+        def request_release_milestone(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/requestReleaseMilestone.json", build_api_params({
+            :transactionid => params[:transaction_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Release a milestone payment
+        #
+        # Valid parameters are:
+        #   - transaction_id: the id of the milestone transaction to release
+        #   - full_name: the full name of the payer (signature)
+        def release_milestone(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/releaseMilestone.json", build_api_params({
+            :transactionid => params[:transaction_id],
+            :fullname => params[:full_name]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Prepare a transfer to validate it before actually transfering
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to transfer money for
+        #   - amount: the amount of money to transfer
+        #   - user_id: the id of the user to transfer money to
+        #   - type: the type of transfer (partial, full or other)
+        def prepare_transfer(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/prepareTransfer.json", build_api_params({
+            :projectid => params[:project_id],
+            :amount => params[:amount],
+            :touserid => params[:user_id],
+            :reasontype => params[:type]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
       end
     end
   end

data/lib/freelancer/api/profile.rb

@@ -11,6 +11,46 @@ module Freelancer
           
         end
 
+        # Update one or more attributes for the current user. This method takes a
+        # User object, and this should in most cases have been populated by the
+        # account_details method before passed to the update_account_details
+        # method to ensure that no data gets lost.
+        def update_account_details(account)
+
+          # Prepare a map of update parameters
+          params = {}
+          params[:fullname] = account.name
+          params[:company_name] = account.company
+          params[:type_of_work] = account.type_of_work
+          params[:addressline1] = account.address.street_name
+          params[:addressline2] = account.address.street_name_2
+          params[:city] = account.address.city
+          params[:state] = account.address.state
+          params[:country] = account.address.country
+          params[:postalcode] = account.address.postal_code
+          params[:phone] = account.phone_number
+          params[:fax] = account.fax_number
+          params[:notificationformat] = account.notifications.notification_format
+          params[:emailnotificationstatus] = account.notifications.email
+          params[:receivenewsstatus] = account.notifications.news
+          params[:bidwonnotificationstatus] = account.notifications.bid_won
+          params[:bidplacednotificationstatus] = account.notifications.bid_placed
+          params[:newprivatemessagestatus] = account.notifications.new_private_message
+          params[:qualificationcsv] = account.qualifications.join(",")
+          params[:profiletext] = account.profile_text
+          params[:vision] = account.vision
+          params[:keywords] = account.keywords
+          params[:hourlyrate] = account.hourly_rate
+          params[:skills] = account.skills.join("\n")
+
+          # Execute the service call
+          result = api_get("/Profile/setProfileInfo.json", params)
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+
+        end
+
         # Retrieve profile information about a specific user
         #
         # Valid parameters are:

data/lib/freelancer/api/project.rb

@@ -126,6 +126,26 @@ module Freelancer
           
         end
 
+        # Post a public message for a project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to post the message to
+        #   - message: the message to post
+        def post_public_project_message(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Project/postPublicMessage.json", build_api_params({
+            :projectid => params[:project_id],
+            :messagetext => params[:message]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
       end
 
     end

data/lib/freelancer/client.rb

@@ -75,7 +75,7 @@ module Freelancer
       return response.body
     end
     
-    # Execute a GET-requset for the specified API method and return the raw
+    # Execute a GET-request for the specified API method and return the raw
     # result.
     def api_get_raw(method, options = {})
       response = access_token.get(to_uri(method, options))
@@ -83,14 +83,6 @@ module Freelancer
       response.body
     end
     
-    # Execute a POST-request for the specified API method
-    # TODO: Finish this method, it should probably return some JSON decoded
-    # string.
-    def api_post(method, body)
-      response = access_token.post(method, body)
-      response.body
-    end
-
     private
 
     # Extract params from an array of arguments. Copied from ActiveSupport.
@@ -114,11 +106,29 @@ module Freelancer
       
       case response.code.to_i
       when 1..199
-        raise "Response code #{response.code}: #{response}"
+        raise FreelancerRequestError.new("Got response code #{response.code} when executing API request")
       when 201..503
-        raise "Response code: #{response.code}: #{response}"
+        raise FreelancerRequestError.new("Got response code #{response.code} when executing API request")
       end
-      
+
+      # Attempt to convert the response to a JSON data structure
+      json = JSONMapper::Parser.parse(response.body)
+
+      # If we didn't get a proper response, raise an error
+      raise FreelancerResponseError.new("No or invalid response received when executing API request") if json.nil?
+
+      # If the JSON data has an error element as the only element,
+      # assume this request fails
+      if json.keys.size == 1 && json.keys.first == :errors
+
+        error_code = json[:errors][:error][:code]
+        error_message = json[:errors][:error][:msg]
+        error_description = json[:errors][:error][:longmsg]
+
+        raise FreelancerResponseError.new("#{error_message} - #{error_description} (code #{error_code})")
+
+      end
+
     end
     
     # Create a URI from the specified method and options
@@ -128,7 +138,7 @@ module Freelancer
       unless options.nil? || options.empty?
         uri.query = to_query(options)
       end
-      
+
       return uri.to_s
       
     end