asana 0.10.3 → 2.0.3

data/asana.gemspec

@@ -1,32 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'asana/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "asana"
+  spec.name          = 'asana'
   spec.version       = Asana::VERSION
-  spec.authors       = ["Txus"]
-  spec.email         = ["me@txus.io"]
+  spec.authors       = ['Txus']
+  spec.email         = ['me@txus.io']
 
-  spec.summary       = %q{Official Ruby client for the Asana API}
-  spec.description   = %q{Official Ruby client for the Asana API}
-  spec.homepage      = "https://github.com/asana/ruby-asana"
-  spec.license       = "MIT"
+  spec.summary       = 'Official Ruby client for the Asana API'
+  spec.description   = 'Official Ruby client for the Asana API'
+  spec.homepage      = 'https://github.com/asana/ruby-asana'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '> 2.0'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_dependency "oauth2", "~> 1.4"
-  spec.add_dependency "faraday", "~> 1.0"
-  spec.add_dependency "faraday_middleware", "~> 1.0"
-  spec.add_dependency "faraday_middleware-multi_json", "~> 0.0"
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_dependency 'faraday-follow_redirects'
+  spec.add_dependency 'faraday-multipart'
+  spec.add_dependency 'oauth2', '>= 1.4', '< 3'
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency 'appraisal', '~> 2.1', '>= 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/examples/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    asana (0.10.3)
+    asana (0.10.5)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
       faraday_middleware-multi_json (~> 0.0)
@@ -27,7 +27,7 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    rack (2.2.3)
+    rack (2.2.3.1)
 
 PLATFORMS
   ruby

data/examples/cli_app.rb

@@ -17,9 +17,9 @@ client = Asana::Client.new do |c|
 end
 
 puts "My Workspaces:"
-client.workspaces.find_all.each do |workspace|
+client.workspaces.get_workspaces.each do |workspace|
   puts "\t* #{workspace.name} - tags:"
-  client.tags.find_by_workspace(workspace: workspace.id).each do |tag|
+  client.tags.get_tags_for_workspace(workspace: workspace.id).each do |tag|
     puts "\t\t- #{tag.name}"
   end
 end

data/examples/events.rb

@@ -13,10 +13,10 @@ client = Asana::Client.new do |c|
   c.authentication :access_token, access_token
 end
 
-workspace = client.workspaces.find_all.first
-task = client.tasks.find_all(assignee: "me", workspace: workspace.id).first
+workspace = client.workspaces.get_workspaces.first
+task = client.tasks.get_tasks(assignee: "me", workspace: workspace.id).first
 unless task
-  task = client.tasks.create(workspace: workspace.id, name: "Hello world!", assignee: "me")
+  task = client.tasks.create_task(workspace: workspace.id, name: "Hello world!", assignee: "me")
 end
 
 Thread.abort_on_exception = true

data/examples/personal_access_token.rb

@@ -13,9 +13,9 @@ client = Asana::Client.new do |c|
 end
 
 puts "My Workspaces:"
-client.workspaces.find_all.each do |workspace|
+client.workspaces.get_workspaces.each do |workspace|
   puts "\t* #{workspace.name} - tags:"
-  client.tags.find_by_workspace(workspace: workspace.id).each do |tag|
+  client.tags.get_tags_for_workspace(workspace: workspace.id).each do |tag|
     puts "\t\t- #{tag.name}"
   end
 end

data/lib/asana/authentication/oauth2/access_token_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   module Authentication
     module OAuth2
@@ -43,7 +45,8 @@ module Asana
         # Returns nothing.
         def configure(connection)
           @token = @token.refresh! if @token.expired?
-          connection.request :oauth2, @token.token
+
+          connection.request :authorization, 'Bearer', @token.token
         end
       end
     end

data/lib/asana/authentication/oauth2/bearer_token_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   module Authentication
     module OAuth2
@@ -24,8 +26,7 @@ module Asana
         #
         # Returns nothing.
         def configure(connection)
-          connection.authorization :Bearer, @token
-          connection.request :oauth2, token_type: 'bearer'
+          connection.request :authorization, 'Bearer', @token
         end
       end
     end

data/lib/asana/authentication/oauth2/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'oauth2'
 
 module Asana

data/lib/asana/authentication/oauth2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'oauth2/bearer_token_authentication'
 require_relative 'oauth2/access_token_authentication'
 require_relative 'oauth2/client'
