BasecampAPI.php

<?php
/**
 * Project:     New Basecamp PHP API
 * File:        Basecamp.php
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * For questions, help, comments, discussion, etc., please join the
 * Smarty mailing list. Send a blank e-mail to
 * smarty-discussion-subscribe@googlegroups.com 
 *
 * @link http://fedil.ukneeq.com/
 * @copyright 2013 Ukneeq Solutions
 * @author Fedil Grogan <fedil at ukneeq dot com>
 * @package BasecampPHPAPI
 * @version 0.5
 */

  class basecamp
  {
    /** @type string Base url for bcx-api requests. */
    protected $baseurl;
    /** @type string Basecamp company/account ID. */
    protected $id;
    /** @type string Basecamp login username. */
    protected $username;
    /** @type string Basecamp login password. */
    protected $password;
    /** @type string User-Agent to identify Application to Basecamp. */
    protected $useragent;
    /** @type string String to store method errors. */
    public $error;

    /**
     * This method creates a new Basecamp instance.
     *
     * @param int $id An unsigned integer.
     * @param string $username A string that represents the login username;
     * @param string $password A string that represets the login password;
     *
     */
    public function __construct($id, $username, $password, $appName, $email)
    {
      $this->id = $id;
      $this->username = $username;
      $this->password = $password;
      $this->baseurl = "https://basecamp.com/$id/api/v1/";
      $this->useragent = "User-Agent: $appName ($email)";

      $this->error = "";
    }
    /* public methods */

    /**
     * Get all projects from Basecamp.
     *
     * @return array Array of project objects
     */
    public function getProjects()
    {
      $request = $this->baseurl . "projects.json";
      $result = $this->processRequest("GET", $request, array());

      return $result; 
    }

    /**
     * Get all archived projects from Basecamp.
     *
     * @return array Array of project objects
     */
    public function getArchivedProjects()
    {
      $request = $this->baseurl . "projects/archived.json";
      $result = $this->processRequest("GET", $request, array());

      return $result; 
    }

    /**
     * Get specific project from Basecamp.
     *
     * @return object Project object
     */
    public function getProject($projectID)
    {
      $request = $this->baseurl . "projects/$projectID.json";
      $result = $this->processRequest("GET", $request, array());

      return $result; 
    }

    /**
     * Create project in Basecamp.
     *
     * @param string $name A String to store project name
     * @param string $descript A String to store description
     *
     * @return object Project object
     */
    public function createProject($name, $description)
    {
      $params = array("name" => "$name",
                      "description" => "$description");
      $request = $this->baseurl . "projects.json";
      $result = $this->processRequest("POST", $request, stripslashes(json_encode($params)));

      return $result;
    }

    /**
     * Update project in Basecamp.
     *
     * @param int $projectID Unsigned INT to store project id
     * @param string $name A String to store project name
     * @param string $descript A String to store description
     *
     * @return object Project object
     */
    public function updateProject($projectID, $name, $description)
    {
      $params = array();
      if ($name)
      {
        $params["name"] = $name;
      }
      if ($description)
      {
        $params["description"] = $description;
      }

      $request = $this->baseurl . "projects/$projectID.json";
      $result = $this->processRequest("PUT", $request, stripslashes(json_encode($params)));

      return $result;
    }

    /**
     * Archive/Activate project in Basecamp.
     *
     * @param int $projectID Unsigned INT to represent basecamp project id.
     * @param bool $archive A bool value to represent if project should be
     * archived or activated.
     *
     * @return object Project object
     */
    public function archiveProject($projectID, $archive)
    {
      $params = array("archived" => $archive);
      $request = $this->baseurl . "projects/$projectID.json";
      $result = $this->processRequest("PUT", $request, stripslashes(json_encode($params)));

      return $result;
    }

    /* private methods */
    private function processRequest($method, $request, $payload)
    {
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_URL, "$request");
      curl_setopt($ch, CURLOPT_HEADER, true);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
      curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
      curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
      curl_setopt($ch, CURLOPT_USERPWD, "$this->username:$this->password");
      curl_setopt($ch, CURLOPT_USERAGENT, "$this->useragent");

      switch($method)
      {
        case "GET":
          curl_setopt($ch, CURLOPT_HTTPGET, true);
        break;
        default:
          $request_headers = array("Content-Type: application/json; charset=utf-8", "Accept: application/json");
          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
          if (is_array($payload)) $payload = http_build_query($payload);

          curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
          curl_setopt($ch, CURLOPT_HTTPHEADER, $request_headers);
        break;
      }

      $response = curl_exec($ch);
      $errno = curl_errno($ch);
      $error = curl_error($ch);
      curl_close($ch);  
      if ($errno) throw new Exception("cUrl error: $error", $errno);

      list($message_headers, $message_body) = preg_split("/\r\n\r\n|\n\n|\r\r/", $response, 2);
      //print_r($message_body);
      $response_headers = $this->curl_parse_headers($message_headers);
      $statusCode = $response_headers['http_status_code'];
      if ($statusCode >= 400)
      {
        throw new Exception("HTTP Error $statusCode:\n" . print_r(compact('method', 'request', 'request_headers', 'response'), 1));
      }

      return json_decode($message_body);
    }

    private function curl_parse_headers($message_headers)
    {
      $header_lines = preg_split("/\r\n|\n|\r/", $message_headers);
      $headers = array();
      list(, $headers['http_status_code'], $headers['http_status_message']) = explode(' ', trim(array_shift($header_lines)), 3);
      foreach ($header_lines as $header_line)
      {
        list($name, $value) = explode(':', $header_line, 2);
        $name = strtolower($name);
        $headers[$name] = trim($value);
      }

      return $headers;
    }
    
  }
?>