camper 0.0.6 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d0cdad6f722b4f3c02ba3da38147000e371f57860ce203fb1c64eb007797de
-  data.tar.gz: db77821cf2cb77070b049dce6cbf4bc62430c4948101aadf7d2c87b4e67eaa42
+  metadata.gz: 0dbee68b43218a497b29c8006b70cb344d0925c879f5220aef14228e12cd6dce
+  data.tar.gz: fc3f58b2d04d11912e6fd497c86eba3039dae579c645eb8a5a5493d9076283d0
 SHA512:
-  metadata.gz: '027558808a97c4ef3c04c6ec895c86a8975e32f7a03397e882513db25f0cfb29978135c23a77a87081cfa845834c31419e7813c24a3bf43aeaf030b777e31c28'
-  data.tar.gz: 7aa221c2f13009488cc57d46fc86e1daeb21e2051b70e33dc6780032b8091bfdcb9f9efd54286b774b2f9406bd78c889add255e47ef674870aae07887c190ac5
+  metadata.gz: 00fabce0dc901476883b26af2e71b8b68fab3859577172e3a4456d20b099ffed533961917388e3eba39fa334f8b9097b73804a15a97264bc9cc6ebd8911b26a1
+  data.tar.gz: b360150b837d8d0d89e794f7145c711a7ef86f88267d9b17d6829b1988ef425f8c82f53b4c0037f74c6a63f655689c93438da9c7f618e5c02c004bffbea27f16

data/.gitignore

@@ -57,4 +57,4 @@ build-iPhoneSimulator/
 
 .rspec_status
 
-.env
+.env*

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'camper.gemspec'
+    - 'lib/camper/core_extensions/object.rb'
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -1,6 +1,49 @@
 # Changelog
 
-## [v0.0.6](https://github.com/renehernandez/camper/tree/v0.0.6) (2020-10-01)
+## [Unreleased](https://github.com/renehernandez/camper/tree/HEAD)
+
+**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)
+
+**Implemented enhancements:**
+
+- Split todos and todolists APIs [\#47](https://github.com/renehernandez/camper/pull/47)
+
+**Merged pull requests:**
+
+- Bump rubocop from 0.92.0 to 1.0.0 [\#44](https://github.com/renehernandez/camper/pull/44)
+
+## [v0.0.8](https://github.com/renehernandez/camper/tree/v0.0.8) (2020-10-27)
+
+**Implemented enhancements:**
+
+- Add people API [\#46](https://github.com/renehernandez/camper/pull/46)
+- Raise error if resource can't be commented [\#45](https://github.com/renehernandez/camper/pull/45)
+
+## [v0.0.7](https://github.com/renehernandez/camper/tree/v0.0.7) (2020-10-04)
 
 **Implemented enhancements:**
 
@@ -30,7 +73,6 @@
 
 - Implement pagination according to basecamp 3 API [\#20](https://github.com/renehernandez/camper/issues/20)
 - Implement pagination according to Basecamp 3 API [\#26](https://github.com/renehernandez/camper/pull/26)
-- Remove unreleasedLabel field [\#15](https://github.com/renehernandez/camper/pull/15)
 
 **Merged pull requests:**
 
@@ -59,6 +101,10 @@
 - Request a new access token once it expires [\#13](https://github.com/renehernandez/camper/issues/13)
 - Retry for new access token [\#16](https://github.com/renehernandez/camper/pull/16)
 
+**Fixed bugs:**
+
+- Remove unreleasedLabel field [\#15](https://github.com/renehernandez/camper/pull/15)
+
 **Documentation:**
 
 - Initial documentation [\#5](https://github.com/renehernandez/camper/issues/5)

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    camper (0.0.5)
+    camper (0.0.10)
+      concurrent-ruby (~> 1.1)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.3)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -38,7 +39,7 @@ GEM
     minitest (5.14.2)
     multi_xml (0.6.0)
     parallel (1.19.2)
-    parser (2.7.1.5)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -52,7 +53,7 @@ GEM
       rack (>= 2.1.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.0)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -67,29 +68,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.92.0)
+    rubocop (1.0.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.7.0)
+    rubocop-ast (1.0.0)
       parser (>= 2.7.1.5)
-      strscan (>= 1.0.0)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
-    strscan (1.0.3)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     yard (0.9.25)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -24,6 +24,20 @@ Or install it yourself as:
 $ gem install camper
 ```
 
+## Status of API endpoints
+
+The up-to-date list of Basecamp API endpoints can be found at [here](https://github.com/basecamp/bc3-api#api-endpoints).
+
+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) (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
 
 ### Configuration

data/camper.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'httparty', '~> 0.18'
   spec.add_dependency 'rack-oauth2', '~> 1.14'
+  spec.add_dependency 'concurrent-ruby', '~> 1.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'

data/examples/people.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+current_user = client.profile
+
+puts "Current User:\n#{current_user.inspect}"
+
+puts "People:\n#{client.people.inspect}"

data/examples/projects.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+project = client.project(ENV['PROJECT_ID'])
+
+puts "Project name: #{project.name}"
+puts "Project description: #{project.description}"
+
+client.update_project(project, name: 'Hermes Testing', description: 'Hermes integration testing')

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+projects = client.projects
+
+projects.auto_paginate do |p|
+  puts "Project: #{p.name}"
+
+  todoset = client.todoset(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}"
+
+    client.todos(list).auto_paginate do |todo|
+      puts "Todo: #{todo.title}"
+      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}"
+    end
+  end
+
+  begin
+    client.todolists(p)
+  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,18 +10,33 @@ end
 
 projects = client.projects
 
-projects.auto_paginate do |p|
-  puts "Project: #{p.inspect}"
+selected_todo = nil
 
-  puts "Todo set: #{p.todoset.inspect}"
+projects.auto_paginate do |p|
+  puts "Project: #{p.name}"
 
   todoset = client.todoset(p)
 
+  puts "Ratio of completed Todos in Todoset: #{todoset.completed_ratio}"
+
   client.todolists(todoset).auto_paginate(5) do |list|
     puts "Todolist: #{list.title}"
 
-    client.todos(list).auto_paginate do |todo|
-      puts todo.inspect
+    client.todos(list).auto_paginate(1) do |todo|
+      puts "Todo: #{todo.title}"
+      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,7 +6,9 @@ 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'
 require 'camper/resource'
 require 'camper/pagination_data'

data/lib/camper/api/{comment.rb → comments.rb}

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 class Camper::Client
-  module CommentAPI
+  module CommentsAPI
     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
 

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 [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("/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 [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 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