restup 1.0.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 821def49d7ed7b1bfe9fece4bdccf8711439f3dd
-  data.tar.gz: 22a09bc07b0613224205ef9b03a499f3f05fe0e4
+  metadata.gz: 7aaee4cc3597cafbc7d621aa6e03fcbf88e2d3b5
+  data.tar.gz: 0a47d288b19a3b9d49052c86bb38ee65c2045bfc
 SHA512:
-  metadata.gz: 053726b4acc83c478528d144d47da2b8423f2da294f1c52ed35b9ab7dd3a20f97d580962c6e9a37fb555e5a82a36b577cfd591f5600232606f8bae36f20a5721
-  data.tar.gz: 66ef657596c00a2255485f48847c575262702167df22b4ef7014e1c2c1d6db4b57a84b366b294403d8d4b642db2ace5f2018ea47d5a1ed32747518845e44e146
+  metadata.gz: 7c8816e02ba2fc5e192a48bbde383073871b4186961bba063aa68d5a3c7164a9edbd5d10218aafab0e5be4df46b131f0502f45ca19eb893f9b876d700363d27e
+  data.tar.gz: 0e963d7b0d1ad86c84e96298f30f02d0580abdf766984a7400ef3b6cb0021a7a2548383641a9871452f2325553ffb70bc99628437cdcb1920ddac0d4bea31f9f

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+### Version Changelog
+1.1.3 Updated to use [Paint v. 2.0](https://github.com/janlelis/paint) gem.
+
+1.0.1 Fixes issue [#33](https://github.com/thoom/restclient/issues/33).
+
+1.0.0 RestClient => RestUp. _Finally_ out of beta.
+ - Fixes Github issue [#30](https://github.com/thoom/restclient/issues/30) by renaming RestClient to RestUp.
+ - Fixes Github issue [#28](https://github.com/thoom/restclient/issues/28). `--form` converts JSON to form data only. 
+   To use form data, manually set the header using the `-h` option or set the header in the configuration.
+ - Fixes Github issues [#24](https://github.com/thoom/restclient/issues/24) and [#25](https://github.com/thoom/restclient/issues/25). Use `--verbose` or set `flags: { display: verbose }` in config.
+ - Fixes Github issue [#31](https://github.com/thoom/restclient/issues/31). Use `-c` or `--config` to pass in another config file.
+ - Fixes Github issue [#20](https://github.com/thoom/restclient/issues/20).
+ - Fixes Github issue [#11](https://github.com/thoom/restclient/issues/11).
+
+
+0.14.3 Fixes Github issues [#21](https://github.com/thoom/restclient/issues/21) and [#26](https://github.com/thoom/restclient/issues/26). 
+You can use YAML now instead of JSON for JSON requests. Since JSON is a subset of YAML, this is not a breaking change.
+
+0.14.2 Fixes Github issue [#17](https://github.com/thoom/restclient/issues/17). It also simplifies how files or data are passed into the client.
+Breaking change because flags -f and -d have been removed. Instead just pass in with STDIN instead.
+
+0.13.0 Fixes Github issue [#13](https://github.com/thoom/restclient/issues/13). 
+Breaking change since it no longer creates a config file if one doesn't exist.
+
+0.12.1: Fixes Github issues [#12](https://github.com/thoom/restclient/issues/12) and [#19](https://github.com/thoom/restclient/issues/19). 
+If using the library class instead of the CLI, you can pass in a `Thoom::HashConfig` object,
+instead of requiring a YAML file. CLI no longer generates a deprecated warning in the Ruby 2.3.
+
+0.11.3: Adds a simple response time to the output.
+
+0.11.2: Fixes Github issue [#10](https://github.com/thoom/restclient/issues/10).
+
+0.11.1: Fixes Github issues [#2](https://github.com/thoom/restclient/issues/2), [#5](https://github.com/thoom/restclient/issues/5), [#6](https://github.com/thoom/restclient/issues/6), [#7](https://github.com/thoom/restclient/issues/7), and [#8](https://github.com/thoom/restclient/issues/8). If a configuration file is not found,
+there is now a simple wizard that will ask a few questions and then generate the config file.
+
+0.10.1: Fixes Github issues [#1](https://github.com/thoom/restclient/issues/1) and [#4](https://github.com/thoom/restclient/issues/4). `PUT`, `PATCH`, and `POST` all set a default `JSON` content type. Added `--response-only` flag.
+
+0.10.0: Fixed a bug missed where headers in the YAML file were not parsed. Changed the YAML :headers: to use a hash instead of array.
+
+0.9.3: Rewrote console output mechanism. Fixed a few bugs related to YAML configuration. Added `--response-code-only` and `--success-only` flags.
+
+0.9.0: Significant internal refactoring to the client. Also changed console coloring dependency to the `Paint` gem instead of `Colored` gem.
+
+0.8.5: Added option to save response to the filename in the content-disposition if that header is passed.
+
+0.8.4: Added option to save response to a file by passing in the -o {file} arg. For binary files, response is never output in summary.
+
+0.7.5: Added option to change the request timeout. Added option to disable TLS cert validation (Useful with self-signed certs).
+
+0.7.0: Removed dependency on Nokogiri for XML parsing.

data/README.md

@@ -31,25 +31,26 @@ To install:
 
 To run:
 
-    docker run --rm -v $PWD:/usr/src/restup thoom/restup
+    docker run --rm -v $PWD:/restup thoom/restup
 
 A sample shell script `restup`:
 
     #!/bin/bash
-    docker run --rm -v $PWD:/usr/src/restup thoom/restup "@"
+    docker run --rm -v $PWD:/restup thoom/restup "@"
 
 Console
 -------
 
     Usage: restclient [options] ENDPOINT
-            --concise                    Disables verbose output
+            --concise                    Simplified response view
             --content-disposition        For responses with a filename in the Content Disposition, save the response using that filename
             --form                       Converts JSON-formatted input and encode it as x-www-form-urlencoded
             --response-only              Only outputs the response body
             --response-code-only         Only outputs the response code
             --success-only               Only outputs whether or not the request was successful
             --cert CERTFILE              Imports cert for Client-Authentication endpoints
-        -c, --config FILE                Config file to use. Defaults to .restup.yml                                                                 -e, --env ENVIRONMENT            Sets YAML environment for the request
+        -c, --config FILE                Config file to use. Defaults to .restup.yml
+        -e, --env ENVIRONMENT            Sets YAML environment for the request
         -h, --header HEADER              Sets arbitrary header passed in format "HEADER: VALUE"
         -j, --json [c|a]                 Sets the Content-Type and/or Accept Headers to use JSON mime types (i.e. -ja)
         -m, --method                     The HTTP method to use (defaults to GET)
@@ -57,9 +58,9 @@ Console
         -p, --password PASSWORD          Password for Basic Authentication
         -u, --username USERNAME          Username for Basic Authentication
         -x, --xml [c|a]                  Sets the Content-Type and/or Accept Headers to use XML mime types (i.e. -xc)
-            --verbose                    Provides a nice UI for your API responses
+            --verbose                    Expanded response view
             --version                    Shows client version
-            --help [details]             Shows this message
+            --help [details]             Shows this help dialog
 
 YAML config
 -----------
@@ -93,11 +94,8 @@ folders.
                 Default: response_only
 
     headers:    Hash of default headers. Useful for custom headers or headers used in every request.
-                The keys for this hash are strings, not symbols like the other keys
-
     timeout:    The number of seconds to wait for a response before timing out. Default: 300
-
-    tls_verify: When using TLS, the verify mode to use.  Values: true, false.  Default: true
+    tls_verify: Whether or not to verify TLS (SSL) certificates.  Values: true, false.  Default: true
 
     xmethods:   Array of nonstandard methods that are accepted by the API. To use these methods the
                 API must support X-HTTP-Method-Override.
@@ -124,8 +122,8 @@ To use without the config:
 Submits a GET request to `http://example/api/hello/world` with Basic Auth header using the
 user and pass values in the config.
 
-It would return JSON values. If successful, the JSON would be parsed and highlighted in __:colors::success:__. If
-the an error was returned (an HTTP response code >= 400), the body would be in __:colors::error:__.
+It would return JSON values. If successful, the JSON would be parsed and highlighted in __colors['success']__. If
+the an error was returned (an HTTP response code >= 400), the body would be in __colors['error']__.
 
 ### POST Request
 
@@ -149,8 +147,8 @@ Submits a POST request to `http://example/api/hello/world` with Basic Auth heade
 user and pass values in the config. It imports the salutation.json and passes it to the API as application/json
 content type. It would also set the `X-Custom-Id` header with every request.
 
-It would return JSON values. If successful, the JSON would be parsed and highlighted in __:colors::success:__. If
-the an error was returned (an HTTP response code >= 400), the body would be in __:colors::error:__.
+It would return JSON values. If successful, the JSON would be parsed and highlighted in __colors['success']__. If
+the an error was returned (an HTTP response code >= 400), the body would be in __colors['error']__.
 
 
 Migration From RestClient

data/bin/restup

@@ -36,7 +36,7 @@ opts_builder = nil
 
 parser = OptionParser.new do |o|
   o.banner = 'Usage: restup [options] ENDPOINT'
-  o.on('--concise', 'Disables verbose output') do
+  o.on('--concise', 'Simplified response view') do
     opts[:display] = :concise
   end
 
@@ -59,7 +59,7 @@ parser = OptionParser.new do |o|
     opts[:display] = :success_only
   end
 
-  o.on('--cert CERTFILE', 'Imports cert for Client-Authentication endpoints') do |cert|
+  o.on('--cert FILE', 'Imports cert for Client-Authentication endpoints') do |cert|
     opts[:cert] = cert
   end
 
@@ -88,7 +88,7 @@ parser = OptionParser.new do |o|
     end
   end
 
-  o.on('-m', '--method METHOD', 'Save output to file passed') do |method_name|
+  o.on('-m', '--method METHOD', 'The HTTP method to use') do |method_name|
     opts[:method] = method_name
   end
 
@@ -116,7 +116,7 @@ parser = OptionParser.new do |o|
     end
   end
 
-  o.on('--verbose', 'Provides a nice UI for your API responses') do
+  o.on('--verbose', 'Expanded response view') do
     opts[:display] = :verbose
   end
 

data/lib/constants.rb

@@ -1,6 +1,8 @@
 module Thoom
   class Constants
-    VERSION   = '1.0'.freeze
+    BUILD_DATE = '2017-03-20'.freeze
+    VERSION    = '1.1.3'.freeze
+  
     MIME_JSON = 'application/json'.freeze
     MIME_XML  = 'application/xml'.freeze
   end

data/lib/output_builder.rb

@@ -90,11 +90,8 @@ flags:      Default command line options
             Default: response_only
 
 headers:    Hash of default headers. Useful for custom headers or headers used in every request.
-            The keys for this hash are strings, not symbols like the other keys
-
 timeout:    The number of seconds to wait for a response before timing out. Default: 300
-
-tls_verify: When using TLS, the verify mode to use.  Values: true, false.  Default: true
+tls_verify: Whether or not to verify TLS (SSL) certificates.  Values: true, false.  Default: true
 
 xmethods:   Array of nonstandard methods that are accepted by the API. To use these methods the
             API must support X-HTTP-Method-Override.
@@ -216,21 +213,21 @@ TEXT
       else
         body = response.body
         begin
-            body.encode!('ASCII-8BIT') if body.encoding.to_s != 'ASCII-8BIT'
-
-            body = if response['content-type'].nil?
-                     body
-                   elsif response['content-type'].include? 'json'
-                     JSON.pretty_unparse(JSON.parse(body))
-                   elsif response['content-type'].include? 'xml'
-                     xp(body)
-                   else
-                     body
-               end
-            puts Paint[body, response_color]
-          rescue EncodingError => e
-            puts Paint["RESPONSE contains non-UTF-8 data, so it's not echoed here.", colors[:info]]
-          end
+          body.encode!('ASCII-8BIT') if body.encoding.to_s != 'ASCII-8BIT'
+
+          body = if response['content-type'].nil?
+                   body
+                 elsif response['content-type'].include? 'json'
+                   JSON.pretty_unparse(JSON.parse(body))
+                 elsif response['content-type'].include? 'xml'
+                   xp(body)
+                 else
+                   body
+             end
+          puts Paint[body, response_color]
+        rescue EncodingError
+          puts Paint["RESPONSE contains non-UTF-8 data, so it's not echoed here.", colors[:info]]
+        end
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restup
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Z.d. Peacock
@@ -16,21 +16,25 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: A class and executable for interacting with RESTful web services
 email: zdp@thoomtech.com
 executables:
 - restup
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - bin/restup
@@ -50,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="