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.
- 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
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>configuration.rb</title>
|
|
6
|
+
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
|
8
|
+
<link rel="stylesheet" media="all" href="docco.css" />
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<div id="container">
|
|
12
|
+
<div id="background"></div>
|
|
13
|
+
|
|
14
|
+
<ul id="jump_to">
|
|
15
|
+
<li>
|
|
16
|
+
<a class="large" href="javascript:void(0);">Jump To …</a>
|
|
17
|
+
<a class="small" href="javascript:void(0);">+</a>
|
|
18
|
+
<div id="jump_wrapper">
|
|
19
|
+
<div id="jump_page_wrapper">
|
|
20
|
+
<div id="jump_page">
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<a class="source" href="bcx.html">
|
|
24
|
+
bcx.rb
|
|
25
|
+
</a>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<a class="source" href="http.html">
|
|
29
|
+
http.rb
|
|
30
|
+
</a>
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
<a class="source" href="oauth.html">
|
|
34
|
+
oauth.rb
|
|
35
|
+
</a>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<a class="source" href="configuration.html">
|
|
39
|
+
configuration.rb
|
|
40
|
+
</a>
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
<a class="source" href="oauth.html">
|
|
44
|
+
oauth.rb
|
|
45
|
+
</a>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
<a class="source" href="access.html">
|
|
49
|
+
access.rb
|
|
50
|
+
</a>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<a class="source" href="authorization.html">
|
|
54
|
+
authorization.rb
|
|
55
|
+
</a>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<a class="source" href="comment.html">
|
|
59
|
+
comment.rb
|
|
60
|
+
</a>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<a class="source" href="person.html">
|
|
64
|
+
person.rb
|
|
65
|
+
</a>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<a class="source" href="project.html">
|
|
69
|
+
project.rb
|
|
70
|
+
</a>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<a class="source" href="todo.html">
|
|
74
|
+
todo.rb
|
|
75
|
+
</a>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<a class="source" href="todolist.html">
|
|
79
|
+
todolist.rb
|
|
80
|
+
</a>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<a class="source" href="response_error.html">
|
|
84
|
+
response_error.rb
|
|
85
|
+
</a>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<a class="source" href="version.html">
|
|
89
|
+
version.rb
|
|
90
|
+
</a>
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
</li>
|
|
95
|
+
</ul>
|
|
96
|
+
|
|
97
|
+
<ul class="sections">
|
|
98
|
+
|
|
99
|
+
<li id="title">
|
|
100
|
+
<div class="annotation">
|
|
101
|
+
<h1>configuration.rb</h1>
|
|
102
|
+
</div>
|
|
103
|
+
</li>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<li id="section-1">
|
|
108
|
+
<div class="annotation">
|
|
109
|
+
|
|
110
|
+
<div class="pilwrap ">
|
|
111
|
+
<a class="pilcrow" href="#section-1">¶</a>
|
|
112
|
+
</div>
|
|
113
|
+
<h2 id="configuration">Configuration</h2>
|
|
114
|
+
<p>Provides a configuration block for setting up the Bcx client</p>
|
|
115
|
+
<p>Example:</p>
|
|
116
|
+
<pre><code><span class="hljs-constant">Bcx</span>.configure <span class="hljs-keyword">do</span> |config|
|
|
117
|
+
config.account = <span class="hljs-string">'1234567890'</span>
|
|
118
|
+
<span class="hljs-keyword">end</span>
|
|
119
|
+
</code></pre>
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
123
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Configuration</span></span>
|
|
124
|
+
<span class="hljs-keyword">attr_accessor</span> <span class="hljs-symbol">:account</span>, <span class="hljs-symbol">:api_version</span>
|
|
125
|
+
|
|
126
|
+
<span class="hljs-function"><span class="hljs-keyword">def</span> </span>initialize
|
|
127
|
+
<span class="hljs-variable">@api_version</span> = <span class="hljs-string">'v1'</span>
|
|
128
|
+
<span class="hljs-keyword">end</span>
|
|
129
|
+
<span class="hljs-keyword">end</span>
|
|
130
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
131
|
+
|
|
132
|
+
</li>
|
|
133
|
+
|
|
134
|
+
</ul>
|
|
135
|
+
</div>
|
|
136
|
+
</body>
|
|
137
|
+
</html>
|
data/docs/docco.css
CHANGED
|
@@ -21,11 +21,11 @@
|
|
|
21
21
|
}
|
|
22
22
|
|
|
23
23
|
@font-face {
|
|
24
|
-
font-family: '
|
|
25
|
-
src: url('public/fonts/
|
|
26
|
-
src: url('public/fonts/
|
|
27
|
-
url('public/fonts/
|
|
28
|
-
url('public/fonts/
|
|
24
|
+
font-family: 'roboto-black';
|
|
25
|
+
src: url('public/fonts/roboto-black.eot');
|
|
26
|
+
src: url('public/fonts/roboto-black.eot?#iefix') format('embedded-opentype'),
|
|
27
|
+
url('public/fonts/roboto-black.woff') format('woff'),
|
|
28
|
+
url('public/fonts/roboto-black.ttf') format('truetype');
|
|
29
29
|
font-weight: normal;
|
|
30
30
|
font-style: normal;
|
|
31
31
|
}
|
|
@@ -67,7 +67,7 @@ h1, h2, h3, h4, h5, h6 {
|
|
|
67
67
|
color: #112233;
|
|
68
68
|
line-height: 1em;
|
|
69
69
|
font-weight: normal;
|
|
70
|
-
font-family: "
|
|
70
|
+
font-family: "roboto-black";
|
|
71
71
|
text-transform: uppercase;
|
|
72
72
|
margin: 30px 0 15px 0;
|
|
73
73
|
}
|
|
@@ -75,6 +75,9 @@ h1, h2, h3, h4, h5, h6 {
|
|
|
75
75
|
h1 {
|
|
76
76
|
margin-top: 40px;
|
|
77
77
|
}
|
|
78
|
+
h2 {
|
|
79
|
+
font-size: 1.26em;
|
|
80
|
+
}
|
|
78
81
|
|
|
79
82
|
hr {
|
|
80
83
|
border: 0;
|
|
@@ -180,9 +183,18 @@ ul.sections > li > div {
|
|
|
180
183
|
display: block;
|
|
181
184
|
}
|
|
182
185
|
|
|
186
|
+
#jump_page_wrapper{
|
|
187
|
+
position: fixed;
|
|
188
|
+
right: 0;
|
|
189
|
+
top: 0;
|
|
190
|
+
bottom: 0;
|
|
191
|
+
}
|
|
192
|
+
|
|
183
193
|
#jump_page {
|
|
184
194
|
padding: 5px 0 3px;
|
|
185
195
|
margin: 0 0 25px 25px;
|
|
196
|
+
max-height: 100%;
|
|
197
|
+
overflow: auto;
|
|
186
198
|
}
|
|
187
199
|
|
|
188
200
|
#jump_page .source {
|
|
@@ -382,125 +394,125 @@ pre code {
|
|
|
382
394
|
background: #f8f8ff
|
|
383
395
|
}
|
|
384
396
|
|
|
385
|
-
pre .comment,
|
|
386
|
-
pre .template_comment,
|
|
387
|
-
pre .diff .header,
|
|
388
|
-
pre .javadoc {
|
|
397
|
+
pre .hljs-comment,
|
|
398
|
+
pre .hljs-template_comment,
|
|
399
|
+
pre .hljs-diff .hljs-header,
|
|
400
|
+
pre .hljs-javadoc {
|
|
389
401
|
color: #408080;
|
|
390
402
|
font-style: italic
|
|
391
403
|
}
|
|
392
404
|
|
|
393
|
-
pre .keyword,
|
|
394
|
-
pre .assignment,
|
|
395
|
-
pre .literal,
|
|
396
|
-
pre .css .rule .keyword,
|
|
397
|
-
pre .winutils,
|
|
398
|
-
pre .javascript .title,
|
|
399
|
-
pre .lisp .title,
|
|
400
|
-
pre .subst {
|
|
405
|
+
pre .hljs-keyword,
|
|
406
|
+
pre .hljs-assignment,
|
|
407
|
+
pre .hljs-literal,
|
|
408
|
+
pre .hljs-css .hljs-rule .hljs-keyword,
|
|
409
|
+
pre .hljs-winutils,
|
|
410
|
+
pre .hljs-javascript .hljs-title,
|
|
411
|
+
pre .hljs-lisp .hljs-title,
|
|
412
|
+
pre .hljs-subst {
|
|
401
413
|
color: #954121;
|
|
402
414
|
/*font-weight: bold*/
|
|
403
415
|
}
|
|
404
416
|
|
|
405
|
-
pre .number,
|
|
406
|
-
pre .hexcolor {
|
|
417
|
+
pre .hljs-number,
|
|
418
|
+
pre .hljs-hexcolor {
|
|
407
419
|
color: #40a070
|
|
408
420
|
}
|
|
409
421
|
|
|
410
|
-
pre .string,
|
|
411
|
-
pre .tag .value,
|
|
412
|
-
pre .phpdoc,
|
|
413
|
-
pre .tex .formula {
|
|
422
|
+
pre .hljs-string,
|
|
423
|
+
pre .hljs-tag .hljs-value,
|
|
424
|
+
pre .hljs-phpdoc,
|
|
425
|
+
pre .hljs-tex .hljs-formula {
|
|
414
426
|
color: #219161;
|
|
415
427
|
}
|
|
416
428
|
|
|
417
|
-
pre .title,
|
|
418
|
-
pre .id {
|
|
429
|
+
pre .hljs-title,
|
|
430
|
+
pre .hljs-id {
|
|
419
431
|
color: #19469D;
|
|
420
432
|
}
|
|
421
|
-
pre .params {
|
|
433
|
+
pre .hljs-params {
|
|
422
434
|
color: #00F;
|
|
423
435
|
}
|
|
424
436
|
|
|
425
|
-
pre .javascript .title,
|
|
426
|
-
pre .lisp .title,
|
|
427
|
-
pre .subst {
|
|
437
|
+
pre .hljs-javascript .hljs-title,
|
|
438
|
+
pre .hljs-lisp .hljs-title,
|
|
439
|
+
pre .hljs-subst {
|
|
428
440
|
font-weight: normal
|
|
429
441
|
}
|
|
430
442
|
|
|
431
|
-
pre .class .title,
|
|
432
|
-
pre .haskell .label,
|
|
433
|
-
pre .tex .command {
|
|
443
|
+
pre .hljs-class .hljs-title,
|
|
444
|
+
pre .hljs-haskell .hljs-label,
|
|
445
|
+
pre .hljs-tex .hljs-command {
|
|
434
446
|
color: #458;
|
|
435
447
|
font-weight: bold
|
|
436
448
|
}
|
|
437
449
|
|
|
438
|
-
pre .tag,
|
|
439
|
-
pre .tag .title,
|
|
440
|
-
pre .rules .property,
|
|
441
|
-
pre .django .tag .keyword {
|
|
450
|
+
pre .hljs-tag,
|
|
451
|
+
pre .hljs-tag .hljs-title,
|
|
452
|
+
pre .hljs-rules .hljs-property,
|
|
453
|
+
pre .hljs-django .hljs-tag .hljs-keyword {
|
|
442
454
|
color: #000080;
|
|
443
455
|
font-weight: normal
|
|
444
456
|
}
|
|
445
457
|
|
|
446
|
-
pre .attribute,
|
|
447
|
-
pre .variable,
|
|
448
|
-
pre .instancevar,
|
|
449
|
-
pre .lisp .body {
|
|
458
|
+
pre .hljs-attribute,
|
|
459
|
+
pre .hljs-variable,
|
|
460
|
+
pre .hljs-instancevar,
|
|
461
|
+
pre .hljs-lisp .hljs-body {
|
|
450
462
|
color: #008080
|
|
451
463
|
}
|
|
452
464
|
|
|
453
|
-
pre .regexp {
|
|
465
|
+
pre .hljs-regexp {
|
|
454
466
|
color: #B68
|
|
455
467
|
}
|
|
456
468
|
|
|
457
|
-
pre .class {
|
|
469
|
+
pre .hljs-class {
|
|
458
470
|
color: #458;
|
|
459
471
|
font-weight: bold
|
|
460
472
|
}
|
|
461
473
|
|
|
462
|
-
pre .symbol,
|
|
463
|
-
pre .ruby .symbol .string,
|
|
464
|
-
pre .ruby .symbol .keyword,
|
|
465
|
-
pre .ruby .symbol .keymethods,
|
|
466
|
-
pre .lisp .keyword,
|
|
467
|
-
pre .tex .special,
|
|
468
|
-
pre .input_number {
|
|
474
|
+
pre .hljs-symbol,
|
|
475
|
+
pre .hljs-ruby .hljs-symbol .hljs-string,
|
|
476
|
+
pre .hljs-ruby .hljs-symbol .hljs-keyword,
|
|
477
|
+
pre .hljs-ruby .hljs-symbol .hljs-keymethods,
|
|
478
|
+
pre .hljs-lisp .hljs-keyword,
|
|
479
|
+
pre .hljs-tex .hljs-special,
|
|
480
|
+
pre .hljs-input_number {
|
|
469
481
|
color: #990073
|
|
470
482
|
}
|
|
471
483
|
|
|
472
|
-
pre .builtin,
|
|
473
|
-
pre .constructor,
|
|
474
|
-
pre .built_in,
|
|
475
|
-
pre .lisp .title {
|
|
484
|
+
pre .hljs-builtin,
|
|
485
|
+
pre .hljs-constructor,
|
|
486
|
+
pre .hljs-built_in,
|
|
487
|
+
pre .hljs-lisp .hljs-title {
|
|
476
488
|
color: #0086b3
|
|
477
489
|
}
|
|
478
490
|
|
|
479
|
-
pre .preprocessor,
|
|
480
|
-
pre .pi,
|
|
481
|
-
pre .doctype,
|
|
482
|
-
pre .shebang,
|
|
483
|
-
pre .cdata {
|
|
491
|
+
pre .hljs-preprocessor,
|
|
492
|
+
pre .hljs-pi,
|
|
493
|
+
pre .hljs-doctype,
|
|
494
|
+
pre .hljs-shebang,
|
|
495
|
+
pre .hljs-cdata {
|
|
484
496
|
color: #999;
|
|
485
497
|
font-weight: bold
|
|
486
498
|
}
|
|
487
499
|
|
|
488
|
-
pre .deletion {
|
|
500
|
+
pre .hljs-deletion {
|
|
489
501
|
background: #fdd
|
|
490
502
|
}
|
|
491
503
|
|
|
492
|
-
pre .addition {
|
|
504
|
+
pre .hljs-addition {
|
|
493
505
|
background: #dfd
|
|
494
506
|
}
|
|
495
507
|
|
|
496
|
-
pre .diff .change {
|
|
508
|
+
pre .hljs-diff .hljs-change {
|
|
497
509
|
background: #0086b3
|
|
498
510
|
}
|
|
499
511
|
|
|
500
|
-
pre .chunk {
|
|
512
|
+
pre .hljs-chunk {
|
|
501
513
|
color: #aaa
|
|
502
514
|
}
|
|
503
515
|
|
|
504
|
-
pre .tex .formula {
|
|
516
|
+
pre .hljs-tex .hljs-formula {
|
|
505
517
|
opacity: 0.5;
|
|
506
518
|
}
|
data/docs/http.html
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>http.rb</title>
|
|
6
|
+
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
|
8
|
+
<link rel="stylesheet" media="all" href="docco.css" />
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<div id="container">
|
|
12
|
+
<div id="background"></div>
|
|
13
|
+
|
|
14
|
+
<ul id="jump_to">
|
|
15
|
+
<li>
|
|
16
|
+
<a class="large" href="javascript:void(0);">Jump To …</a>
|
|
17
|
+
<a class="small" href="javascript:void(0);">+</a>
|
|
18
|
+
<div id="jump_wrapper">
|
|
19
|
+
<div id="jump_page_wrapper">
|
|
20
|
+
<div id="jump_page">
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<a class="source" href="bcx.html">
|
|
24
|
+
bcx.rb
|
|
25
|
+
</a>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<a class="source" href="http.html">
|
|
29
|
+
http.rb
|
|
30
|
+
</a>
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
<a class="source" href="oauth.html">
|
|
34
|
+
oauth.rb
|
|
35
|
+
</a>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<a class="source" href="configuration.html">
|
|
39
|
+
configuration.rb
|
|
40
|
+
</a>
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
<a class="source" href="oauth.html">
|
|
44
|
+
oauth.rb
|
|
45
|
+
</a>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
<a class="source" href="access.html">
|
|
49
|
+
access.rb
|
|
50
|
+
</a>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<a class="source" href="authorization.html">
|
|
54
|
+
authorization.rb
|
|
55
|
+
</a>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<a class="source" href="comment.html">
|
|
59
|
+
comment.rb
|
|
60
|
+
</a>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<a class="source" href="person.html">
|
|
64
|
+
person.rb
|
|
65
|
+
</a>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<a class="source" href="project.html">
|
|
69
|
+
project.rb
|
|
70
|
+
</a>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<a class="source" href="todo.html">
|
|
74
|
+
todo.rb
|
|
75
|
+
</a>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<a class="source" href="todolist.html">
|
|
79
|
+
todolist.rb
|
|
80
|
+
</a>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<a class="source" href="response_error.html">
|
|
84
|
+
response_error.rb
|
|
85
|
+
</a>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<a class="source" href="version.html">
|
|
89
|
+
version.rb
|
|
90
|
+
</a>
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
</li>
|
|
95
|
+
</ul>
|
|
96
|
+
|
|
97
|
+
<ul class="sections">
|
|
98
|
+
|
|
99
|
+
<li id="title">
|
|
100
|
+
<div class="annotation">
|
|
101
|
+
<h1>http.rb</h1>
|
|
102
|
+
</div>
|
|
103
|
+
</li>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<li id="section-1">
|
|
108
|
+
<div class="annotation">
|
|
109
|
+
|
|
110
|
+
<div class="pilwrap ">
|
|
111
|
+
<a class="pilcrow" href="#section-1">¶</a>
|
|
112
|
+
</div>
|
|
113
|
+
<h2 id="http-client">HTTP Client</h2>
|
|
114
|
+
<p>Provides a client to access the Basecamp Next API using HTTP authentication</p>
|
|
115
|
+
<p>Example:</p>
|
|
116
|
+
<pre><code>client = <span class="hljs-constant">Bcx::Client::HTTP</span>.new(<span class="hljs-symbol">login:</span> <span class="hljs-string">'username'</span>, <span class="hljs-symbol">password:</span> <span class="hljs-string">'secret'</span>)
|
|
117
|
+
</code></pre>
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
121
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Client</span></span>
|
|
122
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">HTTP</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Client</span></span></span>
|
|
123
|
+
method <span class="hljs-symbol">:http</span>
|
|
124
|
+
|
|
125
|
+
extension <span class="hljs-symbol">:json</span>
|
|
126
|
+
encode_request_with <span class="hljs-symbol">:json</span>
|
|
127
|
+
|
|
128
|
+
raise_errors
|
|
129
|
+
|
|
130
|
+
resource <span class="hljs-symbol">:projects</span>, <span class="hljs-symbol">class_name:</span> <span class="hljs-string">'Bcx::Resources::Project'</span>
|
|
131
|
+
resource <span class="hljs-symbol">:todolists</span>, <span class="hljs-symbol">class_name:</span> <span class="hljs-string">'Bcx::Resources::Todolist'</span>
|
|
132
|
+
resource <span class="hljs-symbol">:people</span>, <span class="hljs-symbol">class_name:</span> <span class="hljs-string">'Bcx::Resources::Person'</span>
|
|
133
|
+
|
|
134
|
+
<span class="hljs-function"><span class="hljs-keyword">def</span> </span>initialize(options = {})
|
|
135
|
+
<span class="hljs-variable">@account</span> = <span class="hljs-constant">Bcx</span>.configuration.account
|
|
136
|
+
<span class="hljs-variable">@api_version</span> = <span class="hljs-constant">Bcx</span>.configuration.api_version
|
|
137
|
+
|
|
138
|
+
<span class="hljs-keyword">self</span>.<span class="hljs-keyword">class</span>.site(<span class="hljs-string">"https://basecamp.com/<span class="hljs-subst">#{<span class="hljs-variable">@account</span>}</span>/api/<span class="hljs-subst">#{<span class="hljs-variable">@api_version</span>}</span>/"</span>)
|
|
139
|
+
|
|
140
|
+
<span class="hljs-keyword">super</span>(options)
|
|
141
|
+
<span class="hljs-keyword">end</span>
|
|
142
|
+
<span class="hljs-keyword">end</span>
|
|
143
|
+
<span class="hljs-keyword">end</span>
|
|
144
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
145
|
+
|
|
146
|
+
</li>
|
|
147
|
+
|
|
148
|
+
</ul>
|
|
149
|
+
</div>
|
|
150
|
+
</body>
|
|
151
|
+
</html>
|
data/docs/oauth.html
ADDED
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>oauth.rb</title>
|
|
6
|
+
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
|
|
8
|
+
<link rel="stylesheet" media="all" href="docco.css" />
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<div id="container">
|
|
12
|
+
<div id="background"></div>
|
|
13
|
+
|
|
14
|
+
<ul id="jump_to">
|
|
15
|
+
<li>
|
|
16
|
+
<a class="large" href="javascript:void(0);">Jump To …</a>
|
|
17
|
+
<a class="small" href="javascript:void(0);">+</a>
|
|
18
|
+
<div id="jump_wrapper">
|
|
19
|
+
<div id="jump_page_wrapper">
|
|
20
|
+
<div id="jump_page">
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<a class="source" href="bcx.html">
|
|
24
|
+
bcx.rb
|
|
25
|
+
</a>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
<a class="source" href="http.html">
|
|
29
|
+
http.rb
|
|
30
|
+
</a>
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
<a class="source" href="oauth.html">
|
|
34
|
+
oauth.rb
|
|
35
|
+
</a>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<a class="source" href="configuration.html">
|
|
39
|
+
configuration.rb
|
|
40
|
+
</a>
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
<a class="source" href="oauth.html">
|
|
44
|
+
oauth.rb
|
|
45
|
+
</a>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
<a class="source" href="access.html">
|
|
49
|
+
access.rb
|
|
50
|
+
</a>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
<a class="source" href="authorization.html">
|
|
54
|
+
authorization.rb
|
|
55
|
+
</a>
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<a class="source" href="comment.html">
|
|
59
|
+
comment.rb
|
|
60
|
+
</a>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
<a class="source" href="person.html">
|
|
64
|
+
person.rb
|
|
65
|
+
</a>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<a class="source" href="project.html">
|
|
69
|
+
project.rb
|
|
70
|
+
</a>
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
<a class="source" href="todo.html">
|
|
74
|
+
todo.rb
|
|
75
|
+
</a>
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<a class="source" href="todolist.html">
|
|
79
|
+
todolist.rb
|
|
80
|
+
</a>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<a class="source" href="response_error.html">
|
|
84
|
+
response_error.rb
|
|
85
|
+
</a>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<a class="source" href="version.html">
|
|
89
|
+
version.rb
|
|
90
|
+
</a>
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
</li>
|
|
95
|
+
</ul>
|
|
96
|
+
|
|
97
|
+
<ul class="sections">
|
|
98
|
+
|
|
99
|
+
<li id="title">
|
|
100
|
+
<div class="annotation">
|
|
101
|
+
<h1>oauth.rb</h1>
|
|
102
|
+
</div>
|
|
103
|
+
</li>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
<li id="section-1">
|
|
108
|
+
<div class="annotation">
|
|
109
|
+
|
|
110
|
+
<div class="pilwrap ">
|
|
111
|
+
<a class="pilcrow" href="#section-1">¶</a>
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
117
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Launchpad</span></span>
|
|
118
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">OAuth</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Client</span></span></span>
|
|
119
|
+
method <span class="hljs-symbol">:oauth</span>
|
|
120
|
+
|
|
121
|
+
extension <span class="hljs-symbol">:json</span>
|
|
122
|
+
encode_request_with <span class="hljs-symbol">:json</span>
|
|
123
|
+
|
|
124
|
+
raise_errors
|
|
125
|
+
|
|
126
|
+
resource <span class="hljs-symbol">:authorization</span>, <span class="hljs-symbol">class_name:</span> <span class="hljs-string">"Bcx::Resources::Authorization"</span>
|
|
127
|
+
|
|
128
|
+
<span class="hljs-function"><span class="hljs-keyword">def</span> </span>initialize(options = {})
|
|
129
|
+
options[<span class="hljs-symbol">:site</span>] ||= <span class="hljs-string">"https://launchpad.37signals.com"</span>
|
|
130
|
+
options[<span class="hljs-symbol">:uid</span>] ||= options[<span class="hljs-symbol">:client_id</span>]
|
|
131
|
+
options[<span class="hljs-symbol">:secret</span>] ||= options[<span class="hljs-symbol">:client_secret</span>]
|
|
132
|
+
|
|
133
|
+
<span class="hljs-keyword">super</span>(options)
|
|
134
|
+
<span class="hljs-keyword">end</span>
|
|
135
|
+
<span class="hljs-keyword">end</span>
|
|
136
|
+
<span class="hljs-keyword">end</span>
|
|
137
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
138
|
+
|
|
139
|
+
</li>
|
|
140
|
+
|
|
141
|
+
</ul>
|
|
142
|
+
</div>
|
|
143
|
+
</body>
|
|
144
|
+
</html>
|