asana 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bc6296b155b3b42ce8fc8ab137e43e8d327865c00707e88cb46c9b73746dd92
-  data.tar.gz: 832942a530575433b30106c06dc2400434c430ea45b37da4ea91ecfaa9b21cee
+  metadata.gz: fba81fcfd6e52f9ed9b9351753b1fc053ef365023841c54d82b64fe63615211b
+  data.tar.gz: d69406d6cd8b45e8e824b6ab011f4ca4568ee08d41bb6c13da1e8f5c70c85d9d
 SHA512:
-  metadata.gz: 8f8f4196cf80c3b6101853a51f04b63d2a938f51f8d748d97c736130fa48f843f1a68d21d4728b3f8f206252f8cc203f6dcf3d42bbca2a5a4371c96426e268b2
-  data.tar.gz: d46be8861327941a32f0e5a4ae46c178be58859ca0e4db6814d6d57bd8fee518d5c24ed27a90d12f84b008a63e398aec2820986c3ad9591121739f376331a8fc
+  metadata.gz: b5f09823b1fd94a67c66b80a98d2b22085c365c5ef45fe8103d132c44269434c199ad16ceeb616c9c6479bb7d7f6a25f878acafc59069432e98d7b61e2a56dec
+  data.tar.gz: df14ac41b6115767e8844bd60524c2b73f3b219a9fa7937b9b5ae73ce6c00fdc10bce26a88b289f788a01de0dd4cb8edccf95c2c1886fb9a1e53c5cc5e2aa296

data/.gitignore

@@ -11,3 +11,4 @@
 /bin/
 test.rb
 /node_modules/
+/gemfiles/

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/README.md

