camper 0.0.11 → 0.1.0

data/lib/camper/api/todos.rb

@@ -1,198 +1,176 @@
 # frozen_string_literal: true
 
-class Camper::Client
-  # Defines methods related to todos.
-  # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md
-  module TodosAPI
-    PARAMETERS = %w[
-      content
-      description
-      assignee_ids
-      completion_subscriber_ids
-      notify
-      due_on
-      starts_on
-    ].freeze
-
-    # 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]
-    # @raise [Error::InvalidParameter] if todos_url field in todolist param
-    #   is not a valid basecamp url
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos
-    def todos(todolist, options = {})
-      url = todolist.todos_url
-
-      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
-
-      get(url, query: options, override_path: true)
-    end
-
-    # Get a todo with a given id using a particular parent resource.
-    #
-    # @example
-    #   client.todo(my_project, '10')
-    # @example
-    #   client.todo(new_todolist, 134)
-    # @example
-    #   client.todo(67543, '2440')
-    #
-    # @param parent [Integer|String|Project|Resource] can be either a project id, a project or a todolist resource
-    # @param id [Integer|String] id of the todo
-    # @return [Resource]
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-a-to-do
-    def todo(parent, id)
-      bucket_id = parent
-
-      if parent.is_a? Camper::Project
-        bucket_id = parent.id
-      elsif parent.respond_to?(:type)
-        bucket_id = parent.bucket.id
+module Camper
+  class Client
+    # Defines methods related to todos.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md
+    module TodosAPI
+      PARAMETERS = %w[
+        content
+        description
+        assignee_ids
+        completion_subscriber_ids
+        notify
+        due_on
+        starts_on
+      ].freeze
+
+      # Get the todos in a todolist
+      #
+      # @example
+      #   client.todos(todolist)
+      # @example
+      #   client.todos(todolist, completed: true)
+      #
+      # @param todolist [Resource] the parent todolist resource
+      # @param options [Hash] options to filter the list of todos
+      # @return [Resource]
+      # @raise [Error::InvalidParameter] if todos_url field in todolist param
+      #   is not a valid basecamp url
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos
+      def todos(todolist, options = {})
+        get(todolist.todos_url, query: options, override_path: true)
       end
 
