camp3 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c51061a5954cc07915e99c8e709dde954de59d976664b0fafc0f4e8029d28505
-  data.tar.gz: 98cfe680d84287497ac4c0d8ab6bcdcde00fb9f41ab0b444e90a368cc2a472f4
+  metadata.gz: 66a193782f5b6d1b473d062b935cbbc6574326e73644551fbf7e12be3a2e3265
+  data.tar.gz: 9392604c669d445da80dc67b1d353f32120e6b42128c71e20ade043db8875810
 SHA512:
-  metadata.gz: 4697b931b0e50fdd54e7345de1ebf552f4a5daad1dfb1472773890c5ac107a2a9c512d2dfdf0a852c40650212ea3d3fcff508f23be27c73686fbe2b83539b55f
-  data.tar.gz: 736fe2af5f5eb1599920d9466f52ab60ab637e6356886115b1ff9b9b07822c6030359070e04f9bbc39f5a9eccae96c624be5e984f180f459883cd2178290dd43
+  metadata.gz: d62200e6002a4e01104c0f90d2b22c2f2f65fa3c8f4ef6dad676993e5313fb881ae8ae73aec58f2e3aec15838ce7ee274259049e41d50062eb166724cebaa14e
+  data.tar.gz: '08fac07805af79ea7e4f583c1c5c0a1245a25285e60364f530508a7c1392572cc97169d84291698a697370e102cc118b93e46d6a7d5a090a12833b8e8ded4313'

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 **Implemented enhancements:**
 
