camper 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac986df88ec826cc3b15bb75ba1bab382a144f6fdbf9900881907e7f82aab633
-  data.tar.gz: 122bba57a7e32a886390dbae0220122c86417c064a9ed9815085639fb5f4519c
+  metadata.gz: 702097b0560277ca7116dea4caed2e50e34f6d6732ba0be390515931220ef24b
+  data.tar.gz: 402cc359f4b7013691c36927e26502efe14a52b222471c8e5513a1d2b8e4c106
 SHA512:
-  metadata.gz: 9c7dbea42ec5e6ab228fe0fe627e61e45877f9c82803391005d0c45c262231c165bd523036f3bd38072be2c0ace8510dfc61f2ab792dc8ad27e66b3deae710c5
-  data.tar.gz: 1a7d91f083e430ee984bf81e1f55f5a70281721071e2fd86a947ac7b26a99fc18324bd4da88cbaa2d8ab34e989f2f6396197a904670e785ae42b002b07667b78
+  metadata.gz: 8681cda10f1bc5acc17a407d53a517bac0763758df16773952c8c84b9e7b380c5b18c7254a0d39d09dda70d505732a0c0f515d4c863adb4bab0b8471d66ef383
+  data.tar.gz: a43b2d372e1f539f68ad8ec4bfd212353305da29a72f1bb82382609e0ce2ea237b7b457b92ed0d1d54c300a7d2fa4a8a5077fd0e5b84b1d7b982bb6bd3ccf5a4

data/.gitignore

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

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 
 **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)
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    camper (0.0.7)
+    camper (0.0.8)
       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 +38,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 +52,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,23 +67,21 @@ 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)

data/README.md

