camper 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dbee68b43218a497b29c8006b70cb344d0925c879f5220aef14228e12cd6dce
-  data.tar.gz: fc3f58b2d04d11912e6fd497c86eba3039dae579c645eb8a5a5493d9076283d0
+  metadata.gz: a55ed04d219593d0ed46a16a84c1993eab9b51d1cbc6b55386bd23068f002668
+  data.tar.gz: 1bf654df624233c32289b132ee58dabe05158088f4fc970a8b2ebdf7ddfae229
 SHA512:
-  metadata.gz: 00fabce0dc901476883b26af2e71b8b68fab3859577172e3a4456d20b099ffed533961917388e3eba39fa334f8b9097b73804a15a97264bc9cc6ebd8911b26a1
-  data.tar.gz: b360150b837d8d0d89e794f7145c711a7ef86f88267d9b17d6829b1988ef425f8c82f53b4c0037f74c6a63f655689c93438da9c7f618e5c02c004bffbea27f16
+  metadata.gz: 1a56723911f5687789ae0078d62dd2ffc3ce5df0af7edd844ec2a4942098f26dcec1931a21d9731983af62134d331e6958526d910df68a1959e5794e3fd9a292
+  data.tar.gz: c076b430f753ab8b2021b64e7811b05bfb9e7669a842638df47a7fd2ab6a0536c54ccdc449bbdf81b2a3be86950c3554e11866e45dbd8f2dd612fe18d499f2d5

data/.rubocop.yml

@@ -15,6 +15,9 @@ Layout/LineLength:
     - 'lib/camper/client/*'
     - 'spec/**/*'
 
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
@@ -25,6 +28,12 @@ Metrics/AbcSize:
 Style/Documentation:
   Enabled: false
 
+Style/AsciiComments:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
 Style/ClassAndModuleChildren:
   Exclude:
     - 'lib/camper/*'

data/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 **Implemented enhancements:**
 