+- Add Comments API module [\#11](https://github.com/renehernandez/camp3/issues/11)
+- Add Comment API Module [\#19](https://github.com/renehernandez/camp3/pull/19)
+- Refactor usage around the client object [\#18](https://github.com/renehernandez/camp3/pull/18)
+
+## [v0.0.3](https://github.com/renehernandez/camp3/tree/v0.0.3) (2020-07-26)
+
+**Implemented enhancements:**
+
 - Request a new access token once it expires [\#13](https://github.com/renehernandez/camp3/issues/13)
 - Retry for new access token [\#16](https://github.com/renehernandez/camp3/pull/16)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camp3 (0.0.2)
+    camp3 (0.0.3)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
 

data/README.md

@@ -24,28 +24,46 @@ $ gem install camp3
 
 ## Usage
 
-Configuration example:
+Getting a client and configuring it:
 
 ```ruby
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.client
+
+client.configure do |config|
   config.client_id = ENV['BASECAMP3_CLIENT_ID']
   config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
   config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
   config.refresh_token = ENV['BASECAMP3_REFRESH_TOKEN']
   config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
 end
+
+projects = client.projects
 ```
 
-For more complex examples, we recommend using a client, instead of the top level `Camp3` wrapper. A `client` has a builtin mechanism to retry requests when the access token has expired and update its information (so it will use the new access token instead of the old one), as oppose to the top level `Camp3` which would request a new access token every time a request were to be made.
+Alternatively, it is possible to invoke the top-level `#configure` method to get a client:
+
+```ruby
+require 'camp3'
+
+client = Camp3.configure do |config|
+  config.client_id = ENV['BASECAMP3_CLIENT_ID']
+  config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
+  config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
+  config.refresh_token = ENV['BASECAMP3_REFRESH_TOKEN']
+  config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
+end
+
+projects = client.projects
+```
 
 Example getting list of TODOs:
 
 ```ruby
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.configure do |config|
   config.client_id = ENV['BASECAMP3_CLIENT_ID']
   config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
   config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
@@ -53,8 +71,6 @@ Camp3.configure do |config|
   config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
 end
 
-client = Camp3.client
-
 projects = client.projects
 
 projects.each do |p|
@@ -74,7 +90,7 @@ projects.each do |p|
 end
 ```
 
-For more examples, check the [examples](examples/) folder
+For more examples, check out the [examples](examples/) folder
 
 ## Contributing
 

data/examples/comments.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'camp3'
+
+client = Camp3.configure do |config|
+  config.client_id = ENV['BASECAMP3_CLIENT_ID']
+  config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
+  config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
+  config.refresh_token = ENV['BASECAMP3_REFRESH_TOKEN']
+  config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
+end
+
+projects = client.projects
+
+projects.each do |p|
+  puts "Project: #{p.name}"
+
+  message_board = client.message_board(p)
+  todoset = client.todoset(p)
+
+  # Message board and Todo set are example resources that doesn't have comments
+  puts "Message Board: #{message_board.title}, can be commented on: #{message_board.can_be_commented?}"
+  puts "Todo set: #{todoset.title}, can be commented on: #{todoset.can_be_commented?}"
+
+  # 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>')
+  comments = client.comments(list)
+  comments.each do |c|
+    puts "Comment content: #{c.content}"
+  end
+end

data/examples/messages.rb

@@ -1,6 +1,6 @@
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.configure do |config|
   config.client_id = ENV['BASECAMP3_CLIENT_ID']
   config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
   config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
@@ -8,8 +8,6 @@ Camp3.configure do |config|
   config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
 end
 
-client = Camp3.client
-
 projects = client.projects
 
 projects.each do |p|

data/examples/oauth.rb

@@ -1,13 +1,11 @@
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.configure do |config|
     config.client_id = ENV['BASECAMP3_CLIENT_ID']
     config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
     config.redirect_uri = ENV['BASECAMP3_REDIRECT_URI']
 end
 
-client = Camp3.client
-
 # Get the authorization uri
 puts client.authorization_uri
 

data/examples/obtain_acces_token.rb

@@ -1,13 +1,13 @@
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.configure do |config|
   config.client_id = ENV['BASECAMP3_CLIENT_ID']
   config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
   config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
   config.refresh_token = ENV['BASECAMP3_REFRESH_TOKEN']
 end
 
-tokens = Camp3.update_access_token!
+tokens = client.update_access_token!
 
 # Prints the new access token
 puts tokens.access_token

data/examples/todos.rb

@@ -1,6 +1,6 @@
 require 'camp3'
 
-Camp3.configure do |config|
+client = Camp3.configure do |config|
   config.client_id = ENV['BASECAMP3_CLIENT_ID']
   config.client_secret = ENV['BASECAMP3_CLIENT_SECRET']
   config.account_number = ENV['BASECAMP3_ACCOUNT_NUMBER']
@@ -8,8 +8,6 @@ Camp3.configure do |config|
   config.access_token = ENV['BASECAMP3_ACCESS_TOKEN']
 end
 
-client = Camp3.client
-
 projects = client.projects
 
 projects.each do |p|

data/lib/camp3.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'forwardable'
 require 'rack/oauth2'
 
 require "camp3/version"
@@ -14,9 +15,6 @@ require "camp3/request"
 require "camp3/client"
 
 module Camp3
-  extend Logging
-  extend Configuration
-
   # Alias for Camp3::Client.new
   #
   # @return [Camp3::Client]
@@ -24,16 +22,11 @@ module Camp3
     Camp3::Client.new(options)
   end
 
-  # Delegate to Camp3::Client
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-
-    client.send(method, *args, &block)
-  end
-
-  # Delegate to Camp3::Client
-  def self.respond_to_missing?(method_name, include_private = false)
-    client.respond_to?(method_name) || super
+  # Delegates to Camp3::Client configure method
+  #
+  # @return [Camp3::Client]
+  def self.configure(&block)
+    self.client.configure(&block)
   end
 
 end

data/lib/camp3/api/comment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Camp3::Client
+  module CommentAPI
+    def add_comment(resource, content)
+      post(resource.comments_url, override_path: true, body: { content: content }.to_json)
+    end
+
+    def comments(resource)
+      get(resource.comments_url, override_path: true)
+    end
+  end
+end

data/lib/camp3/authorization.rb

@@ -11,11 +11,11 @@ module Camp3
 
     def authz_client
       Rack::OAuth2::Client.new(
-        identifier: Camp3.client_id,
-        secret: Camp3.client_secret,
-        redirect_uri: Camp3.redirect_uri,
-        authorization_endpoint: Camp3.authz_endpoint,
-        token_endpoint: Camp3.token_endpoint,
+        identifier: @config.client_id,
+        secret: @config.client_secret,
+        redirect_uri: @config.redirect_uri,
+        authorization_endpoint: @config.authz_endpoint,
+        token_endpoint: @config.token_endpoint,
       )
     end
 
@@ -26,10 +26,9 @@ module Camp3
       # Passing secrets as query string
       token = client.access_token!(
         client_auth_method: nil,
-        client_id: Camp3.client_id,
-        client_secret: Camp3.client_secret,
+        client_id: @config.client_id,
+        client_secret: @config.client_secret,
         type: :web_server
-        # code: auth_code
       )
 
       store_tokens(token)
@@ -37,17 +36,16 @@ module Camp3
       token
     end
 
-    def update_access_token!(refresh_token = nil)
-      Camp3.logger.debug "Update access token using refresh token"
+    def update_access_token!
+      logger.debug "Update access token using refresh token"
       
-      refresh_token = Camp3.refresh_token unless refresh_token
       client = authz_client
-      client.refresh_token = refresh_token
+      client.refresh_token = @config.refresh_token
 
       token = client.access_token!(
         client_auth_method: nil,
-        client_id: Camp3.client_id,
-        client_secret: Camp3.client_secret,
+        client_id: @config.client_id,
+        client_secret: @config.client_secret,
         type: :refresh
       )
 
@@ -59,8 +57,8 @@ module Camp3
     private
 
     def store_tokens(token)
-      @access_token = token.access_token
-      @refresh_token = token.refresh_token
+      @config.access_token = token.access_token
+      @config.refresh_token = token.refresh_token
     end
   end
 end

data/lib/camp3/client.rb

@@ -4,25 +4,25 @@ module Camp3
   # Wrapper for the Camp3 REST API.
   class Client
     Dir[File.expand_path('api/*.rb', __dir__)].each { |f| require f }
+
+    extend Forwardable
     
+    def_delegators :@config, *(Configuration::VALID_OPTIONS_KEYS)
+    def_delegators :@config, :authz_endpoint, :token_endpoint, :api_endpoint, :base_api_endpoint
+
     # Keep in alphabetical order
     include Authorization
+    include CommentAPI
+    include Logging
     include MessageAPI
     include ProjectAPI
     include ResourceAPI
     include TodoAPI
 
-    # @private
-    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
-
     # Creates a new API.
     # @raise [Error:MissingCredentials]
     def initialize(options = {})
-      options = Camp3.options.merge(options)
-      
-      (Configuration::VALID_OPTIONS_KEYS).each do |key|
-        send("#{key}=", options[key]) if options[key]
-      end
+      @config = Configuration.new(options)
     end
 
     %w[get post put delete].each do |method|
@@ -37,12 +37,20 @@ module Camp3
       end
     end
 
+    # Allows setting configuration values for this client
+    # returns the client instance being configured
+    def configure
+      yield @config
+
+      self
+    end
+
     # Text representation of the client, masking private token.
     #
     # @return [String]
     def inspect
       inspected = super
-      inspected.sub! @access_token, only_show_last_four_chars(@access_token) if @access_token
+      inspected.sub! @config.access_token, only_show_last_four_chars(@config.access_token) if @config.access_token
       inspected
     end
 
@@ -57,7 +65,7 @@ module Camp3
     private
 
     def new_request
-      Request.new(@access_token, @user_agent)
+      Request.new(@config.access_token, @config.user_agent, self)
     end
 
     def only_show_last_four_chars(token)

data/lib/camp3/configuration.rb

@@ -2,7 +2,7 @@
 
 module Camp3
   # Defines constants and methods related to configuration.
-  module Configuration
+  class Configuration
     include Logging
 
     # An array of valid keys in the options hash when configuring a Basecamp::API.
@@ -22,14 +22,11 @@ module Camp3
     # @private
     attr_accessor(*VALID_OPTIONS_KEYS)
 
-    def configure
-      yield self
-    end
-
-    # Sets all configuration options to their default values
-    # when this module is extended.
-    def self.extended(base)
-      base.reset
+    def initialize(options = {})
+      options[:user_agent] ||= DEFAULT_USER_AGENT
+      VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
     end
 
     # Creates a hash of options and their values.
@@ -66,6 +63,10 @@ module Camp3
     end
 
     def base_api_endpoint
+      self.class.base_api_endpoint
+    end
+
+    def self.base_api_endpoint
       "https://3.basecampapi.com"
     end
   end

data/lib/camp3/logging.rb

@@ -15,7 +15,6 @@ module Camp3
       @logger ||= default_logger
     end
 
-
     private
 
     # Create and configure a logger

data/lib/camp3/request.rb

@@ -6,8 +6,9 @@ module Camp3
   # @private
   class Request
     include HTTParty
+    include Logging
     format :json
-    headers 'Accept' => 'application/json'
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/json'
     parser(proc { |body, _| parse(body) })
 
     module Result
@@ -16,8 +17,9 @@ module Camp3
       Valid = 'Valid'
     end
 
-    def initialize(access_token, user_agent)
+    def initialize(access_token, user_agent, client)
       @access_token = access_token
+      @client = client
 
       self.class.headers 'User-Agent' => user_agent
     end
@@ -55,7 +57,7 @@ module Camp3
         
         params[:headers] ||= {}
 
-        full_endpoint = override_path ? path : Camp3.api_endpoint + path
+        full_endpoint = override_path ? path : @client.api_endpoint + path
 
         execute_request(method, full_endpoint, params)
       end
@@ -65,9 +67,10 @@ module Camp3
 
     # Executes the request
     def execute_request(method, endpoint, params)
+      params[:headers].merge!(self.class.headers)
       params[:headers].merge!(authorization_header)
       
-      Camp3.logger.debug("Method: #{method}; URL: #{endpoint}")
+      logger.debug("Method: #{method}; URL: #{endpoint}")
       response, result = validate self.class.send(method, endpoint, params)
 
       response = extract_parsed(response) if result == Result::Valid
@@ -83,7 +86,7 @@ module Camp3
       error_klass = Error::STATUS_MAPPINGS[response.code]
 
       if error_klass == Error::Unauthorized && response.parsed_response.error.include?("OAuth token expired (old age)")
-        Camp3.logger.debug("Access token expired. Please obtain a new access token")
+        logger.debug("Access token expired. Please obtain a new access token")
         return response, Result::AccessTokenExpired
       end
 
@@ -95,7 +98,7 @@ module Camp3
     def extract_parsed(response)
       parsed = response.parsed_response
       
-      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.client = @client if parsed.respond_to?(:client=)
       parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
 
       parsed

data/lib/camp3/resource.rb

@@ -24,6 +24,14 @@ module Camp3
       data[key]
     end
 
+    # Check whether a resource can be commented on or not
+    # given the presences of `comments_count` and `comments_url` keys
+    #
+    # @return [Boolean]
+    def can_be_commented?
+      hash.key?('comments_url') && hash.key?('comments_count')
+    end
+
     private
 
     attr_reader :hash, :data
@@ -63,7 +71,7 @@ module Camp3
 
     def self.detect_type(url)
       case url
-      when /#{Camp3.base_api_endpoint}\/\d+\/projects\/\d+\.json/
+      when /#{Configuration.base_api_endpoint}\/\d+\/projects\/\d+\.json/
         return Project
       else
         return Resource

data/lib/camp3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camp3
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camp3
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -92,11 +92,13 @@ files:
 - bin/console
 - bin/setup
 - camp3.gemspec
+- examples/comments.rb
 - examples/messages.rb
 - examples/oauth.rb
 - examples/obtain_acces_token.rb
 - examples/todos.rb
 - lib/camp3.rb
+- lib/camp3/api/comment.rb
 - lib/camp3/api/message.rb
 - lib/camp3/api/project.rb
 - lib/camp3/api/resource.rb