kp_api 0.10.0

data/lib/kp_api/today.rb

@@ -0,0 +1,56 @@
+module KpApi
+  class Today < Agent
+    attr_accessor :url
+
+    def initialize(city_id=1, country_id=2)
+      @url = "#{DOMAINS[:api]}#{METHODS[:get_today_films][:method]}?cityID=#{city_id}&countryID=#{country_id}"
+      @json = json
+
+      unless status
+        raise ApiError.new(@json[:message], @json[:data])
+      end
+    end
+
+    def view
+
+      films.map do |film|
+        {
+          id:                     int_data(String, film['id'          ]),
+          kp_type:                str_data(String, film['type'        ]),
+          name_ru:                str_data(String, film['nameRU'      ]),
+          name_en:                str_data(String, film['nameEN'      ]),
+          slogan:                 str_data(String, film['slogan'      ]),
+          description:            str_data(String, film['description' ]),
+          poster_url:             url_data(String, film['posterURL'   ], film["id"], :film),
+          year:                   int_data(String, film['year'        ]),
+          reviews_count:          int_data(String, film['reviewsCount']),
+          duration:               min_data(String, film['filmLength'  ]),
+          countries:              arr_data(String, film['country'     ]),
+          genres:                 arr_data(String, film['genre'       ]),
+          video:                  film['videoURL'],
+          is_sequel_or_prequel:   bool_data(String, film['hasSequelsAndPrequelsFilms']),
+          is_similar_films:       bool_data(String, film['hasRelatedFilms'           ]),
+          is_imax:                bool_data(String, film['isIMAX'                    ]),
+          is_3d:                  bool_data(String, film['is3D'                      ]),
+          rating_mpaa:            str_data(String,  film['ratingMPAA'                ]),
+          minimal_age:            int_data(String,  film['ratingAgeLimits'           ])
+        }
+      end
+    end
+
+    def film_ids
+      films.map{|film| int_data(String, film['id'], nil) }.compact
+    end
+
+    private
+
+      def films
+        if @json['filmsData'].nil?
+          []
+        else
+          @json['filmsData']
+        end
+      end
+
+  end
+end

data/lib/kp_api/top.rb

@@ -0,0 +1,57 @@
+module KpApi
+  class Top < Agent
+    attr_accessor :url
+
+    def initialize(top_list=nil)
+      if !top_list.nil? && !METHODS[:get_top][:types][top_list].nil?
+        @type       = METHODS[:get_top][:types][top_list]
+        @page       = 1
+        gen_url
+        @json       = json
+        @page_count = @json['pagesCount']
+      else
+        #todo
+        raise ArgumentError
+      end
+    end
+
+
+    def view
+      @json['items'].map do |film|
+        film_hash(film,'id')
+      end
+    end
+
+    def view_all(limit=15)
+      all = view
+      while @page <= limit && next_page
+        all += @json['items'].map do |film|
+          film_hash(film,'id')
+        end
+      end
+      all
+    end
+
+    def ids_all(limit=15)
+      all = @json['items'].map{|film| film['id']}
+      while @page <= limit && next_page
+        all += @json['items'].map do |film|
+          film['id']
+        end
+      end
+      all
+    end
+
+    private
+
+      def gen_url
+        @url = [
+          "#{DOMAINS[:api]}#{METHODS[:get_top][:method]}",
+          "?#{METHODS[:get_top][:type]}=#{@type}",
+          "&#{METHODS[:get_top][:page]}=#{@page}"
+        ].join('')
+      end
+
+
+  end
+end

data/lib/kp_api/version.rb

@@ -0,0 +1,3 @@
+module KpApi
+  VERSION = "0.10.0"
+end

data/lib/kp_api.rb

