kinopoisk_dev_api 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2eb814c413cab628bdb504f429f95e51728ab2db462e370ced35d1712ed0559b
+  data.tar.gz: '0169b7b381761e92c16edbe2399f876d1118aa29bd8a2a5030f5f1a85e851f48'
+SHA512:
+  metadata.gz: 00a27da724cb4e67d33d50c68132144725dfff3e600147bc64f03368456501ed9b4daa75585c0e34dd818c1594dbf61bf6e835c48031edcf6fa37b65d69fdfff
+  data.tar.gz: 34f17419254d87257a83cecf7fe1b13b5b6796fc84c38ea46ff5358805948aa5ae2c866a03394ba017d80c519f99aa8eec9e913dcdb6bcb63f4c2f0d18aeb630

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,5 @@
+# Changelog
+
+## [1.4.0] - 2025-04-07
+
+- Initial release v1.4.0 (API v1.4 supported)

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,118 @@
+# kinopoisk_dev_api
+
+Ruby wrapper for [Unofficial Kinopoisk Dev API](https://api.kinopoisk.dev/documentation).
+
+[![Gem Version](https://badge.fury.io/rb/kinopoisk_dev_api.svg)](http://badge.fury.io/rb/kinopoisk_dev_api)
+[![Build Status](https://github.com/prisioner/kinopoisk_dev_api/actions/workflows/main.yml/badge.svg)](https://github.com/prisioner/kinopoisk_dev_api/actions)
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'kinopoisk_dev_api', '~> 1.4.0'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it system-wide:
+
+```shell
+gem install kinopoisk_dev_api
+```
+
+## Usage
+
+First things first, you need to [obtain an Api Key](https://api.kinopoisk.dev/documentation) for your client.
+Then create your API Client like this:
+
+```ruby
+require 'kinopoisk_dev_api'
+
+api_key = 'YOUR_KINOPOISK_DEV_API_KEY'
+
+client = KinopoiskDevApi::Client.new(api_key)
+
+shawshank_redemption = client.movie_by_id(id: 326)
+
+# attributes accessible with snake_case and camelCase methods
+shawshank_redemption.id               # => 326
+shawshank_redemption.alternative_name # => "The Shawshank Redemption"
+shawshank_redemption.alternativeName  # => "The Shawshank Redemption"
+
+# attributes accessible only with camelCase hash keys
+shawshank_redemption[:id]                # => 326
+shawshank_redemption[:alternativeName]   # => "The Shawshank Redemption"
+shawshank_redemption[:alternative_name]  # => nil
+
+# #to_h also converts to hash with camelCase keys
+shawshank_redemption.to_h # => {id: 326, alternativeName: "The Shawshank Redemption", ...}
+
+# nested objects accessible
+shawshank_redemption.persons.first.en_name # => "Tim Robbins"
+
+# search queries
+from_date = DateTime.parse('2019-10-01 00:00:00')
+to_date = DateTime.parse('2023-01-31 23:00:00')
+
+# keys could be in snake or camel cases, attribute name in values should be in camelCase
+# TrueClass, FalseClass, Date, Time, DateTime, Range, Array, String types supported
+query_params = {
+  select_fields: %w[id name alternativeName],
+  is_series: true,
+  'rating.kp' => '7.5-10',
+  'rating.imdb' => 8..10,
+  'premiere.world' => from_date..to_date,
+  'genres.name' => %w[+драма !мелодрама]
+}
+
+# will provoke request with following params:
+# https://api.kinopoisk.dev/v1.4/movie?
+#   genres.name=%2B%D0%B4%D1%80%D0%B0%D0%BC%D0%B0&genres.name=%21%D0%BC%D0%B5%D0%BB%D0%BE%D0%B4%D1%80%D0%B0%D0%BC%D0%B0
+#   &isSeries=true
+#   &premiere.world=01.10.2019-31.01.2023
+#   &rating.imdb=8-10
+#   &rating.kp=7.5-10
+#   &selectFields=id&selectFields=name&selectFields=alternativeName
+movies = client.movie(query_params)
+```
+
+Implemented all endpoints of API v1.4. 
+
+Mapping client method names to endpoints available in [lib/kinopoisk_dev_api/endpoints.rb](lib/kinopoisk_dev_api/endpoints.rb)
+
+## Proxy
+
+You can set up your own proxy and use it to access Kinopoisk Dev API.
+In this case you need to configure API URL:
+
+```ruby
+KinopoiskDevApi::Client.run(token, 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'
+
+KinopoiskDevApi.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]