trailer_vote-api 3.1.0

data/lib/trailer_vote/api/push_recipe_ios.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+
+module TrailerVote
+  module Api
+    class PushRecipeIos
+      include Composable::Get
+
+      attr_accessor :client
+
+      SUCCESS = MediaTypes::PushRecipeIos.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: nil, result: nil)
+        self.configuration = configuration
+        self.result = result
+      end
+
+      def call(url: nil)
+        return self if ok? || !url
+
+        local_client = client
+        unless client
+          uri = URI(url)
+          local_client = TrailerVote::Api.default_unauthenticated_client
+          local_client = local_client.basic_auth(user: uri.user, pass: uri.password)
+        end
+
+        guard_network_errors do
+          branch(local_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/type_registry.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'media_types'
+require 'trailer_vote/media_types'
+
+module TrailerVote
+  module Api
+
+    module TypeRegistry
+      class << self
+        attr_accessor :registry, :registry_shortcuts
+      end
+
+      self.registry = {}
+      self.registry_shortcuts = {}
+
+      module_function
+
+      def [](key)
+        registry.fetch(key) { registry.fetch(registry_shortcuts.fetch(key)) }
+      rescue KeyError
+        raise UnknownMediaType, format('Unknown media type %<type>s', type: key)
+      end
+
+      def []=(key, value)
+        registry[key] = value
+      end
+
+      def shortcut(key, alias_name)
+        registry_shortcuts[alias_name] = key
+      end
+
+      def register(registerable)
+        mime_type = registerable.to_s
+
+        self[mime_type] = AdapterFor(registerable)
+        shortcut(mime_type, registerable.to_s)
+
+        registerable.available_validations.each do |alias_mime_type|
+          shortcut(mime_type, alias_mime_type)
+        end
+      end
+
+      class << self
+        private
+
+        # noinspection RubyClassMethodNamingConvention
+        def AdapterFor(media_type) # rubocop:disable Naming/MethodName
+          adapter_name = generate_adapter_name(media_type.identifier)
+
+          if const_defined?(adapter_name)
+            return const_get(adapter_name)
+          end
+
+          const_set(adapter_name, Module.new).tap do |adapter|
+            define_encode(adapter, media_type)
+            define_decode(adapter, media_type)
+          end
+        end
+
+        def generate_adapter_name(media_type)
+          media_type.split(%r{[./_+-]}).map(&:capitalize).join('').tr('^A-z0-9', '_')
+        end
+
+        def define_encode(adapter, media_type)
+          adapter.define_singleton_method(:encode) do |obj|
+            begin
+              media_type.validate!(obj)
+              Oj.dump(obj, mode: :compat)
+            rescue Oj::Error, ::MediaTypes::Scheme::ValidationError => err
+              raise EncodeError.new(media_type: media_type, source: err)
+            end
+          end
+        end
+
+        def define_decode(adapter, media_type)
+          adapter.define_singleton_method('decode') do |str|
+            begin
+              Oj.load(str, mode: :strict, symbol_keys: true).tap do |result|
+                begin
+                  media_type.validate!(result)
+                rescue ::MediaTypes::Scheme::ValidationError => err
+                  warn format('Decode error! API might now be in an invalid or incomplete state. %<err>s', err: err)
+                end
+              end
+            rescue Oj::Error => err
+              raise DecodeError.new(media_type: media_type, source: err)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module Api
+    VERSION = '3.1.0'
+  end
+end

data/lib/trailer_vote/api/vista_config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types'
+
+module TrailerVote
+  module Api
+    class VistaConfig
+      include Composable::Get
+
+      attr_accessor :client
+
+      SUCCESS = MediaTypes::VistaConfig.to_constructable.version(1).view(:collection)
+      FAILURE = MediaTypes::Errors.to_constructable.version(1)
+      ACCEPT = [SUCCESS.to_s, FAILURE.to_s(0.1)].join(', ').freeze
+
+      def initialize(configuration: nil, result: nil)
+        self.configuration = configuration
+        self.result = result
+      end
+
+      def call(url: nil)
+        return self if ok? || !url
+
+        local_client = client
+        unless client
+          uri = URI(url)
+          local_client = TrailerVote::Api.default_unauthenticated_client
+          local_client = local_client.basic_auth(user: uri.user, pass: uri.password)
+        end
+
+        guard_network_errors do
+          branch(local_client.headers(Headers::ACCEPT => ACCEPT).get(url))
+        end
+      end
+    end
+  end
+end

data/trailer_vote-api.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trailer_vote/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'trailer_vote-api'
+  spec.version       = TrailerVote::Api::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['dj@trailervote.com']
+  spec.homepage      = 'https://github.com/TrailerVote/trailervote-api-clients'
+  spec.summary       = 'Provides a client to interact with the TrailerVote API'
+
+  # noinspection RubyStringKeysInHashInspection
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/TrailerVote/trailervote-api-clients/issues',
+    'changelog_uri'     => 'https://github.com/TrailerVote/trailervote-api-clients/blob/master/ruby/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/trailer_vote-api',
+    'homepage_uri'      => 'https://github.com/trailervote/trailervote-api-clients',
+    'source_code_uri'   => 'https://github.com/trailervote/trailervote-api-clients/blob/master/ruby',
+    'wiki_uri'          => 'https://docs.trailervote.com/reference/media-types'
+  }
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_runtime_dependency 'httpx'
+  spec.add_runtime_dependency 'http', '>= 3.3.0', '<= 4.1.1'
+  spec.add_runtime_dependency 'oj', '>= 3.6', '< 4.x'
+  spec.add_runtime_dependency 'trailer_vote-media_types', '~> 3.0'
+
+  spec.add_development_dependency 'awesome_print', '~> 1.8'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'minitest-ci', '~> 3.4'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+end

