RubyGems - bcx - Versions diffs - 0.3.0 → 0.4.0 - Mend

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

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/todolist.html ADDED Viewed

@@ -0,0 +1,158 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>todolist.rb</title>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
+  <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+  <div id="container">
+    <div id="background"></div>
+      <ul id="jump_to">
+        <li>
+          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
+          <a class="small" href="javascript:void(0);">+</a>
+          <div id="jump_wrapper">
+          <div id="jump_page_wrapper">
+            <div id="jump_page">
+                <a class="source" href="bcx.html">
+                  bcx.rb
+                </a>
+                <a class="source" href="http.html">
+                  http.rb
+                </a>
+                <a class="source" href="oauth.html">
+                  oauth.rb
+                </a>
+                <a class="source" href="configuration.html">
+                  configuration.rb
+                </a>
+                <a class="source" href="oauth.html">
+                  oauth.rb
+                </a>
+                <a class="source" href="access.html">
+                  access.rb
+                </a>
+                <a class="source" href="authorization.html">
+                  authorization.rb
+                </a>
+                <a class="source" href="comment.html">
+                  comment.rb
+                </a>
+                <a class="source" href="person.html">
+                  person.rb
+                </a>
+                <a class="source" href="project.html">
+                  project.rb
+                </a>
+                <a class="source" href="todo.html">
+                  todo.rb
+                </a>
+                <a class="source" href="todolist.html">
+                  todolist.rb
+                </a>
+                <a class="source" href="response_error.html">
+                  response_error.rb
+                </a>
+                <a class="source" href="version.html">
+                  version.rb
+                </a>
+            </div>
+          </div>
+        </li>
+      </ul>
+    <ul class="sections">
+          <li id="title">
+              <div class="annotation">
+                  <h1>todolist.rb</h1>
+              </div>
+          </li>
+        <li id="section-1">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-1">&#182;</a>
+              </div>
+              <h2 id="todolists">Todolists</h2>
+<p>Provides access to todolist resoource both at the client level and per-project</p>
+<h4 id="get-all-todolists-for-a-project">Get all todolists for a project</h4>
+<p><code>GET /projects/123/todolists.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists!
+</code></pre><h4 id="get-all-completed-todolists-for-a-project">Get all completed todolists for a project</h4>
+<p><code>GET /projects/1/todolists/completed.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists.completed!
+</code></pre><h4 id="get-todolists-for-all-projects">Get todolists for all projects</h4>
+<p><code>GET /todolists.json</code></p>
+<pre><code>client.todolists!
+</code></pre><h4 id="get-completed-todolists-for-all-projects">Get completed todolists for all projects</h4>
+<p><code>GET /todolists/completed.json</code></p>
+<pre><code>client.todolists.completed!
+</code></pre><h4 id="get-specific-todolist-including-the-todos">Get specific todolist including the todos</h4>
+<p><code>GET /projects/123/todolists/456.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists!(<span class="hljs-number">456</span>)
+</code></pre><h4 id="create-a-new-todolist">Create a new todolist</h4>
+<p><code>POST /projects/1/todolists.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists.create!(<span class="hljs-symbol">name:</span> <span class="hljs-string">'My todolist'</span>, <span class="hljs-symbol">description:</span> <span class="hljs-string">'This is a todolist'</span>)
+</code></pre><h4 id="update-an-existing-todolist">Update an existing todolist</h4>
+<p><code>PUT /projects/123/todolists/456.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists(<span class="hljs-number">456</span>).update!(<span class="hljs-symbol">name:</span> <span class="hljs-string">'Updated todolist'</span>)
+</code></pre><h4 id="delete-a-todolist">Delete a todolist</h4>
+<p><code>DELETE /projects/123/todolists/456.json</code></p>
+<pre><code>client.projects(<span class="hljs-number">123</span>).todolists(<span class="hljs-number">456</span>).delete!
+</code></pre>
+            </div>
+            <div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
+  <span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Resources</span></span>
+    <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Todolist</span> <span class="hljs-inheritance">&lt; <span class="hljs-parent">Rapidash::Base</span></span></span>
+      resource <span class="hljs-symbol">:todos</span>, <span class="hljs-symbol">class_name:</span> <span class="hljs-string">'Bcx::Resources::Todo'</span>
+      resource <span class="hljs-symbol">:comments</span>
+      collection <span class="hljs-symbol">:completed</span>
+    <span class="hljs-keyword">end</span>
+  <span class="hljs-keyword">end</span>
+<span class="hljs-keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>

