smartsheet 1.0.0.beta.0

data/lib/smartsheet/api/request_spec.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'awrence'
+
+module Smartsheet
+  module API
+    class RequestSpec
+      attr_reader :file_spec, :url_args, :params, :header_overrides, :body, :filename, :content_type
+      private :file_spec
+
+      def initialize(params: {}, header_overrides: {}, body: nil, file_spec: nil, **url_args)
+        @url_args = url_args
+        @params = params
+        @header_overrides = header_overrides
+        @body = body
+        @file_spec = file_spec
+      end
+
+      def filename
+        file_spec.filename
+      end
+
+      def content_type
+        file_spec.content_type
+      end
+
+      def file_length
+        file_spec.file_length
+      end
+
+      def json_body
+        if body.nil? || body.is_a?(String)
+          body
+        else
+          body.to_camelback_keys.to_json
+        end
+      end
+
+      def file_body
+        file_spec.upload_io
+      end
+    end
+  end
+end

data/lib/smartsheet/api/response_net_client_decorator.rb

@@ -0,0 +1,47 @@
+require 'plissken'
+
+require 'smartsheet/error'
+
+module Smartsheet
+  module API
+    class ResponseNetClientDecorator
+      def initialize(client, json_output: false, logger: MuteRequestLogger.new)
+        @json_output = json_output
+        @client = client
+        @logger = logger
+      end
+
+      def make_request(request)
+        parse(request, client.make_request(request))
+      end
+
+      private
+
+      attr_reader :json_output, :client, :logger
+
+      def parse(request, response)
+         if response.success?
+           logger.log_successful_response(response)
+           parse_success(response)
+         else
+           logger.log_error_response(request, response)
+           parse_failure(response)
+         end
+      end
+
+      def parse_success(response)
+        if json_output
+          response.result.to_json
+        elsif response.result.respond_to? :to_snake_keys
+          response.result.to_snake_keys
+        else
+          response.result
+        end
+      end
+
+      def parse_failure(response)
+        raise Smartsheet::ApiError.new(response)
+      end
+    end
+  end
+end

data/lib/smartsheet/api/retry_logic.rb

@@ -0,0 +1,37 @@
+require 'smartsheet/constants'
+
+module Smartsheet
+  module API
+    class RetryLogic
+      include Smartsheet::Constants
+
+      def initialize(max_retry_time: DEFAULT_MAX_RETRY_TIME, backoff_method: DEFAULT_BACKOFF_METHOD)
+        @max_retry_time = max_retry_time
+        @backoff_method = backoff_method
+      end
+
+      def run(should_retry, &method_to_run)
+        end_time = Time.now.to_i + max_retry_time
+
+        _run(method_to_run, should_retry, end_time, 0)
+      end
+
+      private
+
+      attr_reader :backoff_method, :max_retry_time
+
+      def _run(method_to_run, should_retry, end_time, iteration)
+        result = method_to_run.call(iteration)
+
+        backoff = backoff_method.call(iteration, result)
+
+        if backoff == :stop || Time.now.to_i + backoff >= end_time || !should_retry.call(result)
+          return result
+        end
+
+        sleep backoff
+        _run(method_to_run, should_retry, end_time, iteration + 1)
+      end
+    end
+  end
+end

data/lib/smartsheet/api/retry_net_client_decorator.rb

@@ -0,0 +1,36 @@
+require 'smartsheet/api/request_logger'
+
+module Smartsheet
+  module API
+    class RetryNetClientDecorator
+      SHOULD_RETRY = ->(response) { response.should_retry? }
+
+      attr_reader :client, :retrier, :logger
+      private :client, :retrier, :logger
+
+      def initialize(client, retrier, logger: MuteRequestLogger.new)
+        @client = client
+        @retrier = retrier
+        @logger = logger
+      end
+
+      def make_request(request)
+        total_attempts = 0
+
+        retried_response = retrier.run(SHOULD_RETRY) do |iteration|
+          response = client.make_request(request)
+
+          total_attempts = iteration + 1
+          logger.log_retry_attempt(request, response, total_attempts) if SHOULD_RETRY.call(response)
+          response
+        end
+
+        unless retried_response.success?
+          logger.log_retry_failure(total_attempts)
+        end
+
+        retried_response
+      end
+    end
+  end
+end

