camper 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8a4cdfcb11473573ac1bb1f600964f12f8722093a8a9446a47d1594e4a0963
-  data.tar.gz: 43810e0cf19d16b5a2a71789401758f497dfa46d43e70ea8c9e9e5a8160bcb51
+  metadata.gz: 0dbee68b43218a497b29c8006b70cb344d0925c879f5220aef14228e12cd6dce
+  data.tar.gz: fc3f58b2d04d11912e6fd497c86eba3039dae579c645eb8a5a5493d9076283d0
 SHA512:
-  metadata.gz: 261ab2cdc09cae324aef2183d5bba9fa087c87337f2b7fe5e007bb91af4c2a6abb56f32a158437f2f71e1acc5670f76fe612911810402e60647c161733bf6199
-  data.tar.gz: fe517bdf6508916f6cd037424f6e95a589e1ad27303e25b385d44d51c19c722e7d47ad9d1de28bab7f2da5bbe5ffd05f8255cf4400cff980b6cb31f9594e7f59
+  metadata.gz: 00fabce0dc901476883b26af2e71b8b68fab3859577172e3a4456d20b099ffed533961917388e3eba39fa334f8b9097b73804a15a97264bc9cc6ebd8911b26a1
+  data.tar.gz: b360150b837d8d0d89e794f7145c711a7ef86f88267d9b17d6829b1988ef425f8c82f53b4c0037f74c6a63f655689c93438da9c7f618e5c02c004bffbea27f16

data/CHANGELOG.md

@@ -4,6 +4,26 @@
 
 **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)
