smartsheet 1.0.0 → 1.1.0

data/lib/smartsheet.rb

@@ -1,3 +1,3 @@
-# Bootstrap the client as the default import for the gem
-require 'smartsheet/client'
+# Bootstrap the client as the default import for the gem
+require 'smartsheet/client'
 require 'smartsheet/error'

data/lib/smartsheet/api/body_builder.rb

@@ -1,26 +1,26 @@
-module Smartsheet
-  module API
-    # Constructs bodies for accessing the Smartsheet API
-    class BodyBuilder
-      def initialize(endpoint_spec, request_spec)
-        @endpoint_spec = endpoint_spec
-        @request_spec = request_spec
-      end
-
-      def build
-        if endpoint_spec.sending_json?
-          request_spec.json_body
-        elsif endpoint_spec.sending_file?
-          request_spec.file_body
-        else
-          request_spec.body
-        end
-      end
-
-      private
-
-      attr_accessor :endpoint_spec, :request_spec
-
-    end
-  end
+module Smartsheet
+  module API
+    # Constructs bodies for accessing the Smartsheet API
+    class BodyBuilder
+      def initialize(endpoint_spec, request_spec)
+        @endpoint_spec = endpoint_spec
+        @request_spec = request_spec
+      end
+
+      def build
+        if endpoint_spec.sending_json?
+          request_spec.json_body
+        elsif endpoint_spec.sending_file?
+          request_spec.file_body
+        else
+          request_spec.body
+        end
+      end
+
+      private
+
+      attr_accessor :endpoint_spec, :request_spec
+
+    end
+  end
 end

data/lib/smartsheet/api/endpoint_spec.rb

@@ -1,36 +1,54 @@
-require_relative 'url_builder'
-
-module Smartsheet
-  module API
-    # Specification for a single endpoint's configuration
-    class EndpointSpec
-      attr_reader :method, :url_segments, :spec
-
-      def initialize(method, url, **spec)
-        @method = method
-        @url_segments = url
-        @spec = spec
-      end
-
-      def requires_auth?
-        !spec.key?(:no_auth)
-      end
-
-      def requires_body?
-        spec.key? :body_type
-      end
-
-      def sending_file?
-        requires_body? && spec[:body_type] == :file
-      end
-
-      def sending_json?
-        requires_body? && spec[:body_type] == :json
-      end
-
-      def headers
-        spec.key?(:headers) ? spec[:headers] : {}
-      end
-    end
-  end
-end
+require_relative 'url_builder'
+
+module Smartsheet
+  module API
+    # Specification for a single endpoint's configuration
+    class EndpointSpec
+      attr_reader :method, :url_segments, :spec
+
+      # @param method [Symbol] The HTTP method for the endpoint; one of
+      #   `[:get, :put, :post, :delete]`
+      #
+      # @param url_segments [Array<String, Symbol>] The segments of the endpoint URL; strings are
+      #   added as literal segments, while symbols are mapped to corresponding values in a request
+      #   specification
+      # 
+      # @param **spec [Hash{Symbol=>Object}] Optional params, the following of which are supported:
+      #
+      #    - `:no_auth` - If specified as a key, the endpoint can be called without authentication.
+      #        To preserve meaning, it is recommended to associate `:no_auth` with the value `true`.
+      #
+      #    - `:body_type` - If specified as a key, the endpoint will require a body to be provided
+      #        by the request.  When associated with `:json`, it will expect a JSON formattable
+      #        body.  When associated with `:file`, it will expect file upload parameters.
+      #
+      #    - `:headers` - When specified, this is expected to be a map of static HTTP headers that
+      #        will be attached to each request.
+      def initialize(method, url, **spec)
+        @method = method
+        @url_segments = url
+        @spec = spec
+      end
+
+      def requires_auth?
+        !spec.key?(:no_auth)
+      end
+
+      def requires_body?
+        spec.key? :body_type
+      end
+
+      def sending_file?
+        requires_body? && spec[:body_type] == :file
+      end
+
+      def sending_json?
+        requires_body? && spec[:body_type] == :json
+      end
+
+      def headers
+        spec.key?(:headers) ? spec[:headers] : {}
+      end
+    end
+  end
+end

data/lib/smartsheet/api/faraday_adapter/faraday_net_client.rb

