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.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/.rspec +1 -0
  3. data/.travis.yml +2 -0
  4. data/README.md +1 -1
  5. data/bcx.gemspec +2 -1
  6. data/docs/access.html +140 -0
  7. data/docs/authorization.html +147 -0
  8. data/docs/bcx.html +200 -0
  9. data/docs/comment.html +139 -0
  10. data/docs/configuration.html +137 -0
  11. data/docs/docco.css +76 -64
  12. data/docs/http.html +151 -0
  13. data/docs/oauth.html +144 -0
  14. data/docs/person.html +147 -0
  15. data/docs/project.html +154 -0
  16. data/docs/public/fonts/roboto-black.eot +0 -0
  17. data/docs/public/fonts/roboto-black.ttf +0 -0
  18. data/docs/public/fonts/roboto-black.woff +0 -0
  19. data/docs/response_error.html +153 -0
  20. data/docs/todo.html +148 -0
  21. data/docs/todolist.html +158 -0
  22. data/docs/version.html +125 -0
  23. data/lib/bcx/resources/comment.rb +26 -0
  24. data/lib/bcx/resources/project.rb +1 -0
  25. data/lib/bcx/resources/todo.rb +1 -0
  26. data/lib/bcx/resources/todolist.rb +1 -0
  27. data/lib/bcx/version.rb +1 -1
  28. data/lib/bcx.rb +1 -0
  29. data/lib/tasks/docs.rake +4 -2
  30. data/spec/bcx/comment_spec.rb +31 -0
  31. data/spec/cassettes/Bcx_Resources_Comment/DELETE_/projects/9634353/comments/297584179_json/should_delete_the_given_comment.yml +140 -0
  32. data/spec/cassettes/Bcx_Resources_Comment/POST_/projects/9634353/todolists/29123043/comments_json/should_create_a_new_todolist_comment.yml +114 -0
  33. data/spec/cassettes/Bcx_Resources_Comment/POST_/projects/9634353/todos/185137845/comments_json/should_create_a_new_todo_comment.yml +114 -0
  34. metadata +41 -30
  35. data/docs/lib/bcx/client/http.html +0 -144
  36. data/docs/lib/bcx/client/oauth.html +0 -146
  37. data/docs/lib/bcx/configuration.html +0 -80
  38. data/docs/lib/bcx/launchpad/oauth.html +0 -137
  39. data/docs/lib/bcx/resources/access.html +0 -133
  40. data/docs/lib/bcx/resources/authorization.html +0 -140
  41. data/docs/lib/bcx/resources/person.html +0 -140
  42. data/docs/lib/bcx/resources/project.html +0 -146
  43. data/docs/lib/bcx/resources/todo.html +0 -140
  44. data/docs/lib/bcx/resources/todolist.html +0 -150
  45. data/docs/lib/bcx/response_error.html +0 -96
  46. data/docs/lib/bcx/version.html +0 -68
  47. data/docs/lib/bcx.html +0 -192
  48. data/docs/public/fonts/novecento-bold.eot +0 -0
  49. data/docs/public/fonts/novecento-bold.ttf +0 -0
  50. data/docs/public/fonts/novecento-bold.woff +0 -0
