jikan.rb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '098873c3d87b219dd5c77c292913347ec28d5780ac5bf46e41674e84a58e5909'
-  data.tar.gz: 257119827597b7ffa12b8db033a24c5941ad6d3288c63b7966be0d49ce3eb545
+  metadata.gz: bae09e79312c387a9c47086ef0dee5abfbdcf30b5a64a3f1a30912f7ef879d4f
+  data.tar.gz: 5b59b649df57bc6eb1901fff87d9fed194fdab9380bae9fec5f3c1d74f71b480
 SHA512:
-  metadata.gz: 66e2efa11330d262d301f2782fae6f1ebab30b9eaa0c8bae4ce45dc54cccdaa348decec9e8c79c1d23e3379acb5eee4c4c2dee61b6d5b374be00ecade8a69190
-  data.tar.gz: a557f123bdc392f1f3509e0a5b3a4966b3ab8c26187ea350a79701e9ecca9bfbee24314fe6c6bf0512bbfeae670c0e78ccc397152fd9c5b1cf4f094858fadd18
+  metadata.gz: d5ab097f9f58bfb558c3d62251e0697e64a07969be2a1cfaef8d7d1b5a1a285e5e54bef9f7a2c9fa88d7558d7c3ec307ef2af8ea905672eff202e7f46e0f73b4
+  data.tar.gz: 85f55c4e65258b4e6f341220553c680120995db31617d8a5af9226c5d9a1d4ec726fcfc5c79fad76d61bbd511c7285a0a5bc7158c47e5d0511c674d6b0dadac9

data/.travis.yml

@@ -2,4 +2,4 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
-before_install: gem install bundler -v 1.16.1
+before_install: gem install bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jikan (0.0.1)
+    jikan.rb (0.0.1)
       http (~> 3.0.0)
 
 GEM
@@ -59,7 +59,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  jikan!
+  jikan.rb!
   pry
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -1,15 +1,15 @@
 # Jikan.rb
 