@@ -1,43 +1,46 @@
-require 'faraday'
-require 'smartsheet/api/request'
-require 'smartsheet/api/faraday_adapter/middleware/faraday_error_translator'
-require 'smartsheet/api/faraday_adapter/middleware/response_parser'
-
-module Smartsheet
-  module API
-    # Makes calls to the Smartsheet API through Faraday
-    class FaradayNetClient
-      def initialize
-        create_connection
-      end
-
-      # Expected output:
-      # - returned Success Response
-      # - returned Error Response
-      # - thrown Request Error
-      def make_request(request)
-        response = conn.send(request.method) do |req|
-          req.url(request.url)
-          req.headers = request.headers
-          req.params = request.params
-          req.body = request.body
-        end
-
-        response.body
-      end
-
-      private
-
-      def create_connection
-        @conn = Faraday.new do |conn|
-          conn.use Middleware::FaradayErrorTranslator
-          conn.use Middleware::ResponseParser
-
-          conn.adapter Faraday.default_adapter
-        end
-      end
-
-      attr_reader :conn
-    end
-  end
+require 'faraday'
+require 'faraday_middleware'
+require 'smartsheet/api/request'
+require 'smartsheet/api/faraday_adapter/middleware/faraday_error_translator'
+require 'smartsheet/api/faraday_adapter/middleware/response_parser'
+
+module Smartsheet
+  module API
+    # Makes calls to the Smartsheet API through Faraday
+    class FaradayNetClient
+      def initialize
+        create_connection
+      end
+
+      # Expected output:
+      # - returned Success Response
+      # - returned Error Response
+      # - thrown Request Error
+      def make_request(request)
+        response = conn.send(request.method) do |req|
+          req.url(request.url)
+          req.headers = request.headers
+          req.params = request.params
+          req.body = request.body
+        end
+
+        response.body
+      end
+
+      private
+
+      def create_connection
+        @conn = Faraday.new do |conn|
+          conn.use Middleware::FaradayErrorTranslator
+          conn.use Middleware::ResponseParser
+
+          conn.use :gzip
+
+          conn.adapter Faraday.default_adapter
+        end
+      end
+
+      attr_reader :conn
+    end
+  end
 end

data/lib/smartsheet/api/faraday_adapter/faraday_response.rb

@@ -1,70 +1,70 @@
-module Smartsheet
-  module API
-    # Builds response objects from Faraday response environments
-    class FaradayResponse
-      def self.from_response_env(faraday_env)
-        if faraday_env[:body].kind_of?(Hash) && faraday_env[:body].key?(:errorCode)
-          FaradayErrorResponse.new(faraday_env[:body], faraday_env)
-        elsif faraday_env.success?
-          FaradaySuccessResponse.new(faraday_env[:body], faraday_env)
-        else
-          raise HttpResponseError.new(
-              status_code: faraday_env[:status],
-              reason_phrase: faraday_env[:reason_phrase],
-              headers: faraday_env[:response_headers],
-              message: "#{faraday_env[:status]} #{faraday_env[:reason_phrase]}"
-          )
-        end
-      end
-
-      attr_reader :status_code, :reason_phrase, :headers
-
-      def initialize(faraday_env)
-        @status_code = faraday_env[:status]
-        @reason_phrase = faraday_env[:reason_phrase]
-        @headers = faraday_env[:response_headers]
-      end
-    end
-
-    # Provides a Smartsheet error response from a Faraday response environment
-    class FaradayErrorResponse < FaradayResponse
-      RETRYABLE_ERRORS = 4001..4004
-
-      attr_reader :error_code, :message, :ref_id, :detail
-
-      def initialize(result, faraday_env)
-        super(faraday_env)
-        @error_code = result[:errorCode]
-        @message = result[:message]
-        @ref_id = result[:refId]
-        @detail = result[:detail]
-      end
-
-      def should_retry?
-        RETRYABLE_ERRORS.include? error_code
-      end
-
-      def success?
-        false
-      end
-    end
-
-    # Provides a Smartsheet success response from a Faraday response environment
-    class FaradaySuccessResponse < FaradayResponse
-      attr_reader :result
-
-      def initialize(result, faraday_env)
-        super(faraday_env)
-        @result = result
-      end
-
-      def should_retry?
-        false
-      end
-
-      def success?
-        true
-      end
-    end
-  end
-end
+module Smartsheet
+  module API
+    # Builds response objects from Faraday response environments
+    class FaradayResponse
+      def self.from_response_env(faraday_env)
+        if faraday_env[:body].kind_of?(Hash) && faraday_env[:body].key?(:errorCode)
+          FaradayErrorResponse.new(faraday_env[:body], faraday_env)
+        elsif faraday_env.success?
+          FaradaySuccessResponse.new(faraday_env[:body], faraday_env)
+        else
+          raise HttpResponseError.new(
+              status_code: faraday_env[:status],
+              reason_phrase: faraday_env[:reason_phrase],
+              headers: faraday_env[:response_headers],
+              message: "#{faraday_env[:status]} #{faraday_env[:reason_phrase]}"
+          )
+        end
+      end
+
+      attr_reader :status_code, :reason_phrase, :headers
+
+      def initialize(faraday_env)
+        @status_code = faraday_env[:status]
+        @reason_phrase = faraday_env[:reason_phrase]
+        @headers = faraday_env[:response_headers]
+      end
+    end
+
+    # Provides a Smartsheet error response from a Faraday response environment
+    class FaradayErrorResponse < FaradayResponse
+      RETRYABLE_ERRORS = 4001..4004
+
+      attr_reader :error_code, :message, :ref_id, :detail
+
+      def initialize(result, faraday_env)
+        super(faraday_env)
+        @error_code = result[:errorCode]
+        @message = result[:message]
+        @ref_id = result[:refId]
+        @detail = result[:detail]
+      end
+
+      def should_retry?
+        RETRYABLE_ERRORS.include? error_code
+      end
+
+      def success?
+        false
+      end
+    end
+
+    # Provides a Smartsheet success response from a Faraday response environment
+    class FaradaySuccessResponse < FaradayResponse
+      attr_reader :result
+
+      def initialize(result, faraday_env)
+        super(faraday_env)
+        @result = result
+      end
+
+      def should_retry?
+        false
+      end
+
+      def success?
+        true
+      end
+    end
+  end
+end

