camper 0.0.7 → 0.1.0

data/lib/camper/api/recordings.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Camper
+  class Client
+    # Defines methods related to recordings.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md
+    module RecordingsAPI
+      # Get a paginated response of recordings of a given type
+      #
+      # @example
+      #   client.recordings('Todo')
+      # @example
+      #   client.recordings(
+      #     'Document',
+      #     bucket: [1,2],
+      #     status: 'archived',
+      #     sort: 'updated_at',
+      #     direction: 'asc'
+      #   )
+      #
+      # @param type [String] type of the recording
+      # @param options [Hash] extra options to filter the recordings to be resulted
+      # @return [PaginatedResponse<Resource>]
+      # @raise [Error::InvalidParameter] if type is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#get-recordings
+      def recordings(type, options = {})
+        raise Error::InvalidParameter, type unless RecordingTypes.all.include?(type)
+
+        get('/projects/recordings', query: options.merge(type: type))
+      end
+
+      # Trash a given recording
+      #
+      # @example
+      #   client.trash_recording(my_todo)
+      # @example
+      #   client.trash_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+      def trash_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/trashed")
+      end
+
+      # Archive a given recording
+      #
+      # @example
+      #   client.archive_recording(my_todo)
+      # @example
+      #   client.archive_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#archive-a-recording
+      def archive_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/archived")
+      end
+
+      # Unarchive a given recording
+      #
+      # @example
+      #   client.unarchive_recording(my_todo)
+      # @example
+      #   client.unarchive_recording(my_message)
+      #
+      # @param recording [Resource] a resource of a valid recording type
+      # @raise [Error::InvalidParameter] if type field in recording param
+      #   is not one of the allowed types
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#unarchive-a-recording
+      def unarchive_recording(recording)
+        raise Error::InvalidParameter, recording unless RecordingTypes.all.include?(recording.type)
+
+        put("/buckets/#{recording.bucket.id}/recordings/#{recording.id}/status/active")
+      end
+    end
+  end
+end

data/lib/camper/api/resource.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-class Camper::Client
-  module ResourceAPI
-    def resource(url)
-      get(url, override_path: true)
+module Camper
+  class Client
+    module ResourceAPI
+      def resource(url)
+        get(url, override_path: true)
+      end
     end
   end
 end

data/lib/camper/api/todolists.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Camper
+  class 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 [PaginatedResponse<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 = {})
+        get(todoset.todolists_url, query: options, 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 = '')
+        body = { name: name, description: description }
+
+        post(todoset.todolists_url, body: body, override_path: true)
+      end
+
+      # Update a todolist to change name and description
+      #
+      # @example
+      #   client.update_todolist(todolist, 'Launch')
+      # @example
+      #   client.update_todolist(todolist, 'Launch', "<div><em>Finish it!</em></div>")
+      # @example
+      #   client.update_todolist(todolist, 'Launch', '')
+      #
+      # @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. If not specified,
+      #   it will be set to the current description value
+      # @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 = nil)
+        body = { name: name }
+        body[:description] = description.nil? ? todolist.description : description
+
+        put(todolist.url, body: body, override_path: true)
+      end
+
+      # Trash a todolist
+      #   it calls the trash_recording endpoint under the hood
+      #
+      # @example
+      #   client.trash_todolist(todolist)
+      #
+      # @param todolist [Resource] the todolist to be trashed
+      # @raise [Error::InvalidParameter] if the type field in todolist param
+      #   is not an allowed type in the recording API
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording
+      def trash_todolist(todolist)
+        trash_recording(todolist)
+      end
+    end
+  end
+end

data/lib/camper/api/todos.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Camper
+  class Client
+    # Defines methods related to todos.
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md
+    module TodosAPI
+      PARAMETERS = %w[
+        content
+        description
+        assignee_ids
+        completion_subscriber_ids
+        notify
+        due_on
+        starts_on
+      ].freeze
+
+      # Get the todos in a todolist
+      #
+      # @example
+      #   client.todos(todolist)
+      # @example
+      #   client.todos(todolist, completed: true)
+      #
+      # @param todolist [Resource] the parent todolist 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, query: options, 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
+      #
+      # @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 parameters 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
+      # @raise [Error::InvalidParameter] if content parameter is blank
+      # @see https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do
+      def create_todo(todolist, content, options = {})
+        raise Error::InvalidParameter, content if content.blank?
+
+        post(todolist.todos_url, body: { content: content, **options }, override_path: true)
+      end
+
+      # Update a todo.
+      #
+      # @example
+      #   client.update_todo(todo, 'Todo')
+      # @example
+      #   client.update_todo(
+      #     todo,
+      #     'Program it',
+      #     description: "<div><em>Try that new language!</em></div>,
+      #     due_on: "2016-05-01",
+      #     starts_on: "2016-04-30"
+      #   )
+      #
+      # @param todo [Resource] the todo to be updated
+      # @param options [Hash] parameters to be changed. The ones that are not specified
+      #   will be set to the current values of the todo object
+      # @return [Resource]
+      # @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#update-a-to-do
+      def update_todo(todo, options)
+        body = {}.merge(options)
+        PARAMETERS.each { |p| body[p.to_sym] = todo[p] unless key_is_present?(body, p) }
+
+        put(todo.url, body: body, override_path: true)
+      end
+
+      # Complete a todo
+      #
+      # @example
+      #   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)
+      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)
+        delete("#{todo.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)
+        raise Error::InvalidParameter, position if position.to_i < 1
+
+        put("#{todo.url}/position", position: position, override_path: true)
+      end
+
+      # Trash a todo
+      #   it calls the trash_recording endpoint under the hood
+      #
+      # @example
+      #   client.trash_todo(todo)
+      #
+      # @param todo [Resource] the todo to be trashed
+      # @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/recordings.md#trash-a-recording
+      def trash_todo(todo)
+        trash_recording(todo)
+      end
+
+      private
+
+      def key_is_present?(hash, key)
+        hash.key?(key.to_sym) || hash.key?(key.to_s)
+      end
+    end
+  end
+end

data/lib/camper/client.rb

@@ -12,12 +12,17 @@ module Camper
 
     # Keep in alphabetical order
     include Authorization
-    include CommentAPI
+    include CommentsAPI
     include Logging
-    include MessageAPI
-    include ProjectAPI
+    include MessageBoardsAPI
+    include MessageTypesAPI
+    include MessagesAPI
+    include PeopleAPI
+    include ProjectsAPI
+    include RecordingsAPI
     include ResourceAPI
-    include TodoAPI
+    include TodolistsAPI
+    include TodosAPI
 
     # Creates a new Client instance.
     # @raise [Error:MissingCredentials]
@@ -41,7 +46,7 @@ module Camper
     # by yielding the config object to the block
     # @return [Camper::Client] the client instance being configured
     def configure
-      yield @config
+      yield @config if block_given?
 
       self
     end

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