RubyGems - bcx - Versions diffs - 0.3.0 → 0.4.0 - Mend

bcx 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

checksums.yaml +4 -4
data/.rspec +1 -0
data/.travis.yml +2 -0
data/README.md +1 -1
data/bcx.gemspec +2 -1
data/docs/access.html +140 -0
data/docs/authorization.html +147 -0
data/docs/bcx.html +200 -0
data/docs/comment.html +139 -0
data/docs/configuration.html +137 -0
data/docs/docco.css +76 -64
data/docs/http.html +151 -0
data/docs/oauth.html +144 -0
data/docs/person.html +147 -0
data/docs/project.html +154 -0
data/docs/public/fonts/roboto-black.eot +0 -0
data/docs/public/fonts/roboto-black.ttf +0 -0
data/docs/public/fonts/roboto-black.woff +0 -0
data/docs/response_error.html +153 -0
data/docs/todo.html +148 -0
data/docs/todolist.html +158 -0
data/docs/version.html +125 -0
data/lib/bcx/resources/comment.rb +26 -0
data/lib/bcx/resources/project.rb +1 -0
data/lib/bcx/resources/todo.rb +1 -0
data/lib/bcx/resources/todolist.rb +1 -0
data/lib/bcx/version.rb +1 -1
data/lib/bcx.rb +1 -0
data/lib/tasks/docs.rake +4 -2
data/spec/bcx/comment_spec.rb +31 -0
data/spec/cassettes/Bcx_Resources_Comment/DELETE_/projects/9634353/comments/297584179_json/should_delete_the_given_comment.yml +140 -0
data/spec/cassettes/Bcx_Resources_Comment/POST_/projects/9634353/todolists/29123043/comments_json/should_create_a_new_todolist_comment.yml +114 -0
data/spec/cassettes/Bcx_Resources_Comment/POST_/projects/9634353/todos/185137845/comments_json/should_create_a_new_todo_comment.yml +114 -0
metadata +41 -30
data/docs/lib/bcx/client/http.html +0 -144
data/docs/lib/bcx/client/oauth.html +0 -146
data/docs/lib/bcx/configuration.html +0 -80
data/docs/lib/bcx/launchpad/oauth.html +0 -137
data/docs/lib/bcx/resources/access.html +0 -133
data/docs/lib/bcx/resources/authorization.html +0 -140
data/docs/lib/bcx/resources/person.html +0 -140
data/docs/lib/bcx/resources/project.html +0 -146
data/docs/lib/bcx/resources/todo.html +0 -140
data/docs/lib/bcx/resources/todolist.html +0 -150
data/docs/lib/bcx/response_error.html +0 -96
data/docs/lib/bcx/version.html +0 -68
data/docs/lib/bcx.html +0 -192
data/docs/public/fonts/novecento-bold.eot +0 -0
data/docs/public/fonts/novecento-bold.ttf +0 -0
data/docs/public/fonts/novecento-bold.woff +0 -0

data/docs/lib/bcx/resources/project.html DELETED Viewed

