freelancer 0.1.0

data/lib/freelancer/models/balance.rb

@@ -0,0 +1,22 @@
+module Freelancer
+  module Models
+    class Balance
+
+      include JSONMapper
+
+      # The amount of money in the users account
+      #
+      # Provided from:
+      #   - /Payment/getAccountBalanceStatus.json
+      #   - /Payment/getBalance.json
+      json_attribute :amount, [ :balanceamount, :balance ], Float
+
+      # The last transaction available for the user
+      #
+      # Provided from:
+      #   - /Payment/getAccountBalanceStatus.json
+      json_attribute :last_transaction, "self", Transaction
+
+    end
+  end
+end

data/lib/freelancer/models/bid.rb

@@ -0,0 +1,41 @@
+module Freelancer
+  module Models
+    class Bid
+
+      include JSONMapper
+
+      # The provider that made the bid
+      json_attribute :provider, "self", User
+
+      # The rating of the provider
+      json_attribute :provider_rating, :rating, Float
+
+      # The bid amount
+      json_attribute :amount, :bid_amount, Integer
+
+      # The milestone payment requirements
+      json_attribute :milestone, String
+
+      # If the bid is highlighted
+      json_attribute :highlighted, Boolean
+
+      # The number of days in the bid
+      json_attribute :days, :period, Integer
+
+      # The bid description
+      json_attribute :description, :descr, String
+
+      # The time the bid was placed
+      json_attribute :submitted_at, :submittime, DateTime
+
+      # The number of messages between the seller and bidder on this project
+      json_attribute :total_messages, :total_msg_count, Integer
+
+      # The number of unread messages between the seller and bidder on this project
+      json_attribute :unread_messages, :unread_msg_count, Integer
+
+      def highlighted?; return self.highlighted; end
+
+    end
+  end
+end

data/lib/freelancer/models/config_version.rb

@@ -0,0 +1,21 @@
+module Freelancer
+  module Models
+    class ConfigVersion
+
+      include JSONMapper
+
+      # The function requested
+      #
+      # Provided from:
+      #   - /Common/getConfigVersion.json
+      json_attribute :function, String
+
+      # The version of the requested function
+      #
+      # Provided from:
+      #   - /Common/getConfigVersion.json
+      json_attribute :version, Integer
+
+    end
+  end
+end

data/lib/freelancer/models/eligibility.rb

@@ -0,0 +1,23 @@
+module Freelancer
+  module Models
+    class Eligibility
+
+      include JSONMapper
+
+      # If the user is eligible for the requested action
+      #
+      # Provided from:
+      #   - /Employer/eligibleForTrialProject.json
+      json_attribute :eligible, Boolean
+
+      # The number of bonus point the user has
+      #
+      # Provided from:
+      #   - /Employer/eligibleForTrialProject.json
+      json_attribute :bonus_points, :bonuspoints, Integer
+
+      def eligible?; self.eligible; end
+
+    end
+  end
+end

data/lib/freelancer/models/job.rb

@@ -0,0 +1,33 @@
+module Freelancer
+  module Models
+    class Job
+
+      include JSONMapper
+
+      # The id of the job
+      #
+      # Provided from:
+      #   - /Job/getJobList.json
+      json_attribute :id, Integer
+
+      # The name of the job
+      #
+      # Provided from:
+      #   - /Job/getJobList.json
+      json_attribute :name, String
+
+      # The number of projects available for the job type
+      #
+      # Provided from:
+      #   - /Job/getJobList.json
+      json_attribute :project_count, Integer
+
+      # The SEO URL for the job
+      #
+      # Provided from:
+      #   - /Job/getJobList.json
+      json_attribute :seo_url, String
+
+    end
+  end
+end

data/lib/freelancer/models/job_category.rb

@@ -0,0 +1,18 @@
+module Freelancer
+  module Models
+    class JobCategory
+
+      include JSONMapper
+
+      # The id of the category
+      json_attribute :id, Integer
+
+      # The name of the category
+      json_attribute :name, String
+
+      # The list of jobs associated with the category
+      json_attributes :jobs, :job, Job
+
+    end
+  end
+end

data/lib/freelancer/models/message.rb

@@ -0,0 +1,32 @@
+module Freelancer
+  module Models
+    class Message
+
+      include JSONMapper
+
+      # The id of the message
+      json_attribute :id, Integer
+
+      # Sender or recipient of the message
+      json_attribute :user, "self", User
+
+      # The project id related to the message
+      json_attribute :project_id, :projectid, Integer
+
+      # The date the message was sent
+      json_attribute :sent_at, :datetime, DateTime
+
+      # The message text
+      json_attribute :text, String
+
+      # The url to the attachment
+      json_attribute :attachment_url, :attachmentlink, String
+
+      # If the message has been read
+      json_attribute :new, Boolean
+
+      def new?; return self.new; end
+
+    end
+  end
+end

data/lib/freelancer/models/milestone.rb

@@ -0,0 +1,57 @@
+module Freelancer
+  module Models
+    class Milestone
+
+      include JSONMapper
+
+      # The id of the milestone
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :id, Integer
+
+      # The user id the milestone payment is for
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :user_id, :userid, Integer
+
+      # The username the milestone payment is for
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :username, String
+
+      # The id of the project the milestone payment is for
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :project_id, :projectid, Integer
+
+      # The name of the project the milestone payment is for
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :project_name, :projectname, String
+
+      # The amount of money in the milestone payment
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :amount, Float
+
+      # The description of the milestone payment
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :description, :reason, String
+
+      # The date the milestone was placed
+      #
+      # Provided from:
+      #   - /Payment/getAccountMilestoneList.json
+      json_attribute :made_at, :date, DateTime
+
+    end
+  end
+end

