trailer_vote-api 0.8.4 → 0.9.0

data/Rakefile

@@ -1,12 +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
+# 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

@@ -1,15 +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__)
+#!/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

@@ -1,8 +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
+#!/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

@@ -1,43 +1,43 @@
-# frozen_string_literal: true
-
-# require 'httpx'
-# HTTP_KLAZZ = HTTPX.plugin(:compression, :basic_authentication)
-require 'http'
-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)
-      TypeRegistry[result.content_type.mime_type].decode(result.body.to_s)
-    end
-
-    def encode(media_type, data)
-      TypeRegistry[media_type.to_s].encode(data)
-    end
-
-    def default_client(username, password)
-      # .basic_authentication
-      HTTP_KLAZZ.basic_auth(user: username, pass: password).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
-
-    module Headers
-      ACCEPT = 'Accept'
-      ACCEPT_ENCODING = 'Accept-Encoding'
-      CONTENT_TYPE = 'Content-Type'
-      ETAG = 'ETag'
-      IF_MATCH = 'If-Match'
-      USER_AGENT = 'User-Agent'
-    end
-  end
-end
+# frozen_string_literal: true
+
+# require 'httpx'
+# HTTP_KLAZZ = HTTPX.plugin(:compression, :basic_authentication)
+require 'http'
+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)
+      TypeRegistry[result.content_type.mime_type].decode(result.body.to_s)
+    end
+
+    def encode(media_type, data)
+      TypeRegistry[media_type.to_s].encode(data)
+    end
+
+    def default_client(username, password)
+      # .basic_authentication
+      HTTP_KLAZZ.basic_auth(user: username, pass: password).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
+
+    module Headers
+      ACCEPT = 'Accept'
+      ACCEPT_ENCODING = 'Accept-Encoding'
+      CONTENT_TYPE = 'Content-Type'
+      ETAG = 'ETag'
+      IF_MATCH = 'If-Match'
+      USER_AGENT = 'User-Agent'
+    end
+  end
+end

data/lib/trailer_vote/api/autoload.rb

@@ -1,22 +1,24 @@
-# 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/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'
-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'
+# 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/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'

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

@@ -1,91 +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
+# 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

@@ -1,66 +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
+# 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