bcx 0.3.0 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ca9b706ec38077f58b5ef2e0ac30aa6a2195b68c
|
|
4
|
+
data.tar.gz: 70aea2ab33f6848e4aa632446e2a3314e16cc8ff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b938bf020795af1e1f87ed41d1700de79f5ff46f129f5e79903c1896955693b8749da32664516fbcb0ed26e35c591cf9696ede88cf40e9c688a35b75acc80cdc
|
|
7
|
+
data.tar.gz: b0a565e55dbfe585fcdabd42b0285a00201de15e958c14ddcceec900abd1529797084fc8427dcb15fc6be5e4e36e5957fdee8991c835d4f29d6d811377ef3e99
|
data/.rspec
CHANGED
data/.travis.yml
CHANGED
data/README.md
CHANGED
|
@@ -145,7 +145,7 @@ end
|
|
|
145
145
|
|
|
146
146
|
### Documentation
|
|
147
147
|
|
|
148
|
-
See the full [annotated source code](http://paulspringett.github.io/bcx).
|
|
148
|
+
See the full [annotated source code](http://paulspringett.github.io/bcx/docs/bcx.html).
|
|
149
149
|
|
|
150
150
|
The docs are generated using [Docco](http://jashkenas.github.io/docco/). To generate the docs, run:
|
|
151
151
|
|
data/bcx.gemspec
CHANGED
|
@@ -14,8 +14,9 @@ Gem::Specification.new do |gem|
|
|
|
14
14
|
gem.name = "bcx"
|
|
15
15
|
gem.require_paths = ["lib"]
|
|
16
16
|
gem.version = Bcx::VERSION
|
|
17
|
+
gem.license = 'MIT'
|
|
17
18
|
|
|
18
|
-
gem.add_runtime_dependency 'rapidash', '~>0.3.0'
|
|
19
|
+
gem.add_runtime_dependency 'rapidash', '~> 0.3.0'
|
|
19
20
|
|
|
20
21
|
gem.add_development_dependency 'rake'
|
|
21
22
|
gem.add_development_dependency 'rspec'
|
data/docs/access.html
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>access.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>access.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
|
+
<p>Bcx::Resources::Access</p>
|
|
114
|
+
<p>Provides access to accesses resource at per-project level</p>
|
|
115
|
+
<h4 id="get-accesses-for-a-project">Get accesses for a project</h4>
|
|
116
|
+
<p><code>GET /projects/1/accesses.json</code></p>
|
|
117
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).accesses!
|
|
118
|
+
</code></pre><h4 id="grant-access">Grant access</h4>
|
|
119
|
+
<p><code>POST /projects/1/accesses.json</code></p>
|
|
120
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).accesses.create!(<span class="hljs-symbol">ids:</span> [ <span class="hljs-number">5</span>, <span class="hljs-number">6</span>, <span class="hljs-number">10</span>])
|
|
121
|
+
</code></pre><h4 id="revoke-access">Revoke access</h4>
|
|
122
|
+
<p><code>DELETE /projects/1/accesses/1.json</code></p>
|
|
123
|
+
<pre><code>client.projects(<span class="hljs-number">1</span>).accesses(<span class="hljs-number">1</span>).delete!
|
|
124
|
+
</code></pre>
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
128
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
|
129
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Access</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
|
130
|
+
|
|
131
|
+
<span class="hljs-keyword">end</span>
|
|
132
|
+
<span class="hljs-keyword">end</span>
|
|
133
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
134
|
+
|
|
135
|
+
</li>
|
|
136
|
+
|
|
137
|
+
</ul>
|
|
138
|
+
</div>
|
|
139
|
+
</body>
|
|
140
|
+
</html>
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>authorization.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>authorization.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">Resources</span></span></pre></div></div>
|
|
118
|
+
|
|
119
|
+
</li>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<li id="section-2">
|
|
123
|
+
<div class="annotation">
|
|
124
|
+
|
|
125
|
+
<div class="pilwrap ">
|
|
126
|
+
<a class="pilcrow" href="#section-2">¶</a>
|
|
127
|
+
</div>
|
|
128
|
+
<p>Bcx::Resources::Authorization
|
|
129
|
+
Provides access to the authorization resource</p>
|
|
130
|
+
<p>Fetch authorization
|
|
131
|
+
GET /authorization.json</p>
|
|
132
|
+
<p> launchpad.authorization!</p>
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
<div class="content"><div class='highlight'><pre> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Authorization</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
|
137
|
+
url <span class="hljs-symbol">:authorization</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/bcx.html
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>bcx.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>bcx.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-keyword">require</span> <span class="hljs-string">'rapidash'</span>
|
|
117
|
+
<span class="hljs-keyword">require</span> <span class="hljs-string">'bcx/version'</span></pre></div></div>
|
|
118
|
+
|
|
119
|
+
</li>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<li id="section-2">
|
|
123
|
+
<div class="annotation">
|
|
124
|
+
|
|
125
|
+
<div class="pilwrap ">
|
|
126
|
+
<a class="pilcrow" href="#section-2">¶</a>
|
|
127
|
+
</div>
|
|
128
|
+
<h2 id="bcx">Bcx</h2>
|
|
129
|
+
<p>Fully-fledged Ruby API wrapper for Basecamp Next</p>
|
|
130
|
+
<p>See the <a href="https://github.com/paulspringett/bcx#readme">README</a> for usage</p>
|
|
131
|
+
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
135
|
+
autoload <span class="hljs-symbol">:Configuration</span>, <span class="hljs-string">'bcx/configuration'</span>
|
|
136
|
+
|
|
137
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
|
138
|
+
autoload <span class="hljs-symbol">:Todo</span>, <span class="hljs-string">'bcx/resources/todo'</span>
|
|
139
|
+
autoload <span class="hljs-symbol">:Todolist</span>, <span class="hljs-string">'bcx/resources/todolist'</span>
|
|
140
|
+
autoload <span class="hljs-symbol">:Project</span>, <span class="hljs-string">'bcx/resources/project'</span>
|
|
141
|
+
autoload <span class="hljs-symbol">:Person</span>, <span class="hljs-string">'bcx/resources/person'</span>
|
|
142
|
+
autoload <span class="hljs-symbol">:Access</span>, <span class="hljs-string">'bcx/resources/access'</span>
|
|
143
|
+
autoload <span class="hljs-symbol">:Authorization</span>, <span class="hljs-string">'bcx/resources/authorization'</span>
|
|
144
|
+
autoload <span class="hljs-symbol">:Comment</span>, <span class="hljs-string">'bcx/resources/comment'</span>
|
|
145
|
+
<span class="hljs-keyword">end</span>
|
|
146
|
+
|
|
147
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Client</span></span>
|
|
148
|
+
autoload <span class="hljs-symbol">:HTTP</span>, <span class="hljs-string">'bcx/client/http'</span>
|
|
149
|
+
autoload <span class="hljs-symbol">:OAuth</span>, <span class="hljs-string">'bcx/client/oauth'</span>
|
|
150
|
+
<span class="hljs-keyword">end</span>
|
|
151
|
+
|
|
152
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Launchpad</span></span>
|
|
153
|
+
autoload <span class="hljs-symbol">:OAuth</span>, <span class="hljs-string">'bcx/launchpad/oauth'</span>
|
|
154
|
+
<span class="hljs-keyword">end</span>
|
|
155
|
+
|
|
156
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-inheritance"><</span><span class="hljs-inheritance">< <span class="hljs-parent">self</span></span></span>
|
|
157
|
+
<span class="hljs-keyword">attr_accessor</span> <span class="hljs-symbol">:configuration</span>
|
|
158
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
159
|
+
|
|
160
|
+
</li>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<li id="section-3">
|
|
164
|
+
<div class="annotation">
|
|
165
|
+
|
|
166
|
+
<div class="pilwrap ">
|
|
167
|
+
<a class="pilcrow" href="#section-3">¶</a>
|
|
168
|
+
</div>
|
|
169
|
+
<p>Expose configuration block</p>
|
|
170
|
+
|
|
171
|
+
</div>
|
|
172
|
+
|
|
173
|
+
<div class="content"><div class='highlight'><pre> <span class="hljs-function"><span class="hljs-keyword">def</span> </span><span class="hljs-keyword">self</span>.configure
|
|
174
|
+
<span class="hljs-keyword">self</span>.configuration ||= <span class="hljs-constant">Configuration</span>.new
|
|
175
|
+
<span class="hljs-keyword">yield</span>(configuration)
|
|
176
|
+
<span class="hljs-keyword">end</span>
|
|
177
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<li id="section-4">
|
|
183
|
+
<div class="annotation">
|
|
184
|
+
|
|
185
|
+
<div class="pilwrap ">
|
|
186
|
+
<a class="pilcrow" href="#section-4">¶</a>
|
|
187
|
+
</div>
|
|
188
|
+
<p>Use custom <code>Bcx::ResponseError</code> on top of Rapidash’s error handling</p>
|
|
189
|
+
|
|
190
|
+
</div>
|
|
191
|
+
|
|
192
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-keyword">require</span> <span class="hljs-string">'bcx/response_error'</span>
|
|
193
|
+
<span class="hljs-constant">Rapidash</span>.response_exception_class = <span class="hljs-constant">Bcx::ResponseError</span></pre></div></div>
|
|
194
|
+
|
|
195
|
+
</li>
|
|
196
|
+
|
|
197
|
+
</ul>
|
|
198
|
+
</div>
|
|
199
|
+
</body>
|
|
200
|
+
</html>
|
data/docs/comment.html
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<title>comment.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>comment.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="comments">Comments</h2>
|
|
114
|
+
<p>Provides access to comments resource on todo or todolist level</p>
|
|
115
|
+
<h4 id="create-a-new-todolist-comment">Create a new todolist comment</h4>
|
|
116
|
+
<p><code>POST /projects/123/todolist/456/comments.json</code></p>
|
|
117
|
+
<pre><code>client.projects(<span class="hljs-number">123</span>).todolists(<span class="hljs-number">456</span>).comments.create!(<span class="hljs-symbol">content:</span> <span class="hljs-string">'New comment'</span>)
|
|
118
|
+
</code></pre><h4 id="create-a-new-todo-comment">Create a new todo comment</h4>
|
|
119
|
+
<p><code>POST /projects/123/todo/456/comments.json</code></p>
|
|
120
|
+
<pre><code>client.projects(<span class="hljs-number">123</span>).todos(<span class="hljs-number">456</span>).comments.create!(<span class="hljs-symbol">content:</span> <span class="hljs-string">'New comment'</span>)
|
|
121
|
+
</code></pre><h4 id="delete-the-comment">Delete the comment</h4>
|
|
122
|
+
<p><code>DELETE /projects/123/comments/456.json</code></p>
|
|
123
|
+
<pre><code>client.projects(<span class="hljs-number">123</span>).comments(<span class="hljs-number">456</span>).delete!
|
|
124
|
+
</code></pre>
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
<div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
|
|
128
|
+
<span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
|
|
129
|
+
<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Comment</span> <span class="hljs-inheritance">< <span class="hljs-parent">Rapidash::Base</span></span></span>
|
|
130
|
+
<span class="hljs-keyword">end</span>
|
|
131
|
+
<span class="hljs-keyword">end</span>
|
|
132
|
+
<span class="hljs-keyword">end</span></pre></div></div>
|
|
133
|
+
|
|
134
|
+
</li>
|
|
135
|
+
|
|
136
|
+
</ul>
|
|
137
|
+
</div>
|
|
138
|
+
</body>
|
|
139
|
+
</html>
|