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

smartsheet 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/sights/sights.rb CHANGED

@@ -1,102 +1,102 @@
-require_relative 'sights_share'
-module Smartsheet
-  # Sights Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#sights API Sights Docs
-  #
-  # @!attribute [r] share
-  #   @return [SightsShare]
-  class Sights
-    attr_reader :client, :share
-    private :client
-    def initialize(client)
-      @client = client
-      @share = SightsShare.new(client)
-    end
-    def copy(sight_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sights', :sight_id, 'copy'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def delete(sight_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sights', :sight_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(sight_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights', :sight_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def move(sight_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sights', :sight_id, 'move'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_publish_status(sight_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights', :sight_id, 'publish'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def set_publish_status(sight_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sights', :sight_id, 'publish'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update(sight_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sights', :sight_id], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sight_id: sight_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require_relative 'sights_share'
+module Smartsheet
+  # Sights Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#sights API Sights Docs
+  #
+  # @!attribute [r] share
+  #   @return [SightsShare]
+  class Sights
+    attr_reader :client, :share
+    private :client
+    def initialize(client)
+      @client = client
+      @share = SightsShare.new(client)
+    end
+    def copy(sight_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sights', :sight_id, 'copy'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def delete(sight_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['sights', :sight_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(sight_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights', :sight_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def move(sight_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sights', :sight_id, 'move'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_publish_status(sight_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sights', :sight_id, 'publish'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def set_publish_status(sight_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sights', :sight_id, 'publish'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update(sight_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['sights', :sight_id], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sight_id: sight_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/sights/sights_share.rb CHANGED

@@ -1,70 +1,70 @@
-require 'smartsheet/endpoints/share/share'
-module Smartsheet
-  # Sight Sharing Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#sight-sharing API Sight Sharing Docs
-  class SightsShare
-    attr_reader :client
-    private :client
-    URL = ['sights', :sight_id]
-    def initialize(client)
-      @client = client
-    end
-    def delete(sight_id:, share_id:, params: {}, header_overrides: {})
-      delete_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          sight_id: sight_id
-      )
-    end
-    def get(sight_id:, share_id:, params: {}, header_overrides: {})
-      get_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          sight_id: sight_id
-      )
-    end
-    def list(sight_id:, params: {}, header_overrides: {})
-      list_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          sight_id: sight_id
-      )
-    end
-    def create(sight_id:, body:, params: {}, header_overrides: {})
-      create_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          sight_id: sight_id
-      )
-    end
-    def update(sight_id:, share_id:, body:, params: {}, header_overrides: {})
-      update_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          sight_id: sight_id
-      )
-    end
-    private
-    include Smartsheet::Share
-  end
+require 'smartsheet/endpoints/share/share'
+module Smartsheet
+  # Sight Sharing Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#sight-sharing API Sight Sharing Docs
+  class SightsShare
+    attr_reader :client
+    private :client
+    URL = ['sights', :sight_id]
+    def initialize(client)
+      @client = client
+    end
+    def delete(sight_id:, share_id:, params: {}, header_overrides: {})
+      delete_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+    end
+    def get(sight_id:, share_id:, params: {}, header_overrides: {})
+      get_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          sight_id: sight_id
+      )
+    end
+    def list(sight_id:, params: {}, header_overrides: {})
+      list_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          sight_id: sight_id
+      )
+    end
+    def create(sight_id:, body:, params: {}, header_overrides: {})
+      create_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sight_id: sight_id
+      )
+    end
+    def update(sight_id:, share_id:, body:, params: {}, header_overrides: {})
+      update_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          sight_id: sight_id
+      )
+    end
+    private
+    include Smartsheet::Share
+  end
 end

data/lib/smartsheet/endpoints/templates/templates.rb CHANGED

@@ -1,30 +1,30 @@
-module Smartsheet
-  # Templates Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#templates API Templates Docs
-  class Templates
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def list_public(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['templates', 'public'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['templates'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+module Smartsheet
+  # Templates Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#templates API Templates Docs
+  class Templates
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def list_public(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['templates', 'public'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['templates'])
+      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/token/token.rb CHANGED

@@ -1,61 +1,66 @@
-require 'digest'
-module Smartsheet
-  # Token Endpoints
-  #
-  # {#get} and {#refresh} do not require an existing token to call
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#token API Token Docs
-  class Token
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def get(client_id:, hash:, code:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['token'],
-          no_auth: true
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params.merge({
-                                   client_id: client_id,
-                                   code: code,
-                                   hash: hash,
-                                   grant_type: 'authorization_code'
-                               })
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def refresh(client_id:, hash:, refresh_token:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['token'],
-          no_auth: true
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params.merge({
-                                   client_id: client_id,
-                                   refresh_token: refresh_token,
-                                   hash: hash,
-                                   grant_type: 'refresh_token'
-                               })
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def revoke(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['token'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'digest'
+module Smartsheet
+  # Token Endpoints
+  #
+  # {#get} and {#refresh} do not require an existing token to call
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#token API Token Docs
+  class Token
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def build_authorization_url(client_id:, scopes:)
+      scopes_string = scopes.join('%20')
+      "https://app.smartsheet.com/b/authorize?response_type=code&client_id=#{client_id}&scope=#{scopes_string}"
+    end
+    def get(client_id:, hash:, code:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['token'],
+          no_auth: true
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params.merge({
+                                   client_id: client_id,
+                                   code: code,
+                                   hash: hash,
+                                   grant_type: 'authorization_code'
+                               })
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def refresh(client_id:, hash:, refresh_token:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['token'],
+          no_auth: true
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params.merge({
+                                   client_id: client_id,
+                                   refresh_token: refresh_token,
+                                   hash: hash,
+                                   grant_type: 'refresh_token'
+                               })
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def revoke(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['token'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end