@@ -0,0 +1,179 @@
+require 'net/http'
+require 'digest'
+require 'json'
+require 'date'
+require 'time'
+
+require 'kp_api/api_error'
+require 'kp_api/agent'
+require 'kp_api/film'
+require 'kp_api/people'
+require 'kp_api/category'
+require 'kp_api/today'
+require 'kp_api/top'
+require 'kp_api/global_search'
+require 'kp_api/film_search'
+require 'kp_api/people_search'
+
+#require 'kp_api/reviews'
+#require 'kp_api/gallery'
+#require 'kp_api/similar'
+
+require 'kp_api/version'
+
+module KpApi
+  DOMAINS = {
+    api:  'https://ext.kinopoisk.ru/ios/5.0.0/',
+    salt: 'IDATevHDS7',
+
+    kinopoisk: {
+      main: 'https://www.kinopoisk.ru',
+      poster: {
+        film: 'https://st.kp.yandex.net/images/film_iphone/iphone360',
+        name: 'https://st.kp.yandex.net/images/actor_iphone/iphone360',
+        gallery: 'https://st.kp.yandex.net/images'
+      }
+    }
+  }
+
+  METHODS = {
+    get_film: {
+      method: 'getKPFilmDetailView',
+      id: 'filmID'
+    },
+    get_staff: {
+      method: 'getStaffList',
+      id: 'filmID'
+    },
+    get_gallery: {
+      method: 'getGallery',
+      id: 'filmID'
+    },
+    get_similar: {
+      method: 'getKPFilmsList',
+      type: 'kp_similar_films',
+      id: 'filmID'
+    },
+
+    navigator_filters:{
+      method: 'navigatorFilters'
+    },
+
+    get_reviews: {
+      method: 'getKPReviews',
+      id: 'filmID'
+    },
+    get_review_detail: {
+      method: 'getReviewDetail',
+      id: 'reviewID'
+    },
+
+    get_people: {
+      method: 'getKPPeopleDetailView',
+      id:     'peopleID'
+    },
+    get_today_films: {
+      method: 'getKPTodayFilms'
+    },
+    get_cinemas: {
+      method: 'getCinemas'
+    },
+    get_cinema_detail: {
+      method: 'getCinemaDetail',
+      id: 'cinemaID'
+    },
+    get_seance: {
+      method: 'getSeance',
+      id: 'filmID'
+    },
+    get_dates_for_detail_cinema: {
+      method: 'getDatesForDetailCinema',
+      id: 'filmID'
+    },
+    get_soon_films: {
+      method: 'getSoonFilms'
+    },
+    get_soon_dvd: {
+      method: 'getSoonDVD'
+    },
+    get_dates_for_soon_films: {
+      method: 'getDatesForSoonFilms'
+    },
+    get_dates_for_soon_dvd: {
+      method: 'getDatesForSoonDVD'
+    },
+
+    get_top: {
+      method: 'getKPTop',
+      page:   'page',
+      type:   'type',
+      types: {
+        popular_films:   'kp_item_top_popular_films',
+        best_films:      'kp_item_top_best_films',
+        await_films:     'kp_item_top_await',
+        popular_people:  'kp_item_top_popular_people',
+
+      }
+    },
+
+    get_best_films_list: {
+      method: 'getBestFilmsList'
+    },
+
+    get_all_cities_view:{
+      method: 'getKPAllCitiesView'
+    },
+
+
+    search_global: {
+      method: 'getKPGlobalSearch',
+      keyword: 'keyword'
+    },
+    search_film: {
+      method: 'getKPSearchInFilms',
+      keyword: 'keyword',
+      page:    'page'
+    },
+    search_people: {
+      method:  'getKPSearchInPeople',
+      keyword: 'keyword',
+      page:    'page'
+    },
+
+    search_cinemas: {
+      method: 'searchCinemas',
+      keyword: 'keyword'
+    },
+    news: {
+      method: 'getNews'
+    },
+    get_news_detail: {
+      method: 'getNewsDetail'
+    }
+  }
+
+  def self.api_access(url)
+    #uri = URI.parse(url)
+    #http = Net::HTTP.new(uri.host, uri.port)
+    #response = http.request_head(uri.path)
+    #
+    #if response.code == '200'
+    #  true
+    #else
+    #  false
+    #end
+    raise ToDo
+  end
+
+  def self.valid_json?(j)
+    begin
+      JSON.parse(j)
+
+
+      return true
+    rescue JSON::ParserError => e
+      return false
+    end
+  end
+
+end

data/spec/kp_api/category_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe KpApi::Category do
+  r = KpApi::Category.new(2)
+
+
+  it "Check return Category not formatted data" do
+    expect( r.data.class                 ).to eql(Hash)
+    expect( r.status                     ).to eql(true)
+    expect( r.data['genre'  ].class      ).to eql(Array)
+    expect( r.data['country'].class      ).to eql(Array)
+    expect( r.data['genre'  ].count > 0  ).to eql(true)
+    expect( r.data['country'].count > 0  ).to eql(true)
+
+    expect( r.data['country'].first['id'     ].class  ).to eql(String)
+    expect( r.data['country'].first['name'   ].class  ).to eql(String)
+
+    expect( r.data['genre'].first['id'     ].class    ).to eql(String)
+    expect( r.data['genre'].first['name'   ].class    ).to eql(String)
+
+  end
+
+  it "Check return Category genres formatted data" do
+    expect( r.genres.class     ).to eql(Array)
+    expect( r.genres.count > 0 ).to eql(true)
+
+    expect( r.genres.first[:id     ].class ).to eql(Integer)
+    expect( r.genres.first[:name   ].class ).to eql(String)
+  end
+
+  it "Check return Category countries formatted data" do
+    expect( r.countries.class     ).to eql(Array)
+    expect( r.countries.count > 0 ).to eql(true)
+
+    expect( r.countries.first[:id     ].class ).to eql(Integer)
+    expect( r.countries.first[:name   ].class ).to eql(String)
+  end
+
+  it "Check  return Category before cities data" do
+    expect( r.data2 ).to eql(nil)
+  end
+
+  it "Check return Category cities data" do
+    expect( r.cities.class ).to eql(Array)
+    expect( r.cities.count > 0 ).to eql(true)
+
+    expect( r.cities.first[:id     ].class ).to eql(Integer)
+    expect( r.cities.first[:name   ].class ).to eql(String)
+  end
+
+  it "Check return not found country_id" do
+    expect { KpApi::Category.new(9999999999).cities }
+      .to raise_error(KpApi::ApiError)
+  end
+
+end

data/spec/kp_api/film_search_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe KpApi::FilmSearch do
+  gs1 = KpApi::FilmSearch.new('Бразилия')
+  gs2 = KpApi::FilmSearch.new('олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув')
+
+  it "Check return FilmSearch not formatted data" do
+    expect( gs1.data.class     ).to eql(Hash)
+    expect( gs1.data['class'] ).to eql("KPSearchInFilms")
+    expect( gs1.data['keyword'] ).to eql("Бразилия")
+    expect( gs1.data['searchFilms'].count ).to eql(20)
+    expect( gs1.data['searchFilmsCountResult'] > 40).to eql(true)
+    expect( gs1.data['pagesCount'] > 2).to eql(true)
+
+    expect( gs2.data.class     ).to eql(Hash)
+    expect( gs2.data['class'] ).to eql("KPSearchInFilms")
+    expect( gs2.data['keyword'] ).to eql("олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув")
+    expect( gs2.data['pagesCount'] ).to eql(0)
+  end
+
+  it "Check return FilmSearch formatted data \"Бразилия\" and paginate" do
+    expect( gs1.found? ).to eql(true)
+    expect( gs1.view.count == 20  ).to eql(true)
+    expect( gs1.films_count > 40 ).to eql(true)
+    expect( gs1.current_page     ).to eql(1)
+    expect( gs1.page_count > 2   ).to eql(true)
+    f_id = gs1.view.first[:id]
+
+    2.upto( gs1.page_count ).map do |page|
+      expect( gs1.next_page ).to eql(true)
+      expect( gs1.current_page ).to eql(page)
+    end
+
+    expect( gs1.next_page ).to eql(false)
+    expect( gs1.view.count > 0  ).to eql(true)
+    expect( f_id != gs1.view.first[:id] ).to eql(true)
+
+  end
+
+  it "Check return FilmSearch formatted not found data"  do
+    expect( gs2.found? ).to eql(false)
+  end
+
+end

