camper 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 984eef67b2149dac0f1735f6dcda5012b140dd4d3404b8523e23b21096d510de
-  data.tar.gz: 90b228ed0f5388a6866346c46b98a608d44a8753bec6a7eef844cd85583afd34
+  metadata.gz: 1b8a4cdfcb11473573ac1bb1f600964f12f8722093a8a9446a47d1594e4a0963
+  data.tar.gz: 43810e0cf19d16b5a2a71789401758f497dfa46d43e70ea8c9e9e5a8160bcb51
 SHA512:
-  metadata.gz: 6bac9cf265b6ec6ddcdaa38fb6290e9c35b16c8a4dc1c64446589eea095dd2a4dcda4a491b0e46c20c9aad45e6af4d8168b693dcfc556d125b78fc8de35caf7a
-  data.tar.gz: c605925535d3052d2844d2fe7ac0ee2b420f2891c78e1e14422bb3e8cf9464399eb741dbdde2fd7611f49743de2097f8a62f06e98e0419d2dc4298551328b604
+  metadata.gz: 261ab2cdc09cae324aef2183d5bba9fa087c87337f2b7fe5e007bb91af4c2a6abb56f32a158437f2f71e1acc5670f76fe612911810402e60647c161733bf6199
+  data.tar.gz: fe517bdf6508916f6cd037424f6e95a589e1ad27303e25b385d44d51c19c722e7d47ad9d1de28bab7f2da5bbe5ffd05f8255cf4400cff980b6cb31f9594e7f59

data/.gitignore

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

data/.rubocop.yml

@@ -7,9 +7,10 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'camper.gemspec'
+    - 'lib/camper/core_extensions/object.rb'
 
 Layout/LineLength:
-  Max: 123
+  Max: 120
   Exclude:
     - 'lib/camper/client/*'
     - 'spec/**/*'
