camper 0.0.5 → 0.0.10

data/lib/camper/authorization.rb

@@ -38,7 +38,7 @@ module Camper
 
     def update_access_token!
       logger.debug "Update access token using refresh token"
-      
+
       client = authz_client
       client.refresh_token = @config.refresh_token
 

data/lib/camper/client.rb

@@ -6,20 +6,22 @@ module Camper
     Dir[File.expand_path('api/*.rb', __dir__)].each { |f| require f }
 
     extend Forwardable
-    
+
     def_delegators :@config, *(Configuration::VALID_OPTIONS_KEYS)
     def_delegators :@config, :authz_endpoint, :token_endpoint, :api_endpoint, :base_api_endpoint
 
     # Keep in alphabetical order
     include Authorization
-    include CommentAPI
+    include CommentsAPI
     include Logging
-    include MessageAPI
-    include ProjectAPI
+    include MessagesAPI
+    include PeopleAPI
+    include ProjectsAPI
     include ResourceAPI
-    include TodoAPI
+    include TodolistsAPI
+    include TodosAPI
 
-    # Creates a new API.
+    # Creates a new Client instance.
     # @raise [Error:MissingCredentials]
     def initialize(options = {})
       @config = Configuration.new(options)
@@ -27,18 +29,19 @@ module Camper
 
     %w[get post put delete].each do |method|
       define_method method do |path, options = {}|
-        response, result = new_request.send(method, path, options)
-        return response unless result == Request::Result::AccessTokenExpired
-
-        update_access_token!
+        request = new_request(method, path, options)
 
-        response, = new_request.send(method, path, options)
-        response
+        loop do
+          response, result = request.execute
+          logger.debug("Request result: #{result}; Attempt: #{request.attempts}")
+          return response unless retry_request?(response, result)
+        end
       end
     end
 
     # Allows setting configuration values for this client
-    # returns the client instance being configured
+    # by yielding the config object to the block
+    # @return [Camper::Client] the client instance being configured
     def configure
       yield @config
 
@@ -54,33 +57,34 @@ module Camper
       inspected
     end
 
-    # Utility method for URL encoding of a string.
-    # Copied from https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB/Util.html
-    #
-    # @return [String]
-    def url_encode(url)
-      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString, Style/FormatStringToken
+    private
+
+    def new_request(method, path, options)
+      Request.new(self, method, path, options)
     end
 
-    private
+    def retry_request?(response, result)
+      case result
+      when Request::Result::ACCESS_TOKEN_EXPIRED
+        update_access_token!
+        true
+      when Request::Result::TOO_MANY_REQUESTS
+        sleep_before_retrying(response)
+        true
+      else
+        false
+      end
+    end
+
+    def sleep_before_retrying(response)
+      time = response.headers['Retry-After'].to_i
+      logger.debug("Sleeping for #{time} seconds before retrying request")
 
-    def new_request
-      Request.new(@config.access_token, @config.user_agent, self)
+      sleep(time)
     end
 
     def only_show_last_four_chars(token)
       "#{'*' * (token.size - 4)}#{token[-4..-1]}"
     end
-
-    # Utility method for transforming Basecamp Web URLs into API URIs
-    # e.g 'https://3.basecamp.com/1/buckets/2/todos/3' will be 
-    # converted into 'https://3.basecampapi.com/1/buckets/2/todos/3.json'
-    #
-    # @return [String]
-    def url_transform(url)
-      api_uri = url.gsub('3.basecamp.com', '3.basecampapi.com')
-      api_uri += '.json' unless url.end_with? '.json'
-      api_uri
-    end
   end
 end

data/lib/camper/configuration.rb

@@ -23,7 +23,7 @@ module Camper
     attr_accessor(*VALID_OPTIONS_KEYS)
 
     def initialize(options = {})
-      options[:user_agent] ||= DEFAULT_USER_AGENT
+      default_from_environment
       VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key]) if options[key]
       end
@@ -36,10 +36,9 @@ module Camper
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
     # Resets all configuration options to the defaults.
-    def reset
-      logger.debug 'Resetting attributes to default environment values'
+    def default_from_environment
+      logger.debug 'Setting attributes to default environment values'
       self.client_id      = ENV['BASECAMP3_CLIENT_ID']
       self.client_secret  = ENV['BASECAMP3_CLIENT_SECRET']
       self.redirect_uri   = ENV['BASECAMP3_REDIRECT_URI']
@@ -48,7 +47,6 @@ module Camper
       self.access_token   = ENV['BASECAMP3_ACCESS_TOKEN']
       self.user_agent     = ENV['BASECAMP3_USER_AGENT'] || DEFAULT_USER_AGENT
     end
-    # rubocop:enable Metrics/AbcSize
 
     def authz_endpoint
       'https://launchpad.37signals.com/authorization/new'
@@ -60,7 +58,7 @@ module Camper
 
     def api_endpoint
       raise Camper::Error::InvalidConfiguration, "missing basecamp account" unless self.account_number
-      
+
       "#{self.base_api_endpoint}/#{self.account_number}"
     end
 

