smartsheet 2.77.0 → 2.101.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eae914214c09e89c42b784bae587d674d5c2773c8f23a55a5514cf2e5bf89141
-  data.tar.gz: a0494874786cea9674006c2253b9e5b61442c8f07ef861a253570fb33ad1d365
+  metadata.gz: c1447ac9c5b6ddd46a57909483d1b372ef66f94a130ca856b554008e734eb895
+  data.tar.gz: c5a7ac119de07b7de672a12fa9aa662e33c4096be5ee02d7f78ce2ed7d7f72a3
 SHA512:
-  metadata.gz: 48a942ed00e9f71795c17931e4d02cb01b17e2ea9c025d61f13cd9b5b73b4e841b1b73f55c3ef890948579db17a0897f327376d902ae2ee35f5fb2a46e5b484c
-  data.tar.gz: b8193db2c5ee289df790636ac06b437bc2c60c2849caf4acfbfe774d319cad3988a006c12e0b6cd0d41f4925acbcb76006d9291641513d9fbcc945bc08c8510c
+  metadata.gz: 750f791d71daff58364cecbcf2afcb92d0e840e41c2790137747b4098a281e31e65c6ca001e551f7fffea67da877519b756e6601a48296726ae49568dae43cdf
+  data.tar.gz: 7e3e461e0d657d20e7ebf6643a1f04751268be69c226a4d0a62e805011c6c4e01137f656b4e0fe3c1c4e0c8ea50ccbb7acc352856f7ded0211a6a05c2d5d2e8c

data/.gitignore

@@ -1,12 +1,12 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.idea/
-*.gem
-test.rb
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.gem
+test.rb

data/.rubocop.yml

@@ -1,5 +1,5 @@
-Layout/EndOfLine:
-  Enabled: false
-
-Metrics/LineLength:
+Layout/EndOfLine:
+  Enabled: false
+
+Metrics/LineLength:
   Max: 100

data/.travis.yml

@@ -1,15 +1,29 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2
-  - 2.4
-before_install:
-  - git clone https://github.com/smartsheet-platform/smartsheet-sdk-tests.git
-  - smartsheet-sdk-tests/travis_scripts/install_wiremock.sh
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - gem install bundler -v 1.15.4
-
-
-script:
-  - smartsheet-sdk-tests/travis_scripts/start_wiremock.sh
-  - rake test
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5
+before_install:
+  - git clone https://github.com/smartsheet-platform/smartsheet-sdk-tests.git
+  - smartsheet-sdk-tests/travis_scripts/install_wiremock.sh
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v 1.17.3
+
+
+script:
+- smartsheet-sdk-tests/travis_scripts/start_wiremock.sh
+- rake test
+before_deploy: "echo 'Deploying release to Rubygems'"
+deploy:
+  provider: rubygems
+  api_key:
+    secure: TMJZSpK3uHov1p0mvnOVjt75OZ3PrcwvufEESWd68K2A8DLwICbAMgC+uyf7VZV4Wg1nI5JOCrcBoty4xslHcCwAdG/HqVxV+JNsBhoFmaECv/YxaB+0QRQOhaMxIfIcindtXdguzDq162D8i1Xh4rdTTBuNwXnTYckqrpqNJ9erZ4pKFZbOr3nEhqnS+FyK7yZ2ihzsrWM7Ad/UL6x4rurvwb4+PgwoVF3Z6X3XJDYekTTs3klmGkDkMX+rhHZ54kW7l0dE2mHV2Mc60lwvDX1E1lHhCWuF3sxxr+TGWHCuT/5uskX3YYdwvGsRN17edqBrDYxE3J6lwPm7YEY75D4lHEXqipB+48HnoOemZUrQwieArDHtnba4x0Z61ftIropHYK154IX0Ieo7oQcNZdg6Zsj9mR42+WcY7Ih64i8/DfUsh2umOQ4iGlXxm8+JtybYzrG83guWQTXu97nMHIZqfmW4dgehr58hah108wruI8NEiqtUzk5ZAzH2Z4LBVXpVBRktragP+NMyRPCgSXGg4qHOkb/wsBLvaFee25Ps1+pZInvegU7TlsKZpxyt5TvS7X5yShHiZznLllDwqZ8wm36vTQbCunFkCfZxVK6/pCkPpJcISeVie4TJKVOtT93PDYI5HzSZuRQXlnfcPL4vJgo0Diw1P9NTVArtr1g=
+  gem: smartsheet
+  gemspec: smartsheet.gemspec
+  on:
+    repo: smartsheet-platform/smartsheet-ruby-sdk
+    branch: master
+    rvm: 2.7
+after_deploy: "echo 'Finished deployment process'"

data/.yardopts

