camper 0.0.11 → 0.1.0

data/lib/camper/api/people.rb

@@ -1,97 +1,99 @@
 # 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 [PaginatedResponse<Resource>]
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-all-people
-    def people
-      get('/people')
-    end
+module Camper
+  class 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 [PaginatedResponse<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 [PaginatedResponse<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 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 [PaginatedResponse<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
+        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?
+      # 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
+        id = project.respond_to?(:id) ? project.id : project
 
-      put("/projects/#{id}/people/users", body: { **options })
-    end
+        put("/projects/#{id}/people/users", body: { **options })
+      end
 
-    # Get all people on this Basecamp account who can be pinged
-    #
-    # @example
-    #   client.pingable_people
-    #
-    # @return [PaginatedResponse<Resource>]
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-pingable-people
-    def pingable_people
-      get('/circles/people')
-    end
+      # Get all people on this Basecamp account who can be pinged
+      #
+      # @example
+      #   client.pingable_people
+      #
+      # @return [PaginatedResponse<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 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')
+      # 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
 end

data/lib/camper/api/projects.rb

@@ -1,120 +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?
+module Camper
+  class 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("/projects/#{id}")
-    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 Error::InvalidParameter, id if id.blank?
 
-    # 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?
+        get("/projects/#{id}")
+      end
 
-      post('/projects', body: { name: name, description: description })
-    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 Error::InvalidParameter, name if name.blank?
 
-    # 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'
+        post('/projects', body: { name: name, description: description })
       end
 
-      id = project.respond_to?(:id) ? project.id : project
+      # 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)
+        # rubocop:disable Style/IfUnlessModifier:
+        if name.blank? && description.blank?
+          raise Error::InvalidParameter, 'name and description cannot both be blank'
+        end
 
-      options = {}
-      options[:name] = name unless name.blank?
-      options[:description] = description unless description.nil?
+        # rubocop:enable Style/IfUnlessModifier
 
-      put("/projects/#{id}", body: { **options })
-    end
+        id = project.respond_to?(:id) ? project.id : project
 
-    # 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?
+        options = {}
+        options[:name] = name unless name.blank?
+        options[:description] = description unless description.nil?
 
-      id = project.respond_to?(:id) ? project.id : project
+        put("/projects/#{id}", body: { **options })
+      end
 
-      delete("/projects/#{id}")
-    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 Error::InvalidParameter, 'project cannot be blank' if project.blank?
 
-    alias trash_project delete_project
+        id = project.respond_to?(:id) ? project.id : project
 
-    def message_board(project)
-      board = project.message_board
-      get(board.url, override_path: true)
-    end
+        delete("/projects/#{id}")
+      end
+
+      alias trash_project delete_project
 
-    def todoset(project)
-      todoset = project.todoset
-      get(todoset.url, override_path: true)
+      def todoset(project)
+        todoset = project.todoset
+        get(todoset.url, override_path: true)
+      end
     end
   end
 end

data/lib/camper/api/resource.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-class Camper::Client
-  module ResourceAPI
-    def resource(url)
-      get(url, override_path: true)
+module Camper
+  class Client
+    module ResourceAPI
+      def resource(url)
+        get(url, override_path: true)
+      end
     end
   end
 end

data/lib/camper/api/todolists.rb

@@ -1,103 +1,95 @@
 # 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
+module Camper
+  class 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 = {})
+        get(todoset.todolists_url, query: options, override_path: true)
+      end
 
-      raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
+      # 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(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 = '')
+        body = { name: name, description: description }
 
-    # 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
+        post(todoset.todolists_url, body: body, override_path: true)
+      end
 
-      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)
+        body = { name: name }
+        body[:description] = description.nil? ? todolist.description : description
 
-    # 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
+        put(todolist.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)
+      # 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
 end