basecampeverest 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c889239a3ba4c249a55c8fdbc50e4babec6f09d
+  data.tar.gz: 6fc8f2d98f32a9aa5e5a7d0e4d5549fe4d65ba0f
+SHA512:
+  metadata.gz: 357b562178ad4ac1f0410c5fceea95b91c8d7afbd0b7e6fad6f7bab0baecb5c5567b7dc27c4af78149ef308e1ba52f84c0a722fdd22b0c7bc54f820251df98b0
+  data.tar.gz: 3851acb5669bc4375fcf6450f3260398f3cb74500652fe835ff4a6d134c4df3e7b929eb62679db0cf306c83ad90b722d1064bc8a3b98d1b3c73e334888369502

data/lib/basecampeverest/connect.rb

@@ -0,0 +1,116 @@
+module Basecampeverest
+  class Connect
+    # includes
+    include HTTParty
+    include JSON
+
+    # INTRODUCTION
+    # *******************************************************
+    # 
+    # This is a class based off the required format for httparty. When an instance of the class is called,
+    # httparty created the connection using the specific variables base_uri, and headers.
+    # 
+    # Once an instance of this class has been created, you can then call on the gem using that stored authorization. 
+    # 
+    # 
+    # 
+    # 
+    # EXAMPLE
+    # *******************************************************
+    # @authorization = { :username => "first.last@example.com", :password => "IuseSecureP@assw0rd$_" }
+    # @user_agent = "PutAnythingHere (first.last@example.com)"
+    # @basecamp_ID = "123456"
+    # Basecampeverest::Connect.new(@basecamp_ID, @authorization, @user_agent)
+    
+    # => #<Basecampeverest::Connect:0x007fc8652eca18>
+    
+    # Basecampeverest::Project.all
+    
+    # =>[{"id"=>494832908, "name"=>"Cool Basecamp Project", "description"=>"this is a description", "archived"=>false, "is_client_project"=>false, 
+    # "created_at"=>"2013-11-06T13:53:17.000-05:00", "updated_at"=>"2013-12-05T13:34:20.000-05:00", "draft"=>false,
+    # "last_event_at"=>"2013-12-05T13:34:20.000-05:00", "starred"=>false,
+    # "url"=>"https://basecamp.com/123456/api/v1/projects/494832908-Cool-Basecamp-Project.json"}]
+    # 
+    # 
+    # 
+    # 
+    # LICENSE
+    # *******************************************************
+    # 
+    # Copyright (c) 2014 Alex Gordon
+    # Permission is hereby granted, free of charge, to any person obtaining
+    # a copy of this software and associated documentation files (the
+    # "Software"), to deal in the Software without restriction, including
+    # without limitation the rights to use, copy, modify, merge, publish,
+    # distribute, sublicense, and/or sell copies of the Software, and to
+    # permit persons to whom the Software is furnished to do so, subject to
+    # the following conditions:
+    #   
+    # The above copyright notice and this permission notice shall be
+    # included in all copies or substantial portions of the Software.
+    #       
+    # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+    # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+    # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+    # 
+
+
+    # Set a few variables
+    attr_accessor :basecamp_id, :authorization, :user_agent, :base_uri, :headers
+
+    # Initializes the connection to Basecamp using httparty. 
+    #
+    # @param basecamp_id [String] the Basecamp company ID
+    # @param authorization [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, authorization, user_agent)
+      # Set some variables
+      self.class.base_uri "https://basecamp.com/#{basecamp_id}/api/v1"
+      self.class.headers 'User-Agent' => user_agent
+      self.auth = authorization
+
+      # end method
+    end
+    
+    # Sets the authorization information. 
+    # Need to 
+    # 
+    # @param authorization [Hash] authorization hash consisting of a username and password combination (:username, :password) or an access_token (:access_token)
+    def auth=(authorization)
+      clensed_auth_hash = {}
+      authorization.each {|k, v| 
+        clensed_auth_hash[k.to_sym] = v
+        }
+
+      # nice and pretty now
+      authorization = clensed_auth_hash
+      
+      # if the authorization has the correct hash values...
+      if authorization.has_key?(:username) && authorization.has_key?(:password)
+
+        # ... then we pass it off to basic auth
+        self.class.basic_auth authorization[:username], authorization[:password]
+        
+        # check if the user tried passing in some other stupid stuff.
+        # this should never be the case if the user follows instructions. 
+        self.class.headers.reject!{ |k, v| k == "Authorization" }
+
+      else
+        # something inportant is missing if we get here. 
+        raise "Incomplete Authorization hash. Please check the Authentication Hash."
+
+        #end else 
+      end
+
+    # end method
+    end
+
+  # end class
+  end
+
+# end module
+end

