logan 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c585ab8667cacf627cb22756a3b5e79c03c943d4
-  data.tar.gz: b1446c01c02d4ae765b5e3a5d1024dab9ce4917f
+  metadata.gz: 1822a39bbf699d36bbcd41d341786a984936358c
+  data.tar.gz: 74679a3a940ca1e28c870436cd6ea0bbd9a6fbfb
 SHA512:
-  metadata.gz: 0a415d2b10fe20bf8de8103031cf0c204f8a0ca9646a8c8283d32a491283dcd4bc6de8242fa54d47cdb3329d28f58507998130d84fcfa49f3f5ad4c5d367b716
-  data.tar.gz: f4ab9aef971f044f394617948c301e7a0494a1807d4cd79d5de3250baff7f87d19a7f52385d0974b1310362451e7ddc51a63a616d4c5de4df39d86c8e1d3f74f
+  metadata.gz: f601b37125b722a12a36e485ee940916bdd81894448529fca149089909163040e04f03724f86addd4a238de3bb8250f9313a1141e1576ace9d005e240a9a519e
+  data.tar.gz: 33d7fe47676149b50cac2f465bf20aeb57104f3a45ec3fb28e83ec3440f7520b1785fdb7f5435ee932ec2368bbea178142bf23f47680757cb63a8c627d03394d

data/lib/logan.rb

@@ -6,7 +6,9 @@ require 'logan/client'
 require 'logan/event'
 require 'logan/person'
 require 'logan/project'
+require 'logan/project_template'
 require 'logan/todo'
 require 'logan/todolist'
+require 'logan/message'
 require 'logan/errors'
 require 'logan/response_handler'

data/lib/logan/HashConstructed.rb

@@ -2,12 +2,18 @@
 # http://stackoverflow.com/questions/1572660/is-there-a-way-to-initialize-an-object-through-a-hash
 
 module HashConstructed
-  
-  # initalizes the object by pulling key-value pairs from the hash and 
+
+  attr_accessor :attributes, :json_raw
+
+  # 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}=") } 
+    @attributes = h
+    h.each do |k,v|
+      next unless respond_to?("#{k}=")
+      send("#{k}=",v)
+    end
   end
 end

data/lib/logan/client.rb

@@ -47,9 +47,20 @@ module Logan
     # get projects from Basecamp API
     #
     # @return [Array<Logan::Project>] array of {Logan::Project} instances
-    def projects
-      response = self.class.get '/projects.json'
-      handle_response(response, Proc.new {|h| Logan::Project.new(h) })
+    def projects(id = nil)
+      if id
+        project_by_id id
+      else
+        all_projects
+      end
+    end
+
+    # get project templates from Basecamp API
+    #
+    # @return [Array<Logan::ProjectTemplate>] array of {Logan::ProjectTemplate} instances
+    def project_templates
+      response = self.class.get '/project_templates.json'
+      handle_response(response, Proc.new {|h| Logan::ProjectTemplate.new(h) })
     end
 
     # get active Todo lists for all projects from Basecamp API
@@ -60,10 +71,10 @@ module Logan
       handle_response(response,
         Proc.new { |h|
           list = Logan::TodoList.new(h)
-          
+
           # grab the project ID for this list from the url
           list.project_id = list.url.scan( /projects\/(\d+)/).last.first
-          
+
           # return the list so this method returns an array of lists
           list
         }
@@ -71,7 +82,7 @@ module Logan
     end
 
     def events(since_time, page = 1)
-      response = self.class.get "/events.json?since=#{since_time.to_s}&page=#{page}"
+      response = self.class.get "/events.json?since=#{URI.escape since_time.to_formatted_s(:iso8601)}&page=#{page}"
       handle_response(response, Proc.new {|h| Logan::Event.new(h) })
     end
 
@@ -79,5 +90,25 @@ module Logan
       response = self.class.get "/people.json"
       handle_response(response, Proc.new {|h| Logan::Person.new(h) })
     end
+
+    def person(id)
+      response = self.class.get  "/people/#{id}.json"
+      person = Logan::Person.new response
+      person.json_raw = response.body
+      person
+    end
+
+    private
+      def all_projects
+        response = self.class.get '/projects.json'
+        handle_response(response, Proc.new {|h| Logan::Project.new(h) })
+      end
+
+      def project_by_id id
+        response = self.class.get  "/projects/#{id}.json"
+        project = Logan::Project.new response
+        project.json_raw = response.body
+        project
+      end
   end
 end

data/lib/logan/comment.rb

@@ -3,18 +3,30 @@ require 'logan/HashConstructed'
 module Logan
   class Comment
     include HashConstructed
-    
+
     attr_accessor :id
     attr_accessor :content
     attr_accessor :created_at
     attr_accessor :updated_at
+    attr_accessor :trashed
+    attr_accessor :private
+    attr_accessor :subscribers
     attr_reader :creator
-    
+
+    def post_json
+      {
+        :content => @content,
+        :trashed => @trashed,
+        :private => @private,
+        :creator => @creator.nil? ? nil : @creator.to_hash
+      }.to_json
+    end
+
     # sets the creator for this todo
-    # 
+    #
     # @param [Object] creator person hash from API or <Logan::Person> object
     def creator=(creator)
-      @creator = creator.is_a?(Hash) ? Logan::Person.new(creator) : creator        
+      @creator = creator.is_a?(Hash) ? Logan::Person.new(creator) : creator
     end
   end
 end

data/lib/logan/event.rb

@@ -3,9 +3,33 @@ require 'logan/HashConstructed'
 module Logan
   class Event
     include HashConstructed
-    
+    include ResponseHandler
+
     attr_accessor :id
     attr_accessor :summary
     attr_accessor :url
-  end  
-end
+    attr_accessor :eventable
+    attr_accessor :updated_at
+    attr_accessor :created_at
+    attr_accessor :action
+    attr_accessor :summary
+    attr_accessor :raw_excerpt
+    attr_accessor :excerpt
+
+
+    def eventable= h
+      @eventable = OpenStruct.new h
+    end
+
+    def get
+      begin
+        response = Logan::Client.get eventable.url
+        o = eval("Logan::#{eventable.type}").new response.parsed_response
+        o.json_raw = response.body
+        o
+      rescue NameError
+        return nil
+      end
+    end
+  end
+end

data/lib/logan/message.rb

@@ -0,0 +1,16 @@
+require 'logan/HashConstructed'
+
+module Logan
+  class Message
+    include HashConstructed
+
+    attr_accessor :id
+    attr_accessor :subject
+    attr_accessor :content
+    attr_accessor :private
+    attr_accessor :trashed
+    attr_accessor :subscribers
+    attr_accessor :creator
+    attr_accessor :comments
+  end
+end

data/lib/logan/person.rb

@@ -3,7 +3,7 @@ require 'logan/HashConstructed'
 module Logan
   class Person
     include HashConstructed
-    
+
     attr_accessor :id
     attr_accessor :identity_id
     attr_accessor :name
@@ -13,9 +13,9 @@ module Logan
     attr_accessor :created_at
     attr_accessor :updated_at
     attr_accessor :url
-    
+
     def to_hash
       { :id => @id, :type => "Person" }
     end
-  end  
+  end
 end

data/lib/logan/project.rb

@@ -1,51 +1,76 @@
 require 'logan/HashConstructed'
 require 'logan/todolist'
+require 'logan/response_handler'
 
 module Logan
   class Project
     include HashConstructed
-    
+    include ResponseHandler
+
     attr_accessor :id
     attr_accessor :name
-    
+    attr_accessor :description
+    attr_accessor :updated_at
+    attr_accessor :url
+    attr_accessor :app_url
+    attr_accessor :template
+    attr_accessor :archived
+    attr_accessor :starred
+    attr_accessor :trashed
+    attr_accessor :draft
+    attr_accessor :is_client_project
+    attr_accessor :color
+
     # 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| 
+      lists_array = active_response.parsed_response.map do |h|
         Logan::TodoList.new h.merge({ :project_id => @id })
       end
     end
-    
+
+    # publish this project from Basecamp API
+    #
+    # @return <Logan::Project> this project
+    def publish
+      post_params = {
+        :body => {}.to_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/projects/#{@id}/publish.json", post_params
+    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| 
+      lists_array = completed_response.parsed_response.map do |h|
         Logan::TodoList.new h.merge({ :project_id => @id })
       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
-    
+
     # 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)
@@ -53,7 +78,7 @@ module Logan
         :body => todo_list.post_json,
         :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
       }
-          
+
       response = Logan::Client.post "/projects/#{@id}/todolists.json", post_params
       Logan::TodoList.new response.merge({ :project_id => @id })
     end
@@ -72,6 +97,15 @@ module Logan
       response = Logan::Client.post "/projects/#{@id}/accesses.json", post_params
     end
 
+    def add_client_by_id(id)
+      post_params = {
+        :body => { ids: [id] }.to_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/projects/#{@id}/client_accesses.json", post_params
+    end
+
     def add_user_by_email(email)
       post_params = {
         :body => { email_addresses: [email] }.to_json,
@@ -80,5 +114,104 @@ module Logan
 
       response = Logan::Client.post "/projects/#{@id}/accesses.json", post_params
     end
-  end  
+
+    def add_client_by_email(email)
+      post_params = {
+        :body => { email_addresses: [email] }.to_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/projects/#{@id}/client_accesses.json", post_params
+    end
+
+    # create a message via Basecamp API
+    #
+    # @param [String] subject subject for the new message
+    # @param [String] content content for the new message
+    # @param [Array] subscribers array of subscriber ids for the new message
+    # @param [Bool] private should the private flag be set for the new message
+    # @return [Logan::Message] message instance from Basecamp API response
+    def create_message(subject, content, subscribers, private)
+      post_params = {
+        :body => {subject: subject, content: content, subscribers: subscribers, private: private}.to_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/projects/#{@id}/messages.json", post_params
+      Logan::Project.new response
+    end
+
+
+    # returns the array of remaining todos - potentially synchronously downloaded from API
+    #
+    # @return [Array<Logan::Todo>] Array of remaining todos for this todo list
+    def remaining_todos &block
+      return @remaining_todos if @remaining_todos
+      remaining_todos! &block
+    end
+
+    def remaining_todos! &block
+      @remaining_todos = []
+      if block_given?
+        page = 1
+        while true
+
+          response = Logan::Client.get "/projects/#{@id}/todos/remaining.json?page=#{page}"
+          list = handle_response(response, Proc.new {|h| Logan::Todo.new(h.merge({ :project_id => @id })) })
+          @remaining_todos << list
+          page += 1
+          break if list.size < 50
+        end
+        @remaining_todos = @remaining_todos.flatten
+      else
+        response = Logan::Client.get "/projects/#{@id}/todos/remaining.json"
+        @remaining_todos = handle_response(response, Proc.new {|h| Logan::Todo.new(h.merge({ :project_id => @id })) })
+      end
+      @remaining_todos
+    end
+
+    # returns the array of completed todos - potentially synchronously downloaded from API
+    #
+    # @return [Array<Logan::Todo>] Array of completed todos for this todo list
+    def completed_todos
+      return @completed_todos if @completed_todos
+      completed_todos!
+    end
+
+    def completed_todos!
+      response = Logan::Client.get "/projects/#{@id}/todos/completed.json"
+
+      @completed_todos = handle_response(response, Proc.new {|h| Logan::Todo.new(h.merge({ :project_id => @id })) })
+    end
+
+    # returns the array of trashed todos - potentially synchronously downloaded from API
+    #
+    # @return [Array<Logan::Todo>] Array of trashed todos for this todo list
+    def trashed_todos
+      return @trashed_todos if @trashed_todos
+      trashed_todos!
+    end
+
+    def trashed_todos!
+      response = Logan::Client.get "/projects/#{@id}/todos/trashed.json"
+
+      @trashed_todos = handle_response(response, Proc.new {|h| Logan::Todo.new(h.merge({ :project_id => @id })) })
+    end
+
+    # returns the array of todos - potentially synchronously downloaded from API
+    #
+    # @return [Array<Logan::Todo>] Array of todos for this todo list
+    def todos
+      return @todos if @todos
+      todos!
+    end
+
+    def todos!
+      response = Logan::Client.get "/projects/#{@id}/todos.json"
+
+      @todos = handle_response(response, Proc.new {|h| Logan::Todo.new(h.merge({ :project_id => @id })) })
+    end
+
+
+  end
 end

data/lib/logan/project_template.rb

@@ -0,0 +1,27 @@
+require 'logan/HashConstructed'
+
+module Logan
+  class ProjectTemplate
+    include HashConstructed
+
+    attr_accessor :id
+    attr_accessor :name
+
+
+    # create a project based on this project template via Basecamp API
+    #
+    # @param [String] name name for the new project
+    # @param [String] description description for the new project
+    # @return [Logan::Project] project instance from Basecamp API response
+    def create_project( name, description = nil)
+      post_params = {
+        :body => {name: name, description: description}.to_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/project_templates/#{@id}/projects.json", post_params
+      Logan::Project.new response
+    end
+
+  end
+end

data/lib/logan/response_handler.rb

@@ -2,7 +2,9 @@ module Logan
   module ResponseHandler
     def handle_response(response, block)
       if success?(response.response)
-        response.parsed_response.map { |h| block.call(h) }
+        response.parsed_response.map do |h|
+          block.call( h.merge({json_raw: h.to_json}) )
+        end
       else
         handle_error(response.response)
       end

data/lib/logan/todo.rb

@@ -14,6 +14,16 @@ module Logan
     attr_reader :assignee
     attr_accessor :due_at
     attr_accessor :position
+    attr_accessor :app_url
+    attr_accessor :url
+    attr_accessor :trashed
+    attr_accessor :private
+
+    def initialize h
+      super
+      @project_id ||= app_url[/projects\/(\d*)\//, 1].to_i unless app_url.blank?
+      self
+    end
 
     def post_json
       {
@@ -28,11 +38,21 @@ module Logan
         :content => @content,
         :due_at => @due_at,
         :assignee => @assignee.nil? ? nil : @assignee.to_hash,
-        :position => (@position.nil? || @position.empty?) ? 99  : @position,
+        :position => (@position.nil? || @position.to_s.empty?) ? 99  : @position,
         :completed => @completed
       }.to_json
     end
 
+    def save
+      put_params = {
+        :body => put_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.put url, put_params
+      initialize response.parsed_response
+    end
+
     # refreshes the data for this todo from the API
     def refresh
       response = Logan::Client.get "/projects/#{project_id}/todos/#{id}.json"
@@ -62,5 +82,19 @@ module Logan
     def assignee=(assignee)
       @assignee = assignee.is_a?(Hash) ? Logan::Person.new(assignee) : assignee
     end
+
+    # create a create in this todo list via the Basecamp API
+    #
+    # @param [Logan::Comment] todo the comment instance to create in this todo lost
+    # @return [Logan::Comment] the created comment returned from the Basecamp API
+    def create_comment(comment)
+      post_params = {
+        :body => comment.post_json,
+        :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
+      }
+
+      response = Logan::Client.post "/projects/#{@project_id}/todos/#{@id}/comments.json", post_params
+      Logan::Comment.new response
+    end
   end
 end

data/lib/logan/todolist.rb

@@ -4,7 +4,7 @@ require 'logan/todo'
 module Logan
   class TodoList
     include HashConstructed
-    
+
     attr_accessor :id
     attr_accessor :project_id
     attr_accessor :name
@@ -15,57 +15,57 @@ module Logan
     attr_accessor :url
     attr_writer :remaining_todos
     attr_writer :completed_todos
-    
-    # intializes a todo list by calling the HashConstructed initialize method and 
+
+    # 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 = []
       super
     end
-    
+
     def post_json
         { :name => @name, :description => @description }.to_json
     end
-    
+
     # refreshes the data for this todo list from the API
     def refresh
       response = Logan::Client.get "/projects/#{@project_id}/todolists/#{@id}.json"
       initialize(response.parsed_response)
     end
-    
+
     # returns the array of remaining todos - potentially synchronously downloaded from API
-    #  
+    #
     # @return [Array<Logan::Todo>] Array of remaining todos for this todo list
     def remaining_todos
       if @remaining_todos.empty? && @remaining_count > 0
         refresh
       end
-      
+
       return @remaining_todos
     end
-    
+
     # returns the array of completed todos - potentially synchronously downloaded from API
-    #  
+    #
     # @return [Array<Logan::Todo>] Array of completed todos for this todo list
     def completed_todos
       if @completed_todos.empty? && @completed_count > 0
         refresh
       end
-      
+
       return @completed_todos
     end
-    
+
     # returns an array of all todos, completed and remaining - potentially synchronously downloaded from API
-    #  
+    #
     # @return [Array<Logan::Todo>] Array of completed todos for this todo list
     def todos
       remaining_todos + completed_todos
     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
     # @return [Array<Logan::Todo>] array of remaining and completed todos for this list
     def todos=(todo_hash)
@@ -73,18 +73,18 @@ module Logan
       @completed_todos = todo_hash['completed'].map { |h| Logan::Todo.new h.merge({ :project_id => @project_id }) }
       return @remaining_todos + @completed_todos
     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)      
+    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)
@@ -92,13 +92,13 @@ module Logan
         :body => todo.post_json,
         :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
       }
-       
+
       response = Logan::Client.post "/projects/#{@project_id}/todolists/#{@id}/todos.json", post_params
       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)
@@ -106,17 +106,17 @@ module Logan
         :body => todo.put_json,
         :headers => Logan::Client.headers.merge({'Content-Type' => 'application/json'})
       }
-             
+
       response = Logan::Client.put "/projects/#{@project_id}/todos/#{todo.id}.json", put_params
       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
-  end  
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logan
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Stephen Birarda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,28 +28,28 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
@@ -73,13 +73,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/logan.rb
+- lib/logan/HashConstructed.rb
 - lib/logan/client.rb
 - lib/logan/comment.rb
 - lib/logan/errors.rb
 - lib/logan/event.rb
-- lib/logan/HashConstructed.rb
+- lib/logan/message.rb
 - lib/logan/person.rb
 - lib/logan/project.rb
+- lib/logan/project_template.rb
 - lib/logan/response_handler.rb
 - lib/logan/todo.rb
 - lib/logan/todolist.rb
@@ -93,17 +95,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ruby gem to communicate with new Basecamp API