@@ -3,7 +3,6 @@
 [![Gem Version](https://badge.fury.io/rb/asana.svg)](http://badge.fury.io/rb/asana)
 [![Build Status](https://travis-ci.org/Asana/ruby-asana.svg?branch=master)](https://travis-ci.org/Asana/ruby-asana)
 [![Code Climate](https://codeclimate.com/github/Asana/ruby-asana/badges/gpa.svg)](https://codeclimate.com/github/Asana/ruby-asana)
-[![Dependency Status](https://gemnasium.com/Asana/ruby-asana.svg)](https://gemnasium.com/Asana/ruby-asana)
 
 
 A Ruby client for the 1.0 version of the Asana API.
@@ -341,6 +340,25 @@ Thread.new do
 end
 ```
 
+### Asana Change Warnings
+
+You will receive warning logs if performing requests that may be affected by a deprecation. The warning contains a link that explains the deprecation.
+
+If you receive one of these warnings, you should:
+* Read about the deprecation.
+* Resolve sections of your code that would be affected by the deprecation.
+* Add the deprecation flag to your "asana-enable" header.
+
+You can add global headers, by setting default_headers
+
+    c.default_headers "asana-enable" => "string_ids"
+    
+Or you can add a header field to the options of each request.
+
+If you would rather suppress these warnings, you can set
+
+    c.log_asana_change_warnings false
+
 ## Development
 
 You'll need Ruby 2.1+ and Node v0.10.26+ / NPM 1.4.3+ installed.

data/asana.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_dependency "faraday_middleware-multi_json", "~> 0.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency 'appraisal', '~> 2.1', '>= 2.1'

data/lib/asana/client.rb

@@ -75,10 +75,12 @@ module Asana
     def initialize
       config = Configuration.new.tap { |c| yield c }.to_h
       @http_client =
-        HttpClient.new(authentication: config.fetch(:authentication),
-                       adapter:        config[:faraday_adapter],
-                       user_agent:     config[:user_agent],
-                       debug_mode:     config[:debug_mode],
+        HttpClient.new(authentication:            config.fetch(:authentication),
+                       adapter:                   config[:faraday_adapter],
+                       user_agent:                config[:user_agent],
+                       debug_mode:                config[:debug_mode],
+                       log_asana_change_warnings: config[:log_asana_change_warnings],
+                       default_headers:           config[:default_headers],
                        &config[:faraday_configuration])
     end
 

data/lib/asana/client/configuration.rb

@@ -16,7 +16,9 @@ module Asana
     class Configuration
       # Public: Initializes an empty configuration object.
       def initialize
-        @configuration = {}
+        @configuration = {
+            :log_asana_change_warnings => true
+        }
       end
 
       # Public: Sets an authentication strategy.
@@ -63,6 +65,20 @@ module Asana
         @configuration[:debug_mode] = true
       end
 
+      # Public: Configures the client to log Asana-Change warnings on STDERR.
+      #
+      # Returns nothing.
+      def log_asana_change_warnings(value)
+        @configuration[:log_asana_change_warnings] = !!value
+      end
+
+      # Public: Configures the client to always send the given headers
+      #
+      # Returns nothing.
+      def default_headers(value)
+        @configuration[:default_headers] = value
+      end
+
       # Public:
       # Returns the configuration [Hash].
       def to_h

data/lib/asana/http_client.rb

@@ -26,12 +26,16 @@ module Asana
                    adapter: nil,
                    user_agent: nil,
                    debug_mode: false,
+                   log_asana_change_warnings: true,
+                   default_headers: nil,
                    &config)
-      @authentication   = authentication
-      @adapter          = adapter || Faraday.default_adapter
-      @environment_info = EnvironmentInfo.new(user_agent)
-      @debug_mode       = debug_mode
-      @config           = config
+      @authentication             = authentication
+      @adapter                    = adapter || Faraday.default_adapter
+      @environment_info           = EnvironmentInfo.new(user_agent)
+      @debug_mode                 = debug_mode
+      @log_asana_change_warnings  = log_asana_change_warnings
+      @default_headers            = default_headers
+      @config                     = config
     end
 
     # Public: Performs a GET request against the API.
@@ -49,7 +53,7 @@ module Asana
           hash[:"opt_#{k}"] = v.is_a?(Array) ? v.join(',') : v
         end
       end
-      perform_request(:get, resource_uri, params.merge(opts))
+      perform_request(:get, resource_uri, params.merge(opts), options[:headers])
     end
 
     # Public: Performs a PUT request against the API.
@@ -62,8 +66,14 @@ module Asana
     # Returns an [Asana::HttpClient::Response] if everything went well.
     # Raises [Asana::Errors::APIError] if anything went wrong.
     def put(resource_uri, body: {}, options: {})
+      opts = options.reduce({}) do |acc, (k, v)|
+        acc.tap do |hash|
+          hash[:"opt_#{k}"] = v.is_a?(Array) ? v.join(',') : v
+        end
+      end
+      options.merge(opts)
       params = { data: body }.merge(options.empty? ? {} : { options: options })
-      perform_request(:put, resource_uri, params)
+      perform_request(:put, resource_uri, params, options[:headers])
     end
 
     # Public: Performs a POST request against the API.
@@ -78,13 +88,19 @@ module Asana
     # Returns an [Asana::HttpClient::Response] if everything went well.
     # Raises [Asana::Errors::APIError] if anything went wrong.
     def post(resource_uri, body: {}, upload: nil, options: {})
+      opts = options.reduce({}) do |acc, (k, v)|
+        acc.tap do |hash|
+          hash[:"opt_#{k}"] = v.is_a?(Array) ? v.join(',') : v
+        end
+      end
+      options.merge(opts)
       params = { data: body }.merge(options.empty? ? {} : { options: options })
       if upload
-        perform_request(:post, resource_uri, params.merge(file: upload)) do |c|
+        perform_request(:post, resource_uri, params.merge(file: upload), options[:headers]) do |c|
           c.request :multipart
         end
       else
-        perform_request(:post, resource_uri, params)
+        perform_request(:post, resource_uri, params, options[:headers])
       end
     end
 
@@ -113,11 +129,14 @@ module Asana
       end
     end
 
-    def perform_request(method, resource_uri, body = {}, &request_config)
+    def perform_request(method, resource_uri, body = {}, headers = {}, &request_config)
       handling_errors do
         url = BASE_URI + resource_uri
+        headers = (@default_headers || {}).merge(headers || {})
         log_request(method, url, body) if @debug_mode
-        Response.new(connection(&request_config).public_send(method, url, body))
+        result = Response.new(connection(&request_config).public_send(method, url, body, headers))
+        log_asana_change_headers(headers, result.headers) if @log_asana_change_warnings
+        result
       end
     end
 
@@ -151,5 +170,73 @@ module Asana
                          url,
                          body.inspect)
     end
+
+    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
+      end
+
+      if change_header_key != nil
+        accounted_for_flags = Array.new
+
+        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
+          end
+        end
+
+        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
+          end
+        end
+      end
+    end
   end
 end
+
+

data/lib/asana/http_client/response.rb

@@ -11,6 +11,9 @@ module Asana
       # Public:
       # Returns the [Hash] representing the parsed JSON body.
       attr_reader :body
+      # Public:
+      # Returns the [Hash] of attribute headers.
+      attr_reader :headers
 
       # Public: Wraps a Faraday response.
       #
@@ -19,6 +22,7 @@ module Asana
         @faraday_env = faraday_response.env
         @status      = faraday_env.status
         @body        = faraday_env.body
+        @headers     = faraday_response.headers
       end
 
       # Public:

data/lib/asana/resource_includes/attachment_uploading.rb

@@ -20,7 +20,7 @@ module Asana
           raise ArgumentError, "file #{filename} doesn't exist"
         end
         upload = Faraday::UploadIO.new(path, mime)
-        response = client.post("/#{self.class.plural_name}/#{id}/attachments",
+        response = client.post("/#{self.class.plural_name}/#{gid}/attachments",
                                body: data,
                                upload: upload,
                                options: options)

data/lib/asana/resource_includes/event_subscription.rb

@@ -7,7 +7,7 @@ module Asana
     module EventSubscription
       # Public: Returns an infinite collection of events on the resource.
       def events(wait: 1, options: {})
-        Events.new(resource: id, client: client, wait: wait, options: options)
+        Events.new(resource: gid, client: client, wait: wait, options: options)
       end
     end
   end

data/lib/asana/resource_includes/resource.rb

@@ -25,7 +25,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, id)
+        self.class.find_by_id(client, gid)
       end
 
       # Internal: Proxies method calls to the data, wrapping it accordingly and

data/lib/asana/resources/attachment.rb

@@ -11,6 +11,10 @@ module Asana
 
       attr_reader :id
 
+      attr_reader :gid
+
+      attr_reader :resource_type
+
       attr_reader :created_at
 
       attr_reader :download_url
@@ -31,7 +35,7 @@ module Asana
 
         # Returns the full record for a single attachment.
         #
-        # id - [Id] Globally unique identifier for the attachment.
+        # id - [Gid] Globally unique identifier for the attachment.
         #
         # options - [Hash] the request I/O options.
         def find_by_id(client, id, options: {})
@@ -41,7 +45,7 @@ module Asana
 
         # Returns the compact records for all attachments on the task.
         #
-        # task - [Id] Globally unique identifier for the task.
+        # task - [Gid] Globally unique identifier for the task.
         #
         # per_page - [Integer] the number of records to fetch per page.
         # options - [Hash] the request I/O options.

data/lib/asana/resources/custom_field_settings.rb

@@ -3,20 +3,27 @@
 
 module Asana
   module Resources
-    # Custom fields are attached to a particular project with the Custom
-    # Field Settings resource. This resource both represents the many-to-many join
-    # of the Custom Field and Project as well as stores information that is relevant to that
-    # particular pairing; for instance, the `is_important` property determines
-    # some possible application-specific handling of that custom field (see below)
+    # Custom fields are applied to a particular project or portfolio with the
+    # Custom Field Settings resource. This resource both represents the
+    # many-to-many join of the Custom Field and Project or Portfolio as well as
+    # stores information that is relevant to that particular pairing; for instance,
+    # the `is_important` property determines some possible application-specific
+    # handling of that custom field and parent.
     class CustomFieldSetting < Resource
 
 
       attr_reader :id
 
+      attr_reader :gid
+
+      attr_reader :resource_type
+
       attr_reader :created_at
 
       attr_reader :is_important
 
+      attr_reader :parent
+
       attr_reader :project
 
       attr_reader :custom_field
@@ -27,15 +34,25 @@ module Asana
           'custom_field_settings'
         end
 
-        # Returns a list of all of the custom fields settings on a project, in compact form. Note that, as in all queries to collections which return compact representation, `opt_fields` and `opt_expand` can be used to include more data than is returned in the compact representation. See the getting started guide on [input/output options](/developers/documentation/getting-started/input-output-options) for more information.
+        # Returns a list of all of the custom fields settings on a project.
         #
-        # project - [Id] The ID of the project for which to list custom field settings
+        # project - [Gid] The ID of the project for which to list custom field settings
         # per_page - [Integer] the number of records to fetch per page.
         # options - [Hash] the request I/O options.
         def find_by_project(client, project: required("project"), per_page: 20, options: {})
           params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
           Collection.new(parse(client.get("/projects/#{project}/custom_field_settings", params: params, options: options)), type: Resource, client: client)
         end
+
+        # Returns a list of all of the custom fields settings on a portfolio.
+        #
+        # portfolio - [Gid] The ID of the portfolio for which to list custom field settings
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_portfolio(client, portfolio: required("portfolio"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/portfolios/#{portfolio}/custom_field_settings", params: params, options: options)), type: Resource, client: client)
+        end
       end
 
     end

data/lib/asana/resources/custom_fields.rb

@@ -8,11 +8,22 @@ module Asana
     # Fields](/developers/documentation/getting-started/custom-fields) developer
     # documentation for more information about how custom fields relate to various
     # resources in Asana.
+    #
+    # Users in Asana can [lock custom
+    # fields](/guide/help/premium/custom-fields#gl-lock-fields), which will make
+    # them read-only when accessed by other users. Attempting to edit a locked
+    # custom field will return HTTP error code `403 Forbidden`.
     class CustomField < Resource
 
 
       attr_reader :id
 
+      attr_reader :gid
+
+      attr_reader :resource_type
+
+      attr_reader :resource_subtype
+
       attr_reader :name
 
       attr_reader :description
@@ -35,22 +46,23 @@ module Asana
         #
         # Returns the full record of the newly created custom field.
         #
-        # workspace - [Id] The workspace to create a custom field in.
-        # type - [String] The type of the custom field.
+        # workspace - [Gid] The workspace to create a custom field in.
+        # resource_subtype - [String] The type of the custom field. Must be one of the given values.
+        # type - [String] **Deprecated: New integrations should prefer the `resource_subtype` parameter.**
         # name - [String] The name of the custom field.
         # description - [String] The description of the custom field.
         # precision - [Integer] The number of decimal places for the numerical values. Required if the custom field is of type 'number'.
         # enum_options - [String] The discrete values the custom field can assume. Required if the custom field is of type 'enum'.
         # options - [Hash] the request I/O options.
         # data - [Hash] the attributes to post.
-        def create(client, workspace: required("workspace"), type: required("type"), name: required("name"), description: nil, precision: nil, enum_options: nil, options: {}, **data)
-          with_params = data.merge(workspace: workspace, type: type, name: name, description: description, precision: precision, enum_options: enum_options).reject { |_,v| v.nil? || Array(v).empty? }
+        def create(client, workspace: required("workspace"), resource_subtype: nil, type: nil, name: required("name"), description: nil, precision: nil, enum_options: nil, options: {}, **data)
+          with_params = data.merge(workspace: workspace, resource_subtype: resource_subtype || type, name: name, description: description, precision: precision, enum_options: enum_options).reject { |_,v| v.nil? || Array(v).empty? }
           Resource.new(parse(client.post("/custom_fields", body: with_params, options: options)).first, client: client)
         end
 
         # Returns the complete definition of a custom field's metadata.
         #
-        # id - [Id] Globally unique identifier for the custom field.
+        # id - [Gid] Globally unique identifier for the custom field.
         #
         # options - [Hash] the request I/O options.
         def find_by_id(client, id, options: {})
@@ -60,7 +72,7 @@ module Asana
 
         # Returns a list of the compact representation of all of the custom fields in a workspace.
         #
-        # workspace - [Id] The workspace or organization to find custom field definitions in.
+        # workspace - [Gid] The workspace or organization to find custom field definitions in.
         # per_page - [Integer] the number of records to fetch per page.
         # options - [Hash] the request I/O options.
         def find_by_workspace(client, workspace: required("workspace"), per_page: 20, options: {})
@@ -70,68 +82,78 @@ module Asana
 
         # Creates an enum option and adds it to this custom field's list of enum options. A custom field can have at most 50 enum options (including disabled options). By default new enum options are inserted at the end of a custom field's list.
         #
+        # Locked custom fields can only have enum options added by the user who locked the field.
+        #
         # Returns the full record of the newly created enum option.
         #
-        # custom_field - [Id] Globally unique identifier for the custom field.
+        # custom_field - [Gid] Globally unique identifier for the custom field.
         #
         # name - [String] The name of the enum option.
         # color - [String] The color of the enum option. Defaults to 'none'.
-        # insert_before - [Id] An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
-        # insert_after - [Id] An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
+        # insert_before - [Gid] An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
+        # insert_after - [Gid] An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
         # options - [Hash] the request I/O options.
         # data - [Hash] the attributes to post.
-        def add_enum_option(client, custom_field: required("custom_field"), name: required("name"), color: nil, insert_before: nil, insert_after: nil, options: {}, **data)
+        def create_enum_option(client, custom_field: required("custom_field"), name: required("name"), color: nil, insert_before: nil, insert_after: nil, options: {}, **data)
           with_params = data.merge(name: name, color: color, insert_before: insert_before, insert_after: insert_after).reject { |_,v| v.nil? || Array(v).empty? }
           Resource.new(parse(client.post("/custom_fields/#{custom_field}/enum_options", body: with_params, options: options)).first, client: client)
         end
+        alias_method :add_enum_option, :create_enum_option
 
         # Moves a particular enum option to be either before or after another specified enum option in the custom field.
         #
-        # custom_field - [Id] Globally unique identifier for the custom field.
+        # Locked custom fields can only be reordered by the user who locked the field.
+        #
+        # custom_field - [Gid] Globally unique identifier for the custom field.
         #
-        # enum_option - [Id] The ID of the enum option to relocate.
+        # enum_option - [Gid] The ID of the enum option to relocate.
         # name - [String] The name of the enum option.
         # color - [String] The color of the enum option. Defaults to 'none'.
-        # before_enum_option - [Id] An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
-        # after_enum_option - [Id] An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
+        # before_enum_option - [Gid] An existing enum option within this custom field before which the new enum option should be inserted. Cannot be provided together with after_enum_option.
+        # after_enum_option - [Gid] An existing enum option within this custom field after which the new enum option should be inserted. Cannot be provided together with before_enum_option.
         # options - [Hash] the request I/O options.
         # data - [Hash] the attributes to post.
-        def reorder_enum_option(client, custom_field: required("custom_field"), enum_option: required("enum_option"), name: required("name"), color: nil, before_enum_option: nil, after_enum_option: nil, options: {}, **data)
+        def insert_enum_option(client, custom_field: required("custom_field"), enum_option: required("enum_option"), name: required("name"), color: nil, before_enum_option: nil, after_enum_option: nil, options: {}, **data)
           with_params = data.merge(enum_option: enum_option, name: name, color: color, before_enum_option: before_enum_option, after_enum_option: after_enum_option).reject { |_,v| v.nil? || Array(v).empty? }
           Resource.new(parse(client.post("/custom_fields/#{custom_field}/enum_options/insert", body: with_params, options: options)).first, client: client)
         end
+        alias_method :reorder_enum_option, :insert_enum_option
       end
 
       # A specific, existing custom field can be updated by making a PUT request on the URL for that custom field. Only the fields provided in the `data` block will be updated; any unspecified fields will remain unchanged
       #
       # When using this method, it is best to specify only those fields you wish to change, or else you may overwrite changes made by another user since you last retrieved the custom field.
       #
-      # A custom field's `type` cannot be updated.
-      #
       # An enum custom field's `enum_options` cannot be updated with this endpoint. Instead see "Work With Enum Options" for information on how to update `enum_options`.
       #
+      # Locked custom fields can only be updated by the user who locked the field.
+      #
       # Returns the complete updated custom field record.
       #
       # options - [Hash] the request I/O options.
       # data - [Hash] the attributes to post.
       def update(options: {}, **data)
 
-        refresh_with(parse(client.put("/custom_fields/#{id}", body: data, options: options)).first)
+        refresh_with(parse(client.put("/custom_fields/#{gid}", body: data, options: options)).first)
       end
 
       # A specific, existing custom field can be deleted by making a DELETE request on the URL for that custom field.
       #
+      # Locked custom fields can only be deleted by the user who locked the field.
+      #
       # Returns an empty data record.
       def delete()
 
-        client.delete("/custom_fields/#{id}") && true
+        client.delete("/custom_fields/#{gid}") && true
       end
 
       # Updates an existing enum option. Enum custom fields require at least one enabled enum option.
       #
+      # Locked custom fields can only be updated by the user who locked the field.
+      #
       # Returns the full record of the updated enum option.
       #
-      # enum_option - [Id] Globally unique identifier for the enum option.
+      # enum_option - [Gid] Globally unique identifier for the enum option.
       #
       # name - [String] The name of the enum option.
       # color - [String] The color of the enum option. Defaults to 'none'.