asana 2.0.1 → 2.0.2

data/lib/asana/http_client/error_handling.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../errors'
 
 module Asana
@@ -25,37 +27,34 @@ module Asana
       # Raises [Asana::Errors::ServerError] when there's a server problem.
       # Raises [Asana::Errors::APIError] when the API returns an unknown error.
       #
-      # rubocop:disable all
-      def handle(num_retries=0, &request)
+      # rubocop:disable Metrics/AbcSize
+      def handle(num_retries = 0, &request)
         request.call
       rescue Faraday::ClientError => e
         raise e unless e.response
+
         case e.response[:status]
-          when 400 then raise invalid_request(e.response)
-          when 401 then raise not_authorized(e.response)
-          when 402 then raise payment_required(e.response)
-          when 403 then raise forbidden(e.response)
-          when 404 then raise not_found(e.response)
-          when 412 then recover_response(e.response)
-          when 429 then raise rate_limit_enforced(e.response)
-          when 500 then raise server_error(e.response)
-          else raise api_error(e.response)
+        when 400 then raise invalid_request(e.response)
+        when 401 then raise not_authorized(e.response)
+        when 402 then raise payment_required(e.response)
+        when 403 then raise forbidden(e.response)
+        when 404 then raise not_found(e.response)
+        when 412 then recover_response(e.response)
+        when 429 then raise rate_limit_enforced(e.response)
+        when 500 then raise server_error(e.response)
+        else raise api_error(e.response)
         end
       # Retry for timeouts or 500s from Asana
       rescue Faraday::ServerError => e
-        if num_retries < MAX_RETRIES
-          handle(num_retries + 1, &request)
-        else
-          raise server_error(e.response)
-        end
+        raise server_error(e.response) unless num_retries < MAX_RETRIES
+
+        handle(num_retries + 1, &request)
       rescue Net::ReadTimeout => e
-        if num_retries < MAX_RETRIES
-          handle(num_retries + 1, &request)
-        else
-          raise e
-        end
+        raise e unless num_retries < MAX_RETRIES
+
+        handle(num_retries + 1, &request)
       end
-      # rubocop:enable all
+      # rubocop:enable Metrics/AbcSize
 
       # Internal: Returns an InvalidRequest exception including a list of
       # errors.
@@ -110,13 +109,15 @@ module Asana
 
       # Internal: Parser a response body from JSON.
       def body(response)
-        JSON.load(response[:body])
+        JSON.parse(response[:body])
       end
 
+      # rubocop:disable Style/OpenStructUse
       def recover_response(response)
         r = response.dup.tap { |res| res[:body] = body(response) }
         Response.new(OpenStruct.new(env: OpenStruct.new(r)))
       end
+      # rubocop:enable Style/OpenStructUse
     end
   end
 end

data/lib/asana/http_client/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   class HttpClient
     # Internal: Represents a response from the Asana API.

data/lib/asana/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday/follow_redirects'
 
@@ -10,7 +12,7 @@ module Asana
   # parsing and common options.
   class HttpClient
     # Internal: The API base URI.
-    BASE_URI = 'https://app.asana.com/api/1.0'.freeze
+    BASE_URI = 'https://app.asana.com/api/1.0'
 
     # Public: Initializes an HttpClient to make requests to the Asana API.
     #
@@ -130,7 +132,7 @@ module Asana
         configure_format(builder)
         add_middleware(builder)
         configure_redirects(builder)
-        @config.call(builder) if @config
+        @config&.call(builder)
         use_adapter(builder, @adapter)
       end
     end
@@ -173,79 +175,75 @@ module Asana
     end
 
     def log_request(method, url, body)
-      STDERR.puts format('[%s] %s %s (%s)',
-                         self.class,
-                         method.to_s.upcase,
-                         url,
-                         body.inspect)
+      warn format('[%<klass>s] %<method>s %<url>s (%<bodt>s)',
+                  klass: self.class,
+                  method: method.to_s.upcase,
+                  url: url,
+                  body: body.inspect)
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def log_asana_change_headers(request_headers, response_headers)
       change_header_key = nil
 
       response_headers.each_key do |key|
-        if key.downcase == 'asana-change'
-            change_header_key = key
-        end
+        change_header_key = key if key.downcase == 'asana-change'
       end
 
-      if change_header_key != nil
-        accounted_for_flags = Array.new
+      return if change_header_key.nil?
 
