RubyGems - bcx - Versions diffs - 0.0.2 → 0.1.0 - Mend

bcx 0.0.2 → 0.1.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 (60) hide show

data/docs/todolist.html ADDED Viewed

@@ -0,0 +1,148 @@
+<!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">
+              <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="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>
+        </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>
+            </div>
+            <div class="content"><div class='highlight'><pre><span class="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
+  <span class="class"><span class="keyword">module</span> <span class="title">Resources</span></span></pre></div></div>
+        </li>
+        <li id="section-2">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-2">&#182;</a>
+              </div>
+              <p>Bcx::Resources::Todolist
+Provides access to todolist resoource both at the client level and per-project</p>
+<p>Get all todolists for a project
+GET /projects/123/todolists.json</p>
+<p>  client.projects(123).todolists!</p>
+<p>Get all completed todolists for a project
+GET /projects/1/todolists/completed.json</p>
+<p>  client.projects(123).todolists.completed!</p>
+<p>Get todolists for all projects
+GET /todolists.json</p>
+<p>  client.todolists!</p>
+<p>Get completed todolists for all projects
+GET /todolists/completed.json</p>
+<p>  client.todolists.completed!</p>
+<p>Get specific todolist including the todos
+GET /projects/123/todolists/456.json</p>
+<p>  client.projects(123).todolists!(456)</p>
+<p>Create a new todolist
+POST /projects/1/todolists.json</p>
+<p>  client.projects(123).todolists.create!(name: &#39;My todolist&#39;, description: &#39;This is a todolist&#39;)</p>
+<p>Update an existing todolist
+PUT /projects/123/todolists/456.json</p>
+<p>  client.projects(123).todolists(456).update!(name: &#39;Updated todolist&#39;)</p>
+<p>Delete a todolist
+DELETE /projects/123/todolists/456.json</p>
+<p>  client.projects(123).todolists(456).delete!</p>
+            </div>
+            <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>
+      resource <span class="symbol">:todos</span>, <span class="symbol">class_name:</span> <span class="string">'Bcx::Resources::Todo'</span>
+      collection <span class="symbol">:completed</span>
+    <span class="keyword">end</span>
+  <span class="keyword">end</span>
+<span class="keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>

data/docs/version.html ADDED Viewed

@@ -0,0 +1,103 @@
+<!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">
+              <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="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>
+        </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="class"><span class="keyword">module</span> <span class="title">Bcx</span></span>
+  <span class="constant">VERSION</span> = <span class="string">"0.0.2"</span>
+<span class="keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>

data/lib/bcx/client/http.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module Bcx
+  module Client
+    class HTTP < Rapidash::Client
+      method :http
+      extension :json
+      encode_post_data_with :json
+      raise_errors
+      resource :projects, class_name: 'Bcx::Resources::Project'
+      resource :todolists, class_name: 'Bcx::Resources::Todolist'
+      resource :people, class_name: 'Bcx::Resources::Person'
+      def initialize(options = {})
+        @account = Bcx.configuration.account
+        @api_version = Bcx.configuration.api_version
+        self.class.site("https://basecamp.com/#{@account}/api/#{@api_version}/")
+        super(options)
+      end
+    end
+  end
+end

data/lib/bcx/client/oauth.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module Bcx
+  module Client
+    class OAuth < Rapidash::Client
+      method :oauth
+      extension :json
+      encode_post_data_with :json
+      raise_errors
+      resource :projects, class_name: 'Bcx::Resources::Project'
+      resource :todolists, class_name: 'Bcx::Resources::Todolist'
+      resource :people, class_name: 'Bcx::Resources::Person'
+      def initialize(options = {})
+        @account = Bcx.configuration.account
+        @api_version = Bcx.configuration.api_version
+        options[:site] = "https://basecamp.com/#{@account}/api/#{@api_version}"
+        options[:uid] ||= options[:client_id]
+        options[:secret] ||= options[:client_secret]
+        super(options)
+      end
+    end
+  end
+end

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

@@ -1,13 +1,36 @@
+# `Bcx::Resources::Person`
+# Provides access to people resource
+#
+# #### Get all people on the account
+# `GET /people.json`
+#
+#     client.people!
+#
+# #### Get a person
+# `GET /people/123.json`
+#
+#     client.people!(123)
+#
+# #### Get the current person
+# `GET /people/me.json`
+#
+#     client.people.me!
+#
+# #### Get assigned todos for a person
+# `GET /people/1/assigned_todos.json`
+#
+#     client.people(1).assigned_todos
+#
+# #### Delete a person
+# `DELETE /people/123.json`
+#
+#     client.people(123).delete!
+#
 module Bcx
   module Resources
-    # Get todolists with assigned todos for a person
-    # GET /people/1/assigned_todos.json
-    #
-    #   client.people(1).assigned_todos
-    #
     class Person < Rapidash::Base
+      url :people
+      collection :me
     end
   end
 end

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

@@ -7,41 +7,38 @@ module Bcx
     # Fetch all projects
     # GET /projects.json
     #
-    #   client.projects!
+    #     client.projects!
     #
     # Fetch archived projects
     # GET /projects/archived.json
     #
-    #   clients.projects.archived!
+    #     clients.projects.archived!
     #
     # Fetch single project with ID of 123
     # GET /projects/123.json
     #
-    #   client.projects!(123)
+    #     client.projects!(123)
     #
     # Create a project
     # POST /projects.json
     #
-    #   client.projects.create!(name: 'Acme project', description: 'This is a new project')
+    #     client.projects.create!(name: 'Acme project', description: 'This is a new project')
     #
     # Update an existing project
     # PUT /projects/123.json
     #
-    #   client.projects(123).update!(description: 'A new description')
+    #     client.projects(123).update!(description: 'A new description')
     #
     # Delete a project
     # DELETE /projects/123.json
     #
-    #   client.projects(123).delete!
+    #     client.projects(123).delete!
     #
     class Project < Rapidash::Base
       resource :todolists
       resource :todos
-      def archived!
-        @url += '/archived'
-        call!
-      end
+      collection :archived
     end
   end
 end

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

@@ -34,13 +34,20 @@ module Bcx
     #
     #   client.projects(123).todolists.create!(name: 'My todolist', description: 'This is a todolist')
     #
+    # Update an existing todolist
+    # PUT /projects/123/todolists/456.json
+    #
+    #   client.projects(123).todolists(456).update!(name: 'Updated todolist')
+    #
+    # Delete a todolist
+    # DELETE /projects/123/todolists/456.json
+    #
+    #   client.projects(123).todolists(456).delete!
+    #
     class Todolist < Rapidash::Base
       resource :todos, class_name: 'Bcx::Resources::Todo'
-      def completed!
-        @url += '/completed'
-        call!
-      end
+      collection :completed
     end
   end
 end

data/lib/bcx/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Bcx
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/bcx.rb CHANGED Viewed

@@ -1,6 +1,11 @@
 require 'rapidash'
 require 'bcx/version'
+# # Bcx
+# Fully-fledged Ruby API wrapper for Basecamp Next
+#
+#  See the [README](https://github.com/paulspringett/bcx#readme) for usage
+#
 module Bcx
   autoload :Configuration, 'bcx/configuration'
@@ -8,19 +13,25 @@ module Bcx
     autoload :Todo, 'bcx/resources/todo'
     autoload :Todolist, 'bcx/resources/todolist'
     autoload :Project, 'bcx/resources/project'
+    autoload :Person, 'bcx/resources/person'
   end
-  autoload :Client, 'bcx/client'
+  module Client
+    autoload :HTTP, 'bcx/client/http'
+    autoload :OAuth, 'bcx/client/oauth'
+  end
   class << self
     attr_accessor :configuration
   end
+  # Expose configuration block
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
   end
 end
+# Use custom `Bcx::ResponseError` on top of Rapidash's error handling
 require 'bcx/response_error'
 Rapidash.response_exception_class = Bcx::ResponseError

data/spec/bcx/client_spec.rb CHANGED Viewed

@@ -2,9 +2,9 @@ require 'spec_helper'
 describe Bcx::Client do
-  let(:client) { Bcx::Client.new(:http, login: 'bcx-test-user', password: 'secret') }
+  context "http auth" do
+    let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
-  describe "http auth" do
     it "should assign login" do
       expect(client.login).to eq 'bcx-test-user'
     end
@@ -18,23 +18,28 @@ describe Bcx::Client do
     end
   end
-  # TODO: test handling to reponse errors, with error codes
-  # it "should fail for invalid attributes" do
-  #   expect { client.projects.create!(name: '') }.to raise_error { |error|
-  #     expect(error).to be_a Bcx::ResponseError
-  #     expect(error.status).to eq 422
-  #   }
-  # end
-  # Rescue a response error example
-  # begin
-  #   project = client.projects.create!(name: 'foo')
-  # rescue Bcx::ResponseError => response
-  #   puts response.status
-  #   => 422
-  #   puts response.body
-  #   => "Name cannot be blank"
-  # end
+  context "oauth" do
+    let(:client) { Bcx::Client::OAuth.new(client_id: '748cc9c949af86f2e3fb35564f7e209b1d2c27d2', client_secret: '7fba79ec3bf1eb9e278098031414e5a3a41ec842', access_token: 'BAhbByIBsHsiZXhwaXJlc19hdCI6IjIwMTMtMDctMDFUMjE6MTI6MDFaIiwidXNlcl9pZHMiOlsxNzE3NDMwNV0sImNsaWVudF9pZCI6Ijc0OGNjOWM5NDlhZjg2ZjJlM2ZiMzU1NjRmN2UyMDliMWQyYzI3ZDIiLCJ2ZXJzaW9uIjoxLCJhcGlfZGVhZGJvbHQiOiJmZmE1OTgzMzQ3YTY2MWExM2Y1YWE3YTM0ODVhYzk4YiJ9dToJVGltZQ01WBzApGcWMA==--20fd0c6159b19ee6689e149590b14be5fd98bb3b') }
+    it "should assign credentials" do
+      expect(client.uid).to eq '748cc9c949af86f2e3fb35564f7e209b1d2c27d2'
+      expect(client.secret).to eq '7fba79ec3bf1eb9e278098031414e5a3a41ec842'
+    end
+    it "should provide an access token" do
+      expect(client.access_token).not_to be_nil
+    end
+  end
+  describe "error handling", :vcr do
+    let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
+    it "should raise exception" do
+      expect { client.projects.create!(name: '') }.to raise_error { |response|
+        expect(response).to be_a Bcx::ResponseError
+        expect(response.status).to eq 422
+        expect(response.errors).to include("name can't be blank")
+      }
+    end
+  end
 end

data/spec/bcx/person_spec.rb ADDED Viewed

@@ -0,0 +1,55 @@
+require 'spec_helper'
+describe Bcx::Resources::Person, :vcr do
+  let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
+  describe "GET /people.json" do
+    let(:people) { client.people! }
+    it "should be an array" do
+      expect(people).to be_an Array
+    end
+    it "first person should have the correct id" do
+      expect(people.first.id).to eq 4666033
+    end
+  end
+  describe "GET /people/4666033.json" do
+    let(:person) { client.people!(4666033) }
+    it "should return a hash" do
+      expect(person).to be_a Hashie::Mash
+    end
+    it "should have the correct id" do
+      expect(person.id).to eq 4666033
+    end
+  end
+  describe "GET /people/me.json" do
+    let(:person) { client.people.me! }
+    it "should return a hash" do
+      expect(person).to be_a Hashie::Mash
+    end
+    it "should have the correct id" do
+      expect(person.id).to eq 4666033
+    end
+    it "should have assigned todos" do
+      expect(person.assigned_todos).to be_a Hashie::Mash
+    end
+  end
+  describe "DELETE /people/4904728.json" do
+    it "should delete a todolist" do
+      client.people(4904728).delete!
+      expect { client.people!(4904728) }.to raise_error { |error|
+        expect(error).to be_a Bcx::ResponseError
+        expect(error.status).to eq 404
+      }
+    end
+  end
+end

data/spec/bcx/project_spec.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 require 'spec_helper'
 describe Bcx::Resources::Project, :vcr do
-  let(:client) { Bcx::Client.new(:http, login: 'bcx-test-user', password: 'secret') }
+  let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
   describe "GET /projects" do
     let(:projects) { client.projects! }

data/spec/bcx/todo_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'spec_helper'
+describe Bcx::Resources::Todo, :vcr do
+  let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
+  describe "POST /projects/2951531/todolists/8268819/todos.json" do
+    it "should create a new todo" do
+      todo = client.projects(2951531).todolists(8268819).todos.create!(content: 'My todo')
+      expect(todo.created_at).not_to be_blank
+      expect(todo.content).to eq 'My todo'
+    end
+  end
+  describe "GET /projects/2951531/todos/48545200.json" do
+    let(:todo) { client.projects(2951531).todos!(48545200) }
+    it "should return a hash" do
+      expect(todo).to be_a Hashie::Mash
+    end
+    it "should have the correct id" do
+      expect(todo.id).to eq 48545200
+      expect(todo.content).to eq 'First todo'
+    end
+  end
+  describe "PUT /projects/2951531/todos/48545200.json" do
+    it "should update an existing todo" do
+      todo = client.projects(2951531).todos(48545200).update!(content: 'My updated todo')
+      expect(todo.content).to eq 'My updated todo'
+    end
+  end
+  describe "DELETE /projects/2951531/todos/48545200.json" do
+    it "should delete the given todo" do
+      client.projects(2951531).todos(48545200).delete!
+      expect { client.projects(2951531).todos!(48545200) }.to raise_error { |error|
+        expect(error).to be_a Bcx::ResponseError
+        expect(error.status).to eq 404
+      }
+    end
+  end
+end

data/spec/bcx/todolist_spec.rb CHANGED Viewed

@@ -1,8 +1,7 @@
 require 'spec_helper'
 describe Bcx::Resources::Todolist, :vcr do
-  let(:client) { Bcx::Client.new(:http, login: 'bcx-test-user', password: 'secret') }
+  let(:client) { Bcx::Client::HTTP.new(login: 'bcx-test-user', password: 'secret') }
   describe "GET /projects/2937644/todolists.json" do
     let(:todolists) { client.projects(2956584).todolists! }
@@ -66,10 +65,27 @@ describe Bcx::Resources::Todolist, :vcr do
     end
   end
-  describe "/projects/123/todolists.json" do
+  describe "POST /projects/123/todolists.json" do
     it "should create a new todolist" do
       todolist = client.projects(2956584).todolists.create!(name: 'My todolist', description: 'This is a todolist')
       expect(todolist.created_at).not_to be_blank
     end
   end
+  describe "PUT /projects/2956584/todolists/8268819.json" do
+    it "should create a new todolist" do
+      todolist = client.projects(2951531).todolists(8268819).update!(name: 'Renamed todolist')
+      expect(todolist.name).to eq 'Renamed todolist'
+    end
+  end
+  describe "DELETE /projects/2956584/todolists/8268819.json" do
+    it "should delete a todolist" do
+      client.projects(2951531).todolists(8268819).delete!
+      expect { client.projects(2951531).todolists!(8268819) }.to raise_error { |error|
+        expect(error).to be_a Bcx::ResponseError
+        expect(error.status).to eq 404
+      }
+    end
+  end
 end