trailer_vote-api 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ffccb405ec69e5cb2f85fdc6bec5b629667d9ad4d4cb14030db0952fafc13a23
+  data.tar.gz: 5659979cd40ebb822a2b7eb01975490b05af87f4403e4cc69a90333a655f3ab0
+SHA512:
+  metadata.gz: bc09c0745b73c5497dc6ca98521d359a95de307f2e38a1826930b1cc931eddfadbb43c750ff1d6aaf83d03ed1a794259caaa7a27cda34bf5cf5b361bb60ea412
+  data.tar.gz: cecc15619cbd422d7713036a8b743229970fe76481a777cf90df7c05ddbf5f8a10702548cf2920892b49adffc3d2dec6e34c1d6d1541d168ea859edf232fbec4

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +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

data/CHANGELOG.md

@@ -0,0 +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

data/Gemfile

@@ -0,0 +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

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    trailer_vote-api (3.1.0)
+      http (>= 3.3.0, <= 4.1.1)
+      oj (>= 3.6, < 4.x)
+      trailer_vote-media_types (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    builder (3.2.4)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http (4.1.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http_parser.rb (0.6.0)
+    media_types (2.0.1)
+    minitest (5.14.0)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    oj (3.10.7)
+    public_suffix (4.0.3)
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    trailer_vote-media_types (3.0.4)
+      media_types (>= 2.0.0, < 3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unf_ext (0.0.7.7-x64-mingw32)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print (~> 1.8)
+  bundler (~> 1.16)
+  minitest (~> 5.11)
+  minitest-ci (~> 3.4)
+  minitest-reporters (~> 1.3)
+  rake (~> 13.0)
+  simplecov (~> 0.16)
+  trailer_vote-api!
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +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)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'trailer_vote/api/autoload'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/trailer_vote/api.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# require 'httpx'
+# HTTP_KLAZZ = HTTPX.plugin(:compression, :basic_authentication)
+require 'http'
+require 'json'
+HTTP_KLAZZ = HTTP.use(:auto_inflate)
+
+require 'trailer_vote/api/version'
+require 'trailer_vote/api/type_registry'
+require 'trailer_vote/api/fallback_content_types'
+require 'trailer_vote/api/errors'
+require 'trailer_vote/api/configuration'
+
+module TrailerVote
+  module Api
+    module_function
+
+    def decode(result)
+      begin
+        #Oj.load(result, mode: :strict, symbol_keys: true)
+        JSON.parse(result, {symbolize_names: true})
+      rescue Oj::Error => err
+        raise DecodeError.new(media_type: media_type, source: err)
+      rescue JSON::JSONError => err
+        raise DecodeError.new(media_type: media_type, source: err)
+      end
+    end
+
+    def encode(media_type, data)
+      Oj.dump(data, mode: :compat)
+    end
+
+    def default_unauthenticated_client
+      HTTP_KLAZZ.headers(
+        Headers::ACCEPT_ENCODING => 'gzip, deflate; q=0.5, identity; q=0.1',
+        Headers::USER_AGENT => format('TrailerVote/httpx.rb (client %<version>s)', version: VERSION)
+      )
+    end
+
+    def default_client(username, password)
+      default_unauthenticated_client.basic_auth(user: username, pass: password)
+    end
+
+    module Headers
+      ACCEPT = 'Accept'
+      ACCEPT_ENCODING = 'Accept-Encoding'
+      CONTENT_TYPE = 'Content-Type'
+      ETAG = 'ETag'
+      IF_MATCH = 'If-Match'
+      USER_AGENT = 'User-Agent'
+    end
+
+    TypeRegistry.register(MediaTypes::Configuration)
+    TypeRegistry.register(MediaTypes::Errors)
+    TypeRegistry.register(MediaTypes::Issue)
+    TypeRegistry.register(MediaTypes::Place)
+    TypeRegistry.register(MediaTypes::Product)
+    TypeRegistry.register(MediaTypes::ProductImage)
+    TypeRegistry.register(MediaTypes::ProductLookup)
+    TypeRegistry.register(MediaTypes::ProductPlaceLink)
+    TypeRegistry.register(MediaTypes::ProductVideo)
+    TypeRegistry.register(MediaTypes::PushRecipeAndroid)
+    TypeRegistry.register(MediaTypes::PushRecipeIos)
+    TypeRegistry.register(MediaTypes::VistaConfig)
+  end
+end