+[![Build Status](https://img.shields.io/travis/Zerocchi/jikan.rb.svg)](https://github.com/Zerocchi/jikan.rb/tree/master) [![Gem Version](https://img.shields.io/gem/v/jikan.rb.svg)](https://rubygems.org/gems/jikan.rb) [![Total Downloads](https://img.shields.io/gem/dt/jikan.rb.svg?colorB=6495ed)](https://rubygems.org/gems/jikan.rb) [![License MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php) [![Dart](https://img.shields.io/badge/language-Ruby-red.svg)](https://www.ruby-lang.org/)
+
 This is a thin Ruby wrapper for [jikan.me](http://jikan.me) inspired by [JikanPy](https://github.com/AWConant/jikanpy).  For more information, please refer to [Jikan.ME documentation](https://jikan.me/docs).
 
 ## Installation
 
-**NOTE: This does not work yet until the gem is uploaded.**
-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jikan'
+gem 'jikan.rb'
 ```
 
 And then execute:
@@ -18,19 +18,26 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install jikan
+    $ gem install jikan.rb
 
 ## Usage
 
+```diff
+- NOTE: As per documentation there's a rate limit of 2000 requests per IP per day, and two concurrent requests 
+- per second. This wrapper does not have any attempt of blocking the limit so please use it wisely. 
+- More information available at https://jikan.docs.apiary.io/#introduction/information
+```
+
 **Get anime and manga information based on their ID**
 
 ```ruby
 # https://myanimelist.net/anime/34798/Yuru_Camp
 >> qry = Jikan::Query.new
-=> #<Jikan::Query:0x026ed9d0>
+=> <Jikan::Query:0x026ed9d0>
 
 >> yurucamp = qry.anime_id 34798 # manga_id for manga
-# You can also specify flag as second parameter
+>> yurucamp = Jikan::anime 34798 # shortcut method without instaniating Query object, both are valid
+# You can also specify flag as second parameter to get more information
 # >> yurucamp = qry.anime_id 34798, :episodes
 # All flags are symbol, please refer https://jikan.me/docs#chaining-methods to see all available flags
 => <Jikan::Anime:0x0168c4e0>
@@ -58,12 +65,12 @@ Or install it yourself as:
 ```ruby
 # https://myanimelist.net/character/16521/Kagome_Ikaruga
 >> qry = Jikan::Query.new
-=> #<Jikan::Query:0x027554b8>
+=> <Jikan::Query:0x027554b8>
 
 >> ikaruga = qry.character_id 16521
-=> #<Jikan::Character:0x0134b080>
+=> <Jikan::Character:0x0134b080>
 
->> ikaruga.raw # only raw method is available for now for both character and people
+>> ikaruga.raw # only raw method is available for now for both character and person
 =>{
     "mal_id"=>16521,
     "link_canonical"=>"https://myanimelist.net/character/16521/Kagome_Ikaruga",
@@ -79,12 +86,12 @@ Or install it yourself as:
 **Search**
 ``` ruby
 >> qry = Jikan::Query.new
-=> #<Jikan::Query:0x027d70e8>
+=> <Jikan::Query:0x027d70e8>
 
->> railgun = qry.search("railgun", :anime) # other parameter tokens are :manga, :character, :person
-=> #<Jikan::Search:0x016fd760>
+>> railgun = qry.search("railgun", :anime) # other flags are :manga, :character, :person
+=> <Jikan::Search:0x016fd760>
 
->> railgun.raw # only raw method is available for now
+>> railgun.raw # return raw result
 =>{"result"=>
     [
       { 
@@ -105,6 +112,42 @@ Or install it yourself as:
       }
     ]
   }
+
+# Return each result items wrapped in their respective object 
+# :person and :character only return raw objects for now so this method isn't available for those flags
+>> res = railgun.result 
+=> [<Jikan::Anime:0x0196c968>, <Jikan::Anime:0x0196c950>, <Jikan::Anime:0x019f1610>, <Jikan::Anime:0x019f15f8>, ...]
+
+>> first_anime = res[0]
+=> <Jikan::Anime:0x0196c968>
+
+>> first_anime.title
+=> "Toaru Kagaku no Railgun"
+
+# Method name follow Jikan::Anime object so it will slighly differ from raw result keys
+# e.g. raw result key is image_url but Jikan::Anime method is image.
+>> first_anime.image
+=> "https://myanimelist.cdn-dena.com/r/100x140/images/anime/8/53581.jpg?s=4003b92ef0e723389087b69a8a08d742"
+
+>> first_anime.synopsis # same goes to description which is truncated in search result. We use synopsis method instead.
+=> "The student-filled Academy City is at the forefront of scientific advancement and home to the esper 
+development program. The seven \"Level 5\" espers are the most powerful in Academy City, and ranked th..."
+
+# Eventhough the result method return specific objects array, it is still bound to the raw result above.
+# So you don't get full information the same way when you do Jikan::anime(id)
+>> first_anime.opening # this will return nil because search result doesn't have opening information
+=> nil
+
+# To get detailed anime information you can assign special details method on search result object.
+# This method will call Jikan::Anime(id) or equivalent and get detailed information from the API and return new object.
+# You can also pass flag as you would do in normal Query or shortcut methods.
+>> full_info = first_anime.details
+=> <Jikan::Anime:0x01ad4170>
+
+>> full_info.opening
+>> first_anime.details.opening # shorter way but this will call the API again if you change the rightmost method
+=> ["#1: \"only my railgun\" by fripSide (eps 2-14)", "#2: \"LEVEL 5 -judgelight-\" by fripSide (eps 15-23)"]
+
 ```
 
 ## To-Do

data/lib/jikan.rb

@@ -14,4 +14,25 @@ module Jikan
     'person' => [ :pictures ],
     'search' => [:anime, :manga, :person, :character]
   }
+
+  # shortcut methods
+  def self.anime(id, flag=nil)
+    Jikan::Query.new.anime_id(id, flag)
+  end
+  
+  def self.manga(id, flag=nil)
+    Jikan::Query.new.manga_id(id, flag)
+  end
+  
+  def self.character(id, flag=nil)
+    Jikan::Query.new.character_id(id, flag)
+  end
+  
+  def self.person(id, flag=nil)
+    Jikan::Query.new.person_id(id, flag)
+  end
+  
+  def self.search(query, flag=:anime, page=1)
+    Jikan::Query.new.search(query, flag, page)
+  end
 end

data/lib/jikan/anime.rb

@@ -24,7 +24,7 @@ module Jikan
     end
 
     def ending
-      raw['ending-theme']
+      raw['ending_theme']
     end
 
     def episodes
@@ -35,12 +35,20 @@ module Jikan
       raw['episode']
     end
 
+    def details(flag=nil)
+      unless raw.has_key?('opening') || raw.has_key?('studio') 
+        Jikan::anime id, flag
+      else 
+        raise NoMethodError, "Method only available for Anime object within Jikan::Search results."
+      end
+    end
+
     def licensor
       raw['licensor']
     end
 
     def opening
-      raw['opening-theme']
+      raw['opening_theme']
     end
 
     def premiered

data/lib/jikan/api.rb

@@ -31,7 +31,12 @@ module Jikan
 				unless Jikan::FLAGS[@endpoint].include? @flag
 					raise Jikan::FlagError, 'Flag not supported'
 				else
-					@url = "#{@end_url}/#{@flag.to_s}/#{@query}/#{@id}"
+					# This is inconsistencies in the API.
+					if @flag == :anime || @flag == :manga
+						@url = "#{@end_url}/#{@flag.to_s}/#{@query.downcase.delete(' ')}/#{@id}"
+					elsif @flag == :character || @flag == :person
+						@url = "#{@end_url}/#{@flag.to_s}/#{@query.downcase}/#{@id}"
+					end
 				end
       end
 
@@ -46,7 +51,7 @@ module Jikan
 		def get_data
 			res = HTTP.get(@url)
 			if res.status >= 400
-				raise ClientError, "#{res.status}: error on endpoint #{@endpoint}"
+				raise ClientError, "#{res.status}: error on endpoint #{@endpoint} (URL: #{@url})"
 			end
 
 			JSON.parse(res.body)

data/lib/jikan/entity.rb

@@ -19,8 +19,12 @@ module Jikan
       raw['genre']
     end
 
+    def id
+      raw['id'] || raw['mal_id']
+    end
+
     def image
-      raw['image']
+      raw['image'] || raw['image_url']
     end
 
     def members
@@ -56,11 +60,11 @@ module Jikan
     end
 
     def synopsis
-      raw['synopsis']
+      raw['synopsis'] || raw['description']
     end
 
     def link
-      raw['link_canonical']
+      raw['link_canonical'] || raw['url']
     end
 
     def title

data/lib/jikan/manga.rb

@@ -9,6 +9,14 @@ module Jikan
       raw['chapters']
     end
     
+    def details(flag=nil)
+      unless raw.has_key?('published') || raw.has_key?('popularity') 
+        Jikan::manga id, flag 
+      else 
+        raise NoMethodError, "Method only available for Manga object within Jikan::Search results."
+      end
+    end
+
     def published
       raw['published']
     end

data/lib/jikan/query.rb

@@ -34,7 +34,7 @@ module Jikan
 
     def search(title, type=:anime, page=1)
       @json = Jikan::API.new.get("search", page, type, title)
-      Jikan::Search.new(@json)
+      Jikan::Search.new(@json, type)
     end
     
 	end

data/lib/jikan/search.rb

@@ -1,23 +1,49 @@
 module Jikan
   class Search < BaseEntity
 
+    def initialize(json, type)
+      super(json)
+      @type = type
+      @search = true
+    end
+
+    def is_search?
+      @search
+    end
+
     def id
-      iter('id')
+      iter { |i| i['id'] }
     end
 
     def title
-      iter('title')
+      iter { |i| i['title'] }
     end
     
     def url
-      iter('url')
+      iter { |i| i['url'] }
+    end
+
+    # returns each result items wrapped in their respective objects
+    def result
+      case @type
+      when :anime
+        iter { |i| Jikan::Anime.new(i) }
+      when :manga
+        iter { |i| Jikan::Manga.new(i) }
+      when :character
+        raise NoMethodError, "Character only return raw result for now."
+      when :person
+        raise NoMethodError, "Person only return raw result for now."
+      end
     end
 
     private
 
-    def iter(key)
+    def iter
       @raw['result'].map do |item|
-        item[key]
+        if block_given?
+          yield item
+        end
       end
     end   
   end

data/lib/jikan/version.rb

@@ -1,3 +1,3 @@
 module Jikan
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jikan.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zerocchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http