@@ -1,146 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>project.rb</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
-  <link rel="stylesheet" media="all" href="../../../docco.css" />
-</head>
-<body>
-  <div id="container">
-    <div id="background"></div>
-      <ul id="jump_to">
-        <li>
-          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
-          <a class="small" href="javascript:void(0);">+</a>
-          <div id="jump_wrapper">
-          <div id="jump_page">
-              <a class="source" href="../../bcx.html">
-                lib/bcx.rb
-              </a>
-              <a class="source" href="../client/http.html">
-                lib/bcx/client/http.rb
-              </a>
-              <a class="source" href="../client/oauth.html">
-                lib/bcx/client/oauth.rb
-              </a>
-              <a class="source" href="../configuration.html">
-                lib/bcx/configuration.rb
-              </a>
-              <a class="source" href="../launchpad/oauth.html">
-                lib/bcx/launchpad/oauth.rb
-              </a>
-              <a class="source" href="access.html">
-                lib/bcx/resources/access.rb
-              </a>
-              <a class="source" href="authorization.html">
-                lib/bcx/resources/authorization.rb
-              </a>
-              <a class="source" href="person.html">
-                lib/bcx/resources/person.rb
-              </a>
-              <a class="source" href="project.html">
-                lib/bcx/resources/project.rb
-              </a>
-              <a class="source" href="todo.html">
-                lib/bcx/resources/todo.rb
-              </a>
-              <a class="source" href="todolist.html">
-                lib/bcx/resources/todolist.rb
-              </a>
-              <a class="source" href="../response_error.html">
-                lib/bcx/response_error.rb
-              </a>
-              <a class="source" href="../version.html">
-                lib/bcx/version.rb
-              </a>
-          </div>
-        </li>
-      </ul>
-    <ul class="sections">
-          <li id="title">
-              <div class="annotation">
-                  <h1>project.rb</h1>
-              </div>
-          </li>
-        <li id="section-1">
-            <div class="annotation">
-              <div class="pilwrap for-h2">
-                <a class="pilcrow" href="#section-1">&#182;</a>
-              </div>
-              <h2>Projects</h2>
-<p>Provides access to projects resoource and other nested resources</p>
-<h4>Fetch all projects</h4>
-<p><code>GET /projects.json</code></p>
-<pre><code>client.projects!</code></pre>
-<h4>Fetch archived projects</h4>
-<p><code>GET /projects/archived.json</code></p>
-<pre><code>clients.projects.archived!</code></pre>
-<h4>Fetch single project with ID of 123</h4>
-<p><code>GET /projects/123.json</code></p>
-<pre><code>client.projects!(<span class="number">123</span>)</code></pre>
-<h4>Create a project</h4>
-<p><code>POST /projects.json</code></p>
-<pre><code>client.projects.create!(<span class="symbol">name:</span> <span class="string">'Acme project'</span>, <span class="symbol">description:</span> <span class="string">'This is a new project'</span>)</code></pre>
-<h4>Update an existing project</h4>
-<p><code>PUT /projects/123.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).update!(<span class="symbol">description:</span> <span class="string">'A new description'</span>)</code></pre>
-<h4>Delete a project</h4>
-<p><code>DELETE /projects/123.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).delete!</code></pre>
-            </div>
-            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
-  <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
-    <span class="class"><span class="keyword">class</span> <span class="title">Project</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
-      resource <span class="symbol">:todolists</span>
-      resource <span class="symbol">:todos</span>
-      resource <span class="symbol">:accesses</span>
-      collection <span class="symbol">:archived</span>
-    <span class="keyword">end</span>
-  <span class="keyword">end</span>
-<span class="keyword">end</span></pre></div></div>
-        </li>
-    </ul>
-  </div>
-</body>
-</html>

data/docs/lib/bcx/resources/todo.html DELETED Viewed

