camper 0.0.6 → 0.0.11

data/lib/camper/api/projects.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  # Defines methods related to projects.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md
+  module ProjectsAPI
+    # Get the projects visible to the current user
+    #
+    # @example
+    #   client.projects
+    # @example
+    #   client.projects(status: 'trashed')
+    #
+    # @param options [Hash] extra options to filter the list of todolist
+    # @return [PaginatedResponse<Project>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-all-projects
+    def projects(options = {})
+      get('/projects', query: options)
+    end
+
+    # Get a project with a given id, granted they have access to it
+    #
+    # @example
+    #   client.project(82564)
+    # @example
+    #   client.project('7364183')
+    #
+    # @param id [Integet|String] id of the project to retrieve
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if id is blank (nil or empty string)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-a-project
+    def project(id)
+      raise Camper::Error::InvalidParameter, id if id.blank?
+
+      get("/projects/#{id}")
+    end
+
+    # Create a project
+    #
+    # @example
+    #   client.create_project("Marketing Campaign")
+    # @example
+    #   client.create_project('Better Marketing Campaign', "For Client: XYZ")
+    #
+    # @param name [String] name of the project to create
+    # @param description [String] description of the project
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if name is blank (nil or empty string)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#create-a-project
+    def create_project(name, description = '')
+      raise Camper::Error::InvalidParameter, name if name.blank?
+
+      post('/projects', body: { name: name, description: description })
+    end
+
+    # Update a project
+    #  description can be set to empty by passing an empty string
+    #
+    # @example
+    #   client.update_project(12324, name: 'Retros')
+    # @example
+    #   client.update_project('157432', description: 'A new description')
+    # @example
+    #   client.update_project('157432', description: '')
+    # @example
+    #   client.update_project(my_project, name: 'A new name', description: 'A new description')
+    #
+    # @param project [Integer|String|Project] either a project object or a project id
+    # @param name [String] optional new name of the project
+    # @param description [String] optinal new description of the project
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if both name and description are blank (nil or empty strings)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#update-a-project
+    def update_project(project, name: '', description: nil)
+      if name.blank? && description.blank?
+        raise Camper::Error::InvalidParameter, 'name and description cannot both be blank'
+      end
+
+      id = project.respond_to?(:id) ? project.id : project
+
+      options = {}
+      options[:name] = name unless name.blank?
+      options[:description] = description unless description.nil?
+
+      put("/projects/#{id}", body: { **options })
+    end
+
+    # Delete a project
+    #
+    # @example
+    #   client.delete_project(12324)
+    # @example
+    #   client.delete_project('157432')
+    # @example
+    #   client.delete_project(my_project)
+    #
+    # @param project [Integer|String|Project] either a project object or a project id
+    # @raise [Error::InvalidParameter] if project param is blank
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#trash-a-project
+    def delete_project(project)
+      raise Camper::Error::InvalidParameter, 'project cannot be blank' if project.blank?
+
+      id = project.respond_to?(:id) ? project.id : project
+
+      delete("/projects/#{id}")
+    end
+
+    alias trash_project delete_project
+
+    def message_board(project)
+      board = project.message_board
+      get(board.url, override_path: true)
+    end
+
+    def todoset(project)
+      todoset = project.todoset
+      get(todoset.url, override_path: true)
+    end
+  end
+end

data/lib/camper/api/recordings.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Camper
+  class Client
+    # Defines methods related to recordings.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md
+    module RecordingsAPI
+      # Get a paginated response of recordings of a given type
+      #
+      # @example
+      #   client.recordings('Todo')
+      # @example
+      #   client.recordings(
+      #     'Document',
+      #     bucket: [1,2],
+      #     status: 'archived',
+      #     sort: 'updated_at',
+      #     direction: 'asc'
+      #   )
+      #
+      # @param type [String] type of the recording
+      # @param options [Hash] extra options to filter the recordings to be resulted
+      # @return [PaginatedResponse<Resource>]
+      # @raise [Error::InvalidParameter] if type is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#get-recordings
+      def recordings(type, options = {})
+        raise Error::InvalidParameter, type unless RecordingTypes.all.include?(type)
+
+        get('/projects/recordings', query: options.merge(type: type))
+      end
+
+      # Trash a given recording
+      #
+      # @example
+      #   client.trash_recording(my_todo)
+      # @example
+      #   client.trash_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+      def trash_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/trashed")
+      end
+
+      # Archive a given recording
+      #
+      # @example
+      #   client.archive_recording(my_todo)
+      # @example
+      #   client.archive_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#archive-a-recording
+      def archive_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/archived")
+      end
+
+      # Unarchive a given recording
+      #
+      # @example
+      #   client.unarchive_recording(my_todo)
+      # @example
+      #   client.unarchive_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#unarchive-a-recording
+      def unarchive_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/active")
+      end
+    end
+  end
+end

data/lib/camper/api/todolists.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  # Defines methods related to todolists.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md
+  module TodolistsAPI
+    # 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 [PaginatedResponse<Resource>]
+    # @raise [Error::InvalidParameter] if todolists_url field in todoset param
+    #   is not a valid basecamp url
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-to-do-lists
+    def todolists(todoset, options = {})
+      url = todoset.todolists_url
+
+      raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
+
+      get(url, query: options, 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
+
+    # Create a todolist within the given todoset
+    #
+    # @example
+    #   client.create_todolist(todoset, 'Launch', "<div><em>Finish it!</em></div>")
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param name [String] the name of the new todolist
+    # @param description [String] an optional description for the todolist
+    # @return [Resource]
+    # @raise [Error::InvalidParameter] if todolists_url field in todoset param
+    #   is not a valid basecamp url
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#create-a-to-do-list
+    def create_todolist(todoset, name, description = '')
+      url = todoset.todolists_url
+
+      raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
+
+      post(url, body: { name: name, description: description }, override_path: true)
+    end
+
+    # Update a todolist to change name and description
+    #
+    # @example
+    #   client.update_todolist(todolist, 'Launch')
+    # @example
+    #   client.update_todolist(todolist, 'Launch', "<div><em>Finish it!</em></div>")
+    # @example
+    #   client.update_todolist(todolist, 'Launch', '')
+    #
+    # @param todolist [Resource] the todolist resource to update
+    # @param name [String] the new name of the todolist
+    # @param description [String] a new optional description for the todolist. If not specified,
+    #   it will be set to the current description value
+    # @return [Resource]
+    # @raise [Error::InvalidParameter] if url field in todolist param
+    #   is not a valid basecamp url
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#update-a-to-do-list
+    def update_todolist(todolist, name, description = nil)
+      url = todolist.url
+
+      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
+
+      body = { name: name }
+      body[:description] = description.nil? ? todolist.description : description
+
+      put(url, body: body, override_path: true)
+    end
+
+    # Trash a todolist
+    #   it calls the trash_recording endpoint under the hood
+    #
+    # @example
+    #   client.trash_todolist(todolist)
+    #
+    # @param todolist [Resource] the todolist to be trashed
+    # @raise [Error::InvalidParameter] if the type field in todolist param
+    #   is not an allowed type in the recording API
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+    def trash_todolist(todolist)
+      trash_recording(todolist)
+    end
+  end
+end

data/lib/camper/api/todos.rb

@@ -0,0 +1,198 @@
+# 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
+      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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # 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
+
+    private
+
+    def key_is_present?(hash, key)
+      hash.key?(key.to_sym) || hash.key?(key.to_s)
+    end
+  end
+end