RubyGems - smartsheet - Versions diffs - 1.0.0 → 1.1.0 - Mend

smartsheet 1.0.0 → 1.1.0

Files changed (70) hide show

checksums.yaml +4 -4
data/.gitignore +11 -11
data/.rubocop.yml +4 -4
data/.travis.yml +13 -6
data/.yardopts +3 -3
data/CHANGELOG.md +103 -0
data/Gemfile +6 -6
data/LICENSE +202 -202
data/README.md +214 -141
data/Rakefile +29 -23
data/bin/console +14 -14
data/bin/setup +8 -8
data/lib/smartsheet.rb +2 -2
data/lib/smartsheet/api/body_builder.rb +25 -25
data/lib/smartsheet/api/endpoint_spec.rb +54 -36
data/lib/smartsheet/api/faraday_adapter/faraday_net_client.rb +45 -42
data/lib/smartsheet/api/faraday_adapter/faraday_response.rb +70 -70
data/lib/smartsheet/api/faraday_adapter/middleware/faraday_error_translator.rb +20 -20
data/lib/smartsheet/api/faraday_adapter/middleware/response_parser.rb +25 -25
data/lib/smartsheet/api/file_spec.rb +31 -31
data/lib/smartsheet/api/header_builder.rb +90 -84
data/lib/smartsheet/api/request.rb +42 -29
data/lib/smartsheet/api/request_client.rb +43 -27
data/lib/smartsheet/api/request_logger.rb +182 -182
data/lib/smartsheet/api/request_spec.rb +57 -44
data/lib/smartsheet/api/response_net_client_decorator.rb +54 -54
data/lib/smartsheet/api/retry_logic.rb +40 -40
data/lib/smartsheet/api/retry_net_client_decorator.rb +37 -37
data/lib/smartsheet/api/url_builder.rb +25 -25
data/lib/smartsheet/client.rb +191 -185
data/lib/smartsheet/constants.rb +15 -15
data/lib/smartsheet/endpoints/contacts/contacts.rb +30 -30
data/lib/smartsheet/endpoints/favorites/favorites.rb +159 -159
data/lib/smartsheet/endpoints/folders/folders.rb +125 -125
data/lib/smartsheet/endpoints/groups/groups.rb +83 -83
data/lib/smartsheet/endpoints/home/home.rb +20 -20
data/lib/smartsheet/endpoints/reports/reports.rb +100 -100
data/lib/smartsheet/endpoints/reports/reports_share.rb +69 -69
data/lib/smartsheet/endpoints/search/search.rb +30 -30
data/lib/smartsheet/endpoints/server_info/server_info.rb +21 -21
data/lib/smartsheet/endpoints/share/share.rb +58 -58
data/lib/smartsheet/endpoints/sheets/automation_rules.rb +56 -0
data/lib/smartsheet/endpoints/sheets/cells.rb +82 -82
data/lib/smartsheet/endpoints/sheets/columns.rb +66 -66
data/lib/smartsheet/endpoints/sheets/comments.rb +64 -64
data/lib/smartsheet/endpoints/sheets/comments_attachments.rb +78 -78
data/lib/smartsheet/endpoints/sheets/cross_sheet_references.rb +45 -0
data/lib/smartsheet/endpoints/sheets/discussions.rb +84 -84
data/lib/smartsheet/endpoints/sheets/discussions_attachments.rb +22 -22
data/lib/smartsheet/endpoints/sheets/rows.rb +106 -95
data/lib/smartsheet/endpoints/sheets/rows_attachments.rb +92 -92
data/lib/smartsheet/endpoints/sheets/sheets.rb +326 -317
data/lib/smartsheet/endpoints/sheets/sheets_attachments.rb +174 -174
data/lib/smartsheet/endpoints/sheets/sheets_share.rb +69 -69
data/lib/smartsheet/endpoints/sights/sights.rb +101 -101
data/lib/smartsheet/endpoints/sights/sights_share.rb +69 -69
data/lib/smartsheet/endpoints/templates/templates.rb +29 -29
data/lib/smartsheet/endpoints/token/token.rb +65 -60
data/lib/smartsheet/endpoints/update_requests/sent_update_requests.rb +44 -44
data/lib/smartsheet/endpoints/update_requests/update_requests.rb +74 -74
data/lib/smartsheet/endpoints/users/alternate_emails.rb +79 -79
data/lib/smartsheet/endpoints/users/users.rb +77 -77
data/lib/smartsheet/endpoints/webhooks/webhooks.rb +71 -71
data/lib/smartsheet/endpoints/workspaces/workspaces.rb +87 -87
data/lib/smartsheet/endpoints/workspaces/workspaces_share.rb +70 -70
data/lib/smartsheet/error.rb +69 -69
data/lib/smartsheet/general_request.rb +74 -74
data/lib/smartsheet/version.rb +5 -5
data/smartsheet.gemspec +54 -52
metadata +34 -3

