smartsheet 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d40986baa13b5cbda5dbf6bab61056dfc3e64b34
-  data.tar.gz: e8fea36ef79dd09ce22a632f5134d5561db01673
+SHA256:
+  metadata.gz: dfdb074b34d136b1e899f676f8cf8807e32bdd662d69bdc5386a8ffe7cfb0f58
+  data.tar.gz: cda02013bf2ea4e3ffa64d4aed6d5b113e0c272cf905e37a28d963584b7b975c
 SHA512:
-  metadata.gz: bc87fcc08699c74aa731c9f0c1fd04b2790abbd473ae14ccf92ee3b39a522b9f8369e3b5a5c15b1963923263b7b84d4a2b366de8241198ab6e73ddb3904c6f56
-  data.tar.gz: 54e1bc705a081fcf7809a14b11cbc43f571f61ce59cd225772d66a613397cd0318d5a574eb0b973c8622860a3496ad6f0a6560386fb3a1f03e519e4f8d881d19
+  metadata.gz: 07c7a7f66f6b3fe1b5e3bcc18c79eb99fb61462c1cf2b66284398cd24629dd96e97442d9507fa4b1142d22b807983be0d5c9e730e236b6d93b9f4c8decefe49d
+  data.tar.gz: ff81233acec8c754515b60adfa38d9e435ab4669973488e9c20a855f13bfbd1d594a7e2c9f7a3f87d605028186b55ed6a75c83c8b021e1bdb425dcd0d336844d

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /.idea/
 *.gem
+test.rb

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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

data/README.md

@@ -11,7 +11,7 @@ The SDK supports Ruby versions 2.2 or later.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'smartsheet', '>= 1.0.0'
+gem 'smartsheet', '>= 1.3.0'
 ```
 
 And then execute:
@@ -66,6 +66,28 @@ end
 
 See the [read-write-sheet](https://github.com/smartsheet-samples/ruby-read-write-sheet) example to see a more robust use case in action.
 
+## Conventions
+
+Each endpoint may take a number of keyword arguments, including the special keyword argument `body` for requests that accept a request body. Smartsheet's API Ruby documentation provides the parameters expected for each endpoint.
+
+Each endpoint also provides two optional keyword arguments:
+
+* `params` - This option is common for specifying enhancements or additional features for an API call. It specifies the query string for the call's URL.
+
+  This must be a hash of URL query string fields to their values. For example, to make a call with the query string `?include=comments&includeAll=true`, an API call would look like the following:
+
+  ```ruby
+  ...get( ..., params: {include: 'comments', includeAll: true})
+  ```
+
+* `header_overrides` - This option is less frequently used, as it overrides the HTTP headers sent by API calls on an individual basis. _Use with caution_, as some headers are required to allow the SDK to function properly.
+  
+  This must be a hash of headers to override values. For example, to make a call with a modified `Assume-User` header set to `jane.doe@smartsheet.com`, an API call would look like the following:
+
+  ```ruby
+  ...get( ..., header_overrides: {'Assume-User' => 'jane.doe@smartsheet.com'})
+  ```
+
 ## Basic Configuration
 
 When creating the client object, pass an object with any of the following properties to tune its behavior.
@@ -74,7 +96,9 @@ When creating the client object, pass an object with any of the following proper
 
 * `max_retry_time` - The maximum time in seconds to retry intermittent errors. (Defaults to 15 seconds.)
 
-* `base_url` - By default, the SDK connects to the production API URL. Provide a custom base URL to connect to other environments.
+* `base_url` - By default, the SDK connects to the production API URL. Provide a custom base URL to connect to other environments. For example, to access SmartsheetGov, the `base_url` will be `https://api.smartsheetgov.com/2.0`.
+  * To access Smartsheetgov, you will need to specify the Smartsheetgov API URI, `https://api.smartsheetgov.com/2.0/`, as the `base_url` during creation of the Smartsheet client object. The Smartsheetgov URI is defined as a constant (`GOV_API_URL`).
+
 
 ## Advanced Configuration Options
 ### Logging Configuration
@@ -158,7 +182,7 @@ To invoke the passthrough, your code can call one of the following three methods
 `response = smartsheet.request_with_file_from_path(method:, url_path:, path:, filename:, content_type:, params:, header_overrides:)`
 
 * `method`: The method to invoke, one of `:get`, `:post`, `:put`, or `:delete`
-* `url_path`: The specific API endpoint you wish to invoke. The client object base URL gets prepended to the caller’s endpoint URL argument.  For example, passing a `url_path` of `sheets/1` to a standard client would give a URL like `https://api.smartsheet.com/2.0/sheets/1`
+* `url_path`: The specific API endpoint you wish to invoke. The client object base URL gets prepended to the caller’s endpoint URL argument.
 * `body`: An optional hash of data to be passed as a JSON request body
 * `file`: An opened `File` object to read as the request body, generally for file attachment endpoints
 * `path`: The path of a file to be read as the request body, generally for file attachment endpoints
@@ -209,6 +233,6 @@ If you have any questions or issues with this SDK please post on [Stack Overflow
 
 ## Release Notes
 
-Each specific release is available for download via [GitHub](https://github.com/smartsheet-platform/smartsheet-ruby-sdk/tags).  Detailed release notes are available in [CHANGELOG.md].
+Each specific release is available for download via [GitHub](https://github.com/smartsheet-platform/smartsheet-ruby-sdk/tags). Detailed release notes are available in [CHANGELOG.md].
 
 *Note*: Minor changes that result in a patch version increment in RubyGems (such as updates to the README) will not be tagged as a Release in GitHub.

data/lib/smartsheet/constants.rb

@@ -1,9 +1,10 @@
 module Smartsheet
   module Constants
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.3.0'.freeze
 
     USER_AGENT = 'smartsheet-ruby-sdk'.freeze
     API_URL = 'https://api.smartsheet.com/2.0'.freeze
+    GOV_API_URL = 'https://api.smartsheetgov.com/2.0'.freeze
 
     JSON_TYPE = 'application/json'.freeze
     EXCEL_TYPE = 'application/vnd.ms-excel'.freeze

data/smartsheet.gemspec

@@ -45,9 +45,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'mocha', '~> 1.3'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
   spec.add_development_dependency 'reek', '~> 4.7'
-  spec.add_development_dependency 'rubycritic', '~> 3.2'
+  spec.add_development_dependency 'rubycritic', '~> 3.4'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'redcarpet', '~> 3.4'
   spec.add_development_dependency 'github-markup', '~> 1.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartsheet
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Smartsheet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-29 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -344,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An SDK to simplify connecting to the Smartsheet API from Ruby applications.