bugherd_client 0.0.6 → 0.0.8

data/lib/bugherd_client/resources/v1/task.rb

@@ -12,7 +12,7 @@ module BugherdClient
         STATUSES   = ['feedback', 'backlog','todo','doing','done','closed']
         STATUSES.each.with_index do |status, index|
           if index == 0
-            Task.const_set("STATUS_#{status.upcase}", nil)  
+            Task.const_set("STATUS_#{status.upcase}", nil)
           else
             Task.const_set("STATUS_#{status.upcase}", index-1)
           end
@@ -37,15 +37,15 @@ module BugherdClient
 
         #
         # Create a new Task
-        # attributes: 
-        #   description, priority, status, tag_names(Array), 
-        #   requester_id or requester_email, 
+        # attributes:
+        #   description, priority, status, tag_names(Array),
+        #   requester_id or requester_email,
         #   assigned_to_id or assigned_to_email
         #   external_id
         # if status is null the Task is automatically put in the Feedback panel
-        # "requester_email" can be any email address while "assigned_to_email" needs to be of a current project member.
-        # Values for "priority" are not set, critical, important, normal, and minor.
-        # Values for "status" are backlog, todo, doing, done, and closed. Omit this field or set as "null" to send tasks to the Feedback panel.
+        # 'requester_email' can be any email address while 'assigned_to_email' needs to be of a current project member.
+        # Values for 'priority' are not set, critical, important, normal, and minor.
+        # Values for 'status' are backlog, todo, doing, done, and closed. Omit this field or set as 'null' to send tasks to the Feedback panel.
         # External ID is an API-only field. It cannot be set from the BugHerd application, only using the API. An external ID can be used to track originating IDs from other systems in BugHerd bugs.
         def create(project_id, attributes={})
           raw_response = post_request("projects/#{project_id}/tasks", task: attributes)
@@ -57,8 +57,11 @@ module BugherdClient
           parse_response(raw_response)
         end
 
+        def delete(project_id, task_id)
+        end
+
       end
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v2/attachment.rb

@@ -0,0 +1,73 @@
+module BugherdClient
+  module Resources
+    module V2
+
+      class Attachment < Base
+
+        # LIST
+        #
+        # Get a paginated list of attachments for a task.
+        # GET /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments.json
+        def all(project_id, task_id)
+          raw_response = get_request("projects/#{project_id}/tasks/#{task_id}/attachments")
+          parse_response(raw_response, :attachments)
+        end
+
+        # SHOW
+        #
+        # Get detail for specific attachment.
+        # GET /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/#{id}.json
+        def find(project_id, task_id, attachment_id)
+          raw_response = get_request("projects/#{project_id}/tasks/#{task_id}/attachments/#{attachment_id}")
+          parse_response(raw_response)
+        end
+
+        # CREATE
+        #
+        # Adds a new attachment to the specified task using an existing URL.
+        # POST /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments.json
+        #
+        # PARAMS
+        # {'attachment':{
+        #   'file_name':'resolution.gif',
+        #   'url':'http://i.imgur.com/U9h3jZI.gif'
+        # }}
+        def create(project_id, task_id, payload)
+          raw_response = post_request("projects/#{project_id}/tasks/#{task_id}/attachments", attachment: payload)
+          parse_response(raw_response, :attachment)
+        end
+
+        # UPLOAD
+        #
+        # Upload a new attachment and add it to the specified task.
+        # The file contents need to be specified as the POST data on this request.
+        #
+        # Note that your upload needs to be reasonable in size as the maximum time the request
+        # may take is around 30 seconds.
+        # If you have larger uploads please create arrange your own file upload
+        # and create the attachment from a URL instead.
+        #
+        # POST /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/upload
+        #
+        # Note in the sample below please specify an existing file name.
+        def upload(project_id, task_id, payload)
+          uri = "projects/#{project_id}/tasks/#{task_id}/attachments/upload"
+          headers = { content_type: 'application/binary' }
+          raw_response = post_request(uri, payload.merge(headers: headers))
+          parse_response(raw_response, :attachment)
+        end
+
+        # DELETE
+        #
+        # Delete an attachment from a task. Note that this action is permanent and cannot be undone.
+        # DELETE /api_v2/projects/#{project_id}/tasks/#{task_id}/attachments/#{id}.json
+        def delete(project_id, task_id, attachment_id)
+          raw_response = delete_request("projects/#{project_id}/tasks/#{task_id}/attachments/#{attachment_id}")
+          parse_response(raw_response)
+        end
+
+      end
+
+    end # V2
+  end # Resources
+end # BugherdClient

data/lib/bugherd_client/resources/v2/base.rb

@@ -18,16 +18,22 @@ module BugherdClient
           self.class.instance_methods(false)
         end
 
-        attr_accessor :connection, :options
+        # store a reference to the HTTP connection
+        attr_accessor :connection
+
+        attr_accessor :options
+
         def initialize(conn, opts={})
           @connection, @options = conn, opts
         end
 