@@ -18,6 +19,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
+Metrics/AbcSize:
+  Max: 20
+
 Style/Documentation:
   Enabled: false
 

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+lib/**/*.rb
+examples/*.rb - 
+README.md CONTRIBUTING.md CHANGELOG.md

data/CHANGELOG.md

@@ -4,8 +4,50 @@
 
 **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:**
+
+- Implement handling error according to Basecamp 3 API specifications [\#21](https://github.com/renehernandez/camper/issues/21)
+- Add ability to complete a Todo [\#12](https://github.com/renehernandez/camper/issues/12)
+- Multiple improvements [\#38](https://github.com/renehernandez/camper/pull/38)
+- Error handling improvements [\#37](https://github.com/renehernandez/camper/pull/37)
+
+**Documentation:**
+
+- Enable documentation in RubyDoc [\#6](https://github.com/renehernandez/camper/issues/6)
+- Add yard documentation [\#41](https://github.com/renehernandez/camper/pull/41)
+- Fix gem badge [\#39](https://github.com/renehernandez/camper/pull/39)
+
+**Merged pull requests:**
+
+- Rename add\_comment to create\_comment [\#40](https://github.com/renehernandez/camper/pull/40)
+- Bump rubocop from 0.91.0 to 0.92.0 [\#36](https://github.com/renehernandez/camper/pull/36)
+
+## [v0.0.5](https://github.com/renehernandez/camper/tree/v0.0.5) (2020-09-22)
+
+**Implemented enhancements:**
+
 - Enable dependabot [\#22](https://github.com/renehernandez/camper/pull/22)
-- Retry for new access token [\#16](https://github.com/renehernandez/camper/pull/16)
 
 **Fixed bugs:**
 
@@ -37,6 +79,7 @@
 **Implemented enhancements:**
 
 - 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:**
 

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    camper (0.0.4)
+    camper (0.0.9)
+      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.4)
+    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,17 +68,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.91.0)
+    rubocop (1.0.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.2)
-      parser (>= 2.7.1.4)
+    rubocop-ast (1.0.0)
+      parser (>= 2.7.1.5)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
       rubocop-ast (>= 0.4.0)
@@ -86,7 +87,8 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    yard (0.9.25)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -98,6 +100,7 @@ DEPENDENCIES
   rspec (~> 3.9)
   rubocop
   rubocop-performance
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,7 +1,9 @@
-# camper ![CI](https://github.com/renehernandez/camper/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/Camper.svg)](https://badge.fury.io/rb/camper)
+# camper ![CI](https://github.com/renehernandez/camper/workflows/CI/badge.svg) [![Gem Version](https://badge.fury.io/rb/camper.svg)](https://badge.fury.io/rb/camper)
 
 Camper is a Ruby wrapper for the [Basecamp 3 API](https://github.com/basecamp/bc3-api).
 
+You can check out the gem documentation at [https://www.rubydoc.org/gems/camper](https://www.rubydoc.org/gems/camper)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,9 +24,24 @@ 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) (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)
+
 ## Usage
 
-Getting a client and configuring it:
+### Configuration
+
+Getting a `client` and configuring it:
 
 ```ruby
 require 'camper'
@@ -32,44 +49,58 @@ require 'camper'
 client = Camper.client
 
 client.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = 'client_id'
+  config.client_secret = 'client_secret'
+  config.account_number = 'account_number'
+  config.refresh_token = 'refresh_token'
+  config.access_token = 'access_token'
 end
-
-projects = client.projects
 ```
 
-Alternatively, it is possible to invoke the top-level `#configure` method to get a client:
+Alternatively, it is possible to invoke the top-level `#configure` method to get a `client`:
 
 ```ruby
 require 'camper'
 
 client = Camper.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = 'client_id'
+  config.client_secret = 'client_secret'
+  config.account_number = 'account_number'
+  config.refresh_token = 'refresh_token'
+  config.access_token = 'access_token'
 end
+```
 
-# gets a paginated response
-projects = client.projects
+Also, the `client` can read directly the following environment variables:
+
+* `BASECAMP_CLIENT_ID`
+* `BASECAMP_CLIENT_SECRET`
+* `BASECAMP_ACCOUNT_NUMBER`
+* `BASECAMP_REFRESH_TOKEN`
+* `BASECAMP_ACCESS_TOKEN`
+
+then the code would look like:
+
+```ruby
+require 'camper'
+
+client = Camper.client
 ```
 
+
+### Examples
+
 Example getting list of TODOs:
 
 ```ruby
 require 'camper'
 
 client = Camper.configure do |config|
-  config.client_id = ENV['BASEcamper_CLIENT_ID']
-  config.client_secret = ENV['BASEcamper_CLIENT_SECRET']
-  config.account_number = ENV['BASEcamper_ACCOUNT_NUMBER']
-  config.refresh_token = ENV['BASEcamper_REFRESH_TOKEN']
-  config.access_token = ENV['BASEcamper_ACCESS_TOKEN']
+  config.client_id = ENV['BASECAMP_CLIENT_ID']
+  config.client_secret = ENV['BASECAMP_CLIENT_SECRET']
+  config.account_number = ENV['BASECAMP_ACCOUNT_NUMBER']
+  config.refresh_token = ENV['BASECAMP_REFRESH_TOKEN']
+  config.access_token = ENV['BASECAMP_ACCESS_TOKEN']
 end
 
 # gets a paginated response

data/camper.gemspec

@@ -28,7 +28,9 @@ 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'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/examples/comments.rb

@@ -25,7 +25,7 @@ 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.add_comment(list, 'New <b>comment</b> with <i>HTML support</i>')
+  client.create_comment(list, 'New <b>comment</b> with <i>HTML support</i>')
   comments = client.comments(list)
   idx = 0
   comments.auto_paginate do |c|

data/examples/create_and_complete_todo.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+# It will configure the client using the basecamp environment variables
+client = Camper.client
+
+project = client.project(ENV['PROJECT_ID'])
+
+todoset = client.todoset(project)
+
+todolist = client.todolist(todoset, ENV['TODOLIST_ID'])
+
+puts todolist.title
+
+client.todos(todolist).auto_paginate do |todo|
+  puts todo.title
+end
+
+todo = client.create_todo(todolist, 'TODO from camper', description: 'This is a todo created with camper')
+
+puts todo.title
+
+client.complete_todo(todo)

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/todolists.rb

@@ -0,0 +1,32 @@
+# 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}"
+
+  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
+    puts 'Cannot use a project p to get the todolists'
+  end
+end

data/examples/todos.rb

@@ -11,17 +11,20 @@ end
 projects = client.projects
 
 projects.auto_paginate do |p|
-  puts "Project: #{p.inspect}"
-
-  puts "Todo set: #{p.todoset.inspect}"
+  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}"
     end
   end
 end

data/lib/camper.rb

@@ -7,6 +7,7 @@ require 'camper/version'
 require 'camper/logging'
 require 'camper/error'
 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,9 +1,11 @@
 # frozen_string_literal: true
 
 class Camper::Client
-  module CommentAPI
-    def add_comment(resource, content)
-      post(resource.comments_url, override_path: true, body: { content: content }.to_json)
+  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
 
     def comments(resource)