logan18 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: c75432a4b58cfdc008d493ded925490158eb3338e26dbbb8de2a6bcc3a14339d4967bf88bf1aaa994138876670451588f8a76663bf354e182fd726af2c817c54
+  data.tar.gz: 4f6404b95da08e945195b04dabdfa080c2bcc695393a2305bad70fdfec7eca68cc4f8f7b6f1eaa870b23ad92c56a76f0122b458b1882f00f754b2be14650f740
+SHA1: 
+  metadata.gz: f0fca7f22143c534cd25571c23799c03ea71e8d6
+  data.tar.gz: 9a01ca0abc5ec9c8aea48a34df8ecc6a60f48713

data/lib/logan/HashConstructed.rb

@@ -0,0 +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
+  
+  # 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

@@ -0,0 +1,74 @@
+require 'logan/project'
+
+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 auth_hash [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)
+    # @param user_agent [String] the user-agent string to include in header of requests
+    def initialize(basecamp_id, auth_hash, user_agent)
+      self.class.base_uri "https://basecamp.com/#{basecamp_id}/api/v1"
+      self.class.headers 'User-Agent' => user_agent
+      self.auth = auth_hash
+    end
+    
+    # Updates authorization information for Logan shared client
+    # 
+    # @param auth_hash [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)
+    def auth=(auth_hash)
+      # symbolize the keys
+      auth_hash = auth_hash.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      
+      if auth_hash.has_key? :access_token
+        # clear the basic_auth, if it's set
+        self.class.default_options.reject!{ |k| k == :basic_auth }
+                
+        # set the Authorization headers
+        self.class.headers.merge!("Authorization" => "Bearer #{auth_hash[:access_token]}")
+      elsif auth_hash.has_key?(:username) && auth_hash.has_key?(:password)
+        self.class.basic_auth auth_hash[:username], auth_hash[:password]
+        
+        # remove the access_token from the headers, if it exists
+        self.class.headers.reject!{ |k| k == "Authorization" }
+      else
+        raise """
+        Incomplete authorization information passed in authorization hash. 
+        You must have either an :access_token or a username password combination (:username, :password).
+        """
+      end
+    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'
+      
+      response.parsed_response.map do |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
+      end
+    end
+    
+    def events(since_time, page = 1)
+      response = self.class.get "/events.json?since=#{since_time.to_s}&page=#{page}"
+      response.map { |h| e = Logan::Event.new(h) }
+    end
+  end
+end

data/lib/logan/event.rb

@@ -0,0 +1,11 @@
+require 'logan/HashConstructed'
+
+module Logan
+  class Event
+    include HashConstructed
+    
+    attr_accessor :id
+    attr_accessor :summary
+    attr_accessor :url
+  end  
+end

data/lib/logan/person.rb

@@ -0,0 +1,14 @@
+require 'logan/HashConstructed'
+
+module Logan
+  class Person
+    include HashConstructed
+    
+    attr_accessor :id
+    attr_accessor :name
+    
+    def to_hash
+      { :id => @id, :type => "Person" }
+    end
+  end  
+end

data/lib/logan/project.rb

@@ -0,0 +1,61 @@
+require 'logan/HashConstructed'
+require 'logan/todolist'
+
+module Logan
+  class Project
+    include HashConstructed
+    
+    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| 
+        Logan::TodoList.new h.merge({ :project_id => @id })
+      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| 
+        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)
+      post_params = {
+        :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
+  end  
+end

data/lib/logan/todo.rb

@@ -0,0 +1,35 @@
+require 'logan/HashConstructed'
+require 'logan/person'
+
+module Logan
+  class Todo
+    include HashConstructed
+    
+    attr_accessor :id
+    attr_accessor :content
+    attr_accessor :completed
+    attr_accessor :assignee
+    attr_accessor :due_at
+    
+    def post_json
+      {
+        :content => @content,
+        :due_at => @due_at,
+        :assignee => @assignee.to_hash
+      }.to_json
+    end
+    
+    def put_json
+      { 
+        :content => @content, 
+        :due_at => @due_at,
+        :assignee => @assignee.to_hash,
+        :completed => @completed
+      }.to_json
+    end
+    
+    def assignee=(assignee)
+      @assignee = assignee.is_a?(Hash) ? Logan::Person.new(assignee) : assignee        
+    end
+  end  
+end

data/lib/logan/todolist.rb

@@ -0,0 +1,84 @@
+require 'logan/HashConstructed'
+require 'logan/todo'
+
+module Logan
+  class TodoList
+    include HashConstructed
+    
+    attr_accessor :id
+    attr_accessor :project_id
+    attr_accessor :name
+    attr_accessor :description
+    attr_accessor :completed
+    attr_accessor :remaining_todos
+    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 = []
+      super
+    end
+    
+    def post_json
+        { :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,
+        :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)
+      put_params = {
+        :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

data/lib/logan.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'json'
+
+require 'logan/client'
+require 'logan/event'
+require 'logan/person'
+require 'logan/project'
+require 'logan/todo'
+require 'logan/todolist'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: logan18
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Stephen Birarda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-01-31 00:00:00 Z
+dependencies: []
+
+description: 
+email: logan@birarda.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/logan.rb
+- lib/logan/client.rb
+- lib/logan/event.rb
+- lib/logan/HashConstructed.rb
+- lib/logan/person.rb
+- lib/logan/project.rb
+- lib/logan/todo.rb
+- lib/logan/todolist.rb
+homepage: https://github.com/birarda/logan
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id001 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id001
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: ruby gem to communicate with new Basecamp API
+test_files: []
+