data/lib/freelancer/models/news.rb

@@ -0,0 +1,15 @@
+module Freelancer
+  module Models
+    class News
+
+      include JSONMapper
+
+      # The id of the news entry
+      json_attribute :id, :newsid, Integer
+
+      # The text of the news entry
+      json_attribute :text, :newstext, String
+
+    end
+  end
+end

data/lib/freelancer/models/notification.rb

@@ -0,0 +1,15 @@
+module Freelancer
+  module Models
+    class Notification
+
+      include JSONMapper
+
+      # The description of the notification
+      json_attribute :description, :notificationtext, String
+
+      # The URL to the notification
+      json_attribute :url, String
+
+    end
+  end
+end

data/lib/freelancer/models/notification_status.rb

@@ -0,0 +1,45 @@
+module Freelancer
+  module Models
+    class NotificationStatus
+
+      include JSONMapper
+
+      # The notification format setting
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :notification_format, :notificationformat, String
+
+      # If e-mail notifications have been enabled
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :email, :emailnotificationstatus, Boolean
+
+      # If news notifications have been enabled
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :news, :receivenewsstatus, Boolean
+
+      # If bid won notifications have been enabled
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :bid_won, :bidwonnotificationstatus, Boolean
+
+      # If bid placed notifications have been enabled
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :bid_placed, :bidplacednotificationstatus, Boolean
+
+      # If private message notifications have been enabled
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      json_attribute :new_private_message, :newprivatemessagestatus, Boolean
+
+    end
+  end
+end

data/lib/freelancer/models/project.rb

@@ -0,0 +1,116 @@
+module Freelancer
+  module Models
+    class Project
+
+      include JSONMapper
+      
+      # The ID of the project
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      #   - /Employer/postNewProject.json
+      json_attribute :id, [ :id, :projectid ], Integer
+
+      # The name of the project
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      #   - /Employer/getPostedProjectList.json
+      json_attribute :name, [ :name, :projectname ], String
+
+      # The URL to the project
+      #
+      # Provided from:
+      #   - /Profile/getAccountDetails.json
+      #   - /Employer/postNewProject.json
+      json_attribute :url, [ :url, :projecturl ], String
+
+      # The short description of the project
+      json_attribute :short_description, [ :shortdescr, :short_descr ], String
+
+      # The detailed description of the project
+      json_attribute :additional_description, { :additional_descr => :descr_html }, String
+
+      # The status value of the project
+      #
+      # Provided from:
+      #   - /Freelancer/getProjectListForPlacedBids.json
+      json_attribute :status, [ :status, :state ], String
+
+      # The additional status value of the project
+      #
+      # Provided from:
+      #   - /Freelancer/getProjectListForPlacedBids.json
+      json_attribute :additional_status, :additionalstatus, String
+
+      # The job types associated with the project
+      json_attributes :jobs, :jobtypecsv, DelimitedString, :delimiter => ","
+
+      # The job types associated with this project. This is a workaround
+      # for the /Project/getProjectDetails.json service which returns the
+      # data as an array instead of a comma separated list like the rest of
+      # the services. There's some magic in the jobs method below to select
+      # the proper one.
+      json_attributes :jobs_array, :jobs, String
+
+      # The project options
+      json_attribute :options, ProjectOptions
+
+      # The minimum budget for the project
+      json_attribute :minimum_budget, { :budget => :min }, Integer
+
+      # The maximum budget for the project
+      json_attribute :maximum_budget, { :budget => :max }, Integer
+
+      # The number of bids placed on the project
+      #
+      # Provided from:
+      #   - /Freelancer/getProjectListForPlacedBids.json
+      json_attribute :bids, [ :bidcount, :bids, { :bid_stats => :count } ], Integer
+
+      # The average bid for the project
+      #
+      # Provided from:
+      #   - /Freelancer/getProjectListForPlacedBids.json
+      json_attribute :average_bid, [ :averagebid, { :bid_stats => :avg } ], Integer
+
+      # The date the project was posted
+      #
+      # Provided from:
+      #   - /Employer/postNewProject.json
+      json_attribute :posted_at, :postdatetime, DateTime
+
+      # The date the project starts
+      json_attribute :starts_at, [ :startdate, :start_date ], DateTime
+
+      # The date the project ends
+      #
+      # Provided from:
+      #   - /Freelancer/getProjectListForPlacedBids.json
+      json_attribute :ends_at, [ :enddate, :end_date ], DateTime
+
+      # The time left before the project ends
+      json_attribute :time_left, :timeleft, String
+
+      # The buyer that created the project
+      json_attribute :buyer, User
+
+      # The sellers that have bid on the project
+      json_attributes :sellers, :seller, User
+
+      # The freelancers selected for this project. This is
+      # only available when listing projects where a money
+      # transfer can take place.
+      json_attributes :selected_freelancers, :selectedfreelancer, User
+
+      # Returns the list of jobs associated with the project. This method
+      # selects the "jobs_array" if it exists and has content, otherwise
+      # it returns the "jobs" array
+      def jobs
+        return self.jobs_array unless self.jobs_array.nil? || self.jobs_array.empty?
+        return @jobs
+      end
+
+    end
+  end
+end