-        def send_request(method="GET", path="", params={}, headers={})
+        def send_request(method='GET', path='', params={}, headers={})
           headers = DEFAULT_HEADER_ATTRS.merge(headers)
           params.merge!(headers)
           method_name = method.to_s.downcase
           self.connection[path].__send__(method_name, params)
+        rescue RestClient::Exception => e
+          raise(BugherdClient::Errors::HttpRequestError.new(e.message, e.http_code))
         end
 
         [:get, :post, :put, :patch, :delete].each do |method_name|
@@ -36,16 +42,29 @@ module BugherdClient
           end
         end
 
+        def converter(body)
+          case body
+          when Hash
+            ::Hashie::Mash.new(body)
+          when Array
+            body.map { |item| item.is_a?(Hash) ? converter(item) : item }
+          else
+            body
+          end
+        end
+
         def parse_response(response, root_element=nil)
-          if root_element
-            JSON.parse(response)[root_element.to_s]
+          parsed = if root_element
+            p = JSON.parse(response)
+            p.key?(root_element.to_s) ? p[root_element.to_s] : p
           else
             JSON.parse(response)
           end
+          converter(parsed)
         end
 
       end
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v2/comment.rb

@@ -1,7 +1,7 @@
 module BugherdClient
   module Resources
     module V2
-      
+
       class Comment < Base
 
         #
@@ -31,4 +31,4 @@ module BugherdClient
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v2/organization.rb

@@ -1,18 +1,18 @@
 module BugherdClient
   module Resources
     module V2
-      
+
       class Organization < Base
 
         #
         # Get more detail of your account.
-        # 
+        #
         def get
           raw_response = self.connection['organization'].get
           parse_response(raw_response, :organization)
         end
       end
 
-    end
-  end
-end
+    end # V2
+  end # Resources
+end # BugherdClient

data/lib/bugherd_client/resources/v2/project.rb

@@ -6,7 +6,7 @@ module BugherdClient
 
         #
         # Get more detail of your account.
-        # 
+        #
         def all
           raw_response = get_request('projects')
           parse_response(raw_response, :projects)
@@ -14,18 +14,27 @@ module BugherdClient
 
         #
         # Show details for a specific project
-        # 
+        #
         def find(project_id)
           raw_response = get_request("projects/#{project_id}")
           parse_response(raw_response, :project)
         end
 
+        # CREATE
+        #
+        # Create a new project. The project will initially have no members.
+        # POST /api_v2/projects.json
+        #
+        # PARAMS:
+        # {
+        #   "name": "My Website",
+        #   "devurl": "http://www.example.com",
+        #   "is_active": true,
+        #   "is_public": false
+        # }
         #
-        # Create a Project, will initially have no members
-        # attributes: name, devurl, is_public, is_active
-        # 
         def create(attributes={})
-          raw_response = post_request("projects", project: attributes)
+          raw_response = post_request('projects', project: attributes)
           parse_response(raw_response, :project)
         end
 
@@ -37,7 +46,7 @@ module BugherdClient
           parse_response(raw_response, :project)
         end
 
-        # 
+        #
         # Delete a project and all associated data. Use with care, deleted projects cannot be recovered.
         # API: 1,2
         def delete(project_id)
@@ -45,7 +54,7 @@ module BugherdClient
           parse_response(raw_response)
         end
 
-        # 
+        #
         # Add an existing guest to a project, or invite someone by email address.
         # required: project_id
         # attributes: user_id, email
@@ -55,11 +64,11 @@ module BugherdClient
           parse_response(raw_response)
         end
 
-        # 
+        #
         # Add an existing guest to a project, or invite someone by email address.
         # required: project_id
         # attributes: user_id
-        # 
+        #
         def add_member(project_id, attributes={})
           raw_response = post_request("projects/#{project_id}/add_member", attributes)
           parse_response(raw_response)
@@ -68,13 +77,13 @@ module BugherdClient
 
         #
         # Get all active projects
-        # 
+        #
         def active
           raw_response = get_request('projects/active')
           parse_response(raw_response, :projects)
         end
       end
-      
+
     end
   end
-end
+end

data/lib/bugherd_client/resources/v2/task.rb

@@ -5,20 +5,31 @@ module BugherdClient
       class Task < Base
 
         PRIORITIES = ['not set', 'critical', 'important', 'normal','minor']
-        PRIORITIES.each do |priority|
-          Task.const_set("PRIORITY_#{priority.gsub(' ', '').upcase}", priority)
+        PRIORITIES.each { |p| Task.const_set("PRIORITY_#{p.gsub(' ', '').upcase}", p) }
+        def priorities
+          self.class::PRIORITIES
         end
 
-        STATUSES   = ['backlog','todo','doing','done','closed']
-        STATUSES.each do |status|
-          Task.const_set("STATUS_#{status.upcase}", status)
+        STATUSES = ['backlog','todo','doing','done','closed']
+        STATUSES.each { |s| Task.const_set("STATUS_#{s.upcase}", s) }
+        def statuses
+          self.class::STATUSES
         end
 
