RubyGems - vermillion-client - Versions diffs - 1.0.0 - Mend

vermillion-client 1.0.0

Files changed (103) hide show

checksums.yaml +7 -0
data/.gitignore +1 -0
data/.hound.yml +2 -0
data/.rubocop.yml +320 -0
data/Gemfile +3 -0
data/Gemfile.lock +26 -0
data/README.md +55 -0
data/Rakefile +10 -0
data/bin/setup +7 -0
data/bin/vermillion +16 -0
data/doc/ChangeBranchTest.html +240 -0
data/doc/ConfigurationTest.html +277 -0
data/doc/CreateTest.html +240 -0
data/doc/Gemfile.html +145 -0
data/doc/Gemfile_lock.html +173 -0
data/doc/README_md.html +216 -0
data/doc/Rakefile.html +151 -0
data/doc/UpdateTest.html +280 -0
data/doc/Vermillion.html +272 -0
data/doc/Vermillion/Cfg.html +362 -0
data/doc/Vermillion/Controller.html +185 -0
data/doc/Vermillion/Controller/Base.html +503 -0
data/doc/Vermillion/Controller/Change.html +301 -0
data/doc/Vermillion/Controller/Create.html +301 -0
data/doc/Vermillion/Controller/Firstrun.html +256 -0
data/doc/Vermillion/Controller/Status.html +308 -0
data/doc/Vermillion/Controller/Update.html +326 -0
data/doc/Vermillion/Helper.html +252 -0
data/doc/Vermillion/Helper/ApiCommunication.html +307 -0
data/doc/Vermillion/Helper/Endpoint.html +506 -0
data/doc/Vermillion/Helper/Formatting.html +250 -0
data/doc/Vermillion/Helper/Network.html +304 -0
data/doc/Vermillion/Helper/Results.html +341 -0
data/doc/Vermillion/Helper/Time.html +295 -0
data/doc/Vermillion/Request.html +332 -0
data/doc/Vermillion/Router.html +351 -0
data/doc/Vermillion/Test.html +183 -0
data/doc/Vermillion/Test/Base.html +260 -0
data/doc/Vermillion/Utils.html +247 -0
data/doc/bin/setup.html +147 -0
data/doc/created.rid +33 -0
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +138 -0
data/doc/js/darkfish.js +155 -0
data/doc/js/jquery.js +4 -0
data/doc/js/navigation.js +142 -0
data/doc/js/search.js +94 -0
data/doc/js/search_index.js +1 -0
data/doc/js/searcher.js +228 -0
data/doc/rdoc.css +595 -0
data/doc/table_of_contents.html +255 -0
data/doc/vermillion-client_gemspec.html +166 -0
data/lib/client.rb +35 -0
data/lib/client/config.rb +58 -0
data/lib/client/controller.rb +68 -0
data/lib/client/controller/change.rb +26 -0
data/lib/client/controller/create.rb +26 -0
data/lib/client/controller/firstrun.rb +30 -0
data/lib/client/controller/status.rb +43 -0
data/lib/client/controller/update.rb +26 -0
data/lib/client/helper.rb +21 -0
data/lib/client/helper/apicommunication.rb +78 -0
data/lib/client/helper/endpoint.rb +61 -0
data/lib/client/helper/formatting.rb +23 -0
data/lib/client/helper/network.rb +54 -0
data/lib/client/helper/results.rb +28 -0
data/lib/client/helper/time.rb +33 -0
data/lib/client/request.rb +22 -0
data/lib/client/router.rb +56 -0
data/lib/client/utils.rb +18 -0
data/lib/client/version.rb +4 -0
data/lib/test.rb +13 -0
data/lib/test/base.rb +17 -0
data/test/test_change_branch.rb +14 -0
data/test/test_configuration.rb +21 -0
data/test/test_create.rb +14 -0
data/test/test_update.rb +24 -0
data/vermillion-client.gemspec +23 -0
metadata +201 -0