+- update\_todolist endpoint now sends the current description if none is specified [\#62](https://github.com/renehernandez/camper/pull/62)
+- Add trash\_todolist endpoint [\#61](https://github.com/renehernandez/camper/pull/61)
+- Add trash\_todo endpoint implementation [\#60](https://github.com/renehernandez/camper/pull/60)
+- Add recordings api [\#53](https://github.com/renehernandez/camper/pull/53)
+- Add update\_todo implementation [\#52](https://github.com/renehernandez/camper/pull/52)
+
+**Fixed bugs:**
+
+- return tag should mention PaginatedResponse instead of Array [\#56](https://github.com/renehernandez/camper/issues/56)
+- Get endpoints params need to be set under query field [\#54](https://github.com/renehernandez/camper/issues/54)
+- 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)
+
+## [v0.0.10](https://github.com/renehernandez/camper/tree/v0.0.10) (2020-10-30)
+
+**Implemented enhancements:**
+
 - Complete projects api [\#51](https://github.com/renehernandez/camper/pull/51)
 
 ## [v0.0.9](https://github.com/renehernandez/camper/tree/v0.0.9) (2020-10-28)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camper (0.0.9)
+    camper (0.0.10)
       concurrent-ruby (~> 1.1)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)

data/README.md

@@ -33,9 +33,10 @@ 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)
 * [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) (Partial)
-* [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) (Almost complete, only missing todolist trashing)
-* [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) (Almost complete, only missing todo trashing)
+* [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)
+* [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)
 
 ## Usage
 

data/examples/recordings.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+recordings = client.recordings(
+  Camper::RecordingTypes::TODO
+)
+
+recordings.auto_paginate do |rec|
+  puts "Todo content: #{rec.content}"
+end

data/examples/todolists.rb

@@ -13,6 +13,7 @@ projects.auto_paginate do |p|
 
   puts "Ratio of completed Todos in Todoset: #{todoset.completed_ratio}"
 
+  puts 'Listing active todolists'
   client.todolists(todoset).auto_paginate(5) do |list|
     puts "Todolist: #{list.title}"
 
@@ -26,7 +27,24 @@ projects.auto_paginate do |p|
 
   begin
     client.todolists(p)
-  rescue Camper::Error::InvalidParameter
+  rescue Camper::Error::InvalidParameter, NoMethodError
     puts 'Cannot use a project p to get the todolists'
   end
+
+  puts 'Listing archived todolists'
+  client.todolists(todoset, status: :archived).auto_paginate do |list|
+    client.todos(list).auto_paginate do |todo|
+      puts "Todo: #{todo.title}"
+      puts "Can be commented: #{todo.can_be_commented?}"
+      puts "It's completed: #{todo.completed}"
+
+      client.complete_todo(todo)
+    end
+  end
+
+  puts 'Create a new todolist'
+  new_list = client.create_todolist(todoset, 'Temporary list')
+  puts "Todolist title: #{new_list.title}"
+  puts 'Trash list'
+  client.trash_todolist(new_list)
 end

data/examples/todos.rb

@@ -10,6 +10,8 @@ end
 
 projects = client.projects
 
+selected_todo = nil
+
 projects.auto_paginate do |p|
   puts "Project: #{p.name}"
 
@@ -25,6 +27,16 @@ projects.auto_paginate do |p|
       puts "Get Todo using project id: #{client.todo(p.id, todo.id).title}"
       puts "Get Todo using project resource: #{client.todo(p, todo.id).title}"
       puts "Get Todo using todolist resource: #{client.todo(list, todo.id).title}"
+
+      selected_todo = todo
     end
+
+    puts 'Create new todo'
+    new_todo = client.create_todo(list, 'new todo')
+    puts "New Todo title: #{new_todo.title}"
+    puts 'Trash new todo'
+    client.trash_todo(new_todo)
   end
-end
+end
+
+client.update_todo(selected_todo, { description: 'New Description' })

data/lib/camper.rb

@@ -6,6 +6,7 @@ require 'rack/oauth2'
 require 'camper/version'
 require 'camper/logging'
 require 'camper/error'
+require 'camper/recording_types'
 require 'camper/configuration'
 require 'camper/url_utils'
 require 'camper/authorization'

data/lib/camper/api/people.rb

@@ -9,7 +9,7 @@ class Camper::Client
     # @example
     #   client.people
     #
-    # @return [Array<Resource>]
+    # @return [PaginatedResponse<Resource>]
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-all-people
     def people
       get('/people')
@@ -25,7 +25,7 @@ class Camper::Client
     #   client.people_in_project(my_project)
     #
     # @param project [Resource|Integer|String] A project resource or a project id
-    # @return [Array<Resource>]
+    # @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
@@ -65,7 +65,7 @@ class Camper::Client
     # @example
     #   client.pingable_people
     #
-    # @return [Array<Resource>]
+    # @return [PaginatedResponse<Resource>]
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-pingable-people
     def pingable_people
       get('/circles/people')

data/lib/camper/api/projects.rb

@@ -12,10 +12,10 @@ class Camper::Client
     #   client.projects(status: 'trashed')
     #
     # @param options [Hash] extra options to filter the list of todolist
-    # @return [Array<Project>]
+    # @return [PaginatedResponse<Project>]
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-all-projects
     def projects(options = {})
-      get('/projects', options)
+      get('/projects', query: options)
     end
 
     # Get a project with a given id, granted they have access to it

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

@@ -13,7 +13,7 @@ class Camper::Client
     #
     # @param todoset [Resource] the parent todoset resource
     # @param options [Hash] extra options to filter the list of todolist
-    # @return [Array<Resource>]
+    # @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
@@ -22,7 +22,7 @@ class Camper::Client
 
       raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
 
-      get(url, options.merge(override_path: true))
+      get(url, query: options, override_path: true)
     end
 
     # Get a todolist with a given id
@@ -61,21 +61,43 @@ class Camper::Client
     # 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
+    # @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 = '')
+    def update_todolist(todolist, name, description = nil)
       url = todolist.url
 
       raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
 
-      put(url, body: { name: name, description: description }, override_path: true)
+      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

@@ -4,6 +4,16 @@ 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
@@ -22,7 +32,7 @@ class Camper::Client
 
       raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
 
-      get(url, options.merge(override_path: true))
+      get(url, query: options, override_path: true)
     end
 
     # Get a todo with a given id using a particular parent resource.
@@ -63,19 +73,52 @@ class Camper::Client
     #
     # @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
+    # @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
@@ -129,5 +172,27 @@ class Camper::Client
 
       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

data/lib/camper/client.rb

@@ -17,6 +17,7 @@ module Camper
     include MessagesAPI
     include PeopleAPI
     include ProjectsAPI
+    include RecordingsAPI
     include ResourceAPI
     include TodolistsAPI
     include TodosAPI

data/lib/camper/recording_types.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Camper
+  class RecordingTypes
+    COMMENT = 'Comment'
+    DOCUMENT = 'Document'
+    MESSAGE = 'Message'
+    QUESTION_ANSWER = 'Question::Answer'
+    SCHEDULE_ENTRY = 'Schedule::Entry'
+    TODO = 'Todo'
+    TODOLIST = 'Todolist'
+    UPLOAD = 'Upload'
+
+    # rubocop:disable Style/ClassVars
+    def self.all
+      @@recordings ||= constants(false).map { |c| const_get(c) }.sort
+
+      @@recordings
+    end
+    # rubocop:enable Style/ClassVars
+  end
+end

data/lib/camper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -128,6 +128,7 @@ files:
 - examples/obtain_acces_token.rb
 - examples/people.rb
 - examples/projects.rb
+- examples/recordings.rb
 - examples/todolists.rb
 - examples/todos.rb
 - lib/camper.rb
@@ -135,6 +136,7 @@ files:
 - lib/camper/api/messages.rb
 - lib/camper/api/people.rb
 - lib/camper/api/projects.rb
+- lib/camper/api/recordings.rb
 - lib/camper/api/resource.rb
 - lib/camper/api/todolists.rb
 - lib/camper/api/todos.rb
@@ -146,6 +148,7 @@ files:
 - lib/camper/logging.rb
 - lib/camper/paginated_response.rb
 - lib/camper/pagination_data.rb
+- lib/camper/recording_types.rb
 - lib/camper/request.rb
 - lib/camper/resource.rb
 - lib/camper/resources/project.rb