-        if request_headers == nil
-          request_headers = {}
-        end
-        # Grab the request's asana-enable flags
-        request_headers.each_key do |req_header|
-          if req_header.downcase == 'asana-enable'
-            request_headers[req_header].split(',').each do |flag|
-              accounted_for_flags.push(flag)
-            end
-          elsif req_header.downcase == 'asana-disable'
-            request_headers[req_header].split(',').each do |flag|
-              accounted_for_flags.push(flag)
-            end
+      accounted_for_flags = []
+
+      request_headers = {} if request_headers.nil?
+      # Grab the request's asana-enable flags
+      request_headers.each_key do |req_header|
+        case req_header.downcase
+        when 'asana-enable', 'asana-disable'
+          request_headers[req_header].split(',').each do |flag|
+            accounted_for_flags.push(flag)
           end
         end
+      end
+
+      changes = response_headers[change_header_key].split(',')
+
+      changes.each do |unsplit_change|
+        change = unsplit_change.split(';')
 
-        changes = response_headers[change_header_key].split(',')
-
-        changes.each do |unsplit_change|
-          change = unsplit_change.split(';')
-
-          name = nil
-          info = nil
-          affected = nil
-
-          change.each do |unsplit_field|
-            field = unsplit_field.split('=')
-
-            field[0].strip!
-            field[1].strip!
-            if field[0] == 'name'
-                name = field[1]
-            elsif field[0] == 'info'
-                info = field[1]
-            elsif field[0] == 'affected'
-                affected = field[1]
-            end
-
-            # Only show the error if the flag was not in the request's asana-enable header
-            if !(accounted_for_flags.include? name) && (affected == 'true')
-              message1 = 'This request is affected by the "%s"' +
-              ' deprecation. Please visit this url for more info: %s'
-              message2 = 'Adding "%s" to your "Asana-Enable" or ' +
-              '"Asana-Disable" header will opt in/out to this deprecation ' +
-              'and suppress this warning.'
-
-              STDERR.puts format(message1, name, info)
-              STDERR.puts format(message2, name)
-            end
+        name = nil
+        info = nil
+        affected = nil
+
+        change.each do |unsplit_field|
+          field = unsplit_field.split('=')
+
+          field[0].strip!
+          field[1].strip!
+          case field[0]
+          when 'name'
+            name = field[1]
+          when 'info'
+            info = field[1]
+          when 'affected'
+            affected = field[1]
           end
+
+          # Only show the error if the flag was not in the request's asana-enable header
+          next unless !(accounted_for_flags.include? name) && (affected == 'true')
+
+          message1 = 'This request is affected by the "%s" ' \
+                     'deprecation. Please visit this url for more info: %s'
+          message2 = 'Adding "%s" to your "Asana-Enable" or ' \
+                     '"Asana-Disable" header will opt in/out to this deprecation ' \
+                     'and suppress this warning.'
+
+          warn format(message1, name, info)
+          warn format(message2, name)
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
   end
 end
-
-

data/lib/asana/resource_includes/attachment_uploading.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday/multipart'
 
 module Asana
@@ -13,8 +15,6 @@ module Asana
       # options  - [Hash] the request I/O options
       # data     - [Hash] extra attributes to post
       #
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       def attach(filename: required('filename'),
                  mime: required('mime'),
                  io: nil, options: {}, **data)
@@ -35,8 +35,6 @@ module Asana
 
         Attachment.new(parse(response).first, client: client)
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/asana/resource_includes/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'response_helper'
 
 module Asana
@@ -40,7 +42,7 @@ module Asana
       def last
         @elements.last
       end
-      
+
       # Public: Returns the size of the collection.
       def size
         to_a.size
@@ -49,9 +51,7 @@ module Asana
 
       # Public: Returns a String representation of the collection.
       def to_s
-        "#<Asana::Collection<#{@type}> " \
-          "[#{@elements.map(&:inspect).join(', ')}" +
-          (@next_page_data ? ', ...' : '') + ']>'
+        "#<Asana::Collection<#{@type}> [#{@elements.map(&:inspect).join(', ')}#{@next_page_data ? ', ...' : ''}]>"
       end
       alias inspect to_s
 

data/lib/asana/resource_includes/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'events'
 
 module Asana

data/lib/asana/resource_includes/event_subscription.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'events'
 
 module Asana

data/lib/asana/resource_includes/events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'event'
 
 module Asana
@@ -89,13 +91,14 @@ module Asana
 
       # Internal: Returns the formatted params for the poll request.
       def params
-        { resource: @resource, sync: @sync }.reject { |_, v| v.nil? }
+        { resource: @resource, sync: @sync }.compact
       end
 
       # Internal: Executes a block if at least @wait seconds have passed since
       # @last_poll.
       def rate_limiting
         return if @last_poll && Time.now - @last_poll <= @wait
+
         yield.tap { @last_poll = Time.now }
       end
     end

data/lib/asana/resource_includes/registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'resource'
 require 'set'
 

data/lib/asana/resource_includes/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'registry'
 require_relative 'response_helper'
 