data/docs/version.html ADDED Viewed

@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>version.rb</title>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
+  <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+  <div id="container">
+    <div id="background"></div>
+      <ul id="jump_to">
+        <li>
+          <a class="large" href="javascript:void(0);">Jump To &hellip;</a>
+          <a class="small" href="javascript:void(0);">+</a>
+          <div id="jump_wrapper">
+          <div id="jump_page_wrapper">
+            <div id="jump_page">
+                <a class="source" href="bcx.html">
+                  bcx.rb
+                </a>
+                <a class="source" href="http.html">
+                  http.rb
+                </a>
+                <a class="source" href="oauth.html">
+                  oauth.rb
+                </a>
+                <a class="source" href="configuration.html">
+                  configuration.rb
+                </a>
+                <a class="source" href="oauth.html">
+                  oauth.rb
+                </a>
+                <a class="source" href="access.html">
+                  access.rb
+                </a>
+                <a class="source" href="authorization.html">
+                  authorization.rb
+                </a>
+                <a class="source" href="comment.html">
+                  comment.rb
+                </a>
+                <a class="source" href="person.html">
+                  person.rb
+                </a>
+                <a class="source" href="project.html">
+                  project.rb
+                </a>
+                <a class="source" href="todo.html">
+                  todo.rb
+                </a>
+                <a class="source" href="todolist.html">
+                  todolist.rb
+                </a>
+                <a class="source" href="response_error.html">
+                  response_error.rb
+                </a>
+                <a class="source" href="version.html">
+                  version.rb
+                </a>
+            </div>
+          </div>
+        </li>
+      </ul>
+    <ul class="sections">
+          <li id="title">
+              <div class="annotation">
+                  <h1>version.rb</h1>
+              </div>
+          </li>
+        <li id="section-1">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-1">&#182;</a>
+              </div>
+            </div>
+            <div class="content"><div class='highlight'><pre><span class="hljs-class"><span class="hljs-keyword">module</span> <span class="hljs-title">Bcx</span></span>
+  <span class="hljs-constant">VERSION</span> = <span class="hljs-string">"0.4.0"</span>
+<span class="hljs-keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>

data/lib/bcx/resources/comment.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# ## Comments
+#
+# Provides access to comments resource on todo or todolist level
+#
+# #### Create a new todolist comment
+# `POST /projects/123/todolist/456/comments.json`
+#
+#     client.projects(123).todolists(456).comments.create!(content: 'New comment')
+#
+# #### Create a new todo comment
+# `POST /projects/123/todo/456/comments.json`
+#
+#     client.projects(123).todos(456).comments.create!(content: 'New comment')
+#
+#
+# #### Delete the comment
+# `DELETE /projects/123/comments/456.json`
+#
+#     client.projects(123).comments(456).delete!
+#
+module Bcx
+  module Resources
+    class Comment < Rapidash::Base
+    end
+  end
+end

data/lib/bcx/resources/project.rb CHANGED Viewed

@@ -38,6 +38,7 @@ module Bcx
       resource :todolists
       resource :todos
       resource :accesses
+      resource :comments
       collection :archived
     end

data/lib/bcx/resources/todo.rb CHANGED Viewed

@@ -32,6 +32,7 @@
 module Bcx
   module Resources
     class Todo < Rapidash::Base
+      resource :comments
     end
   end
 end

data/lib/bcx/resources/todolist.rb CHANGED Viewed

@@ -46,6 +46,7 @@ module Bcx
   module Resources
     class Todolist < Rapidash::Base
       resource :todos, class_name: 'Bcx::Resources::Todo'
+      resource :comments
       collection :completed
     end

data/lib/bcx/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Bcx
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/bcx.rb CHANGED Viewed

@@ -16,6 +16,7 @@ module Bcx
     autoload :Person, 'bcx/resources/person'
     autoload :Access, 'bcx/resources/access'
     autoload :Authorization, 'bcx/resources/authorization'
+    autoload :Comment, 'bcx/resources/comment'
   end
   module Client