data/spec/kp_api/film_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe KpApi::Film do
+  id = 444
+  resource = KpApi::Film.new(id)
+
+
+  it "Check return Film not formatted data" do
+    expect( resource.data.class  ).to eql(Hash)
+    expect( resource.status      ).to eql(true)
+
+    expect( resource.data['class']      ).to eql("KPFilmDetailView")
+    expect( resource.data['type']       ).to eql("KPFilm")
+    expect( resource.data['filmID']     ).to eql(444)
+    expect( resource.data['webURL']     ).to eql("http://www.kinopoisk.ru/film/444/")
+    expect( resource.data['nameRU']     ).to eql("Терминатор 2: Судный день")
+    expect( resource.data['nameEN']     ).to eql("Terminator 2: Judgment Day")
+    expect( resource.data['filmLength'] ).to eql("2:17")
+    expect( resource.data['year']       ).to eql("1991")
+  end
+
+  it "Check return Film formatted data" do
+    expect( resource.view[:kp_type]     ).to eql("KPFilm")
+    expect( resource.view[:id]          ).to eql(444)
+    expect( resource.view[:name_ru]     ).to eql("Терминатор 2: Судный день")
+    expect( resource.view[:name_en]     ).to eql("Terminator 2: Judgment Day")
+    expect( resource.view[:slogan]      ).to eql("Same Make. Same Model. New Mission")
+    expect( resource.view[:duration]    ).to eql(137)
+    expect( resource.view[:year]        ).to eql(1991)
+    expect( resource.view[:countries]   ).to eql(["США", "Франция"])
+    expect( resource.view[:genres]      ).to eql(["фантастика", "боевик", "триллер"])
+  end
+
+
+
+  it "Check return Film peoples data" do
+    expect( resource.peoples.count                   ).to eql(7)
+    expect( resource.peoples.first.class             ).to eql(Hash)
+    expect( resource.peoples.first[:id].class        ).to eql(Integer)
+    expect( resource.peoples.first[:name_ru].class   ).to eql(String)
+    expect( resource.peoples.first[:name_en].class   ).to eql(String)
+  end
+
+  it "Check return Film peoples_full data" do
+    expect( resource.data2 ).to eql(nil)
+  end
+
+  it "Check return Film peoples_full data" do
+    expect( resource.peoples_full.count ).to eql(84)
+    expect( resource.data2.class        ).to eql(Hash)
+    expect( resource.status2            ).to eql(true)
+  end
+
+  it "Check return not found Film" do
+    expect { KpApi::Film.new(1) }
+      .to raise_error(KpApi::ApiError)
+  end
+
+end

data/spec/kp_api/global_search_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe KpApi::GlobalSearch do
+  gs1 = KpApi::GlobalSearch.new('Бразилия')
+  gs2 = KpApi::GlobalSearch.new('Привет')
+  gs3 = KpApi::GlobalSearch.new('олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув')
+
+
+  it "Check return GlobalSearch not formatted data" do
+    expect( gs1.data.class     ).to eql(Hash)
+    expect( gs1.data['class'] ).to eql("KPGlobalSearch")
+    expect( gs1.data['keyword'] ).to eql("Бразилия")
+    expect( gs1.data['searchFilms'].count ).to eql(3)
+    expect( gs1.data['searchPeople'].count > 0).to eql(true)
+    expect( gs1.data['searchFilmsCountResult'] > 0).to eql(true)
+    expect( gs1.data['searchPeoplesCountResult'] > 0).to eql(true)
+
+    expect( gs2.data.class     ).to eql(Hash)
+    expect( gs2.data['class'] ).to eql("KPGlobalSearch")
+    expect( gs2.data['keyword'] ).to eql("Привет")
+    expect( gs2.data['searchFilms'].count ).to eql(3)
+    expect( gs2.data['searchPeople'] ).to eql(nil)
+    expect( gs2.data['searchFilmsCountResult'] > 0).to eql(true)
+    expect( gs2.data['searchPeoplesCountResult']).to eql(nil)
+
+    expect( gs3.data.class     ).to eql(Hash)
+    expect( gs3.data['class'] ).to eql("KPGlobalSearch")
+    expect( gs3.data['keyword'] ).to eql("олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув")
+    expect( gs3.data['searchFilms'] ).to eql([])
+    expect( gs3.data['searchFilmsCountResult']).to eql(nil)
+    expect( gs3.data['searchPeoplesCountResult']).to eql(nil)
+
+  end
+
+  it "Check return GlobalSearch formatted data \"Бразилия\"" do
+    expect( gs1.found?            ).to eql(true)
+    expect( gs1.films_count > 40  ).to eql(true)
+    expect( gs1.peoples_count > 0 ).to eql(true)
+
+    expect( gs1.films.count   == 3 ).to eql(true)
+    expect( gs1.peoples.count > 0  ).to eql(true)
+
+    expect( gs1.films.first.class ).to eql(Hash)
+    expect( gs1.films.first[:id] > 0).to eql(true)
+
+    expect( gs1.peoples.first.class ).to eql(Hash)
+    expect( gs1.peoples.first[:id] > 0).to eql(true)
+
+    expect( gs1.youmean.class ).to eql(Hash)
+    expect( gs1.youmean[:id] > 0).to eql(true)
+
+  end
+
+  it "Check return GlobalSearch formatted data \"Привет\"" do
+    expect( gs2.found?             ).to eql(true)
+    expect( gs2.films_count > 100  ).to eql(true)
+    expect( gs2.peoples_count == 0 ).to eql(true)
+
+    expect( gs2.films.count   == 3 ).to eql(true)
+    expect( gs2.peoples            ).to eql(nil)
+
+    expect( gs2.films.first.class ).to eql(Hash)
+    expect( gs2.films.first[:id] > 0).to eql(true)
+
+  end
+
+  it "Check return GlobalSearch formatted not found data"  do
+    expect( gs3.found? ).to eql(false)
+  end
+
+
+end

data/spec/kp_api/people_search_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe KpApi::PeopleSearch do
+  gs1 = KpApi::PeopleSearch.new('Дуров')
+  gs2 = KpApi::PeopleSearch.new('олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув')
+
+  it "Check return PeopleSearch not formatted data" do
+    expect( gs1.data.class     ).to eql(Hash)
+    expect( gs1.data['class'] ).to eql("KPSearchInPeople")
+    expect( gs1.data['keyword'] ).to eql("Дуров")
+    expect( gs1.data['searchPeople'].count ).to eql(20)
+    expect( gs1.data['searchPeoplesCountResult'] > 80).to eql(true)
+    expect( gs1.data['pagesCount'] > 4).to eql(true)
+
+    expect( gs2.data.class     ).to eql(Hash)
+    expect( gs2.data['class'] ).to eql("KPSearchInPeople")
+    expect( gs2.data['keyword'] ).to eql("олимркмрумщшрушосрволыдсродлрфдлоыврцлдоув")
+    expect( gs2.data['pagesCount'] ).to eql(0)
+  end
+
+  it "Check return PeopleSearch formatted data \"Бразилия\" and paginate" do
+    expect( gs1.found? ).to eql(true)
+    expect( gs1.view.count == 20  ).to eql(true)
+    expect( gs1.peoples_count > 80 ).to eql(true)
+    expect( gs1.current_page     ).to eql(1)
+    expect( gs1.page_count > 4   ).to eql(true)
+    f_id = gs1.view.first[:id]
+
+    2.upto( gs1.page_count ).map do |page|
+      expect( gs1.next_page ).to eql(true)
+      expect( gs1.current_page ).to eql(page)
+    end
+
+    expect( gs1.next_page ).to eql(false)
+    expect( gs1.view.count > 0  ).to eql(true)
+    expect( f_id != gs1.view.first[:id] ).to eql(true)
+
+  end
+
+  it "Check return PeopleSearch formatted not found data"  do
+    expect( gs2.found? ).to eql(false)
+  end
+
+end

