trailer_vote-api 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30fd6a22496288d0ac36a8705d983483ff073d54
-  data.tar.gz: f75c0572e46c36b13e1fe23a339b367806edfbaf
+SHA256:
+  metadata.gz: baf64ce0088b018665613dcc161724f231bf472d337c1211d8c4d667c071779b
+  data.tar.gz: a268451a8680cd70159046acf5b586ee79ef132ae508b9c73d16b374f33b5aba
 SHA512:
-  metadata.gz: ce9a18a3f3c02b16beb3b0863f2d4b789b7fca8c888f80440b3009c2f97625af09136bf9290574ce3c14fda2a3c99a3fcc77142ff32d03f8c3a2be5fa9550110
-  data.tar.gz: e6bad4734d466fa15601cab2724a6f3a9bc5e96ca6a0d7788f61f18110feb68955063dd8dc769f2ffc6de1f9225d823fcf493f644fa8f227da86e5899a8e30d8
+  metadata.gz: 1ce14102cbd477234327f251c29e837212df319e3306601a25e39de7706302eb53f34ed6745996c6b3895e081af55c6bff9d502c14a95372e3d16171d8427a1d
+  data.tar.gz: 4257f218530a0d488923e3eb6ea8479350356c1c8d32d066afd46e123e037ff029a9530d7bbe74e16e6eb68f76f58d9664f81e96152db018fb6fc88f34fac10f

data/.gitignore

@@ -1,13 +1,13 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/test/reports/
-/tmp/
-
-/bin/c
-/.byebug_history
-/.rakeTasks
-
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/reports/
+/tmp/
+
+/bin/c
+/.byebug_history
+/.rakeTasks
+

data/.rubocop.yml

@@ -1,29 +1,29 @@
-AllCops:
-  Include:
-    - '**/Rakefile'
-    - 'lib/**/*.rb'
-  Exclude:
-    - 'Gemfile'
-    - 'bin/**/*'
-  TargetRubyVersion: 2.4
-
-Layout/EmptyLinesAroundClassBody:
-  Enabled: false
-
-Layout/EndOfLine:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/MethodLength:
-  Max: 15
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/IfUnlessModifier:
-  Enabled: false
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - 'lib/**/*.rb'
+  Exclude:
+    - 'Gemfile'
+    - 'bin/**/*'
+  TargetRubyVersion: 2.4
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -1,56 +1,56 @@
-# 0.8.4
-
-- Add `#inspect` and `#to_s` to response errors
-- Add `#status` and `#to_i` to response errors
-- Add `UnprocessibleEntity` as defined response error (`ClientError`)
-
-# 0.8.3
-
-- Add `Issue` media create API
-
-# 0.8.2
-
-- Add a fallback if the `errors` is decoded correctly, but not the correct format.
-
-# 0.8.1
-
-- Add a fallback if the `errors` key does not exist for error messages
-- Fix decoding error messages (use symbol instead of string)
-
-# 0.8.0
-
-- Symbolize all keys to ensure interopt. with TrailerVote ingestion, and Ruby hash defaults
-- Add warning to STDERR when decoding yields a validation error (server response does not match media type)
-
-# 0.7.0
-
-- Guards network errors during all API calls
-- Add `NetworkError` and the subclasses `TimeoutError`, `ConnectionError`
-- Add `back` links to most API calls
-- Add `MediaTypeUnknown` error for decoding (and encoding) unknown media types
-- Add `application/json` fallback support for hostile server responses
-- Add `text/html` fallback support
-- Fix a bug with a missing `product` attribute
-- Fix an unsupported media type causing `ErrorsResponse` to break
-
-# 0.6.1
-
-- Always coerce body into string first because `Oj` might choke on chunked body.
-
-# 0.6.0
-
-- Add error classes for common errors
-- Add error message decoding from server (and pass onto error message)
-
-# 0.5.2
-
-- Fix a bug with the `media_types` integration
-
-# 0.5.1
-
-- Loosen Gem dependency versions to allow any minor update, except for dogfooded gems, which are allowed major updates, until they hit 1.0.0
-- Add metadata urls for gemspec
-
-# 0.5.0
-
-:baby: Initial public release
+# 0.8.4
+
+- Add `#inspect` and `#to_s` to response errors
+- Add `#status` and `#to_i` to response errors
+- Add `UnprocessibleEntity` as defined response error (`ClientError`)
+
+# 0.8.3
+
+- Add `Issue` media create API
+
+# 0.8.2
+
+- Add a fallback if the `errors` is decoded correctly, but not the correct format.
+
+# 0.8.1
+
+- Add a fallback if the `errors` key does not exist for error messages
+- Fix decoding error messages (use symbol instead of string)
+
+# 0.8.0
+
+- Symbolize all keys to ensure interopt. with TrailerVote ingestion, and Ruby hash defaults
+- Add warning to STDERR when decoding yields a validation error (server response does not match media type)
+
+# 0.7.0
+
+- Guards network errors during all API calls
+- Add `NetworkError` and the subclasses `TimeoutError`, `ConnectionError`
+- Add `back` links to most API calls
+- Add `MediaTypeUnknown` error for decoding (and encoding) unknown media types
+- Add `application/json` fallback support for hostile server responses
+- Add `text/html` fallback support
+- Fix a bug with a missing `product` attribute
+- Fix an unsupported media type causing `ErrorsResponse` to break
+
+# 0.6.1
+
+- Always coerce body into string first because `Oj` might choke on chunked body.
+
+# 0.6.0
+
+- Add error classes for common errors
+- Add error message decoding from server (and pass onto error message)
+
+# 0.5.2
+
+- Fix a bug with the `media_types` integration
+
+# 0.5.1
+
+- Loosen Gem dependency versions to allow any minor update, except for dogfooded gems, which are allowed major updates, until they hit 1.0.0
+- Add metadata urls for gemspec
+
+# 0.5.0
+
+:baby: Initial public release

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in trailer_vote-api.gemspec
-gemspec
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in trailer_vote-api.gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trailer_vote-api (0.8.4)
+    trailer_vote-api (0.9.0)
       http (>= 3.3.0, < 4.x)
       oj (>= 3.6, < 4.x)
       trailer_vote-media_types (>= 0.6.1, < 1)
