bcx 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (29) hide show
  1. data/Gemfile +0 -2
  2. data/README.md +8 -9
  3. data/Rakefile +2 -0
  4. data/bcx.gemspec +1 -1
  5. data/docs/configuration.html +0 -35
  6. data/docs/response_error.html +0 -35
  7. data/docs/version.html +1 -36
  8. data/lib/bcx/client/http.rb +1 -1
  9. data/lib/bcx/client/oauth.rb +1 -1
  10. data/lib/bcx/resources/person.rb +2 -1
  11. data/lib/bcx/resources/project.rb +34 -34
  12. data/lib/bcx/resources/todo.rb +31 -31
  13. data/lib/bcx/resources/todolist.rb +44 -44
  14. data/lib/bcx/version.rb +1 -1
  15. data/lib/bcx.rb +2 -1
  16. data/lib/rapidash/collection.rb +33 -0
  17. data/lib/tasks/docs.rake +41 -0
  18. metadata +18 -27
  19. data/docs/bcx.html +0 -171
  20. data/docs/http.html +0 -125
  21. data/docs/oauth.html +0 -127
  22. data/docs/person.html +0 -125
  23. data/docs/project.html +0 -143
  24. data/docs/public/fonts/fleurons.eot +0 -0
  25. data/docs/public/fonts/fleurons.ttf +0 -0
  26. data/docs/public/fonts/fleurons.woff +0 -0
  27. data/docs/public/images/gray.png +0 -0
  28. data/docs/todo.html +0 -138
  29. data/docs/todolist.html +0 -148