@@ -31,10 +33,10 @@ module Asana
         client = Client.new(client_id: client_id,
                             client_secret: client_secret,
                             redirect_uri: 'urn:ietf:wg:oauth:2.0:oob')
-        STDOUT.puts '1. Go to the following URL to authorize the ' \
-          " application: #{client.authorize_url}"
-        STDOUT.puts '2. Paste the authorization code here: '
-        auth_code = STDIN.gets.chomp
+        $stdout.puts '1. Go to the following URL to authorize the  ' \
+                     "application: #{client.authorize_url}"
+        $stdout.puts '2. Paste the authorization code here: '
+        auth_code = $stdin.gets.chomp
         client.token_from_auth_code(auth_code)
       end
     end

data/lib/asana/authentication/token_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   module Authentication
     # Public: Represents an API token authentication mechanism.
@@ -13,7 +15,7 @@ module Asana
       #
       # Returns nothing.
       def configure(connection)
-        connection.basic_auth(@token, '')
+        connection.request :authorization, :basic, @token, ''
       end
     end
   end

data/lib/asana/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'authentication/oauth2'
 require_relative 'authentication/token_authentication'
 

data/lib/asana/client/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   class Client
     # Internal: Represents a configuration DSL for an Asana::Client.
@@ -17,7 +19,7 @@ module Asana
       # Public: Initializes an empty configuration object.
       def initialize
         @configuration = {
-            :log_asana_change_warnings => true
+          log_asana_change_warnings: true
         }
       end
 
@@ -100,7 +102,6 @@ module Asana
       #
       # Raises ArgumentError if the OAuth2 configuration arguments are invalid.
       #
-      # rubocop:disable Metrics/MethodLength
       def oauth2(value)
         case value
         when ::OAuth2::AccessToken
@@ -111,8 +112,8 @@ module Asana
           from_bearer_token(value[:bearer_token])
         else
           error 'Invalid OAuth2 configuration: pass in either an ' \
-            '::OAuth2::AccessToken object of your own or a hash ' \
-            'containing :refresh_token or :bearer_token.'
+                '::OAuth2::AccessToken object of your own or a hash ' \
+                'containing :refresh_token or :bearer_token.'
         end
       end
 
@@ -158,7 +159,7 @@ module Asana
       end
 
       def requiring(hash, *keys)
-        missing_keys = keys.select { |k| !hash.key?(k) }
+        missing_keys = keys.reject { |k| hash.key?(k) }
         missing_keys.any? && error("Missing keys: #{missing_keys.join(', ')}")
         keys.map { |k| hash[k] }
       end

data/lib/asana/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'authentication'
 require_relative 'client/configuration'
 require_relative 'resources'
@@ -59,12 +61,12 @@ module Asana
         @resource = resource
       end
 
-      def method_missing(m, *args, **kwargs, &block)
-        @resource.public_send(m, *([@client] + args), **kwargs, &block)
+      def method_missing(method_name, *args, **kwargs, &block)
+        @resource.public_send(method_name, *([@client] + args), **kwargs, &block)
       end
 
-      def respond_to_missing?(m, *)
-        @resource.respond_to?(m)
+      def respond_to_missing?(method_name, *)
+        @resource.respond_to?(method_name)
       end
     end
 
@@ -72,15 +74,15 @@ module Asana
     #
     # Yields a {Asana::Client::Configuration} object as a configuration
     # DSL. See {Asana::Client} for usage examples.
-    def initialize
-      config = Configuration.new.tap { |c| yield c }.to_h
+    def initialize(&block)
+      config = Configuration.new.tap(&block).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],
+                       default_headers: config[:default_headers],
                        &config[:faraday_configuration])
     end
 

data/lib/asana/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Asana
   # Public: Defines the different errors that the Asana API may throw, which the
   # client code may want to catch.
@@ -19,8 +21,8 @@ module Asana
     # user could not be authenticated.
     NotAuthorized = Class.new(APIError) do
       def to_s
-        'Valid credentials were not provided with the request, so the API could '\
-        'not associate a user with the request.'
+        'Valid credentials were not provided with the request, so the API could ' \
+          'not associate a user with the request.'
       end
     end
 
@@ -28,8 +30,8 @@ module Asana
     # that requires a premium account (Payment Required).
     PremiumOnly = Class.new(APIError) do
       def to_s
