freelancer 0.1.0

data/lib/freelancer/api.rb

@@ -0,0 +1,20 @@
+module Freelancer
+  module API
+    
+    # Returns the list of registered APIs
+    def apis
+      @apis ||= []
+    end
+    
+    # Include the specified API
+    def api(api)
+      
+      extend api::ClassMethods if api.const_defined?(:ClassMethods)
+      include api::InstanceMethods if api.const_defined?(:InstanceMethods)
+      
+      apis << api
+      
+    end
+
+  end
+end

data/lib/freelancer/api/common.rb

@@ -0,0 +1,58 @@
+module Freelancer
+  module API
+    module Common
+      module InstanceMethods
+
+        # Get a list of projects that are pending feedback
+        #
+        # Valid parameters are:
+        #   - type: the type of projects to list ("P" or "B" (default))
+        def pending_feedback(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/getPendingFeedback.json", build_api_params({
+            :type => params[:type]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Get the configuration version of a specific service function
+        #
+        # Valid parameters are:
+        #   - function: the function to look up config version for
+        def config_version(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/getConfigVersion.json", build_api_params({
+            :function => params[:function]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::ConfigVersion.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Returns the current Terms and Conditions from the site
+        def terms
+
+          result = api_get("/Common/getTerms.json")
+          json = JSONMapper::Parser.parse(result)
+
+          if !json.nil? && json.key?(:"json-result")
+            return json[:"json-result"][:terms]
+          end
+          return nil
+          
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/employer.rb

@@ -0,0 +1,56 @@
+module Freelancer
+  module API
+    module Employer
+      module InstanceMethods
+
+        # Retrieve a list of projects posted by a user. By default, this
+        # retrieves the projects posted by the currently authenticated user.
+        #
+        # Valid parameters are:
+        #   - status: the status value to filter projects by (defaults to 2 (open and frozen))
+        #   - user_id: the id of the user to list projects for (defaults to current user)
+        #   - project_id: the project id to filter projects by
+        #   - type: the project type to use ('active', 'trial' and 'draft' - defaults to 'active')
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def posted_projects(*args)
+
+          params = extract_params(args)
+
+          # Use a blank type value if type is set to 'active'
+          params[:type] = nil if params[:type] == "active"
+
+          # Execute the service call
+          result = api_get("/Employer/getPostedProjectList.json", build_api_params({
+            :status => params[:status],
+            :userid => params[:user_id],
+            :projectid => params[:project_id],
+            :projectoption => params[:type],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Check if the current user is eligible to post trial projects
+        def eligible_for_trial_project
+          
+          result = api_get("/Employer/eligibleForTrialProject.json")
+          ::Freelancer::Models::Eligibility.parse(result, :shift => :"json-result")
+
+        end
+
+        # Returns true if the current user is eligible to post trial projects,
+        # false otherwise
+        def eligible_for_trial_project?
+          eligibility = eligible_for_trial_project
+          !eligibility.nil? && eligibility.eligible?
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/freelancer.rb

@@ -0,0 +1,36 @@
+module Freelancer
+  module API
+    module Freelancer
+      module InstanceMethods
+
+        # Get a list of all projects where the specified user have placed a bid.
+        # If no user id is specified, the current user is used.
+        #
+        # Valid parameters are:
+        #   - status: the project status to filter the results by (defaults to 2 - open and frozen)
+        #   - user_id: the id of the user to retrieve projects for
+        #   - project_id: the project id to filter the results by
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def bid_projects(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Freelancer/getProjectListForPlacedBids.json", build_api_params({
+            :status => params[:status],
+            :userid => params[:user_id],
+            :projectid => params[:project_id],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+          
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/job.rb

@@ -0,0 +1,46 @@
+module Freelancer
+  module API
+    module Job
+      module InstanceMethods
+
+        # Retrieve a list of available jobs
+        def jobs
+
+          result = api_get("/Job/getJobList.json")
+          ::Freelancer::Models::Job.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Retrieve a list of available job categories
+        def job_categories
+          
+          result = api_get("/Job/getCategoryJobList.json")
+          ::Freelancer::Models::JobCategory.parse_collection(result, :shift => [ :"json-result", :items, :category ])
+
+        end
+
+        # Retrieve a list of the current users jobs
+        def my_jobs
+          
+          result = api_get("/Job/getMyJobList.json")
+
+          # We need to hack this to make the job id a sub element of the
+          # job node to make the mapping work properly.
+          json_result = JSONMapper::Parser.parse(result)
+          jobs = []
+          unless json_result.nil?
+
+            json_result[:"json-result"][:items][:job].each do |item|
+              jobs << { :id => item }
+            end
+
+          end
+
+          ::Freelancer::Models::Job.parse_json_collection(jobs)
+
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/message.rb

@@ -0,0 +1,89 @@
+module Freelancer
+  module API
+    module Message
+      module InstanceMethods
+
+        # Return the private messages sent to the current user
+        #
+        # Valid parameters are:
+        #   - project_id: the project id to filter messages by
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def messages(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Message/getInboxMessages.json", build_api_params({
+            :projectid => params[:project_id],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Message.parse_collection(result, :shift => [ :"json-result", :items ])
+
+        end
+
+        # Retrieve the messages the current user has sent to other users
+        #
+        # Valid parameters are:
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def sent_messages(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Message/getSentMessages.json", build_api_params({
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Message.parse_collection(result, :shift => [ :"json-result", :items ])
+
+        end
+
+        # Retrieve the number of unread messages the current user has available
+        def unread_message_count
+
+          result = api_get("/Message/getUnreadCount.json")
+          json = JSONMapper::Parser.parse(result)
+
+          if !json.nil? && json.key?(:"json-result")
+            return json[:"json-result"][:unreadcount].to_i
+          end
+          return nil
+
+        end
+
+        # Retrieve the full thread of private messages sent between two users
+        # within a project.
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to load messages for
+        #   - between_user_id: the id of the receiving user to load the thread for
+        #   - count: the number of messages to retrieve (defaults to 50)
+        #   - page: the page number to retrieve (defaults to 0)
+        def message_thread(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Message/loadMessageThread.json", build_api_params({
+            :projectid => params[:project_id],
+            :betweenuserid => params[:between_user_id],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Message.parse_collection(result, :shift => [ :"json-result", :items, :message ])
+          
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/notification.rb

@@ -0,0 +1,25 @@
+module Freelancer
+  module API
+    module Notification
+      module InstanceMethods
+
+        # Get a list of available alerts for the current user
+        def notifications
+
+          result = api_get("/Notification/getNotification.json")
+          ::Freelancer::Models::Notification.parse_collection(result, :shift => [ :"json-result", :items, :notification ])
+          
+        end
+
+        # Return a list of available news items
+        def news
+
+          result = api_get("/Notification/getNews.json")
+          ::Freelancer::Models::News.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+      end
+    end
+  end
+end

data/lib/freelancer/api/payment.rb

@@ -0,0 +1,123 @@
+module Freelancer
+  module API
+    module Payment
+      module InstanceMethods
+
+        # Retrieve the current users balance and the details of the last
+        # transaction.
+        def account_balance
+
+          result = api_get("/Payment/getAccountBalanceStatus.json")
+          ::Freelancer::Models::Balance.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Retrieve a list of transactions for the current user
+        #
+        # Valid parameters are:
+        #   - from: the from date/time to search by
+        #   - to: the to date/time to search by
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def transactions(*args)
+
+          params = extract_params(args)
+
+          # If we have a from or to date, convert it to a string
+          if params.key?(:from) && params[:from].is_a?(Date)
+            params[:from] = params[:from].strftime("%Y-%m-%d %H:%M:%S")
+          end
+          if params.key?(:to) && params[:to].is_a?(Date)
+            params[:to] = params[:to].strftime("%Y-%m-%d %H:%M:%S")
+          end
+
+          # Execute the service call
+          result = api_get("/Payment/getAccountTransactionList.json", build_api_params({
+            :datefrom => params[:from],
+            :dateto => params[:to],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Transaction.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Retrieve a list of milestones for the current user
+        #
+        # Valid parameters are:
+        #   - type: the type of milestone (Incoming (default) or Outgoing)
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def account_milestones(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/getAccountMilestoneList.json", build_api_params({
+            :type => params[:type],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Milestone.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Retrieve a list of withdrawals for the current user
+        #
+        # Valid parameters are:
+        #   - type: the type of withdrawal (Incoming (default) or Outgoing)
+        #   - count: the number of results to return (defaults to 50)
+        #   - page: the page to retrieve (defaults to 0)
+        def account_withdrawals(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Payment/getAccountWithdrawalList.json", build_api_params({
+            :type => params[:type],
+            :count => params[:count],
+            :page => params[:page]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::Withdrawal.parse_collection(result, :shift => [ :"json-result", :items ])
+          
+        end
+
+        # Retrieve the balance for the current user
+        def balance
+
+          result = api_get("/Payment/getBalance.json")
+          json = JSONMapper::Parser.parse(result)
+
+          if !json.nil? && json.key?(:"json-result")
+            return json[:"json-result"][:balance].to_f
+          end
+          return nil
+
+        end
+
+        # Retrieve a list of available withdrawal fees
+        def withdrawal_fees
+
+          result = api_get("/Payment/getWithdrawalFees.json")
+          ::Freelancer::Models::WithdrawalFee.parse_collection(result, :shift => [ :"json-result", :items, :fee ])
+          
+        end
+
+        # Retrieve a list of projects that's available for transfers
+        def projects_for_transfer
+
+          result = api_get("/Payment/getProjectListForTransfer.json")
+          ::Freelancer::Models::Project.parse_collection(result, :shift => [ :"json-result", :items, :project ])
+          
+        end
+
+      end
+    end
+  end
+end