+        VALID_QUERY_KEYS = [:page, :updated_since, :created_since, :status, :priority, :assigned_to_id, :external_id]
+
         #
         # Get a full list of tasks for a project, including archived tasks.
-        # filters: updated_since, created_since, status, priority, tag and external_id
+        # filters: updated_since, created_since, status, priority, tag,
+        #          assigned_to_id, and external_id.
+        #
+        # example:
+        #
+        # client.tasks.all(45, { status: 'backlog' })
+        #
         def all(project_id, filter_attributes={})
           params = filter_attributes.empty? ? {} : { params: filter_attributes }
+          validate_filter_attributes!(filter_attributes) unless filter_attributes.empty?
           raw_response = get_request("projects/#{project_id}/tasks", params)
           parse_response(raw_response, :tasks)
         end
@@ -28,20 +39,20 @@ module BugherdClient
         #
         def find(project_id, task_id)
           raw_response = get_request("projects/#{project_id}/tasks/#{task_id}")
-          parse_response(raw_response)
+          parse_response(raw_response, :task)
         end
 
         #
         # Create a new Task
-        # attributes: 
-        #   description, priority, status, tag_names(Array), 
-        #   requester_id or requester_email, 
+        # attributes:
+        #   description, priority, status, tag_names(Array),
+        #   requester_id or requester_email,
         #   assigned_to_id or assigned_to_email
         #   external_id
         # if status is null the Task is automatically put in the Feedback panel
-        # "requester_email" can be any email address while "assigned_to_email" needs to be of a current project member.
-        # Values for "priority" are not set, critical, important, normal, and minor.
-        # Values for "status" are backlog, todo, doing, done, and closed. Omit this field or set as "null" to send tasks to the Feedback panel.
+        # 'requester_email' can be any email address while 'assigned_to_email' needs to be of a current project member.
+        # Values for 'priority' are not set, critical, important, normal, and minor.
+        # Values for 'status' are backlog, todo, doing, done, and closed. Omit this field or set as 'null' to send tasks to the Feedback panel.
         # External ID is an API-only field. It cannot be set from the BugHerd application, only using the API. An external ID can be used to track originating IDs from other systems in BugHerd bugs.
         def create(project_id, attributes={})
           raw_response = post_request("projects/#{project_id}/tasks", task: attributes)
@@ -53,8 +64,17 @@ module BugherdClient
           parse_response(raw_response)
         end
 
+        private
+          def validate_filter_attributes!(input_filters = {})
+            input_filters.keys.compact.each do |k|
+              unless VALID_QUERY_KEYS.include?(k.to_sym)
+                raise(BugherdClient::Errors::InvalidQueryKey.new(k, VALID_QUERY_KEYS))
+              end
+            end
+          end
+
       end
 
     end
   end
-end
+end

data/lib/bugherd_client/resources/v2/webhook.rb

@@ -0,0 +1,54 @@
+module BugherdClient
+  module Resources
+    module V2
+      class Webhook < Base
+
+        EVENTS = ['task_create', 'task_update', 'task_destroy', 'comment']
+        def events
+          self.class::EVENTS
+        end
+
+        # LIST
+        #
+        # Get a list of currently installed webhooks.
+        #
+        # GET /api_v2/webhooks.json
+        def all
+          raw_response = get_request('webhooks')
+          parse_response(raw_response, :webhooks)
+        end
+
+        # CREATE
+        #
+        # When installing a webhook, specify an event you wish to hook into.
+        # Choose from: 'task_create', 'task_update', 'comment' or 'task_destroy'.
+        # To get activity for all 3 events, create an entry for each event.
+        #
+        # 'project_id' is optional; it only needs to be specified if you'd only like
+        # events on a specific project. Omitting 'project_id' results in notifications
+        # of activity on all your projects.
+        #
+        # PARAMS
+        # {
+        #   'project_id':1,
+        #   'target_url':'https://app.example.com/api/bugherd_sync/project/1/task_create',
+        #   'event':'task_create'
+        # }
+        #
+        def create(payload = {})
+          raw_response = post_request('webhooks', payload)
+          parse_response(raw_response, :webhook)
+        end
+
+        # DELETE
+        #
+        # DELETE /api_v2/webhooks/#{id}.json
+        def delete(webhook_id)
+          raw_response = delete_request("webhooks/#{webhook_id}")
+          parse_response(raw_response)
+        end
+
+      end
+    end # V2
+  end # Resources
+end # BugherdClient

data/lib/bugherd_client/version.rb

@@ -2,7 +2,7 @@ module BugherdClient
   module VERSION
     MAJOR = 0
     MINOR = 0
-    PATCH = 6
+    PATCH = 8
 
     STRING = [MAJOR,MINOR,PATCH].join('.')
   end