kinopoisk_dev_api 1.4.0

data/lib/kinopoisk_dev_api/types/votes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    class Votes < Base
+      attribute? :kp, Types::Coercible::String.optional
+      attribute? :imdb, Types::Float | Types::Integer.optional
+      attribute? :tmdb, Types::Float | Types::Integer.optional
+      attribute? :filmCritics, Types::Float | Types::Integer.optional
+      attribute? :russianFilmCritics, Types::Float | Types::Integer.optional
+      attribute? :await, Types::Float | Types::Integer.optional
+      alias film_critics filmCritics
+      alias russian_film_critics russianFilmCritics
+    end
+  end
+end

data/lib/kinopoisk_dev_api/types/watchability.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    class Watchability < Base
+      attribute? :items, Types::Array.of(WatchabilityItem)
+    end
+  end
+end

data/lib/kinopoisk_dev_api/types/watchability_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    class WatchabilityItem < Base
+      attribute? :name, Types::Coercible::String.optional
+      attribute? :logo, Logo
+      attribute? :url, Types::Coercible::String
+    end
+  end
+end

data/lib/kinopoisk_dev_api/types/year_range.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    class YearRange < Base
+      attribute? :start, Types::Float | Types::Integer.optional
+      attribute? :end, Types::Float | Types::Integer.optional
+    end
+  end
+end

data/lib/kinopoisk_dev_api/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/kinopoisk_dev_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  VERSION = "1.4.0"
+end

data/lib/kinopoisk_dev_api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
+require "zeitwerk"
+require "dry-struct"
+require "kinopoisk_dev_api/inflector"
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.inflector = KinopoiskDevApi::Inflector.new(__FILE__)
+loader.setup
+
+module KinopoiskDevApi
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/rakelib/parse_schema.rake

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "openapi3_parser"
+
+INCONSISTENT_TYPES = %w[Keyword Studio].freeze
+
+# rubocop:disable Metrics/BlockLength
+desc "Parse types from public json, should be up to date https://api.kinopoisk.dev/documentation-json"
+task :parse_schema do
+  document = Openapi3Parser.load_url("https://api.kinopoisk.dev/documentation-json")
+
+  result = document.components.schemas.to_h do |type_name, schema|
+    type_schema = schema.properties.to_h do |property_name, property_schema|
+      attribute = { type: parse_initial_type(property_schema, property_name) }
+
+      unless property_schema.any_of.nil?
+        attribute[:type] = property_schema.any_of.map { |item| property_schema.name || item.name || item.type }.uniq
+      end
+
+      attribute[:type] = attribute[:type].join if attribute[:type]&.length == 1
+
+      attribute[:nullable] = property_schema.nullable?
+
+      attribute[:required] = true if required_keys(schema).include?(property_name)
+
+      # getting required values from the description, no values in json 😔
+      required_value = property_schema.description&.match(/always “(.+)”|must be \*(.+)\*/)
+      attribute[:required_value] = (required_value[1] || required_value[2]).delete("\\") if required_value
+
+      # for some reason every property's minLength is 0 by default, probably parser bug, had to ignore that
+      attribute[:min_size] = property_schema[:minLength] if property_schema[:minLength] != 0
+      attribute[:max_size] = property_schema[:maxLength] if property_schema[:maxLength]
+
+      attribute[:items] = property_schema.items.type if property_schema&.items
+      if property_schema&.type == "array" && property_schema&.items&.type.nil?
+        attribute[:items] = property_schema&.items&.name
+      end
+
+      attribute[:items] = property_schema.items.name if property_schema&.items&.type == "object"
+
+      # array of arrays
+      if property_schema&.items&.type == "array"
+        attribute[:items] = { type: "array", items: property_schema.items.items.name }
+      end
+
+      # FIXME: dirty hack in case of https://github.com/mdwitr0/kinopoiskdev/issues/173
+      attribute[:nullable] = true if type_name == "Person" && property_name == "countAwards"
+      if INCONSISTENT_TYPES.include?(type_name) && property_name == "movies"
+        attribute[:items] = attribute[:type]
+        attribute[:type] = "array"
+      end
+
+      attribute = apply_default_schema(attribute, property_schema)
+      [property_name, attribute]
+    end
+
+    # find empty classes
+    type_schema[:type] = schema.any_of.map(&:name) if schema.properties.empty? && schema.any_of
+    [type_name, type_schema]
+  end
+
+  # Drop Error Response Schemas
+  result.reject! { |type| type.end_with?("ErrorResponseDto") }
+  File.write "#{__dir__}/../data/type_attributes.json", JSON.pretty_generate(result)
+end
+# rubocop:enable Metrics/BlockLength
+
+def required_keys(schema)
+  schema.required.to_a || []
+end
+
+def apply_default_schema(attribute, property_schema)
+  attribute[:default] = property_schema.default unless property_schema.default.nil?
+  # previous line would have been enough, but had to check the description due to issue: https://github.com/kevindew/openapi3_parser/issues/28
+  attribute[:default] = false if property_schema.description&.include?("Defaults to *false*")
+  attribute
+end
+
+def parse_initial_type(property_schema, property_name)
+  case property_schema.type
+  when nil
+    if property_schema.all_of.nil?
+      property_name.capitalize.gsub(/_(\w)/) { Regexp.last_match(1).upcase }
+    else
+      parse_initial_type(property_schema.all_of.first, property_schema.all_of.first.name)
+    end
+  when "object" then property_schema.name
+  else property_schema.type
+  end
+end

