camper 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa90563f8a1f1cc3ba09a874f10130511620dbe0afb687aedf2a70f7d97bde14
-  data.tar.gz: 753c1ca3bedeff92690f267e75c045357535fcc10bedc7b7df42f64ca9f9d7b8
+  metadata.gz: ac986df88ec826cc3b15bb75ba1bab382a144f6fdbf9900881907e7f82aab633
+  data.tar.gz: 122bba57a7e32a886390dbae0220122c86417c064a9ed9815085639fb5f4519c
 SHA512:
-  metadata.gz: 179b1ecd4431b2049ddbb135a260f6b47ade0a8e3a3aef021f8027e4ba7b8ff0561567179fd503fe317a66099ca30b46296e6e99c3deead27a9e0ee347aed9c5
-  data.tar.gz: a976b84f32e91336a0be556417098de9218aec0d1f05c632c9bc41d4f99f699364d152ec4caf1b89917a32ccf13c61ac447529930e57ca0ab127250f954d096f
+  metadata.gz: 9c7dbea42ec5e6ab228fe0fe627e61e45877f9c82803391005d0c45c262231c165bd523036f3bd38072be2c0ace8510dfc61f2ab792dc8ad27e66b3deae710c5
+  data.tar.gz: 1a7d91f083e430ee984bf81e1f55f5a70281721071e2fd86a947ac7b26a99fc18324bd4da88cbaa2d8ab34e989f2f6396197a904670e785ae42b002b07667b78

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # 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:**
+
+- 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camper (0.0.5)
+    camper (0.0.7)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
 

data/README.md

@@ -24,6 +24,18 @@ Or install it yourself as:
 $ gem install camper
 ```
 
+## Implemented 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**
+
 ## Usage
 
 ### Configuration

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 ttps://github.com/basecamp/bc3-api/blob/master/sections/people.md
+  module PeopleAPI
+    # Get all people visible to the current user
+    #
+    # @example
+    #   client.people
+    #
+    # @return [Array<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 [Array<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::RequestIsMissingParameters] 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?
+
+      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 [Array<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

data/lib/camper/api/{project.rb → projects.rb}

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 class Camper::Client
-  module ProjectAPI
-
+  module ProjectsAPI
     def projects(options = {})
-      get("/projects", options)
+      get('/projects', options)
     end
 
     def project(id)

data/lib/camper/api/{todo.rb → todos.rb}

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 class Camper::Client
-  module TodoAPI
-
+  module TodosAPI
     # Get the todolists associated with the todoset
     #
     # @example
@@ -14,7 +13,7 @@ class Camper::Client
     # @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={})
+    def todolists(todoset, options = {})
       get(todoset.todolists_url, options.merge(override_path: true))
     end
 
@@ -42,7 +41,7 @@ class Camper::Client
     # @param options [Hash] options to filter the list of todos
     # @return [Resource]
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos
-    def todos(todolist, options={})
+    def todos(todolist, options = {})
       get(todolist.todos_url, options.merge(override_path: true))
     end
 
@@ -62,7 +61,7 @@ class Camper::Client
     # @param options [Hash] extra configuration for the todo such as due_date and description
     # @return [Resource]
     # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
-    def create_todo(todolist, content, options={})
+    def create_todo(todolist, content, options = {})
       post(todolist.todos_url, body: { content: content, **options }, override_path: true)
     end
 

data/lib/camper/client.rb

@@ -12,12 +12,13 @@ module Camper
 
     # Keep in alphabetical order
     include Authorization
-    include CommentAPI
+    include CommentsAPI
     include Logging
-    include MessageAPI
-    include ProjectAPI
+    include MessagesAPI
+    include PeopleAPI
+    include ProjectsAPI
     include ResourceAPI
-    include TodoAPI
+    include TodosAPI
 
     # Creates a new Client instance.
     # @raise [Error:MissingCredentials]

data/lib/camper/error.rb

@@ -13,6 +13,10 @@ module Camper
 
     class MissingBody < Error; end
 
+    class ResourceCannotBeCommented < Error; end
+
+    class RequestIsMissingParameters < Error; end
+
     # Raised when impossible to parse response body.
     class Parsing < Error; end
 

data/lib/camper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -114,11 +114,12 @@ files:
 - examples/obtain_acces_token.rb
 - examples/todos.rb
 - lib/camper.rb
-- lib/camper/api/comment.rb
-- lib/camper/api/message.rb
-- lib/camper/api/project.rb
+- lib/camper/api/comments.rb
+- lib/camper/api/messages.rb
+- lib/camper/api/people.rb
+- lib/camper/api/projects.rb
 - lib/camper/api/resource.rb
-- lib/camper/api/todo.rb
+- lib/camper/api/todos.rb
 - lib/camper/authorization.rb
 - lib/camper/client.rb
 - lib/camper/configuration.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby client for Basecamp 3 API