-        'The endpoint that is being requested is only available to premium '\
-        'users.'
+        'The endpoint that is being requested is only available to premium ' \
+          'users.'
       end
     end
 
@@ -37,18 +39,18 @@ module Asana
     # access the requested resource or to perform the requested action on it.
     Forbidden = Class.new(APIError) do
       def to_s
-        'The authorization and request syntax was valid but the server is refusing '\
-        'to complete the request. This can happen if you try to read or write '\
-        'to objects or properties that the user does not have access to.'
+        'The authorization and request syntax was valid but the server is refusing ' \
+          'to complete the request. This can happen if you try to read or write ' \
+          'to objects or properties that the user does not have access to.'
       end
     end
 
     # Public: A 404 error. Raised when the requested resource doesn't exist.
     NotFound = Class.new(APIError) do
       def to_s
-        'Either the request method and path supplied do not specify a known '\
-        'action in the API, or the object specified by the request does not '\
-        'exist.'
+        'Either the request method and path supplied do not specify a known ' \
+          'action in the API, or the object specified by the request does not ' \
+          'exist.'
       end
     end
 
@@ -59,11 +61,12 @@ module Asana
       attr_accessor :phrase
 
       def initialize(phrase)
+        super()
         @phrase = phrase
       end
 
       def to_s
-        "There has been an error on Asana's end. Use this unique phrase to "\
+        "There has been an error on Asana's end. Use this unique phrase to " \
         'identify the problem when contacting support: ' + %("#{@phrase}")
       end
     end
@@ -74,6 +77,7 @@ module Asana
       attr_accessor :errors
 
       def initialize(errors)
+        super()
         @errors = errors
       end
 
@@ -89,6 +93,7 @@ module Asana
       attr_accessor :retry_after_seconds
 
       def initialize(retry_after_seconds)
+        super()
         @retry_after_seconds = retry_after_seconds
       end
 

data/lib/asana/http_client/environment_info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../version'
 require 'openssl'
 
@@ -6,7 +8,7 @@ module Asana
     # Internal: Adds environment information to a Faraday request.
     class EnvironmentInfo
       # Internal: The default user agent to use in all requests to the API.
-      USER_AGENT = "ruby-asana v#{Asana::VERSION}".freeze
+      USER_AGENT = "ruby-asana v#{Asana::VERSION}"
 
       def initialize(user_agent = nil)
         @user_agent = user_agent || USER_AGENT
@@ -19,7 +21,7 @@ module Asana
       # environment.
       def configure(builder)
         builder.headers[:user_agent] = @user_agent
-        builder.headers[:"X-Asana-Client-Lib"] = header
+        builder.headers[:'X-Asana-Client-Lib'] = header
       end
 
       private
@@ -33,21 +35,20 @@ module Asana
           .map { |k, v| "#{k}=#{v}" }.join('&')
       end
 
-      # rubocop:disable Metrics/MethodLength
       def os
-        if RUBY_PLATFORM =~ /win32/ || RUBY_PLATFORM =~ /mingw/
+        case RUBY_PLATFORM
+        when /win32/, /mingw/
           'windows'
-        elsif RUBY_PLATFORM =~ /linux/
+        when /linux/
           'linux'
-        elsif RUBY_PLATFORM =~ /darwin/
+        when /darwin/
           'darwin'
-        elsif RUBY_PLATFORM =~ /freebsd/
+        when /freebsd/
           'freebsd'
         else
           'unknown'
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/asana/http_client/error_handling.rb

@@ -1,4 +1,4 @@
-require 'multi_json'
+# frozen_string_literal: true
 
 require_relative '../errors'
 
@@ -11,7 +11,7 @@ module Asana
 
       module_function
 
-      MAX_TIMEOUTS = 5
+      MAX_RETRIES = 5
 
       # Public: Perform a request handling any API errors correspondingly.
       #
@@ -27,30 +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_timeouts=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
+        raise server_error(e.response) unless num_retries < MAX_RETRIES
+
+        handle(num_retries + 1, &request)
       rescue Net::ReadTimeout => e
-        if num_timeouts < MAX_TIMEOUTS
-          handle(num_timeouts + 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.
@@ -105,13 +109,15 @@ module Asana
 
       # Internal: Parser a response body from JSON.
       def body(response)
-        MultiJson.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.