kinopoisk_unofficial_api 1.0.0.1

data/lib/kinopoisk_unofficial_api/types/person_response/film.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class PersonResponse < Base
+      class Film < Base
+        attribute? :film_id, Types::Integer
+        attribute? :name_ru, Types::String.optional
+        attribute? :name_en, Types::String.optional
+        attribute? :rating, Types::String.optional
+        attribute? :general, Types::Bool
+        attribute? :description, Types::String.optional
+        attribute? :profession_key, Types::String
+      end
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/person_response/spouse.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class PersonResponse < Base
+      class Spouse < Base
+        attribute? :person_id, Types::Integer
+        attribute? :name, Types::String.optional
+        attribute? :divorced, Types::Bool
+        attribute? :divorced_reason, Types::String.optional
+        attribute? :sex, Types::String
+        attribute? :children, Types::Integer
+        attribute? :web_url, Types::String
+        attribute? :relation, Types::String
+      end
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/person_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class PersonResponse < Base
+      attribute :person_id, Types::Integer
+      attribute :web_url, Types::String.optional
+      attribute :name_ru, Types::String.optional
+      attribute :name_en, Types::String.optional
+      attribute :sex, Types::String.optional
+      attribute :poster_url, Types::String
+      attribute :growth, Types::Integer.optional
+      attribute :birthday, Types::String.optional
+      attribute :death, Types::String.optional
+      attribute :age, Types::Integer.optional
+      attribute :birthplace, Types::String.optional
+      attribute :deathplace, Types::String.optional
+      attribute :has_awards, Types::Integer.optional
+      attribute :profession, Types::String.optional
+      attribute :facts, Types::Array.of(Types::String)
+      attribute :spouses, Types::Array.of(PersonResponse::Spouse)
+      attribute :films, Types::Array.of(PersonResponse::Film)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/premiere_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class PremiereResponse < Base
+      attribute :total, Types::Integer
+      attribute :items, Types::Array.of(PremiereResponseItem)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/premiere_response_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class PremiereResponseItem < Base
+      attribute :kinopoisk_id, Types::Integer
+      attribute :name_ru, Types::String.optional
+      attribute :name_en, Types::String.optional
+      attribute :year, Types::Integer
+      attribute :poster_url, Types::String
+      attribute :poster_url_preview, Types::String
+      attribute :countries, Types::Array.of(Country)
+      attribute :genres, Types::Array.of(Genre)
+      attribute :duration, Types::Integer.optional
+      attribute :premiere_ru, Types::String
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/related_film_response/item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class RelatedFilmResponse < Base
+      class Item < Base
+        attribute? :film_id, Types::Integer
+        attribute? :name_ru, Types::String.optional
+        attribute? :name_en, Types::String.optional
+        attribute? :name_original, Types::String.optional
+        attribute? :poster_url, Types::String
+        attribute? :poster_url_preview, Types::String
+        attribute? :relation_type, Types::String
+      end
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/related_film_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class RelatedFilmResponse < Base
+      attribute :total, Types::Integer
+      attribute :items, Types::Array.of(RelatedFilmResponse::Item)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/review_response/item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class ReviewResponse < Base
+      class Item < Base
+        attribute? :kinopoisk_id, Types::Integer
+        attribute? :type, Types::String
+        attribute? :date, Types::String
+        attribute? :positive_rating, Types::Integer
+        attribute? :negative_rating, Types::Integer
+        attribute? :author, Types::String
+        attribute? :title, Types::String.optional
+        attribute? :description, Types::String
+      end
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/review_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class ReviewResponse < Base
+      attribute :total, Types::Integer
+      attribute :total_pages, Types::Integer
+      attribute :total_positive_reviews, Types::Integer
+      attribute :total_negative_reviews, Types::Integer
+      attribute :total_neutral_reviews, Types::Integer
+      attribute :items, Types::Array.of(ReviewResponse::Item)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/season.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class Season < Base
+      attribute :number, Types::Integer
+      attribute :episodes, Types::Array.of(Episode)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/season_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class SeasonResponse < Base
+      attribute :total, Types::Integer
+      attribute :items, Types::Array.of(Season)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/staff_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class StaffResponse < Base
+      attribute :staff_id, Types::Integer
+      attribute :name_ru, Types::String.optional
+      attribute :name_en, Types::String.optional
+      attribute :description, Types::String.optional
+      attribute :poster_url, Types::String
+      attribute :profession_text, Types::String
+      attribute :profession_key, Types::String
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/video_response/item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class VideoResponse < Base
+      class Item < Base
+        attribute? :url, Types::String
+        attribute? :name, Types::String
+        attribute? :site, Types::String
+      end
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types/video_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class VideoResponse < Base
+      attribute :total, Types::Integer
+      attribute :items, Types::Array.of(VideoResponse::Item)
+    end
+  end
+end

