DEVOPS-247: Update example README. Address example payload tweak. Remove docker dir.

Author: seth-mg

examples/README.md

@@ -1,32 +1,36 @@
-Ruby Examples
-============
-Each example class can be run independently.
+## Endpoint Examples
 
-Each example file demonstrates one of the capabilities of the Rosette Platform.
+These examples are scripts that can be run independently to demonstrate the Rosette API functionality.
 
-A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolchain also supports it.
-
-## Running the example
-You can run your desired `_endpoint_.rb` file to see it in action.
+Each example file demonstrates one of the capabilities of the Rosette Platform. Each example, when run, prints its output to the console.
 
-`ruby _endpoint_.rb api_key(required) alternate_url(optional)`
+Here are some methods for running the examples.  Each example will also accept an optional parameter for
+overriding the default URL.  To use, place the url parameter after the key parameter.
 
-For example, run `ruby categories.js <your_key>` if you want to see the categories
-functionality demonstrated.
+A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolchain also supports it.
 
-All files require you to input your Rosette API User Key after `--key` to run.
-For example: `ruby ping.js 1234567890`
+#### Docker/Latest Version From RubyGems
+```
+git clone [email protected]:rosette-api/ruby.git
+cd ruby
+docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
 
-To run all of the examples:
-`find -maxdepth 1 -name *.rb -exec ruby {} api_key alternate_url`
+gem install rosette_api
 
-Each example, when run, prints its output to the console.
+cd /source/examples
+ruby ping.rb $API_KEY
+```
 
-## Docker ##
-A Docker image for running the examples against the compiled source library is available on Docker Hub.
+#### Docker/Latest Source
+```
+git clone [email protected]:rosette-api/ruby.git
+cd ruby
+docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
 
-Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-ruby`
+cd /source
+gem build rosette_api.gemspec
+gem install rosette_api*.gem
 
-Additional environment settings:
-`-e ALT_URL=<alternative URL>`
-`-e FILENAME=<single filename>`
+cd examples
+ruby ping.rb $API_KEY
+```

examples/address_similarity.rb

@@ -12,18 +12,18 @@
 
 begin
   address1 = AddressParameter.new(
-    'house_number': '1600',
-    'road': 'Pennsylvania Ave NW',
-    'city': 'Washington',
-    'state': 'DC',
-    'post_code': '20500'
+    house_number: '1600',
+    road: 'Pennsylvania Ave NW',
+    city: 'Washington',
+    state: 'DC',
+    post_code: '20500'
   )
   address2 = AddressParameter.new(
-    'house_number': '160',
-    'road': 'Pennsilvana Avenue',
-    'city': 'Washington',
-    'state': 'D.C.',
-    'post_code': '20500'
+    house_number: '160',
+    road: 'Pennsilvana Avenue',
+    city: 'Washington',
+    state: 'D.C.',
+    post_code: '20500'
   )
   params = AddressSimilarityParameters.new(address1, address2)
   response = rosette_api.get_address_similarity(params)