data/rakelib/rebuild_types.rake

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "json"
+require "erb"
+DRY_TYPES = %w[string integer float decimal array hash symbol boolean date date_time time range].freeze
+
+# rubocop:disable Metrics/BlockLength
+desc "Rebuild types"
+task :rebuild_types do
+  types = JSON.parse(File.read("#{__dir__}/../data/type_attributes.json"), symbolize_names: true)
+
+  types.each_pair do |name, attributes|
+    # currently there is no empty types
+    next build_empty_type(name, attributes) if attributes[:type].instance_of?(Array)
+
+    attributes.each_pair do |attr_name, properties|
+      attributes[attr_name][:type] = add_module_types(properties[:type]) unless properties[:type].is_a?(Array)
+      if properties[:type].is_a?(Array)
+        attributes[attr_name][:type] = properties[:type].map do |type|
+          add_module_types(type)
+        end.join(" | ")
+      end
+
+      if properties[:items].instance_of?(String)
+        attributes[attr_name][:type] += ".of(#{add_module_types(properties[:items])})"
+      elsif properties[:items] && properties[:items][:type] == "array"
+        attributes[attr_name][:type] += ".of(Types::Array.of(#{properties[:items][:items]}))"
+      end
+      original_type = properties[:type]
+
+      attributes = apply_required(attributes, attr_name, properties, original_type)
+      attributes = apply_min_max(attributes, attr_name, properties)
+      attributes = apply_default(attributes, attr_name, properties, original_type)
+
+      attributes[attr_name][:type] = "Types::True" if attributes[attr_name][:type] == "Types::Boolean.default(true)"
+      attributes[attr_name][:type] = attributes[attr_name][:type].gsub("Types::Boolean", "Types::Bool")
+      attributes[attr_name][:type] += ".optional" if properties[:nullable]
+    end
+
+    File.write "#{__dir__}/../lib/kinopoisk_dev_api/types/#{underscore(name)}.rb",
+               ERB.new(File.read("#{__dir__}/templates/type.erb")).result(binding).gsub(/^\s+\n/, "")
+  end
+end
+# rubocop:enable Metrics/BlockLength
+
+def build_empty_type(name, attributes)
+  attributes = attributes[:type].join(" |\n      ")
+  File.write "#{__dir__}/../lib/kinopoisk_dev_api/types/#{underscore(name)}.rb",
+             ERB.new(File.read("#{__dir__}/templates/empty_type.erb")).result(binding).gsub(/^\s+\n/, "")
+end
+
+def apply_default(attributes, attr_name, properties, original_type)
+  return attributes if properties[:default].nil?
+
+  attributes[attr_name][:type] += ".default(#{typecast(original_type,
+                                                       properties[:default])})"
+  attributes
+end
+
+def apply_required(attributes, attr_name, properties, original_type)
+  return attributes unless properties[:required_value]
+
+  attributes[attr_name][:type] += ".constrained(eql: #{typecast(original_type,
+                                                                properties[:required_value])})"
+  attributes
+end
+
+def apply_min_max(attributes, attr_name, properties)
+  return attributes unless properties[:min_size] || properties[:max_size]
+
+  constrain = ".constrained(minmax)"
+  constrain = properties[:min_size] ? constrain.gsub("min", "min_size: #{properties[:min_size]}, ") : ""
+  constrain = constrain.gsub("max", "max_size: #{properties[:max_size]}") if properties[:max_size]
+  attributes[attr_name][:type] += constrain
+  attributes
+end
+
+def add_module_types(type)
+  return %w[Types::Float Types::Integer] if type == "number"
+  return "Types::Coercible::String" if type == "string"
+
+  DRY_TYPES.include?(type) ? "Types::#{type.capitalize}" : type
+end
+
+def underscore(camel_cased_word)
+  camel_cased_word.to_s.gsub("::", "/")
+                  .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                  .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                  .tr("-", "_")
+                  .downcase
+end
+
+def typecast(type, obj)
+  type == "Types::Coercible::String" ? "'#{obj}'" : obj
+end

data/rakelib/templates/empty_type.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    <%= name %> = (
+      <%= attributes %>
+    )
+  end
+end