data/docs/lib/bcx/configuration.html DELETED
@@ -1,80 +0,0 @@
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 &hellip;</a>
17
- <a class="small" href="javascript:void(0);">+</a>
18
- <div id="jump_wrapper">
19
- <div id="jump_page">
20
-
21
-
22
- <a class="source" href="configuration.html">
23
- lib/bcx/configuration.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="response_error.html">
28
- lib/bcx/response_error.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="version.html">
33
- lib/bcx/version.rb
34
- </a>
35
-
36
- </div>
37
- </li>
38
- </ul>
39
-
40
- <ul class="sections">
41
-
42
- <li id="title">
43
- <div class="annotation">
44
- <h1>configuration.rb</h1>
45
- </div>
46
- </li>
47
-
48
-
49
-
50
- <li id="section-1">
51
- <div class="annotation">
52
-
53
- <div class="pilwrap for-h2">
54
- <a class="pilcrow" href="#section-1">&#182;</a>
55
- </div>
56
- <h2>Configuration</h2>
57
- <p>Provides a configuration block for setting up the Bcx client</p>
58
- <p>Example:</p>
59
- <pre><code><span class="constant">Bcx</span>.configure <span class="keyword">do</span> |config|
60
- config.account = <span class="string">'1234567890'</span>
61
- <span class="keyword">end</span></code></pre>
62
-
63
- </div>
64
-
65
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
66
- <span class="class"><span class="keyword">class</span> <span class="title">Configuration</span></span>
67
- attr_accessor <span class="symbol">:account</span>, <span class="symbol">:api_version</span>
68
-
69
- <span class="function"><span class="keyword">def</span> <span class="title">initialize</span></span>
70
- <span class="variable">@api_version</span> = <span class="string">'v1'</span>
71
- <span class="keyword">end</span>
72
- <span class="keyword">end</span>
73
- <span class="keyword">end</span></pre></div></div>
74
-
75
- </li>
76
-
77
- </ul>
78
- </div>
79
- </body>
80
- </html>
data/docs/lib/bcx/launchpad/oauth.html DELETED
@@ -1,137 +0,0 @@
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 &hellip;</a>
17
- <a class="small" href="javascript:void(0);">+</a>
18
- <div id="jump_wrapper">
19
- <div id="jump_page">
20
-
21
-
22
- <a class="source" href="../../bcx.html">
23
- lib/bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="../client/http.html">
28
- lib/bcx/client/http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="../client/oauth.html">
33
- lib/bcx/client/oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="../configuration.html">
38
- lib/bcx/configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="oauth.html">
43
- lib/bcx/launchpad/oauth.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="../resources/access.html">
48
- lib/bcx/resources/access.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="../resources/authorization.html">
53
- lib/bcx/resources/authorization.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="../resources/person.html">
58
- lib/bcx/resources/person.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="../resources/project.html">
63
- lib/bcx/resources/project.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="../resources/todo.html">
68
- lib/bcx/resources/todo.rb
69
- </a>
70
-
71
-
72
- <a class="source" href="../resources/todolist.html">
73
- lib/bcx/resources/todolist.rb
74
- </a>
75
-
76
-
77
- <a class="source" href="../response_error.html">
78
- lib/bcx/response_error.rb
79
- </a>
80
-
81
-
82
- <a class="source" href="../version.html">
83
- lib/bcx/version.rb
84
- </a>
85
-
86
- </div>
87
- </li>
88
- </ul>
89
-
90
- <ul class="sections">
91
-
92
- <li id="title">
93
- <div class="annotation">
94
- <h1>oauth.rb</h1>
95
- </div>
96
- </li>
97
-
98
-
99
-
100
- <li id="section-1">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-1">&#182;</a>
105
- </div>
106
-
107
- </div>
108
-
109
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
110
- <span class="class"><span class="keyword">module</span> <span class="title">Launchpad</span></span>
111
- <span class="class"><span class="keyword">class</span> <span class="title">OAuth</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Client</span></span></span>
112
- method <span class="symbol">:oauth</span>
113
-
114
- extension <span class="symbol">:json</span>
115
- encode_request_with <span class="symbol">:json</span>
116
-
117
- raise_errors
118
-
119
- resource <span class="symbol">:authorization</span>, <span class="symbol">class_name:</span> <span class="string">"Bcx::Resources::Authorization"</span>
120
-
121
- <span class="function"><span class="keyword">def</span> <span class="title">initialize</span><span class="params">(options = {})</span></span>
122
- options[<span class="symbol">:site</span>] ||= <span class="string">"https://launchpad.37signals.com"</span>
123
- options[<span class="symbol">:uid</span>] ||= options[<span class="symbol">:client_id</span>]
124
- options[<span class="symbol">:secret</span>] ||= options[<span class="symbol">:client_secret</span>]
125
-
126
- <span class="keyword">super</span>(options)
127
- <span class="keyword">end</span>
128
- <span class="keyword">end</span>
129
- <span class="keyword">end</span>
130
- <span class="keyword">end</span></pre></div></div>
131
-
132
- </li>
133
-
134
- </ul>
135
- </div>
136
- </body>
137
- </html>
data/docs/lib/bcx/resources/access.html DELETED
@@ -1,133 +0,0 @@
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 &hellip;</a>
17
- <a class="small" href="javascript:void(0);">+</a>
18
- <div id="jump_wrapper">
19
- <div id="jump_page">
20
-
21
-
22
- <a class="source" href="../../bcx.html">
23
- lib/bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="../client/http.html">
28
- lib/bcx/client/http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="../client/oauth.html">
33
- lib/bcx/client/oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="../configuration.html">
38
- lib/bcx/configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="../launchpad/oauth.html">
43
- lib/bcx/launchpad/oauth.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="access.html">
48
- lib/bcx/resources/access.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="authorization.html">
53
- lib/bcx/resources/authorization.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="person.html">
58
- lib/bcx/resources/person.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="project.html">
63
- lib/bcx/resources/project.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="todo.html">
68
- lib/bcx/resources/todo.rb
69
- </a>
70
-
71
-
72
- <a class="source" href="todolist.html">
73
- lib/bcx/resources/todolist.rb
74
- </a>
75
-
76
-
77
- <a class="source" href="../response_error.html">
78
- lib/bcx/response_error.rb
79
- </a>
80
-
81
-
82
- <a class="source" href="../version.html">
83
- lib/bcx/version.rb
84
- </a>
85
-
86
- </div>
87
- </li>
88
- </ul>
89
-
90
- <ul class="sections">
91
-
92
- <li id="title">
93
- <div class="annotation">
94
- <h1>access.rb</h1>
95
- </div>
96
- </li>
97
-
98
-
99
-
100
- <li id="section-1">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-1">&#182;</a>
105
- </div>
106
- <p>Bcx::Resources::Access</p>
107
- <p>Provides access to accesses resource at per-project level</p>
108
- <h4>Get accesses for a project</h4>
109
- <p><code>GET /projects/1/accesses.json</code></p>
110
- <pre><code>client.projects(<span class="number">1</span>).accesses!</code></pre>
111
- <h4>Grant access</h4>
112
- <p><code>POST /projects/1/accesses.json</code></p>
113
- <pre><code>client.projects(<span class="number">1</span>).accesses.create!(<span class="symbol">ids:</span> [ <span class="number">5</span>, <span class="number">6</span>, <span class="number">10</span>])</code></pre>
114
- <h4>Revoke access</h4>
115
- <p><code>DELETE /projects/1/accesses/1.json</code></p>
116
- <pre><code>client.projects(<span class="number">1</span>).accesses(<span class="number">1</span>).delete!</code></pre>
117
-
118
- </div>
119
-
120
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
121
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
122
- <span class="class"><span class="keyword">class</span> <span class="title">Access</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
123
-
124
- <span class="keyword">end</span>
125
- <span class="keyword">end</span>
126
- <span class="keyword">end</span></pre></div></div>
127
-
128
- </li>
129
-
130
- </ul>
131
- </div>
132
- </body>
133
- </html>
data/docs/lib/bcx/resources/authorization.html DELETED
@@ -1,140 +0,0 @@
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 &hellip;</a>
17
- <a class="small" href="javascript:void(0);">+</a>
18
- <div id="jump_wrapper">
19
- <div id="jump_page">
20
-
21
-
22
- <a class="source" href="../../bcx.html">
23
- lib/bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="../client/http.html">
28
- lib/bcx/client/http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="../client/oauth.html">
33
- lib/bcx/client/oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="../configuration.html">
38
- lib/bcx/configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="../launchpad/oauth.html">
43
- lib/bcx/launchpad/oauth.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="access.html">
48
- lib/bcx/resources/access.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="authorization.html">
53
- lib/bcx/resources/authorization.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="person.html">
58
- lib/bcx/resources/person.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="project.html">
63
- lib/bcx/resources/project.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="todo.html">
68
- lib/bcx/resources/todo.rb
69
- </a>
70
-
71
-
72
- <a class="source" href="todolist.html">
73
- lib/bcx/resources/todolist.rb
74
- </a>
75
-
76
-
77
- <a class="source" href="../response_error.html">
78
- lib/bcx/response_error.rb
79
- </a>
80
-
81
-
82
- <a class="source" href="../version.html">
83
- lib/bcx/version.rb
84
- </a>
85
-
86
- </div>
87
- </li>
88
- </ul>
89
-
90
- <ul class="sections">
91
-
92
- <li id="title">
93
- <div class="annotation">
94
- <h1>authorization.rb</h1>
95
- </div>
96
- </li>
97
-
98
-
99
-
100
- <li id="section-1">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-1">&#182;</a>
105
- </div>
106
-
107
- </div>
108
-
109
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
110
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span></pre></div></div>
111
-
112
- </li>
113
-
114
-
115
- <li id="section-2">
116
- <div class="annotation">
117
-
118
- <div class="pilwrap ">
119
- <a class="pilcrow" href="#section-2">&#182;</a>
120
- </div>
121
- <p>Bcx::Resources::Authorization
122
- Provides access to the authorization resource</p>
123
- <p>Fetch authorization
124
- GET /authorization.json</p>
125
- <p> launchpad.authorization!</p>
126
-
127
- </div>
128
-
129
- <div class="content"><div class='highlight'><pre> <span class="class"><span class="keyword">class</span> <span class="title">Authorization</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
130
- url <span class="symbol">:authorization</span>
131
- <span class="keyword">end</span>
132
- <span class="keyword">end</span>
133
- <span class="keyword">end</span></pre></div></div>
134
-
135
- </li>
136
-
137
- </ul>
138
- </div>
139
- </body>
140
- </html>
data/docs/lib/bcx/resources/person.html DELETED
@@ -1,140 +0,0 @@
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 &hellip;</a>
17
- <a class="small" href="javascript:void(0);">+</a>
18
- <div id="jump_wrapper">
19
- <div id="jump_page">
20
-
21
-
22
- <a class="source" href="../../bcx.html">
23
- lib/bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="../client/http.html">
28
- lib/bcx/client/http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="../client/oauth.html">
33
- lib/bcx/client/oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="../configuration.html">
38
- lib/bcx/configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="../launchpad/oauth.html">
43
- lib/bcx/launchpad/oauth.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="access.html">
48
- lib/bcx/resources/access.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="authorization.html">
53
- lib/bcx/resources/authorization.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="person.html">
58
- lib/bcx/resources/person.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="project.html">
63
- lib/bcx/resources/project.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="todo.html">
68
- lib/bcx/resources/todo.rb
69
- </a>
70
-
71
-
72
- <a class="source" href="todolist.html">
73
- lib/bcx/resources/todolist.rb
74
- </a>
75
-
76
-
77
- <a class="source" href="../response_error.html">
78
- lib/bcx/response_error.rb
79
- </a>
80
-
81
-
82
- <a class="source" href="../version.html">
83
- lib/bcx/version.rb
84
- </a>
85
-
86
- </div>
87
- </li>
88
- </ul>
89
-
90
- <ul class="sections">
91
-
92
- <li id="title">
93
- <div class="annotation">
94
- <h1>person.rb</h1>
95
- </div>
96
- </li>
97
-
98
-
99
-
100
- <li id="section-1">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap for-h2">
104
- <a class="pilcrow" href="#section-1">&#182;</a>
105
- </div>
106
- <h2>People</h2>
107
- <p>Provides access to people resource</p>
108
- <h4>Get all people on the account</h4>
109
- <p><code>GET /people.json</code></p>
110
- <pre><code>client.people!</code></pre>
111
- <h4>Get a person</h4>
112
- <p><code>GET /people/123.json</code></p>
113
- <pre><code>client.people!(<span class="number">123</span>)</code></pre>
114
- <h4>Get the current person</h4>
115
- <p><code>GET /people/me.json</code></p>
116
- <pre><code>client.people.me!</code></pre>
117
- <h4>Get assigned todos for a person</h4>
118
- <p><code>GET /people/1/assigned_todos.json</code></p>
119
- <pre><code>client.people(<span class="number">1</span>).assigned_todos</code></pre>
120
- <h4>Delete a person</h4>
121
- <p><code>DELETE /people/123.json</code></p>
122
- <pre><code>client.people(<span class="number">123</span>).delete!</code></pre>
123
-
124
- </div>
125
-
126
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
127
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
128
- <span class="class"><span class="keyword">class</span> <span class="title">Person</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
129
- url <span class="symbol">:people</span>
130
- collection <span class="symbol">:me</span>
131
- <span class="keyword">end</span>
132
- <span class="keyword">end</span>
133
- <span class="keyword">end</span></pre></div></div>
134
-
135
- </li>
136
-
137
- </ul>
138
- </div>
139
- </body>
140
- </html>