data/spec/kp_api/people_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe KpApi::People do
+  id = 1
+  r  = KpApi::People.new(id)
+
+  it "Check return Film not formatted data" do
+    expect( r.data.class  ).to eql(Hash)
+    expect( r.status      ).to eql(true)
+
+    expect( r.data['class']        ).to eql("KPPeopleDetailView")
+    expect( r.data['peopleID']     ).to eql("1")
+    expect( r.data['webURL']       ).to eql("http://www.kinopoisk.ru/name/1/")
+    expect( r.data['nameRU']       ).to eql("Стивен Карпентер")
+    expect( r.data['nameEN']       ).to eql("Stephen Carpenter")
+    expect( r.data['sex']          ).to eql("male")
+    expect( r.data['birthplace']   ).to eql("Уэтерфорд, Техас, США")
+  end
+
+  it "Check return Film formatted data" do
+    expect( r.view[:kp_type]     ).to eql("KPPeopleDetailView")
+    expect( r.view[:id]          ).to eql(1)
+    expect( r.view[:name_ru]     ).to eql("Стивен Карпентер")
+    expect( r.view[:name_en]     ).to eql("Stephen Carpenter")
+    expect( r.view[:sex]         ).to eql("male")
+    expect( r.view[:profession]  ).to eql(["Сценарист", "Режиссер", "Оператор"])
+    expect( r.view[:birthplace]  ).to eql("Уэтерфорд, Техас, США")
+  end
+
+  it "Check return People films data" do
+    expect( r.films.count > 21              ).to eql(true)
+    expect( r.films.first[:id].class        ).to eql(Integer)
+    expect( r.film_ids.map{|i| i.class == Integer && i > 0 }.uniq). to eql([true])
+  end
+
+  it "Check return not found Film" do
+    expect { KpApi::People.new(999999999999999999999999) }
+      .to raise_error(KpApi::ApiError)
+  end
+
+end

data/spec/kp_api/today_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe KpApi::Today do
+  r = KpApi::Today.new()
+
+  it "Check return Today not formatted data" do
+    expect( r.data.class                 ).to eql(Hash)
+    expect( r.status                     ).to eql(true)
+
+    expect( r.data['class'  ]              ).to eql('KPTodayFilms')
+    expect( r.data['filmsData'].class      ).to eql(Array)
+    expect( r.data['filmsData'].count  > 0 ).to eql(true)
+
+    expect( r.data['filmsData'].first['id'       ].class    ).to eql(String)
+    expect( r.data['filmsData'].first['nameRU'   ].class    ).to eql(String)
+    expect( r.data['filmsData'].first['nameEN'   ].class    ).to eql(String)
+  end
+
+  it "Check return Today formatted data" do
+    expect( r.view.class     ).to eql(Array)
+    expect( r.view.count > 0 ).to eql(true)
+
+    expect( r.view.first[:id     ].class ).to eql(Integer)
+    expect( r.view.first[:name_ru].class ).to eql(String)
+    expect( r.view.first[:name_en].class ).to eql(String)
+  end
+
+  it "Check return Today ids formatted data" do
+    expect( r.film_ids.count > 0    ).to eql(true)
+    expect( r.film_ids.first.class  ).to eql(Integer)
+    expect( r.film_ids.map{|i| i.class == Integer && i > 0 }.uniq). to eql([true])
+  end
+
+  it "Check return Today not found country_id" do
+    expect( KpApi::Today.new(9999999999, 99999999999).view ).to eql([])
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'kp_api'
+require 'pry'
+require 'awesome_print'
+require 'hashie'
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+
+  config.before(:suite) do
+    Hashie.logger = Logger.new(nil)
+  end
+end
+
+RSpec::Matchers.define :log_requests do
+  match do |logger|
+    logger.log_requests?
+  end
+end
+
+RSpec::Matchers.define :log_errors do
+  match do |logger|
+    logger.log_errors?
+  end
+end
+
+RSpec::Matchers.define :log_responses do
+  match do |logger|
+    logger.log_responses?
+  end
+end