dormouse

<!DOCTYPE html> <html> <head> <title>connection.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="assembler.html"> assembler.coffee </a> <a class="source" href="connection.html"> connection.coffee </a> <a class="source" href="libutils.html"> libutils.coffee </a> <a class="source" href="mixin.html"> mixin.coffee </a> <a class="source" href="projects.html"> projects.coffee </a> <a class="source" href="query.html"> query.coffee </a> <a class="source" href="tasks.html"> tasks.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> connection.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre>path = require 'path' _ = require 'underscore' http = require 'http-browserify' libutils = require './libutils'</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <h3>Connection for us all</h3> Used as a base class that provides simple <code>.get()</code> and <code>.post()</code> access to the relevant http methods Inspiration from Ruby's <code>httparty</code> </td> <td class="code"> <div class="highlight"><pre>class Connection</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Assumption that it is getting JSON @param options serialized in GET params </td> <td class="code"> <div class="highlight"><pre> @get: (get_path, options, callback) -> if typeof options is 'function' callback = options options = {} get_path = libutils.formatUrl path: get_path query: appendAPIKey options req = http.request method: 'GET' host: Connection.host() port: Connection.port() path: get_path , (res) -> handleResponse res, callback req.end() # sends the request</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> @param options appended to URL @param body dumped in POST body </td> <td class="code"> <div class="highlight"><pre> @post: (post_path, options, body, callback) -> post_path = libutils.formatUrl path: post_path query: appendAPIKey options raw_body = JSON.stringify body raw_length = if Buffer? then Buffer.byteLength(raw_body) else raw_body.length req = http.request method: 'POST' host: Connection.host() port: Connection.port() path: post_path headers: 'Content-Type': 'application/json' 'Content-Length': raw_length , (res) -> handleResponse res, callback req.end raw_body</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> @param options appended to URL @param body dumped in body </td> <td class="code"> <div class="highlight"><pre> @put: (put_path, options, body, callback) -> put_path = libutils.formatUrl path: put_path query: appendAPIKey options raw_body = JSON.stringify body raw_length = if Buffer? then Buffer.byteLength(raw_body) else raw_body.length req = http.request method: 'PUT' host: Connection.host() port: Connection.port() path: put_path headers: 'Content-Type': 'application/json' 'Content-Length': raw_length , (res) -> handleResponse res, callback req.end raw_body</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> @param options is optional </td> <td class="code"> <div class="highlight"><pre> @delete: (delete_path, options, callback) -> delete_path = libutils.formatUrl path: delete_path query: appendAPIKey options req = http.request method: 'DELETE' host: Connection.host() port: Connection.port() path: delete_path , (res) -> handleResponse res, callback req.end() host = 'dormou.se' port = 80 @server: (setter) -> if setter matched = setter.match /^((https?):\/\/)?([A-Za-z0-9\.]+)(:(\d+))?\/?$/ if matched host = matched[3] || 'dormou.se' port = matched[5] || 80 else throw new Error 'Improperly formatted url passed to Dormouse.server(...)' "http://#{host}:#{port}/" @host: (setter) -> if setter host = setter host @port: (setter) -> if setter port = setter port api_key = '' @api_key: (setter) -> if setter api_key = setter unless api_key throw new Error 'You cannot make API calls without an api_key. Set it using Dormouse.api_key(...)' api_key</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <h3>Private methods</h3> No one can access these from the outside </td> <td class="code"> <div class="highlight"><pre>appendAPIKey = (options) -> return _.extend options, api_key: Connection.api_key() handleResponse = (res, callback) -> data = '' res.on 'data', (buf) -> data += buf res.on 'end', () -> parseResponse res, data, callback if callback res.on 'error', (err) -> console.log 'HTTP error', res.statusCode, data, err parseResponse = (res, raw_response, callback) -> raw_response = raw_response.trim() if res.statusCode is 200 # STATUS: OK if raw_response try callback null, JSON.parse raw_response catch err console.error 'Response JSON parsing error', err if console else callback null, success: true else console.info 'Request failed', raw_response if console callback new Error(raw_response), null exports.Connection = Connection </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>