smartsheet 1.0.0.beta.0 → 1.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba8152aff078b8908b76631e7260f51810e42917
-  data.tar.gz: 033b8f54c6e9ffb942d51b880b05430ea271ad8a
+  metadata.gz: 1cc15ce5cfbb1822363ff37ab362868d9395fcc5
+  data.tar.gz: 245e9e285c496ed02d8449441b020edfaeaa1cee
 SHA512:
-  metadata.gz: 99d13d7fec3c7713e1bfd211179d89a505a8e9f5b0a8a3a849092ed79a00d2a9118cc83b7435e12881a5120f4056427b05d1853fd8c8a59a5afba234c0f524eb
-  data.tar.gz: d35920faee71c41a5e3af38cc426a08e2e9d4127be78a50c4eee80e1f2803b2139af13526c54aaf46aa0c781385a4bafc5159c6ad0f551ebd3086f0a07eeda52
+  metadata.gz: 33892c0f87e810d3b7a22dd66dbf8f60418717e81f6e962aee171a014845a9f72244525e96087a9d69be00a2087672ca14df55d545a87b244ed43f2651e94d98
+  data.tar.gz: 89778f43258fb0c72aa28a5f3dd2115bfb9ef2a179fcd27e48ba6f649813c1fc9fac06de28cee897714ba316a588d1c15324386e0d457796111a53007373a7e6

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /.idea/
+*.gem

data/README.md

