Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
Repository URL to install this package:
|
Version:
0.3.1custom ▾
|
<!DOCTYPE html>
<html>
<head>
<title>bcx.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 …</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="bcx/client/http.html">
lib/bcx/client/http.rb
</a>
<a class="source" href="bcx/client/oauth.html">
lib/bcx/client/oauth.rb
</a>
<a class="source" href="bcx/configuration.html">
lib/bcx/configuration.rb
</a>
<a class="source" href="bcx/launchpad/oauth.html">
lib/bcx/launchpad/oauth.rb
</a>
<a class="source" href="bcx/resources/access.html">
lib/bcx/resources/access.rb
</a>
<a class="source" href="bcx/resources/authorization.html">
lib/bcx/resources/authorization.rb
</a>
<a class="source" href="bcx/resources/person.html">
lib/bcx/resources/person.rb
</a>
<a class="source" href="bcx/resources/project.html">
lib/bcx/resources/project.rb
</a>
<a class="source" href="bcx/resources/todo.html">
lib/bcx/resources/todo.rb
</a>
<a class="source" href="bcx/resources/todolist.html">
lib/bcx/resources/todolist.rb
</a>
<a class="source" href="bcx/response_error.html">
lib/bcx/response_error.rb
</a>
<a class="source" href="bcx/version.html">
lib/bcx/version.rb
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>bcx.rb</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
</div>
<div class="content"><div class='highlight'><pre><span class="keyword">require</span> <span class="string">'rapidash'</span>
<span class="keyword">require</span> <span class="string">'bcx/version'</span></pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap for-h2">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<h2>Bcx</h2>
<p>Fully-fledged Ruby API wrapper for Basecamp Next</p>
<p>See the <a href="https://github.com/paulspringett/bcx#readme">README</a> for usage</p>
</div>
<div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
autoload <span class="symbol">:Configuration</span>, <span class="string">'bcx/configuration'</span>
<span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
autoload <span class="symbol">:Todo</span>, <span class="string">'bcx/resources/todo'</span>
autoload <span class="symbol">:Todolist</span>, <span class="string">'bcx/resources/todolist'</span>
autoload <span class="symbol">:Project</span>, <span class="string">'bcx/resources/project'</span>
autoload <span class="symbol">:Person</span>, <span class="string">'bcx/resources/person'</span>
autoload <span class="symbol">:Access</span>, <span class="string">'bcx/resources/access'</span>
autoload <span class="symbol">:Authorization</span>, <span class="string">'bcx/resources/authorization'</span>
<span class="keyword">end</span>
<span class="class"><span class="keyword">module</span> <span class="title">Client</span></span>
autoload <span class="symbol">:HTTP</span>, <span class="string">'bcx/client/http'</span>
autoload <span class="symbol">:OAuth</span>, <span class="string">'bcx/client/oauth'</span>
<span class="keyword">end</span>
<span class="class"><span class="keyword">module</span> <span class="title">Launchpad</span></span>
autoload <span class="symbol">:OAuth</span>, <span class="string">'bcx/launchpad/oauth'</span>
<span class="keyword">end</span>
<span class="class"><span class="keyword">class</span> <span class="inheritance"><</span><span class="inheritance">< <span class="parent">self</span></span></span>
attr_accessor <span class="symbol">:configuration</span>
<span class="keyword">end</span></pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<p>Expose configuration block</p>
</div>
<div class="content"><div class='highlight'><pre> <span class="function"><span class="keyword">def</span> <span class="title"><span class="keyword">self</span></span>.<span class="title">configure</span></span>
<span class="keyword">self</span>.configuration ||= <span class="constant">Configuration</span>.new
<span class="keyword">yield</span>(configuration)
<span class="keyword">end</span>
<span class="keyword">end</span></pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<p>Use custom <code>Bcx::ResponseError</code> on top of Rapidash's error handling</p>
</div>
<div class="content"><div class='highlight'><pre><span class="keyword">require</span> <span class="string">'bcx/response_error'</span>
<span class="constant">Rapidash</span>.response_exception_class = <span class="constant">Bcx::ResponseError</span></pre></div></div>
</li>
</ul>
</div>
</body>
</html>