-      get("/buckets/#{bucket_id}/todos/#{id}")
-    end
+      # Get a todo with a given id using a particular parent resource.
+      #
+      # @example
+      #   client.todo(my_project, '10')
+      # @example
+      #   client.todo(new_todolist, 134)
+      # @example
+      #   client.todo(67543, '2440')
+      #
+      # @param parent [Integer|String|Project|Resource] can be either a project id, a project or a todolist resource
+      # @param id [Integer|String] id of the todo
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-a-to-do
+      def todo(parent, id)
+        bucket_id = parent
+
+        if parent.is_a? Camper::Project
+          bucket_id = parent.id
+        elsif parent.respond_to?(:type)
+          bucket_id = parent.bucket.id
+        end
+
+        get("/buckets/#{bucket_id}/todos/#{id}")
+      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 parameters for the todo such as due_date and description
-    # @return [Resource]
-    # @raise [Error::InvalidParameter] if todos_url field in todolist param
-    #   is not a valid basecamp url
-    # @raise [Error::InvalidParameter] if content parameter is blank
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
-    def create_todo(todolist, content, options = {})
-      url = todolist.todos_url
-
-      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
-      raise Camper::Error::InvalidParameter, content if content.blank?
-
-      post(url, body: { content: content, **options }, 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 parameters for the todo such as due_date and description
+      # @return [Resource]
+      # @raise [Error::InvalidParameter] if todos_url field in todolist param
+      #   is not a valid basecamp url
+      # @raise [Error::InvalidParameter] if content parameter is blank
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
+      def create_todo(todolist, content, options = {})
+        raise Error::InvalidParameter, content if content.blank?
+
+        post(todolist.todos_url, body: { content: content, **options }, override_path: true)
+      end
 
-    # Update a todo.
-    #
-    # @example
-    #   client.update_todo(todo, 'Todo')
-    # @example
-    #   client.update_todo(
-    #     todo,
-    #     'Program it',
-    #     description: "<div><em>Try that new language!</em></div>,
-    #     due_on: "2016-05-01",
-    #     starts_on: "2016-04-30"
-    #   )
-    #
-    # @param todo [Resource] the todo to be updated
-    # @param options [Hash] parameters to be changed. The ones that are not specified
-    #   will be set to the current values of the todo object
-    # @return [Resource]
-    # @raise [Error::InvalidParameter] if url field in todo param
-    #   is not a valid basecamp url
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#update-a-to-do
-    def update_todo(todo, options)
-      url = todo.url
-
-      raise Camper::Error::InvalidParameter, url unless Camper::UrlUtils.basecamp_url?(url)
-
-      body = {}.merge(options)
-      PARAMETERS.each { |p| body[p.to_sym] = todo[p] unless key_is_present?(body, p) }
-
-      put(url, body: body, override_path: true)
-    end
+      # Update a todo.
+      #
+      # @example
+      #   client.update_todo(todo, 'Todo')
+      # @example
+      #   client.update_todo(
+      #     todo,
+      #     'Program it',
+      #     description: "<div><em>Try that new language!</em></div>,
+      #     due_on: "2016-05-01",
+      #     starts_on: "2016-04-30"
+      #   )
+      #
+      # @param todo [Resource] the todo to be updated
+      # @param options [Hash] parameters to be changed. The ones that are not specified
+      #   will be set to the current values of the todo object
+      # @return [Resource]
+      # @raise [Error::InvalidParameter] if url field in todo param
+      #   is not a valid basecamp url
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#update-a-to-do
+      def update_todo(todo, options)
+        body = {}.merge(options)
+        PARAMETERS.each { |p| body[p.to_sym] = todo[p] unless key_is_present?(body, p) }
+
+        put(todo.url, body: body, override_path: true)
+      end
 
-    # Complete a todo
-    #
-    # @example
-    #   client.complete_todo(todo)
-    #
-    # @param todo [Resource] the todo to be marked as completed
-    # @raise [Error::InvalidParameter] if url field in todo param
-    #   is not a valid basecamp url
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#complete-a-to-do
-    def complete_todo(todo)
-      url = todo.url
-
-      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
-
-      post("#{url}/completion", override_path: true)
-    end
+      # Complete a todo
+      #
+      # @example
+      #   client.complete_todo(todo)
+      #
+      # @param todo [Resource] the todo to be marked as completed
+      # @raise [Error::InvalidParameter] if url field in todo param
+      #   is not a valid basecamp url
+      # @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
 
-    # Uncomplete a todo
-    #
-    # @example
-    #   client.uncomplete_todo(todo)
-    #
-    # @param todo [Resource] the todo to be marked as uncompleted
-    # @raise [Error::InvalidParameter] if url field in todo param
-    #   is not a valid basecamp url
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#uncomplete-a-to-do
-    def uncomplete_todo(todo)
-      url = todo.url
-
-      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
-
-      delete("#{url}/completion", override_path: true)
-    end
+      # Uncomplete a todo
+      #
+      # @example
+      #   client.uncomplete_todo(todo)
+      #
+      # @param todo [Resource] the todo to be marked as uncompleted
+      # @raise [Error::InvalidParameter] if url field in todo param
+      #   is not a valid basecamp url
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#uncomplete-a-to-do
+      def uncomplete_todo(todo)
+        delete("#{todo.url}/completion", override_path: true)
+      end
 
-    # Reposition a todo
-    #
-    # @example
-    #   client.uncomplete_todo(todo)
-    #
-    # @param todo [Resource] the todo to be repositioned
-    # @param position [Integer|String] new position for the todo
-    # @raise [Error::InvalidParameter] if url field in todo param
-    #   is not a valid basecamp url
-    # @raise [Error::InvalidParameter] if position param is less than 1
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#reposition-a-to-do
-    def reposition_todo(todo, position)
-      url = todo.url
-      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
-
-      raise Camper::Error::InvalidParameter, position if position.to_i < 1
-
-      put("#{url}/position", position: position, override_path: true)
-    end
+      # Reposition a todo
+      #
+      # @example
+      #   client.uncomplete_todo(todo)
+      #
+      # @param todo [Resource] the todo to be repositioned
+      # @param position [Integer|String] new position for the todo
+      # @raise [Error::InvalidParameter] if url field in todo param
+      #   is not a valid basecamp url
+      # @raise [Error::InvalidParameter] if position param is less than 1
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#reposition-a-to-do
+      def reposition_todo(todo, position)
+        raise Error::InvalidParameter, position if position.to_i < 1
+
+        put("#{todo.url}/position", position: position, override_path: true)
+      end
 
-    # Trash a todo
-    #   it calls the trash_recording endpoint under the hood
-    #
-    # @example
-    #   client.trash_todo(todo)
-    #
-    # @param todo [Resource] the todo to be trashed
-    # @raise [Error::InvalidParameter] if url field in todo param
-    #   is not a valid basecamp url
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
-    def trash_todo(todo)
-      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(todo.url)
-
-      trash_recording(todo)
-    end
+      # Trash a todo
+      #   it calls the trash_recording endpoint under the hood
+      #
+      # @example
+      #   client.trash_todo(todo)
+      #
+      # @param todo [Resource] the todo to be trashed
+      # @raise [Error::InvalidParameter] if url field in todo param
+      #   is not a valid basecamp url
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+      def trash_todo(todo)
+        trash_recording(todo)
+      end
 
-    private
+      private
 
-    def key_is_present?(hash, key)
-      hash.key?(key.to_sym) || hash.key?(key.to_s)
+      def key_is_present?(hash, key)
+        hash.key?(key.to_sym) || hash.key?(key.to_s)
+      end
     end
   end
 end

data/lib/camper/client.rb

@@ -14,6 +14,8 @@ module Camper
     include Authorization
     include CommentsAPI
     include Logging
+    include MessageBoardsAPI
+    include MessageTypesAPI
     include MessagesAPI
     include PeopleAPI
     include ProjectsAPI
@@ -44,7 +46,7 @@ module Camper
     # by yielding the config object to the block
     # @return [Camper::Client] the client instance being configured
     def configure
-      yield @config
+      yield @config if block_given?
 
       self
     end

data/lib/camper/error.rb

@@ -17,6 +17,8 @@ module Camper
 
     class RequestIsMissingParameters < Error; end
 
+    class InvalidURL < Error; end
+
     class InvalidParameter < Error; end
 
     # Raised when impossible to parse response body.

data/lib/camper/paginated_response.rb

@@ -51,9 +51,11 @@ module Camper
 
     private
 
+    # rubocop:disable Lint/ToEnumArguments
     def lazy_paginate
       to_enum(:each_page).lazy.flat_map(&:to_ary)
     end
+    # rubocop:enable Lint/ToEnumArguments
 
     def each_page
       current = self

data/lib/camper/request.rb

@@ -63,6 +63,7 @@ module Camper
     def execute
       endpoint, params = prepare_request_data
 
+      raise Error::InvalidURL, endpoint unless UrlUtils.basecamp_url?(endpoint)
       raise Error::TooManyRetries, endpoint if maxed_attempts?
 
       @attempts += 1

data/lib/camper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -123,6 +123,7 @@ files:
 - camper.gemspec
 - examples/comments.rb
 - examples/create_and_complete_todo.rb
+- examples/message_types.rb
 - examples/messages.rb
 - examples/oauth.rb
 - examples/obtain_acces_token.rb
@@ -133,6 +134,8 @@ files:
 - examples/todos.rb
 - lib/camper.rb
 - lib/camper/api/comments.rb
+- lib/camper/api/message_board.rb
+- lib/camper/api/message_types.rb
 - lib/camper/api/messages.rb
 - lib/camper/api/people.rb
 - lib/camper/api/projects.rb