data/lib/tasks/docs.rake CHANGED Viewed

@@ -4,10 +4,12 @@ namespace :docs do
     ensure_clean_git
     run "git checkout #{branch}"
     run "docco lib/**/*.rb"
-    run "git commit -am 'Updated documentation'"
+    run "git add -A ."
+    run "git commit -m 'Updated documentation'"
     run "git checkout gh-pages"
     run "git checkout #{branch} -- docs/" # Copy docs changes across and stage
-    run "git commit -am 'Updated docs on gh-pages'"
+    run "git add -A ."
+    run "git commit -m 'Updated docs on gh-pages'"
     run "git checkout #{branch}"
   end

data/spec/bcx/comment_spec.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require 'spec_helper'
+describe Bcx::Resources::Comment, :vcr do
+  let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
+  describe "POST /projects/9634353/todos/185137845/comments.json" do
+    it "should create a new todo comment" do
+      comment = client.projects(9634353).todos(185137845).comments.create!(content: 'New Todo comment')
+      expect(comment.created_at).not_to be_blank
+    end
+  end
+  describe "POST /projects/9634353/todolists/29123043/comments.json" do
+    it "should create a new todolist comment" do
+      comment = client.projects(9634353).todolists(29123043).comments.create!(content: 'New TodoList comment')
+      expect(comment.created_at).not_to be_blank
+    end
+  end
+  describe "DELETE /projects/9634353/comments/297584179.json" do
+    it "should delete the given comment" do
+      client.projects(9634353).comments(297584179).delete!
+      expect { client.projects(9634353).comments!(297584179) }.to raise_error { |error|
+        expect(error).to be_a Bcx::ResponseError
+        expect(error.status).to eq 404
+      }
+    end
+  end
+end

data/spec/cassettes/Bcx_Resources_Comment/DELETE_/projects/9634353/comments/297584179_json/should_delete_the_given_comment.yml ADDED Viewed

@@ -0,0 +1,140 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://basecamp.com/2274488/api/v1/projects/9634353/comments/297584179.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Authorization:
+      - Basic N3IwZ2d3QGdtYWlsLmNvbTpCQ1BabGhma2IyNjU=
+  response:
+    status:
+      code: 204
+      message:
+    headers:
+      server:
+      - openresty
+      date:
+      - Tue, 23 Jun 2015 14:39:05 GMT
+      connection:
+      - close
+      status:
+      - 204 No Content
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      x-asset-paths:
+      - '{"desktop.js":"desktop-ffff6ab2353adfd35273439e2b190a97.js","desktop.css":"desktop-d7e97abbc9c3540e9ab5d7537c0b4a05.css"}'
+      cache-control:
+      - no-cache
+      x-request-id:
+      - 9e107a64-ce2b-4d87-a469-8f42b4c0f3d1
+      x-runtime:
+      - '0.250619'
+      x-queue-time:
+      - '0.0011830329895019531'
+      timing-allow-origin:
+      - "*"
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version:
+  recorded_at: Tue, 23 Jun 2015 14:39:05 GMT
+- request:
+    method: get
+    uri: https://basecamp.com/2274488/api/v1/projects/9634353/comments/297584179.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Authorization:
+      - Basic N3IwZ2d5QGdtYWlsLmNvbTpCQ1BmbGhma2IyNjU=
+  response:
+    status:
+      code: 404
+      message:
+    headers:
+      server:
+      - openresty
+      date:
+      - Tue, 23 Jun 2015 14:39:06 GMT
+      content-type:
+      - application/json; charset=utf-8
+      content-length:
+      - '36'
+      connection:
+      - close
+      status:
+      - 404 Not Found
+      x-request-id:
+      - 8872d9af-2656-4f3a-88b5-0929826f4567
+      x-runtime:
+      - '0.066340'
+      x-queue-time:
+      - '0.0009946823120117188'
+    body:
+      encoding: UTF-8
+      string: '{"status":"404","error":"Not Found"}'
+    http_version:
+  recorded_at: Tue, 23 Jun 2015 14:39:06 GMT
+- request:
+    method: delete
+    uri: https://basecamp.com/2274488/api/v1/projects/9634353/comments/297584179.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Authorization:
+      - Basic YmN4LXRlc3QtdXNlcjpzZWNyZXQ=
+  response:
+    status:
+      code: 404
+      message:
+    headers:
+      server:
+      - openresty
+      date:
+      - Tue, 23 Jun 2015 14:40:28 GMT
+      content-type:
+      - application/json
+      connection:
+      - Keep-Alive
+      status:
+      - 404 Not Found
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      reason:
+      - Account Inactive
+      cache-control:
+      - no-cache
+      x-request-id:
+      - 9a1cc87c-47d1-4fd2-b286-9560ab618a59
+      x-runtime:
+      - '0.031792'
+      x-queue-time:
+      - '0.0011222362518310547'
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '23'
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    http_version:
+  recorded_at: Tue, 23 Jun 2015 14:40:28 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/Bcx_Resources_Comment/POST_/projects/9634353/todolists/29123043/comments_json/should_create_a_new_todolist_comment.yml ADDED Viewed

