trailer_vote-api 3.1.0

data/lib/trailer_vote/api/product.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+require 'trailer_vote/api/configuration'
+
+module TrailerVote
+  module Api
+    class Configuration
+      # @return [TrailerVote::Api::Product] api to deal with products
+      def product
+        Product.new(configuration: self)
+      end
+
+      alias products product
+    end
+
+    class Product
+      def initialize(configuration:)
+        self.configuration = configuration
+      end
+
+      def back
+        configuration
+      end
+
+      private
+
+      attr_accessor :configuration
+    end
+  end
+end

data/lib/trailer_vote/api/product/create.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+
+require 'trailer_vote/api/product'
+require 'trailer_vote/api/product/find'
+
+module TrailerVote
+  module Api
+    class Product
+      # @return [TrailerVote::Api::Product::Create] api to create a new product
+      def create
+        Create.new(configuration: configuration)
+      end
+
+      class Create
+        include Composable::Common
+
+        CONTENT = MediaTypes::Product.to_constructable.version(2).view('create')
+        SUCCESS = MediaTypes::Product.to_constructable.version(2)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        def initialize(configuration:)
+          self.configuration = configuration
+        end
+
+        # @return [TrailerVote::Api::Product] api to deal with products
+        def back
+          configuration.product
+        end
+
+        def call(data:, url: resolve_url)
+          body = encode(data)
+          guard_network_errors do
+            branch(
+              resolve_client.headers(
+                Headers::ACCEPT => ACCEPT,
+                Headers::CONTENT_TYPE => "#{CONTENT}; charset=#{body.encoding.name}"
+              ).post(url, body: body),
+              data: data
+            )
+          end
+        end
+
+        private
+
+        def resolve_url
+          configuration.links.products
+        end
+
+        def encode(data)
+          TrailerVote::Api.encode(CONTENT, product: data)
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/find.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/product'
+
+module TrailerVote
+  module Api
+    class Product
+      # @param [TrailerVote::Api::Product::Find,
+      #   TrailerVote::Api::Product::Create,
+      #   TrailerVote::Api::Product::Update,
+      #   TrailerVote::Api::Product::Lookup,
+      #   NilClass] result the found product
+      # @return [TrailerVote::Api::Product::Find] api to deal with a found product
+      def find(result: nil)
+        Find.new(configuration: configuration, result: result)
+      end
+
+      class Find
+        include Composable::Get
+
+        SUCCESS = MediaTypes::Product.to_constructable.version(2)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        def initialize(configuration:, result: nil)
+          self.configuration = configuration
+          self.result = result
+        end
+
+        # @return [TrailerVote::Api::Product::Find,
+        #   TrailerVote::Api::Product::Create,
+        #   TrailerVote::Api::Product::Update,
+        #   TrailerVote::Api::Product::Lookup,
+        #   NilClass] return the api that yielded this
+        def back
+          backtrack = result
+          backtrack = result.back while backtrack&.is_a?(self.class)
+          backtrack
+        end
+
+        def call(url: nil, data: nil)
+          return self if ok? || !url
+          guard_network_errors do
+            branch(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url), data: data)
+          end
+        end
+
+        def data
+          to_h[:product]
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/image.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/product'
+require 'trailer_vote/api/product/find'
+
+module TrailerVote
+  module Api
+    class Product
+      class Find
+        # @return [TrailerVote::Api::Product::Image] api to deal with a product's images
+        def image
+          Image.new(configuration: configuration, product: self)
+        end
+
+        alias product_image image
+        alias images image
+      end
+
+      class Image
+        def initialize(configuration:, product: nil)
+          self.configuration = configuration
+          self.product = product
+        end
+
+        # @return [TrailerVote::Api::Product::Find] api to deal with a found product
+        def back
+          product
+        end
+
+        private
+
+        attr_accessor :configuration, :product
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/image/create.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+
+require 'trailer_vote/api/product/image'
+require 'trailer_vote/api/product/image/find'
+
+module TrailerVote
+  module Api
+    class Product
+      class Image
+
+        # @return [TrailerVote::Api::Product::Image::Create] the api to create an image for the current +product+
+        def create
+          Create.new(configuration: configuration, product: product)
+        end
+
+        class Create
+          include Composable::Common
+
+          CONTENT = MediaTypes::ProductImage.to_constructable.version(1).view('create')
+          SUCCESS = MediaTypes::ProductImage.to_constructable.version(1)
+          FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+          ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+          def initialize(configuration:, product:)
+            self.configuration = configuration
+            self.product = product
+          end
+
+          # @return [TrailerVote::Api::Product::Image] the api to deal with the current +product+ images
+          def back
+            product.image
+          end
+
+          # Create the image
+          #
+          # @see https://www.rubydoc.info/gems/trailer_vote-media_types/TrailerVote/MediaTypes/ProductImage TrailerVote::MediaTypes::ProductImage
+          #
+          # @param [String] url (#resolve_url result) the url to post to
+          # @param [Hash] data the image data
+          #
+          # @return [TrailerVote::Api::Product::Image::Find]
+          def call(data:, url: resolve_url)
+            body = encode(data)
+            guard_network_errors do
+              branch(
+                resolve_client.headers(
+                  Headers::ACCEPT => ACCEPT,
+                  Headers::CONTENT_TYPE => "#{CONTENT}; charset=#{body.encoding.name}"
+                ).post(url, body: body),
+                data: data
+              )
+            end
+          end
+
+          private
+
+          attr_accessor :product
+
+          def resolve_url
+            product.links.images
+          end
+
+          def encode(data)
+            TrailerVote::Api.encode(CONTENT, product_image: data)
+          end
+
+          def forward(result, data:)
+            return unless [307, 308].include?(result.status)
+            forward_klazz.new(configuration: configuration, product: product)
+                         .call(data: data, url: redirected_url(result))
+          end
+
+          def redirect_klazz
+            Find
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/image/find.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/product/image'
+
+module TrailerVote
+  module Api
+    class Product
+      class Image
+
+        # @param [TrailerVote::Api::Product::Image::Find,
+        #   TrailerVote::Api::Product::Image::Create,
+        #   TrailerVote::Api::Product::Image::Urls::Traverse,
+        #   NilClass] result the found image, or nil
+        # @return [TrailerVote::Api::Product::Image::Find] the api to deal with the found image
+        def find(result: nil)
+          Find.new(configuration: configuration, result: result)
+        end
+
+        class Find
+          include Composable::Get
+
+          SUCCESS = MediaTypes::ProductImage.to_constructable.version(1)
+          FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+          ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+          def initialize(configuration:, result: nil)
+            self.configuration = configuration
+            self.result = result
+          end
+
+          # @return [TrailerVote::Api::Product::Image::Create,
+          #   TrailerVote::Api::Product::Image::Urls::Traverse,
+          #   NilClass] return the api that yielded this
+          def back
+            backtrack = result
+            backtrack = result.back while backtrack&.is_a?(self.class)
+            backtrack
+          end
+
+          def call(url: nil)
+            return self if ok? || !url
+            branch(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+          end
+
+          def data
+            to_h[:product_image]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/image/urls.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/product/image'
+
+module TrailerVote
+  module Api
+    class Product
+      class Image
+
+        # @return [TrailerVote::Api::Product::Image::Urls] the api to get the image urls for the current product
+        def urls
+          Urls.new(configuration: configuration, product: product)
+        end
+
+        class Urls
+          include Composable::Get
+
+          SUCCESS = MediaTypes::ProductImage.to_constructable.version(1).view('index')
+          FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+          ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+          def initialize(configuration:, product:, result: nil)
+            self.configuration = configuration
+            self.product = product
+            self.result = result
+          end
+
+          # @return [TrailerVote::Api::Product::Image] the api to deal with a product's images
+          def back
+            product.image
+          end
+
+          def call(url: resolve_url)
+            return self if ok? || !url
+            guard_network_errors do
+              branch(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+            end
+          end
+
+          def data
+            to_h[:product_images]
+          end
+
+          private
+
+          attr_accessor :product
+
+          def ok?
+            result&.status&.ok?
+          end
+
+          def resolve_url
+            product.links.images
+          end
+
+          def redirect(result)
+            redirect_klazz.new(configuration: configuration, product: product, result: result)
+                          .call(url: redirected_url(result))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/product/lookup.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+
+require 'trailer_vote/api/product'
+require 'trailer_vote/api/product/find'
+
+module TrailerVote
+  module Api
+
+    class Configuration
+      # @return [TrailerVote::Api::Product::Lookup] api to deal with looking up a product
+      def product_lookup
+        product.lookup
+      end
+    end
+
+    class Product
+
+      # @return [TrailerVote::Api::Product::Lookup] api to deal with looking up a product
+      def lookup
+        Lookup.new(configuration: configuration)
+      end
+
+      ##
+      # Looks up a product by a set of authority and identifiers in +lookups+
+      #
+      # @example lookup a product by imdb or tmdb authority
+      #
+      #   lookups = [
+      #     { authority: 'imdb', identifier: 'tt1825683'},
+      #     { authority: 'tmdb', identifier: '284054' }
+      #   ]
+      #   result = TrailerVote::Api.configure(...).product.lookup.call(data: lookups)
+      #   result.product
+      #   # => { "title": "" }
+      #
+      # @example try to lookup multiple products at the same time
+      #
+      #   lookups = [
+      #     { authority: 'imdb', identifier: 'tt1825683'},
+      #     { authority: 'isbn', identifier: '978-1-59448-194-9' }
+      #   ]
+      #   result = TrailerVote::Api.configure(...).product.lookup.call(data: lookups)
+      #   result.errors
+      #   # => [{ "message": "Found multiple products for the given identifiers, only one result ..." }]
+      #
+      class Lookup
+        include Composable::Common
+
+        CONTENT = MediaTypes::ProductLookup.to_constructable.version(1)
+        SUCCESS = MediaTypes::Product.to_constructable.version(2)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        def initialize(configuration:)
+          self.configuration = configuration
+        end
+
+        # @return [TrailerVote::Api::Product] api to deal with products
+        def back
+          configuration.product
+        end
+
+        def call(data:, url: resolve_url)
+          body = encode(data)
+          guard_network_errors do
+            branch(
+              resolve_client.headers(
+                Headers::ACCEPT => ACCEPT,
+                Headers::CONTENT_TYPE => "#{CONTENT}; charset=#{body.encoding.name}"
+              ).post(url, body: body),
+              data: data
+            )
+          end
+        end
+
+        private
+
+        def resolve_url
+          configuration.links.product_lookup
+        end
+
+        def encode(data)
+          TrailerVote::Api.encode(CONTENT, product_identifiers: data)
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end