@@ -24,17 +24,18 @@ Or install it yourself as:
 $ gem install camper
 ```
 
-## Implemented API endpoints
+## 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](./lib/camper/api/comments.rb) **Partial**
-* [Messages](https://github.com/basecamp/bc3-api/blob/master/sections/messages.md): Implementation at [messages.rb](./lib/camper/api/messages.rb) **Partial**
-* [People](https://github.com/basecamp/bc3-api/blob/master/sections/people.md): Implementation at [people.rb](./lib/camper/api/people.rb) **Complete**
-* [Projects](https://github.com/basecamp/bc3-api/blob/master/sections/projects.md): Implementation at [projects.rb](./lib/camper/api/projects.rb) **Partial**
-* [To-dos](https://github.com/basecamp/bc3-api/blob/master/sections/todos.md): Implementation at [todos.rb](./lib/camper/api/todos.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) (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
 

data/examples/people.rb

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

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

@@ -2,7 +2,7 @@
 
 class Camper::Client
   # Defines methods related to people.
-  # @see ttps://github.com/basecamp/bc3-api/blob/master/sections/people.md
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/people.md
   module PeopleAPI
     # Get all people visible to the current user
     #
@@ -50,10 +50,10 @@ class Camper::Client
     # @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::RequestIsMissingParameters] if no option is specified
+    # @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 RequestIsMissingParameters, 'options cannot be empty' if options.empty?
+      raise Camper::Error::InvalidParameter, 'options cannot be empty' if options.empty?
 
       id = project.respond_to?(:id) ? project.id : project
 

data/lib/camper/api/todolists.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  # Defines methods related to todolists.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md
+  module TodolistsAPI
+    # Get the todolists associated with the todoset
+    #
+    # @example
+    #   client.todolists(todoset)
+    # @example
+    #   client.todolists(todoset, status: 'archived')
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param options [Hash] extra options to filter the list of todolist
+    # @return [Array<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
+    def todolists(todoset, options = {})
+      url = todoset.todolists_url
+
+      raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
+
+      get(url, options.merge(override_path: true))
+    end
+
+    # Get a todolist with a given id
+    #
+    # @example
+    #   client.todolist(todoset, '2345')
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param id [Integer, String] the id of the todolist to get
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-a-to-do-list
+    def todolist(todoset, id)
+      get("/buckets/#{todoset.bucket.id}/todolists/#{id}")
+    end
+
+    # Create a todolist within the given todoset
+    #
+    # @example
+    #   client.create_todolist(todoset, 'Launch', "<div><em>Finish it!</em></div>")
+    #
+    # @param todoset [Resource] the parent todoset resource
+    # @param name [String] the name of the new todolist
+    # @param description [String] an optional description for the todolist
+    # @return [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#create-a-to-do-list
+    def create_todolist(todoset, name, description = '')
+      url = todoset.todolists_url
+
+      raise Camper::Error::InvalidParameter, todoset unless Camper::UrlUtils.basecamp_url?(url)
+
+      post(url, body: { name: name, description: description }, override_path: true)
+    end
+
+    # Update a todolist to change name and description
+    #
+    # @example
+    #   client.update_todolist(todolist, 'Launch', "<div><em>Finish it!</em></div>")
+    #
+    # @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
+    # @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 = '')
+      url = todolist.url
+
+      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
+
+      put(url, body: { name: name, description: description }, override_path: true)
+    end
+  end
+end

data/lib/camper/api/todos.rb

@@ -1,35 +1,9 @@
 # frozen_string_literal: true
 
 class Camper::Client
+  # Defines methods related to todos.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md
   module TodosAPI
-    # Get the todolists associated with the todoset
-    #
-    # @example
-    #   client.todolists(todoset)
-    # @example
-    #   client.todolists(todoset, status: 'archived')
-    #
-    # @param todoset [Resource] the parent todoset resource
-    # @param options [Hash] extra options to filter the list of todolist
-    # @return [Array<Resource>]
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-to-do-lists
-    def todolists(todoset, options = {})
-      get(todoset.todolists_url, options.merge(override_path: true))
-    end
-
-    # Get a todolist with a given id
-    #
-    # @example
-    #   client.todolist(todoset, '2345')
-    #
-    # @param todoset [Resource] the parent todoset resource
-    # @param id [Integer, String] the id of the todolist to get
-    # @return [Resource]
-    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-a-to-do-list
-    def todolist(todoset, id)
-      get("/buckets/#{todoset.bucket.id}/todolists/#{id}")
-    end
-
     # Get the todos in a todolist
     #
     # @example
@@ -40,9 +14,40 @@ class Camper::Client
     # @param todolist [Resource] the parent todoset resource
     # @param options [Hash] options to filter the list of todos
     # @return [Resource]
+    # @raise [Error::InvalidParameter] if todos_url field in todolist param
+    #   is not a valid basecamp url
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos
     def todos(todolist, options = {})
-      get(todolist.todos_url, options.merge(override_path: true))
+      url = todolist.todos_url
+
+      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
+
+      get(url, options.merge(override_path: true))
+    end
+
+    # Get a todo with a given id using a particular parent resource.
+    #
+    # @example
+    #   client.todo(my_project, '10')
+    # @example
+    #   client.todo(new_todolist, 134)
+    # @example
+    #   client.todo(67543, '2440')
+    #
+    # @param parent [Integer|String|Project|Resource] can be either a project id, a project or a todolist resource
+    # @param id [Integer|String] id of the todo
+    # @return [Resource]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-a-to-do
+    def todo(parent, id)
+      bucket_id = parent
+
+      if parent.is_a? Camper::Project
+        bucket_id = parent.id
+      elsif parent.respond_to?(:type)
+        bucket_id = parent.bucket.id
+      end
+
+      get("/buckets/#{bucket_id}/todos/#{id}")
     end
 
     # Create a todo within a todolist
@@ -60,9 +65,15 @@ class Camper::Client
     # @param content [String] what the to-do is for
     # @param options [Hash] extra configuration 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
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
     def create_todo(todolist, content, options = {})
-      post(todolist.todos_url, body: { content: content, **options }, override_path: true)
+      url = todolist.todos_url
+
+      raise Camper::Error::InvalidParameter, todolist unless Camper::UrlUtils.basecamp_url?(url)
+
+      post(url, body: { content: content, **options }, override_path: true)
     end
 
     # Complete a todo
@@ -71,9 +82,52 @@ class Camper::Client
     #   client.complete_todo(todo)
     #
     # @param todo [Resource] the todo to be marked as completed
+    # @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#complete-a-to-do
     def complete_todo(todo)
-      post("#{todo.url}/completion", override_path: true)
+      url = todo.url
+
+      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
+
+      post("#{url}/completion", override_path: true)
+    end
+
+    # Uncomplete a todo
+    #
+    # @example
+    #   client.uncomplete_todo(todo)
+    #
+    # @param todo [Resource] the todo to be marked as uncompleted
+    # @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#uncomplete-a-to-do
+    def uncomplete_todo(todo)
+      url = todo.url
+
+      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
+
+      delete("#{url}/completion", override_path: true)
+    end
+
+    # Reposition a todo
+    #
+    # @example
+    #   client.uncomplete_todo(todo)
+    #
+    # @param todo [Resource] the todo to be repositioned
+    # @param position [Integer|String] new position for the todo
+    # @raise [Error::InvalidParameter] if url field in todo param
+    #   is not a valid basecamp url
+    # @raise [Error::InvalidParameter] if position param is less than 1
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#reposition-a-to-do
+    def reposition_todo(todo, position)
+      url = todo.url
+      raise Camper::Error::InvalidParameter, todo unless Camper::UrlUtils.basecamp_url?(url)
+
+      raise Camper::Error::InvalidParameter, position if position.to_i < 1
+
+      put("#{url}/position", position: position, override_path: true)
     end
   end
 end

data/lib/camper/client.rb

@@ -18,6 +18,7 @@ module Camper
     include PeopleAPI
     include ProjectsAPI
     include ResourceAPI
+    include TodolistsAPI
     include TodosAPI
 
     # Creates a new Client instance.

data/lib/camper/error.rb

@@ -17,6 +17,8 @@ module Camper
 
     class RequestIsMissingParameters < Error; end
 
+    class InvalidParameter < Error; end
+
     # Raised when impossible to parse response body.
     class Parsing < Error; end
 

data/lib/camper/request.rb

@@ -93,7 +93,7 @@ module Camper
 
       full_endpoint = override_path ? @path : @client.api_endpoint + @path
 
-      full_endpoint = url_transform(full_endpoint)
+      full_endpoint = UrlUtils.transform(full_endpoint)
 
       return full_endpoint, params
     end
@@ -138,17 +138,6 @@ module Camper
       { 'Authorization' => "Bearer #{@client.access_token}" }
     end
 
-    # Utility method for transforming Basecamp Web URLs into API URIs
-    # e.g 'https://3.basecamp.com/1/buckets/2/todos/3' will be
-    # converted into 'https://3.basecampapi.com/1/buckets/2/todos/3.json'
-    #
-    # @return [String]
-    def url_transform(url)
-      api_url = url.gsub('3.basecamp.com', '3.basecampapi.com')
-      api_url.gsub!('.json', '')
-      "#{api_url}.json"
-    end
-
     def body_to_json?(params)
       @method == 'post' && params.key?(:body)
     end

data/lib/camper/url_utils.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Camper
+  # Defines methods related to url operations.
+  module UrlUtils
+    def self.basecamp_url?(url)
+      return false if url.nil? || !url.is_a?(String) || url == ''
+
+      transformed_url = UrlUtils.transform(url)
+
+      transformed_url.match?(%r{#{Configuration.base_api_endpoint}/\d+/.*})
+    end
+
+    # Utility method for transforming Basecamp Web URLs into API URIs
+    # e.g 'https://3.basecamp.com/1/buckets/2/todos/3' will be
+    # converted into 'https://3.basecampapi.com/1/buckets/2/todos/3.json'
+    #
+    # @param url [String] url to test
+    # @return [String]
+    def self.transform(url)
+      api_url = url.gsub('3.basecamp.com', '3.basecampapi.com')
+      api_url.gsub!('.json', '')
+      "#{api_url}.json"
+    end
+  end
+end

data/lib/camper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -112,6 +112,8 @@ files:
 - examples/messages.rb
 - examples/oauth.rb
 - examples/obtain_acces_token.rb
+- examples/people.rb
+- examples/todolists.rb
 - examples/todos.rb
 - lib/camper.rb
 - lib/camper/api/comments.rb
@@ -119,6 +121,7 @@ files:
 - lib/camper/api/people.rb
 - lib/camper/api/projects.rb
 - lib/camper/api/resource.rb
+- lib/camper/api/todolists.rb
 - lib/camper/api/todos.rb
 - lib/camper/authorization.rb
 - lib/camper/client.rb
@@ -130,6 +133,7 @@ files:
 - lib/camper/request.rb
 - lib/camper/resource.rb
 - lib/camper/resources/project.rb
+- lib/camper/url_utils.rb
 - lib/camper/version.rb
 homepage: https://github.com/renehernandez/camper
 licenses: