KinopoiskAPI 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7afc41b11af49e12d3b259a454b831fd286e5f57
-  data.tar.gz: 2a56181c33f432ee83855bfa127cb47e0d71fb8e
+  metadata.gz: 179e576c676fab3f3b46e0b86693a8fe4b87613e
+  data.tar.gz: 21661aef4cd08b1a2f991a49c40529bd2f020fde
 SHA512:
-  metadata.gz: dfc3fb6668ebe82a14e89bb5a39f9bafa824797a0e76e5641472bbf56cf1adade6c404352f27cf8540d5c67ee02c48ed1b7d8ede2456b2468296f6c8f488e69d
-  data.tar.gz: 3513459760d2da9402dc3a438f676b1957638f2798ad78e16024e05c03760c34d73b4e68c3ad9ecd7dc54b141326ddc8d3a1aa99c4a7ccb179a55ca9ea38af0e
+  metadata.gz: 5daf562303b3e50047b44df0b41933894f005a6ea4b9c604de94e1c482862b3dde27580ea815531e4f5983b3d43d00d66d4df7f81210bce5794f31b8c54b2e87
+  data.tar.gz: e46bf93b44dc2fed91afe050a302ff07b710a50ea151ac37fc7a0ee27f452e0cd843de0a8ea38f3291a9bc388a4fd860e1ea0da7d3eddac681f42d5a8af7af0d

data/.gitignore

@@ -8,5 +8,7 @@
 /spec/reports/
 /tmp/
 
+*.old
+
 # rspec failure tracking
 .rspec_stat

data/README.md

@@ -2,17 +2,16 @@
 
 Этот gem создан для упрощения работы с КиноПоиск API в проектах Ruby on Rails.
 
-Гем основан официальном API от кинопоиска. Используется не официально, прикидываясь андройдом.
-Данный гем являеться форком проекта afuno/Kinopoisk-API-Gem, но т.к http://api.kinopoisk.cf/ не работает, то пришлось переделать для работы на прямую с кинопоиском.
+Гем основан официальном API от кинопоиска. Используется не официально, прикидываясь андройдом. Данный гем являеться форком проекта afuno/Kinopoisk-API-Gem, но т.к http://api.kinopoisk.cf/ не работает, то пришлось переделать для работы на прямую с кинопоиском.
 
-Используется версия api 3.11.0
+Используется версия api 3.11.0 (планируется перевести на 5.0.0)
 
 ## Установка
 
 Добавьте эту строку в Gemfile вашего приложения:
 
 ```ruby
-gem 'KinopoiskAPI' , github: 'alpha-ver/Kinopoisk-API-Gem', branch: 'master'
+gem 'KinopoiskAPI'
 ```
 
 Затем выполните:
@@ -22,261 +21,236 @@ gem 'KinopoiskAPI' , github: 'alpha-ver/Kinopoisk-API-Gem', branch: 'master'
 
 ## Использование
 
-### Фильм
+### Глабальные функции
 
 ```ruby
-film = KinopoiskAPI::Film.new(733493)
+api = KinopoiskAPI::Class 
 ```
+
 ```ruby
-#   Вся информация о фильме
-film.all
+api.status 
+#   > true  [Полученна следующая станица]
+#   > false [Достигли конца пагинации]
 ```
+
 ```ruby
-#   Название фильма на русском
-film.title[:ru]
+#   Оригинальный хеш кинопоиска
+api.data 
 ```
+
 ```ruby
-#   Название фильма на английском
-film.title[:en]
+#   Оригинальный хеш кинопоиска (используется в некоторых классах для дополнительного запроса). 
+#   Пример: __film.peoples_full__)
+api.data2 
 ```
 
-Доступен вывод следующей информации:
-
-* **id** - КиноПоиск ID
-* **url** - URL адрес страницы на КиноПоиск
-* **title** - Названия:
-    * **ru** - На русском
-    * **en** - На английском
-* **slogan** - Слоган
-* **description** - Описание
-* **poster** - Полный адрес на постер (в формате JPG)
-* **year** - Год выхода
-* **kinopoisk** - Массив следующих данных для КиноПоиск:
-    * **rating** - Рейтинг
-    * **quantity** - Количество оценивших
-    * **good_reviews_in_percentage** - Количество положительных рецензий в процентах
-    * **number_of_good_reviews** - Количество положительных рецензий
-    * **waiting_in_percentage** - Количество ожидающих в процентах
-    * **number_of_waiting** - Количество ожидающих
-    * **film_critics_in_percentage** - Положительны рейтинг критиков в мире в процентах
-    * **film_critics** - Количество положительных оценок критиков в мире
-    * **rf_critics_in_percentage** - Положительны рейтинг критиков в РФ в процентах
-    * **rf_critics** - Количество положительных оценок критиков в РФ
-* **imdb** - Массив следующих данных для IMDb:
-    * **id** - IMDb ID
-    * **rating** - Рейтинг
-    * **quantity** - Количество оценивших
-* **number_of_reviews** - Количество рецензий
-* **duration** - Продолжительность фильма
-* **countries** - Массив со странами
-* **genres** - Массив с жанрами
-* **video** - Полный адрес на трейлер
-* **is_sequel_or_prequel** - Имеет ли сиквелы или приквелы
-* **is_similar_films** - Имеет ли родственные фильмы
-* **is_imax** - Есть ли IMAX
-* **is_3d** - Есть ли 3D
-* **rating_mpaa** - Рейтинг MPAA
-* **minimal_age** - Минимальный рекомендуемый возраст
-* **premiere** - Массив данных о премьере:
-    * **ru** - Дата премьеры в РФ
-    * **world** - Дата премьеры в мире
-    * **world_country** - Страна премьеры
-* **status** - Проверка полученного JSON (true или false)
 
