camper 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984eef67b2149dac0f1735f6dcda5012b140dd4d3404b8523e23b21096d510de
-  data.tar.gz: 90b228ed0f5388a6866346c46b98a608d44a8753bec6a7eef844cd85583afd34
+  metadata.gz: b7d0cdad6f722b4f3c02ba3da38147000e371f57860ce203fb1c64eb007797de
+  data.tar.gz: db77821cf2cb77070b049dce6cbf4bc62430c4948101aadf7d2c87b4e67eaa42
 SHA512:
-  metadata.gz: 6bac9cf265b6ec6ddcdaa38fb6290e9c35b16c8a4dc1c64446589eea095dd2a4dcda4a491b0e46c20c9aad45e6af4d8168b693dcfc556d125b78fc8de35caf7a
-  data.tar.gz: c605925535d3052d2844d2fe7ac0ee2b420f2891c78e1e14422bb3e8cf9464399eb741dbdde2fd7611f49743de2097f8a62f06e98e0419d2dc4298551328b604
+  metadata.gz: '027558808a97c4ef3c04c6ec895c86a8975e32f7a03397e882513db25f0cfb29978135c23a77a87081cfa845834c31419e7813c24a3bf43aeaf030b777e31c28'
+  data.tar.gz: 7aa221c2f13009488cc57d46fc86e1daeb21e2051b70e33dc6780032b8091bfdcb9f9efd54286b774b2f9406bd78c889add255e47ef674870aae07887c190ac5

data/.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
     - 'camper.gemspec'
 
 Layout/LineLength:
-  Max: 123
+  Max: 120
   Exclude:
     - 'lib/camper/client/*'
     - 'spec/**/*'