data/lib/basecampeverest/convert.rb

@@ -0,0 +1,27 @@
+module Basecampeverest; class Convert
+
+    # code originally written by Rebecca Miller-Webster
+    # taken from https://gist.github.com/rmw/2710460
+
+    # convert an array into a nested OpenStruct
+    # 
+    # @param [Basecampeverest::Project] object the recursive object to pass in
+    # @return [Basecampeverest::Project] the found project information from the Basecamp API
+    def to_ostruct_recursive(options)
+      convert_to_ostruct_recursive(self, options) 
+    end
+    
+    def convert_to_ostruct_recursive(obj, options)
+      result = obj
+      if result.is_a? Hash
+        result = result.dup.with_sym_keys
+        result.each  do |key, val| 
+          result[key] = convert_to_ostruct_recursive(val, options) unless options[:exclude].try(:include?, key)
+        end
+        result = OpenStruct.new result       
+      elsif result.is_a? Array
+         result = result.map { |r| convert_to_ostruct_recursive(r, options) }
+      end
+      return result
+    end
+end; end

data/lib/basecampeverest/recursive.rb

@@ -0,0 +1,24 @@
+# taken from http://www.rebeccamiller-webster.com/2012/06/recursively-convert-a-ruby-hash-to-openstruct/
+
+class Recursive
+    # options:
+  #   :exclude => [keys] - keys need to be symbols 
+  def self.to_ostruct_recursive(options = {})
+    convert_to_ostruct_recursive(self, options) 
+  end
+ 
+  private
+    def convert_to_ostruct_recursive(obj, options)
+      result = obj
+      if result.is_a? Hash
+        result = result.dup.with_sym_keys
+        result.each  do |key, val| 
+          result[key] = convert_to_ostruct_recursive(val, options) unless options[:exclude].try(:include?, key)
+        end
+        result = OpenStruct.new result       
+      elsif result.is_a? Array
+         result = result.map { |r| convert_to_ostruct_recursive(r, options) }
+      end
+      return result
+    end
+end

data/lib/basecampeverest/resources/access.rb

@@ -0,0 +1,62 @@
+module Basecampeverest; class Access
+
+    # find the people that have access to a project via the Basecamp API
+    # 
+    # @param [Basecampeverest::Project] project_id the project id from basecamp
+    # @return [Basecampeverest::Project] the parsed response of who has access from the Basecamp API
+    def self.for_project(project_id)
+        url = "/projects/#{project_id}/accesses.json"
+        response = Basecampeverest::Connect.get url 
+
+        # parse the response to remove HTTParty info
+        response.parsed_response
+    end
+
+    # find the people that have access to a calendar via the Basecamp API
+    # 
+    # @param [Basecampeverest::Project] calendar_id the calendar id to check access
+    # @return [Basecampeverest::Project] the parsed response of who has access from the Basecamp API
+    def self.for_calendar(calendar_id)
+        url = "/calendars/#{calendar_id}/accesses.json"
+        response = Basecampeverest::Connect.get url 
+
+        # parse the response to remove HTTParty info
+        response.parsed_response
+    end
+
+    # find the people that have access to a project via the Basecamp API
+    # 
+    # @param [Basecampeverest::Project] project_id the project id from basecamp
+    # @param [Basecampeverest::Project] options a hash containing the people to grant access
+    # @return [Basecampeverest::Project] the parsed response of who has access from the Basecamp API
+    def self.grant_project(project_id, options={})
+        post_params = {
+          :body => options.to_json,
+          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+        }
+        url = "/projects/#{project_id}/accesses.json"
+        response = Basecampeverest::Connect.post url, post_params
+
+        # parse the response to remove HTTParty info
+        response.parsed_response
+    end
+
+    # find the people that have access to a project via the Basecamp API
+    # 
+    # @param [Basecampeverest::Project] project_id the project id from basecamp
+    # @param [Basecampeverest::Project] options a hash containing the people to revoke access for
+    # @return [Basecampeverest::Project] the parsed response of who has access from the Basecamp API
+    def self.revoke_project(project_id, user_id)
+        post_params = {
+          :body => options.to_json,
+          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+        }
+        url = "/projects/#{project_id}/accesses/#{user_id}.json"
+        response = Basecampeverest::Connect.get url, post_params
+
+        # parse the response to remove HTTParty info
+        response.parsed_response
+    end
+
+# end module and class
+end; end

