trailer_vote-api 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c83428f8cdf27b0b7be61b7f1b39f67cae7a721
+  data.tar.gz: 1d14fcbd1e8d7759a19a7feb6d05ed1b5f5f8d7f
+SHA512:
+  metadata.gz: e74475a1590286c488e70f83338f43fe8c001e81fef23fab18dd66ddfcdcaa5774ab3d6a0db8a69ca84c9e2dce92688d622f6d40ec73560390aa45bd1d984f37
+  data.tar.gz: a2028156d2b770043cebca99a536a128161dfb60e18565ea36994ca770a83f51b54397bc1a4aeeb781bfa455c595dd32a7f84118b001a623b7b1e4882d83eceb

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.3
+
+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,3 @@
+# 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 (0.5.0)
+      http
+      oj (~> 3.6)
+      trailer_vote-media_types (~> 0.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http (3.3.0)
+      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.1.1)
+    http_parser.rb (0.6.0)
+    json (2.1.0)
+    media_types (0.6.0)
+    minitest (5.11.3)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.3.5)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    oj (3.6.11)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    trailer_vote-media_types (0.6.1)
+      media_types (~> 0.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5-x64-mingw32)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print (~> 1.8)
+  bundler (~> 1.16)
+  minitest (~> 5.11)
+  minitest-ci (~> 3.4)
+  minitest-reporters (~> 1.3)
+  rake (~> 10.5)
+  simplecov (~> 0.16)
+  trailer_vote-api!
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   1.16.5

data/README.md

@@ -0,0 +1,184 @@
+# TrailerVote::Api
+
+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'
+
+# 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/autoload.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api'
+require 'trailer_vote/api/place'
+require 'trailer_vote/api/place/create'
+require 'trailer_vote/api/place/find'
+require 'trailer_vote/api/product'
+require 'trailer_vote/api/product/create'
+require 'trailer_vote/api/product/find'
+require 'trailer_vote/api/product/lookup'
+require 'trailer_vote/api/product/image/create'
+require 'trailer_vote/api/product/image/find'
+require 'trailer_vote/api/product/place/link'
+require 'trailer_vote/api/product/video/create'
+require 'trailer_vote/api/product/video/find'