data/lib/smartsheet/api/url_builder.rb

@@ -0,0 +1,25 @@
+require 'smartsheet/constants'
+
+module Smartsheet
+  module API
+    # Methods for building Smartsheet API URLs
+    class UrlBuilder
+      def initialize(endpoint_spec, request_spec, base_url)
+        @segments = endpoint_spec.url_segments
+        @args = request_spec.url_args
+        @base_url = base_url
+      end
+
+      def build
+        segments
+          .collect { |seg| seg.is_a?(Symbol) ? args[seg] : seg }
+          .unshift(base_url)
+          .join('/')
+      end
+
+      private
+
+      attr_accessor :segments, :args, :base_url
+    end
+  end
+end

data/lib/smartsheet/client.rb

@@ -0,0 +1,115 @@
+require 'smartsheet/api/faraday_adapter/faraday_net_client'
+require 'smartsheet/api/retry_net_client_decorator'
+require 'smartsheet/api/response_net_client_decorator'
+require 'smartsheet/api/request_client'
+require 'smartsheet/api/retry_logic'
+require 'smartsheet/api/request_logger'
+require 'smartsheet/general_request'
+
+require 'smartsheet/endpoints/contacts/contacts'
+require 'smartsheet/endpoints/favorites/favorites'
+require 'smartsheet/endpoints/folders/folders'
+require 'smartsheet/endpoints/groups/groups'
+require 'smartsheet/endpoints/home/home'
+require 'smartsheet/endpoints/reports/reports'
+require 'smartsheet/endpoints/search/search'
+require 'smartsheet/endpoints/server_info/server_info'
+require 'smartsheet/endpoints/sheets/sheets'
+require 'smartsheet/endpoints/sights/sights'
+require 'smartsheet/endpoints/templates/templates'
+require 'smartsheet/endpoints/token/token'
+require 'smartsheet/endpoints/update_requests/update_requests'
+require 'smartsheet/endpoints/users/users'
+require 'smartsheet/endpoints/webhooks/webhooks'
+require 'smartsheet/endpoints/workspaces/workspaces'
+
+
+module Smartsheet
+  class Client
+    include GeneralRequest
+    include Smartsheet::Constants
+
+    attr_reader :contacts, :favorites, :folders, :groups, :home, :reports, :search, :server_info,
+                :sheets, :sights, :templates, :token, :update_requests, :users, :webhooks,
+                :workspaces
+
+    def initialize(
+        token: nil,
+        assume_user: nil,
+        json_output: false,
+        max_retry_time: nil,
+        backoff_method: nil,
+        logger: nil,
+        log_full_body: false,
+        base_url: API_URL
+    )
+
+      request_logger =
+          logger ?
+              API::RequestLogger.new(logger, log_full_body) :
+              API::MuteRequestLogger.new
+
+      token = token_env_var if token.nil?
+
+      net_client = API::FaradayNetClient.new
+
+      retry_logic = init_retry_logic(max_retry_time, backoff_method)
+
+      retrying_client = API::RetryNetClientDecorator.new(
+          net_client,
+          retry_logic,
+          logger: request_logger
+      )
+
+      response_client = API::ResponseNetClientDecorator.new(
+          retrying_client,
+          json_output: json_output
+      )
+
+      @client = API::RequestClient.new(
+          token,
+          response_client,
+          base_url,
+          assume_user: assume_user,
+          logger: request_logger
+      )
+
+      build_categories
+    end
+
+    private
+
+    attr_reader :client
+
+    def build_categories
+      @contacts = Contacts.new(client)
+      @favorites = Favorites.new(client)
+      @folders = Folders.new(client)
+      @groups = Groups.new(client)
+      @home = Home.new(client)
+      @reports = Reports.new(client)
+      @search = Search.new(client)
+      @server_info = ServerInfo.new(client)
+      @sheets = Sheets.new(client)
+      @sights = Sights.new(client)
+      @token = Token.new(client)
+      @templates = Templates.new(client)
+      @update_requests = UpdateRequests.new(client)
+      @users = Users.new(client)
+      @webhooks = Webhooks.new(client)
+      @workspaces = Workspaces.new(client)
+    end
+
+    def init_retry_logic(max_retry_time, backoff_method)
+      retry_opts = {}
+      retry_opts[:max_retry_time] = max_retry_time unless max_retry_time.nil?
+      retry_opts[:backoff_method] = backoff_method unless backoff_method.nil?
+
+      API::RetryLogic.new(**retry_opts)
+    end
+
+    def token_env_var
+      ENV['SMARTSHEET_ACCESS_TOKEN']
+    end
+  end
+end

