camper 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 702097b0560277ca7116dea4caed2e50e34f6d6732ba0be390515931220ef24b
-  data.tar.gz: 402cc359f4b7013691c36927e26502efe14a52b222471c8e5513a1d2b8e4c106
+  metadata.gz: 1b8a4cdfcb11473573ac1bb1f600964f12f8722093a8a9446a47d1594e4a0963
+  data.tar.gz: 43810e0cf19d16b5a2a71789401758f497dfa46d43e70ea8c9e9e5a8160bcb51
 SHA512:
-  metadata.gz: 8681cda10f1bc5acc17a407d53a517bac0763758df16773952c8c84b9e7b380c5b18c7254a0d39d09dda70d505732a0c0f515d4c863adb4bab0b8471d66ef383
-  data.tar.gz: a43b2d372e1f539f68ad8ec4bfd212353305da29a72f1bb82382609e0ce2ea237b7b457b92ed0d1d54c300a7d2fa4a8a5077fd0e5b84b1d7b982bb6bd3ccf5a4
+  metadata.gz: 261ab2cdc09cae324aef2183d5bba9fa087c87337f2b7fe5e007bb91af4c2a6abb56f32a158437f2f71e1acc5670f76fe612911810402e60647c161733bf6199
+  data.tar.gz: fe517bdf6508916f6cd037424f6e95a589e1ad27303e25b385d44d51c19c722e7d47ad9d1de28bab7f2da5bbe5ffd05f8255cf4400cff980b6cb31f9594e7f59

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - 'camper.gemspec'
+    - 'lib/camper/core_extensions/object.rb'
 
 Layout/LineLength:
   Max: 120

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 **Implemented enhancements:**
 
+- Complete projects api [\#51](https://github.com/renehernandez/camper/pull/51)
+
+## [v0.0.9](https://github.com/renehernandez/camper/tree/v0.0.9) (2020-10-28)
+
+**Implemented enhancements:**
+
 - Split todos and todolists APIs [\#47](https://github.com/renehernandez/camper/pull/47)
 
 **Merged pull requests:**

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    camper (0.0.8)
+    camper (0.0.9)
+      concurrent-ruby (~> 1.1)
       httparty (~> 0.18)
       rack-oauth2 (~> 1.14)
 
@@ -87,7 +88,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     yard (0.9.25)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby

data/camper.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'httparty', '~> 0.18'
   spec.add_dependency 'rack-oauth2', '~> 1.14'
+  spec.add_dependency 'concurrent-ruby', '~> 1.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'

data/examples/people.rb

@@ -8,3 +8,4 @@ current_user = client.profile
 
 puts "Current User:\n#{current_user.inspect}"
 
+puts "People:\n#{client.people.inspect}"

data/examples/projects.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.client
+
+project = client.project(ENV['PROJECT_ID'])
+
+puts "Project name: #{project.name}"
+puts "Project description: #{project.description}"
+
+client.update_project(project, name: 'Hermes Testing', description: 'Hermes integration testing')

data/lib/camper/api/projects.rb

@@ -1,15 +1,112 @@
 # frozen_string_literal: true
 
 class Camper::Client
+  # Defines methods related to projects.
+  # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md
   module ProjectsAPI
+    # Get the projects visible to the current user
+    #
+    # @example
+    #   client.projects
+    # @example
+    #   client.projects(status: 'trashed')
+    #
+    # @param options [Hash] extra options to filter the list of todolist
+    # @return [Array<Project>]
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-all-projects
     def projects(options = {})
       get('/projects', options)
     end
 
+    # Get a project with a given id, granted they have access to it
+    #
+    # @example
+    #   client.project(82564)
+    # @example
+    #   client.project('7364183')
+    #
+    # @param id [Integet|String] id of the project to retrieve
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if id is blank (nil or empty string)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-a-project
     def project(id)
+      raise Camper::Error::InvalidParameter, id if id.blank?
+
       get("/projects/#{id}")
     end
 
+    # Create a project
+    #
+    # @example
+    #   client.create_project("Marketing Campaign")
+    # @example
+    #   client.create_project('Better Marketing Campaign', "For Client: XYZ")
+    #
+    # @param name [String] name of the project to create
+    # @param description [String] description of the project
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if name is blank (nil or empty string)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#create-a-project
+    def create_project(name, description = '')
+      raise Camper::Error::InvalidParameter, name if name.blank?
+
+      post('/projects', body: { name: name, description: description })
+    end
+
+    # Update a project
+    #  description can be set to empty by passing an empty string
+    #
+    # @example
+    #   client.update_project(12324, name: 'Retros')
+    # @example
+    #   client.update_project('157432', description: 'A new description')
+    # @example
+    #   client.update_project('157432', description: '')
+    # @example
+    #   client.update_project(my_project, name: 'A new name', description: 'A new description')
+    #
+    # @param project [Integer|String|Project] either a project object or a project id
+    # @param name [String] optional new name of the project
+    # @param description [String] optinal new description of the project
+    # @return [Project]
+    # @raise [Error::InvalidParameter] if both name and description are blank (nil or empty strings)
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#update-a-project
+    def update_project(project, name: '', description: nil)
+      if name.blank? && description.blank?
+        raise Camper::Error::InvalidParameter, 'name and description cannot both be blank'
+      end
+
+      id = project.respond_to?(:id) ? project.id : project
+
+      options = {}
+      options[:name] = name unless name.blank?
+      options[:description] = description unless description.nil?
+
+      put("/projects/#{id}", body: { **options })
+    end
+
+    # Delete a project
+    #
+    # @example
+    #   client.delete_project(12324)
+    # @example
+    #   client.delete_project('157432')
+    # @example
+    #   client.delete_project(my_project)
+    #
+    # @param project [Integer|String|Project] either a project object or a project id
+    # @raise [Error::InvalidParameter] if project param is blank
+    # @see https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#trash-a-project
+    def delete_project(project)
+      raise Camper::Error::InvalidParameter, 'project cannot be blank' if project.blank?
+
+      id = project.respond_to?(:id) ? project.id : project
+
+      delete("/projects/#{id}")
+    end
+
+    alias trash_project delete_project
+
     def message_board(project)
       board = project.message_board
       get(board.url, override_path: true)

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

@@ -139,7 +139,7 @@ module Camper
     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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camper
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - renehernandez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-10-30 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
@@ -113,6 +127,7 @@ files:
 - examples/oauth.rb
 - examples/obtain_acces_token.rb
 - examples/people.rb
+- examples/projects.rb
 - examples/todolists.rb
 - examples/todos.rb
 - lib/camper.rb
@@ -126,6 +141,7 @@ files:
 - 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