@@ -30,18 +30,18 @@ GEM
     http-form_data (2.1.1)
     http_parser.rb (0.6.0)
     json (2.1.0)
-    media_types (0.6.0)
+    media_types (0.6.2)
     minitest (5.11.3)
     minitest-ci (3.4.0)
       minitest (>= 5.0.6)
-    minitest-reporters (1.3.5)
+    minitest-reporters (1.3.6)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    oj (3.6.13)
+    oj (3.7.12)
     public_suffix (3.0.3)
-    rake (10.5.0)
+    rake (12.3.2)
     ruby-progressbar (1.10.0)
     safe_yaml (1.0.4)
     simplecov (0.16.1)
@@ -49,13 +49,12 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    trailer_vote-media_types (0.8.1)
+    trailer_vote-media_types (0.11.1)
       media_types (>= 0.6.0, < 1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    unf_ext (0.0.7.5-x64-mingw32)
-    webmock (3.4.2)
+    unf_ext (0.0.7.6)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -70,10 +69,10 @@ DEPENDENCIES
   minitest (~> 5.11)
   minitest-ci (~> 3.4)
   minitest-reporters (~> 1.3)
-  rake (~> 10.5)
+  rake (~> 12.3)
   simplecov (~> 0.16)
   trailer_vote-api!
   webmock (~> 3.4)
 
 BUNDLED WITH
-   1.16.5
+   1.17.3

data/README.md

@@ -1,188 +1,188 @@
-# TrailerVote::Api
-[![Build Status](https://travis-ci.com/TrailerVote/trailervote-api-clients.svg?branch=master)](https://travis-ci.com/TrailerVote/trailervote-api-clients)
-[![Gem Version](https://badge.fury.io/rb/trailer_vote-api.svg)](https://badge.fury.io/rb/trailer_vote-api)
-[![Maintainability](https://api.codeclimate.com/v1/badges/da722ca43c5811db5926/maintainability)](https://codeclimate.com/github/TrailerVote/trailervote-api-clients/maintainability)
-[![Depfu](https://badges.depfu.com/badges/abcb16e9c6a98f7ce7ce9f8379f8b2c7/overview.svg)](https://depfu.com/github/TrailerVote/trailervote-api-clients?project_id=5890)
-
-The TrailerVote Api gem is the official interface to communicate with the TrailerVote product service. It allows you to
-keep your code simple and not deal with the HTTP suite.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'trailer_vote-api'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install trailer_vote-api
-
-## Usage
-
-By default only the configuration api calls are available and you need to require which ever calls you want to make. A call always loads it dependencies. If you want to load everything you can `require 'trailer_vote/api/autoload'`.
-
-In order to call any of the APIs, you need to configure the api first:
-```Ruby
-key = '<TrailerVote API Client key>'
-secret = '<TrailerVote API Client secret>'
-url = '<TrailerVote API environment url>'
-
-configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
-# => TrailerVote::Api::Configuration
-```
-
-The TrailerVote API Client for Ruby uses a lazy chainable API and does **NOT** make any requests until it's absolutely necessary.
-It is recommended that you re-use the configuration instance, as well as other results, in order to reduce network requests.
-
-The common interface is:
-- `#call(*args)`: Make the call and return an object that has results
-- `#data`: Return the inner data (`#to_h`) without the wrapping key
-- `#to_i`: Return the HTTP status code
-- `#to_h`: Return the response (`#call`), parsed (if parsable, like JSON) and validated (according to the media type)
-- `#etag`: Return the HTTP ETag header value, if any
-- `#links`: Return the HTTP Link header / inner `_links` as `Links` object
-
-Unless data is being posted, `#call` is not necessary:
-
-```Ruby
-configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
-configuration.links
-# => TrailerVote::Api::Links # Makes the HTTP call if necessary
-```
-
-In case of an error, a `TrailerVote::Api::Error` is raised, with subclasses defining what went wrong. If the API gives back an error (HTTP status `(400..599)`), the error is parsed and turned into a `ErrorsResponse < Error` error.
-
-## Interface
-
-Only the call available to the current link in the chain, if `required` are available on each object.
-
-### `configuration`
-You don't need to require this, it's always loaded.
-
-```Ruby
-require 'trailer_vote/api/configuration'
-
-configuration = TrailerVote::Api.configure(key: '', secret: '', url: '')
-# => TrailerVote::Api::Configuration
-```
-
-### `configuration.product.lookup`
-Used to lookup products by authority:identifier pairs. If found, returns the actual `Product::Find`.
-
-The `data` argument is wrapped in `{ product_identifiers: data }` and then needs to match `application/vnd.trailervote.product.lookup.v1+json`
-
-```Ruby
-require 'trailer_vote/api/product/lookup'
-
-lookup = configuration.product.lookup
-# => TrailerVote::Api::Product::Lookup
-
-lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }, { authority: 'tmdb', identifier: '12345678' }])
-# => TrailerVote::Api::Product::Find
-```
-
-### `configuration.product.update`
-Used to update a product. Is only available on `Product::Find`, because we require updates to be non-stale, that is you need to ensure that you are the last one updating the product, so merging data can be done correctly.
-
-The `data` argument is wrapped in `{ product: data }` and then needs to match `application/vnd.trailervote.product.v2+json`
-
-```Ruby
-require 'trailer_vote/api/product/lookup'
-require 'trailer_vote/api/product/update'
-
-lookup = configuration.product.lookup
-product = lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
-# => TrailerVote::Api::Product::Find
-
-current_product_data = product.data
-next_product_data = make_changes_to_product_data(current_product_data)
-product.update.call(data: next_product_data)
-# => TrailerVote::Api::Product::Find
-```
-
-If the update call fails with a `409 Conflict` or `412 Precondition Failed`, it means the product was updated in the meanwhile. You want to fetch the product again by doing another lookup and then running your strategy again.
-
-### `configuration.product.create`
-Creating a product is similar to looking up a product. If successful, returns an actual `Product::Find`.
-
-The `data` argument is wrapped in `{ product: data }` and then needs to match `application/vnd.trailervote.product.v2.create+json`
-
-```Ruby
-require 'trailer_vote/api/product/create'
-
-configuration.product.create(data: { title: 'My product', ... })
-# => TrailerVote::Api::Product::Find
-```
-
-### `configuration.product.<>.video.create`
-To attach an video to a product, you first need to find the product. This can be done by:
- - `configuration.product.create`: creating a new product
- - `configuration.product.lookup`: looking up an existing product
-
-Once you have it, the video operations are available on the result.
-
-The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
-
-```Ruby
-require 'trailer_vote/api/product/lookup'
-require 'trailer_vote/api/product/video/create'
-
-product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
-# => TrailerVote::Api::Product::Find
-
-product.video.create(data: { source_url: '', ... })
-# => TrailerVote::Api::Product::Video::Find
-```
-
-You can see in this example the `product` result is cached in a variable, so that if you want to create *many* videos, the product isn't looked up each call.
-
-### `configuration.product.<>.image.urls`
-Gets all the image urls for a product
-
-### `configuration.product.<>.video.create`
-To attach an video to a product, you first need to find the product. This can be done by:
- - `configuration.product.create`: creating a new product
- - `configuration.product.lookup`: looking up an existing product
-
-Once you have it, the video operations are available on the result.
-
-The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
-
-```Ruby
-require 'trailer_vote/api/product/lookup'
-require 'trailer_vote/api/product/video/create'
-
-product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
-# => TrailerVote::Api::Product::Find
-
-product.video.create(data: { source_url: '', ... })
-# => TrailerVote::Api::Product::Video::Find
-```
-
-You can see in this example the `product` result is cached in a variable, so that if you want to create *many* videos, the product isn't looked up each call.
-
-### `configuration.product.<>.video.urls`
-Gets all the image urls for a product
-
-### `configuration.product.<>.place.link`
-Links a place to a product
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
-also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
-version number in `version.rb`, and then run `bundle update trailer_vote-api` in any repository that depends on
-this gem. If you have push rights, you may call `bundle exec rake release` to create a new git tag, push
-git commits and tags, and push the `.gem` file to the rubygems gem server.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at [TrailerVote/trailervote-api-clients](https://github.com/trailervote/trailervote-api-clients)
+# TrailerVote::Api
+[![Build Status](https://travis-ci.com/TrailerVote/trailervote-api-clients.svg?branch=master)](https://travis-ci.com/TrailerVote/trailervote-api-clients)
+[![Gem Version](https://badge.fury.io/rb/trailer_vote-api.svg)](https://badge.fury.io/rb/trailer_vote-api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/da722ca43c5811db5926/maintainability)](https://codeclimate.com/github/TrailerVote/trailervote-api-clients/maintainability)
+[![Depfu](https://badges.depfu.com/badges/abcb16e9c6a98f7ce7ce9f8379f8b2c7/overview.svg)](https://depfu.com/github/TrailerVote/trailervote-api-clients?project_id=5890)
+
+The TrailerVote Api gem is the official interface to communicate with the TrailerVote product service. It allows you to
+keep your code simple and not deal with the HTTP suite.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trailer_vote-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trailer_vote-api
+
+## Usage
+
+By default only the configuration api calls are available and you need to require which ever calls you want to make. A call always loads it dependencies. If you want to load everything you can `require 'trailer_vote/api/autoload'`.
+
+In order to call any of the APIs, you need to configure the api first:
+```Ruby
+key = '<TrailerVote API Client key>'
+secret = '<TrailerVote API Client secret>'
+url = '<TrailerVote API environment url>'
+
+configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
+# => TrailerVote::Api::Configuration
+```
+
+The TrailerVote API Client for Ruby uses a lazy chainable API and does **NOT** make any requests until it's absolutely necessary.
+It is recommended that you re-use the configuration instance, as well as other results, in order to reduce network requests.
+
+The common interface is:
+- `#call(*args)`: Make the call and return an object that has results
+- `#data`: Return the inner data (`#to_h`) without the wrapping key
+- `#to_i`: Return the HTTP status code
+- `#to_h`: Return the response (`#call`), parsed (if parsable, like JSON) and validated (according to the media type)
+- `#etag`: Return the HTTP ETag header value, if any
+- `#links`: Return the HTTP Link header / inner `_links` as `Links` object
+
+Unless data is being posted, `#call` is not necessary:
+
+```Ruby
+configuration = TrailerVote::Api.configure(url: url, key: key, secret: secret)
+configuration.links
+# => TrailerVote::Api::Links # Makes the HTTP call if necessary
+```
+
+In case of an error, a `TrailerVote::Api::Error` is raised, with subclasses defining what went wrong. If the API gives back an error (HTTP status `(400..599)`), the error is parsed and turned into a `ErrorsResponse < Error` error.
+
+## Interface
+
+Only the call available to the current link in the chain, if `required` are available on each object.
+
+### `configuration`
+You don't need to require this, it's always loaded.
+
+```Ruby
+require 'trailer_vote/api/configuration'
+
+configuration = TrailerVote::Api.configure(key: '', secret: '', url: '')
+# => TrailerVote::Api::Configuration
+```
+
+### `configuration.product.lookup`
+Used to lookup products by authority:identifier pairs. If found, returns the actual `Product::Find`.
+
+The `data` argument is wrapped in `{ product_identifiers: data }` and then needs to match `application/vnd.trailervote.product.lookup.v1+json`
+
+```Ruby
+require 'trailer_vote/api/product/lookup'
+
+lookup = configuration.product.lookup
+# => TrailerVote::Api::Product::Lookup
+
+lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }, { authority: 'tmdb', identifier: '12345678' }])
+# => TrailerVote::Api::Product::Find
+```
+
+### `configuration.product.update`
+Used to update a product. Is only available on `Product::Find`, because we require updates to be non-stale, that is you need to ensure that you are the last one updating the product, so merging data can be done correctly.
+
+The `data` argument is wrapped in `{ product: data }` and then needs to match `application/vnd.trailervote.product.v2+json`
+
+```Ruby
+require 'trailer_vote/api/product/lookup'
+require 'trailer_vote/api/product/update'
+
+lookup = configuration.product.lookup
+product = lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
+# => TrailerVote::Api::Product::Find
+
+current_product_data = product.data
+next_product_data = make_changes_to_product_data(current_product_data)
+product.update.call(data: next_product_data)
+# => TrailerVote::Api::Product::Find
+```
+
+If the update call fails with a `409 Conflict` or `412 Precondition Failed`, it means the product was updated in the meanwhile. You want to fetch the product again by doing another lookup and then running your strategy again.
+
+### `configuration.product.create`
+Creating a product is similar to looking up a product. If successful, returns an actual `Product::Find`.
+
+The `data` argument is wrapped in `{ product: data }` and then needs to match `application/vnd.trailervote.product.v2.create+json`
+
+```Ruby
+require 'trailer_vote/api/product/create'
+
+configuration.product.create(data: { title: 'My product', ... })
+# => TrailerVote::Api::Product::Find
+```
+
+### `configuration.product.<>.video.create`
+To attach an video to a product, you first need to find the product. This can be done by:
+ - `configuration.product.create`: creating a new product
+ - `configuration.product.lookup`: looking up an existing product
+
+Once you have it, the video operations are available on the result.
+
+The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
+
+```Ruby
+require 'trailer_vote/api/product/lookup'
+require 'trailer_vote/api/product/video/create'
+
+product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
+# => TrailerVote::Api::Product::Find
+
+product.video.create(data: { source_url: '', ... })
+# => TrailerVote::Api::Product::Video::Find
+```
+
+You can see in this example the `product` result is cached in a variable, so that if you want to create *many* videos, the product isn't looked up each call.
+
+### `configuration.product.<>.image.urls`
+Gets all the image urls for a product
+
+### `configuration.product.<>.video.create`
+To attach an video to a product, you first need to find the product. This can be done by:
+ - `configuration.product.create`: creating a new product
+ - `configuration.product.lookup`: looking up an existing product
+
+Once you have it, the video operations are available on the result.
+
+The `data` argument is wrapped in `{ product_video: data }` and then needs to match `application/vnd.trailervote.product.video.v1.create+json`
+
+```Ruby
+require 'trailer_vote/api/product/lookup'
+require 'trailer_vote/api/product/video/create'
+
+product = configuration.product.lookup.call(data: [{ authority: 'imdb', identifier: 'tt01010101' }])
+# => TrailerVote::Api::Product::Find
+
+product.video.create(data: { source_url: '', ... })
+# => TrailerVote::Api::Product::Video::Find
+```
+
+You can see in this example the `product` result is cached in a variable, so that if you want to create *many* videos, the product isn't looked up each call.
+
+### `configuration.product.<>.video.urls`
+Gets all the image urls for a product
+
+### `configuration.product.<>.place.link`
+Links a place to a product
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle update trailer_vote-api` in any repository that depends on
+this gem. If you have push rights, you may call `bundle exec rake release` to create a new git tag, push
+git commits and tags, and push the `.gem` file to the rubygems gem server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [TrailerVote/trailervote-api-clients](https://github.com/trailervote/trailervote-api-clients)