anilibria-api-ruby 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19108f3f24b1792bb2640d48a562bea69ff82c3d9ff3f372ae1efe7952cd8340
-  data.tar.gz: 0eecd5734d837d98156619f3ac864fd154113478c515cfbee8535cd00af468ad
+  metadata.gz: 69881766a2287e012e03871b9997435a9d8f7080eed1377c267847b865c9a0be
+  data.tar.gz: c70122a1d4aafea3218cc3f9b9323df801289733f394e7b1f5e847dff72ea466
 SHA512:
-  metadata.gz: 34d6bbd2917aa045c0cf7c97a98b19dd6b8e07b9cc19629e322090d978e561e6c8156e9da9c0d4f303f4fa922a0131c87ae61f91fa561aa06de1682418f11e78
-  data.tar.gz: fceeca87a3a2bcba908deaddca452b27fe38d2e65cb527d55efab0ac8cc8284f475102be8d5264114ee606cd99dd98e83f883264291fb4da78abe1d8a6bfc8c5
+  metadata.gz: c25155e4d2fe623944cfa58b6b5ff8836132c4963980db42ea52cc0431301c052dd4accb81722d36d9d8faf148bd26c7d064f10bbfc92602744d13b45fa84b17
+  data.tar.gz: 57c3db01725fe8fc00a193269777b9d491816503b996ad105fda3c6210d1d5d9b3c6014317c8138cb8772614b982ecd209f3fe81452de6b27aa3886f84df096f

data/Gemfile

@@ -5,5 +5,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-
 gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    anilibria-api-ruby (1.0.0)
+    anilibria-api-ruby (1.0.4)
       dry-struct (~> 1.4)
       faraday (~> 2)
 

data/README.md

@@ -24,43 +24,56 @@ $ gem install anilibria-api-ruby
 
 ## Usage
 
