lib/bcx/resources/project.rb in bcx-0.0.1 vs lib/bcx/resources/project.rb in bcx-0.0.2

@@ -1,9 +1,47 @@
 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
-      root :project
+      resource :todolists
+      resource :todos
 
-      resource :todolists, class_name: 'Bcx::Resources::Todolist'
+      def archived!
+        @url += '/archived'
+        call!
+      end
     end
   end
 end