Class DynectRest
In: lib/dynect_rest.rb
lib/dynect_rest/resource.rb
lib/dynect_rest/exceptions.rb
Parent: Object
Author:Adam Jacob (<adam@opscode.com>)
Copyright:Copyright (c) 2010 Opscode, Inc.
License:Apache License, Version 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Methods

api_request   delete   freeze   get   get_zone   login   logout   new   parse_response   post   publish   put   thaw   underscore  

Classes and Modules

Class DynectRest::Exceptions
Class DynectRest::Resource

Attributes

customer_name  [RW] 
password  [RW] 
rest  [RW] 
user_name  [RW] 
zone  [RW] 

Public Class methods

Creates a new base object for interacting with Dynect‘s REST API

@param [String] Your dynect customer name @param [String] Your dnyect user name @param [String] Your dynect password @param [String] The zone you are going to be editing @param [Boolean] Whether to connect immediately or not - runs login for you @param [Boolean] Verbosity

Convert a CamelCasedString to an under_scored_string.

Public Instance methods

Handles making Dynect API requests and formatting the responses properly.

Raw DELETE request, formatted for Dyn. See list of endpoints at:

manage.dynect.net/help/docs/api2/rest/resources/

@param [String] The partial path to DELETE - for example, ‘User’ or ‘Zone’. @param [Hash] Additional HTTP headers

Freeze the zone.

See: manage.dynect.net/help/docs/api2/rest/resources/Zone.html

@param [String] The zone to freeze - if one is provided when instantiated, we use that. @return [Hash] The dynect API response

Raw GET request, formatted for Dyn. See list of endpoints at:

manage.dynect.net/help/docs/api2/rest/resources/

@param [String] The partial path to GET - for example, ‘User’ or ‘Zone’. @param [Hash] Additional HTTP headers

Zone

Get a zone from dynect

See: manage.dynect.net/help/docs/api2/rest/resources/Zone.html

@param [String] The zone to fetch - if one is provided when instantiated, we use that. @return [Hash] The dynect API response

Login to Dynect - must be done before any other methods called.

See: manage.dynect.net/help/docs/api2/rest/resources/Session.html

@return [Hash] The dynect API response

Logout of Dynect - must be done before any other methods called.

See: manage.dynect.net/help/docs/api2/rest/resources/Session.html

@return [Hash] The dynect API response

Raw POST request, formatted for Dyn. See list of endpoints at:

manage.dynect.net/help/docs/api2/rest/resources/

Read the API documentation, and submit the proper data structure from here.

@param [String] The partial path to POST - for example, ‘User’ or ‘Zone’. @param [Hash] The data structure to submit as the body, is automatically turned to JSON. @param [Hash] Additional HTTP headers

Publish any pending changes to the zone - required to make any alterations permanent.

See: manage.dynect.net/help/docs/api2/rest/resources/Zone.html

@param [String] The zone to publish - if one is provided when instantiated, we use that. @return [Hash] The dynect API response

Raw PUT request, formatted for Dyn. See list of endpoints at:

manage.dynect.net/help/docs/api2/rest/resources/

Read the API documentation, and submit the proper data structure from here.

@param [String] The partial path to PUT - for example, ‘User’ or ‘Zone’. @param [Hash] The data structure to submit as the body, is automatically turned to JSON. @param [Hash] Additional HTTP headers

Thaw the zone.

See: manage.dynect.net/help/docs/api2/rest/resources/Zone.html

@param [String] The zone to thaw - if one is provided when instantiated, we use that. @return [Hash] The dynect API response

[Validate]