@@ -18,6 +18,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
+Metrics/AbcSize:
+  Max: 20
+
 Style/Documentation:
   Enabled: false
 

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+lib/**/*.rb
+examples/*.rb - 
+README.md CONTRIBUTING.md CHANGELOG.md

data/CHANGELOG.md

@@ -1,16 +1,36 @@
 # Changelog
 
-## [Unreleased](https://github.com/renehernandez/camper/tree/HEAD)
+## [v0.0.6](https://github.com/renehernandez/camper/tree/v0.0.6) (2020-10-01)
+
+**Implemented enhancements:**
+
+- Implement handling error according to Basecamp 3 API specifications [\#21](https://github.com/renehernandez/camper/issues/21)
+- Add ability to complete a Todo [\#12](https://github.com/renehernandez/camper/issues/12)
+- Multiple improvements [\#38](https://github.com/renehernandez/camper/pull/38)
+- Error handling improvements [\#37](https://github.com/renehernandez/camper/pull/37)
+
+**Documentation:**
+
+- Enable documentation in RubyDoc [\#6](https://github.com/renehernandez/camper/issues/6)
+- Add yard documentation [\#41](https://github.com/renehernandez/camper/pull/41)
+- Fix gem badge [\#39](https://github.com/renehernandez/camper/pull/39)
+
+**Merged pull requests:**
+
+- Rename add\_comment to create\_comment [\#40](https://github.com/renehernandez/camper/pull/40)
+- Bump rubocop from 0.91.0 to 0.92.0 [\#36](https://github.com/renehernandez/camper/pull/36)
+
+## [v0.0.5](https://github.com/renehernandez/camper/tree/v0.0.5) (2020-09-22)
 
 **Implemented enhancements:**
 
 - Enable dependabot [\#22](https://github.com/renehernandez/camper/pull/22)
-- Retry for new access token [\#16](https://github.com/renehernandez/camper/pull/16)
 
 **Fixed bugs:**
 
 - Implement pagination according to basecamp 3 API [\#20](https://github.com/renehernandez/camper/issues/20)
 - Implement pagination according to Basecamp 3 API [\#26](https://github.com/renehernandez/camper/pull/26)
+- Remove unreleasedLabel field [\#15](https://github.com/renehernandez/camper/pull/15)
 
 **Merged pull requests:**
 
@@ -37,10 +57,7 @@
 **Implemented enhancements:**
 
 - Request a new access token once it expires [\#13](https://github.com/renehernandez/camper/issues/13)
-
-**Fixed bugs:**
-
-- Remove unreleasedLabel field [\#15](https://github.com/renehernandez/camper/pull/15)
+- Retry for new access token [\#16](https://github.com/renehernandez/camper/pull/16)
 
 **Documentation:**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camper (0.0.4)
+    camper (0.0.5)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
 
@@ -38,7 +38,7 @@ GEM
     minitest (5.14.2)
     multi_xml (0.6.0)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.1.5)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -67,25 +67,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.91.0)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
+    rubocop-ast (0.7.0)
+      parser (>= 2.7.1.5)
+      strscan (>= 1.0.0)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
+    strscan (1.0.3)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    yard (0.9.25)
     zeitwerk (2.4.0)
 
 PLATFORMS
@@ -98,6 +101,7 @@ DEPENDENCIES
   rspec (~> 3.9)
   rubocop
   rubocop-performance
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,7 +1,9 @@
-# camper ![CI](https://github.com/renehernandez/camper/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/Camper.svg)](https://badge.fury.io/rb/camper)
+# camper ![CI](https://github.com/renehernandez/camper/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/camper.svg)](https://badge.fury.io/rb/camper)
 
 Camper is a Ruby wrapper for the [Basecamp 3 API](https://github.com/basecamp/bc3-api).
 
+You can check out the gem documentation at [https://www.rubydoc.org/gems/camper](https://www.rubydoc.org/gems/camper)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +26,9 @@ $ gem install camper
 
 ## Usage
 
-Getting a client and configuring it:
+### Configuration
+
+Getting a `client` and configuring it:
 
 ```ruby
 require 'camper'
@@ -32,44 +36,58 @@ require 'camper'
 client = Camper.client
 
 client.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = 'client_id'
+  config.client_secret = 'client_secret'
+  config.account_number = 'account_number'
+  config.refresh_token = 'refresh_token'
+  config.access_token = 'access_token'
 end
-
-projects = client.projects
 ```
 
-Alternatively, it is possible to invoke the top-level `#configure` method to get a client:
+Alternatively, it is possible to invoke the top-level `#configure` method to get a `client`:
 
 ```ruby
 require 'camper'
 
 client = Camper.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = 'client_id'
+  config.client_secret = 'client_secret'
+  config.account_number = 'account_number'
+  config.refresh_token = 'refresh_token'
+  config.access_token = 'access_token'
 end
+```
 
-# gets a paginated response
-projects = client.projects
+Also, the `client` can read directly the following environment variables:
+
+* `BASECAMP_CLIENT_ID`
+* `BASECAMP_CLIENT_SECRET`
+* `BASECAMP_ACCOUNT_NUMBER`
+* `BASECAMP_REFRESH_TOKEN`
+* `BASECAMP_ACCESS_TOKEN`
+
+then the code would look like:
+
+```ruby
+require 'camper'
+
+client = Camper.client
 ```
 
+
+### Examples
+
 Example getting list of TODOs:
 
 ```ruby
 require 'camper'
 
 client = Camper.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = ENV['BASECAMP_CLIENT_ID']
+  config.client_secret = ENV['BASECAMP_CLIENT_SECRET']
+  config.account_number = ENV['BASECAMP_ACCOUNT_NUMBER']
+  config.refresh_token = ENV['BASECAMP_REFRESH_TOKEN']
+  config.access_token = ENV['BASECAMP_ACCESS_TOKEN']
 end
 
 # gets a paginated response

data/camper.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/examples/comments.rb

@@ -25,7 +25,7 @@ projects.auto_paginate do |p|
   # Adds a comment on the first todolist
   list = client.todolists(todoset).first
   puts "Todolist: #{list.title}, can be commented on: #{list.can_be_commented?}"
-  client.add_comment(list, 'New <b>comment</b> with <i>HTML support</i>')
+  client.create_comment(list, 'New <b>comment</b> with <i>HTML support</i>')
   comments = client.comments(list)
   idx = 0
   comments.auto_paginate do |c|

data/examples/create_and_complete_todo.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+# It will configure the client using the basecamp environment variables
+client = Camper.client
+
+project = client.project(ENV['PROJECT_ID'])
+
+todoset = client.todoset(project)
+
+todolist = client.todolist(todoset, ENV['TODOLIST_ID'])
+
+puts todolist.title
+
+client.todos(todolist).auto_paginate do |todo|
+  puts todo.title
+end
+
+todo = client.create_todo(todolist, 'TODO from camper', description: 'This is a todo created with camper')
+
+puts todo.title
+
+client.complete_todo(todo)

data/lib/camper/api/comment.rb

@@ -2,8 +2,8 @@
 
 class Camper::Client
   module CommentAPI
-    def add_comment(resource, content)
-      post(resource.comments_url, override_path: true, body: { content: content }.to_json)
+    def create_comment(resource, content)
+      post(resource.comments_url, override_path: true, body: { content: content })
     end
 
     def comments(resource)

data/lib/camper/api/project.rb

@@ -7,6 +7,10 @@ class Camper::Client
       get("/projects", options)
     end
 
+    def project(id)
+      get("/projects/#{id}")
+    end
+
     def message_board(project)
       board = project.message_board
       get(board.url, override_path: true)

data/lib/camper/api/resource.rb

@@ -2,10 +2,8 @@
 
 class Camper::Client
   module ResourceAPI
-    
     def resource(url)
-      get(url_transform(url), override_path: true)
+      get(url, override_path: true)
     end
-
   end
 end

data/lib/camper/api/todo.rb

@@ -3,12 +3,78 @@
 class Camper::Client
   module TodoAPI
 
-    def todolists(todoset)
-      get(todoset.todolists_url, override_path: true)
+    # Get the todolists associated with the todoset
+    #
+    # @example
+    #   client.todolists(todoset)
+    # @example
+    #   client.todolists(todoset, status: 'archived')
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param options [Hash] extra options to filter the list of todolist
+    # @return [Array<Resource>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-to-do-lists
+    def todolists(todoset, options={})
+      get(todoset.todolists_url, options.merge(override_path: true))
     end
 
+    # Get a todolist with a given id
+    #
+    # @example
+    #   client.todolist(todoset, '2345')
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param id [Integer, String] the id of the todolist to get
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-a-to-do-list
+    def todolist(todoset, id)
+      get("/buckets/#{todoset.bucket.id}/todolists/#{id}")
+    end
+
+    # Get the todos in a todolist
+    #
+    # @example
+    #   client.todos(todolist)
+    # @example
+    #   client.todos(todolist, completed: true)
+    #
+    # @param todolist [Resource] the parent todoset resource
+    # @param options [Hash] options to filter the list of todos
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos
     def todos(todolist, options={})
       get(todolist.todos_url, options.merge(override_path: true))
     end
+
+    # Create a todo within a todolist
+    #
+    # @example
+    #   client.create_todo(todolist, 'First Todo')
+    # @example
+    #   client.create_todo(
+    #     todolist,
+    #     'Program it',
+    #     description: "<div><em>Try that new language!</em></div>, due_on: "2016-05-01"
+    #   )
+    #
+    # @param todolist [Resource] the todolist where the todo is going to be created
+    # @param content [String] what the to-do is for
+    # @param options [Hash] extra configuration for the todo such as due_date and description
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
+    def create_todo(todolist, content, options={})
+      post(todolist.todos_url, body: { content: content, **options }, override_path: true)
+    end
+
+    # Complete a todo
+    #
+    # @example
+    #   client.complete_todo(todo)
+    #
+    # @param todo [Resource] the todo to be marked as completed
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#complete-a-to-do
+    def complete_todo(todo)
+      post("#{todo.url}/completion", override_path: true)
+    end
   end
 end

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,7 +6,7 @@ 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
 
@@ -19,7 +19,7 @@ module Camper
     include ResourceAPI
     include TodoAPI
 
-    # Creates a new API.
+    # Creates a new Client instance.
     # @raise [Error:MissingCredentials]
     def initialize(options = {})
       @config = Configuration.new(options)
@@ -27,18 +27,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 +55,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/error.rb

@@ -11,9 +11,14 @@ module Camper
     # Raised when API endpoint credentials not configured.
     class MissingCredentials < Error; end
 
+    class MissingBody < 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 +75,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 +129,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 +144,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 = url_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,24 @@ 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
+
+    # 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_url = url.gsub('3.basecamp.com', '3.basecampapi.com')
+      api_url.gsub!('.json', '')
+      "#{api_url}.json"
+    end
 
-      { 'Authorization' => "Bearer #{@access_token}" }
+    def body_to_json?(params)
+      @method == 'post' && params.key?(:body)
     end
   end
 end

data/lib/camper/resource.rb

@@ -63,11 +63,9 @@ module Camper
       @data.key?(method_name.to_s) ? @data[method_name.to_s] : super
     end
 
-    # rubocop:disable Style/OptionalBooleanParameter
     def respond_to_missing?(method_name, include_private = false)
       @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
     end
-    # rubocop:enable Style/OptionalBooleanParameter
 
     def self.detect_type(url)
       case url

data/lib/camper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camper
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2020-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: 
 email: 
 executables: []
@@ -82,6 +96,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -93,6 +108,7 @@ files:
 - bin/setup
 - camper.gemspec
 - examples/comments.rb
+- examples/create_and_complete_todo.rb
 - examples/messages.rb
 - examples/oauth.rb
 - examples/obtain_acces_token.rb