data/lib/smartsheet/endpoints/sheets/comments.rb CHANGED

@@ -1,65 +1,65 @@
-require 'smartsheet/endpoints/sheets/comments_attachments'
-module Smartsheet
-  # Comments Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#comments API Comments Docs
-  #
-  # @!attribute [r] attachments
-  #   @return [CommentsAttachments]
-  class Comments
-    attr_reader :client, :attachments
-    private :client
-    def initialize(client)
-      @client = client
-      @attachments = CommentsAttachments.new(client)
-    end
-    def add(sheet_id:, discussion_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'discussions', :discussion_id, 'comments'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          sheet_id: sheet_id,
-          discussion_id: discussion_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update(sheet_id:, comment_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sheets', :sheet_id, 'comments', :comment_id], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def delete(sheet_id:, comment_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'comments', :comment_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(sheet_id:, comment_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'comments', :comment_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'smartsheet/endpoints/sheets/comments_attachments'
+module Smartsheet
+  # Comments Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#comments API Comments Docs
+  #
+  # @!attribute [r] attachments
+  #   @return [CommentsAttachments]
+  class Comments
+    attr_reader :client, :attachments
+    private :client
+    def initialize(client)
+      @client = client
+      @attachments = CommentsAttachments.new(client)
+    end
+    def add(sheet_id:, discussion_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'discussions', :discussion_id, 'comments'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sheet_id: sheet_id,
+          discussion_id: discussion_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update(sheet_id:, comment_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sheets', :sheet_id, 'comments', :comment_id], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def delete(sheet_id:, comment_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'comments', :comment_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(sheet_id:, comment_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'comments', :comment_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/sheets/comments_attachments.rb CHANGED

@@ -1,79 +1,79 @@
-require 'smartsheet/api/file_spec'
-module Smartsheet
-  # Comments Attachments Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#attachments API Attachments Docs
-  class CommentsAttachments
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def attach_url(sheet_id:, comment_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
-          body_type: :json
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def attach_file(
-        sheet_id:,
-        comment_id:,
-        file:,
-        filename:,
-        file_length:,
-        content_type: '',
-        params: {},
-        header_overrides: {}
-    )
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
-          body_type: :file
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          file_spec: Smartsheet::API::ObjectFileSpec.new(file, filename, file_length, content_type),
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def attach_file_from_path(
-        sheet_id:,
-        comment_id:,
-        path:,
-        filename: nil,
-        content_type: '',
-        params: {},
-        header_overrides: {}
-    )
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
-          body_type: :file
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          file_spec: Smartsheet::API::PathFileSpec.new(path, filename, content_type),
-          sheet_id: sheet_id,
-          comment_id: comment_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'smartsheet/api/file_spec'
+module Smartsheet
+  # Comments Attachments Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#attachments API Attachments Docs
+  class CommentsAttachments
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def attach_url(sheet_id:, comment_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
+          body_type: :json
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def attach_file(
+        sheet_id:,
+        comment_id:,
+        file:,
+        filename:,
+        file_length:,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
+          body_type: :file
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::ObjectFileSpec.new(file, filename, file_length, content_type),
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def attach_file_from_path(
+        sheet_id:,
+        comment_id:,
+        path:,
+        filename: nil,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['sheets', :sheet_id, 'comments', :comment_id, 'attachments'],
+          body_type: :file
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::PathFileSpec.new(path, filename, content_type),
+          sheet_id: sheet_id,
+          comment_id: comment_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/sheets/cross_sheet_references.rb ADDED

@@ -0,0 +1,45 @@
+module Smartsheet
+    # Cross-sheet References Endpoints
+    # @see http://smartsheet-platform.github.io/api-docs/?ruby#cross-sheet-references API
+    #   Cross-sheet References Docs
+    class CrossSheetReferences
+      attr_reader :client
+      private :client
+      def initialize(client)
+        @client = client
+      end
+      def create(sheet_id:, body:, params: {}, header_overrides: {})
+        endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'crosssheetreferences'], body_type: :json)
+        request_spec = Smartsheet::API::RequestSpec.new(
+            header_overrides: header_overrides,
+            params: params,
+            body: body,
+            sheet_id: sheet_id
+        )
+        client.make_request(endpoint_spec, request_spec)
+      end
+      def list(sheet_id:, params: {}, header_overrides: {})
+        endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences'])
+        request_spec = Smartsheet::API::RequestSpec.new(
+            params: params,
+            header_overrides: header_overrides,
+            sheet_id: sheet_id
+        )
+        client.make_request(endpoint_spec, request_spec)
+      end
+      def get(sheet_id:, cross_sheet_reference_id:, params: {}, header_overrides: {})
+        endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences', :cross_sheet_reference_id])
+        request_spec = Smartsheet::API::RequestSpec.new(
+            params: params,
+            header_overrides: header_overrides,
+            sheet_id: sheet_id,
+            cross_sheet_reference_id: cross_sheet_reference_id
+        )
+        client.make_request(endpoint_spec, request_spec)
+      end
+    end
+  end

data/lib/smartsheet/endpoints/sheets/discussions.rb CHANGED

@@ -1,85 +1,85 @@
-require 'smartsheet/endpoints/sheets/discussions_attachments'
-module Smartsheet
-  # Discussions Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#discussions API Discussions Docs
-  #
-  # @!attribute [r] attachments
-  #   @return [DiscussionsAttachments]
-  class Discussions
-    attr_reader :client, :attachments
-    private :client
-    def initialize(client)
-      @client = client
-      @attachments = DiscussionsAttachments.new(client)
-    end
-    def create_on_row(sheet_id:, row_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'rows', :row_id, 'discussions'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sheet_id: sheet_id,
-          row_id: row_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def create_on_sheet(sheet_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'discussions'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sheet_id: sheet_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def delete(sheet_id:, discussion_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'discussions', :discussion_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sheet_id: sheet_id,
-          discussion_id: discussion_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(sheet_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'discussions'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          sheet_id: sheet_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(sheet_id:, discussion_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'discussions', :discussion_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sheet_id: sheet_id,
-          discussion_id: discussion_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list_row_discussions(sheet_id:, row_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'rows', :row_id, 'discussions'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          sheet_id: sheet_id,
-          row_id: row_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'smartsheet/endpoints/sheets/discussions_attachments'
+module Smartsheet
+  # Discussions Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#discussions API Discussions Docs
+  #
+  # @!attribute [r] attachments
+  #   @return [DiscussionsAttachments]
+  class Discussions
+    attr_reader :client, :attachments
+    private :client
+    def initialize(client)
+      @client = client
+      @attachments = DiscussionsAttachments.new(client)
+    end
+    def create_on_row(sheet_id:, row_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'rows', :row_id, 'discussions'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sheet_id: sheet_id,
+          row_id: row_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def create_on_sheet(sheet_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'discussions'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sheet_id: sheet_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def delete(sheet_id:, discussion_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sheets', :sheet_id, 'discussions', :discussion_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id,
+          discussion_id: discussion_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(sheet_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'discussions'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          sheet_id: sheet_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(sheet_id:, discussion_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'discussions', :discussion_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id,
+          discussion_id: discussion_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list_row_discussions(sheet_id:, row_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'rows', :row_id, 'discussions'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          sheet_id: sheet_id,
+          row_id: row_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end