data/lib/basecampeverest/resources/attachment.rb

@@ -0,0 +1,83 @@
+module Basecampeverest; class Attachments
+
+	    # find all #### via the Basecamp API
+	    # 
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.all
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.find()
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.new(options={})
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+	        }
+	        # make the http basecamp call
+	        response = Basecampeverest::Connect.post "####", post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] #### 
+	    # @return [Basecampeverest::Project]  from the Basecamp API
+	    def self.update()
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.merge({'Content-Type' => 'application/json'})
+	        }
+
+	        # make the http basecamp call
+	        response = Basecampeverest::Connect.put "####", post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] ####
+	    def self.delete()
+	        url = "####"
+	        response = Basecampeverest::Connect.delete url
+
+	        # This checks the response code for validity and error checking
+	        if response.code == 204
+	            message = "#### successfully deleted"
+	        elsif response.code == 403
+	            message = "You do not have permission to delete this ####"
+	        else 
+	            message = "Invalid project ID or authentication. The #### was not deleted."
+	        end
+
+	        # return the message
+	        message
+	    end
+
+	# end module and class
+end; end

data/lib/basecampeverest/resources/calendar.rb

@@ -0,0 +1,84 @@
+module Basecampeverest; class Calendar
+
+	    # find all calendars via the Basecamp API
+	    # 
+	    # @return [Basecampeverest::Project] an array of all the calendars from the Basecamp API
+	    def self.all
+	        url = "/calendars.json"
+	        response = Basecampeverest::Connect.get url
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    #  a specific calendar via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] calendar_id the id of the calendar
+	    # @return [Basecampeverest::Project] an array of the calendar information from the Basecamp API
+	    def self.find(calendar_id)
+	        url = "/calendars/#{calendar_id}.json"
+	        response = Basecampeverest::Connect.get url
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # create a calendar via the Basecamp API
+	    # 
+	    # 
+	    # @param [Basecampeverest::Project] options a hash that contains the array of the name of the calendar to be created
+	    # @return [Basecampeverest::Project] the info of the calendar created from the Basecamp API
+	    def self.new(options={})
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+	        }
+	        # make the http basecamp call
+	        url = "/calendars.json"
+	        response = Basecampeverest::Connect.post url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # update a calendar via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] calendar_id the id of the calendar
+	    # @return [Basecampeverest::Project] the created calendar from the Basecamp API
+	    def self.update(calendar_id)
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.merge({'Content-Type' => 'application/json'})
+	        }
+
+	        # make the http basecamp call
+	        url = "/calendars/#{calendar_id}.json"
+	        response = Basecampeverest::Connect.put url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # delete a calendar via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] calendar_id the id of the calendar
+	    # @return [Basecampeverest::Project] a message with successful or unsuccessful deletion
+	    def self.delete(calendar_id)
+	    	url = "/calendars/#{calendar_id}.json"
+	        response = Basecampeverest::Connect.delete url
+
+	        # This checks the response code for validity and error checking
+	        if response.code == 204
+	            message = "#### successfully deleted"
+	        elsif response.code == 403
+	            message = "You do not have permission to delete this ####"
+	        else 
+	            message = "Invalid project ID or authentication. The #### was not deleted."
+	        end
+
+	        # return the message
+	        message
+	    end
+
+	# end module and class
+end; end

