camper 0.0.6 → 0.0.11

data/lib/camper/client.rb

@@ -12,12 +12,15 @@ 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 RecordingsAPI
     include ResourceAPI
-    include TodoAPI
+    include TodolistsAPI
+    include TodosAPI
 
     # Creates a new Client instance.
     # @raise [Error:MissingCredentials]

data/lib/camper/core_extensions/object.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+# Copied from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/blank.rb
+
+require 'concurrent/map'
+
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
+  #
+  # This simplifies
+  #
+  #   !address || address.empty?
+  #
+  # to
+  #
+  #   address.blank?
+  #
+  # @return [true, false]
+  def blank?
+    respond_to?(:empty?) ? !!empty? : !self
+  end
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end
+
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
+  #
+  #    object.present? ? object : nil
+  #
+  # For example, something like
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # becomes
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
+  alias_method :blank?, :empty?
+end
+
+class String
+  BLANK_RE = /\A[[:space:]]*\z/
+  ENCODED_BLANKS = Concurrent::Map.new do |h, enc|
+    h[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
+  end
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
+  def blank?
+    # The regexp that matches blank strings is expensive. For the case of empty
+    # strings we can speed up this method (~3.5x) with an empty? call. The
+    # penalty for the rest of strings is marginal.
+    empty? ||
+      begin
+        BLANK_RE.match?(self)
+      rescue Encoding::CompatibilityError
+        ENCODED_BLANKS[self.encoding].match?(self)
+      end
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end
+
+class Time #:nodoc:
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end
+end

data/lib/camper/error.rb

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

data/lib/camper/recording_types.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Camper
+  class RecordingTypes
+    COMMENT = 'Comment'
+    DOCUMENT = 'Document'
+    MESSAGE = 'Message'
+    QUESTION_ANSWER = 'Question::Answer'
+    SCHEDULE_ENTRY = 'Schedule::Entry'
+    TODO = 'Todo'
+    TODOLIST = 'Todolist'
+    UPLOAD = 'Upload'
+
+    # rubocop:disable Style/ClassVars
+    def self.all
+      @@recordings ||= constants(false).map { |c| const_get(c) }.sort
+
+      @@recordings
+    end
+    # rubocop:enable Style/ClassVars
+  end
+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,19 +138,8 @@ 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)
+      %w[post put].include?(@method) && params.key?(:body)
     end
   end
 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.6'
+  VERSION = '0.0.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.11
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,23 +126,33 @@ files:
 - examples/messages.rb
 - examples/oauth.rb
 - examples/obtain_acces_token.rb
+- examples/people.rb
+- examples/projects.rb
+- examples/recordings.rb
+- examples/todolists.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/recordings.rb
 - lib/camper/api/resource.rb
-- lib/camper/api/todo.rb
+- lib/camper/api/todolists.rb
+- lib/camper/api/todos.rb
 - lib/camper/authorization.rb
 - lib/camper/client.rb
 - lib/camper/configuration.rb
+- lib/camper/core_extensions/object.rb
 - lib/camper/error.rb
 - lib/camper/logging.rb
 - lib/camper/paginated_response.rb
 - lib/camper/pagination_data.rb
+- lib/camper/recording_types.rb
 - 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:
@@ -152,7 +176,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

data/lib/camper/api/project.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-class Camper::Client
-  module ProjectAPI
-
-    def projects(options = {})
-      get("/projects", options)
-    end
-
-    def project(id)
-      get("/projects/#{id}")
-    end
-
-    def message_board(project)
-      board = project.message_board
-      get(board.url, override_path: true)
-    end
-
-    def todoset(project)
-      todoset = project.todoset
-      get(todoset.url, override_path: true)
-    end
-  end
-end

data/lib/camper/api/todo.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-class Camper::Client
-  module TodoAPI
-
-    # 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
-    #   client.todos(todolist)
-    # @example
-    #   client.todos(todolist, completed: true)
-    #
-    # @param todolist [Resource] the parent todoset resource
-    # @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={})
-      get(todolist.todos_url, options.merge(override_path: true))
-    end
-
-    # Create a todo within a todolist
-    #
-    # @example
-    #   client.create_todo(todolist, 'First Todo')
-    # @example
-    #   client.create_todo(
-    #     todolist,
-    #     'Program it',
-    #     description: "<div><em>Try that new language!</em></div>, due_on: "2016-05-01"
-    #   )
-    #
-    # @param todolist [Resource] the todolist where the todo is going to be created
-    # @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]
-    # @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)
-    end
-
-    # Complete a todo
-    #
-    # @example
-    #   client.complete_todo(todo)
-    #
-    # @param todo [Resource] the todo to be marked as completed
-    # @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)
-    end
-  end
-end