+### Client
+
 Usage example:
 
 ```ruby
 require 'anilibria/api'
 
 anilibria = Anilibria::Api::Client.new
+# => #<Anilibria::Api::Client:0x00007f25c52fc1b8 ...
+
+anilibria.get_years
+# => [1996, 1998, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009, ...
 
-anilibria.get_years # => [1996, 1998, 2001, 2003, 2004, 2005, 2006, ...]
+title = anilibria.get_title(code: 'steinsgate')
+# => #<Anilibria::Api::Types::Title id=8674 code="steinsgate" ...
 
-title = anilibria.get_title(code: 'steinsgate') # => #<Anilibria::Api::Types::Title id=8674 code="steinsgate"...
-title.names.en # => "Steins;Gate"
+title.names.en
+# => "Steins;Gate"
 ```
 
 `anilibria` object implements [AniLibria API methods](https://github.com/anilibria/docs/blob/master/api_v2.md#method-list) as is. All methods are available in *snake_case* notation. Same with the `title` object - it implements the [Title](https://github.com/anilibria/docs/blob/master/api_v2.md#возвращаемые-значения-при-запросе-информации-о-тайтле) specification.
 
-## Authorization
+### Authorization
 
-The client supports authorization:
+The gem supports authorization:
 
 ```ruby
-# session = anilibria.auth('wrongemail@example.com', 'WrongPassword') # => nil
-# session = anilibria.auth!('wrongemail@example.com', 'WrongPassword') # raises an error Anilibria::Api::Exceptions::AuthError
-session = anilibria.auth('correctemail@example.com', 'CorrectPassword') # returns the session string
+# session = anilibria.auth('wrong@example.com', 'WrongPassword')
+# => nil
 
-anilibria.add_favorite(title_id: 9114, session: session) # => true
+# session = anilibria.auth!('wrong@example.com', 'WrongPassword')
+# raises an error Anilibria::Api::Exceptions::AuthError
 
-titles = anilibria.get_favorites(filter: 'id,code,names,description', session: session)
-# => [#<Anilibria::Api::Types::Title id=9114 code="shingeki-no-k...
+session = anilibria.auth('correct@example.com', 'CorrectPassword')
+# => "VdZnNZRpEl9w2HcKNRyj1BWXLqdynpog"
 
+anilibria.add_favorite(title_id: 9114, session: session)
+# => true
+
+titles = anilibria.get_favorites(filter: 'id,code,names,description', session: session)
+# => [#<Anilibria::Api::Types::Title id=9114 code="shingeki-no-kyojin-the-final-season-part-2" ...
 ```
 
-## API Version
+### API Version
 
 You can get the currently used version of [AniLibria API](https://github.com/anilibria/docs/blob/master/api_v2.md): 
 
 ```ruby
-anilibria.api_version # => "2.13.10"
+anilibria.api_version
+# => "2.13.10"
 ```
 
 ## Contributing

data/lib/anilibria/api/client.rb

@@ -25,6 +25,8 @@ module Anilibria
         end
       end
 
+      Faraday::Utils.default_space_encoding = '%20'
+
       DryTypes = Types::DryTypes
 
       API_VERSION = '2.13'.freeze
@@ -39,7 +41,10 @@ module Anilibria
       attr_reader :connection
 
       def initialize(url: ENDPOINT)
-        @connection = Faraday.new(url: url) do |f|
+        @connection = Faraday.new(
+          url: url,
+          headers: { 'User-Agent' => "anilibria-api-ruby/#{VERSION}" }
+        ) do |f|
           f.request :url_encoded
           f.response :json, parser_options: { symbolize_names: true }
         end
@@ -58,7 +63,7 @@ module Anilibria
       def auth(mail, passwd)
         response = auth_response(mail, passwd)
 
-        return unless response[:key] == 'success'
+        return unless auth_successful?(response)
 
         response[:sessionId]
       end
@@ -66,34 +71,50 @@ module Anilibria
       def auth!(mail, passwd)
         response = auth_response(mail, passwd)
 
-        raise Exceptions::AuthError, response unless response[:key] == 'success'
+        unless auth_successful?(response)
+          raise(
+            Exceptions::AuthError.new(response),
+            'Failed authorization attempt'
+          )
+        end
 
         response[:sessionId]
       end
 
       def api_version
-        connection.get.headers['api-version']
+        connection.head.headers['API-Version']
       end
 
       private
 
+      def check_response!(response)
+        return if response.status == 200
+
+        if !response.body.respond_to?(:to_hash) ||
+           !response.body[:error].respond_to?(:to_hash)
+          raise Exceptions::ResponseError.new(
+            'Unexpected response from API', response
+          )
+        end
+
+        raise Exceptions::ApiError.new(response), response.body.dig(:error, :message)
+      end
+
       def auth_response(mail, passwd)
         response = connection.post(
           AUTH_ENDPOINT,
           { mail: mail, passwd: passwd }
         )
 
-        JSON.parse(response.body, { symbolize_names: true })
-      end
-
-      def check_response!(response)
-        return if response.status == 200
-
-        if !response.body.respond_to?(:to_hash) || !response.body.key?(:error)
-          raise Exceptions::ResponseError.new('Unexpected response from API', response)
+        begin
+          JSON.parse(response.body, { symbolize_names: true })
+        rescue JSON::ParserError
+          {}
         end
+      end
 
-        raise Exceptions::ApiError, response
+      def auth_successful?(response)
+        response[:key] == 'success' && response.key?(:sessionId)
       end
     end
   end

data/lib/anilibria/api/exceptions/api_error.rb

@@ -7,7 +7,8 @@ module Anilibria
         def initialize(response)
           error = response.body[:error].to_h
           @code = error[:code]
-          super("#{error[:code]} #{error[:message]}", response)
+
+          super(error[:message], response)
         end
       end
     end

data/lib/anilibria/api/exceptions/auth_error.rb

@@ -2,14 +2,25 @@ module Anilibria
   module Api
     module Exceptions
       class AuthError < Base
-        attr_reader :err, :key, :mes
+        attr_reader :data
+
+        def initialize(data = {})
+          @data = data
 
-        def initialize(response_body)
-          @err = response_body[:err]
-          @key = response_body[:key]
-          @mes = response_body[:mes]
           super("#{mes} (#{key})")
         end
+
+        def err
+          data[:err]
+        end
+
+        def mes
+          data[:mes]
+        end
+
+        def key
+          data[:key]
+        end
       end
     end
   end

data/lib/anilibria/api/exceptions/response_error.rb

@@ -4,9 +4,10 @@ module Anilibria
       class ResponseError < Base
         attr_reader :response
 
-        def initialize(message, response)
+        def initialize(msg = nil, response = nil)
           @response = response
-          super(message)
+
+          super(msg)
         end
       end
     end

data/lib/anilibria/api/types/title.rb

@@ -8,12 +8,23 @@ module Anilibria
           attribute? :string, DryTypes::String.optional
         end
 
+        class Posters < Base
+          class Poster < Base
+            attribute? :url, DryTypes::String.optional
+            attribute? :raw_base64_file, DryTypes::String.optional
+          end
+
+          %i[small medium original].each do |size|
+            attribute? size, Poster
+          end
+        end
+
         class Player < Base
           class Playlist < Base
             attribute? :serie, DryTypes::Strict::Integer
             attribute? :created_timestamp, DryTypes::Timestamp
 
-            attribute? :hls do
+            attribute? :hls, Base do
               attribute? :fhd, DryTypes::String.optional
               attribute? :hd, DryTypes::String.optional
               attribute? :sd, DryTypes::String.optional
@@ -47,7 +58,6 @@ module Anilibria
               attribute? :name, DryTypes::Strict::String
               attribute? :announce, DryTypes::Array.of(DryTypes::Strict::String)
               attribute? :created_timestamp, DryTypes::Timestamp
-
               attribute? :files_list, DryTypes::Array.of(FilesList)
             end
 
@@ -56,7 +66,7 @@ module Anilibria
             attribute? :torrent_id, DryTypes::Strict::Integer
             attribute? :series, Title::Series
 
-            attribute? :quality do
+            attribute? :quality, Base do
               attribute? :string, DryTypes::Strict::String
               attribute? :type, DryTypes::Strict::String
               attribute? :resolution, DryTypes::Strict::Integer
@@ -82,7 +92,7 @@ module Anilibria
         attribute? :id, DryTypes::Strict::Integer
         attribute? :code, DryTypes::Strict::String
 
-        attribute? :names do
+        attribute? :names, Base do
           attribute? :ru, DryTypes::String.optional
           attribute? :en, DryTypes::String.optional
           attribute? :alternative, DryTypes::String.optional
@@ -90,24 +100,16 @@ module Anilibria
 
         attribute? :announce, DryTypes::String.optional
 
-        attribute? :status do
+        attribute? :status, Base do
           attribute? :string, DryTypes::Strict::String
           attribute? :code, DryTypes::Strict::Integer
         end
 
-        attribute? :posters do
-          %i[small medium original].each do |poster|
-            attribute? poster do
-              attribute? :url, DryTypes::String.optional
-              attribute? :raw_base64_file, DryTypes::String.optional
-            end
-          end
-        end
-
+        attribute? :posters, Posters
         attribute? :updated, DryTypes::Timestamp.optional
         attribute? :last_change, DryTypes::Timestamp.optional
 
-        attribute? :type do
+        attribute? :type, Base do
           attribute? :full_string, DryTypes::String.optional
           attribute? :string, DryTypes::String.optional
           attribute? :length, DryTypes::String.optional
@@ -118,7 +120,7 @@ module Anilibria
         attribute? :genres, DryTypes::Array.of(DryTypes::Strict::String)
         attribute? :team, Types::Team
 
-        attribute? :season do
+        attribute? :season, Base do
           attribute? :string, DryTypes::String.optional
           attribute? :code, DryTypes::Integer.optional
           attribute? :year, DryTypes::Integer.optional
@@ -128,7 +130,7 @@ module Anilibria
         attribute? :description, DryTypes::String.optional
         attribute? :in_favorites, DryTypes::Integer.optional
 
-        attribute? :blocked do
+        attribute? :blocked, Base do
           attribute? :blocked, DryTypes::Strict::Bool
           attribute? :bakanim, DryTypes::Strict::Bool
         end

data/lib/anilibria/api/version.rb

@@ -1,6 +1,6 @@
 module Anilibria
   module Api
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.4'.freeze
     public_constant :VERSION
   end
 end

data/sample/rss.rb

@@ -0,0 +1,14 @@
+require 'anilibria/api'
+require 'rss'
+
+anilibria = Anilibria::Api::Client.new
+
+today_ts = Date.today.to_time.to_i
+raw_rss = anilibria.get_rss(since: today_ts)
+
+feed = RSS::Parser.parse(raw_rss)
+
+puts feed.channel.title
+feed.items.each do |item|
+  puts "#{item.pubDate.strftime('%H:%M:%S')} | #{item.title}"
+end

data/sample/schedule.rb

@@ -0,0 +1,25 @@
+require 'anilibria/api'
+
+WEEK_DAYS = %w[
+  Понедельник
+  Вторник
+  Среда
+  Четверг
+  Пятница
+  Суббота
+  Воскресенье
+].freeze
+
+anilibria = Anilibria::Api::Client.new
+
+schedules = anilibria.get_schedule(filter: 'names.ru')
+
+schedules.each do |schedule|
+  puts "#{WEEK_DAYS[schedule.day]}:"
+
+  schedule.list.each do |title|
+    puts "  #{title.names.ru}"
+  end
+
+  puts
+end

data/sample/search_titles.rb

@@ -0,0 +1,29 @@
+require 'anilibria/api'
+
+anilibria = Anilibria::Api::Client.new
+
+limit = 10
+
+puts 'Введите поисковый запрос:'
+input = $stdin.gets.chomp
+puts
+
+titles = anilibria.search_titles(
+  search: input,
+  filter: 'id,names,season,type,team,genres[0]',
+  limit: limit
+)
+
+puts 'Результаты:'
+puts
+
+titles.each do |title|
+  puts "  id: #{title.id}"
+  puts "  #{title.names.ru} / #{title.names.en}"
+  puts "  Сезон: #{title.season.string} #{title.season.year}"
+  puts "  Тип: #{title.type.full_string}"
+  puts "  Жанр: #{title.genres.join(', ')}"
+  puts
+end
+
+puts "Всего найдено #{titles.size}, лимит: #{limit}"

data/sample/title.rb

@@ -0,0 +1,21 @@
+require 'anilibria/api'
+
+anilibria = Anilibria::Api::Client.new
+
+title = anilibria.get_random_title(remove: 'posters,player,torrents')
+# title = anilibria.get_title(id: 495, remove: 'posters,player,torrents')
+
+subtitle_team = title.team.translator + title.team.editing + title.team.decor
+
+puts "#{title.names.ru} / #{title.names.en}"
+puts
+puts "Сезон: #{title.season.year} #{title.season.string}"
+puts "Тип: #{title.type.full_string}"
+puts "Жанры: #{title.genres.join(', ')}"
+puts "Озвучка: #{title.team.voice.join(', ')}"
+puts "Тайминг: #{title.team.timing.join(', ')}" if title.team.timing.any?
+puts "Работа над субтитрами: #{subtitle_team.join(', ')}" if subtitle_team.any?
+puts
+puts title.description
+puts
+puts format('https://www.anilibria.tv/release/%<code>s.html', code: title.code)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anilibria-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Roman Kozachenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -71,6 +71,10 @@ files:
 - lib/anilibria/api/types/title.rb
 - lib/anilibria/api/types/youtube.rb
 - lib/anilibria/api/version.rb
+- sample/rss.rb
+- sample/schedule.rb
+- sample/search_titles.rb
+- sample/title.rb
 homepage: https://github.com/psychosocial88/anilibria-api-ruby
 licenses:
 - MIT