logan 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ba45bb77d32f5b00a89c053de3cff2ae1c9ef0b
-  data.tar.gz: 288d0153ed727f60b694386a3158a3359a84083e
+  metadata.gz: e39f8bb1bebade7a2d6d7b2ef6f8149e02cee606
+  data.tar.gz: d0c5e113b5db76d6b8cf8f9a03a64f27d562539a
 SHA512:
-  metadata.gz: 48b176bc3031d723b868279bd302744792a9ef81391783d21e2edd5f9a0f10741a9eb8975afa80bae53c8986e9eb15b835d6dfe7f12f771af7c36245b3f441af
-  data.tar.gz: 2485b976bdef206dfe3e8dd7cee5a0306cc72cb5c15c042b31c59fdaf88a973cdfa80b68c767b2d91cdebe2af5f7e2fd552daa16eff884a19221b5106c059869
+  metadata.gz: 584042077954e3131935bc73b96a95a28dc0875bb29b635036780ba1bf2accbeb3cd7943bc62347dec472f0db8985f98d28de0b9fc27c38b68a6df36c48bf866
+  data.tar.gz: f71fc834f95e02da617cd974c78daf932a8d90f0a5f6c24ea6a5f6b17ead66cbf0ea922b047dbd6cb90ee10bfce9c237032de6e70228ba61896e85ba5918ea6c

data/lib/logan/HashConstructed.rb

@@ -1,5 +1,13 @@
+# this module is taken from the accepted answer here
+# http://stackoverflow.com/questions/1572660/is-there-a-way-to-initialize-an-object-through-a-hash
+
 module HashConstructed
- def initialize(h)
-  h.each { |k,v| send("#{k}=",v) if respond_to?("#{k}=") } 
- end
+  
+  # initalizes the object by pulling key-value pairs from the hash and 
+  # mapping them to the object's instance variables
+  # 
+  # @param [Hash] h hash containing key-value pairs to map to object instance variables
+  def initialize(h)
+    h.each { |k,v| send("#{k}=",v) if respond_to?("#{k}=") } 
+  end
 end

data/lib/logan/client.rb

@@ -4,17 +4,29 @@ module Logan
   class Client
     include HTTParty
     
+    # Initializes the Logan shared client with information required to communicate with Basecamp
+    #
+    # @param basecamp_id [String] the Basecamp company ID
+    # @param username [String] the username to use for requests
+    # @param password [String] the password to use for the passed username
+    # @param user_agent [String] the user-agent string to include in header of requests
     def initialize(basecamp_id, username, password, user_agent)
       self.class.base_uri "https://basecamp.com/#{basecamp_id}/api/v1"
       self.class.basic_auth username, password
       self.class.headers 'User-Agent' => user_agent
     end
     
+    # get projects from Basecamp API
+    # 
+    # @return [Array<Logan::Project>] array of {Logan::Project} instances
     def projects
       response = self.class.get '/projects.json'
       response.parsed_response.map { |h| p = Logan::Project.new(h) }
     end
     
+    # get active Todo lists for all projects from Basecamp API
+    # 
+    # @return [Array<Logan::TodoList>] array of {Logan::TodoList} instances
     def todolists
       response = self.class.get '/todolists.json'
       

data/lib/logan/person.rb

@@ -10,9 +10,5 @@ module Logan
     def to_hash
       { :id => @id, :type => "Person" }
     end
-    
-    def post_json
-      self.to_hash.to_json
-    end
   end  
 end

data/lib/logan/project.rb

@@ -8,6 +8,9 @@ module Logan
     attr_accessor :id
     attr_accessor :name
     
+    # get active todo lists for this project from Basecamp API
+    # 
+    # @return [Array<Logan::TodoList>] array of active todo lists for this project
     def todolists
       active_response = Logan::Client.get "/projects/#{@id}/todolists.json"
       lists_array = active_response.parsed_response.map do |h| 
@@ -15,6 +18,9 @@ module Logan
       end
     end
     