+- Complete messages and message types APIs [\#66](https://github.com/renehernandez/camper/pull/66)
+- Complete comments api [\#65](https://github.com/renehernandez/camper/pull/65)
+
+**Merged pull requests:**
+
+- Refactor check for valid basecamp url [\#67](https://github.com/renehernandez/camper/pull/67)
+- Bump rspec from 3.9.0 to 3.10.0 [\#64](https://github.com/renehernandez/camper/pull/64)
+- Rewrite API modules to use module nesting [\#63](https://github.com/renehernandez/camper/pull/63)
+- Bump rubocop from 1.0.0 to 1.1.0 [\#48](https://github.com/renehernandez/camper/pull/48)
+
+## [v0.0.11](https://github.com/renehernandez/camper/tree/v0.0.11) (2020-11-01)
+
+**Implemented enhancements:**
+
 - Implement trash\_todo endpoint [\#58](https://github.com/renehernandez/camper/issues/58)
 - Implement trash\_todolist endpoint [\#57](https://github.com/renehernandez/camper/issues/57)
 - To-do API is missing update\_todo endpoint [\#49](https://github.com/renehernandez/camper/issues/49)
@@ -20,6 +34,10 @@
 - Update endpoints documentation to use PaginatedResponse [\#59](https://github.com/renehernandez/camper/pull/59)
 - Fix query string generation in get endpoints [\#55](https://github.com/renehernandez/camper/pull/55)
 
+**Documentation:**
+
+- update\_todolist needs to call out that description will be cleared if not specified [\#50](https://github.com/renehernandez/camper/issues/50)
+
 ## [v0.0.10](https://github.com/renehernandez/camper/tree/v0.0.10) (2020-10-30)
 
 **Implemented enhancements:**

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camper (0.0.10)
+    camper (0.0.11)
       concurrent-ruby (~> 1.1)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
@@ -21,7 +21,7 @@ GEM
     bindata (2.4.8)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -55,29 +55,29 @@ GEM
     rake (13.0.1)
     regexp_parser (1.8.2)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (1.0.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.1.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.0.0)
+    rubocop-ast (1.1.0)
       parser (>= 2.7.1.5)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)

data/README.md

@@ -30,11 +30,13 @@ The up-to-date list of Basecamp API endpoints can be found at [here](https://git
 
 Currently, Camper supports the following endpoints:
 
-* [Comments](https://github.com/basecamp/bc3-api/blob/master/sections/comments.md): Implementation at [comments.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/comments.rb) (Partial)
-* [Messages](https://github.com/basecamp/bc3-api/blob/master/sections/messages.md): Implementation at [messages.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/messages.rb) (Partial)
+* [Comments](https://github.com/basecamp/bc3-api/blob/master/sections/comments.md): Implementation at [comments.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/comments.rb) (Complete)
+* [Message Types](https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md): Implementation at [messages.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/message_types.rb) (Complete)
+* [Message Boards](https://github.com/basecamp/bc3-api/blob/master/sections/message_boards.md): Implementation at [message_boards.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/message_boards.rb) (Complete)
+* [Messages](https://github.com/basecamp/bc3-api/blob/master/sections/messages.md): Implementation at [messages.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/messages.rb) (Complete)
 * [People](https://github.com/basecamp/bc3-api/blob/master/sections/people.md): Implementation at [people.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/people.rb) (Complete)
 * [Projects](https://github.com/basecamp/bc3-api/blob/master/sections/projects.md): Implementation at [projects.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/projects.rb) (Complete)
-* [Recordings](https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md): Implementation at [recordings.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/recordings.rb)
+* [Recordings](https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md): Implementation at [recordings.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/recordings.rb) (Complete)
 * [To-do list](https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md): Implementation at [todolists.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/todolists.rb) (Complete)
 * [To-dos](https://github.com/basecamp/bc3-api/blob/master/sections/todos.md): Implementation at [todos.rb](https://github.com/renehernandez/camper/blob/main/lib/camper/api/todos.rb) (Complete)
 

data/examples/comments.rb

@@ -25,11 +25,22 @@ 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.create_comment(list, 'New <b>comment</b> with <i>HTML support</i>')
+
+  puts 'Create a new comment'
+  new_comment = client.create_comment(list, 'New temporary comment')
   comments = client.comments(list)
   idx = 0
   comments.auto_paginate do |c|
     puts "Comment #{idx} content: #{c.content}"
     idx += 1
   end
+
+  puts 'Get single comment'
+  single_comment = client.comment(list, new_comment.id)
+
+  puts 'Update comment'
+  client.update_comment(single_comment, 'New content')
+
+  puts 'Delete comment'
+  client.trash_comment(single_comment)
 end

data/examples/message_types.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+project = client.projects.first
+
+puts 'List all messages types'
+client.message_types(project).auto_paginate do |type|
+  puts "Name: #{type.name}; Icon: #{type.icon}"
+end
+
+puts 'Create new message type'
+type = client.create_message_type(project, 'Farewell', '👋')
+puts "Message Type:\n#{type.inspect}"
+
+puts 'Update message type name'
+type = client.update_message_type(project, type, name: 'Bye bye')
+puts "Message Type:\n#{type.inspect}"
+
+puts 'Update message type icon'
+type = client.update_message_type(project, type, icon: '🙌')
+puts "Message Type:\n#{type.inspect}"
+
+puts 'Delete message type'
+client.delete_message_type(project, type)
+
+

data/examples/messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'camper'
 
 client = Camper.configure do |config|
@@ -16,9 +18,18 @@ projects.auto_paginate do |p|
   message_board = client.message_board(p)
   puts "Message Board: #{message_board.title}"
 
+  puts 'List messages using the message board'
   messages = client.messages(message_board)
 
   messages.auto_paginate do |msg|
-    puts msg.inspect
+    puts "Title: #{msg.title}; Content: #{msg.content}"
+  end
+
+  puts 'List messages using the project'
+  messages = client.messages(p)
+
+  messages.auto_paginate do |msg|
+    puts "Title: #{msg.title}; Content: #{msg.content}"
+    puts "Message:\n#{msg.inspect}"
   end
-end
+end

data/lib/camper/api/comments.rb

@@ -1,15 +1,87 @@
 # frozen_string_literal: true
 
-class Camper::Client
-  module CommentsAPI
-    def create_comment(resource, content)
-      raise Error::ResourceCannotBeCommented, resource unless resource.can_be_commented?
+module Camper
+  class Client
+    # Defines methods related to comments.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/comments.md
+    module CommentsAPI
+      # Get a paginated list of active comments for a given resource
+      #
+      # @example
+      #   client.comments(todo)
+      #
+      # @param resource [Resource] resource to gets the comments from
+      # @return [PaginatedResponse<Resource>]
+      # @raise [Error::ResourceCannotBeCommented] if the resource doesn't support comments
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#get-comments
+      def comments(resource)
+        raise Error::ResourceCannotBeCommented, resource unless resource.can_be_commented?
 
-      post(resource.comments_url, override_path: true, body: { content: content })
-    end
+        get(resource.comments_url, override_path: true)
+      end
+
+      # Get a comment within a resource
+      #
+      # @example
+      #   client.comment(todo, 10)
+      # @example
+      #   client.comment(my_message, '23')
+      #
+      # @param resource [Resource] resource to get the comment from
+      # @param comment_id [Integer|String] id of comment ot retrieve
+      # @return [Resource]
+      # @raise [Error::ResourceCannotBeCommented] if the resource doesn't support comments
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#get-a-comment
+      def comment(resource, comment_id)
+        raise Error::ResourceCannotBeCommented, resource unless resource.can_be_commented?
+
+        bucket_id = resource.bucket.id
+
+        get("/buckets/#{bucket_id}/comments/#{comment_id}")
+      end
+
+      # Create a new comment for a given resource
+      #
+      # @example
+      #   client.create_comment(my_message, 'We are ready to start the project')
+      #
+      # @param resource [Resource] resource to create the comment on
+      # @param content [String] content of the comment
+      # @return [Resource]
+      # @raise [Error::ResourceCannotBeCommented] if the resource doesn't support comments
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#create-a-comment
+      def create_comment(resource, content)
+        raise Error::ResourceCannotBeCommented, resource unless resource.can_be_commented?
+
+        post(resource.comments_url, override_path: true, body: { content: content })
+      end
+
+      # Update the content in a comment
+      #
+      # @example
+      #   client.update_comment(comment, 'Fixed grammar mistakes')
+      #
+      # @param comment [Resource] comment to modify
+      # @param content [String] new content of the comment
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#update-a-comment
+      def update_comment(comment, content)
+        bucket_id = comment.bucket.id
+
+        put("/buckets/#{bucket_id}/comments/#{comment.id}", body: { content: content })
+      end
 
-    def comments(resource)
-      get(resource.comments_url, override_path: true)
+      # Trash a comment
+      #   it calls the trash_recording endpoint under the hood
+      #
+      # @example
+      #   client.trash_comment(current_comment)
+      #
+      # @param comment [Resource] the comment to be trashed
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+      def trash_comment(comment)
+        trash_recording(comment)
+      end
     end
   end
 end

data/lib/camper/api/message_board.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Camper
+  class Client
+    # Defines methods related to message boards.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_boards.md
+    module MessageBoardsAPI
+      # Get a message board for a given project
+      #
+      # @example
+      #   client.message_board(project)
+      #
+      # @param project [Project] project to get the associated message board on
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_boards.md#message-boards
+      def message_board(project)
+        board = project.message_board
+
+        get(board.url, override_path: true)
+      end
+    end
+  end
+end

data/lib/camper/api/message_types.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Camper
+  class Client
+    # Defines methods related to message types.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md
+    module MessageTypesAPI
+      # Get a paginated list of all messages types in a given project
+      #
+      # @example
+      #   client.messages_types(my_project)
+      #
+      # @param project [Project] project to get the messages types from
+      # @return [PaginatedResponse<Resource>]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#get-message-types
+      def message_types(project)
+        get("/buckets/#{project.id}/categories")
+      end
+
+      # Get a messages type in a given project
+      #
+      # @example
+      #   client.message_type(my_project, '10')
+      # @example
+      #   client.message_type(my_project, 64926)
+      #
+      # @param project [Project] project to get the messages type from
+      # @param message_type_id [Integer|String] id of the message type to retrieve
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#get-a-message-type
+      def message_type(project, message_type_id)
+        get("/buckets/#{project.id}/categories/#{message_type_id}")
+      end
+
+      # Create a messages type in a given project
+      #
+      # @example
+      #   client.create_message_type(my_project, 'Farewell', '👋')
+      #
+      # @param project [Project] project where the message type belongs to
+      # @param name [String] name of the new message type
+      # @param icon [String] icon to associate with the new message type
+      # @return [Resource]
+      # @raise [Error::InvalidParameter] if either name or icon is blank
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#create-a-message-type
+      def create_message_type(project, name, icon)
+        raise Error::InvalidParameter, 'Name and icon parameters cannot be blank' if name.blank? || icon.blank?
+
+        post("/buckets/#{project.id}/categories", body: { name: name, icon: icon })
+      end
+
+      # Update a message type in a given project
+      #
+      # @example
+      #   client.update_message_type(my_project, type, name: 'Quick Update')
+      # @example
+      #   client.update_message_type(my_project, type, icon: '🤙')
+      #
+      # @param project [Project] project where the message type belongs to
+      # @param type [Resource|Integer|String] resource or id representing a message type
+      # @param options [Hash] hash containing the name and/or icon to modify
+      # @return [Resource]
+      # @raise [Error::InvalidParameter] if options parameter is empty
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#destroy-a-message-type
+      def update_message_type(project, type, options = {})
+        raise Error::InvalidParameter, 'options cannot be empty' if options.empty?
+
+        type_id = type.respond_to?(:id) ? type.id : type
+
+        put("/buckets/#{project.id}/categories/#{type_id}", body: options)
+      end
+
+      # Delete a message type in a given project
+      #
+      # @example
+      #   client.delete_message_type(my_project, type)
+      #
+      # @param project [Project] project where the message type belongs to
+      # @param type [Resource|Integer|String] resource or id representing a message type
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#destroy-a-message-type
+      def delete_message_type(project, type)
+        type_id = type.respond_to?(:id) ? type.id : type
+
+        delete("/buckets/#{project.id}/categories/#{type_id}")
+      end
+
+      alias trash_message_type delete_message_type
+    end
+  end
+end

data/lib/camper/api/messages.rb

@@ -1,9 +1,108 @@
 # frozen_string_literal: true
 
-class Camper::Client
-  module MessagesAPI
-    def messages(message_board)
-      get(message_board.messages_url, override_path: true)
+module Camper
+  class Client
+    # Defines methods related to messages.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/messages.md
+    module MessagesAPI
+      # Get a paginated list of active messages under the given message board or project
+      #
+      # @example
+      #   client.messages(message_board)
+      # @example
+      #   client.messages(my_project)
+      #
+      # @param parent [Project|Resource] either a project or message board resource
+      # @return [PaginatedResponse<Resource>]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#get-messages
+      def messages(parent)
+        if parent.is_a?(Project)
+          bucket_id, board_id = parent.id, parent.message_board.id
+        else
+          bucket_id, board_id = parent.bucket.id, parent.id
+        end
+
+        get("/buckets/#{bucket_id}/message_boards/#{board_id}/messages")
+      end
+
+      # Get a paginated list of active messages under the given message board or project
+      #
+      # @example
+      #   client.message(my_project, '2343')
+      # @example
+      #   client.message(message_board, 234)
+      #
+      # @param parent [Project|Resource] either a project or message board resource
+      # @param message_id [Integer|String] id of the message to retrieve
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#get-a-message
+      def message(parent, message_id)
+        bucket_id = parent.is_a?(Project) ? parent.id : parent.bucket.id
+
+        get("/buckets/#{bucket_id}/messages/#{message_id}")
+      end
+
+      # Create a message
+      #
+      # @example
+      #   client.create_message(my_project, 'New Infrastructure')
+      # @example
+      #   client.create_message(message_board, 'New Launch',
+      #     content: 'This launch will be awesome',
+      #     category_id: '23'
+      #   )
+      #
+      # @param parent [Project|Resource] either a project or message board resource
+      # @param subject [String] subject of the new message
+      # @param options [Hash] hash containing the content and/or category id for the new message
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#create-a-message
+      def create_message(parent, subject, options = {})
+        if parent.is_a?(Project)
+          bucket_id, board_id = parent.id, parent.message_board.id
+        else
+          bucket_id, board_id = parent.bucket.id, parent.id
+        end
+
+        post(
+          "/buckets/#{bucket_id}/message_boards/#{board_id}/messages",
+          body: options.merge({ subject: subject, status: 'active' })
+        )
+      end
+
+      # Update a message
+      #
+      # @example
+      #   client.update_message(message, subject: 'New Infrastructure')
+      # @example
+      #   client.update_message(message, content: 'This launch will be awesome')
+      # @example
+      #   client.update_message(message, category_id: '6918641') # message type id
+      #
+      # @param message [Resource] message to update
+      # @param options [Hash] subject of the new message
+      # @param options [Hash] hash containing subject, content and/or category_id to update
+      # @return [Resource]
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#update-a-message
+      def update_message(message, options = {})
+        raise Error::InvalidParameter, 'options cannot be empty' if options.empty?
+
+        update("/buckets/#{message.bucket.id}/messages/#{message.id}", body: options)
+      end
+
+      # Trash message
+      #   it calls the trash_recording endpoint under the hood
+      #
+      # @example
+      #   client.trash_message(message)
+      #
+      # @param todo [Resource] the message 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_message(message)
+        trash_recording(message)
+      end
     end
   end
 end