# Racks.coffee - A javascript SDK for the Rackspace Cloud - https://github.com/erulabs/racksjs # by Seandon Mooy "use strict" module.exports = class RacksJS constructor: (@authObj, callback) -> @https_node = require 'https' @url = require 'url' @fs = require 'fs' @path = require 'path' # Defaults @authToken = no @products = {} unless @authObj? then @authObj = {} # Default verbosity unless @authObj.verbosity? @verbosity = 0 else @verbosity = @authObj.verbosity # Default endpoint (Rackspace v2.0 api) unless @authObj.endpoint? @authObj.endpoint = 'https://identity.api.rackspacecloud.com/v2.0' # If we're using the LON endpoint, set the datacenter there automatically if @authObj.endpoint is 'https://lon.identity.api.rackspacecloud.com/v2.0' @datacenter = 'LON' # Test mode if !@authObj.test? then @test = no else @test = @authObj.test unless @authObj.network? @network = 'public' else @network = @authObj.network # Fix a common mistake - the networks are 'public' and 'internal'... if @network in [ 'private', 'servicenet' ] then @network = 'internal' if @network not in [ 'public', 'internal' ] @network = 'public' # Colors for console output: @clr = { red: "\u001b[31m", blue: "\u001b[34m", green: "\u001b[32m", cyan: "\u001b[36m", gray: "\u001b[1;30m", reset: "\u001b[0m" } # HTTP human readable codes from Rackspace API docs @httpCodes = '200': 'OK' '202': 'Accepted' '204': 'No Content' '400': 'Compute Fault / Bad Request' '401': 'Unauthorized' '403': 'Forbidden' '404': 'Not found' '413': 'Over API limits' '415': 'Bad Media Type' '503': 'Service Unavailable' # Build the service catalog @buildProducts() # Authenticate if @authObj.username? and @authObj.apiKey? and callback? then @authenticate @authObj, callback log: () -> if @verbosity is 0 then return false date = new Date() process.stdout.write(date.getMonth() + '/' + date.getDate() + ' ' + date.toTimeString().split(' ')[0] + ' ') console.log.apply(@, arguments) logerror: (message) -> if @verbosity is 0 then return false @log @clr.red + '---> Error' + @clr.reset + ':' console.log.apply(@, arguments) return false https: (opts, callback) -> if !opts.headers? then opts.headers = {} # Save the plaintext option, but don't pass it along to HTTPS plaintext = opts.plaintext delete opts.plaintext # Send along auth token if we have one if @authToken then opts.headers['X-Auth-Token'] = @authToken # Always use JSON if !opts.headers['Content-Type']? opts.headers['Content-Type'] = 'application/json' # If we have data, JSON.stringify if needed and calc length if opts.data? if typeof opts.data is 'object' try opts.data = JSON.stringify(opts.data) catch e then console.log e opts.headers['Content-Length'] = opts.data.length # Parse the passed URL for easy use with Node's HTTPS, but don't pass along the unneeded full URL opts.url = @url.parse opts.url opts.host = opts.url.host opts.path = opts.url.path delete opts.url # Logging if @verbosity is 1 @log @clr.cyan + opts.method + @clr.reset + ':', opts.path else if @verbosity > 1 @log @clr.cyan + 'Request' + @clr.reset + ':', opts # Make the HTTP request if @test # If we're testing, callback with a mock response instead. @mockApi(opts, callback) else # Place the request request = @https_node.request opts, (response) => rawReply = '' response.setEncoding 'utf8' # Collect data response.on 'data', (responseChunk) -> rawReply = rawReply + responseChunk # Response end response.on 'end', () => # Parse reply if plaintext if rawReply.length is 0 reply = [] else reply = rawReply.substr(0, rawReply.length - 1).split "\n" else try reply = JSON.parse rawReply catch error then reply = rawReply # Log and callback if @verbosity > 0 and @verbosity < 4 @log @clr.green + 'Reply' + @clr.reset + ':', response.statusCode, @httpCodes[response.statusCode] else if @verbosity > 3 @log @clr.green + 'Reply' + @clr.reset + ':', response.statusCode, @httpCodes[response.statusCode] @log '--->', @clr.cyan + 'Headers' + @clr.reset + ":\n", response.headers @log '--->', @clr.cyan + 'Body' + @clr.reset + ":\n", reply if callback? if typeof reply is 'string' if reply.length is 0 reply = false callback reply, response response.on 'error', (error) => @log error, opts # Write data down the pipe (in the case of POST and PUTs, etc) if opts.data? then request.write opts.data request.end() get: (url, callback) -> @https { method: 'GET', url: url }, callback post: (url, data, headers, callback) -> realCallback = callback if typeof headers is 'function' and !callback? realCallback = headers @https { headers: headers, method: 'POST', url: url, data: data }, realCallback delete: (url, data, callback) -> unless data? data = {} if typeof data is 'function' callback = data data = {} unless callback? callback = () -> return false @https { method: 'DELETE', url: url, data: data }, callback put: (url, data, callback) -> @https { method: 'PUT', url: url, data: data }, callback authenticate: (authObj, callback) -> if !authObj.username? or !authObj.apiKey? then return callback { error: 'No username or apiKey provided to .authenticate()' } @post authObj.endpoint + '/tokens', { 'auth': 'RAX-KSKEY:apiKeyCredentials': 'username': authObj.username 'apiKey': authObj.apiKey }, (response) => if response.access? @authToken = response.access.token.id @access = response.access @error = false @serviceCatalog = response.access.serviceCatalog @buildCatalog @serviceCatalog else @log 'Auth failed', response @error = 'Auth failed' callback @ # buildModel - wraps each item in typical API response arrays. In other words, for a list of servers, each server (which is a {}), # gets appended with a bunch of functionality (whatever is in its .model()), some metadata which is nice for scripting # and most importantly, a target function buildModel: (template, raw) -> rack = @ if template.model? then model = template.model raw else return raw model._racksmeta = resource: template._racksmeta.name product: template._racksmeta.product target: () -> target = template._racksmeta.target() idOrName = '' if target.substr(-1) is '/' then target = target.substr(0, target.length - 1) if model.id? idOrName = model.id else if model.name? idOrName = model.name return target + '/' + idOrName return model resourceRequest: (resource, callback) -> @https { url: resource._racksmeta.target() plaintext: resource._racksmeta.plaintext method: 'GET' }, (reply, rawResponse) => metaName = resource._racksmeta.name if resource._racksmeta.replyString? then metaName = resource._racksmeta.replyString # Most good API resources reply this way: ie: get /servers (what we call servers.all()) # respond with { servers: [ {}, {}, {} ... ] } # which is exactly what we want - all we do is strip the outer { servers: } object # and pass the array that was requested if reply[metaName]? if resource.model # If we got back an array, loop thru the reply objects and "buildProduct" if reply[metaName].push? response = [] reply[metaName].forEach (raw) => response.push @buildModel resource, raw if callback? then callback response, rawResponse else if callback? then callback @buildModel resource, reply[metaName] else if callback? then callback reply[metaName] else if resource._racksmeta.plaintext? response = [] reply.forEach (raw) => response.push @buildModel resource, raw if callback? then callback response, rawResponse else if callback? callback reply, rawResponse subResource: (resource, id, subResource) -> @buildResource resource._racksmeta.product, resource._racksmeta.name + '/' + subResource, { _racksmeta: resourceString: subResource, name: subResource, singular: subResource, target: () -> return resource._racksmeta.target() + '/' + id + '/' + subResource } buildResource: (productName, resourceName, subResource) -> if subResource? then resource = subResource else resource = @[productName][resourceName] if !resource._racksmeta? then resource._racksmeta = {} if !resource._racksmeta.name? then resource._racksmeta.name = resourceName if !resource._racksmeta.singular? if resource._racksmeta.name.substr(-1) is 's' resource._racksmeta.singular = resource._racksmeta.name.substr(0, resource._racksmeta.name.length - 1) else resource._racksmeta.singular = resource._racksmeta.name resource._racksmeta.product = productName rack = @ if !resource._racksmeta.target? then resource._racksmeta.target = () -> if resource._racksmeta.resourceString? then resourcePath = resource._racksmeta.resourceString else resourcePath = @name return rack[productName]._racksmeta.target() + resourcePath unless resource._racksmeta.noResource resource.all = (callback) => @resourceRequest resource, callback resource.assume = (obj) => if typeof obj is 'string' obj = { id: obj } if !obj.id? and !obj.name? @log '[INFO] .assume() relies on .target() which in turn requires the object ' @log 'argument to have a .id or .name - please define one or the other - ' @log 'alternatively you can pass a string, in which case skinny will assume youre providing an id' @buildModel(resource, obj) if resource.new? resource.new = resource.new(rack) else resource.new = (obj, callback) -> data = {} # This is a bug with CloudMonitoring - post requests are NOT wrapped with the resource object title if resource._racksmeta.dontWrap? data = obj else data[resource._racksmeta.singular] = obj if resource._racksmeta.replyString? replyString = resource._racksmeta.replyString else replyString = resource._racksmeta.name rack.post resource._racksmeta.target(), data, (reply) -> if reply[replyString]? obj = reply[replyString] else if reply[resource._racksmeta.singular]? obj = reply[resource._racksmeta.singular] else if callback? return callback(reply) if callback? callback(rack.buildModel(resource, obj)) return resource buildCatalog: (serviceCatalog) -> rack = @ serviceCatalog.forEach (product) => if !product.name? then return false if @[product.name]? @[product.name]._racksmeta = { endpoints: product.endpoints target: () -> target = false if rack.datacenter? then dc = rack.datacenter else dc = rack.access.user['RAX-AUTH:defaultRegion'] if @endpoints.length > 1 # Based on the rack.network and chosen datacenter, target() searches the available endpoints @endpoints.forEach (endpoint) -> if endpoint.region is dc then target = endpoint[rack.network.toLowerCase() + 'URL'] #console.log 'rack.network is', rack.network #console.log 'and the result is:', target, 'available endpoints are', @endpoints else target = @endpoints[0] if typeof target is 'object' target = target[rack.network.toLowerCase() + 'URL'] if rack.test target = 'https://MOCKAPI' if !target rack.logerror 'No target was found with endpoint "' + rack.authObj.endpoint + '" and datacenter "' + rack.datacenter + '"' else if target.substr(-1) isnt '/' then target = target + '/' return target } # Build out .products, which isolates the product catalog for tools like RacksUI - ie: # make it friendlier to code against, less friendly to script against. # RacksJS.products is, after an authentication, a kind of suped serviceCatalog - or rather, the full formal name # ie: # shortcut/script style -> formal/normal style used in documentation -> full path # rs.servers -> rs.cloudServersOpenStack.servers -> rs.products.cloudServersOpenStack.servers @products[product.name] = {} for resourceName, resource of @[product.name] if @[product.name].hasOwnProperty resourceName if resourceName isnt '_racksmeta' @[product.name][resourceName] = @buildResource product.name, resourceName @products[product.name][resourceName] = @[product.name][resourceName] else if @verbosity > 3 @log 'no product named "' + product.name + '" found in racksjs - please contact the maintainers' # A testing API mockApi: (opts, callback) -> # Fake reply object: fakeReply = [ { id: 1, '_racksmeta': name: 'cloudServersOpenStack' }, { id: 2, '_racksmeta': name: 'cloudServersOpenStack' }, ] # The authentication call if !opts.data? return callback(fakeReply) if opts.data.match /apiKeyCredentials/ fakeEndpoints = [ 'http://MOCKAPI', 0, 1, 2 ] cbObj = access: user: 'RAX-AUTH:defaultRegion': 'ORD' token: id: 'some-fake-testing-id' serviceCatalog: [] for product in [ 'cloudServersOpenStack', 'cloudServers', 'cloudLoadBalancers', 'cloudFiles', 'cloudBlockStorage', 'cloudDatabases', 'cloudBackup', 'cloudDNS', 'cloudImages', 'cloudMonitoring' ] cbObj.access.serviceCatalog.push { name: product, endpoints: fakeEndpoints } return callback(cbObj) else return callback(fakeReply) buildProducts: () -> rack = @ # http://docs.rackspace.com/servers/api/v2/cs-devguide/content/ch_api_operations.html @cloudServersOpenStack = require('./products/cloudServersOpenStack.js')(rack) # http://docs.rackspace.com/servers/api/v1.0/cs-devguide/content/API_Operations-d1e1720.html # This is very old stuff - First Gen servers. Never use this. @cloudServers = require('./products/cloudServers.js')(rack) # http://docs.rackspace.com/loadbalancers/api/v1.0/clb-devguide/content/API_Operations-d1e1354.html @cloudLoadBalancers = require('./products/cloudLoadBalancers.js')(rack) # http://docs.rackspace.com/files/api/v1/cf-devguide/content/API_Operations_for_CDN_Services-d1e2386.html # FIXME: This should NOT be it's own product... Otherwise we duplicate a very large amount of code from RacksJS.cloudFiles #@cloudFilesCDN = # containers: # _racksmeta: # # Containers are accessed with a GET directly to the storage endpoint - ie: there is no URL path beyond the product base # resourceString: '' # plaintext: yes # model: (containerName) -> # catalog = # name: containerName # _racksmeta: # name: containerName # return catalog @cloudFilesCDN = {} @cloudBigData = {} # http://docs.rackspace.com/files/api/v1/cf-devguide/content/API_Operations_for_Storage_Services-d1e942.html @cloudFiles = require('./products/cloudFiles.js')(rack) # http://docs.rackspace.com/cas/api/v1.0/autoscale-devguide/content/API_Operations.html @autoscale = require('./products/autoscale.js')(rack) # http://docs.rackspace.com/cbs/api/v1.0/cbs-devguide/content/volume.html @cloudBlockStorage = require('./products/cloudBlockStorage.js')(rack) # http://docs.rackspace.com/cdb/api/v1.0/cdb-devguide/content/API_Operations-d1e2264.html @cloudDatabases = require('./products/cloudDatabases.js')(rack) # NO DOCUMENTATION AVAILABLE @cloudOrchestration = {} # http://docs.rackspace.com/queues/api/v1.0/cq-devguide/content/API_Operations_dle001.html @cloudQueues = require('./products/cloudQueues.js')(rack) # http://docs.rackspace.com/rcbu/api/v1.0/rcbu-devguide/content/operations.html @cloudBackup = require('./products/cloudBackup.js')(rack) # http://docs.rackspace.com/cdns/api/v1.0/cdns-devguide/content/API_Operations-d1e2264.html @cloudDNS = require('./products/cloudDNS.js')(rack) # http://docs.rackspace.com/images/api/v2/ci-devguide/content/API_Operations.html @cloudImages = require('./products/cloudImages.js')(rack) # http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/service-api-operations.html @cloudMonitoring = require('./products/cloudMonitoring.js')(rack) # Include utilties - these are common and useful RacksJS scripts meant primarily for use by Rackers # but Rackspace customers may also find them useful. @utils = require('./utils.js')(rack) # Shortcuts: @servers = @cloudServersOpenStack.servers @networks = @cloudServersOpenStack.networks @nextgen = @cloudServersOpenStack @firstgen = @cloudServers @clbs = @cloudLoadBalancers.loadBalancers @dns = @cloudDNS.domains @files = @cloudFiles.containers