@@ -1,140 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>todo.rb</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
-  <link rel="stylesheet" media="all" href="../../../docco.css" />
-</head>
-<body>
-  <div id="container">
-    <div id="background"></div>
-      <ul id="jump_to">
-        <li>
-          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
-          <a class="small" href="javascript:void(0);">+</a>
-          <div id="jump_wrapper">
-          <div id="jump_page">
-              <a class="source" href="../../bcx.html">
-                lib/bcx.rb
-              </a>
-              <a class="source" href="../client/http.html">
-                lib/bcx/client/http.rb
-              </a>
-              <a class="source" href="../client/oauth.html">
-                lib/bcx/client/oauth.rb
-              </a>
-              <a class="source" href="../configuration.html">
-                lib/bcx/configuration.rb
-              </a>
-              <a class="source" href="../launchpad/oauth.html">
-                lib/bcx/launchpad/oauth.rb
-              </a>
-              <a class="source" href="access.html">
-                lib/bcx/resources/access.rb
-              </a>
-              <a class="source" href="authorization.html">
-                lib/bcx/resources/authorization.rb
-              </a>
-              <a class="source" href="person.html">
-                lib/bcx/resources/person.rb
-              </a>
-              <a class="source" href="project.html">
-                lib/bcx/resources/project.rb
-              </a>
-              <a class="source" href="todo.html">
-                lib/bcx/resources/todo.rb
-              </a>
-              <a class="source" href="todolist.html">
-                lib/bcx/resources/todolist.rb
-              </a>
-              <a class="source" href="../response_error.html">
-                lib/bcx/response_error.rb
-              </a>
-              <a class="source" href="../version.html">
-                lib/bcx/version.rb
-              </a>
-          </div>
-        </li>
-      </ul>
-    <ul class="sections">
-          <li id="title">
-              <div class="annotation">
-                  <h1>todo.rb</h1>
-              </div>
-          </li>
-        <li id="section-1">
-            <div class="annotation">
-              <div class="pilwrap for-h2">
-                <a class="pilcrow" href="#section-1">&#182;</a>
-              </div>
-              <h2>Todo</h2>
-<p>Provides access to todolist resoource both at the client level and per-project</p>
-<h4>Get todos for a todolist</h4>
-<p><code>GET /todolists/1.json</code></p>
-<pre><code>todolist = client.todolists!(<span class="number">1</span>)
-todolist.todos.remaining
-todolist.todos.completed</code></pre>
-<h4>Get a specific todo</h4>
-<p><code>GET /projects/1/todos/2.json</code></p>
-<pre><code>client.projects(<span class="number">1</span>).todos!(<span class="number">2</span>)</code></pre>
-<h4>Create a todo</h4>
-<p><code>POST /projects/1/todolists/2/todos.json</code></p>
-<pre><code>client.projects(<span class="number">1</span>).todolists(<span class="number">2</span>).todos.create!(<span class="symbol">content:</span> <span class="string">'Update copy text'</span>)</code></pre>
-<h4>Update a todo</h4>
-<p><code>PUT /projects/1/todos/2.json</code></p>
-<pre><code>client.projects(<span class="number">1</span>).todos(<span class="number">2</span>).update!(<span class="symbol">completed:</span> <span class="keyword">true</span>)</code></pre>
-<h4>Delete a todo</h4>
-<p><code>DELETE /projects/1/todos/2.json</code></p>
-<pre><code>client.projects(<span class="number">1</span>).todos(<span class="number">2</span>).delete!</code></pre>
-            </div>
-            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
-  <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
-    <span class="class"><span class="keyword">class</span> <span class="title">Todo</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
-    <span class="keyword">end</span>
-  <span class="keyword">end</span>
-<span class="keyword">end</span></pre></div></div>
-        </li>
-    </ul>
-  </div>
-</body>
-</html>

data/docs/lib/bcx/resources/todolist.html DELETED Viewed

