camper 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa90563f8a1f1cc3ba09a874f10130511620dbe0afb687aedf2a70f7d97bde14
-  data.tar.gz: 753c1ca3bedeff92690f267e75c045357535fcc10bedc7b7df42f64ca9f9d7b8
+  metadata.gz: a55ed04d219593d0ed46a16a84c1993eab9b51d1cbc6b55386bd23068f002668
+  data.tar.gz: 1bf654df624233c32289b132ee58dabe05158088f4fc970a8b2ebdf7ddfae229
 SHA512:
-  metadata.gz: 179b1ecd4431b2049ddbb135a260f6b47ade0a8e3a3aef021f8027e4ba7b8ff0561567179fd503fe317a66099ca30b46296e6e99c3deead27a9e0ee347aed9c5
-  data.tar.gz: a976b84f32e91336a0be556417098de9218aec0d1f05c632c9bc41d4f99f699364d152ec4caf1b89917a32ccf13c61ac447529930e57ca0ab127250f954d096f
+  metadata.gz: 1a56723911f5687789ae0078d62dd2ffc3ce5df0af7edd844ec2a4942098f26dcec1931a21d9731983af62134d331e6958526d910df68a1959e5794e3fd9a292
+  data.tar.gz: c076b430f753ab8b2021b64e7811b05bfb9e7669a842638df47a7fd2ab6a0536c54ccdc449bbdf81b2a3be86950c3554e11866e45dbd8f2dd612fe18d499f2d5

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
@@ -14,6 +15,9 @@ Layout/LineLength:
     - 'lib/camper/client/*'
     - 'spec/**/*'
 
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
@@ -24,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

@@ -1,6 +1,67 @@
 # 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:**
+
+- 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)
+- 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)
+
+**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:**
+
+- 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:**
 

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    camper (0.0.5)
+    camper (0.0.11)
+      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)
@@ -20,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)
@@ -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,44 +53,42 @@ 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)
-      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 (0.92.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.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.7.0)
+    rubocop-ast (1.1.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,22 @@ 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) (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) (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)
+
 ## 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/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/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' })