data/lib/camper/core_extensions/object.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+# Copied from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/blank.rb
+
+require 'concurrent/map'
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+  ENCODED_BLANKS = Concurrent::Map.new do |h, enc|
+    h[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
+  end
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? ||
+      begin
+        BLANK_RE.match?(self)
+      rescue Encoding::CompatibilityError
+        ENCODED_BLANKS[self.encoding].match?(self)
+      end
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time #:nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/camper/error.rb

@@ -11,9 +11,20 @@ module Camper
     # Raised when API endpoint credentials not configured.
     class MissingCredentials < Error; end
 
+    class MissingBody < Error; end
+
+    class ResourceCannotBeCommented < Error; end
+
+    class RequestIsMissingParameters < Error; end
+
+    class InvalidParameter < Error; end
+
     # Raised when impossible to parse response body.
     class Parsing < Error; end
 
+    # Raised when too many attempts for the same request
+    class TooManyRetries < Error; end
+
     # Custom error class for rescuing from HTTP response errors.
     class ResponseError < Error
       POSSIBLE_MESSAGE_KEYS = %i[message error_description error].freeze
@@ -70,9 +81,6 @@ module Camper
         # Return stringified response when receiving a
         # parsing error to avoid obfuscation of the
         # api error.
-        #
-        # note: The Camper API does not always return valid
-        # JSON when there are errors.
         @response.to_s
       end
 
@@ -127,6 +135,8 @@ module Camper
     # Raised when API endpoint returns the HTTP status code 503.
     class ServiceUnavailable < ResponseError; end
 
+    class GatewayTimeout < ResponseError; end
+
     # HTTP status codes mapped to error classes.
     STATUS_MAPPINGS = {
       400 => BadRequest,
@@ -140,7 +150,8 @@ module Camper
       429 => TooManyRequests,
       500 => InternalServerError,
       502 => BadGateway,
-      503 => ServiceUnavailable
+      503 => ServiceUnavailable,
+      504 => GatewayTimeout
     }.freeze
   end
 end

data/lib/camper/pagination_data.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 module Camper
-  # Parses link header.
-  #
-  # @private
   class PaginationData
     include Logging
 

data/lib/camper/request.rb

@@ -11,17 +11,26 @@ module Camper
     headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
     parser(proc { |body, _| parse(body) })
 
+    attr_reader :attempts
+
+    MAX_RETRY_ATTEMPTS = 5
+
     module Result
       ACCESS_TOKEN_EXPIRED = 'AccessTokenExpired'
 
+      TOO_MANY_REQUESTS = 'TooManyRequests'
+
       VALID = 'Valid'
     end
 
-    def initialize(access_token, user_agent, client)
-      @access_token = access_token
+    def initialize(client, method, path, options = {})
       @client = client
+      @path = path
+      @options = options
+      @attempts = 0
+      @method = method
 
-      self.class.headers 'User-Agent' => user_agent
+      self.class.headers 'User-Agent' => @client.user_agent
     end
 
     # Converts the response body to a Resource.
@@ -50,32 +59,43 @@ module Camper
       raise Error::Parsing, 'The response is not a valid JSON'
     end
 
-    %w[get post put delete].each do |method|
-      define_method method do |path, options = {}|
-        params = options.dup
-        override_path = params.delete(:override_path)
+    # Executes the request
+    def execute
+      endpoint, params = prepare_request_data
 
-        params[:headers] ||= {}
+      raise Error::TooManyRetries, endpoint if maxed_attempts?
 
-        full_endpoint = override_path ? path : @client.api_endpoint + path
+      @attempts += 1
 
-        execute_request(method, full_endpoint, params)
-      end
+      logger.debug("Method: #{@method}; URL: #{endpoint}")
+
+      response, result = validate self.class.send(@method, endpoint, params)
+      response = extract_parsed(response) if result == Result::VALID
+
+      return response, result
+    end
+
+    def maxed_attempts?
+      @attempts >= MAX_RETRY_ATTEMPTS
     end
 
     private
 
-    # Executes the request
-    def execute_request(method, endpoint, params)
+    def prepare_request_data
+      params = @options.dup
+      override_path = params.delete(:override_path)
+
+      params[:body] = params[:body].to_json if body_to_json?(params)
+
+      params[:headers] ||= {}
       params[:headers].merge!(self.class.headers)
       params[:headers].merge!(authorization_header)
 
-      logger.debug("Method: #{method}; URL: #{endpoint}")
-      response, result = validate self.class.send(method, endpoint, params)
+      full_endpoint = override_path ? @path : @client.api_endpoint + @path
 
-      response = extract_parsed(response) if result == Result::VALID
+      full_endpoint = UrlUtils.transform(full_endpoint)
 
-      return response, result
+      return full_endpoint, params
     end
 
     # Checks the response code for common errors.
@@ -90,9 +110,14 @@ module Camper
         return response, Result::ACCESS_TOKEN_EXPIRED
       end
 
+      if error_klass == Error::TooManyRequests
+        logger.debug('Too many request. Please check the Retry-After header for subsequent requests')
+        return response, Result::TOO_MANY_REQUESTS
+      end
+
       raise error_klass, response if error_klass
 
-      return response, Result::Valid
+      return response, Result::VALID
     end
 
     def extract_parsed(response)
@@ -108,9 +133,13 @@ module Camper
     #
     # @raise [Error::MissingCredentials] if access_token and auth_token are not set.
     def authorization_header
-      raise Error::MissingCredentials, 'Please provide a access_token' if @access_token.to_s.empty?
+      raise Error::MissingCredentials, 'Please provide a access_token' if @client.access_token.to_s.empty?
+
+      { 'Authorization' => "Bearer #{@client.access_token}" }
+    end
 
-      { 'Authorization' => "Bearer #{@access_token}" }
+    def body_to_json?(params)
+      %w[post put].include?(@method) && params.key?(:body)
     end
   end
 end