PageRenderTime 61ms CodeModel.GetById 25ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/backbone-github.html

https://github.com/foresthz/backbone-github
HTML | 368 lines | 339 code | 29 blank | 0 comment | 0 complexity | 4069070404fd83e6901f9e35530ceb6e MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html;charset=utf-8">
    5. 

  5.   <title>backbone-github.coffee</title>
    6. 

  6.   <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <div id='container'>
    10. 

  10.   <div id="background"></div>
    11. 

  11.   <table cellspacing=0 cellpadding=0>
    12. 

  12.   <thead>
    13. 

  13.     <tr>
    14. 

  14.       <th class=docs><h1>backbone-github.coffee</h1></th>
    15. 

  15.       <th class=code></th>
    16. 

  16.     </tr>
    17. 

  17.   </thead>
    18. 

  18.   <tbody>
    19. 

  19.     <tr id='section-Dependencies'>
    20. 

  20.       <td class=docs>
    21. 

  21.         <div class="pilwrap">
    22. 

  22.           <a class="pilcrow" href="#section-Dependencies">&#182;</a>
    23. 

  23.         </div>
    24. 

  24.         <p>Backbone GitHub is a library that connects to the <a href="http://developer.github.com">GitHub
    25. 

  25. API</a> using Cross Origin Resource 
    26. 

  26. Sharing (CORS). That means that you can utilize this library 
    27. 

  27. to access the full GitHub API without any server-side code 
    28. 

  28. whatsoever.</p>
    29. 

  29. 

  30. <h2>Dependencies</h2>
    31. 

  31. 

  32. <p>Backbone GitHub depends on Backbone, so before you can use
    33. 

  33. this library you will need to have included Backbone, 
    34. 

  34. Underscore, and jQuery on the page.</p>
    35. 

  35.       </td>
    36. 

  36.       <td class=code>
    37. 

  37.         <div class='highlight'><pre><span class="nb">window</span><span class="p">.</span><span class="nx">GitHub</span> <span class="o">=</span> <span class="p">{}</span></pre></div>
    38. 

  38.       </td>
    39. 

  39.     </tr>
    40. 

  40.     <tr id='section-GitHub.token'>
    41. 

  41.       <td class=docs>
    42. 

  42.         <div class="pilwrap">
    43. 

  43.           <a class="pilcrow" href="#section-GitHub.token">&#182;</a>
    44. 

  44.         </div>
    45. 

  45.         <h2>GitHub.token</h2>
    46. 

  46. 

  47. <p>If <code>GitHub.token</code> is set you will be able to make 
    48. 

  48. user-authenticated calls to the GitHub API.</p>
    49. 

  49.       </td>
    50. 

  50.       <td class=code>
    51. 

  51.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">token</span> <span class="o">=</span> <span class="kc">null</span></pre></div>
    52. 

  52.       </td>
    53. 

  53.     </tr>
    54. 

  54.     <tr id='section-GitHub.authenticate(username,_password,_options)'>
    55. 

  55.       <td class=docs>
    56. 

  56.         <div class="pilwrap">
    57. 

  57.           <a class="pilcrow" href="#section-GitHub.authenticate(username,_password,_options)">&#182;</a>
    58. 

  58.         </div>
    59. 

  59.         <h2>GitHub.authenticate(username, password, options)</h2>
    60. 

  60. 

  61. <p>Authenticate with GitHub via username and password. This 
    62. 

  62. method will automatically set <code>GitHub.token</code>, which allows
    63. 

  63. you to make authenticated calls to the GitHub API.</p>
    64. 

  64. 

  65. <p>Note that this will authenticate the user with a generic
    66. 

  66. &ldquo;GitHub API&rdquo; application. In order to have an app-specific
    67. 

  67. token you need to use the redirect flow. Available options:</p>
    68. 

  68. 

  69. <ul>
    70. 

  70. <li><strong>success:</strong> a callback function that takes arguments
    71. 

  71. <code>data</code>, <code>textStatus</code>, and <code>jqXHR</code> (standard jQuery
    72. 

  72. success callback)</li>
    73. 

  73. <li><strong>error:</strong> a callback function that takes arguments
    74. 

  74. <code>jqXHR</code>, <code>textStatus</code>, and <code>errorThrown</code></li>
    75. 

  75. <li><strong>scope:</strong> provide comma-separated scopes. For example,
    76. 

  76. <code>repo,user</code></li>
    77. 

  77. </ul>
    78. 

  78.       </td>
    79. 

  79.       <td class=code>
    80. 

  80.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">authenticate</span> <span class="o">=</span> <span class="p">(</span><span class="nx">username</span><span class="p">,</span> <span class="nx">password</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    81. 

  81.   <span class="nx">postData</span> <span class="o">=</span> <span class="p">{}</span>
    82. 

  82.   <span class="nx">postData</span><span class="p">.</span><span class="nx">scope</span> <span class="o">=</span> <span class="nx">options</span><span class="p">.</span><span class="nx">scope</span> <span class="k">if</span> <span class="nx">options</span><span class="p">.</span><span class="nx">scope</span><span class="o">?</span>
    83. 

  83. 

  84.   <span class="nx">$</span><span class="p">.</span><span class="nx">ajax</span>
    85. 

  85.     <span class="nv">url: </span><span class="s2">&quot;https://api.github.com/authorizations&quot;</span>
    86. 

  86.     <span class="nv">contentType: </span><span class="s1">&#39;application/json&#39;</span>
    87. 

  87.     <span class="nv">dataType: </span><span class="s1">&#39;json&#39;</span>
    88. 

  88.     <span class="nv">type: </span><span class="s1">&#39;POST&#39;</span>
    89. 

  89.     <span class="nv">data: </span><span class="nx">JSON</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">postData</span><span class="p">)</span>
    90. 

  90.     <span class="nv">headers:</span>
    91. 

  91.       <span class="s1">&#39;Authorization&#39;</span><span class="o">:</span> <span class="s2">&quot;Basic #{btoa(&quot;</span><span class="c1">#{username}:#{password}&quot;)}&quot;</span>
    92. 

  92.     <span class="nv">success: </span><span class="p">(</span><span class="nx">d</span><span class="p">,</span><span class="nx">s</span><span class="p">,</span><span class="nx">x</span><span class="p">)</span><span class="o">-&gt;</span>
    93. 

  93.       <span class="nx">GitHub</span><span class="p">.</span><span class="nx">token</span> <span class="o">=</span> <span class="nx">d</span><span class="p">.</span><span class="nx">token</span>
    94. 

  94.       <span class="nx">options</span><span class="p">.</span><span class="nx">success</span><span class="p">(</span><span class="nx">d</span><span class="p">,</span><span class="nx">s</span><span class="p">,</span><span class="nx">x</span><span class="p">)</span> <span class="k">if</span> <span class="nx">options</span><span class="p">.</span><span class="nx">success</span><span class="o">?</span>
    95. 

  95.     <span class="nv">error: </span><span class="nx">options</span><span class="p">.</span><span class="nx">error</span></pre></div>
    96. 

  96.       </td>
    97. 

  97.     </tr>
    98. 

  98.     <tr id='section-GitHub.sync'>
    99. 

  99.       <td class=docs>
    100. 

  100.         <div class="pilwrap">
    101. 

  101.           <a class="pilcrow" href="#section-GitHub.sync">&#182;</a>
    102. 

  102.         </div>
    103. 

  103.         <h2>GitHub.sync</h2>
    104. 

  104. 

  105. <p>The GitHub sync method is simply a customized version of the
    106. 

  106. default Backbone sync mechanism with two improved properties:</p>
    107. 

  107. 

  108. <ol>
    109. 

  109. <li>It automatically sets an Accept header compatible with the
    110. 

  110. GitHub v3 API.</li>
    111. 

  111. <li>It sets the OAuth 2.0 Authorization header if <code>GitHub.token</code>
    112. 

  112. exists.</li>
    113. 

  113. </ol>
    114. 

  114.       </td>
    115. 

  115.       <td class=code>
    116. 

  116.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">sync</span> <span class="o">=</span> <span class="p">(</span><span class="nx">method</span><span class="p">,</span> <span class="nx">model</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    117. 

  117.   <span class="nx">extendedOptions</span> <span class="o">=</span> <span class="nx">_</span><span class="p">.</span><span class="nx">extend</span> <span class="p">{</span>
    118. 

  118.     <span class="nv">beforeSend: </span><span class="p">(</span><span class="nx">xhr</span><span class="p">)</span><span class="o">-&gt;</span>
    119. 

  119.       <span class="nx">xhr</span><span class="p">.</span><span class="nx">setRequestHeader</span> <span class="s1">&#39;Accept&#39;</span><span class="p">,</span> <span class="s1">&#39;application/vnd.github+json&#39;</span>
    120. 

  120.       <span class="nx">xhr</span><span class="p">.</span><span class="nx">setRequestHeader</span> <span class="s1">&#39;Authorization&#39;</span><span class="p">,</span> <span class="s2">&quot;bearer #{GitHub.token}&quot;</span> <span class="k">if</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">token</span>
    121. 

  121.   <span class="p">},</span> <span class="nx">options</span>
    122. 

  122.   <span class="nx">Backbone</span><span class="p">.</span><span class="nx">sync</span><span class="p">(</span><span class="nx">method</span><span class="p">,</span> <span class="nx">model</span><span class="p">,</span> <span class="nx">extendedOptions</span><span class="p">)</span>
    123. 

  123. 

  124. <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Model</span> <span class="o">=</span> <span class="nx">Backbone</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span>
    125. 

  125.   <span class="nv">sync: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">sync</span>
    126. 

  126. 

  127. <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Collection</span> <span class="o">=</span> <span class="nx">Backbone</span><span class="p">.</span><span class="nx">Collection</span><span class="p">.</span><span class="nx">extend</span>
    128. 

  128.   <span class="nv">sync: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">sync</span>
    129. 

  129. 

  130. <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Relations</span> <span class="o">=</span>
    131. 

  131.   <span class="nv">ownedRepos: </span><span class="p">(</span><span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    132. 

  132.     <span class="nx">repos</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Repos</span>
    133. 

  133.     <span class="nx">repos</span><span class="p">.</span><span class="nx">url</span> <span class="o">=</span> <span class="k">if</span> <span class="k">typeof</span> <span class="err">@</span><span class="nx">url</span> <span class="o">==</span> <span class="s2">&quot;function&quot;</span> <span class="k">then</span> <span class="err">@</span><span class="nx">url</span><span class="p">()</span> <span class="k">else</span> <span class="err">@</span><span class="nx">url</span>
    134. 

  134.     <span class="nx">repos</span><span class="p">.</span><span class="nx">url</span> <span class="o">+=</span> <span class="s2">&quot;/repos&quot;</span>
    135. 

  135.     <span class="nx">repos</span><span class="p">.</span><span class="nx">fetch</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span>
    136. 

  136.     <span class="nx">repos</span>
    137. 

  137.   <span class="nv">ownedOrgs: </span><span class="p">(</span><span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    138. 

  138.     <span class="nx">orgs</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Organizations</span>
    139. 

  139.     <span class="nx">orgs</span><span class="p">.</span><span class="nx">url</span> <span class="o">=</span> <span class="k">if</span> <span class="k">typeof</span> <span class="err">@</span><span class="nx">url</span> <span class="o">==</span> <span class="s2">&quot;function&quot;</span> <span class="k">then</span> <span class="err">@</span><span class="nx">url</span><span class="p">()</span> <span class="k">else</span> <span class="err">@</span><span class="nx">url</span>
    140. 

  140.     <span class="nx">orgs</span><span class="p">.</span><span class="nx">url</span> <span class="o">+=</span> <span class="s2">&quot;/orgs&quot;</span>
    141. 

  141.     <span class="nx">orgs</span><span class="p">.</span><span class="nx">fetch</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span>
    142. 

  142.     <span class="nx">orgs</span></pre></div>
    143. 

  143.       </td>
    144. 

  144.     </tr>
    145. 

  145.     <tr id='section-GitHub.User'>
    146. 

  146.       <td class=docs>
    147. 

  147.         <div class="pilwrap">
    148. 

  148.           <a class="pilcrow" href="#section-GitHub.User">&#182;</a>
    149. 

  149.         </div>
    150. 

  150.         <h2>GitHub.User</h2>
    151. 

  151. 

  152. <p>The GitHub User model. For information about specific attributes
    153. 

  153. that are available on this model, see GitHub&rsquo;s <a href="http://developer.github.com/v3/users/">Users API</a>
    154. 

  154. documentation.</p>
    155. 

  155.       </td>
    156. 

  156.       <td class=code>
    157. 

  157.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">User</span> <span class="o">=</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span>
    158. 

  158.   <span class="nv">urlRoot: </span><span class="s1">&#39;https://api.github.com/users/&#39;</span></pre></div>
    159. 

  159.       </td>
    160. 

  160.     </tr>
    161. 

  161.     <tr id='section-user.repos(options)'>
    162. 

  162.       <td class=docs>
    163. 

  163.         <div class="pilwrap">
    164. 

  164.           <a class="pilcrow" href="#section-user.repos(options)">&#182;</a>
    165. 

  165.         </div>
    166. 

  166.         <h3>user.repos(options)</h3>
    167. 

  167. 

  168. <p>Fetch associated repositories for this user. Takes
    169. 

  169. a <code>success</code> and <code>error</code> callback as potential options.
    170. 

  170. Returns a <code>GitHub.Repos</code> collection.</p>
    171. 

  171.       </td>
    172. 

  172.       <td class=code>
    173. 

  173.         <div class='highlight'><pre>  <span class="nv">repos: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Relations</span><span class="p">.</span><span class="nx">ownedRepos</span></pre></div>
    174. 

  174.       </td>
    175. 

  175.     </tr>
    176. 

  176.     <tr id='section-user.organizations(options)'>
    177. 

  177.       <td class=docs>
    178. 

  178.         <div class="pilwrap">
    179. 

  179.           <a class="pilcrow" href="#section-user.organizations(options)">&#182;</a>
    180. 

  180.         </div>
    181. 

  181.         <h3>user.organizations(options)</h3>
    182. 

  182. 

  183. <p>Fetch associated organizations for this user. Takes
    184. 

  184. a <code>success</code> and <code>error</code> callback as potential options.</p>
    185. 

  185.       </td>
    186. 

  186.       <td class=code>
    187. 

  187.         <div class='highlight'><pre>  <span class="nv">organizations: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Relations</span><span class="p">.</span><span class="nx">ownedOrgs</span>
    188. 

  188. <span class="p">,</span></pre></div>
    189. 

  189.       </td>
    190. 

  190.     </tr>
    191. 

  191.     <tr id='section-GitHub.User.fetch(name,_options)'>
    192. 

  192.       <td class=docs>
    193. 

  193.         <div class="pilwrap">
    194. 

  194.           <a class="pilcrow" href="#section-GitHub.User.fetch(name,_options)">&#182;</a>
    195. 

  195.         </div>
    196. 

  196.         <h3>GitHub.User.fetch(name, options)</h3>
    197. 

  197. 

  198. <p>Retrieve a user by username. Takes <code>success</code> and
    199. 

  199. <code>error</code> callbacks.</p>
    200. 

  200. 

  201. <pre><code>GitHub.User.fetch(&lsquo;mbleigh&rsquo;, {success: function(u){
    202. 

  202.   console.log(u.toJSON());
    203. 

  203. }});
    204. 

  204. </code></pre>
    205. 

  205.       </td>
    206. 

  206.       <td class=code>
    207. 

  207.         <div class='highlight'><pre>  <span class="nv">fetch: </span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    208. 

  208.     <span class="nx">user</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">User</span><span class="p">(</span><span class="nv">id: </span><span class="nx">name</span><span class="p">)</span>
    209. 

  209.     <span class="nx">user</span><span class="p">.</span><span class="nx">fetch</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span>
    210. 

  210.     <span class="nx">user</span>
    211. 

  211. <span class="p">)</span></pre></div>
    212. 

  212.       </td>
    213. 

  213.     </tr>
    214. 

  214.     <tr id='section-GitHub.Organization'>
    215. 

  215.       <td class=docs>
    216. 

  216.         <div class="pilwrap">
    217. 

  217.           <a class="pilcrow" href="#section-GitHub.Organization">&#182;</a>
    218. 

  218.         </div>
    219. 

  219.         <h2>GitHub.Organization</h2>
    220. 

  220. 

  221. <p>Represents a GitHub organization. See the <a href="http://developer.github.com/v3/orgs/">Organization
    222. 

  222. API</a> docs on GitHub
    223. 

  223. for additional information.</p>
    224. 

  224.       </td>
    225. 

  225.       <td class=code>
    226. 

  226.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Organization</span> <span class="o">=</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span>
    227. 

  227.   <span class="nv">urlRoot: </span><span class="s1">&#39;https://api.github.com/orgs/&#39;</span></pre></div>
    228. 

  228.       </td>
    229. 

  229.     </tr>
    230. 

  230.     <tr id='section-org.repos(options)'>
    231. 

  231.       <td class=docs>
    232. 

  232.         <div class="pilwrap">
    233. 

  233.           <a class="pilcrow" href="#section-org.repos(options)">&#182;</a>
    234. 

  234.         </div>
    235. 

  235.         <h3>org.repos(options)</h3>
    236. 

  236. 

  237. <p>Fetch the repositories for the instantiated organization.
    238. 

  238. Takes <code>success</code> and <code>error</code> callbacks. Returns a
    239. 

  239. <code>GitHub.Repos</code> collection.</p>
    240. 

  240.       </td>
    241. 

  241.       <td class=code>
    242. 

  242.         <div class='highlight'><pre>  <span class="nv">repos: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Relations</span><span class="p">.</span><span class="nx">ownedRepos</span>
    243. 

  243. <span class="p">,</span></pre></div>
    244. 

  244.       </td>
    245. 

  245.     </tr>
    246. 

  246.     <tr id='section-GitHub.Organization.fetch(name,_options)'>
    247. 

  247.       <td class=docs>
    248. 

  248.         <div class="pilwrap">
    249. 

  249.           <a class="pilcrow" href="#section-GitHub.Organization.fetch(name,_options)">&#182;</a>
    250. 

  250.         </div>
    251. 

  251.         <h3>GitHub.Organization.fetch(name, options)</h3>
    252. 

  252. 

  253. <p>Fetch an organization by name. Accepts <code>success</code>
    254. 

  254. and <code>error</code> callbacks.</p>
    255. 

  255. 

  256. <pre><code>GitHub.Organization.fetch(&lsquo;opperator&rsquo;, {success: function(o){
    257. 

  257.   console.log(o.toJSON());
    258. 

  258. }});
    259. 

  259. </code></pre>
    260. 

  260.       </td>
    261. 

  261.       <td class=code>
    262. 

  262.         <div class='highlight'><pre>  <span class="nv">fetch: </span><span class="p">(</span><span class="nx">name</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    263. 

  263.     <span class="nx">org</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Organization</span><span class="p">(</span><span class="nv">id: </span><span class="nx">name</span><span class="p">)</span>
    264. 

  264.     <span class="nx">org</span><span class="p">.</span><span class="nx">fetch</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span>
    265. 

  265.     <span class="nx">org</span>
    266. 

  266. <span class="p">)</span></pre></div>
    267. 

  267.       </td>
    268. 

  268.     </tr>
    269. 

  269.     <tr id='section-GitHub.Organizations'>
    270. 

  270.       <td class=docs>
    271. 

  271.         <div class="pilwrap">
    272. 

  272.           <a class="pilcrow" href="#section-GitHub.Organizations">&#182;</a>
    273. 

  273.         </div>
    274. 

  274.         <h2>GitHub.Organizations</h2>
    275. 

  275. 

  276. <p>Collection of multiple organizations. By default will
    277. 

  277. be associated to the current user&rsquo;s organizations (you
    278. 

  278. must set an <code>GitHub.token</code> for that to work.)</p>
    279. 

  279.       </td>
    280. 

  280.       <td class=code>
    281. 

  281.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Organizations</span> <span class="o">=</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Collection</span><span class="p">.</span><span class="nx">extend</span>
    282. 

  282.   <span class="nv">url: </span><span class="s1">&#39;https://api.github.com/user/orgs&#39;</span>
    283. 

  283.   <span class="nv">model: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Organization</span></pre></div>
    284. 

  284.       </td>
    285. 

  285.     </tr>
    286. 

  286.     <tr id='section-GitHub.Repo'>
    287. 

  287.       <td class=docs>
    288. 

  288.         <div class="pilwrap">
    289. 

  289.           <a class="pilcrow" href="#section-GitHub.Repo">&#182;</a>
    290. 

  290.         </div>
    291. 

  291.         <h2>GitHub.Repo</h2>
    292. 

  292. 

  293. <p>Repository model. For more information about attributes
    294. 

  294. etc, see the <a href="http://developer.github.com/v3/repos/">GitHub Repo</a>
    295. 

  295. API docs.</p>
    296. 

  296.       </td>
    297. 

  297.       <td class=code>
    298. 

  298.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Repo</span> <span class="o">=</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Model</span><span class="p">.</span><span class="nx">extend</span><span class="p">(</span>
    299. 

  299.   <span class="nv">url: </span><span class="p">()</span><span class="o">-&gt;</span>
    300. 

  300.     <span class="err">@</span><span class="nx">get</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">)</span> <span class="o">||</span> <span class="s2">&quot;https://api.github.com/repos/#{@get(&#39;path&#39;)}&quot;</span>
    301. 

  301. <span class="p">,</span></pre></div>
    302. 

  302.       </td>
    303. 

  303.     </tr>
    304. 

  304.     <tr id='section-GitHub.Repo.fetch(owner,_name,_options)'>
    305. 

  305.       <td class=docs>
    306. 

  306.         <div class="pilwrap">
    307. 

  307.           <a class="pilcrow" href="#section-GitHub.Repo.fetch(owner,_name,_options)">&#182;</a>
    308. 

  308.         </div>
    309. 

  309.         <h3>GitHub.Repo.fetch(owner, name, options)</h3>
    310. 

  310. 

  311. <p>Retrieve a repository knowing its owner and name. Takes
    312. 

  312. <code>success</code> and <code>error</code> callbacks in options.</p>
    313. 

  313. 

  314. <pre><code>GitHub.Repo.fetch(&lsquo;opperator&rsquo;, &lsquo;backbone-github&rsquo;, {success: function&reg;{
    315. 

  315.   console.log(r.toJSON());
    316. 

  316. }});
    317. 

  317. </code></pre>
    318. 

  318.       </td>
    319. 

  319.       <td class=code>
    320. 

  320.         <div class='highlight'><pre>  <span class="nv">fetch: </span><span class="p">(</span><span class="nx">owner</span><span class="p">,</span> <span class="nx">name</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span><span class="o">-&gt;</span>
    321. 

  321.     <span class="nx">repo</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Repo</span><span class="p">(</span><span class="nv">path: </span><span class="s2">&quot;#{owner}/#{name}&quot;</span><span class="p">)</span>
    322. 

  322.     <span class="nx">repo</span><span class="p">.</span><span class="nx">fetch</span><span class="p">(</span><span class="nx">options</span><span class="p">)</span>
    323. 

  323.     <span class="nx">repo</span>
    324. 

  324. <span class="p">)</span></pre></div>
    325. 

  325.       </td>
    326. 

  326.     </tr>
    327. 

  327.     <tr id='section-GitHub.Repos'>
    328. 

  328.       <td class=docs>
    329. 

  329.         <div class="pilwrap">
    330. 

  330.           <a class="pilcrow" href="#section-GitHub.Repos">&#182;</a>
    331. 

  331.         </div>
    332. 

  332.         <h2>GitHub.Repos</h2>
    333. 

  333. 

  334. <p>Collection of Repo models. Defaults to the current user&rsquo;s
    335. 

  335. repositories. Must have set <code>GitHub.token</code> for current
    336. 

  336. user repo fetch to be successful.</p>
    337. 

  337.       </td>
    338. 

  338.       <td class=code>
    339. 

  339.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Repos</span> <span class="o">=</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">Collection</span><span class="p">.</span><span class="nx">extend</span>
    340. 

  340.   <span class="nv">url: </span><span class="s1">&#39;https://api.github.com/user/repos&#39;</span>
    341. 

  341.   <span class="nv">model: </span><span class="nx">GitHub</span><span class="p">.</span><span class="nx">Repo</span></pre></div>
    342. 

  342.       </td>
    343. 

  343.     </tr>
    344. 

  344.     <tr id='section-GitHub.currentUser'>
    345. 

  345.       <td class=docs>
    346. 

  346.         <div class="pilwrap">
    347. 

  347.           <a class="pilcrow" href="#section-GitHub.currentUser">&#182;</a>
    348. 

  348.         </div>
    349. 

  349.         <h2>GitHub.currentUser</h2>
    350. 

  350. 

  351. <p>A <code>GitHub.User</code> corresponding to the authenticated user.
    352. 

  352. Note that you must set <code>GitHub.token</code> to a valid OAuth 2.0
    353. 

  353. token to be able to utilize the current user.</p>
    354. 

  354. 

  355. <p>The <code>currentUser</code> is not fetched by default, you must run
    356. 

  356. <code>GitHub.currentUser.fetch()</code> before it will be populated
    357. 

  357. with data.</p>
    358. 

  358. 

  359.       </td>
    360. 

  360.       <td class=code>
    361. 

  361.         <div class='highlight'><pre><span class="nx">GitHub</span><span class="p">.</span><span class="nx">currentUser</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">GitHub</span><span class="p">.</span><span class="nx">User</span><span class="p">()</span>
    362. 

  362. <span class="nx">GitHub</span><span class="p">.</span><span class="nx">currentUser</span><span class="p">.</span><span class="nx">url</span> <span class="o">=</span> <span class="s2">&quot;https://api.github.com/user&quot;</span>
    363. 

  363. <span class="nx">GitHub</span><span class="p">.</span><span class="nx">currentUser</span><span class="p">.</span><span class="nx">urlRoot</span> <span class="o">=</span> <span class="kc">null</span></pre></div>
    364. 

  364.       </td>
    365. 

  365.     </tr>
    366. 

  366.   </table>
    367. 

  367. </div>
    368. 

  368. </body>
    369. 

  369.