data/lib/smartsheet/api/faraday_adapter/middleware/faraday_error_translator.rb

@@ -1,21 +1,21 @@
-require 'faraday'
-require 'smartsheet/error'
-
-module Smartsheet
-  module API
-    module Middleware
-      # Raises Faraday request errors as {Smartsheet::RequestError RequestErrors}
-      class FaradayErrorTranslator < Faraday::Middleware
-        def initialize(app)
-          super(app)
-        end
-
-        def call(env)
-          @app.call(env)
-        rescue Faraday::Error => e
-          raise Smartsheet::RequestError, e
-        end
-      end
-    end
-  end
+require 'faraday'
+require 'smartsheet/error'
+
+module Smartsheet
+  module API
+    module Middleware
+      # Raises Faraday request errors as {Smartsheet::RequestError RequestErrors}
+      class FaradayErrorTranslator < Faraday::Middleware
+        def initialize(app)
+          super(app)
+        end
+
+        def call(env)
+          @app.call(env)
+        rescue Faraday::Error => e
+          raise Smartsheet::RequestError, e
+        end
+      end
+    end
+  end
 end

data/lib/smartsheet/api/faraday_adapter/middleware/response_parser.rb

@@ -1,26 +1,26 @@
-require 'faraday'
-require 'json'
-require 'smartsheet/api/faraday_adapter/faraday_response'
-
-module Smartsheet
-  module API
-    module Middleware
-      # Wraps responses into {FaradayResponse FaradayResponses}, parsing JSON bodies when applicable
-      class ResponseParser < Faraday::Middleware
-        def initialize(app)
-          super(app)
-        end
-
-        def call(env)
-          @app.call(env).on_complete do |response_env|
-            if response_env[:response_headers]['content-type'] =~ /\bjson\b/
-              response_env[:body] = JSON.parse(response_env[:body], symbolize_names: true)
-            end
-
-            response_env[:body] = FaradayResponse.from_response_env response_env
-          end
-        end
-      end
-    end
-  end
+require 'faraday'
+require 'json'
+require 'smartsheet/api/faraday_adapter/faraday_response'
+
+module Smartsheet
+  module API
+    module Middleware
+      # Wraps responses into {FaradayResponse FaradayResponses}, parsing JSON bodies when applicable
+      class ResponseParser < Faraday::Middleware
+        def initialize(app)
+          super(app)
+        end
+
+        def call(env)
+          @app.call(env).on_complete do |response_env|
+            if response_env[:response_headers]['content-type'] =~ /\bapplication\/json\b/
+              response_env[:body] = JSON.parse(response_env[:body], symbolize_names: true)
+            end
+
+            response_env[:body] = FaradayResponse.from_response_env response_env
+          end
+        end
+      end
+    end
+  end
 end