@@ -21,6 +23,7 @@ module Asana
       def refresh
         raise "#{self.class.name} does not respond to #find_by_id" unless \
           self.class.respond_to?(:find_by_id)
+
         self.class.find_by_id(client, gid)
       end
 
@@ -30,17 +33,17 @@ module Asana
       # Returns the value for the requested property.
       #
       # Raises a NoMethodError if the property doesn't exist.
-      def method_missing(m, *args)
-        super unless respond_to_missing?(m, *args)
-        cache(m, wrapped(to_h[m.to_s]))
+      def method_missing(method_name, *args)
+        super unless respond_to_missing?(method_name, *args)
+        cache(method_name, wrapped(to_h[method_name.to_s]))
       end
 
       # Internal: Guard for the method_missing proxy. Checks if the resource
       # actually has a specific piece of data at all.
       #
       # Returns true if the resource has the property, false otherwise.
-      def respond_to_missing?(m, *)
-        to_h.key?(m.to_s)
+      def respond_to_missing?(method_name, *)
+        to_h.key?(method_name.to_s)
       end
 
       # Public:

data/lib/asana/resource_includes/response_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   module Resources
     # Internal: A helper to make response body parsing easier.

data/lib/asana/resources/audit_log_api.rb

@@ -0,0 +1,42 @@
+require_relative 'gen/audit_log_api_base'
+
+module Asana
+  module Resources
+    class AuditLogAPI < AuditLogAPIBase
+
+
+      attr_reader :gid
+
+      attr_reader :actor
+
+      attr_reader :context
+      
+      attr_reader :api_authentication_method
+
+      attr_reader :client_ip_address
+      
+      attr_reader :context_type
+
+      attr_reader :oauth_app_name
+
+      attr_reader :user_agent
+
+      attr_reader :created_at
+
+      attr_reader :details
+
+      attr_reader :event_category
+
+      attr_reader :event_type
+
+      attr_reader :resource
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'audit_log_apis'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/gen/attachments_base.rb

@@ -39,7 +39,7 @@ module Asana
         # Get attachments from an object
         #
 
-        # parent - [str]  (required) Globally unique identifier for object to fetch statuses from. Must be a GID for a task, project, or project_brief.
+        # parent - [str]  (required) Globally unique identifier for object to fetch statuses from. Must be a GID for a `project`, `project_brief`, or `task`.
         # options - [Hash] the request I/O options
         # > offset - [str]  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
         # > limit - [int]  Results per page. The number of objects to return per page. The value must be between 1 and 100.

data/lib/asana/resources/gen/audit_log_api_base.rb

@@ -17,7 +17,7 @@ module Asana
         # workspace_gid - [str]  (required) Globally unique identifier for the workspace or organization.
         # start_at - [datetime]  Filter to events created after this time (inclusive).
         # end_at - [datetime]  Filter to events created before this time (exclusive).
-        # event_type - [str]  Filter to events of this type. Refer to the [Supported AuditLogEvents](/docs/supported-auditlogevents) for a full list of values.
+        # event_type - [str]  Filter to events of this type. Refer to the [supported audit log events](/docs/audit-log-events#supported-audit-log-events) for a full list of values.
         # actor_type - [str]  Filter to events with an actor of this type. This only needs to be included if querying for actor types without an ID. If `actor_gid` is included, this should be excluded.
         # actor_gid - [str]  Filter to events triggered by the actor with this ID.
         # resource_gid - [str]  Filter to events with this resource ID.

data/lib/asana/resources/gen/memberships_base.rb