@@ -0,0 +1,114 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://basecamp.com/2274488/api/v1/projects/9634353/todolists/29123043/comments.json
+    body:
+      encoding: UTF-8
+      string: '{"content":"New TodoList comment"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Authorization:
+      - Basic N2IwZ2d5QGdtYWlsLmNvbTpCQ1BmbGhma2IyNjU=
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message:
+    headers:
+      server:
+      - openresty
+      date:
+      - Tue, 23 Jun 2015 14:38:13 GMT
+      content-type:
+      - application/json; charset=utf-8
+      connection:
+      - Keep-Alive
+      status:
+      - 201 Created
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      x-asset-paths:
+      - '{"desktop.js":"desktop-ffff6ab2353adfd35273439e2b190a97.js","desktop.css":"desktop-d7e97abbc9c3540e9ab5d7537c0b4a05.css"}'
+      etag:
+      - '"e0151f0dceb5a1754f860b907ca2fe99"'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-request-id:
+      - d7cf177a-f7f0-480b-951c-06b4ce9eaa36
+      x-runtime:
+      - '0.217618'
+      x-queue-time:
+      - '0.0010294914245605469'
+      timing-allow-origin:
+      - "*"
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '400'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":297586622,"content":"New TodoList comment","created_at":"2015-06-23T21:38:13.156+07:00","updated_at":"2015-06-23T21:38:13.156+07:00","private":false,"trashed":false,"attachments":[],"creator":{"id":9056757,"name":"Kosta
+        Korenkov","avatar_url":"http://cdn.37img.com/global/8763e3387c99c11693eef859f5e1ebc30010/avatar.gif?r=3","fullsize_avatar_url":"https://cdn.37img.com/global/8763e3387c99c11693eef859f5e1ebc30010/original.gif?r=3"},"topic_url":"https://basecamp.com/2274488/api/v1/projects/9634353/todolists/29123043.json","topic_app_url":"https://basecamp.com/2274488/projects/9634353/todolists/29123043"}'
+    http_version:
+  recorded_at: Tue, 23 Jun 2015 14:38:13 GMT
+- request:
+    method: post
+    uri: https://basecamp.com/2274488/api/v1/projects/9634353/todolists/29123043/comments.json
+    body:
+      encoding: UTF-8
+      string: '{"content":"New TodoList comment"}'
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Authorization:
+      - Basic YmN4LXRlc3QtdXNlcjpzZWNyZXQ=
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 404
+      message:
+    headers:
+      server:
+      - openresty
+      date:
+      - Tue, 23 Jun 2015 14:40:27 GMT
+      content-type:
+      - application/json
+      connection:
+      - Keep-Alive
+      status:
+      - 404 Not Found
+      x-frame-options:
+      - SAMEORIGIN
+      x-xss-protection:
+      - 1; mode=block
+      x-content-type-options:
+      - nosniff
+      reason:
+      - Account Inactive
+      cache-control:
+      - no-cache
+      x-request-id:
+      - 4046a382-1e93-4f8d-84b3-882afb287dfe
+      x-runtime:
+      - '0.036859'
+      x-queue-time:
+      - '0.00047588348388671875'
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '23'
+    body:
+      encoding: ASCII-8BIT
+      string: ''
+    http_version:
+  recorded_at: Tue, 23 Jun 2015 14:40:27 GMT
+recorded_with: VCR 2.9.3