doc/Trello.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Trello
— Documentation by YARD 0.9.25
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Trello";
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 (T)</a> »
<span class="title">Trello</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: Trello
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/trello.rb<span class="defines">,<br />
lib/trello/net.rb,<br /> lib/trello/card.rb,<br /> lib/trello/item.rb,<br /> lib/trello/list.rb,<br /> lib/trello/board.rb,<br /> lib/trello/error.rb,<br /> lib/trello/label.rb,<br /> lib/trello/token.rb,<br /> lib/trello/action.rb,<br /> lib/trello/client.rb,<br /> lib/trello/member.rb,<br /> lib/trello/schema.rb,<br /> lib/trello/comment.rb,<br /> lib/trello/webhook.rb,<br /> lib/trello/checklist.rb,<br /> lib/trello/attachment.rb,<br /> lib/trello/basic_data.rb,<br /> lib/trello/item_state.rb,<br /> lib/trello/json_utils.rb,<br /> lib/trello/label_name.rb,<br /> lib/trello/association.rb,<br /> lib/trello/cover_image.rb,<br /> lib/trello/has_actions.rb,<br /> lib/trello/custom_field.rb,<br /> lib/trello/notification.rb,<br /> lib/trello/organization.rb,<br /> lib/trello/plugin_datum.rb,<br /> lib/trello/authorization.rb,<br /> lib/trello/configuration.rb,<br /> lib/trello/association_proxy.rb,<br /> lib/trello/custom_field_item.rb,<br /> lib/trello/multi_association.rb,<br /> lib/trello/custom_field_option.rb,<br /> lib/trello/schema/attribute/base.rb,<br /> lib/trello/association_infer_tool.rb,<br /> lib/trello/schema/serializer/time.rb,<br /> lib/trello/schema/attribute/default.rb,<br /> lib/trello/schema/attribute_builder.rb,<br /> lib/trello/schema/serializer/labels.rb,<br /> lib/trello/schema/serializer/default.rb,<br /> lib/trello/schema/serializer/webhooks.rb,<br /> lib/trello/association_builder/has_one.rb,<br /> lib/trello/association_fetcher/has_one.rb,<br /> lib/trello/schema/attribute/board_pref.rb,<br /> lib/trello/association_builder/has_many.rb,<br /> lib/trello/association_fetcher/has_many.rb,<br /> lib/trello/schema/attribute_registration.rb,<br /> lib/trello/association_fetcher/has_one/fetch.rb,<br /> lib/trello/association_fetcher/has_many/fetch.rb,<br /> lib/trello/association_fetcher/has_one/params.rb,<br /> lib/trello/association_fetcher/has_many/params.rb,<br /> lib/trello/schema/attribute/custom_field_display.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Ruby wrapper around the [Trello] API</p>
<p>First, set up your key information. You can get this information by [clicking <a href="trello-app-key">here]</a>.</p>
<p>You can get the key by going to this url in your browser: <a href="https://trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never">trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never</a> Only request the permissions you need; i.e., scope=read if you only need read, or scope=write if you only need write. Comma separate scopes you need. If you want your token to expire after 30 days, drop the &expiration=never. Then run the following code, where KEY denotes the key returned from the url above:</p>
<p>Trello.configure do |config|</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_consumer_key'>consumer_key</span> <span class='op'>=</span> <span class='const'>TRELLO_CONSUMER_KEY</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_consumer_secret'>consumer_secret</span> <span class='op'>=</span> <span class='const'>TRELLO_CONSUMER_SECRET</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_oauth_token'>oauth_token</span> <span class='op'>=</span> <span class='const'>TRELLO_OAUTH_TOKEN</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_oauth_token_secret'>oauth_token_secret</span> <span class='op'>=</span> <span class='const'>TRELLO_OAUTH_TOKEN_SECRET</span>
</code></pre>
<p>end</p>
<p>All the calls this library make to Trello require authentication using these keys. Be sure to protect them.</p>
<p>So lets say you want to get information about the user <strong>bobtester</strong>. We can do something like this:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bob'>bob</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Trello/Member.html" title="Trello::Member (class)">Member</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="Trello/Member.html#find-class_method" title="Trello::Member.find (method)">find</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bobtester</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='comment'># Print out his name
</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_bob'>bob</span><span class='period'>.</span><span class='id identifier rubyid_full_name'>full_name</span> <span class='comment'># "Bob Tester"
</span><span class='comment'># Print his bio
</span><span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_bob'>bob</span><span class='period'>.</span><span class='id identifier rubyid_bio'>bio</span> <span class='comment'># A wonderfully delightful test user
</span><span class='comment'># How about a list of his boards?
</span><span class='id identifier rubyid_bob'>bob</span><span class='period'>.</span><span class='id identifier rubyid_boards'>boards</span>
</code></pre>
<p>And so much more. Consult the rest of the documentation for more information.</p>
<p>Feel free to [peruse and participate in our Trello <a href="ruby-trello-board">board]</a>. It's completely open to the public.</p>
<p>[trello]: <a href="http://trello.com">trello.com</a> [trello-app-key]: <a href="https://trello.com/app-key">trello.com/app-key</a> [ruby-trello-board]: <a href="https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd">trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd</a></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="Trello/AssociationBuilder.html" title="Trello::AssociationBuilder (module)">AssociationBuilder</a></span>, <span class='object_link'><a href="Trello/AssociationFetcher.html" title="Trello::AssociationFetcher (module)">AssociationFetcher</a></span>, <span class='object_link'><a href="Trello/Authorization.html" title="Trello::Authorization (module)">Authorization</a></span>, <span class='object_link'><a href="Trello/HasActions.html" title="Trello::HasActions (module)">HasActions</a></span>, <span class='object_link'><a href="Trello/JsonUtils.html" title="Trello::JsonUtils (module)">JsonUtils</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Trello/Action.html" title="Trello::Action (class)">Action</a></span>, <span class='object_link'><a href="Trello/Association.html" title="Trello::Association (class)">Association</a></span>, <span class='object_link'><a href="Trello/AssociationInferTool.html" title="Trello::AssociationInferTool (class)">AssociationInferTool</a></span>, <span class='object_link'><a href="Trello/AssociationProxy.html" title="Trello::AssociationProxy (class)">AssociationProxy</a></span>, <span class='object_link'><a href="Trello/Attachment.html" title="Trello::Attachment (class)">Attachment</a></span>, <span class='object_link'><a href="Trello/BasicData.html" title="Trello::BasicData (class)">BasicData</a></span>, <span class='object_link'><a href="Trello/Board.html" title="Trello::Board (class)">Board</a></span>, <span class='object_link'><a href="Trello/Card.html" title="Trello::Card (class)">Card</a></span>, <span class='object_link'><a href="Trello/CheckItemState.html" title="Trello::CheckItemState (class)">CheckItemState</a></span>, <span class='object_link'><a href="Trello/Checklist.html" title="Trello::Checklist (class)">Checklist</a></span>, <span class='object_link'><a href="Trello/Client.html" title="Trello::Client (class)">Client</a></span>, <span class='object_link'><a href="Trello/Comment.html" title="Trello::Comment (class)">Comment</a></span>, <span class='object_link'><a href="Trello/Configuration.html" title="Trello::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Trello/CoverImage.html" title="Trello::CoverImage (class)">CoverImage</a></span>, <span class='object_link'><a href="Trello/CustomField.html" title="Trello::CustomField (class)">CustomField</a></span>, <span class='object_link'><a href="Trello/CustomFieldItem.html" title="Trello::CustomFieldItem (class)">CustomFieldItem</a></span>, <span class='object_link'><a href="Trello/CustomFieldOption.html" title="Trello::CustomFieldOption (class)">CustomFieldOption</a></span>, <span class='object_link'><a href="Trello/Error.html" title="Trello::Error (class)">Error</a></span>, <span class='object_link'><a href="Trello/Item.html" title="Trello::Item (class)">Item</a></span>, <span class='object_link'><a href="Trello/Label.html" title="Trello::Label (class)">Label</a></span>, <span class='object_link'><a href="Trello/LabelName.html" title="Trello::LabelName (class)">LabelName</a></span>, <span class='object_link'><a href="Trello/List.html" title="Trello::List (class)">List</a></span>, <span class='object_link'><a href="Trello/Member.html" title="Trello::Member (class)">Member</a></span>, <span class='object_link'><a href="Trello/MultiAssociation.html" title="Trello::MultiAssociation (class)">MultiAssociation</a></span>, <span class='object_link'><a href="Trello/Notification.html" title="Trello::Notification (class)">Notification</a></span>, <span class='object_link'><a href="Trello/Organization.html" title="Trello::Organization (class)">Organization</a></span>, <span class='object_link'><a href="Trello/PluginDatum.html" title="Trello::PluginDatum (class)">PluginDatum</a></span>, <span class='object_link'><a href="Trello/Request.html" title="Trello::Request (class)">Request</a></span>, <span class='object_link'><a href="Trello/Response.html" title="Trello::Response (class)">Response</a></span>, <span class='object_link'><a href="Trello/Schema.html" title="Trello::Schema (class)">Schema</a></span>, <span class='object_link'><a href="Trello/TInternet.html" title="Trello::TInternet (class)">TInternet</a></span>, <span class='object_link'><a href="Trello/Token.html" title="Trello::Token (class)">Token</a></span>, <span class='object_link'><a href="Trello/Webhook.html" title="Trello::Webhook (class)">Webhook</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="API_VERSION-constant" class="">API_VERSION =
<div class="docstring">
<div class="discussion">
<p>Version of the Trello API that we use by default.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='int'>1</span></pre></dd>
<dt id="InvalidAccessToken-constant" class="">InvalidAccessToken =
<div class="docstring">
<div class="discussion">
<p>This specific error is thrown when your access token is invalid. You should get a new one.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Trello/Error.html" title="Trello::Error (class)">Error</a></span></span><span class='rparen'>)</span></pre></dd>
<dt id="ConfigurationError-constant" class="">ConfigurationError =
<div class="docstring">
<div class="discussion">
<p>This error is thrown when your client has not been configured</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Class</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Trello/Error.html" title="Trello::Error (class)">Error</a></span></span><span class='rparen'>)</span></pre></dd>
</dl>
<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="#auth_policy-class_method" title="auth_policy (class method)">.<strong>auth_policy</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#authorize_url-class_method" title="authorize_url (class method)">.<strong>authorize_url</strong>(options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Url to token for making authorized requests to the Trello API.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#client-class_method" title="client (class method)">.<strong>client</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configuration-class_method" title="configuration (class method)">.<strong>configuration</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong>(&block) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logger-class_method" title="logger (class method)">.<strong>logger</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#logger=-class_method" title="logger= (class method)">.<strong>logger=</strong>(logger) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#open_authorization_url-class_method" title="open_authorization_url (class method)">.<strong>open_authorization_url</strong>(options = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Visit the Trello authorized token page.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#open_public_key_url-class_method" title="open_public_key_url (class method)">.<strong>open_public_key_url</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Visit the Trello API public key page.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#open_url-class_method" title="open_url (class method)">.<strong>open_url</strong>(url) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#public_key_url-class_method" title="public_key_url (class method)">.<strong>public_key_url</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Url to Trello API public key page.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reset!-class_method" title="reset! (class method)">.<strong>reset!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="auth_policy-class_method">
.<strong>auth_policy</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 128</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_auth_policy'>auth_policy</span><span class='semicolon'>;</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_auth_policy'>auth_policy</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="authorize_url-class_method">
.<strong>authorize_url</strong>(options = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Url to token for making authorized requests to the Trello API</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>Repository information to update</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
<ul class="option">
<li>
<span class="name">:name</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>Name of the application</p>
</div>
</li>
<li>
<span class="name">:key</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>Application key</p>
</div>
</li>
<li>
<span class="name">:response_type</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>'token'</p>
</div>
</li>
<li>
<span class="name">:callback_method</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>'postMessage' or 'fragment'</p>
</div>
</li>
<li>
<span class="name">:return_url</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>URL the token should be returned to</p>
</div>
</li>
<li>
<span class="name">:scope</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>Comma-separated list of one or more of 'read', 'write', 'account'</p>
</div>
</li>
<li>
<span class="name">:expiration</span>
<span class="type">(<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>'1hour', '1day', '30days', 'never'</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://developers.trello.com/authorize" target="_parent" title="https://developers.trello.com/authorize">https://developers.trello.com/authorize</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
147
148
149
150
151
152
153
154
155
156
157
158</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 147</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:key</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_developer_public_key'>developer_public_key</span> <span class='kw'>or</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please configure your Trello public key</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Ruby Trello</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:scope</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>read,write,account</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:expiration</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>never</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:response_type</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>token</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='const'>Addressable</span><span class='op'>::</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://trello.com/1/authorize</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_uri'>uri</span><span class='period'>.</span><span class='id identifier rubyid_query_values'>query_values</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
<span class='id identifier rubyid_uri'>uri</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="client-class_method">
.<strong>client</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
115
116
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 115</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Trello/Client.html" title="Trello::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Trello/Client.html#initialize-instance_method" title="Trello::Client#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configuration-class_method">
.<strong>configuration</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 129</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='semicolon'>;</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="configure-class_method">
.<strong>configure</strong>(&block) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
119
120
121
122</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 119</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_reset!'>reset!</span>
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="logger-class_method">
.<strong>logger</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
107
108
109</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 107</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logger'>logger</span>
<span class='ivar'>@logger</span> <span class='op'>||=</span> <span class='const'>Logger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>STDOUT</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="logger=-class_method">
.<strong>logger=</strong>(logger) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
111
112
113</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 111</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_logger='>logger=</span><span class='lparen'>(</span><span class='id identifier rubyid_logger'>logger</span><span class='rparen'>)</span>
<span class='ivar'>@logger</span> <span class='op'>=</span> <span class='id identifier rubyid_logger'>logger</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="open_authorization_url-class_method">
.<strong>open_authorization_url</strong>(options = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Visit the Trello authorized token page</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://developers.trello.com/authorize" target="_parent" title="https://developers.trello.com/authorize">https://developers.trello.com/authorize</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
170
171
172</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 170</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open_authorization_url'>open_authorization_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_open_url'>open_url</span> <span class='id identifier rubyid_authorize_url'>authorize_url</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="open_public_key_url-class_method">
.<strong>open_public_key_url</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Visit the Trello API public key page</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://trello.com/app-key" target="_parent" title="https://trello.com/app-key">https://trello.com/app-key</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
163
164
165</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 163</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open_public_key_url'>open_public_key_url</span>
<span class='id identifier rubyid_open_url'>open_url</span> <span class='id identifier rubyid_public_key_url'>public_key_url</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="open_url-class_method">
.<strong>open_url</strong>(url) ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
175
176
177
178
179
180
181</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 175</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open_url'>open_url</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>launchy</span><span class='tstring_end'>'</span></span>
<span class='const'>Launchy</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>LoadError</span>
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Please install the launchy gem to open the url automatically.</span><span class='tstring_end'>'</span></span>
<span class='id identifier rubyid_url'>url</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="public_key_url-class_method">
.<strong>public_key_url</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Url to Trello API public key page</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
132
133
134</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 132</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_public_key_url'>public_key_url</span>
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://trello.com/app-key</span><span class='tstring_end'>'</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="reset!-class_method">
.<strong>reset!</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
124
125
126</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/trello.rb', line 124</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_reset!'>reset!</span>
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Tue Nov 10 16:31:45 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.6).
</div>
</div>
</body>
</html>