metadata

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: trailer_vote-api
+version: !ruby/object:Gem::Version
+  version: 3.1.0
+platform: ruby
+authors:
+- Derk-Jan Karrenbeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.x
+- !ruby/object:Gem::Dependency
+  name: trailer_vote-media_types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-ci
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- dj@trailervote.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trailer_vote/api.rb
+- lib/trailer_vote/api/autoload.rb
+- lib/trailer_vote/api/composable/common.rb
+- lib/trailer_vote/api/composable/get.rb
+- lib/trailer_vote/api/configuration.rb
+- lib/trailer_vote/api/errors.rb
+- lib/trailer_vote/api/fallback_content_types.rb
+- lib/trailer_vote/api/issue.rb
+- lib/trailer_vote/api/issue/create.rb
+- lib/trailer_vote/api/issue/find.rb
+- lib/trailer_vote/api/links.rb
+- lib/trailer_vote/api/place.rb
+- lib/trailer_vote/api/place/children.rb
+- lib/trailer_vote/api/place/children/urls.rb
+- lib/trailer_vote/api/place/create.rb
+- lib/trailer_vote/api/place/find.rb
+- lib/trailer_vote/api/place/lookup.rb
+- lib/trailer_vote/api/product.rb
+- lib/trailer_vote/api/product/create.rb
+- lib/trailer_vote/api/product/find.rb
+- lib/trailer_vote/api/product/image.rb
+- lib/trailer_vote/api/product/image/create.rb
+- lib/trailer_vote/api/product/image/find.rb
+- lib/trailer_vote/api/product/image/urls.rb
+- lib/trailer_vote/api/product/lookup.rb
+- lib/trailer_vote/api/product/place.rb
+- lib/trailer_vote/api/product/place/link.rb
+- lib/trailer_vote/api/product/update.rb
+- lib/trailer_vote/api/product/video.rb
+- lib/trailer_vote/api/product/video/create.rb
+- lib/trailer_vote/api/product/video/find.rb
+- lib/trailer_vote/api/product/video/urls.rb
+- lib/trailer_vote/api/push_recipe_android.rb
+- lib/trailer_vote/api/push_recipe_ios.rb
+- lib/trailer_vote/api/type_registry.rb
+- lib/trailer_vote/api/version.rb
+- lib/trailer_vote/api/vista_config.rb
+- trailer_vote-api.gemspec
+homepage: https://github.com/TrailerVote/trailervote-api-clients
+licenses: []
+metadata:
+  bug_tracker_uri: https://github.com/TrailerVote/trailervote-api-clients/issues
+  changelog_uri: https://github.com/TrailerVote/trailervote-api-clients/blob/master/ruby/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/trailer_vote-api
+  homepage_uri: https://github.com/trailervote/trailervote-api-clients
+  source_code_uri: https://github.com/trailervote/trailervote-api-clients/blob/master/ruby
+  wiki_uri: https://docs.trailervote.com/reference/media-types
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Provides a client to interact with the TrailerVote API
+test_files: []