bcx 0.1.0 → 0.1.1

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in bcx.gemspec
 gemspec
-
-gem 'rapidash', github: 'paulspringett/rapidash', branch: 'error-handling'

data/README.md

@@ -1,6 +1,6 @@
 ## Bcx
 
-> NB. This is still alpha software and may not work as expected. It's also missing a lot of the Basecamp endpoints. Please feel free [to contribute!](#contributing)
+> NB. This gem is missing a lot of the Basecamp endpoints. Please feel free [to contribute!](#contributing)
 
 Fully-fledged Ruby API wrapper for Basecamp Next
 
@@ -47,7 +47,12 @@ You can get a `client_id` and `client_secret` from https://integrate.37signals.c
 
 ### Resources
 
-See the [full resource documentation](#todo) for all available API endpoints.
+The following resources are fully implemented and tested.
+
+* [People](http://paulspringett.github.io/bcx/docs/person.html)
+* [Projects](http://paulspringett.github.io/bcx/docs/project.html)
+* [Todolists](http://paulspringett.github.io/bcx/docs/todolist.html)
+* [Todos](http://paulspringett.github.io/bcx/docs/todo.html)
 
 #### Bang operators
 
@@ -99,14 +104,8 @@ See the full [annotated source code](http://paulspringett.github.io/bcx).
 The docs are generated using [Docco](http://jashkenas.github.io/docco/). To generate the docs, run:
 
 ```bash
-$ git checkout master
 $ npm install -g docco
-$ docco lib/**/*.rb
-$ git commit -am "Updated docs"
-
-$ git checkout gh-pages
-$ git checkout master -- docs/ # Copy docs changes across and stage
-$ git commit -m "Updated docs on gh-pages"
+$ rake docs:generate
 ```
 
 ### Contributing

data/Rakefile

@@ -4,3 +4,5 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 task default: [:spec]
+
+import 'lib/tasks/docs.rake'

data/bcx.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Bcx::VERSION
 
-  gem.add_runtime_dependency 'rapidash', '~> 0.2.0'
+  gem.add_runtime_dependency 'rapidash', '0.3.0.beta'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/docs/configuration.html

@@ -19,46 +19,11 @@
           <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>

data/docs/response_error.html

@@ -19,46 +19,11 @@
           <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>

data/docs/version.html

@@ -19,46 +19,11 @@
           <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>
@@ -92,7 +57,7 @@
             </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="constant">VERSION</span> = <span class="string">"0.1.0"</span>
 <span class="keyword">end</span></pre></div></div>
             
         </li>

data/lib/bcx/client/http.rb

@@ -4,7 +4,7 @@ module Bcx
       method :http
 
       extension :json
-      encode_post_data_with :json
+      encode_request_with :json
 
       raise_errors
 

data/lib/bcx/client/oauth.rb

@@ -4,7 +4,7 @@ module Bcx
       method :oauth
 
       extension :json
-      encode_post_data_with :json
+      encode_request_with :json
 
       raise_errors
 

data/lib/bcx/resources/person.rb

@@ -1,4 +1,5 @@
-# `Bcx::Resources::Person`
+# ## People
+#
 # Provides access to people resource
 #
 # #### Get all people on the account

data/lib/bcx/resources/project.rb

@@ -1,39 +1,39 @@
+# ## Projects
+#
+# Provides access to projects resoource and other nested resources
+#
+# #### Fetch all projects
+# `GET /projects.json`
+#
+#     client.projects!
+#
+# #### Fetch archived projects
+# `GET /projects/archived.json`
+#
+#     clients.projects.archived!
+#
+# #### Fetch single project with ID of 123
+# `GET /projects/123.json`
+#
+#     client.projects!(123)
+#
+# #### Create a project
+# `POST /projects.json`
+#
+#     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')
+#
+# #### Delete a project
+# `DELETE /projects/123.json`
+#
+#     client.projects(123).delete!
+#
 module Bcx
   module Resources
-
-    # Bcx::Resources::Project
-    # Provides access to projects resoource and other nested resources
-    #
-    # Fetch all projects
-    # GET /projects.json
-    #
-    #     client.projects!
-    #
-    # Fetch archived projects
-    # GET /projects/archived.json
-    #
-    #     clients.projects.archived!
-    #
-    # Fetch single project with ID of 123
-    # GET /projects/123.json
-    #
-    #     client.projects!(123)
-    #
-    # Create a project
-    # POST /projects.json
-    #
-    #     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')
-    #
-    # Delete a project
-    # DELETE /projects/123.json
-    #
-    #     client.projects(123).delete!
-    #
     class Project < Rapidash::Base
       resource :todolists
       resource :todos

data/lib/bcx/resources/todo.rb

@@ -1,36 +1,36 @@
+# ## Todo
+#
+# Provides access to todolist resoource both at the client level and per-project
+#
+# #### Get todos for a todolist
+# `GET /todolists/1.json`
+#
+#     todolist = client.todolists!(1)
+#     todolist.todos.remaining
+#     todolist.todos.completed
+#
+# #### Get a specific todo
+# `GET /projects/1/todos/2.json`
+#
+#     client.projects(1).todos!(2)
+#
+# #### Create a todo
+# `POST /projects/1/todolists/2/todos.json`
+#
+#     client.projects(1).todolists(2).todos.create!(content: 'Update copy text')
+#
+# #### Update a todo
+# `PUT /projects/1/todos/2.json`
+#
+#     client.projects(1).todos(2).update!(completed: true)
+#
+# #### Delete a todo
+# `DELETE /projects/1/todos/2.json`
+#
+#     client.projects(1).todos(2).delete!
+#
 module Bcx
   module Resources
-
-    # Bcx::Resources::Todo
-    # Provides access to todolist resoource both at the client level and per-project
-    #
-    # Get todos for a todolist
-    # GET /todolists/1.json
-    #
-    #   todolist = client.todolists!(1)
-    #   todolist.todos.remaining
-    #   todolist.todos.completed
-    #
-    # Get a specific todo
-    # GET /projects/1/todos/2.json
-    #
-    #   client.projects(1).todos!(2)
-    #
-    # Create a todo
-    # POST /projects/1/todolists/2/todos.json
-    #
-    #   client.projects(1).todolists(2).todos.create!(content: 'Update copy text')
-    #
-    # Update a todo
-    # PUT /projects/1/todos/2.json
-    #
-    #   client.projects(1).todos(2).update!(completed: true)
-    #
-    # Delete a todo
-    # DELETE /projects/1/todos/2.json
-    #
-    #   client.projects(1).todos(2).delete!
-    #
     class Todo < Rapidash::Base
     end
   end

data/lib/bcx/resources/todolist.rb

@@ -1,49 +1,49 @@
+# ## Todolists
+#
+# Provides access to todolist resoource both at the client level and per-project
+#
+# #### Get all todolists for a project
+# `GET /projects/123/todolists.json`
+#
+#     client.projects(123).todolists!
+#
+# #### Get all completed todolists for a project
+# `GET /projects/1/todolists/completed.json`
+#
+#     client.projects(123).todolists.completed!
+#
+# #### Get todolists for all projects
+# `GET /todolists.json`
+#
+#     client.todolists!
+#
+# #### Get completed todolists for all projects
+# `GET /todolists/completed.json`
+#
+#     client.todolists.completed!
+#
+# #### Get specific todolist including the todos
+# `GET /projects/123/todolists/456.json`
+#
+#     client.projects(123).todolists!(456)
+#
+# #### Create a new todolist
+# `POST /projects/1/todolists.json`
+#
+#     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!
+#
 module Bcx
   module Resources
-
-    # Bcx::Resources::Todolist
-    # Provides access to todolist resoource both at the client level and per-project
-    #
-    # Get all todolists for a project
-    # GET /projects/123/todolists.json
-    #
-    #   client.projects(123).todolists!
-    #
-    # Get all completed todolists for a project
-    # GET /projects/1/todolists/completed.json
-    #
-    #   client.projects(123).todolists.completed!
-    #
-    # Get todolists for all projects
-    # GET /todolists.json
-    #
-    #   client.todolists!
-    #
-    # Get completed todolists for all projects
-    # GET /todolists/completed.json
-    #
-    #   client.todolists.completed!
-    #
-    # Get specific todolist including the todos
-    # GET /projects/123/todolists/456.json
-    #
-    #   client.projects(123).todolists!(456)
-    #
-    # Create a new todolist
-    # POST /projects/1/todolists.json
-    #
-    #   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'
 

data/lib/bcx/version.rb

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

data/lib/bcx.rb

@@ -1,7 +1,8 @@
 require 'rapidash'
+require 'rapidash/collection'
 require 'bcx/version'
 
-# # Bcx
+# ## Bcx
 # Fully-fledged Ruby API wrapper for Basecamp Next
 #
 #  See the [README](https://github.com/paulspringett/bcx#readme) for usage

data/lib/rapidash/collection.rb

@@ -0,0 +1,33 @@
+module Rapidash
+  module Collection
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def collection(name, attrs = {})
+        path = attrs[:path] || name.to_s
+        path.gsub!(/^\//, '')
+
+        method = attrs[:method] || :get
+
+        define_method("#{name}!") do
+          original_url = @url
+
+          @url += "/#{path}"
+          @options[:method] = method
+          result = call!
+
+          @url = original_url
+
+          result
+        end
+      end
+    end
+  end
+end
+
+class Rapidash::Base
+  include Rapidash::Collection
+end

data/lib/tasks/docs.rake

@@ -0,0 +1,41 @@
+namespace :docs do
+  desc "Generate the latest docs from the source code and add to gh-pages"
+  task :generate do
+    ensure_clean_git
+    run "git checkout #{branch}"
+    run "docco lib/**/*.rb"
+    run "git commit -am '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 checkout #{branch}"
+  end
+
+  desc "Deploy docs to GitHub pages"
+  task :deploy do
+    ensure_clean_git
+    run "git checkout gh-pages"
+    run "git push origin gh-pages"
+    run "git checkout #{branch}"
+  end
+end
+
+def branch
+  @branch ||= `git symbolic-ref HEAD 2> /dev/null`.gsub("refs/heads/", "").strip
+end
+
+def git_dirty?
+  `[[ $(git diff --shortstat 2> /dev/null | tail -n1) != "" ]]`
+  dirty = $?.success?
+end
+
+def ensure_clean_git
+  if git_dirty?
+    raise "Can't deploy without a clean git status."
+  end
+end
+
+def run(command)
+  puts "  #{command}"
+  %x{#{command}}
+end