camper 0.0.5

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['-D', '--parallel']
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "camper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/camper.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/camper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'camper'
+  spec.version       = Camper::VERSION
+  spec.authors       = ['renehernandez']
+
+  spec.summary       = 'Ruby client for Basecamp 3 API'
+  spec.homepage      = 'https://github.com/renehernandez/camper'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.18'
+  spec.add_dependency 'rack-oauth2', '~> 1.14'
+
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+end

data/examples/comments.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'camper'
+
+client = Camper.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.auto_paginate 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)
+  idx = 0
+  comments.auto_paginate do |c|
+    puts "Comment #{idx} content: #{c.content}"
+    idx += 1
+  end
+end

data/examples/messages.rb

@@ -0,0 +1,24 @@
+require 'camper'
+
+client = Camper.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.auto_paginate do |p|
+  puts "Project: #{p.name}"
+
+  message_board = client.message_board(p)
+  puts "Message Board: #{message_board.title}"
+
+  messages = client.messages(message_board)
+
+  messages.auto_paginate do |msg|
+    puts msg.inspect
+  end
+end

data/examples/oauth.rb

@@ -0,0 +1,22 @@
+require 'camper'
+
+client = Camper.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
+
+# Get the authorization uri
+puts client.authorization_uri
+
+# Once you have received the auth code from basecamp, you can proceed with the following step
+# This will update the configuration with the corresponding tokens
+# Store the tokens in a safe place
+token = client.authorize! ENV['BASECAMP3_ACCESS_CODE']
+
+# Print refresh token
+puts token.refresh_token
+
+# Print access token
+puts token.access_token
+

data/examples/obtain_acces_token.rb

@@ -0,0 +1,13 @@
+require 'camper'
+
+client = Camper.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 = client.update_access_token!
+
+# Prints the new access token
+puts tokens.access_token

data/examples/todos.rb

@@ -0,0 +1,27 @@
+require 'camper'
+
+client = Camper.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.auto_paginate do |p|
+  puts "Project: #{p.inspect}"
+
+  puts "Todo set: #{p.todoset.inspect}"
+
+  todoset = client.todoset(p)
+
+  client.todolists(todoset).auto_paginate(5) do |list|
+    puts "Todolist: #{list.title}"
+
+    client.todos(list).auto_paginate do |todo|
+      puts todo.inspect
+    end
+  end
+end

data/lib/camper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'rack/oauth2'
+
+require 'camper/version'
+require 'camper/logging'
+require 'camper/error'
+require 'camper/configuration'
+require 'camper/authorization'
+require 'camper/resource'
+require 'camper/pagination_data'
+require 'camper/paginated_response'
+require 'camper/request'
+require 'camper/client'
+
+module Camper
+  # Alias for Camper::Client.new
+  #
+  # @return [Camper::Client]
+  def self.client(options = {})
+    Camper::Client.new(options)
+  end
+
+  # Delegates to Camper::Client configure method
+  #
+  # @return [Camper::Client]
+  def self.configure(&block)
+    client.configure(&block)
+  end
+
+end

data/lib/camper/api/comment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Camper::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/camper/api/message.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  module MessageAPI
+    def messages(message_board)
+      get(message_board.messages_url, override_path: true)
+    end
+  end
+end

data/lib/camper/api/project.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  module ProjectAPI
+
+    def projects(options = {})
+      get("/projects", options)
+    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/resource.rb

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

data/lib/camper/api/todo.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Camper::Client
+  module TodoAPI
+
+    def todolists(todoset)
+      get(todoset.todolists_url, override_path: true)
+    end
+
+    def todos(todolist, options={})
+      get(todolist.todos_url, options.merge(override_path: true))
+    end
+  end
+end

data/lib/camper/authorization.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Camper
+  module Authorization
+
+    def authorization_uri
+      client = authz_client
+
+      client.authorization_uri type: :web_server
+    end
+
+    def authz_client
+      Rack::OAuth2::Client.new(
+        identifier: @config.client_id,
+        secret: @config.client_secret,
+        redirect_uri: @config.redirect_uri,
+        authorization_endpoint: @config.authz_endpoint,
+        token_endpoint: @config.token_endpoint,
+      )
+    end
+
+    def authorize!(auth_code)
+      client = authz_client
+      client.authorization_code = auth_code
+
+      # Passing secrets as query string
+      token = client.access_token!(
+        client_auth_method: nil,
+        client_id: @config.client_id,
+        client_secret: @config.client_secret,
+        type: :web_server
+      )
+
+      store_tokens(token)
+
+      token
+    end
+
+    def update_access_token!
+      logger.debug "Update access token using refresh token"
+      
+      client = authz_client
+      client.refresh_token = @config.refresh_token
+
+      token = client.access_token!(
+        client_auth_method: nil,
+        client_id: @config.client_id,
+        client_secret: @config.client_secret,
+        type: :refresh
+      )
+
+      store_tokens(token)
+
+      token
+    end
+
+    private
+
+    def store_tokens(token)
+      @config.access_token = token.access_token
+      @config.refresh_token = token.refresh_token
+    end
+  end
+end

data/lib/camper/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Camper
+  # Wrapper for the Camper 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
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options = {})
+      @config = Configuration.new(options)
+    end
+
+    %w[get post put delete].each do |method|
+      define_method method do |path, options = {}|
+        response, result = new_request.send(method, path, options)
+        return response unless result == Request::Result::AccessTokenExpired
+
+        update_access_token!
+
+        response, = new_request.send(method, path, options)
+        response
+      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! @config.access_token, only_show_last_four_chars(@config.access_token) if @config.access_token
+      inspected
+    end
+
+    # Utility method for URL encoding of a string.
+    # Copied from https://ruby-doc.org/stdlib-2.7.0/libdoc/erb/rdoc/ERB/Util.html
+    #
+    # @return [String]
+    def url_encode(url)
+      url.to_s.b.gsub(/[^a-zA-Z0-9_\-.~]/n) { |m| sprintf('%%%02X', m.unpack1('C')) } # rubocop:disable Style/FormatString, Style/FormatStringToken
+    end
+
+    private
+
+    def new_request
+      Request.new(@config.access_token, @config.user_agent, self)
+    end
+
+    def only_show_last_four_chars(token)
+      "#{'*' * (token.size - 4)}#{token[-4..-1]}"
+    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_uri = url.gsub('3.basecamp.com', '3.basecampapi.com')
+      api_uri += '.json' unless url.end_with? '.json'
+      api_uri
+    end
+  end
+end