trailer_vote-api 3.1.0

data/lib/trailer_vote/api/autoload.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api'
+
+require 'trailer_vote/api/issue'
+require 'trailer_vote/api/issue/create'
+require 'trailer_vote/api/issue/find'
+require 'trailer_vote/api/place'
+require 'trailer_vote/api/place/children'
+require 'trailer_vote/api/place/children/urls'
+require 'trailer_vote/api/place/create'
+require 'trailer_vote/api/place/find'
+require 'trailer_vote/api/place/lookup'
+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'
+require 'trailer_vote/api/product/image/create'
+require 'trailer_vote/api/product/image/find'
+require 'trailer_vote/api/product/place'
+require 'trailer_vote/api/product/place/link'
+require 'trailer_vote/api/product/video'
+require 'trailer_vote/api/product/video/create'
+require 'trailer_vote/api/product/video/find'
+require 'trailer_vote/api/push_recipe_ios'
+require 'trailer_vote/api/push_recipe_android'
+require 'trailer_vote/api/vista_config'

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

@@ -0,0 +1,91 @@
+# 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
+
+        # Execute the call (and all dependent calls)
+        #
+        # @see #forward_klazz
+        # @see #redirect_klazz
+        def call(**_opts)
+          raise format('Missing implementation of #args in %<name>s', self.class.name)
+        end
+
+        private
+
+        def resolve_client
+          configuration.client
+        end
+
+        # Class used to branch forward to in case of a HTTP 307 or 308.
+        #
+        # @see #branch
+        # @see #forward
+        #
+        # @private
+        # @return [Class]
+        def forward_klazz
+          self.class
+        end
+
+        # Class used to branch redirect to in case of a HTTP 200, 201, 204, 301, 302, 303 or 304.
+        #
+        # When the status does not allow for redirecting, instead sends the retrieved result to the redirected class.
+        #
+        # @see #branch
+        # @see #redirect
+        #
+        # @private
+        # @return [Class]
+        def redirect_klazz
+          self.class
+        end
+
+        def guard_network_errors
+          yield
+        rescue HTTP::ConnectionError => err
+          raise ConnectionError, err
+        rescue HTTP::TimeoutError => err
+          raise TimeoutError, err
+        rescue HTTP::Error => err
+          raise NetworkError, err
+        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,66 @@
+# 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
+
+        # Return the {Links} for the result
+        # @return [Links] the links
+        def links
+          # TODO: or headers
+          @links ||= Links.new(data[:_links])
+        end
+
+        # Decode the result via {TypeRegistry}. This also takes care of MediaTypes validation.
+        #
+        # @see #decode
+        # @return [Hash, Array] the decoded response
+        def to_h
+          @to_h ||= TrailerVote::Api.decode(call.result)
+        end
+
+        # Return the HTTP status
+        # @return [Numeric] the HTTP status
+        def to_i
+          call.result.status
+        end
+
+        # Return the ETag value
+        # @return [String, NilClass] the etag or nil
+        def etag
+          call.result[Headers::ETAG]
+        end
+
+        # Return the decoded result inner object
+        # @return [Object] the inner object
+        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/media_types'
+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(5)
+      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
+        guard_network_errors do
+          merge(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+        end
+      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

data/lib/trailer_vote/api/errors.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+
+module TrailerVote
+  module Api
+
+    class Error < RuntimeError; end
+    class UnknownMediaType < Error; end
+    class NetworkError < Error; end
+    class ConnectionError < NetworkError; end
+    class TimeoutError < NetworkError; 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
+        Array(formatted_data[:errors]).map { |error| error[:message] }.join(', ')
+      end
+
+      def data
+        @data ||= TrailerVote::Api.decode(result)
+      rescue DecodeError, UnknownMediaType
+        # noinspection RubyStringKeysInHashInspection
+        @data = { errors: [{ message: result.status.reason }] }
+      end
+
+      def status
+        result.status.to_i
+      end
+
+      def inspect
+        format('[%<status>s] %<klazz>s' + "\n" + '%<messages>s', status: status, klazz: self.class.name, messages: messages)
+      end
+
+      alias to_i status
+      alias to_s inspect
+
+      private
+
+      def formatted_data
+        return data if data.is_a?(::Hash)
+
+        { errors: [{ message: String(data) }] }
+      end
+    end
+
+    class ClientError < ErrorsResponse; end
+    class BadRequest < ClientError; end
+    class Unauthorized < ClientError; end
+    class Forbidden < ClientError; end
+    class NotFound < ClientError; end
+    class Conflict < ClientError; end
+    class Gone < ClientError; end
+    class PreconditionFailed < ClientError; end
+    class UnprocessableEntity < ClientError; end
+    class TooManyRequests < ClientError; end
+
+    class ServerError < ErrorsResponse; end
+
+    ERROR_MAPPING = Hash.new { |_, key| key < 500 ? ClientError : ServerError }.merge(
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      409 => Conflict,
+      410 => Gone,
+      412 => PreconditionFailed,
+      422 => UnprocessableEntity,
+      429 => TooManyRequests
+    ).freeze
+
+    module_function
+
+    def raise_error(result)
+      raise ERROR_MAPPING[result.status], result
+    end
+
+  end
+end

data/lib/trailer_vote/api/fallback_content_types.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'trailer_vote/api/type_registry'
+
+module TrailerVote
+  module Api
+    module JsonTypeAdapter
+      module_function
+
+      def encode(obj)
+        Oj.dump(obj, mode: :compat)
+      rescue Oj::Error => err
+        raise EncodeError.new(media_type: 'application/json', source: err)
+      end
+
+      def decode(obj)
+        Oj.load(obj, mode: :strict, symbol_keys: true)
+      rescue Oj::Error => err
+        raise DecodeError.new(media_type: 'application/json', source: err)
+      end
+    end
+  end
+end
+
+TrailerVote::Api::TypeRegistry['application/json'] = TrailerVote::Api::JsonTypeAdapter
+TrailerVote::Api::TypeRegistry.shortcut('application/json', :json)
+TrailerVote::Api::TypeRegistry.shortcut('application/json', 'text/json')
+
+module TrailerVote
+  module Api
+    module HtmlTypeAdapter
+      module_function
+
+      def encode(obj)
+        return obj if obj.is_a?(String)
+        raise EncodeError.new(
+          media_type: 'text/html',
+          source: ArgumentError.new('HTML must be passed in as a HTML string')
+        )
+      end
+
+      def decode(str)
+        str
+      end
+    end
+  end
+end
+
+TrailerVote::Api::TypeRegistry['text/html'] = TrailerVote::Api::HtmlTypeAdapter

data/lib/trailer_vote/api/issue.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+require 'trailer_vote/api/configuration'
+
+module TrailerVote
+  module Api
+    class Configuration
+      # @return [TrailerVote::Api::Issue::Find] issues attached to the credentials
+      def issue
+        Issue.new(configuration: self)
+      end
+    end
+
+    class Issue
+      def initialize(configuration:)
+        self.configuration = configuration
+      end
+
+      def back
+        configuration
+      end
+
+      private
+
+      attr_accessor :configuration
+    end
+  end
+end