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
data/docs/person.html
ADDED
@@ -0,0 +1,147 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<title>person.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>person.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="people">People</h2>
|
114
|
+
<p>Provides access to people resource</p>
|
115
|
+
<h4 id="get-all-people-on-the-account">Get all people on the account</h4>
|
116
|
+
<p><code>GET /people.json</code></p>
|
117
|
+
<pre><code>client.people!
|
118
|
+
</code></pre><h4 id="get-a-person">Get a person</h4>
|
119
|
+
<p><code>GET /people/123.json</code></p>
|
120
|
+
<pre><code>client.people!(<span class="hljs-number">123</span>)
|
121
|
+
</code></pre><h4 id="get-the-current-person">Get the current person</h4>
|
122
|
+
<p><code>GET /people/me.json</code></p>
|
123
|
+
<pre><code>client.people.me!
|
124
|
+
</code></pre><h4 id="get-assigned-todos-for-a-person">Get assigned todos for a person</h4>
|
125
|
+
<p><code>GET /people/1/assigned_todos.json</code></p>
|
126
|
+
<pre><code>client.people(<span class="hljs-number">1</span>).assigned_todos
|
127
|
+
</code></pre><h4 id="delete-a-person">Delete a person</h4>
|
128
|
+
<p><code>DELETE /people/123.json</code></p>
|
129
|
+
<pre><code>client.people(<span class="hljs-number">123</span>).delete!
|
130
|
+
</code></pre>
|
131
|
+
</div>
|
132
|
+
|
133
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
134
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
135
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Person</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
136
|
+
url <span class="hljs-symbol">:people</span>
|
137
|
+
collection <span class="hljs-symbol">:me</span>
|
138
|
+
<span class="hljs-keyword">end</span>
|
139
|
+
<span class="hljs-keyword">end</span>
|
140
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
141
|
+
|
142
|
+
</li>
|
143
|
+
|
144
|
+
</ul>
|
145
|
+
</div>
|
146
|
+
</body>
|
147
|
+
</html>
|
data/docs/project.html
ADDED
@@ -0,0 +1,154 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<title>project.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>project.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="projects">Projects</h2>
|
114
|
+
<p>Provides access to projects resoource and other nested resources</p>
|
115
|
+
<h4 id="fetch-all-projects">Fetch all projects</h4>
|
116
|
+
<p><code>GET /projects.json</code></p>
|
117
|
+
<pre><code>client.projects!
|
118
|
+
</code></pre><h4 id="fetch-archived-projects">Fetch archived projects</h4>
|
119
|
+
<p><code>GET /projects/archived.json</code></p>
|
120
|
+
<pre><code>clients.projects.archived!
|
121
|
+
</code></pre><h4 id="fetch-single-project-with-id-of-123">Fetch single project with ID of 123</h4>
|
122
|
+
<p><code>GET /projects/123.json</code></p>
|
123
|
+
<pre><code>client.projects!(<span class="hljs-number">123</span>)
|
124
|
+
</code></pre><h4 id="create-a-project">Create a project</h4>
|
125
|
+
<p><code>POST /projects.json</code></p>
|
126
|
+
<pre><code>client.projects.create!(<span class="hljs-symbol">name:</span> <span class="hljs-string">'Acme project'</span>, <span class="hljs-symbol">description:</span> <span class="hljs-string">'This is a new project'</span>)
|
127
|
+
</code></pre><h4 id="update-an-existing-project">Update an existing project</h4>
|
128
|
+
<p><code>PUT /projects/123.json</code></p>
|
129
|
+
<pre><code>client.projects(<span class="hljs-number">123</span>).update!(<span class="hljs-symbol">description:</span> <span class="hljs-string">'A new description'</span>)
|
130
|
+
</code></pre><h4 id="delete-a-project">Delete a project</h4>
|
131
|
+
<p><code>DELETE /projects/123.json</code></p>
|
132
|
+
<pre><code>client.projects(<span class="hljs-number">123</span>).delete!
|
133
|
+
</code></pre>
|
134
|
+
</div>
|
135
|
+
|
136
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
137
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
138
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Project</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
139
|
+
resource <span class="hljs-symbol">:todolists</span>
|
140
|
+
resource <span class="hljs-symbol">:todos</span>
|
141
|
+
resource <span class="hljs-symbol">:accesses</span>
|
142
|
+
resource <span class="hljs-symbol">:comments</span>
|
143
|
+
|
144
|
+
collection <span class="hljs-symbol">:archived</span>
|
145
|
+
<span class="hljs-keyword">end</span>
|
146
|
+
<span class="hljs-keyword">end</span>
|
147
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
</ul>
|
152
|
+
</div>
|
153
|
+
</body>
|
154
|
+
</html>
|
Binary file
|
Binary file
|
Binary file
|
@@ -0,0 +1,153 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<title>response_error.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>response_error.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="response-error">Response Error</h2>
|
114
|
+
<p>If the response whilst fetching a resource is a 4xx or 5xx, Bcx will raise a <code>Bcx::ResponseError</code> exception.</p>
|
115
|
+
<p>Examples:</p>
|
116
|
+
<pre><code>client.projects.create!(<span class="hljs-symbol">name:</span> <span class="hljs-string">''</span>)
|
117
|
+
<span class="hljs-status">=></span> <span class="hljs-constant">Bcx::ResponseError</span><span class="hljs-symbol">:</span> <span class="hljs-number">422</span> <span class="hljs-constant">POST</span> <span class="hljs-symbol">https:</span>/<span class="hljs-regexp">/basecamp.com/</span><span class="hljs-number">2274488</span>/api/v1/projects.json | <span class="hljs-constant">Errors</span><span class="hljs-symbol">:</span> name can<span class="hljs-string">'t be blank</span>
|
118
|
+
</code></pre><p>You can rescue this exception to grab the status, method, URL and errors individually.</p>
|
119
|
+
<pre><code><span class="hljs-keyword">begin</span>
|
120
|
+
client.projects.create!(<span class="hljs-symbol">name:</span> <span class="hljs-string">''</span>)
|
121
|
+
<span class="hljs-keyword">rescue</span> <span class="hljs-constant">Bcx::ResponseError</span> => response
|
122
|
+
response.method <span class="hljs-comment"># => "POST"</span>
|
123
|
+
response.status <span class="hljs-comment"># => 422</span>
|
124
|
+
response.url <span class="hljs-comment"># => "https://basecamp.com/2274488/api/v1/projects.json"</span>
|
125
|
+
response.errors <span class="hljs-comment"># => ["name can't be blank"]</span>
|
126
|
+
<span class="hljs-keyword">end</span>
|
127
|
+
</code></pre>
|
128
|
+
</div>
|
129
|
+
|
130
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
131
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">ResponseError</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::ResponseError</span></span></span>
|
132
|
+
|
133
|
+
<span class="hljs-function"><span class="hljs-keyword">def</span> </span>errors
|
134
|
+
<span class="hljs-keyword">return</span> body <span class="hljs-keyword">if</span> body.kind_of?(<span class="hljs-constant">String</span>)
|
135
|
+
|
136
|
+
messages = []
|
137
|
+
|
138
|
+
body.each_pair <span class="hljs-keyword">do</span> |attribute, msgs|
|
139
|
+
msgs.each { |msg| messages.push <span class="hljs-string">"<span class="hljs-subst">#{attribute}</span> <span class="hljs-subst">#{msg}</span>"</span> }
|
140
|
+
<span class="hljs-keyword">end</span>
|
141
|
+
|
142
|
+
messages.join(<span class="hljs-string">', '</span>)
|
143
|
+
<span class="hljs-keyword">end</span>
|
144
|
+
|
145
|
+
<span class="hljs-keyword">end</span>
|
146
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
147
|
+
|
148
|
+
</li>
|
149
|
+
|
150
|
+
</ul>
|
151
|
+
</div>
|
152
|
+
</body>
|
153
|
+
</html>
|
data/docs/todo.html
ADDED
@@ -0,0 +1,148 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<title>todo.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>todo.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="todo">Todo</h2>
|
114
|
+
<p>Provides access to todolist resoource both at the client level and per-project</p>
|
115
|
+
<h4 id="get-todos-for-a-todolist">Get todos for a todolist</h4>
|
116
|
+
<p><code>GET /todolists/1.json</code></p>
|
117
|
+
<pre><code>todolist = client.todolists!(<span class="hljs-number">1</span>)
|
118
|
+
todolist.todos.remaining
|
119
|
+
todolist.todos.completed
|
120
|
+
</code></pre><h4 id="get-a-specific-todo">Get a specific todo</h4>
|
121
|
+
<p><code>GET /projects/1/todos/2.json</code></p>
|
122
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).todos!(<span class="hljs-number">2</span>)
|
123
|
+
</code></pre><h4 id="create-a-todo">Create a todo</h4>
|
124
|
+
<p><code>POST /projects/1/todolists/2/todos.json</code></p>
|
125
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).todolists(<span class="hljs-number">2</span>).todos.create!(<span class="hljs-symbol">content:</span> <span class="hljs-string">'Update copy text'</span>)
|
126
|
+
</code></pre><h4 id="update-a-todo">Update a todo</h4>
|
127
|
+
<p><code>PUT /projects/1/todos/2.json</code></p>
|
128
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).todos(<span class="hljs-number">2</span>).update!(<span class="hljs-symbol">completed:</span> <span class="hljs-keyword">true</span>)
|
129
|
+
</code></pre><h4 id="delete-a-todo">Delete a todo</h4>
|
130
|
+
<p><code>DELETE /projects/1/todos/2.json</code></p>
|
131
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).todos(<span class="hljs-number">2</span>).delete!
|
132
|
+
</code></pre>
|
133
|
+
</div>
|
134
|
+
|
135
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
136
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
137
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Todo</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
138
|
+
resource <span class="hljs-symbol">:comments</span>
|
139
|
+
<span class="hljs-keyword">end</span>
|
140
|
+
<span class="hljs-keyword">end</span>
|
141
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
142
|
+
|
143
|
+
</li>
|
144
|
+
|
145
|
+
</ul>
|
146
|
+
</div>
|
147
|
+
</body>
|
148
|
+
</html>
|