data/doc/Vermillion/Helper/ApiCommunication.html ADDED Viewed

@@ -0,0 +1,307 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>module Vermillion::Helper::ApiCommunication - RDoc Documentation</title>
+<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../../";
+</script>
+<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../../index.html">Home</a>
+    <a href="../../table_of_contents.html#classes">Classes</a>
+    <a href="../../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/client/helper/apicommunication.rb
+  </ul>
+</nav>
+  </div>
+  <div id="class-metadata">
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+  <ul class="link-list">
+    <li ><a href="#method-i-send_to_all">#send_to_all</a>
+    <li ><a href="#method-i-send_to_one">#send_to_one</a>
+  </ul>
+</nav>
+  </div>
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+  <ul>
+    <li class="file"><a href="../../Gemfile.html">Gemfile</a>
+    <li class="file"><a href="../../Gemfile_lock.html">Gemfile.lock</a>
+    <li class="file"><a href="../../README_md.html">README</a>
+    <li class="file"><a href="../../Rakefile.html">Rakefile</a>
+    <li class="file"><a href="../../bin/setup.html">setup</a>
+    <li class="file"><a href="../../vermillion-client_gemspec.html">vermillion-client.gemspec</a>
+  </ul>
+</nav>
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+  <ul class="link-list">
+    <li><a href="../../ChangeBranchTest.html">ChangeBranchTest</a>
+    <li><a href="../../ConfigurationTest.html">ConfigurationTest</a>
+    <li><a href="../../CreateTest.html">CreateTest</a>
+    <li><a href="../../UpdateTest.html">UpdateTest</a>
+    <li><a href="../../Vermillion.html">Vermillion</a>
+    <li><a href="../../Vermillion/Cfg.html">Vermillion::Cfg</a>
+    <li><a href="../../Vermillion/Controller.html">Vermillion::Controller</a>
+    <li><a href="../../Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
+    <li><a href="../../Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
+    <li><a href="../../Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
+    <li><a href="../../Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
+    <li><a href="../../Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
+    <li><a href="../../Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
+    <li><a href="../../Vermillion/Helper.html">Vermillion::Helper</a>
+    <li><a href="../../Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
+    <li><a href="../../Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
+    <li><a href="../../Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
+    <li><a href="../../Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
+    <li><a href="../../Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
+    <li><a href="../../Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
+    <li><a href="../../Vermillion/Request.html">Vermillion::Request</a>
+    <li><a href="../../Vermillion/Router.html">Vermillion::Router</a>
+    <li><a href="../../Vermillion/Test.html">Vermillion::Test</a>
+    <li><a href="../../Vermillion/Test/Base.html">Vermillion::Test::Base</a>
+    <li><a href="../../Vermillion/Utils.html">Vermillion::Utils</a>
+  </ul>
+</nav>
+  </div>
+</nav>
+<div id="documentation">
+  <h1 class="module">module Vermillion::Helper::ApiCommunication</h1>
+  <div id="description" class="description">
+  </div><!-- description -->
+  <section id="5Buntitled-5D" class="documentation-section">
+    <!-- Methods -->
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+      <div id="method-i-send_to_all" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">send_to_all</span><span
+            class="method-args">(endpoint, args = {})</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Send HTTP requests to all servers in the local manifest Params:</p>
+<dl class="rdoc-list note-list"><dt><code>endpoint</code>
+<dd>
+<p>The REST endpoint you&#39;d like to send a request to</p>
+</dd><dt><code>args</code>
+<dd>
+<p>Any specific configuration data to send along with the request</p>
+</dd></dl>
+          <div class="method-source-code" id="send_to_all-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/apicommunication.rb, line 41</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_to_all</span>(<span class="ruby-identifier">endpoint</span>, <span class="ruby-identifier">args</span> = {})
+  <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:servers</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">send_to_one</span>(<span class="ruby-identifier">server</span>[<span class="ruby-value">:name</span>], <span class="ruby-identifier">endpoint</span>, <span class="ruby-identifier">args</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">server</span>[<span class="ruby-value">:name</span>]
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- send_to_all-source -->
+        </div>
+      </div><!-- send_to_all-method -->
+      <div id="method-i-send_to_one" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">send_to_one</span><span
+            class="method-args">(input, endpoint, args = {})</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Send an HTTP request to one server Params:</p>
+<dl class="rdoc-list note-list"><dt><code>input</code>
+<dd>
+<p>The server you want to connect to</p>
+</dd><dt><code>endpoint</code>
+<dd>
+<p>The REST endpoint you&#39;d like to send a request to</p>
+</dd><dt><code>args</code>
+<dd>
+<p>Any specific configuration data to send along with the request</p>
+</dd></dl>
+          <div class="method-source-code" id="send_to_one-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/apicommunication.rb, line 9</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_to_one</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">endpoint</span>, <span class="ruby-identifier">args</span> = {})
+  <span class="ruby-identifier">server</span>, <span class="ruby-identifier">endpoint</span> = <span class="ruby-identifier">setup</span>(<span class="ruby-identifier">input</span>, <span class="ruby-identifier">endpoint</span>, <span class="ruby-identifier">args</span>)
+  <span class="ruby-keyword">begin</span>
+    <span class="ruby-identifier">resp</span> = <span class="ruby-ivar">@network</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">endpoint</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">server</span>[<span class="ruby-value">:key</span>])
+    <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">spit</span>(<span class="ruby-identifier">endpoint</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">DEBUG</span>
+    <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">spit</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">DEBUG</span>
+    <span class="ruby-comment"># generic failure for invalid response type</span>
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECONNREFUSED</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">resp</span>[<span class="ruby-string">&quot;Content-Type&quot;</span>] <span class="ruby-operator">!=</span> <span class="ruby-string">&quot;application/json&quot;</span>
+    <span class="ruby-comment"># handle JSON response</span>
+    <span class="ruby-identifier">response_data</span> = <span class="ruby-ivar">@format</span>.<span class="ruby-identifier">symbolize</span>(<span class="ruby-constant">JSON</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">body</span>))
+    <span class="ruby-keyword">if</span> <span class="ruby-identifier">response_data</span>[<span class="ruby-value">:_code</span>] <span class="ruby-operator">==</span> <span class="ruby-value">200</span>
+      <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">success</span>(<span class="ruby-node">&quot;#{server[:name]} (#{server[:address]}) update succeeded&quot;</span>)
+    <span class="ruby-keyword">elsif</span> <span class="ruby-operator">!</span><span class="ruby-identifier">response_data</span>[<span class="ruby-value">:message</span>].<span class="ruby-identifier">nil?</span>
+      <span class="ruby-comment"># work around a messaging issue with vermillion-server</span>
+      <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-node">&quot;Error: #{response_data[:message]}&quot;</span>)
+    <span class="ruby-keyword">else</span>
+      <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-node">&quot;#{response_data[:_title]}: #{response_data[:_message]}&quot;</span>)
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ECONNREFUSED</span>
+    <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-node">&quot;Request failed for #{server[:name]} (#{server[:address]})&quot;</span>)
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- send_to_one-source -->
+        </div>
+      </div><!-- send_to_one-method -->
+    </section><!-- public-instance-method-details -->
+  </section><!-- 5Buntitled-5D -->
+</div><!-- documentation -->
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>

data/doc/Vermillion/Helper/Endpoint.html ADDED Viewed

@@ -0,0 +1,506 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<title>class Vermillion::Helper::Endpoint - RDoc Documentation</title>
+<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../../";
+</script>
+<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../../index.html">Home</a>
+    <a href="../../table_of_contents.html#classes">Classes</a>
+    <a href="../../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/client/helper/endpoint.rb
+  </ul>
+</nav>
+  </div>
+  <div id="class-metadata">
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  <p class="link">Object
+</nav>
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+  <ul class="link-list">
+    <li ><a href="#method-c-new">::new</a>
+    <li ><a href="#method-i-add">#add</a>
+    <li ><a href="#method-i-delete">#delete</a>
+    <li ><a href="#method-i-exists-3F">#exists?</a>
+    <li ><a href="#method-i-get">#get</a>
+    <li ><a href="#method-i-protocol-3D">#protocol=</a>
+    <li ><a href="#method-i-to_s">#to_s</a>
+  </ul>
+</nav>
+  </div>
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+  <ul>
+    <li class="file"><a href="../../Gemfile.html">Gemfile</a>
+    <li class="file"><a href="../../Gemfile_lock.html">Gemfile.lock</a>
+    <li class="file"><a href="../../README_md.html">README</a>
+    <li class="file"><a href="../../Rakefile.html">Rakefile</a>
+    <li class="file"><a href="../../bin/setup.html">setup</a>
+    <li class="file"><a href="../../vermillion-client_gemspec.html">vermillion-client.gemspec</a>
+  </ul>
+</nav>
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+  <ul class="link-list">
+    <li><a href="../../ChangeBranchTest.html">ChangeBranchTest</a>
+    <li><a href="../../ConfigurationTest.html">ConfigurationTest</a>
+    <li><a href="../../CreateTest.html">CreateTest</a>
+    <li><a href="../../UpdateTest.html">UpdateTest</a>
+    <li><a href="../../Vermillion.html">Vermillion</a>
+    <li><a href="../../Vermillion/Cfg.html">Vermillion::Cfg</a>
+    <li><a href="../../Vermillion/Controller.html">Vermillion::Controller</a>
+    <li><a href="../../Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
+    <li><a href="../../Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
+    <li><a href="../../Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
+    <li><a href="../../Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
+    <li><a href="../../Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
+    <li><a href="../../Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
+    <li><a href="../../Vermillion/Helper.html">Vermillion::Helper</a>
+    <li><a href="../../Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
+    <li><a href="../../Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
+    <li><a href="../../Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
+    <li><a href="../../Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
+    <li><a href="../../Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
+    <li><a href="../../Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
+    <li><a href="../../Vermillion/Request.html">Vermillion::Request</a>
+    <li><a href="../../Vermillion/Router.html">Vermillion::Router</a>
+    <li><a href="../../Vermillion/Test.html">Vermillion::Test</a>
+    <li><a href="../../Vermillion/Test/Base.html">Vermillion::Test::Base</a>
+    <li><a href="../../Vermillion/Utils.html">Vermillion::Utils</a>
+  </ul>
+</nav>
+  </div>
+</nav>
+<div id="documentation">
+  <h1 class="class">class Vermillion::Helper::Endpoint</h1>
+  <div id="description" class="description">
+  </div><!-- description -->
+  <section id="5Buntitled-5D" class="documentation-section">
+    <!-- Attributes -->
+    <section id="attribute-method-details" class="method-section section">
+      <h3 class="section-header">Attributes</h3>
+      <div id="attribute-i-server" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">server</span><span
+            class="attribute-access-type">[W]</span>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </section><!-- attribute-method-details -->
+    <!-- Methods -->
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+      <div id="method-c-new" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(initial_path)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Creates the <a href="Endpoint.html">Endpoint</a> object with default values
+for internal variables Params:</p>
+<dl class="rdoc-list note-list"><dt><code>initial_path</code>
+<dd>
+<p>Starting point of the URL this class will build</p>
+</dd></dl>
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 9</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">initial_path</span>)
+  <span class="ruby-ivar">@path</span> = { <span class="ruby-identifier">default</span><span class="ruby-operator">:</span> <span class="ruby-identifier">initial_path</span> }
+  <span class="ruby-ivar">@server</span> = <span class="ruby-keyword">nil</span>
+  <span class="ruby-ivar">@protocol</span> = <span class="ruby-string">&quot;http://&quot;</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- new-source -->
+        </div>
+      </div><!-- new-method -->
+    </section><!-- public-class-method-details -->
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+      <div id="method-i-add" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">add</span><span
+            class="method-args">(key, value)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Add a section to the path Params:</p>
+<dl class="rdoc-list note-list"><dt><code>key</code>
+<dd>
+<p>Symbol, the key to identify the section</p>
+</dd><dt><code>value</code>
+<dd>
+<p>Any value to store with the associated key</p>
+</dd></dl>
+          <div class="method-source-code" id="add-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 26</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span>)
+  <span class="ruby-ivar">@path</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">value</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- add-source -->
+        </div>
+      </div><!-- add-method -->
+      <div id="method-i-delete" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">delete</span><span
+            class="method-args">(key)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Deletes a value from the internal hash based on a key Params:</p>
+<dl class="rdoc-list note-list"><dt><code>key</code>
+<dd>
+<p>Symbol, the key to identify the section</p>
+</dd></dl>
+          <div class="method-source-code" id="delete-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 40</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+  <span class="ruby-ivar">@path</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">key</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- delete-source -->
+        </div>
+      </div><!-- delete-method -->
+      <div id="method-i-exists-3F" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">exists?</span><span
+            class="method-args">(key)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Checks whether a key exists Params:</p>
+<dl class="rdoc-list note-list"><dt><code>key</code>
+<dd>
+<p>Symbol, the key to identify the section</p>
+</dd></dl>
+          <div class="method-source-code" id="exists-3F-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 47</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">key</span>)
+  <span class="ruby-ivar">@path</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">key</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- exists-3F-source -->
+        </div>
+      </div><!-- exists-3F-method -->
+      <div id="method-i-get" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">get</span><span
+            class="method-args">(key)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Return a value based on the provided key Params:</p>
+<dl class="rdoc-list note-list"><dt><code>key</code>
+<dd>
+<p>Symbol, the key to identify the section</p>
+</dd></dl>
+          <div class="method-source-code" id="get-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 33</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">key</span>)
+  <span class="ruby-ivar">@path</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>]
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- get-source -->
+        </div>
+      </div><!-- get-method -->
+      <div id="method-i-protocol-3D" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">protocol=</span><span
+            class="method-args">(use_https)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Set endpoint protocol Params:</p>
+<dl class="rdoc-list note-list"><dt><code>use_https</code>
+<dd>
+<p>Boolean value for whether to use HTTPS</p>
+</dd></dl>
+          <div class="method-source-code" id="protocol-3D-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 18</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">protocol=</span>(<span class="ruby-identifier">use_https</span>)
+  <span class="ruby-ivar">@protocol</span> = <span class="ruby-string">&#39;https://&#39;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">use_https</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- protocol-3D-source -->
+        </div>
+      </div><!-- protocol-3D-method -->
+      <div id="method-i-to_s" class="method-detail ">
+        <div class="method-heading">
+          <span class="method-name">to_s</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Override the <a href="Endpoint.html#method-i-to_s">#to_s</a> method to
+return an endpoint fragment</p>
+          <div class="method-source-code" id="to_s-source">
+            <pre><span class="ruby-comment"># File lib/client/helper/endpoint.rb, line 52</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
+  <span class="ruby-identifier">output</span> = <span class="ruby-ivar">@protocol</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@server</span>
+  <span class="ruby-ivar">@path</span>.<span class="ruby-identifier">each_pair</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">_k</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">output</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">value</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-identifier">output</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- to_s-source -->
+        </div>
+      </div><!-- to_s-method -->
+    </section><!-- public-instance-method-details -->
+  </section><!-- 5Buntitled-5D -->
+</div><!-- documentation -->
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>