@@ -1,150 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>todolist.rb</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
-  <link rel="stylesheet" media="all" href="../../../docco.css" />
-</head>
-<body>
-  <div id="container">
-    <div id="background"></div>
-      <ul id="jump_to">
-        <li>
-          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
-          <a class="small" href="javascript:void(0);">+</a>
-          <div id="jump_wrapper">
-          <div id="jump_page">
-              <a class="source" href="../../bcx.html">
-                lib/bcx.rb
-              </a>
-              <a class="source" href="../client/http.html">
-                lib/bcx/client/http.rb
-              </a>
-              <a class="source" href="../client/oauth.html">
-                lib/bcx/client/oauth.rb
-              </a>
-              <a class="source" href="../configuration.html">
-                lib/bcx/configuration.rb
-              </a>
-              <a class="source" href="../launchpad/oauth.html">
-                lib/bcx/launchpad/oauth.rb
-              </a>
-              <a class="source" href="access.html">
-                lib/bcx/resources/access.rb
-              </a>
-              <a class="source" href="authorization.html">
-                lib/bcx/resources/authorization.rb
-              </a>
-              <a class="source" href="person.html">
-                lib/bcx/resources/person.rb
-              </a>
-              <a class="source" href="project.html">
-                lib/bcx/resources/project.rb
-              </a>
-              <a class="source" href="todo.html">
-                lib/bcx/resources/todo.rb
-              </a>
-              <a class="source" href="todolist.html">
-                lib/bcx/resources/todolist.rb
-              </a>
-              <a class="source" href="../response_error.html">
-                lib/bcx/response_error.rb
-              </a>
-              <a class="source" href="../version.html">
-                lib/bcx/version.rb
-              </a>
-          </div>
-        </li>
-      </ul>
-    <ul class="sections">
-          <li id="title">
-              <div class="annotation">
-                  <h1>todolist.rb</h1>
-              </div>
-          </li>
-        <li id="section-1">
-            <div class="annotation">
-              <div class="pilwrap for-h2">
-                <a class="pilcrow" href="#section-1">&#182;</a>
-              </div>
-              <h2>Todolists</h2>
-<p>Provides access to todolist resoource both at the client level and per-project</p>
-<h4>Get all todolists for a project</h4>
-<p><code>GET /projects/123/todolists.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists!</code></pre>
-<h4>Get all completed todolists for a project</h4>
-<p><code>GET /projects/1/todolists/completed.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists.completed!</code></pre>
-<h4>Get todolists for all projects</h4>
-<p><code>GET /todolists.json</code></p>
-<pre><code>client.todolists!</code></pre>
-<h4>Get completed todolists for all projects</h4>
-<p><code>GET /todolists/completed.json</code></p>
-<pre><code>client.todolists.completed!</code></pre>
-<h4>Get specific todolist including the todos</h4>
-<p><code>GET /projects/123/todolists/456.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists!(<span class="number">456</span>)</code></pre>
-<h4>Create a new todolist</h4>
-<p><code>POST /projects/1/todolists.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists.create!(<span class="symbol">name:</span> <span class="string">'My todolist'</span>, <span class="symbol">description:</span> <span class="string">'This is a todolist'</span>)</code></pre>
-<h4>Update an existing todolist</h4>
-<p><code>PUT /projects/123/todolists/456.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists(<span class="number">456</span>).update!(<span class="symbol">name:</span> <span class="string">'Updated todolist'</span>)</code></pre>
-<h4>Delete a todolist</h4>
-<p><code>DELETE /projects/123/todolists/456.json</code></p>
-<pre><code>client.projects(<span class="number">123</span>).todolists(<span class="number">456</span>).delete!</code></pre>
-            </div>
-            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
-  <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
-    <span class="class"><span class="keyword">class</span> <span class="title">Todolist</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
-      resource <span class="symbol">:todos</span>, <span class="symbol">class_name:</span> <span class="string">'Bcx::Resources::Todo'</span>
-      collection <span class="symbol">:completed</span>
-    <span class="keyword">end</span>
-  <span class="keyword">end</span>
-<span class="keyword">end</span></pre></div></div>
-        </li>
-    </ul>
-  </div>
-</body>
-</html>

data/docs/lib/bcx/response_error.html DELETED Viewed