data/lib/smartsheet/constants.rb

@@ -0,0 +1,16 @@
+module Smartsheet
+  module Constants
+    VERSION = '1.0.0.beta.0'.freeze
+
+    USER_AGENT = 'smartsheet-ruby-sdk'.freeze
+    API_URL = 'https://api.smartsheet.com/2.0'.freeze
+
+    JSON_TYPE = 'application/json'.freeze
+    EXCEL_TYPE = 'application/vnd.ms-excel'.freeze
+    PDF_TYPE = 'application/pdf'.freeze
+    CSV_TYPE = 'text/csv'.freeze
+
+    DEFAULT_MAX_RETRY_TIME = 15
+    DEFAULT_BACKOFF_METHOD = proc { |iteration, _result| 2**iteration + rand }
+  end
+end

data/lib/smartsheet/endpoints/contacts/contacts.rb

@@ -0,0 +1,29 @@
+module Smartsheet
+  class Contacts
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get(contact_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['contacts', :contact_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          contact_id: contact_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['contacts'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
+end

data/lib/smartsheet/endpoints/favorites/favorites.rb

@@ -0,0 +1,158 @@
+module Smartsheet
+  class Favorites
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def add(body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['favorites'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['favorites'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def remove_folder(folder_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['folder', :folder_id],
+          params: params,
+          header_overrides: header_overrides,
+          folder_id: folder_id
+      )
+    end
+
+    def remove_report(report_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['report', :report_id],
+          params: params,
+          header_overrides: header_overrides,
+          report_id: report_id
+      )
+    end
+
+    def remove_sheet(sheet_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['sheet', :sheet_id],
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id
+      )
+    end
+
+    def remove_sight(sight_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['sights', :sight_id],
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+    end
+
+    def remove_template(template_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['template', :template_id],
+          params: params,
+          header_overrides: header_overrides,
+          template_id: template_id
+      )
+    end
+
+    def remove_workspace(workspace_id:, params: {}, header_overrides: {})
+      remove_favorite(
+          url: ['workspace', :workspace_id],
+          params: params,
+          header_overrides: header_overrides,
+          workspace_id: workspace_id
+      )
+    end
+
+    def remove_folders(folder_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['folder'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: folder_ids
+      )
+    end
+
+    def remove_reports(report_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['report'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: report_ids
+      )
+    end
+
+    def remove_sheets(sheet_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['sheet'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: sheet_ids
+      )
+    end
+
+    def remove_sights(sight_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['sights'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: sight_ids
+      )
+    end
+
+    def remove_templates(template_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['template'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: template_ids
+      )
+    end
+
+    def remove_workspaces(workspace_ids:, params: {}, header_overrides: {})
+      remove_favorites(
+          url: ['workspace'],
+          params: params,
+          header_overrides: header_overrides,
+          object_ids: workspace_ids
+      )
+    end
+
+    private
+
+    def remove_favorite(url:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['favorites'] + url)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def remove_favorites(object_ids:, url:, params:, header_overrides:)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['favorites'] + url)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params.merge({objectIds: object_ids.join(',')})
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
+end