data/lib/kinopoisk_unofficial_api/types.rb

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

data/lib/kinopoisk_unofficial_api/version.rb

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

data/lib/kinopoisk_unofficial_api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
+require "zeitwerk"
+require "dry-struct"
+require_relative "kinopoisk_unofficial_api/version"
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.inflector.inflect("endpoints" => "ENDPOINTS")
+loader.setup
+
+module KinopoiskUnofficialApi
+  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,103 @@
+# frozen_string_literal: true
+
+require "openapi3_parser"
+
+INCONSISTENT_TYPES = {
+  "year" => %w[FilmCollectionResponse::Item KinopoiskUserVoteResponse::Item].freeze,
+  "growth" => %w[PersonResponse].freeze
+}.freeze
+
+# rubocop:disable Metrics/BlockLength
+desc "Parse types from public json, should be up to date https://kinopoiskapiunofficial.tech/documentation/api/"
+task :parse_schema do
+  document = Openapi3Parser.load_url("https://kinopoiskapiunofficial.tech/documentation/api/openapi.json")
+
+  result = document.components.schemas.to_h do |type_name, schema|
+    type_name = cast_underscored_type(type_name)
+
+    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"
+
+      attribute[:items] = cast_underscored_type(attribute[:items]) if attribute[:items]
+
+      # hacks to fix documentation bugs
+      attribute[:nullable] = true if type_name == "Distribution" && property_name == "country"
+      attribute[:type] = "integer" if INCONSISTENT_TYPES["year"].include?(type_name) && property_name == "year"
+      attribute[:type] = "integer" if INCONSISTENT_TYPES["growth"].include?(type_name) && property_name == "growth"
+
+      attribute = apply_default_schema(attribute, property_schema)
+
+      underscored_property_name = property_name.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
+      [underscored_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
+
+  File.write "#{__dir__}/../data/type_attributes.json", JSON.pretty_generate(result.except("ApiError"))
+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)
+  initial_type =
+    case property_schema.type
+    when nil then property_name.capitalize.gsub(/_(\w)/) { Regexp.last_match(1).upcase }
+    when "object" then property_schema.name
+    else property_schema.type
+    end
+
+  cast_underscored_type(initial_type)
+end
+
+def cast_underscored_type(type_name)
+  return type_name unless type_name.include?("_")
+
+  parts = type_name.split("_")
+  parts[1] =
+    case parts[1]
+    when "countries" then "Country"
+    when /s$/ then parts[1][0..-2].capitalize
+    when /([a-z\d])([A-Z])/ then parts[1].gsub(/([a-z\d])([A-Z])/, '\1_\2').split("_").map(&:capitalize).join
+    else parts[1]
+    end
+
+  parts.join("::")
+end

data/rakelib/rebuild_types.rake

@@ -0,0 +1,105 @@
+# 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|
+    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
+
+    next build_nested_type(name, attributes) if name.to_s.include?("::")
+
+    File.write "#{__dir__}/../lib/kinopoisk_unofficial_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_unofficial_api/types/#{underscore(name)}.rb",
+             ERB.new(File.read("#{__dir__}/templates/empty_type.erb")).result(binding).gsub(/^\s+\n/, "")
+end
+
+def build_nested_type(name, attributes)
+  namespace_name, type_name = name.to_s.split("::")
+
+  dir_path = "#{__dir__}/../lib/kinopoisk_unofficial_api/types/#{underscore(namespace_name)}"
+  FileUtils.mkdir_p(dir_path)
+
+  File.write "#{__dir__}/../lib/kinopoisk_unofficial_api/types/#{underscore(name)}.rb",
+             ERB.new(File.read("#{__dir__}/templates/nested_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 "Types::Float | Types::Integer" if type == "number"
+
+  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::String" ? "'#{obj}'" : obj
+end

data/rakelib/templates/empty_type.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    ## Just for classes consistency
+    # rubocop:disable Naming/ConstantName
+    <%= name %> = (
+      <%= attributes %>
+    )
+    # rubocop:enable Naming/ConstantName
+  end
+end

data/rakelib/templates/nested_type.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class <%= namespace_name %> < Base
+      class <%= type_name %> < Base
+      <% attributes.each_pair do |name, properties| %>
+        <%= "#{properties[:required] ? 'attribute' : 'attribute?'} :#{name}, #{properties[:type]}" %>
+      <% end %>
+      end
+    end
+  end
+end

data/rakelib/templates/type.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module KinopoiskUnofficialApi
+  module Types
+    class <%= name %> < Base
+    <% attributes.each_pair do |name, properties| %>
+      <%= "#{properties[:required] ? 'attribute' : 'attribute?'} :#{name}, #{properties[:type]}" %>
+    <% end %>
+    end
+  end
+end