freelancer 0.1.0 → 0.1.1

data/.gitignore

@@ -1,3 +1,5 @@
 .document
 Gemfile.lock
 pkg
+rdoc
+coverage

data/Gemfile

@@ -2,10 +2,10 @@ source :rubygems
 
 gem "oauth", ">= 0.4.0"
 gem "htmlentities", ">= 4.2.1"
-gem "json_mapper", ">= 0.2.0"
+gem "json_mapper", ">= 0.2.1"
 
 group :development do
-  gem "jeweler"
+  gem "jeweler", ">= 1.4.0"
   gem "shoulda", ">= 2.10.3"
   gem "mcmire-matchy", ">= 0.5.2"
   gem "mocha", ">= 0.9.8"

data/README.rdoc

@@ -1,6 +1,6 @@
 = Freelancer API
-by Trond Arve Nordheim -
-{Binary Marbles}[http://www.binarymarbles.com/]
+
+Copyright (C) 2010 Trond Arve Nordheim - {Binary Marbles}[http://www.binarymarbles.com/]
 
 == NOTICE
 
@@ -18,25 +18,22 @@ A Ruby gem for working with the new Freelancer.com API.
 * oAuth authentication.
 * Support for all Freelancer.com APIs.
 * Per-environment configuration and sandboxing.
+* Ruby on Rails support (via separate project {freelancer-rails}[http://github.com/tanordheim/freelancer-rails])
 
 == Issues and missing features
 
-* The Profile API is missing support for SetProfileInfo.
-* The Employer API is missing support for PostNewProject, PostNewTrialProject, PostNewDraftProject, ChooseWinnerForProject, InviteUserForProject, UpdateProjectDetails, PublishDraftProject, UpgradeTrialProject and DeleteDraftProject.
-* The Freelancer API is missing support for PlaceBidOnProject, RetractBidFromProject and AcceptBidWon.
-* The Common API is missing support for RequestCancelProject, PostFeedback, PostReplyForFeedback and RequestWithdrawFeedback.
-* The Payment API is missing support for RequestWithdrawal, CreateMilestonePayment, TransferMoney, RequestCancelWithdrawal, CancelMilestone, RequestReleaseMilestone, ReleaseMilestone and PrepareTransfer.
-* The Project API is missing support for PostPublicMessage.
-* The Message API is missing support for SendMessage and MarkMessageAsRead.
+* Multipart fields are not implemented yet.
+* File associations on projects and messages are not implemented yet.
 
-== Usage
+== Documentation
 
-Examples have not been written yet.
+* RDoc: http://rdoc.info/projects/tanordheim/freelancer-ruby
+* Usage: http://wiki.github.com/tanordheim/freelancer-ruby/
 
 == Requirements
 
 * {oauth}[http://rubygems.org/gems/oauth]
-* {json}[http://rubygems.org/gems/json]
+* {json_mapper}[http://rubygems.org/gems/json_mapper]
 * {htmlentities}[http://rubygems.org/gems/htmlentities]
 
 == Installation

data/Rakefile

@@ -1,23 +1,33 @@
 require "rake"
-require "jeweler"
 require "bundler"
 require "rake/testtask"
+require "rake/rdoctask"
 
 # Gemcutter/Jeweler configuration
 # -----------------------------------------------------------------------------
-Jeweler::Tasks.new do |gem|
-
-  gem.name = "freelancer"
-  gem.summary = "Freelancer API"
-  gem.description = "Ruby gem implementation of the Freelancer.com API"
-  gem.email = "tanordheim@gmail.com"
-  gem.homepage = "http://github.com/tanordheim/freelancer"
-  gem.authors = [ "Trond Arve Nordheim" ]
-  
-  gem.add_bundler_dependencies
+begin
+
+  require "jeweler"
+
+  Jeweler::Tasks.new do |gem|
+
+    gem.name = "freelancer"
+    gem.summary = "Freelancer API"
+    gem.description = "Ruby gem implementation of the Freelancer.com API"
+    gem.email = "tanordheim@gmail.com"
+    gem.homepage = "http://github.com/tanordheim/freelancer-ruby"
+    gem.authors = [ "Trond Arve Nordheim" ]
+
+    gem.add_bundler_dependencies
+
+  end
   
+  Jeweler::GemcutterTasks.new
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
-Jeweler::GemcutterTasks.new
+
 
 # Test setup
 # -----------------------------------------------------------------------------
@@ -28,6 +38,39 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
+# RDoc setup
+# ----------------------------------------------------------------------------
+Rake::RDocTask.new do |rdoc|
+  
+  version = File.exists?("VERSION") ? File.read("VERSION") : ""
+
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "freelancer #{version}"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+
+end
+
+# Rcov setup
+# ----------------------------------------------------------------------------
+begin
+
+  require "rcov/rcovtask"
+
+  Rcov::RcovTask.new do |test|
+
+    test.libs << "test"
+    test.pattern = "test/**/*_test.rb"
+    test.verbose = "true"
+
+  end
+
+rescue LoadError
+  task :rcov do
+    abort "Rcov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
 # Task setups
 # -----------------------------------------------------------------------------
 task :test => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/freelancer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{freelancer}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Trond Arve Nordheim"]
-  s.date = %q{2010-08-09}
+  s.date = %q{2010-08-10}
   s.description = %q{Ruby gem implementation of the Freelancer.com API}
   s.email = %q{tanordheim@gmail.com}
   s.extra_rdoc_files = [
@@ -57,6 +57,7 @@ Gem::Specification.new do |s|
      "lib/freelancer/models/project_options.rb",
      "lib/freelancer/models/rating.rb",
      "lib/freelancer/models/review.rb",
+     "lib/freelancer/models/status_confirmation.rb",
      "lib/freelancer/models/transaction.rb",
      "lib/freelancer/models/user.rb",
      "lib/freelancer/models/withdrawal.rb",
@@ -98,6 +99,7 @@ Gem::Specification.new do |s|
      "test/fixtures/employer/update_project_details.xml",
      "test/fixtures/employer/upgrade_trial_project.json",
      "test/fixtures/employer/upgrade_trial_project.xml",
+     "test/fixtures/error.json",
      "test/fixtures/freelancer/accept_bid_won.json",
      "test/fixtures/freelancer/accept_bid_won.xml",
      "test/fixtures/freelancer/get_project_list_for_placed_bids.json",
@@ -183,6 +185,7 @@ Gem::Specification.new do |s|
      "test/fixtures/project/search_projects.json",
      "test/fixtures/project/search_projects.xml",
      "test/fixtures/project/send_message.xml",
+     "test/fixtures/status_confirmation.json",
      "test/fixtures/user/get_user_details.json",
      "test/fixtures/user/get_user_details.xml",
      "test/fixtures/user/get_user_feedback.json",
@@ -222,7 +225,7 @@ Gem::Specification.new do |s|
      "test/freelancer_test.rb",
      "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/tanordheim/freelancer}
+  s.homepage = %q{http://github.com/tanordheim/freelancer-ruby}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
@@ -269,8 +272,8 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<oauth>, [">= 0.4.0"])
       s.add_runtime_dependency(%q<htmlentities>, [">= 4.2.1"])
-      s.add_runtime_dependency(%q<json_mapper>, [">= 0.2.0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<json_mapper>, [">= 0.2.1"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
       s.add_development_dependency(%q<shoulda>, [">= 2.10.3"])
       s.add_development_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
@@ -278,8 +281,8 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<oauth>, [">= 0.4.0"])
       s.add_dependency(%q<htmlentities>, [">= 4.2.1"])
-      s.add_dependency(%q<json_mapper>, [">= 0.2.0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<json_mapper>, [">= 0.2.1"])
+      s.add_dependency(%q<jeweler>, [">= 1.4.0"])
       s.add_dependency(%q<shoulda>, [">= 2.10.3"])
       s.add_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
@@ -288,8 +291,8 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<oauth>, [">= 0.4.0"])
     s.add_dependency(%q<htmlentities>, [">= 4.2.1"])
-    s.add_dependency(%q<json_mapper>, [">= 0.2.0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<json_mapper>, [">= 0.2.1"])
+    s.add_dependency(%q<jeweler>, [">= 1.4.0"])
     s.add_dependency(%q<shoulda>, [">= 2.10.3"])
     s.add_dependency(%q<mcmire-matchy>, [">= 0.5.2"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])

data/lib/freelancer.rb

@@ -5,6 +5,8 @@ require "json_mapper"
 module Freelancer
   
   class FreelancerError < StandardError; end
+  class FreelancerRequestError < FreelancerError; end
+  class FreelancerResponseError < FreelancerError; end
   
   autoload :API, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "api")
   autoload :Client, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "client")
@@ -45,6 +47,7 @@ module Freelancer
     autoload :Bid, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "models", "bid")
     autoload :Message, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "models", "message")
     autoload :ProjectBudget, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "models", "project_budget")
+    autoload :StatusConfirmation, File.join(File.expand_path(File.dirname(__FILE__)), "freelancer", "models", "status_confirmation")
   end
   
 end

data/lib/freelancer/api/common.rb

@@ -52,6 +52,104 @@ module Freelancer
           
         end
 
+        # Request to cancel an awarded project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to cancel
+        #   - selected_winner: the id of the selected winner of the project
+        #   - comment: the comment for the cancellation request
+        #   - reason: the reason for cancelling the project
+        #   - followed_guidelines: if the guidelines for cancelling the project has been followed
+        def request_cancel_project(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/requestCancelProject.json", build_api_params({
+            :projectid => params[:project_id],
+            :selectedwinner => params[:selected_winner],
+            :commenttext => params[:comment],
+            :reasoncancellation => params[:reason],
+            :followedguidelinesstatus => params[:followed_guidelines]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Post feedback for a user
+        #
+        # Valid parameters are:
+        #   - project_id: the project id related to the feedback
+        #   - user_id: the id of the user to rate
+        #   - username: the username of the user to rate
+        #   - comment: the feedback comment
+        #   - rating: the feedback rating
+        def post_feedback(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/postFeedback.json", build_api_params({
+            :projectid => params[:project_id],
+            :userid => params[:user_id],
+            :username => params[:username],
+            :feedbacktext => params[:comment],
+            :rating => params[:rating]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Post reply to a feedback given to you
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project related to the feedback
+        #   - user_id: the id of the user to reply to
+        #   - username: the username of the user to reply to
+        #   - comment: the feedback comment
+        def post_feedback_reply(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/postReplyForFeedback.json", build_api_params({
+            :projectid => params[:project_id],
+            :userid => params[:user_id],
+            :username => params[:username],
+            :feedbacktext => params[:comment]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Request that posted feedback is withdrawn
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project related to feedback
+        #   - user_id: the user id the feedback is posted to
+        #   - username: the username the feedback is posted to
+        def request_withdraw_feedback(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Common/requestWithdrawFeedback.json", build_api_params({
+            :projectid => params[:project_id],
+            :userid => params[:user_id],
+            :username => params[:username]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
       end
     end
   end

data/lib/freelancer/api/employer.rb

@@ -50,6 +50,175 @@ module Freelancer
           !eligibility.nil? && eligibility.eligible?
         end
 
+        # Post a new project
+        def new_project(project)
+
+          params = new_project_params(project)
+
+          # Execute the service call
+          result = api_get("/Employer/postNewProject.json", params)
+
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse(result, :shift => :"json-result")
+
+        end
+
+        # Post a new project draft
+        def new_project_draft(project)
+
+          params = new_project_params(project)
+
+          # Execute the service call
+          result = api_get("/Employer/postNewDraftProject.json", params)
+
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse(result, :shift => :"json-result")
+
+        end
+
+        # Post a new trial project
+        def new_trial_project(project)
+
+          params = new_project_params(project)
+
+          # Execute the service call
+          result = api_get("/Employer/postNewTrialProject.json", params)
+
+          # Parse and return the response
+          ::Freelancer::Models::Project.parse(result, :shift => :"json-result")
+
+        end
+
+        # Update a project
+        def update_project(project)
+
+          params = {}
+          params[:projectid] = project.id
+          params[:projectdesc] = project.short_description
+          params[:jobtypecsv] = project.jobs.join(",")
+
+          # Execute the service call
+          result = api_get("/Employer/updateProjectDetails.json", params)
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+
+        end
+
+        # Upgrade a trial project to a normal project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to ugprade
+        def upgrade_trial_project(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Employer/upgradeTrialProject.json", build_api_params({
+            :projectid => params[:project_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+
+        end
+
+        # Delete a draft project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to delete
+        def delete_draft_project(*args)
+
+          params = extract_params(args)
+
+          # Execute the service call
+          result = api_get("/Employer/deleteDraftProject.json", build_api_params({
+            :projectid => params[:project_id]
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Choose one or more winners for a project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to choose a winner for
+        #   - user_id: a single user id, or an array of user ids, to be made winners of the project
+        def choose_winner_for_project(*args)
+
+          params = extract_params(args)
+
+          # Handle the user id attribute, make sure it's an array and not set to nil to
+          # simplify the handling below.
+          params[:user_id] ||= []
+          params[:user_id] = [ params[:user_id] ] unless params[:user_id].is_a?(Array)
+
+          # Execute the service call
+          result = api_get("/Employer/chooseWinnerForProject.json", build_api_params({
+            :projectid => params[:project_id],
+            :useridcsv => params[:user_id].join(",")
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+          
+        end
+
+        # Invite one or more users to bid on a project
+        #
+        # Valid parameters are:
+        #   - project_id: the id of the project to invite users to
+        #   - user_id: a single user id, or an array of user ids, to invite to the project
+        #   - username: a single username, or an array of usernames, to invite to the project
+        def invite_user_to_project(*args)
+
+          params = extract_params(args)
+
+          # Handle the username and user id attributes, make sure they're an array and not
+          # set to nil to simplify the handling below.
+          params[:user_id] ||= []
+          params[:user_id] = [ params[:user_id] ] unless params[:user_id].is_a?(Array)
+          params[:username] ||= []
+          params[:username] = [ params[:username] ] unless params[:username].is_a?(Array)
+
+          # Execute the service call
+          result = api_get("/Employer/inviteUserForProject.json", build_api_params({
+            :projectid => params[:project_id],
+            :useridcsv => params[:user_id].join(","),
+            :usernamecsv => params[:username].join(",")
+          }))
+
+          # Parse and return the response
+          ::Freelancer::Models::StatusConfirmation.parse(result, :shift => :"json-result")
+
+        end
+
+        private
+
+        def new_project_params(project)
+
+          params = {}
+
+          params[:projectname] = project.name
+          params[:projectdesc] = project.short_description
+          params[:jobtypecsv] = project.jobs.join(",")
+          params[:budgetoption] = project.budget_option
+          if project.budget_option == 0
+            params[:budget] = "#{project.minimum_budget}-#{project.maximum_budget}"
+          end
+          params[:duration] = project.duration
+
+          params[:isfeatured] = 1 if project.options.featured?
+          params[:isnonpublic] = 1 if project.options.non_public?
+          params[:isbidhidden] = 1 if project.options.hidden_bids?
+          params[:isfulltime] = 1 if project.options.full_time?
+
+          params
+
+        end
+
       end
     end
   end