@@ -1,4 +1,4 @@
-# Smartsheet Ruby SDK [![Build Status](https://travis-ci.org/smartsheet-platform/smartsheet-ruby-sdk.svg?branch=master)](https://travis-ci.org/smartsheet-platform/smartsheet-ruby-sdk) [![Coverage Status](https://coveralls.io/repos/github/smartsheet-platform/smartsheet-ruby-sdk/badge.svg?branch=master)](https://coveralls.io/github/smartsheet-platform/smartsheet-ruby-sdk?branch=master)
+# Smartsheet Ruby SDK [![Build Status](https://travis-ci.org/smartsheet-platform/smartsheet-ruby-sdk.svg?branch=master)](https://travis-ci.org/smartsheet-platform/smartsheet-ruby-sdk) [![Coverage Status](https://coveralls.io/repos/github/smartsheet-platform/smartsheet-ruby-sdk/badge.svg?branch=master)](https://coveralls.io/github/smartsheet-platform/smartsheet-ruby-sdk?branch=master) [![Gem Version](https://badge.fury.io/rb/smartsheet.svg)](https://badge.fury.io/rb/smartsheet)
 
 This is an SDK to simplify connecting to the [Smartsheet API](http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
 
@@ -62,7 +62,7 @@ rescue Smartsheet::ApiError => e
 end
 ```
 
-See the [read-write-sheet](read-write-sheet/read_write_sheet.rb) example to see a more robust use case in action.
+See the [read-write-sheet](https://github.com/smartsheet-samples/ruby-read-write-sheet) example to see a more robust use case in action.
 
 ## Basic Configuration
 
@@ -76,7 +76,8 @@ When creating the client object, pass an object with any of the following proper
 Smartsheet expects a standard Ruby logger.  For example, to enable console logging of warnings and above, make a call such as the following:
 
 ```ruby
-logger = Logger.new(STDOUT, Logger::WARN)
+logger = Logger.new(STDOUT)
+logger.level = Logger::WARN
 smartsheet = Smartsheet::Client.new(logger: logger)
 ```
 
@@ -133,7 +134,7 @@ If you have any questions or issues with this SDK please post on [Stack Overflow
 
 Each specific release is available for download via [GitHub](https://github.com/smartsheet-platform/smartsheet-ruby-sdk/tags).
 
-**v1.0.0.beta.0 (October 2017)**
+**v1.0.0.beta (October 2017)**
 Beta release of the Smartsheet SDK for Ruby
 
 *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/api/request_logger.rb

@@ -4,16 +4,19 @@ module Smartsheet
   module API
     class Censor
       EXPOSED_CHARS = 4
+      KEY_TO_STRING = ->(k){ k.to_s }
+      KEY_TO_DOWNCASE_STRING = ->(k){ k.to_s.downcase }
 
       def initialize(*blacklist)
         @blacklist = Set.new(blacklist)
       end
 
-      def censor_hash(h)
-        h.collect do |(k, v)|
-          new_v = blacklist.include?(k.to_s) ? censor(v) : v
-          [k, new_v]
-        end.to_h
+      def censor_hash(h, case_insensitive: false)
+        if case_insensitive
+          _censor_hash(h, KEY_TO_DOWNCASE_STRING, downcased_blacklist)
+        else
+          _censor_hash(h, KEY_TO_STRING, blacklist)
+        end
       end
 
       def censor(str)
@@ -24,6 +27,21 @@ module Smartsheet
 
       private
 
+      def _censor_hash(h, key_transform, cased_blacklist)
+        h.collect do |(k, v)|
+          new_v =
+              cased_blacklist.include?(key_transform.call(k)) ?
+                  censor(v) :
+                  v
+
+          [k, new_v]
+        end.to_h
+      end
+
+      def downcased_blacklist
+        blacklist.collect { |x| x.downcase }
+      end
+
       attr_reader :blacklist
     end
 
@@ -72,7 +90,7 @@ module Smartsheet
       attr_reader :logger, :log_full_body
 
       def log_request_basics(level, request)
-        logger.log(level) { "Request: #{request.method} #{build_logging_url(request)}" }
+        logger.log(level) { "Request: #{request.method.upcase} #{build_logging_url(request)}" }
       end
 
       def build_logging_url(request)
@@ -99,7 +117,8 @@ module Smartsheet
       end
 
       def log_headers(context, req_or_resp)
-        logger.debug { "#{context} Headers: #{HEADER_CENSOR.censor_hash(req_or_resp.headers)}" }
+        censored_hash = HEADER_CENSOR.censor_hash(req_or_resp.headers, case_insensitive: true)
+        logger.debug { "#{context} Headers: #{censored_hash}" }
       end
 
       def log_body(context, body)

data/lib/smartsheet/api/retry_net_client_decorator.rb

@@ -25,7 +25,7 @@ module Smartsheet
           response
         end
 
-        unless retried_response.success?
+        unless retried_response.success? || total_attempts < 2
           logger.log_retry_failure(total_attempts)
         end
 

data/lib/smartsheet/client.rb

@@ -46,10 +46,10 @@ module Smartsheet
 
       request_logger =
           logger ?
-              API::RequestLogger.new(logger, log_full_body) :
+              API::RequestLogger.new(logger, log_full_body: log_full_body) :
               API::MuteRequestLogger.new
 
-      token = token_env_var if token.nil?
+      token = token_env_var if token.nil? || token.empty?
 
       net_client = API::FaradayNetClient.new
 
@@ -63,7 +63,8 @@ module Smartsheet
 
       response_client = API::ResponseNetClientDecorator.new(
           retrying_client,
-          json_output: json_output
+          json_output: json_output,
+          logger: request_logger
       )
 
       @client = API::RequestClient.new(
@@ -77,6 +78,15 @@ module Smartsheet
       build_categories
     end
 
+    def inspect
+      methods = (self.public_methods - Object.methods)
+                    .sort
+                    .map {|m| ':' + m.to_s}
+                    .join(', ')
+
+      "#<Smartsheet::Client:#{self.object_id} #{methods}>"
+    end
+
     private
 
     attr_reader :client

data/lib/smartsheet/constants.rb

@@ -1,6 +1,6 @@
 module Smartsheet
   module Constants
-    VERSION = '1.0.0.beta.0'.freeze
+    VERSION = '1.0.0.beta.2'.freeze
 
     USER_AGENT = 'smartsheet-ruby-sdk'.freeze
     API_URL = 'https://api.smartsheet.com/2.0'.freeze

data/smartsheet.gemspec

@@ -12,10 +12,11 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'An SDK to simplify connecting to the Smartsheet API from Ruby applications.'
   spec.description   = <<-EOF
-    This is an SDK to simplify connecting to the [Smartsheet API](http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
-    *Please note that this SDK is beta and may change significantly in the future.*
+    This is an SDK to simplify connecting to the Smartsheet API
+    (http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
+    Please note that this SDK is beta and may change significantly in the future.
   EOF
-  spec.homepage      = 'http://smartsheet.com/developers'
+  spec.homepage      = 'https://github.com/smartsheet-platform/smartsheet-ruby-sdk'
   spec.license       = 'Apache-2.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -27,10 +28,12 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(/^(test|spec|features)/)
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '> 2.2'
+
   spec.add_dependency 'faraday', '~> 0.13.1'
   spec.add_dependency 'plissken', '~> 1.2'
   spec.add_dependency 'awrence', '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartsheet
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.0
+  version: 1.0.0.beta.2
 platform: ruby
 authors:
 - Smartsheet
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-10-10 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -179,8 +179,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 description: |2
-      This is an SDK to simplify connecting to the [Smartsheet API](http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
-      *Please note that this SDK is beta and may change significantly in the future.*
+      This is an SDK to simplify connecting to the Smartsheet API
+      (http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
+      Please note that this SDK is beta and may change significantly in the future.
 email: api@smartsheet.com
 executables: []
 extensions: []
@@ -249,10 +250,8 @@ files:
 - lib/smartsheet/error.rb
 - lib/smartsheet/general_request.rb
 - lib/smartsheet/version.rb
-- read-write-sheet/config.json
-- read-write-sheet/read_write_sheet.rb
 - smartsheet.gemspec
-homepage: http://smartsheet.com/developers
+homepage: https://github.com/smartsheet-platform/smartsheet-ruby-sdk
 licenses:
 - Apache-2.0
 metadata: {}
@@ -262,9 +261,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"

data/read-write-sheet/config.json

@@ -1,4 +0,0 @@
-{
-  "token": "TOKEN",
-  "sheet_id": "SHEET_ID"
-}

data/read-write-sheet/read_write_sheet.rb

@@ -1,89 +0,0 @@
-require 'smartsheet/client'
-
-
-def row_update(row_id, column_id, value)
-  {
-      id: row_id,
-      cells: [{
-                  columnId: column_id,
-                  value: value
-              }]
-  }
-end
-
-def column_map(sheet)
-  column_map = {}
-  sheet[:columns].each do |column|
-    column_map[column[:title]] = column[:id]
-  end
-
-  column_map
-end
-
-def get_cell_by_column(row, column_id)
-  row[:cells].find {|cell| cell[:column_id] == column_id}
-end
-
-def get_cell_by_column_name(row, column_name, column_map)
-  get_cell_by_column(row, column_map[column_name])
-end
-
-def build_update_complete_row(row, column_map)
-  status_cell = get_cell_by_column_name(row, 'Status', column_map)
-  remaining_cell = get_cell_by_column_name(row, 'Remaining', column_map)
-
-  if status_cell[:display_value] == 'Complete'
-    unless remaining_cell[:display_value] == '0'
-      puts "Updating row #{row[:row_number]}"
-      row_update(row[:id], remaining_cell[:column_id], 0)
-    end
-  end
-end
-
-def build_update_complete_rows_body(sheet)
-  column_map = column_map(sheet)
-  update_rows = []
-  sheet[:rows].each do |row|
-    update_row = build_update_complete_row(row, column_map)
-    update_rows.push(update_row) unless update_row.nil?
-  end
-
-  update_rows
-end
-
-def update_complete_rows(sheet_id, client)
-  sheet = client.sheets.get(sheet_id: sheet_id)
-
-  update_rows_body = build_update_complete_rows_body(sheet)
-  if update_rows_body.empty?
-    puts 'No Update Required'
-    return
-  end
-
-  client.sheets.rows.update(sheet_id: sheet[:id], body: update_rows_body)
-end
-
-def load_config(config_name)
-  file = File.open(config_name)
-
-  JSON.load(file)
-end
-
-
-config = load_config('config.json')
-
-client = Smartsheet::Client.new(token: config['token'])
-
-begin
-  update_complete_rows(config['sheet_id'], client)
-rescue Smartsheet::ApiError => e
-  puts "API returned error:"
-  puts "\terror code: #{e.error_code}"
-  puts "\tref id: #{e.ref_id}"
-  puts "\tmessage: #{e.message}"
-end
-
-
-
-
-