trailer_vote-api 3.1.0

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+require 'trailer_vote/api/issue'
+require 'trailer_vote/api/issue/find'
+
+module TrailerVote
+  module Api
+    class Issue
+
+      def create
+        Create.new(configuration: configuration)
+      end
+
+      class Create
+        include Composable::Common
+
+        CONTENT = MediaTypes::Issue.to_constructable.version(1).view('create')
+        SUCCESS = MediaTypes::Issue.to_constructable.version(1)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        # @private
+        def initialize(configuration:)
+          self.configuration = configuration
+        end
+
+        def back
+          configuration.issue
+        end
+
+        # Create an issue
+        #
+        # @see https://www.rubydoc.info/gems/trailer_vote-media_types/TrailerVote/MediaTypes/Issue TrailerVote::MediaTypes::Issue
+        #
+        # @param [String, Hash] data the data conform to the Issue media type
+        # @param [String] url (#resolve_url result) the url to post to
+        #
+        # @return [TrailerVote::Api::Issue]
+        def call(data:, url: resolve_url)
+          guard_network_errors do
+            body = encode(data)
+            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 :configuration
+
+        def resolve_url
+          configuration.links.issues
+        end
+
+        def encode(data)
+          TrailerVote::Api.encode(CONTENT, issue: data)
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/issue'
+
+module TrailerVote
+  module Api
+    class Issue
+      class Find
+        include Composable::Get
+
+        SUCCESS = MediaTypes::Issue.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::Configuration, TrailerVote::Api::Issue::Create]
+        def back
+          backtrack = result
+          backtrack = result.back while backtrack&.is_a?(self.class)
+          backtrack || configuration
+        end
+
+        def call(url: nil)
+          return self if ok? || !url
+          guard_network_errors do
+            branch(resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+          end
+        end
+
+        def data
+          to_h[:issue]
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/links.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module Api
+    class Links
+      def initialize(links)
+        self.links = links
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        links.key?(method_name) || super
+      end
+
+      def method_missing(method_name, *arguments)
+        link_name = method_name
+        if links.key?(link_name)
+          return call(link_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

data/lib/trailer_vote/api/place.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+require 'trailer_vote/api/configuration'
+
+module TrailerVote
+  module Api
+    class Place
+      def initialize(configuration:)
+        self.configuration = configuration
+      end
+
+      def back
+        configuration
+      end
+
+      private
+
+      attr_accessor :configuration
+    end
+  end
+end

data/lib/trailer_vote/api/place/children.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/place'
+require 'trailer_vote/api/place/find'
+
+module TrailerVote
+  module Api
+    class Place
+      class Find
+        # @return [TrailerVote::Api::Product::Children] api to deal with a place's children
+        def children
+          Children.new(configuration: configuration, place: self)
+        end
+      end
+
+      class Children
+        def initialize(configuration:, place: nil)
+          self.configuration = configuration
+          self.place = place
+        end
+
+        # @return [TrailerVote::Api::Product::Find] api to deal with a found place
+        def back
+          place
+        end
+
+        private
+
+        attr_accessor :configuration, :place
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/place/children/urls.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/place'
+
+module TrailerVote
+  module Api
+    class Place
+      class Children
+
+        # @return [TrailerVote::Api::Place::Children::Urls] the api to get the children urls for the current place
+        def urls
+          Urls.new(configuration: configuration, place: place)
+        end
+
+        class Urls
+          include Composable::Get
+
+          SUCCESS = MediaTypes::Place.to_constructable.version(3).view('index')
+          FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+          ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+          def initialize(configuration:, place:, result: nil)
+            self.configuration = configuration
+            self.place = place
+            self.result = result
+          end
+
+          # @return [TrailerVote::Api::Place::Children] the api to deal with a place's children
+          def back
+            place.children
+          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[:places]
+          end
+
+          private
+
+          attr_accessor :place
+
+          def ok?
+            result&.status&.ok?
+          end
+
+          def resolve_url
+            place.links.children
+          end
+
+          def redirect(result)
+            redirect_klazz.new(configuration: configuration, place: place, result: result)
+                          .call(url: redirected_url(result))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+require 'trailer_vote/api/place'
+require 'trailer_vote/api/place/find'
+
+module TrailerVote
+  module Api
+    class Place
+      class Find
+
+        # @return [TrailerVote::Api::Place::Create] the api to create a child place
+        def create
+          Create.new(configuration: configuration, place: self)
+        end
+      end
+
+      class Create
+        include Composable::Common
+
+        CONTENT = MediaTypes::Place.to_constructable.version(2).view('create')
+        SUCCESS = MediaTypes::Place.to_constructable.version(2)
+        FAILURE = MediaTypes::Errors.to_constructable.version(1)
+
+        ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+        # @private
+        def initialize(configuration:, place:)
+          self.configuration = configuration
+          self.place = place
+        end
+
+        # @return [TrailerVote::Api::Place::Find] the found place
+        def back
+          place
+        end
+
+        # Create a place
+        #
+        # @see https://www.rubydoc.info/gems/trailer_vote-media_types/TrailerVote/MediaTypes/Place TrailerVote::MediaTypes::Place
+        #
+        # @param [String, Hash] data the data conform to the Place media type
+        # @param [String] url (#resolve_url result) the url to post to
+        #
+        # @return [TrailerVote::Api::Place::Find]
+        def call(data:, url: resolve_url)
+          guard_network_errors do
+            body = encode(data)
+            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 :place
+
+        def resolve_url
+          configuration.links.place
+        end
+
+        def encode(data)
+          TrailerVote::Api.encode(CONTENT, place: data)
+        end
+
+        def forward(result, data:)
+          return unless [307, 308].include?(result.status)
+          forward_klazz.new(configuration: configuration, place: place)
+                       .call(data: data, url: redirected_url(result))
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/get'
+require 'trailer_vote/api/place'
+
+module TrailerVote
+  module Api
+    class Configuration
+
+      # @return [TrailerVote::Api::Place::Find] the root place attached to the credentials
+      def place
+        Place::Find.new(configuration: self)
+      end
+    end
+
+    class Place
+      class Find
+        include Composable::Get
+
+        SUCCESS = MediaTypes::Place.to_constructable.version(3)
+        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::Configuration, TrailerVote::Api::Place::Create]
+        def back
+          backtrack = result
+          backtrack = result.back while backtrack&.is_a?(self.class)
+          backtrack || configuration
+        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 resolve_url
+          configuration.links.place
+        end
+
+        def data
+          to_h[:place]
+        end
+
+        def parent
+          Find.new(configuration: configuration)
+              .call(url: links.parent)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/api/composable/common'
+
+require 'trailer_vote/api/place'
+require 'trailer_vote/api/place/find'
+
+module TrailerVote
+  module Api
+
+    class Configuration
+      # @return [TrailerVote::Api::Place::Lookup] api to deal with looking up a place
+      def place_lookup
+        Place::Lookup.new(configuration: self)
+      end
+    end
+
+    class Place
+
+      # @return [TrailerVote::Api::Place::Lookup] api to deal with looking up a place
+      def lookup
+        Lookup.new(configuration: configuration)
+      end
+
+      ##
+      # Looks up a place by a concatenated authority and identifier string
+      #
+      # @example lookup a place by vista authority
+      #
+      #   result = TrailerVote::Api.configure(...).place.lookup.call(url: '')
+      #   result.place
+      #   # => { "title": "" }
+      #
+      class Lookup
+        include Composable::Common
+
+        SUCCESS = MediaTypes::Place.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::Place] api to deal with places
+        def back
+          configuration.place
+        end
+
+        def call(authority:, identifier:)
+          url = resolve_url(authority: authority, identifier: identifier)
+          guard_network_errors do
+            branch(
+              resolve_client.headers(Headers::ACCEPT => ACCEPT).get(url, body: nil)
+            )
+          end
+        end
+
+        private
+
+        def resolve_url(authority:, identifier:)
+          configuration.links.lookup(authority: authority, identifier: identifier)
+        end
+
+        def redirect_klazz
+          Find
+        end
+      end
+    end
+  end
+end