data/lib/basecampeverest/resources/calendar_event.rb

@@ -0,0 +1,87 @@
+module Basecampeverest; class CalendarEvents
+
+	    # find all #### via the Basecamp API
+	    # 
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.all
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.find()
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.new(options={})
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+	        }
+	        # make the http basecamp call
+	        url = "####"
+	        response = Basecampeverest::Connect.post url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] #### 
+	    # @return [Basecampeverest::Project]  from the Basecamp API
+	    def self.update()
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.merge({'Content-Type' => 'application/json'})
+	        }
+
+	        # make the http basecamp call
+	        url = 
+	        response = Basecampeverest::Connect.put url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] ####
+	    def self.delete()
+	        url = "####"
+	        response = Basecampeverest::Connect.delete url
+
+	        # This checks the response code for validity and error checking
+	        if response.code == 204
+	            message = "#### successfully deleted"
+	        elsif response.code == 403
+	            message = "You do not have permission to delete this ####"
+	        else 
+	            message = "Invalid project ID or authentication. The #### was not deleted."
+	        end
+
+	        # return the message
+	        message
+	    end
+
+	# end module and class
+end; end

data/lib/basecampeverest/resources/comment.rb

@@ -0,0 +1,87 @@
+module Basecampeverest; class Comment
+
+	    # find all #### via the Basecamp API
+	    # 
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.all
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.find()
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.new(options={})
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+	        }
+	        # make the http basecamp call
+	        url = "####"
+	        response = Basecampeverest::Connect.post url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] #### 
+	    # @return [Basecampeverest::Project]  from the Basecamp API
+	    def self.update()
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.merge({'Content-Type' => 'application/json'})
+	        }
+
+	        # make the http basecamp call
+	        url = 
+	        response = Basecampeverest::Connect.put url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] ####
+	    def self.delete()
+	        url = "####"
+	        response = Basecampeverest::Connect.delete url
+
+	        # This checks the response code for validity and error checking
+	        if response.code == 204
+	            message = "#### successfully deleted"
+	        elsif response.code == 403
+	            message = "You do not have permission to delete this ####"
+	        else 
+	            message = "Invalid project ID or authentication. The #### was not deleted."
+	        end
+
+	        # return the message
+	        message
+	    end
+
+	# end module and class
+end; end

data/lib/basecampeverest/resources/document.rb

@@ -0,0 +1,87 @@
+module Basecampeverest; class Document
+
+	    # find all #### via the Basecamp API
+	    # 
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.all
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.find()
+	        url = 
+	        response = Basecampeverest::Connect.get 
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] #### from the Basecamp API
+	    def self.new(options={})
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.headers.merge({'Content-Type' => 'application/json'})
+	        }
+	        # make the http basecamp call
+	        url = "####"
+	        response = Basecampeverest::Connect.post url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @param [Basecampeverest::Project] #### 
+	    # @return [Basecampeverest::Project]  from the Basecamp API
+	    def self.update()
+	        post_params = {
+	          :body => options.to_json,
+	          :headers => Basecampeverest::Connect.merge({'Content-Type' => 'application/json'})
+	        }
+
+	        # make the http basecamp call
+	        url = 
+	        response = Basecampeverest::Connect.put url, post_params
+
+	        # parse the response to remove HTTParty info
+	        response.parsed_response
+	    end
+
+
+	    # #### via the Basecamp API
+	    # 
+	    # @param [Basecampeverest::Project] ####
+	    # @return [Basecampeverest::Project] ####
+	    def self.delete()
+	        url = "####"
+	        response = Basecampeverest::Connect.delete url
+
+	        # This checks the response code for validity and error checking
+	        if response.code == 204
+	            message = "#### successfully deleted"
+	        elsif response.code == 403
+	            message = "You do not have permission to delete this ####"
+	        else 
+	            message = "Invalid project ID or authentication. The #### was not deleted."
+	        end
+
+	        # return the message
+	        message
+	    end
+
+	# end module and class
+end; end