datacentred 0.1.1pre → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 240755616a178340253c32e56e42c84021cd1338
-  data.tar.gz: ca171ecfb6061c889b3ce2748f827c8a2200cc21
+  metadata.gz: 72b7ad08b37235031833f7156e93dd13f8cb1336
+  data.tar.gz: e29a3ae8efb52c7f77329f56872a3bfa9f658c0a
 SHA512:
-  metadata.gz: 5a9f5ee89ce7a178fdcae5cc897b3e3dabf817f1f6955911c6a9ba8552500ff38daa96d80fc8d254d553ea83c32c3836fab9161300bf79e60b3e09e475d471de
-  data.tar.gz: f6092203db98a980b9ab9f4100cb01dd85a47f76a05410456b94193fe98e095035d06435db4ae1ccf473f0b32d493a69a6359007b02a94aa092901c0f1797142
+  metadata.gz: 2f5a70d175c027659aa02960e493e33642e3e932011691b08fd7470b2784a4de381740ab7663774d7ba1743dbbb4e68ef9e2762b140881c6590cdb311b49ba1b
+  data.tar.gz: c24448540cbe8e309c0ba934a4af7b5d4745e120e27d4c1f458cdb2700e38d236e20c00b268e785d160809cb935c9c809153deb96d4b8a2a43a1541986f00eca

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+engines:
+  rubocop:
+    enabled: true
+    config:
+      file: .rubocop.yml
+ratings:
+  paths:
+  - lib/**
+  - "**.rb"
+exclude_paths:
+- docs/**/*

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: tqcAzGR7nTMN2VRjkitoGLDWpr1HeURXs

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+.config
+pkg
+doc
+coverage
+.yardoc
+_yardoc
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/.yardopts

@@ -0,0 +1 @@
+--output-dir docs/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at devops@datacentred.co.uk. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,35 +1,72 @@
 PATH
   remote: .
   specs:
-    datacentred (0.1.0)
+    datacentred (0.1.1pre)
       faraday (~> 0.9.1)