data/lib/trailer_vote/api/composable/common.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module Api
+    module Composable
+      module Common
+
+        def self.included(base)
+          base.class_eval do
+            private
+
+            attr_accessor :configuration
+          end
+        end
+
+        def call(**_opts)
+          raise format('Missing implementation of #args in %<name>s', self.class.name)
+        end
+
+        private
+
+        def resolve_client
+          configuration.client
+        end
+
+        def forward_klazz
+          self.class
+        end
+
+        def redirect_klazz
+          self.class
+        end
+
+        def branch(result, data: nil)
+          raise_on_error(result)
+          forward(result, data: data) || redirect(result)
+        end
+
+        def raise_on_error(result)
+          return unless result.status.client_error? || result.status.server_error?
+          TrailerVote::Api.raise_error result
+        end
+
+        def forward(result, data:)
+          return unless [307, 308].include?(result.status)
+          forward_klazz.new(configuration: configuration)
+                       .call(data: data, url: redirected_url(result))
+        end
+
+        def redirect(result)
+          redirect_klazz.new(configuration: configuration, result: result)
+                        .call(url: redirected_url(result))
+        end
+
+        def redirected_url(result)
+          result['Location'] || result['Content-Location']
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/composable/get.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+require 'trailer_vote/api/links'
+
+module TrailerVote
+  module Api
+    module Composable
+      module Get
+        def self.included(base)
+          base.include Common
+          base.class_eval do
+            attr_accessor :result
+          end
+        end
+
+        def links
+          # TODO: or headers
+          @links ||= Links.new(data['_links'])
+        end
+
+        def to_h
+          @to_h ||= TrailerVote::Api.decode(call.result)
+        end
+
+        def to_i
+          call.result.status
+        end
+
+        def etag
+          call.result[Headers::ETAG]
+        end
+
+        def data
+          raise format('Missing implementation of #data in %<name>s', self.class.name)
+        end
+
+        private
+
+        def ok?
+          result&.status == 200
+        end
+
+        def redirecting?
+          [301, 302, 303, 307, 308].include?(result&.status)
+        end
+
+        def redirect_to
+          self.class
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/configuration.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+
+module TrailerVote
+  module Api
+
+    module_function
+
+    def configure(url:, key:, secret:)
+      client = Api.default_client(key, secret)
+      Configuration.new(client: client, url: url)
+    end
+
+    class Configuration
+      include Composable::Get
+
+      SUCCESS = MediaTypes::Configuration.to_constructable.version(2)
+      FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+      ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+      attr_accessor :client
+
+      def initialize(client:, url: nil, result: nil)
+        self.client = client
+        self.result = result
+        self.url = url
+      end
+
+      def data
+        to_h['configuration']
+      end
+
+      def call(url: resolve_url)
+        return self if ok? || !url
+        merge(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+        # TODO: result.raise_for_status
+      end
+
+      private
+
+      attr_accessor :url
+
+      def ok?
+        result&.status == 200
+      end
+
+      def redirecting?(result)
+        [301, 302, 303, 307, 308].include?(result.status)
+      end
+
+      alias resolve_url url
+      alias resolve_client client
+
+      def merge(result)
+        raise_on_error(result)
+        self.result = redirecting?(result) ? redirect(result).result : result
+        self
+      end
+
+      def redirect(result)
+        call(url: result['Location'] || result['Content-Location'])
+      end
+    end
+  end
+end
+
+TrailerVote::MediaTypes::Configuration.register

data/lib/trailer_vote/api/errors.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module Api
+
+    class Error < RuntimeError; end
+
+    class EncodeError < Error
+      def initialize(media_type:, source:)
+        super format(
+          'Failed to encode data for %<media_type>s. Reason: %<reason>s',
+          media_type: media_type,
+          reason: source.message
+        )
+
+        self.source = source
+      end
+
+      attr_accessor :source
+    end
+
+    class DecodeError < Error
+      def initialize(media_type:, source:)
+        super format(
+          'Failed to decode data for %<media_type>s. Reason: %<reason>s',
+          media_type: media_type,
+          reason: source.message
+        )
+
+        self.source = source
+      end
+
+      attr_accessor :source
+    end
+
+    class ErrorsResponse < Error
+      attr_accessor :result
+
+      def initialize(result)
+        self.result = result
+        super messages
+      end
+
+      def messages
+        result.status.reason
+      end
+
+      def data
+        @data ||= TrailerVote::Api.decode(result)
+      end
+    end
+
+    module_function
+
+    def raise_error(result)
+      raise ErrorsResponse, result
+    end
+
+  end
+end
+
+TrailerVote::MediaTypes::Errors.register

data/lib/trailer_vote/api/links.rb

@@ -0,0 +1,51 @@
+module TrailerVote
+  module Api
+    class Links
+      def initialize(links)
+        self.links = links
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        links.key?(String(method_name)) || super
+      end
+
+      def method_missing(method_name, *arguments)
+        if links.key?(String(method_name))
+          return call(String(method_name), *arguments)
+        end
+
+        if /[a-z_]+/.match? method_name
+          raise ArgumentError, format(
+            'Unknown link %<link>s. Available: %<links>s',
+            link: method_name,
+            links: links.keys
+          )
+        end
+
+        super
+      end
+
+      def [](key)
+        links.fetch(key)
+      end
+
+      private
+
+      attr_accessor :links
+
+      def call(link, **arguments)
+        if arguments.length.zero?
+          return self[link]['href']
+        end
+
+        fill_template(self[link]['href'], **arguments)
+      end
+
+      def fill_template(templated, **arguments)
+        arguments.each_with_object(templated) do |(variable, value), result|
+          result.gsub!("{#{variable}}", value)
+        end
+      end
+    end
+  end
+end