-### Режисеры, актеры, операторы и т. д.
+```ruby
+#   Статус парсинга json 
+#   Boolean
+api.status 
+```
 
 ```ruby
-staff = KinopoiskAPI::Staff.new(733493)
+#   Статус парсинга json дополнительного запроса.
+#   Boolean
+api.status2
 ```
+
+### Исключения 
+
+При ошибке выбасывается исключение __KinopoiskAPI::APIerror__. Доступные методы.
+
 ```ruby
-#   Все имена всех профессий
-staff.all
+# http код ответа
+e.code
+=> "404"
 ```
+
 ```ruby
-#   Все имена одной профессии
-staff.profession('writer')
+# Тело ответа
+e.body
+=> [key:false]
 ```
 
-Доступен вывод следующей информации:
 
-* **id** - Идентификатор имени на сайте КиноПоиск
-* **url** - URL на страницу именина КиноПоиск
-* **full_name** - Имена:
-    * **ru** - На русском
-    * **en** - На английском
-* **poster** - Полный адрес на постер (в формате JPG)
-* **profession** - Профессия на русском (актер, режиссер и т. д.)
-* **status** - Проверка полученного JSON (true или false)
+## Классы 
+
+### Фильм
 
-### Галерея
+```ruby
+film = KinopoiskAPI::Film.new(film_id)
+```
 
 ```ruby
-gallery = KinopoiskAPI::Gallery.new(733493)
+#   Вся информация о фильме(включая rating, rent, budget).
+film.view
 ```
 ```ruby
-#   Все изображения из всех разделов
-gallery.all
+# Рейтинги фильма и т.д.
+film.rating
 ```
 ```ruby
-#   Все изображения из конкретного раздела
-gallery.section('poster')
+# Даты премьер и т.д.
+film.rent
 ```
 
-Доступен вывод следующей информации:
+```ruby
+# Бюджет и сборы.
+film.budget
+```
 
-* **image** - Полный адрес на полное изображение (в формате JPG)
-* **preview** - Полный адрес на превью (в формате JPG)
-* **status** - Проверка полученного JSON (true или false)
+```ruby
+# Люди связанные с фильмом(Не полный список, смотрите ниже).
+film.peoples
+```
 
-### Похожие
+```ruby
+# Люди связанные с фильмом(Полный список). Генерирует новый запрос к API.
+film.peoples_full
+```
+
+
+### Люди(Режисеры, актеры, операторы и т.д.).
+
+```ruby
+people = KinopoiskAPI::People.new(people_id)
+```
 
 ```ruby
-similar = KinopoiskAPI::Similar.new(733493)
+# Детальная информация о человеке.
+people.view
 ```
+
 ```ruby
-#   Все похожие фильмы
-similar.all
+# Фильмы связанные с конкретным человеком.
+people.films
 ```
 
-Доступен вывод следующей информации:
+```ruby
+# Массив id фильмов связанных с конкретным человеком.
+people.films_ids
+```
 
-* **title** - Названия:
-    * **ru** - На русском
-    * **en** - На английском
-* **year** - Год выхода
-* **rating** - Рейтинг
-* **number_of_rated** - Количество оценивших
-* **poster** - Полный адрес на постер (в формате JPG)
-* **duration** - Продолжительность фильма
-* **countries** - Массив со странами
-* **genres** - Массив с жанрами
-* **status** - Проверка полученного JSON (true или false)
 
-### Жанры
+### Категории
 
 ```ruby
-genres = KinopoiskAPI::Genres.new
+category = KinopoiskAPI::Category.new
 ```
+
 ```ruby
-#   Все жанры
-genres.all
+# Страны
+category.countries
 ```
 
-Доступен вывод следующей информации:
+```ruby
+# Жанры
+category.genres
+```
 
-* **id** - Идентификатор жанра на сайте КиноПоиск
-* **name** - Жанр на русском
-* **status** - Проверка полученного JSON (true или false)
 
 ### Сегодня в кино
 
 ```ruby
 today = KinopoiskAPI::TodayFilms.new
 ```