data/rakelib/templates/type.erb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KinopoiskDevApi
+  module Types
+    <% if name.to_s.include?('_') %>
+    ## Just for classes consistency
+    # rubocop:disable Naming/ClassAndModuleCamelCase
+    <% end %>
+    class <%= name %> < Base
+    <% attributes.each_pair do |name, properties| %>
+      <%= "attribute? :#{name}, #{properties[:type]}" %>
+    <% end %>
+
+    <% attributes.each_key do |name| %>
+      <% underscore_name = name.to_s.gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase %>
+      <% next if name.to_s == underscore_name %>
+      <%= "alias_method :#{underscore_name}, :#{name}" %>
+    <% end %>
+    end
+    <% if name.to_s.include?('_') %>
+    # rubocop:enable Naming/ClassAndModuleCamelCase
+    <% end %>
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: kinopoisk_dev_api
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Aleksandr Klimenkov
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+email:
+- prisioner@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/type_attributes.json
+- lib/kinopoisk_dev_api.rb
+- lib/kinopoisk_dev_api/client.rb
+- lib/kinopoisk_dev_api/configuration.rb
+- lib/kinopoisk_dev_api/endpoints.rb
+- lib/kinopoisk_dev_api/exceptions/base.rb
+- lib/kinopoisk_dev_api/exceptions/response_error.rb
+- lib/kinopoisk_dev_api/inflector.rb
+- lib/kinopoisk_dev_api/types.rb
+- lib/kinopoisk_dev_api/types/audience.rb
+- lib/kinopoisk_dev_api/types/base.rb
+- lib/kinopoisk_dev_api/types/birth_place.rb
+- lib/kinopoisk_dev_api/types/compactable.rb
+- lib/kinopoisk_dev_api/types/currency_value.rb
+- lib/kinopoisk_dev_api/types/death_place.rb
+- lib/kinopoisk_dev_api/types/episode_v1_4.rb
+- lib/kinopoisk_dev_api/types/external_id.rb
+- lib/kinopoisk_dev_api/types/fact_in_movie.rb
+- lib/kinopoisk_dev_api/types/fact_in_person.rb
+- lib/kinopoisk_dev_api/types/fees.rb
+- lib/kinopoisk_dev_api/types/image.rb
+- lib/kinopoisk_dev_api/types/image_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/item_name.rb
+- lib/kinopoisk_dev_api/types/keyword.rb
+- lib/kinopoisk_dev_api/types/keyword_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/linked_movie_v1_4.rb
+- lib/kinopoisk_dev_api/types/list.rb
+- lib/kinopoisk_dev_api/types/list_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/logo.rb
+- lib/kinopoisk_dev_api/types/meili_person_entity_v1_4.rb
+- lib/kinopoisk_dev_api/types/movie.rb
+- lib/kinopoisk_dev_api/types/movie_award.rb
+- lib/kinopoisk_dev_api/types/movie_award_docs_response_dto.rb
+- lib/kinopoisk_dev_api/types/movie_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/movie_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/movie_from_keyword.rb
+- lib/kinopoisk_dev_api/types/movie_from_studio.rb
+- lib/kinopoisk_dev_api/types/movie_in_person.rb
+- lib/kinopoisk_dev_api/types/name.rb
+- lib/kinopoisk_dev_api/types/network_item_v1_4.rb
+- lib/kinopoisk_dev_api/types/networks_v1_4.rb
+- lib/kinopoisk_dev_api/types/nomination.rb
+- lib/kinopoisk_dev_api/types/nomination_award.rb
+- lib/kinopoisk_dev_api/types/pattern_matching.rb
+- lib/kinopoisk_dev_api/types/person.rb
+- lib/kinopoisk_dev_api/types/person_award.rb
+- lib/kinopoisk_dev_api/types/person_award_docs_response_dto.rb
+- lib/kinopoisk_dev_api/types/person_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/person_in_movie.rb
+- lib/kinopoisk_dev_api/types/possible_value_dto.rb
+- lib/kinopoisk_dev_api/types/premiere.rb
+- lib/kinopoisk_dev_api/types/profession.rb
+- lib/kinopoisk_dev_api/types/rating.rb
+- lib/kinopoisk_dev_api/types/review.rb
+- lib/kinopoisk_dev_api/types/review_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/review_info.rb
+- lib/kinopoisk_dev_api/types/search_movie_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/search_movie_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/search_person_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/season_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/season_info.rb
+- lib/kinopoisk_dev_api/types/season_v1_4.rb
+- lib/kinopoisk_dev_api/types/short_image.rb
+- lib/kinopoisk_dev_api/types/spouses.rb
+- lib/kinopoisk_dev_api/types/studio.rb
+- lib/kinopoisk_dev_api/types/studio_docs_response_dto_v1_4.rb
+- lib/kinopoisk_dev_api/types/video.rb
+- lib/kinopoisk_dev_api/types/video_types.rb
+- lib/kinopoisk_dev_api/types/votes.rb
+- lib/kinopoisk_dev_api/types/watchability.rb
+- lib/kinopoisk_dev_api/types/watchability_item.rb
+- lib/kinopoisk_dev_api/types/year_range.rb
+- lib/kinopoisk_dev_api/version.rb
+- rakelib/parse_schema.rake
+- rakelib/rebuild_types.rake
+- rakelib/templates/empty_type.erb
+- rakelib/templates/type.erb
+homepage: https://github.com/prisioner/kinopoisk_dev_api
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/prisioner/kinopoisk_dev_api
+  source_code_uri: https://github.com/prisioner/kinopoisk_dev_api
+  changelog_uri: https://github.com/prisioner/kinopoisk_dev_api/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby wrapper for unofficial Kinopoisk API
+test_files: []