+      recursive-open-struct (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
+    coveralls (0.8.0)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (2.99.3)
     minitest (5.3.5)
+    multi_json (1.12.1)
     multipart-post (2.0.0)
+    netrc (0.11.0)
     public_suffix (3.0.0)
+    rake (12.0.0)
+    recursive-open-struct (1.0.5)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
     safe_yaml (1.0.4)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.15.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
     vcr (2.8.0)
     webmock (1.8.11)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
+    yard (0.9.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   datacentred!
   minitest (~> 5.3.1)
+  rake (~> 12.0.0)
   vcr (~> 2.8.0)
   webmock (~> 1.8.0)
+  yard (~> 0.9.0)
 
 BUNDLED WITH
-   1.15.1
+   1.15.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 DataCentred Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,2 +1,160 @@
-# datacentred-api-ruby
-Gem wrapper for Datacentred API.
+![Datacentred](https://assets-cdn.datacentred.io/assets/DC_Mono_B-903aac5ca4f5c6887193d880dbd1196deb8a978027eef5cb32de78b66d085935.png)
+
+Ruby client library for automating DataCentred account management.
+
+[www.datacentred.co.uk](https://www.datacentred.co.uk)
+
+[![CircleCI](https://circleci.com/gh/datacentred/datacentred-api-ruby.svg?style=svg&circle-token=c284db6421742dcfe8c50f52945c31d9b976effb)](https://circleci.com/gh/datacentred/datacentred-api-ruby)
+[![Gem Version](https://badge.fury.io/rb/datacentred.png)](http://badge.fury.io/rb/keybase-core) [![Code Climate](https://codeclimate.com/github/datacentred/datacentred-api-ruby/badges/gpa.svg)](https://codeclimate.com/github/datacentred/datacentred-api-ruby) [![Coverage Status](https://coveralls.io/repos/github/datacentred/datacentred-api-ruby/badge.svg?branch=master)](https://coveralls.io/github/datacentred/datacentred-api-ruby?branch=master)
+
+# Installation
+
+```
+gem install datacentred
+```
+
+or
+
+(in Gemfile or .gemspec)
+```ruby
+gem 'datacentred'
+```
+
+then
+
+```ruby
+require 'datacentred'
+```
+
+# Usage
+
+This API allows you to automate operations against your DataCentred account.
+
+Operations include:
+
+* Creating and managing users;
+* Creating and managing roles for users;
+* Managing OpenStack Project creation, quota adjustments, and user assignments;
+* Viewing detailed usage/billing information for your account.
+
+## Authentication
+
+The API uses two pieces of information to authenticate access.
+
+A unique access key specific to your DataCentred account, and a secret key which is generated once.
+
+To get started:
+
+1. Find your API access key and secret key at [my.datacentred.io](https://my.datacentred.io)
+
+![API Credentials](https://user-images.githubusercontent.com/98526/30334767-79f4617c-97d8-11e7-962c-ec3115d13896.png)
+
+2. Set your credentials by exporting your access key and secret key as environment variables:
+
+```
+export DATACENTRED_ACCESS="my_access"
+export DATACENTRED_SECRET="my_secret"
+```
+
+Or setting your keys manually using the following methods:
+
+```ruby
+Datacentred.access_key = 'my_access'
+Datacentred.secret_key = 'my_secret'
+```
+
+NOTE: If you use this approach, the gem will ignore any values assigned to the environment variables.
+
+## Usage Examples
+
+The `User`, `Project`, and `Role` entities all support CRUD operations via the following methods:
+
+* `.all` - returns an index of all entities of this type.
+* `.create params` - creates a new entity where `params` is a hash of properties.
+* `.update id, params` - updates the entity identified by `id` with the hash of properties defined by `params`.
+* `.find id` - finds the entity via the unique identifier `id`.
+* `.destroy id` - removes the entity via the unique identifier `id`.
+
+Here are some worked examples:
+
+### List all available users
+
+```ruby
+Datacentred::User.all
+# => [#<Datacentred::Model::User id="2bd21ee25cde40fdb9454954e4fbb4b5", ...>, ...]
+```
+
+### Find a user by id
+
+```ruby
+Datacentred::User.find "2bd21ee25cde40fdb9454954e4fbb4b5"
+# => #<Datacentred::Model::User id="2bd21ee25cde40fdb9454954e4fbb4b5", ...>
+```
+
+### Update a project
+
+```ruby
+Datacentred::Project.update "6d5277716c4b10d2177814af50b77175", name: "Foo"
+# => #<Datacentred::Model::Project id="6d5277716c4b10d2177814af50b77175", name= "Foo", ...>
+```
+
+### Create a role
+
+Acceptable permissions are: 'api.read', 'cloud.read', 'roles.modify', 'roles.read', 'storage.read', 'tickets.modify', 'usage.read'.
+
+```ruby
+Datacentred::Role.create name: "foo", permissions: ["usage.read"]
+# => #<Datacentred::Model::Role id="654f423e-646a-4742-849d-d8c9ab9b4f39", name="foo", admin=false, permissions=["usage.read"] ...>
+```
+
+### Add a user to a role
+
+```ruby
+Datacentred::Role.add_user role_id: "654f423e-646a-4742-849d-d8c9ab9b4f39", user_id: "2bd21ee25cde40fdb9454954e4fbb4b5"
+# => true
+```
+
+### Remove a user from a project
+
+```ruby
+Datacentred::Project.remove_user project_id: "6d5277716c4b10d2177814af50b77175", user_id: "2bd21ee25cde40fdb9454954e4fbb4b5"
+# => true
+```
+
+### Get usage data for a given year and month
+
+Usage data is returned simply by supplying a year and a month. If the year/month are current then the data will be as recent as the time contained within the `last_updated_at` property.
+
+```ruby
+@usage = Datacentred::Usage.find 2017, 6
+# => #<Datacentred::Model::Usage last_updated_at=2017-07-12 09:46:54 UTC, projects=[{:id=>"37033518a4514f12adeb8346ac3f188c"
+@usage.projects.first.name
+# => "wyld_stallyns"
+@usage.projects.first.usage.instances.first.current_flavor.name
+=> "dc1.1x1"
+```
+
+## Schemas
+
+There are JSON schemas available for each entity in the gem:
+
+* Projects: https://my.datacentred.io/api/schemas/project
+* Roles: https://my.datacentred.io/api/schemas/role
+* Usage: https://my.datacentred.io/api/schemas/usage
+* User: https://my.datacentred.io/api/schemas/user
+
+## Errors
+
+The gem may raise the following standard errors:
+
+* `Unauthorized` - Your credentials are incorrect or your account isn't authorized for API access.
+* `NotFound` - The entity you referred to can't be found with the ID you supplied.
+* `UnprocessableEntity` - There was a validation issue with your request (only applies to create/delete/update operations)
+
+## Documentation
+
+Full documentation is also available via https://datacentred.github.io/datacentred-api-ruby/
+
+## API Reference Manual
+
+Please check out the [DataCentred API Documentation](https://my.datacentred.io/api/docs/v1) for a comprehensive description of the API itself.

data/circle.yml

@@ -1,5 +1,3 @@
 machine:
-  timezone:
-    Europe/London
   ruby:
     version: 2.3.1

data/datacentred.gemspec

@@ -1,23 +1,26 @@
 Gem::Specification.new do |gem|
-  gem.name = 'datacentred'
-  gem.version = '0.1.1pre'
-  gem.date = '2017-08-10'
-  gem.summary = 'datacentred'
+  gem.name        = 'datacentred'
+  gem.version     = '1.1.1'
+  gem.date        = '2017-09-14'
+  gem.summary     = 'datacentred'
   gem.description = 'Gem wrapper for Datacentred API'
-  gem.authors = [ 'Eugenia Grieff', 'Sean Handley' ]
-  gem.email = 'megrieff@gmail.com'
-  gem.files = `git ls-files`.split("\n")
-  gem.homepage = 'https://github.com/datacentred/datacentred-api-ruby'
-  gem.license = 'BSD-3-Clause'
+  gem.authors     = [ 'Eugenia Grieff', 'Sean Handley' ]
+  gem.email       = 'megrieff@gmail.com'
+  gem.files       = `git ls-files`.split("\n")
+  gem.homepage    = 'https://github.com/datacentred/datacentred-api-ruby'
+  gem.license     = 'MIT'
 
   gem.required_ruby_version = '> 2.3'
 
   # Runtime Dependencies
-  gem.add_runtime_dependency 'faraday', '~> 0.9.1'
+  gem.add_runtime_dependency 'faraday',               '~> 0.9.1'
+  gem.add_runtime_dependency 'recursive-open-struct', '~> 1.0'
 
   # Development Dependencies
-  gem.add_development_dependency 'vcr', '~> 2.8.0'
-  gem.add_development_dependency 'webmock', '~> 1.8.0'
-  gem.add_development_dependency 'minitest', '~> 5.3.1'
-
+  gem.add_development_dependency 'minitest',  '~> 5.3.1'
+  gem.add_development_dependency 'rake',      '~> 12.0.0'
+  gem.add_development_dependency 'vcr',       '~> 2.8.0'
+  gem.add_development_dependency 'webmock',   '~> 1.8.0'
+  gem.add_development_dependency 'yard',      '~> 0.9.0'
+  gem.add_development_dependency 'coveralls', '~> 0.8.0'
 end

data/docs/Datacentred.html

@@ -0,0 +1,537 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Datacentred
+  
+    &mdash; Documentation by YARD 0.9.9
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "Datacentred";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (D)</a> &raquo;
+    
+    
+    <span class="title">Datacentred</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: Datacentred
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/datacentred.rb<span class="defines">,<br />
+  lib/datacentred/error.rb,<br /> lib/datacentred/response.rb,<br /> lib/datacentred/model/base.rb,<br /> lib/datacentred/model/role.rb,<br /> lib/datacentred/model/user.rb,<br /> lib/datacentred/model/usage.rb,<br /> lib/datacentred/request/base.rb,<br /> lib/datacentred/model/project.rb,<br /> lib/datacentred/model/version.rb,<br /> lib/datacentred/request/roles.rb,<br /> lib/datacentred/request/usage.rb,<br /> lib/datacentred/request/users.rb,<br /> lib/datacentred/request/projects.rb,<br /> lib/datacentred/request/versions.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Main Datacentred client module</p>
+
+<p>This library acts as a Ruby wrapper for the DataCentred API.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Datacentred/Errors.html" title="Datacentred::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Datacentred/Model.html" title="Datacentred::Model (module)">Model</a></span>, <span class='object_link'><a href="Datacentred/Request.html" title="Datacentred::Request (module)">Request</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Datacentred/Project.html" title="Datacentred::Project (class)">Project</a></span>, <span class='object_link'><a href="Datacentred/Response.html" title="Datacentred::Response (class)">Response</a></span>, <span class='object_link'><a href="Datacentred/Role.html" title="Datacentred::Role (class)">Role</a></span>, <span class='object_link'><a href="Datacentred/Usage.html" title="Datacentred::Usage (class)">Usage</a></span>, <span class='object_link'><a href="Datacentred/User.html" title="Datacentred::User (class)">User</a></span>, <span class='object_link'><a href="Datacentred/Version.html" title="Datacentred::Version (class)">Version</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#access_key-class_method" title="access_key (class method)">.<strong>access_key</strong>  &#x21d2; String </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Access key credential for the DataCentred API.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#access_key=-class_method" title="access_key= (class method)">.<strong>access_key=</strong>(new_access_key)  &#x21d2; String </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Set a new access key value.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#secret_key-class_method" title="secret_key (class method)">.<strong>secret_key</strong>  &#x21d2; String </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Secret key credential for the DataCentred API.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#secret_key=-class_method" title="secret_key= (class method)">.<strong>secret_key=</strong>(new_secret_key)  &#x21d2; String </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Set a new secret key value.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="access_key-class_method">
+  
+    .<strong>access_key</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Access key credential for the DataCentred API.</p>
+
+<p>This value is automatically loaded from the
+<strong>DATACENTRED_ACCESS</strong> environment variable.</p>
+
+<p>You can find your API credentials by logging into the dashboard at <a
+href="https://my.datacentred.io">my.datacentred.io</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>API access key credential</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/datacentred.rb', line 32</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_access_key'>access_key</span>
+  <span class='cvar'>@@access_key</span> <span class='op'>||=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DATACENTRED_ACCESS</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="access_key=-class_method">
+  
+    .<strong>access_key=</strong>(new_access_key)  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Set a new access key value.</p>
+
+<p>This will override any values loaded from environment variables.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>new_access_key</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>New access key value</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>API access key credential</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+42
+43
+44</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/datacentred.rb', line 42</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_access_key='>access_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_new_access_key'>new_access_key</span><span class='rparen'>)</span>
+  <span class='cvar'>@@access_key</span> <span class='op'>=</span> <span class='id identifier rubyid_new_access_key'>new_access_key</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="secret_key-class_method">
+  
+    .<strong>secret_key</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Secret key credential for the DataCentred API.</p>
+
+<p>This value is automatically loaded from the
+<strong>DATACENTRED_SECRET</strong> environment variable.</p>
+
+<p>You can find your API credentials by logging into the dashboard at <a
+href="https://my.datacentred.io">my.datacentred.io</a></p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>API secret key credential</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+53
+54
+55</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/datacentred.rb', line 53</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_secret_key'>secret_key</span>
+  <span class='cvar'>@@secret_key</span> <span class='op'>||=</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DATACENTRED_SECRET</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="secret_key=-class_method">
+  
+    .<strong>secret_key=</strong>(new_secret_key)  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Set a new secret key value.</p>
+
+<p>This will override any values loaded from environment variables.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>new_secret_key</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>New secret key value</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>API secret key credential</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+64
+65
+66</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/datacentred.rb', line 64</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_secret_key='>secret_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_new_secret_key'>new_secret_key</span><span class='rparen'>)</span>
+  <span class='cvar'>@@secret_key</span> <span class='op'>=</span> <span class='id identifier rubyid_new_secret_key'>new_secret_key</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Fri Sep 15 16:27:42 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.9 (ruby-2.3.1).
+</div>
+
+    </div>
+  </body>
+</html>