+
 ```ruby
 #   Список фильмов
-today.all
+today.view
+```
+
+```ruby
+#   Массив id фильмов
+today.film_ids
+```
+
+### Глобальный поиск
+
+```ruby
+search = KinopoiskAPI::GlobalSearch.new('Q')
+```
+```ruby
+#   Скорее всего вы искали этот фильм
+search.exactly
+```
+```ruby
+#   Возможно, вы искали эти фильмы
+search.maybe
+```
+```ruby
+#   Или даже этих людей
+search.peoples
 ```
 
-Доступен вывод следующей информации:
 
-* **id** - Идентификатор жанра на сайте КиноПоиск
-* **status** - Проверка полученного JSON (true или false)
+### Поиск по фильмам
 
+```ruby
+search = KinopoiskAPI::FilmSearch.new('Q')
+```
 
+```ruby
+#   Список фильмов (не более 20)
+search.view
+```
 
+```ruby
+#   Колличество найденных фильмов
+search.films_count
+```
 
-### Глобавльный поиск
+```ruby
+#   Текущая страница
+search.current_page
+```
 
 ```ruby
-global_search = KinopoiskAPI::GlobalSearch.new('Звездные')
+#   Колличество страниц
+search.page_count
 ```
+
 ```ruby
-#   Скорее всего вы искали этот фильм
-global_search.exactly
+#   Следующая страница
+search.next_page
+#   > true  [Полученна следующая станица]
+#   > false [Достигли конца пагинации]
 ```
+
+
+### Поиск по людям
+
 ```ruby
-#   Возможно, вы искали эти фильмы
-global_search.maybe
+search = KinopoiskAPI::PeopleSearch.new('Q')
+```
+
+```ruby
+#   Список людей (не более 20)
+search.view
 ```
+
 ```ruby
-#   Или даже этих людей
-global_search.names
-```
-
-Доступен вывод следующей информации:
-
-* **all** - Полный массив данных
-* **keyword** - Ключевое слово (запрос)
-* **number_of_films** - Количество найденных фильмов по ключевому слову
-* **number_of_names** - Количество найденных имен по ключевому слову
-* **exactly** - Один, наиболее подходящий фильм:
-    * **title** - Названия:
-        * **ru** - На русском
-        * **en** - На английском
-    * **info** - Краткая информация
-    * **duration** - Продолжительность фильма
-    * **year** - Год выхода
-    * **countries** - Массив со странами
-    * **genres** - Массив с жанрами
-    * **rating** - Рейтинг
-    * **number_of_rated** - Количество оценивших
-    * **poster** - Полный адрес на постер (в формате JPG)
-* **maybe** - Список фильмов, которые также подходят под запрос:
-    * **title** - Названия:
-        * **ru** - На русском
-        * **en** - На английском
-    * **info** - Краткая информация
-    * **duration** - Продолжительность фильма
-    * **year** - Год выхода
-    * **countries** - Массив со странами
-    * **genres** - Массив с жанрами
-    * **rating** - Рейтинг
-    * **number_of_rated** - Количество оценивших
-    * **poster** - Полный адрес на постер (в формате JPG)
-* **names** - Список имен, которые также подходят под запрос:
-    * **full_name** - Имена:
-        * **ru** - На русском
-        * **en** - На английском
-    * **info** - Краткая информация
-    * **poster** - Полный адрес на постер (в формате JPG)
-* **status** - Проверка полученного JSON (true или false)
-
-### Рецензии
-
-```ruby
-reviews = KinopoiskAPI::Reviews.new(733493)
-```
-```ruby
-#   Количество рецензий
-reviews.quantity[:reviews]
-```
-```ruby
-#   Рецензии
-reviews.reviews
-```
-
-Доступен вывод следующей информации:
-
-* **all** - Полный массив данных
-* **pages** - Количество страниц
-* **page** - Текущая страница
-* **quantity** - Массив следующих данных:
-    * **reviews** - Количество рецензий
-    * **good_reviews** - Количество положительных рецензий
-    * **good_reviews_in_percent** - Количество положительных рецензий в процентах
-    * **bad_reviews** - Количество отризательных рецензий
-    * **neutral_reviews** - Количество нейтральных рецензий
-* **reviews** - Список рецензий:
-    * **id** - Идентификатор на КиноПоиск
-    * **type** - Тип: положительный, негативный или нейтральный
-    * **data** - Дата и время публикации
-    * **author** - Массив данных об авторе:
-        * **name** - Имя (или никнейм) автора рецензии
-        * **avatar** - Полный адрес на аватар (в формате JPG)
-    * **title** - Заголовок
-    * **description** - Описание
-* **status** - Проверка полученного JSON (true или false)
+#   Колличество найденных фильмов
+search.peoples_count
+```
+
+```ruby
+#   Текущая страница
+search.current_page
+```
+
+```ruby
+#   Колличество страниц
+search.page_count
+```
+
+```ruby
+#   Следующая страница
+search.next_page
+#   > true  [Полученна следующая станица]
+#   > false [Достигли конца пагинации]
+```
 
 ## License