kinopoisk_unofficial_api 1.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5aa0ff48084fede2dc372c7508fda7860b8655c92a3226043230ee8157bb0fd6
+  data.tar.gz: 258c30f78eec6712857d9d5dd4db559c2e7b3436ef853e0f22290ce1b370455d
+SHA512:
+  metadata.gz: dfa51875a54a9b605f3faadabb14ae9e709080acdd881771eea8a6bacc93267aa62513e583bc9985be6449c7f2e94fc518ecbe7c76c0e97a922c992bebdfee10
+  data.tar.gz: 00d23a90ed1acd589717f149e7aae6dc5c5efc1108c7412d3a65f50fb85fb3172da4066fffcebf3ff01e83bae94c4430699f0512940e87b70c5f2357e9a47d87

data/.env.example

@@ -0,0 +1 @@
+X_API_KEY=

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+---
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+plugins:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2025-04-09
+
+- Initial release version

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aleksandr Klimenkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# kinopoisk_unofficial_api
+
+Ruby wrapper for [Kinopoisk Unofficial API](https://kinopoiskapiunofficial.tech/documentation/api/).
+
+[![Gem Version](https://badge.fury.io/rb/kinopoisk_unofficial_api.svg)](http://badge.fury.io/rb/kinopoisk_unofficial_api)
+[![Build Status](https://github.com/prisioner/kinopoisk_unofficial_api_client/actions/workflows/main.yml/badge.svg)](https://github.com/prisioner/kinopoisk_unofficial_api_client/actions)
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'kinopoisk_unofficial_api', '~> 1.0.0'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it system-wide:
+
+```shell
+gem install kinopoisk_unofficial_api
+```
+
+## Usage
+
+First things first, you need to [obtain an Api Key](https://kinopoiskapiunofficial.tech/) for your client.
+Then create your API Client like this:
+
+```ruby
+require 'kinopoisk_unofficial_api'
+
+api_key = 'YOUR_KINOPOISK_UNOFFICIAL_API_API_KEY'
+
+client = KinopoiskUnofficialApi::Client.new(api_key)
+
+shawshank_redemption = client.film(id: 326)
+
+# attributes accessible with snake_case methods
+shawshank_redemption.kinopoisk_id     # => 326
+shawshank_redemption.imdb_id          # => "tt0111161"
+shawshank_redemption.rating_kinopoisk # => 9.1
+shawshank_redemption.rating_imdb      # => 9.3
+shawshank_redemption.name_ru          # => "Побег из Шоушенка"
+shawshank_redemption.name_original    # => "The Shawshank Redemption"
+
+# attributes accessible with hash keys
+shawshank_redemption[:kinopoisk_id]    # => 326
+shawshank_redemption[:name_original]   # => "The Shawshank Redemption"
+
+# #to_h also converts to hash
+shawshank_redemption.to_h # => {kinopoisk_id: 326, kinopoisk_hdid:  ...}
+
+# nested objects accessible
+shawshank_redemption.countries.first.country # => "США"
+
+# keys could be in snake or camel cases
+# genres and countries could be passed with names or ids
+# ids could be obtained via client.film_filters
+query_params = {
+  genres: 'фантастика', # case insensitive, ids, strings and symbols allowed
+  type: :tv_series,     # case insensitive, strings and symbols allowed
+  rating_from: 7.5,     # float and integers allowed
+  rating_to: 10,        # float and integers allowed
+  year_from: 2019,
+  year_to: 2024,
+  countries: 'Россия',  # case insensitive, ids, strings and symbols allowed
+  keyword: 'деревня'
+}
+
+# will provoke request with following params:
+# https://kinopoiskapiunofficial.tech/api/v2.2/films
+#   ?countries=34
+#   &genres=6
+#   &keyword=%D0%B4%D0%B5%D1%80%D0%B5%D0%B2%D0%BD%D1%8F
+#   &order=RATING
+#   &page=1
+#   &ratingFrom=7.5
+#   &ratingTo=10
+#   &type=TV_SERIES
+#   &yearFrom=2019
+#   &yearTo=2024
+
+movies = client.movie(query_params)
+```
+
+Implemented all endpoints of API v2.2.
+
+Mapping client method names to endpoints available in [lib/kinopoisk_unofficial_api/endpoints.rb](lib/kinopoisk_unofficial_api/endpoints.rb)
+
+## Overriding countries and genres name-to-id mapping
+
+If you want override mapping
+
+1. Actual mapping could be learned from [data/countries.json](data/countries.json) and [data/genres.json](data/genres.json)
+
+2. Make your own `.json` files
+
+```json
+// my_genres.json
+[
+  {
+    "id": 10,
+    "genre": "Western"
+  },
+  {
+    "id": 13,
+    "genre": "Comedy"
+  },
+  {
+    "id": 6,
+    "genre": "Sci-Fi"
+  }
+]
+
+// my_countries.json
+[
+  {
+    "id": 1,
+    "country": "USA"
+  },
+  {
+    "id": 3,
+    "country": "France"
+  },
+  {
+    "id": 33,
+    "country": "USSR"
+  },
+  {
+    "id": 34,
+    "country": "Russia"
+  }
+]
+```
+
+4. Configure gem
+
+```ruby
+KinopoiskUnofficialApi.configure do |config|
+  config.genres = JSON.parse(File.read("my_genres.json"), symbolize_names: true)
+  config.countries = JSON.parse(File.read("my_countries.json"), symbolize_names: true)
+end
+```
+
+5. You can use your names in client.films
+
+```ruby
+client.films(genres: :western, countries: 'USA')
+```
+
+## Proxy
+
+You can set up your own proxy and use it to access Kinopoisk Unofficial API.
+In this case you need to configure API URL:
+
+```ruby
+KinopoiskUnofficialApi::Client.run(api_key, url: 'https://proxy.example.com') do |bot|
+  # ...
+end
+```
+
+## Connection adapters
+
+We rely on [faraday](https://github.com/lostisland/faraday) under the hood.
+You can use any of supported adapters (for example, `net/http/persistent`):
+
+```ruby
+require 'net/http/persistent'
+
+KinopoiskUnofficialApi.configure do |config|
+  config.adapter = :net_http_persistent
+end
+```
+
+## Contributing
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new Pull Request.

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = false
+  task.options = %w[--force-exclusion]
+  task.patterns = %w[{lib,spec}/**/*.rb Rakefile Gemfile rakelib/*.rake *.gemspec]
+  task.requires << "rubocop-rspec"
+end
+
+task default: %i[spec rubocop]