@@ -1,4 +1,4 @@
---markup-provider=redcarpet
---markup=markdown
--
+--markup-provider=redcarpet
+--markup=markdown
+-
 README.md

data/ADVANCED.md

@@ -1,79 +1,79 @@
-# Advanced Topics for the Smartsheet SDK for Ruby
-
-## Event Reporting
-The following sample demonstrates best practices for consuming the event stream returned from the Smartsheet Event Reporting feature. 
-
-The sample uses the `smartsheet_client.events.get` method to request lists of events from the stream. The first request sets the `since` parameter with the point in time (i.e. event occurrence datetime) in the stream from which to start consuming events. The `since` parameter can be set with a datetime value that is either formatted as ISO 8601 (e.g. 2010-01-01T00:00:00Z) or as UNIX epoch (in which case the `numeric_dates` parameter must also be set to `True`. By default the `numeric_dates` parameter is set to `False`).
-
-To consume the next list of events after the initial list of events is returned, set the `stream_position` parameter with the `next_stream_position` attribute obtained from the previous request and don't set the `since` parameter with any values. This is because when using the `get` method, either the `since` parameter or the `stream_position` parameter should be set, but never both. 
-
-Note that the `more_available` attribute in a response indicates whether more events are immediately available for consumption. If events aren't immediately available, they may still be generating so subsequent requests should keep using the same `stream_position` value until the next list of events is retrieved.
-
-Many events have additional information available as a part of the event. That information can be accessed from the data stored in the `additional_details` attribute. Information about the additional details provided can be found [here](https://smartsheet-platform.github.io/api-docs/?ruby#event-reporting).
-
-
-```Ruby
-require 'smartsheet'
-require 'time'
-require 'date'
-require 'pp'
-
-# Initialize the client - use your access token here
-$smartsheet_client = Smartsheet::Client.new(token: '1234')
-# The `client` variable now contains access to all of the APIs
-
-today = (DateTime.now)
-date_week_ago = (today - 7).to_time.utc.iso8601 
-
-
-def get_events(params)
-    result = $smartsheet_client.events.get(params: params)
-    # pp result
-    print_new_sheet_events(result[:data])
-
-    more_events_available = result[:more_available]
-    next_stream_position = result[:next_stream_position]
-    get_next_stream_of_events(more_events_available, next_stream_position)
-end 
-
-# Subsequent calls require the streamPosition property
-def get_next_stream_of_events(more_events_available, next_stream_position)
-    params = {
-        stream_position: next_stream_position,
-        max_count: 1
-    }
-
-    if more_events_available 
-        get_events(params);
-    end
-end 
-
-# This example is looking specifically for new sheet events
-def print_new_sheet_events(data)
-    data.each do |value|
-        # Find all created sheets
-        if value[:object_type] == "SHEET" && value[:action] == "CREATE"
-            pp value
-        end
-        
-    end
-end 
-
-
-begin
-    params = {
-        since: date_week_ago,
-        max_count: 1
-    }
-
-    # The first call to the events reporting API
-    # requires the since query parameter.
-    # If you pass in an UNIX epoch date, numericDates must be true
-    get_events(params)
-
-rescue Smartsheet::ApiError => e
-  puts "Error Code: #{e.error_code}"
-  puts "Message: #{e.message}"
-  puts "Ref Id: #{e.ref_id}"
-end
+# Advanced Topics for the Smartsheet SDK for Ruby
+
+## Event Reporting
+The following sample demonstrates best practices for consuming the event stream returned from the Smartsheet Event Reporting feature. 
+
+The sample uses the `smartsheet_client.events.get` method to request lists of events from the stream. The first request sets the `since` parameter with the point in time (i.e. event occurrence datetime) in the stream from which to start consuming events. The `since` parameter can be set with a datetime value that is either formatted as ISO 8601 (e.g. 2010-01-01T00:00:00Z) or as UNIX epoch (in which case the `numeric_dates` parameter must also be set to `True`. By default the `numeric_dates` parameter is set to `False`).
+
+To consume the next list of events after the initial list of events is returned, set the `stream_position` parameter with the `next_stream_position` attribute obtained from the previous request and don't set the `since` parameter with any values. This is because when using the `get` method, either the `since` parameter or the `stream_position` parameter should be set, but never both. 
+
+Note that the `more_available` attribute in a response indicates whether more events are immediately available for consumption. If events aren't immediately available, they may still be generating so subsequent requests should keep using the same `stream_position` value until the next list of events is retrieved.
+
+Many events have additional information available as a part of the event. That information can be accessed from the data stored in the `additional_details` attribute. Information about the additional details provided can be found [here](https://smartsheet-platform.github.io/api-docs/?ruby#event-reporting).
+
+
+```Ruby
+require 'smartsheet'
+require 'time'
+require 'date'
+require 'pp'
+
+# Initialize the client - use your access token here
+$smartsheet_client = Smartsheet::Client.new(token: '1234')
+# The `client` variable now contains access to all of the APIs
+
+today = (DateTime.now)
+date_week_ago = (today - 7).to_time.utc.iso8601 
+
+
+def get_events(params)
+    result = $smartsheet_client.events.get(params: params)
+    # pp result
+    print_new_sheet_events(result[:data])
+
+    more_events_available = result[:more_available]
+    next_stream_position = result[:next_stream_position]
+    get_next_stream_of_events(more_events_available, next_stream_position)
+end 
+
+# Subsequent calls require the streamPosition property
+def get_next_stream_of_events(more_events_available, next_stream_position)
+    params = {
+        stream_position: next_stream_position,
+        max_count: 1
+    }
+
+    if more_events_available 
+        get_events(params);
+    end
+end 
+
+# This example is looking specifically for new sheet events
+def print_new_sheet_events(data)
+    data.each do |value|
+        # Find all created sheets
+        if value[:object_type] == "SHEET" && value[:action] == "CREATE"
+            pp value
+        end
+        
+    end
+end 
+
+
+begin
+    params = {
+        since: date_week_ago,
+        max_count: 1
+    }
+
+    # The first call to the events reporting API
+    # requires the since query parameter.
+    # If you pass in an UNIX epoch date, numericDates must be true
+    get_events(params)
+
+rescue Smartsheet::ApiError => e
+  puts "Error Code: #{e.error_code}"
+  puts "Message: #{e.message}"
+  puts "Ref Id: #{e.ref_id}"
+end
 ```

data/CHANGELOG.md

@@ -1,113 +1,134 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.77.0] - 2019-05-08
-- Added events endpoint to retrieve events that are occurring in your Smartsheet plan.
-
-## [1.3.0] - 2019-02-11
-- Added constant for smartsheetgov 
-- Updated documentation regarding the usage of base_url to clarify how clients can access smartsheetgov
-
-## [1.2.0] - 2018-06-29
-### Added
-- Added support for 'import sheet from XLSX, CSV file' endpoints
-
-## [1.1.0] - 2018-03-16
-### Added
-- Integration test suite (see https://github.com/smartsheet-platform/smartsheet-sdk-tests)
-- Endpoints for automation rules
-- Endpoint for 'sort rows in sheet'
-- Endpoints for cross-sheet references
-- Support for looser JSON content types in responses
-- Support for custom app name in the user agent header
-- URL constructor for requesting app authorization from a user
-- This changelog
-
-### Changed
-- Empty filenames in file-accepting endpoints are now equivalent to nil filenames
-- Specifying `Assume-User` header override in a request will now override the `assume_user` value configured in a client
-- Client now requests and handles gzipped responses
-
-### Removed
-- Unsupported `filename` and `content_type` attributes in `RequestSpec` (internal)
-
-
-## [1.0.0] - 2017-11-08
-### Added
-- Error type `Smartsheet::HttpResponseError` for HTTP failures that do not correspond to Smartsheet errors
-- Basic YARD documentation
-- Re-add support for Ruby versions ~> 2.2 (from > 2.2)
-
-### Fixed
-- Removing one or many favorite sights now uses the correct URL
-
-
-## [1.0.0.beta.2] - 2017-10-12
-### Added
-- Inspect formatting for the Smartsheet client (for interactive use)
-
-### Changed
-- Log retry failures only when retries were actually attempted, and not on non-retryable failures
-- Accept an empty string for a client token as being equivalent to a nil token
-- Adjust formatting of logs
-
-### Deprecated
-- Required Ruby versions restricted to > 2.2 (from ~> 2.2)
-
-### Removed
-- Read-write-sheet example (now available at https://github.com/smartsheet-samples/ruby-read-write-sheet)
-
-### Fixed
-- Pass the 'log full body' client configuration flag correctly
-- Log responses
-
-### Security
-- **Properly censors client tokens** by fixing the header censor to no longer be case-sensitive
-
-
-## [1.0.0.beta.1] - 2017-10-10
-### Changed
-- Set required Ruby version to ~> 2.2
-
-
-## [1.0.0.beta.0] - 2017-10-10
-### Added
-- Endpoints for sheets
-- Endpoints for rows
-- Endpoints for columns
-- Endpoints for comments
-- Endpoints for attachments
-- Endpoints for update requests
-- Endpoints for folders
-- Endpoints for home
-- Endpoints for workspaces
-- Endpoints for favorites
-- Endpoints for users
-- Endpoints for contacts
-- Endpoints for groups
-- Endpoints for reports
-- Endpoints for sights
-- Endpoints for templates
-- Endpoints for search
-- Endpoints for sharing
-- Endpoints for webhooks
-- Endpoints for server info
-- Endpoints for API token management
-- Support for making arbitrary requests
-- Support for assuming the role of a user as an administrator
-- Support for automatic request retry
-- Support for logging
-- Test suite with unit tests and two-column-accounting endpoint tests
-
-[Unreleased]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.2.0...HEAD
-[1.2.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.1.0...v1.2.0
-[1.1.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0...v1.1.0
-[1.0.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.2...v1.0.0
-[1.0.0.beta.2]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.1...v1.0.0.beta.2
-[1.0.0.beta.1]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.0...v1.0.0.beta.1
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.101.1] - 2020-12-07
+### Added
+- Support for state parameter for OAuth
+
+## [2.101.0] - 2020-09-28
+### Changed
+- Include modern Faraday 1.x as an allowed dependency
+
+## [2.86.1] - 2019-11-18
+### Added
+- Support for sheet summary endpoints
+- Missing implementation for add profile image
+
+## [2.77.2] - 2019-06-06
+### Added
+- Automated publication process to RubyGems using Travis CI
+
+## [2.77.0] - 2019-05-08
+### Added
+- Events endpoint to retrieve events that are occurring in your Smartsheet plan.
+
+## [1.3.0] - 2019-02-11
+### Added
+- Constant for smartsheetgov
+
+### Changed 
+- Documentation regarding the usage of base_url to clarify how clients can access smartsheetgov
+
+## [1.2.0] - 2018-06-29
+### Added
+- Support for 'import sheet from XLSX, CSV file' endpoints
+
+## [1.1.0] - 2018-03-16
+### Added
+- Integration test suite (see https://github.com/smartsheet-platform/smartsheet-sdk-tests)
+- Endpoints for automation rules
+- Endpoint for 'sort rows in sheet'
+- Endpoints for cross-sheet references
+- Support for looser JSON content types in responses
+- Support for custom app name in the user agent header
+- URL constructor for requesting app authorization from a user
+- This changelog
+
+### Changed
+- Empty filenames in file-accepting endpoints are now equivalent to nil filenames
+- Specifying `Assume-User` header override in a request will now override the `assume_user` value configured in a client
+- Client now requests and handles gzipped responses
+
+### Removed
+- Unsupported `filename` and `content_type` attributes in `RequestSpec` (internal)
+
+
+## [1.0.0] - 2017-11-08
+### Added
+- Error type `Smartsheet::HttpResponseError` for HTTP failures that do not correspond to Smartsheet errors
+- Basic YARD documentation
+- Re-add support for Ruby versions ~> 2.2 (from > 2.2)
+
+### Fixed
+- Removing one or many favorite sights now uses the correct URL
+
+
+## [1.0.0.beta.2] - 2017-10-12
+### Added
+- Inspect formatting for the Smartsheet client (for interactive use)
+
+### Changed
+- Log retry failures only when retries were actually attempted, and not on non-retryable failures
+- Accept an empty string for a client token as being equivalent to a nil token
+- Adjust formatting of logs
+
+### Deprecated
+- Required Ruby versions restricted to > 2.2 (from ~> 2.2)
+
+### Removed
+- Read-write-sheet example (now available at https://github.com/smartsheet-samples/ruby-read-write-sheet)
+
+### Fixed
+- Pass the 'log full body' client configuration flag correctly
+- Log responses
+
+### Security
+- **Properly censors client tokens** by fixing the header censor to no longer be case-sensitive
+
+
+## [1.0.0.beta.1] - 2017-10-10
+### Changed
+- Set required Ruby version to ~> 2.2
+
+
+## [1.0.0.beta.0] - 2017-10-10
+### Added
+- Endpoints for sheets
+- Endpoints for rows
+- Endpoints for columns
+- Endpoints for comments
+- Endpoints for attachments
+- Endpoints for update requests
+- Endpoints for folders
+- Endpoints for home
+- Endpoints for workspaces
+- Endpoints for favorites
+- Endpoints for users
+- Endpoints for contacts
+- Endpoints for groups
+- Endpoints for reports
+- Endpoints for sights
+- Endpoints for templates
+- Endpoints for search
+- Endpoints for sharing
+- Endpoints for webhooks
+- Endpoints for server info
+- Endpoints for API token management
+- Support for making arbitrary requests
+- Support for assuming the role of a user as an administrator
+- Support for automatic request retry
+- Support for logging
+- Test suite with unit tests and two-column-accounting endpoint tests
+
+[Unreleased]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.2...v1.0.0
+[1.0.0.beta.2]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.1...v1.0.0.beta.2
+[1.0.0.beta.1]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.0...v1.0.0.beta.1
 [1.0.0.beta.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/init...v1.0.0.beta.0