@@ -1,96 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>response_error.rb</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
-  <link rel="stylesheet" media="all" href="../../docco.css" />
-</head>
-<body>
-  <div id="container">
-    <div id="background"></div>
-      <ul id="jump_to">
-        <li>
-          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
-          <a class="small" href="javascript:void(0);">+</a>
-          <div id="jump_wrapper">
-          <div id="jump_page">
-              <a class="source" href="configuration.html">
-                lib/bcx/configuration.rb
-              </a>
-              <a class="source" href="response_error.html">
-                lib/bcx/response_error.rb
-              </a>
-              <a class="source" href="version.html">
-                lib/bcx/version.rb
-              </a>
-          </div>
-        </li>
-      </ul>
-    <ul class="sections">
-          <li id="title">
-              <div class="annotation">
-                  <h1>response_error.rb</h1>
-              </div>
-          </li>
-        <li id="section-1">
-            <div class="annotation">
-              <div class="pilwrap for-h2">
-                <a class="pilcrow" href="#section-1">&#182;</a>
-              </div>
-              <h2>Response Error</h2>
-<p>If the response whilst fetching a resource is a 4xx or 5xx, Bcx will raise a <code>Bcx::ResponseError</code> exception.</p>
-<p>Examples:</p>
-<pre><code>client.projects.create!(<span class="symbol">name:</span> <span class="string">''</span>)
-=&gt; <span class="constant">Bcx::ResponseError</span><span class="symbol">:</span> <span class="number">422</span> <span class="constant">POST</span> <span class="symbol">https:</span>/<span class="regexp">/basecamp.com/</span><span class="number">2274488</span>/api/v1/projects.json | <span class="constant">Errors</span><span class="symbol">:</span> name can<span class="string">'t be blank</code></pre>
-<p>You can rescue this exception to grab the status, method, URL and errors individually.</p>
-<pre><code><span class="keyword">begin</span>
-  client.projects.create!(<span class="symbol">name:</span> <span class="string">''</span>)
-<span class="keyword">rescue</span> <span class="constant">Bcx::ResponseError</span> =&gt; response
-  response.method <span class="comment"># =&gt; "POST"</span>
-  response.status <span class="comment"># =&gt; 422</span>
-  response.url <span class="comment"># =&gt; "https://basecamp.com/2274488/api/v1/projects.json"</span>
-  response.errors <span class="comment"># =&gt; ["name can't be blank"]</span>
-<span class="keyword">end</span></code></pre>
-            </div>
-            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
-  <span class="class"><span class="keyword">class</span> <span class="title">ResponseError</span> <span class="inheritance">&lt; <span class="parent">Rapidash::ResponseError</span></span></span>
-    <span class="function"><span class="keyword">def</span> <span class="title">errors</span></span>
-      <span class="keyword">return</span> body <span class="keyword">if</span> body.kind_of?(<span class="constant">String</span>)
-      messages = []
-      body.each_pair <span class="keyword">do</span> |attribute, msgs|
-        msgs.each { |msg| messages.push <span class="string">"<span class="subst">#{attribute}</span> <span class="subst">#{msg}</span>"</span> }
-      <span class="keyword">end</span>
-      messages.join(<span class="string">', '</span>)
-    <span class="keyword">end</span>
-  <span class="keyword">end</span>
-<span class="keyword">end</span></pre></div></div>
-        </li>
-    </ul>
-  </div>
-</body>
-</html>

data/docs/lib/bcx/version.html DELETED Viewed

@@ -1,68 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>version.rb</title>
-  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
-  <link rel="stylesheet" media="all" href="../../docco.css" />
-</head>
-<body>
-  <div id="container">
-    <div id="background"></div>
-      <ul id="jump_to">
-        <li>
-          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
-          <a class="small" href="javascript:void(0);">+</a>
-          <div id="jump_wrapper">
-          <div id="jump_page">
-              <a class="source" href="configuration.html">
-                lib/bcx/configuration.rb
-              </a>
-              <a class="source" href="response_error.html">
-                lib/bcx/response_error.rb
-              </a>
-              <a class="source" href="version.html">
-                lib/bcx/version.rb
-              </a>
-          </div>
-        </li>
-      </ul>
-    <ul class="sections">
-          <li id="title">
-              <div class="annotation">
-                  <h1>version.rb</h1>
-              </div>
-          </li>
-        <li id="section-1">
-            <div class="annotation">
-              <div class="pilwrap ">
-                <a class="pilcrow" href="#section-1">&#182;</a>
-              </div>
-            </div>
-            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
-  <span class="constant">VERSION</span> = <span class="string">"0.2.1"</span>
-<span class="keyword">end</span></pre></div></div>
-        </li>
-    </ul>
-  </div>
-</body>
-</html>