@@ -0,0 +1,71 @@
+### WARNING: This file is auto-generated by our OpenAPI spec. Do not
+### edit it manually.
+
+require_relative '../../resource_includes/response_helper'
+
+module Asana
+  module Resources
+    class MembershipsBase < Resource
+
+      def self.inherited(base)
+        Registry.register(base)
+      end
+
+      class << self
+        # Create a membership
+        #
+
+        # options - [Hash] the request I/O options
+        # > opt_fields - [list[str]]  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+        # > opt_pretty - [bool]  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+        # data - [Hash] the attributes to POST
+        def create_membership(client, options: {}, **data)
+          path = "/memberships"
+          parse(client.post(path, body: data, options: options)).first
+        end
+
+        # Delete a membership
+        #
+        # membership_gid - [str]  (required) Globally unique identifier for the membership.
+        # options - [Hash] the request I/O options
+        # > opt_fields - [list[str]]  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+        # > opt_pretty - [bool]  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+        def delete_membership(client, membership_gid: required("membership_gid"), options: {})
+          path = "/memberships/{membership_gid}"
+          path["{membership_gid}"] = membership_gid
+          parse(client.delete(path, options: options)).first
+        end
+
+        # Get multiple memberships
+        #
+
+        # parent - [str]  (required) Globally unique identifier for `project`, `portfolio`,   `team`, `goal`, and `workspace`.
+        # member - [str]  Globally unique identifier for `team` and `user`.
+        # options - [Hash] the request I/O options
+        # > offset - [str]  Offset token. An offset to the next page returned by the API. A pagination request will return an offset token, which can be used as an input parameter to the next request. If an offset is not passed in, the API will return the first page of results. 'Note: You can only pass in an offset that was returned to you via a previously paginated request.'
+        # > limit - [int]  Pagination limit for the request.
+        # > opt_fields - [list[str]]  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+        # > opt_pretty - [bool]  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+        def get_memberships(client, parent: nil, member: nil, options: {})
+          path = "/memberships"
+          params = { parent: parent, member: member }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get(path, params: params, options: options)), type: Resource, client: client)
+        end
+
+        # Update a membership
+        #
+        # membership_gid - [str]  (required) Globally unique identifier for the membership.
+        # options - [Hash] the request I/O options
+        # > opt_fields - [list[str]]  Defines fields to return. Some requests return *compact* representations of objects in order to conserve resources and complete the request more efficiently. Other times requests return more information than you may need. This option allows you to list the exact set of fields that the API should be sure to return for the objects. The field names should be provided as paths, described below. The id of included objects will always be returned, regardless of the field options.
+        # > opt_pretty - [bool]  Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.
+        # data - [Hash] the attributes to PUT
+        def update_membership(client, membership_gid: required("membership_gid"), options: {}, **data)
+          path = "/memberships/{membership_gid}"
+          path["{membership_gid}"] = membership_gid
+          parse(client.put(path, body: data, options: options)).first
+        end
+
+      end
+    end
+  end
+end

data/lib/asana/resources/gen/tasks_base.rb

@@ -186,7 +186,7 @@ module Asana
 
         # assignee - [str]  The assignee to filter tasks on. If searching for unassigned tasks, assignee.any = null can be specified. *Note: If you specify `assignee`, you must also specify the `workspace` to filter on.*
         # project - [str]  The project to filter tasks on.
-        # section - [str]  The section to filter tasks on. *Note: Currently, this is only supported in board views.*
+        # section - [str]  The section to filter tasks on.
         # workspace - [str]  The workspace to filter tasks on. *Note: If you specify `workspace`, you must also specify the `assignee` to filter on.*
         # completed_since - [datetime]  Only return tasks that are either incomplete or that have been completed since this time.
         # modified_since - [datetime]  Only return tasks that have been modified since the given time.  *Note: A task is considered “modified” if any of its properties change, or associations between it and other objects are modified (e.g.  a task being added to a project). A task is not considered modified just because another object it is associated with (e.g. a subtask) is modified. Actions that count as modifying the task include assigning, renaming, completing, and adding stories.*

data/lib/asana/resources/goal.rb

@@ -0,0 +1,54 @@
+require_relative 'gen/goals_base'
+
+module Asana
+  module Resources
+    class Goal < GoalsBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :due_on
+      
+      attr_reader :html_notes
+
+      attr_reader :is_workspace_level
+
+      attr_reader :liked
+
+      attr_reader :name
+
+      attr_reader :notes
+
+      attr_reader :start_on
+
+      attr_reader :status
+
+      attr_reader :current_status_update
+
+      attr_reader :followers
+
+      attr_reader :likes
+      
+      attr_reader :metric
+      
+      attr_reader :num_likes
+
+      attr_reader :owner
+
+      attr_reader :team
+
+      attr_reader :time_period
+
+      attr_reader :workspace
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'goals'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/goal_relationship.rb

@@ -0,0 +1,32 @@
+require_relative 'gen/goal_relationships_base'
+
+module Asana
+  module Resources
+    class GoalRelationship < GoalRelationshipsBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :contribution_weight
+      
+      attr_reader :resource_subtype
+
+      attr_reader :supported_goal
+
+      attr_reader :owner
+
+      attr_reader :supporting_resource
+
+      attr_reader :supporting_resource
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'goal_relationships'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/membership.rb

@@ -0,0 +1,20 @@
+require_relative 'gen/memberships_base'
+
+module Asana
+  module Resources
+    class Membership < MembershipsBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'memberships'
+        end
+      end
+    end
+  end
+end

data/lib/asana/resources/project_brief.rb

@@ -0,0 +1,30 @@
+require_relative 'gen/project_briefs_base'
+
+module Asana
+  module Resources
+    class ProjectBrief < ProjectBriefsBase
+
+
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :html_text
+      
+      attr_reader :title
+
+      attr_reader :permalink_url
+
+      attr_reader :project
+
+      attr_reader :text
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'project_briefs'
+        end
+      end
+    end
+  end
+end