+    # get completed todo lists for this project from Basecamp API
+    # 
+    # @return [Array<Logan::TodoList>] array of completed todo lists for this project
     def completed_todolists
       completed_response = Logan::Client.get "/projects/#{@id}/todolists/completed.json"
       lists_array = completed_response.parsed_response.map do |h| 
@@ -22,18 +28,29 @@ module Logan
       end
     end
     
+    # get both active and completed todo lists for this project from Basecamp API
+    # 
+    # @return [Array<Logan::TodoList>] array of active and completed todo lists for this project
     def all_todolists
       todolists + completed_todolists
     end
     
+    # get an individual todo list for this project from Basecamp API
+    # 
+    # @param [String] list_id id for the todo list
+    # @return [Logan::TodoList] todo list instance
     def todolist(list_id)
       response = Logan::Client.get "/projects/#{@id}/todolists/#{list_id}.json"
       Logan::TodoList.new response.parsed_response.merge({ :project_id => @id })
     end
     
-    def create_todolist(todolist)
+    # create a todo list in this project via Basecamp API
+    # 
+    # @param [Logan::TodoList] todo_list todo list instance to be created
+    # @return [Logan::TodoList] todo list instance from Basecamp API response
+    def create_todolist(todo_list)
       post_params = {
-        :body => todolist.post_json,
+        :body => todo_list.post_json,
         :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
       }
           

data/lib/logan/todolist.rb

@@ -14,6 +14,8 @@ module Logan
     attr_accessor :completed_todos
     attr_accessor :url
     
+    # intializes a todo list by calling the HashConstructed initialize method and 
+    # setting both @remaining_todos and @completed_todos to empty arrays
     def initialize(h)
       @remaining_todos = []
       @completed_todos = []
@@ -24,16 +26,29 @@ module Logan
         { :name => @name, :description => @description }.to_json
     end
     
+    # assigns the {#remaining_todos} and {#completed_todos} from the associated keys
+    # in the passed hash
+    # 
+    # @param [Hash] todo_hash hash possibly containing todos under 'remaining' and 'completed' keys
     def todos=(todo_hash)
       @remaining_todos = todo_hash['remaining'].map { |h| Logan::Todo.new h }
       @completed_todos = todo_hash['completed'].map { |h| Logan::Todo.new h }
+      return nil
     end
     
+    # searches the remaining and completed todos for the first todo with the substring in its content
+    # 
+    # @param [String] substring substring to look for
+    # @return [Logan::Todo] the matched todo, or nil if there wasn't one
     def todo_with_substring(substring)      
       issue_todo = @remaining_todos.detect{ |t| !t.content.index(substring).nil? }
       issue_todo ||= @completed_todos.detect { |t| !t.content.index(substring).nil? }
     end
     
+    # create a todo in this todo list via the Basecamp API
+    # 
+    # @param [Logan::Todo] todo the todo instance to create in this todo lost
+    # @return [Logan::Todo] the created todo returned from the Basecamp API
     def create_todo(todo)
       post_params = {
         :body => todo.post_json,
@@ -44,6 +59,10 @@ module Logan
       Logan::Todo.new response
     end
     
+    # update a todo in this todo list via the Basecamp API
+    # 
+    # @param [Logan::Todo] todo the todo instance to update in this todo list
+    # @return [Logan::Todo] the updated todo instance returned from the Basecamp API
     def update_todo(todo)
       put_params = {
         :body => todo.put_json,
@@ -54,6 +73,10 @@ module Logan
       Logan::Todo.new response
     end
     
+    # delete a todo in this todo list via delete call to Basecamp API
+    # 
+    # @param [Logan::Todo] todo the todo instance to be delete from this todo list
+    # @return [HTTParty::response] response from Basecamp for delete request
     def delete_todo(todo)
       response = Logan::Client.delete "/projects/#{@project_id}/todos/#{todo.id}.json"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logan
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Stephen Birarda
@@ -48,3 +48,4 @@ signing_key:
 specification_version: 4
 summary: ruby gem to communicate with new Basecamp API
 test_files: []
+has_rdoc: