camper 0.0.5 → 0.0.10

data/lib/camper/api/{message.rb → messages.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Camper::Client
-  module MessageAPI
+  module MessagesAPI
     def messages(message_board)
       get(message_board.messages_url, override_path: true)
     end

data/lib/camper/api/people.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  # Defines methods related to people.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md
+  module PeopleAPI
+    # Get all people visible to the current user
+    #
+    # @example
+    #   client.people
+    #
+    # @return [Array<Resource>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-all-people
+    def people
+      get('/people')
+    end
+
+    # Get all active people on the project with the given ID
+    #
+    # @example
+    #   client.people_in_project(10)
+    # @example
+    #   client.people_in_project("20")
+    # @example
+    #   client.people_in_project(my_project)
+    #
+    # @param project [Resource|Integer|String] A project resource or a project id
+    # @return [Array<Resource>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-people-on-a-project
+    def people_in_project(project)
+      id = project.respond_to?(:id) ? project.id : project
+
+      get("/projects/#{id}/people")
+    end
+
+    # Allows granting new and existing people access to a project, and revoking access from existing people.
+    #
+    # @example
+    #   client.update_access_in_project(10, { grant: [102, 127] })
+    # @example
+    #   client.update_access_in_project("8634", { revoke: [300, 12527] })
+    # @example
+    #   client.update_access_in_project(my_project, {
+    #     create: [{
+    #       name: "Victor Copper",
+    #       email_address: "victor@hanchodesign.com"
+    #     }]
+    #   })
+    #
+    # @param project [Resource|Integer|String] A project resource or a project id
+    # @param options [Hash] options to update access, either grant, revoke or create new people
+    # @return [Resource]
+    # @raise [Error::InvalidParameter] if no option is specified
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#update-who-can-access-a-project
+    def update_access_in_project(project, options = {})
+      raise Camper::Error::InvalidParameter, 'options cannot be empty' if options.empty?
+
+      id = project.respond_to?(:id) ? project.id : project
+
+      put("/projects/#{id}/people/users", body: { **options })
+    end
+
+    # Get all people on this Basecamp account who can be pinged
+    #
+    # @example
+    #   client.pingable_people
+    #
+    # @return [Array<Resource>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-pingable-people
+    def pingable_people
+      get('/circles/people')
+    end
+
+    # Get the profile for the user with the given ID
+    #
+    # @example
+    #   client.person(234790)
+    #
+    # @param id [Integer|String] A user id
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-person
+    def person(id)
+      get("/people/#{id}")
+    end
+
+    # Get the current user's personal info.
+    #
+    # @example
+    #   client.profile
+    #
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-my-personal-info
+    def profile
+      get('/my/profile')
+    end
+  end
+end

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 [Array<Project>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-all-projects
+    def projects(options = {})
+      get('/projects', 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/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/todolists.rb

@@ -0,0 +1,81 @@
+# 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 [Array<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, 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
+
+    # 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', "<div><em>Finish it!</em></div>")
+    #
+    # @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
+    # @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 = '')
+      url = todolist.url
+
+      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
+
+      put(url, body: { name: name, description: description }, override_path: true)
+    end
+  end
+end

data/lib/camper/api/todos.rb

@@ -0,0 +1,133 @@
+# 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
+    # 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, options.merge(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 configuration 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
+    # @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)
+
+      post(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
+    # @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
+  end
+end