data/docs/person.html DELETED
@@ -1,125 +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
- bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="http.html">
28
- http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="oauth.html">
33
- oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="configuration.html">
38
- configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="person.html">
43
- person.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="project.html">
48
- project.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="todo.html">
53
- todo.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="todolist.html">
58
- todolist.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="response_error.html">
63
- response_error.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="version.html">
68
- version.rb
69
- </a>
70
-
71
- </div>
72
- </li>
73
- </ul>
74
-
75
- <ul class="sections">
76
-
77
- <li id="title">
78
- <div class="annotation">
79
- <h1>person.rb</h1>
80
- </div>
81
- </li>
82
-
83
-
84
-
85
- <li id="section-1">
86
- <div class="annotation">
87
-
88
- <div class="pilwrap ">
89
- <a class="pilcrow" href="#section-1">&#182;</a>
90
- </div>
91
- <p><code>Bcx::Resources::Person</code>
92
- Provides access to people resource</p>
93
- <h4>Get all people on the account</h4>
94
- <p><code>GET /people.json</code></p>
95
- <pre><code>client.people!</code></pre>
96
- <h4>Get a person</h4>
97
- <p><code>GET /people/123.json</code></p>
98
- <pre><code>client.people!(123)</code></pre>
99
- <h4>Get the current person</h4>
100
- <p><code>GET /people/me.json</code></p>
101
- <pre><code>client.people.me!</code></pre>
102
- <h4>Get assigned todos for a person</h4>
103
- <p><code>GET /people/1/assigned_todos.json</code></p>
104
- <pre><code>client.people(1).assigned_todos</code></pre>
105
- <h4>Delete a person</h4>
106
- <p><code>DELETE /people/123.json</code></p>
107
- <pre><code>client.people(123).delete!</code></pre>
108
-
109
- </div>
110
-
111
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
112
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span>
113
- <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>
114
- url <span class="symbol">:people</span>
115
- collection <span class="symbol">:me</span>
116
- <span class="keyword">end</span>
117
- <span class="keyword">end</span>
118
- <span class="keyword">end</span></pre></div></div>
119
-
120
- </li>
121
-
122
- </ul>
123
- </div>
124
- </body>
125
- </html>
data/docs/project.html DELETED
@@ -1,143 +0,0 @@
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 &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
- bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="http.html">
28
- http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="oauth.html">
33
- oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="configuration.html">
38
- configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="person.html">
43
- person.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="project.html">
48
- project.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="todo.html">
53
- todo.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="todolist.html">
58
- todolist.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="response_error.html">
63
- response_error.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="version.html">
68
- version.rb
69
- </a>
70
-
71
- </div>
72
- </li>
73
- </ul>
74
-
75
- <ul class="sections">
76
-
77
- <li id="title">
78
- <div class="annotation">
79
- <h1>project.rb</h1>
80
- </div>
81
- </li>
82
-
83
-
84
-
85
- <li id="section-1">
86
- <div class="annotation">
87
-
88
- <div class="pilwrap ">
89
- <a class="pilcrow" href="#section-1">&#182;</a>
90
- </div>
91
-
92
- </div>
93
-
94
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
95
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span></pre></div></div>
96
-
97
- </li>
98
-
99
-
100
- <li id="section-2">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-2">&#182;</a>
105
- </div>
106
- <p>Bcx::Resources::Project
107
- Provides access to projects resoource and other nested resources</p>
108
- <p>Fetch all projects
109
- GET /projects.json</p>
110
- <p> client.projects!</p>
111
- <p>Fetch archived projects
112
- GET /projects/archived.json</p>
113
- <p> clients.projects.archived!</p>
114
- <p>Fetch single project with ID of 123
115
- GET /projects/123.json</p>
116
- <p> client.projects!(123)</p>
117
- <p>Create a project
118
- POST /projects.json</p>
119
- <p> client.projects.create!(name: &#39;Acme project&#39;, description: &#39;This is a new project&#39;)</p>
120
- <p>Update an existing project
121
- PUT /projects/123.json</p>
122
- <p> client.projects(123).update!(description: &#39;A new description&#39;)</p>
123
- <p>Delete a project
124
- DELETE /projects/123.json</p>
125
- <p> client.projects(123).delete!</p>
126
-
127
- </div>
128
-
129
- <div class="content"><div class='highlight'><pre> <span class="class"><span class="keyword">class</span> <span class="title">Project</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
130
- resource <span class="symbol">:todolists</span>
131
- resource <span class="symbol">:todos</span>
132
-
133
- collection <span class="symbol">:archived</span>
134
- <span class="keyword">end</span>
135
- <span class="keyword">end</span>
136
- <span class="keyword">end</span></pre></div></div>
137
-
138
- </li>
139
-
140
- </ul>
141
- </div>
142
- </body>
143
- </html>
data/docs/public/fonts/fleurons.eot DELETED
Binary file
data/docs/public/fonts/fleurons.ttf DELETED
Binary file
data/docs/public/fonts/fleurons.woff DELETED
Binary file
data/docs/public/images/gray.png DELETED
Binary file
data/docs/todo.html DELETED
@@ -1,138 +0,0 @@
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 &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
- bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="http.html">
28
- http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="oauth.html">
33
- oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="configuration.html">
38
- configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="person.html">
43
- person.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="project.html">
48
- project.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="todo.html">
53
- todo.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="todolist.html">
58
- todolist.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="response_error.html">
63
- response_error.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="version.html">
68
- version.rb
69
- </a>
70
-
71
- </div>
72
- </li>
73
- </ul>
74
-
75
- <ul class="sections">
76
-
77
- <li id="title">
78
- <div class="annotation">
79
- <h1>todo.rb</h1>
80
- </div>
81
- </li>
82
-
83
-
84
-
85
- <li id="section-1">
86
- <div class="annotation">
87
-
88
- <div class="pilwrap ">
89
- <a class="pilcrow" href="#section-1">&#182;</a>
90
- </div>
91
-
92
- </div>
93
-
94
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
95
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span></pre></div></div>
96
-
97
- </li>
98
-
99
-
100
- <li id="section-2">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-2">&#182;</a>
105
- </div>
106
- <p>Bcx::Resources::Todo
107
- Provides access to todolist resoource both at the client level and per-project</p>
108
- <p>Get todos for a todolist
109
- GET /todolists/1.json</p>
110
- <p> todolist = client.todolists!(1)
111
- todolist.todos.remaining
112
- todolist.todos.completed</p>
113
- <p>Get a specific todo
114
- GET /projects/1/todos/2.json</p>
115
- <p> client.projects(1).todos!(2)</p>
116
- <p>Create a todo
117
- POST /projects/1/todolists/2/todos.json</p>
118
- <p> client.projects(1).todolists(2).todos.create!(content: &#39;Update copy text&#39;)</p>
119
- <p>Update a todo
120
- PUT /projects/1/todos/2.json</p>
121
- <p> client.projects(1).todos(2).update!(completed: true)</p>
122
- <p>Delete a todo
123
- DELETE /projects/1/todos/2.json</p>
124
- <p> client.projects(1).todos(2).delete!</p>
125
-
126
- </div>
127
-
128
- <div class="content"><div class='highlight'><pre> <span class="class"><span class="keyword">class</span> <span class="title">Todo</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
129
- <span class="keyword">end</span>
130
- <span class="keyword">end</span>
131
- <span class="keyword">end</span></pre></div></div>
132
-
133
- </li>
134
-
135
- </ul>
136
- </div>
137
- </body>
138
- </html>
data/docs/todolist.html DELETED
@@ -1,148 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <title>todolist.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
- bcx.rb
24
- </a>
25
-
26
-
27
- <a class="source" href="http.html">
28
- http.rb
29
- </a>
30
-
31
-
32
- <a class="source" href="oauth.html">
33
- oauth.rb
34
- </a>
35
-
36
-
37
- <a class="source" href="configuration.html">
38
- configuration.rb
39
- </a>
40
-
41
-
42
- <a class="source" href="person.html">
43
- person.rb
44
- </a>
45
-
46
-
47
- <a class="source" href="project.html">
48
- project.rb
49
- </a>
50
-
51
-
52
- <a class="source" href="todo.html">
53
- todo.rb
54
- </a>
55
-
56
-
57
- <a class="source" href="todolist.html">
58
- todolist.rb
59
- </a>
60
-
61
-
62
- <a class="source" href="response_error.html">
63
- response_error.rb
64
- </a>
65
-
66
-
67
- <a class="source" href="version.html">
68
- version.rb
69
- </a>
70
-
71
- </div>
72
- </li>
73
- </ul>
74
-
75
- <ul class="sections">
76
-
77
- <li id="title">
78
- <div class="annotation">
79
- <h1>todolist.rb</h1>
80
- </div>
81
- </li>
82
-
83
-
84
-
85
- <li id="section-1">
86
- <div class="annotation">
87
-
88
- <div class="pilwrap ">
89
- <a class="pilcrow" href="#section-1">&#182;</a>
90
- </div>
91
-
92
- </div>
93
-
94
- <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
95
- <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span></pre></div></div>
96
-
97
- </li>
98
-
99
-
100
- <li id="section-2">
101
- <div class="annotation">
102
-
103
- <div class="pilwrap ">
104
- <a class="pilcrow" href="#section-2">&#182;</a>
105
- </div>
106
- <p>Bcx::Resources::Todolist
107
- Provides access to todolist resoource both at the client level and per-project</p>
108
- <p>Get all todolists for a project
109
- GET /projects/123/todolists.json</p>
110
- <p> client.projects(123).todolists!</p>
111
- <p>Get all completed todolists for a project
112
- GET /projects/1/todolists/completed.json</p>
113
- <p> client.projects(123).todolists.completed!</p>
114
- <p>Get todolists for all projects
115
- GET /todolists.json</p>
116
- <p> client.todolists!</p>
117
- <p>Get completed todolists for all projects
118
- GET /todolists/completed.json</p>
119
- <p> client.todolists.completed!</p>
120
- <p>Get specific todolist including the todos
121
- GET /projects/123/todolists/456.json</p>
122
- <p> client.projects(123).todolists!(456)</p>
123
- <p>Create a new todolist
124
- POST /projects/1/todolists.json</p>
125
- <p> client.projects(123).todolists.create!(name: &#39;My todolist&#39;, description: &#39;This is a todolist&#39;)</p>
126
- <p>Update an existing todolist
127
- PUT /projects/123/todolists/456.json</p>
128
- <p> client.projects(123).todolists(456).update!(name: &#39;Updated todolist&#39;)</p>
129
- <p>Delete a todolist
130
- DELETE /projects/123/todolists/456.json</p>
131
- <p> client.projects(123).todolists(456).delete!</p>
132
-
133
- </div>
134
-
135
- <div class="content"><div class='highlight'><pre> <span class="class"><span class="keyword">class</span> <span class="title">Todolist</span> <span class="inheritance">&lt; <span class="parent">Rapidash::Base</span></span></span>
136
- resource <span class="symbol">:todos</span>, <span class="symbol">class_name:</span> <span class="string">'Bcx::Resources::Todo'</span>
137
-
138
- collection <span class="symbol">:completed</span>
139
- <span class="keyword">end</span>
140
- <span class="keyword">end</span>
141
- <span class="keyword">end</span></pre></div></div>
142
-
143
- </li>
144
-
145
- </ul>
146
- </div>
147
- </body>
148
- </html>