ann_wrapper 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e57e389662bc751a163ecff82d950d89a79ff80
-  data.tar.gz: 4916dd0335181b68cef44b1ae9b75f98c2eef270
+  metadata.gz: 3a9e7afef7ed3479ae7b65cd78990ac4ec590094
+  data.tar.gz: 9ac1f2658558da468d3c3bd36aa83827d989baf8
 SHA512:
-  metadata.gz: 1358df5bfe4a4e892cbea93af1db570b11e31c30a3b2cd31cc99664b151945470eedcef7e88caf6607cb1e2cf4a66b980d8cbb382e8c1787d36fc0f0d0267353
-  data.tar.gz: 666e68b082a5c2f555497b08820769a06f8b2dfe78f2fca695ba9c27d7652467d74bc5a5b10d77bf44c4b632a59bea52af02feb9c9626e5222b7a09dc98bdf68
+  metadata.gz: 033dc1f439ea2110322bd23366a51377fb550e691ea4f1adf00e327b0d2b26db677029dc37d1813fe621e908bb33747fc8a08203126d42d048e67c50cb72be61
+  data.tar.gz: 12606ade1ae66a7a131fb80eff2eeaab8f7ea90a4eeb7dccb5fafcc2f7981e222a160e458d89d620cb6effaba2bdfcdfba5da3c712ec6cb350310541c3c72ab7

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - "1.9.2"
   - "1.9.3"
   - "2.0.0"
+  - "2.1.5"

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
+# coveralls test coverage
+gem 'coveralls', require: false
+
 # Specify your gem's dependencies in ann_wrapper.gemspec
 gemspec

data/README.md

@@ -4,8 +4,8 @@
 [![Gem Version](https://badge.fury.io/rb/ann_wrapper.png)](http://badge.fury.io/rb/ann_wrapper)
 [![Build Status](https://travis-ci.org/Getkura/ann_wrapper.png?branch=dev)](https://travis-ci.org/Getkura/ann_wrapper)
 [![Dependency Status](https://gemnasium.com/Getkura/ann_wrapper.png)](https://gemnasium.com/Getkura/ann_wrapper)
-[![Code Climate](https://codeclimate.com/github/Getkura/ann_wrapper.png)](https://codeclimate.com/github/Getkura/ann_wrapper)
-
+[![Code Climate](https://codeclimate.com/github/Getkura/ann_wrapper/badges/gpa.svg)](https://codeclimate.com/github/Getkura/ann_wrapper)
+[![Coverage Status](https://coveralls.io/repos/Getkura/ann_wrapper/badge.png?branch=dev)](https://coveralls.io/r/Getkura/ann_wrapper?branch=dev)
 
 A simple ruby wrapper/abstraction for the [Anime News Network API](http://www.animenewsnetwork.com/encyclopedia/api.php)
 
@@ -25,82 +25,132 @@ Or install it yourself as:
 
 ## Usage
 
-Fetch an anime:
+###Fetch an anime:
+
+    anime = ANN_Wrapper.fetch_anime "id"
+    anime.title
+    anime.alt_titles
+    anime.synopsis
+    anime.num_episodes
+    anime.genres
+    anime.themes
+    anime.vintage
+    anime.op_theme
+    anime.ed_theme
+    anime.id
+    anime.type
+    anime.ratings
+    anime.episodes
+    anime.staff
+    anime.cast
+    anime.images
+    anime.to_h
+    
+####Example:
 
     steins_gate = ANN_Wrapper.fetch_anime 11770
 
-Info:
-    
+#####Info:
+
     steins_gate.id
      => "11770"
-     
+
     steins_gate.title
      => ["Steins;Gate"]
-     
+
     steins_gate.alt_titles
      => {"PT"=>["Steins-Gate e a Teoria do Caos"], "JA"=>["シュタインズ・ゲート"], "ZH-TW"=>["命運石之門"], "KO"=>["슈타인즈 게이트"]}
 
     steins_gate.synopsis
      => ["Rintaro Okabe is a self-proclaimed "mad scientist" ... "]
-     
+
     steins_gate.num_episodes
      => ["24"]
-     
+
     steins_gate.vintage
      => ["2011-04-03 (Advanced screening)", "2011-04-05 to 2011-09-13"]
-     
+
     steins_gate.genres
      => ["adventure", "comedy", "drama", "mystery", "psychological", "romance", "science fiction", "thriller"]
-     
+
     steins_gate.themes
      => ["butterfly effect", "conspiracy", "technology", "Time travel"]
-     
+
     steins_gate.op_theme
      => ["\"Hacking to the Gate\" by Kanako Ito"]
-     
+
     steins_gate.ed_theme
      => ["\"Tokitsukasadoru Jūni no Meiyaku\" (刻司ル十二ノ盟約) by Yui Sakakibara", "#2: \"Sukai Kuraddo no Kansokusha\" (スカイクラッドの観測者) by Kanako Ito (ep 23)", "#3: \"Another Heaven\" by Kanako Itou (ep 24)"]
 
 
-Cast and Staff:
-    
+#####Cast and Staff:
+
     steins_gate.cast.find_all {|c| c.name.include? "Hanazawa"}
      => [#<struct ANN_Cast id="53741", role="Mayuri Shiina", name="Kana Hanazawa", lang="JA">]
-     
+
     steins_gate.staff.find_all {|s| s.task.eql? "Director"}
      => [
-            #<struct ANN_Staff id="593", task="Director", name="Takuya Satō">, 
-            #<struct ANN_Staff id="9693", task="Director", name="Hiroshi Hamasaki">, 
+            #<struct ANN_Staff id="593", task="Director", name="Takuya Satō">,
+            #<struct ANN_Staff id="9693", task="Director", name="Hiroshi Hamasaki">,
             #<struct ANN_Staff id="35713", task="Director", name="Tomoki Kobayashi">
         ]
 
 
-Episodes:
+#####Episodes:
 
     steins_gate.episodes.find_all {|e| e.title.include? "Prologue"}
      => [
-            #<struct ANN_Episode number="1", title="Prologue of the Beginning and End", lang="EN">, 
+            #<struct ANN_Episode number="1", title="Prologue of the Beginning and End", lang="EN">,
             #<struct ANN_Episode number="24", title="The Prologue Begins With the End", lang="EN">
         ]
-        
+
     steins_gate.episodes.first.to_h
      => {:number=>"1", :title=>"Prologue of the Beginning and End", :lang=>"EN"}
-        
-Images:
+
+#####Images:
 
     steins_gate.images
      => [
-            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/fit200x200/encyc/A11770-1864351140.1370764886.jpg", width="200", height="125">, 
-            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/max500x600/encyc/A11770-1864351140.1370764886.jpg", width="500", height="312">, 
-            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/images/encyc/A11770-1864351140.1370764886.jpg", width="900", height="562">, 
-            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/fit200x200/encyc/A11770-8.jpg", width="200", height="200">, 
+            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/fit200x200/encyc/A11770-1864351140.1370764886.jpg", width="200", height="125">,
+            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/max500x600/encyc/A11770-1864351140.1370764886.jpg", width="500", height="312">,
+            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/images/encyc/A11770-1864351140.1370764886.jpg", width="900", height="562">,
+            #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/fit200x200/encyc/A11770-8.jpg", width="200", height="200">,
             #<struct ANN_Image src="http://cdn.animenewsnetwork.com/thumbnails/max500x600/encyc/A11770-8.jpg", width="317", height="317">
         ]
+        
+#####Ratings:
 
-
-
-
-
+    steings_gate.ratings
+     => [
+            #<struct ANN_Rating votes="3788", weighted="9.1129", bayesian_score="9.1075">
+        ]
+        
+###Fetch a manga:
+
+Fetching a manga works exactly the same as an anime, but you should call the `fetch_manga` method.
+
+    manga = ANN_Wrapper.fetch_manga "id"
+    manga.title
+    manga.alt_titles
+    manga.synopsis
+    manga.genres
+    manga.vintage
+    manga.themes
+    manga.num_tankoubon
+    manga.num_pages
+    manga.id
+    manga.type
+    manga.staff
+    manga.ratings
+    manga.images
+    manga.to_h
+
+###Batching:
+Send any number of ids in an array for a batch request.
+This will return an array of ANN_Anime or ANN_Manga objects.
+
+    anime = ANN_Wrapper.batch_anime(["id_1", "id_2", "id_3", ...])
+    manga = ANN_Wrapper.batch_manga(["id_1", "id_2", "id_3", ...])
 
 ## Contributing
 

data/ann_wrapper.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["getkura+ann_wrapper@gmail.com"]
   spec.description   = 'A simple wrapper for the Anime News Network API'
   spec.summary       = 'Anime News Network API wrapper'
-  spec.homepage      = "http://documentup.com/Getkura/ann_wrapper"
+  spec.homepage      = "http://getkura.github.io/ann_wrapper/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/ann_wrapper.rb

@@ -4,35 +4,59 @@
 
 require "net/http"
 require "nokogiri"
-require 'ann_wrapper/ann_objects'
+require 'ann_wrapper/ann_anime'
+require 'ann_wrapper/ann_manga'
+require 'ann_wrapper/ann_report'
 
 # wrapper class for ANN API
 module ANN_Wrapper
 extend ANN_Wrapper
 
+	@@type = "anime"
+
 	# ANN API anime url
 	ANN_URL         = "http://cdn.animenewsnetwork.com/encyclopedia"
 	ANN_API_URL     = "#{ANN_URL}/api.xml"
 	ANN_REPORTS_URL = "#{ANN_URL}/reports.xml"
 
-	# fetch anime and convert to ANN_Anime
-	def fetch_anime(id, api_url=ANN_API_URL)
+	# fetch up to 50 items(Animes or Mangas) in one request
+	def batch_items(ids, api_url=ANN_API_URL)
 		# append id to API url and send request
-		url = "#{api_url}?anime=#{id.to_s}"
+		url = "#{api_url}?title=#{ids.first.to_s}"
+		ids[1..-1].each do |id|
+			url << "/#{id.to_s}"
+		end
 
 		ann = fetch(url)
 
-		return ann if ann.is_a?(ANN_Error)
+		return [ann] if ann.is_a?(ANN_Error)
+
+		all_items = ann.xpath("//ann/#{@@type}")
+		warnings = ann.xpath('//ann/warning')
+
+		return [ANN_Error.new(get_xml_error(ann))] if all_items.empty? and warnings.empty?
+
+		all_items = all_items.map { |item| Object.const_get("ANN_#{@@type.capitalize}").new(item) }
+		warnings = warnings.map { |warning| ANN_Error.new(get_xml_error(warning)) }
 
-		anime = ann.at_xpath('//ann/anime')
+		all_items.push(*warnings)
+	end
 
-		# initialize new ann_anime or error with ann object
-		anime.nil? ? ANN_Error.new(get_xml_error(ann)) : ANN_Anime.new(anime)
+	# fetch anime and convert to ANN_Anime
+	def fetch_item(id, api_url=ANN_API_URL)
+		batch_items([id], api_url).first
 	end
 
 	# fetch list of titles via reports
-	def fetch_titles(type="anime", nskip=0, nlist=50, name="", api_url=ANN_REPORTS_URL)
-		url = "#{api_url}?id=155&type=#{type}&nskip=#{nskip}&nlist=#{nlist}"
+	def fetch_titles(options = {})
+		options[:type]    ||= "anime"
+		options[:nskip]   ||= 0
+		options[:nlist]   ||= 50
+		options[:name]    ||= ""
+		options[:api_url] ||= ANN_REPORTS_URL
+
+		url = "#{options[:api_url]}?id=155&type=#{options[:type]}&name=#{options[:name]}&nskip=#{options[:nskip]}&nlist=#{options[:nlist]}"
+
 		report = fetch(url)
 
 		return report if report.is_a?(ANN_Error)
@@ -44,6 +68,15 @@ extend ANN_Wrapper
 		reports.map { |item| ANN_Report.new(item) }
 	end
 
+  def method_missing(meth, *args, &block)
+    if meth.to_s =~ /^(fetch|batch)_(anime|manga)$/
+      @@type = $2
+      $1 == 'fetch' ? fetch_item(*args) : batch_items(*args)
+    else
+      super
+    end
+  end
+
 	private
 		# fetch data from ANN API via http GET request
 		# returns Nokogiri or ANN_Error
@@ -55,16 +88,16 @@ extend ANN_Wrapper
 				# get the response body and try converting to Nokogiri object
 				Nokogiri.XML(resp.body)
 			rescue
-				ANN_Error.new("xml format error, API likely unavailable")
+				ANN_Error.new("Could not reach valid URL")
 			end
-		end	
+		end
 
 		# attempt to grab error message from XMLObject
 		def get_xml_error(xobj)
 			begin
 				xobj.at_xpath('//ann/warning').content
-			rescue NameError
-				"bad response"
+			rescue NoMethodError
+				"unrecognized response body"
 			end
 		end
 	end

data/lib/ann_wrapper/ann.rb

@@ -0,0 +1,44 @@
+# parent with helper methods
+class ANN
+	private
+		##
+		# define method with supplied name and block
+		def create_method(name, &block)
+			self.class.send(:define_method, name, &block)
+		end
+
+
+		# return hash of methods and returns excluding those in excludes
+		def to_hash(excludes)
+			# get list of methods excluding above
+			methods = self.class.instance_methods(false).reject {|m| excludes.include? m}
+
+			# map methods and results to hash
+			data = methods.map do |method |
+				result = self.send(method)
+
+				# convert Structs to hash
+				if (result.is_a? Array)
+					result.map! do |item|
+						item.is_a?(Struct) ? item.hash : item
+					end
+				else
+					result.hash! if result.is_a?(Struct)
+				end
+
+				# make hash with method name and result of call
+				[method.to_sym, result]
+			end
+
+			# return hash
+			Hash[data]
+		end
+	end
+
+# various ANN struct types
+ANN_Error   = Struct.new(:message)
+ANN_Staff   = Struct.new(:id, :task, :name)
+ANN_Cast    = Struct.new(:id, :role, :name, :lang)
+ANN_Episode = Struct.new(:number, :title, :lang)
+ANN_Image   = Struct.new(:src, :width, :height)
+ANN_Rating	= Struct.new(:votes, :weighted, :bayesian_score)

data/lib/ann_wrapper/ann_anime.rb

@@ -0,0 +1,85 @@
+require_relative 'ann_media'
+
+class ANN_Anime < ANN_Media
+	# ann_anime Nokogiri object
+	attr_writer :ann_anime
+
+
+	# initialize and create info methods
+	def initialize(ann_anime)
+		@ann_anime = ann_anime
+
+		# information available from detail
+		@info = Hash.new
+		@info[:title]         = "Main title"
+		@info[:synopsis]      = "Plot Summary"
+		@info[:num_episodes]  = "Number of episodes"
+		@info[:genres]        = "Genres"
+		@info[:themes]        = "Themes"
+		@info[:vintage]       = "Vintage"
+		@info[:op_theme]      = "Opening Theme"
+		@info[:ed_theme]      = "Ending Theme"
+
+		# create methods
+		create_methods(@ann_anime, @info)
+
+	end
+
+	# @return [Nokogiri::XML::NodeSet] return all info with provided key
+	def find_info(key)
+		super(@ann_anime, key)
+	end
+
+	# @return [String] returns anime id
+	def id
+		@id ||= @ann_anime['id']
+	end
+
+	# @return [String] returns anime type
+	def type
+		@type ||= @ann_anime['type']
+	end
+
+	# @return [[ANN_Rating]] returns array of ANN_Episode
+	def ratings
+		super @ann_anime
+	end
+
+	# @return [[ANN_Episode]] returns array of ANN_Episode
+	def episodes
+		@episodes ||= @ann_anime.xpath("./episode").map do |e|
+			title = e.at_xpath("title")
+			ANN_Episode.new(e['num'], title.content, title['lang'])
+		end
+	end
+
+	# @return [[ANN_Cast]] returns array of ANN_Cast
+	def cast
+		@cast ||= @ann_anime.xpath("./cast").map do |s|
+			role = s.at_xpath("role")
+			person = s.at_xpath("person")
+			ANN_Cast.new(person['id'], role.content, person.content, s['lang'])
+		end
+	end
+
+	# @return [[ANN_Staff]] returns array of ANN_Staff
+	def staff
+		super @ann_anime
+	end
+
+	# @return [Hash] hash of self
+	def to_h
+		# create hash excluding some methods
+		to_hash([:to_h, :ann_anime=, :find_info])
+	end
+
+	##
+	# These methods are created via create_method in the constructor
+
+	# @return [[String]] returns number of episodes
+	def num_episodes; end
+	# @return [[String]] returns op theme(s)
+	def op_theme; end
+	# @return [[String]] returns ed theme(s)
+	def ed_theme; end
+end

data/lib/ann_wrapper/ann_manga.rb

@@ -0,0 +1,63 @@
+require_relative 'ann_media'
+
+class	ANN_Manga < ANN_Media
+	# ann_anime Nokogiri object
+	attr_writer :ann_manga
+
+	def initialize(ann_manga)
+		@ann_manga = ann_manga
+
+		# information available from detail
+		@info = Hash.new
+		@info[:title]         			= "Main title"
+		@info[:synopsis]      			= "Plot Summary"
+		@info[:genres]        			= "Genres"
+		@info[:vintage]       			= "Vintage"
+		@info[:themes]        			= "Themes"
+		@info[:num_tankoubon] = "Number of tankoubon"
+		@info[:num_pages]						= "Number of pages"
+
+		# create methods
+		create_methods(@ann_manga, @info)
+	end
+
+	# @return [Nokogiri::XML::NodeSet] return all info with provided key
+	def find_info(key)
+		super(@ann_manga, key)
+	end
+
+	# @return [String] returns manga id
+	def id
+		@id ||= @ann_manga['id']
+	end
+
+	# @return [String] returns manga type
+	def type
+		@type ||= @ann_manga['type']
+	end
+
+	# @return [[ANN_Staff]] returns array of ANN_Staff
+	def staff
+		super @ann_manga
+	end
+
+	# @return [[ANN_Rating]] returns array of ANN_Episode
+	def ratings
+		super @ann_manga
+	end
+
+	# @return [Hash] hash of self
+	def to_h
+		# create hash excluding some methods
+		to_hash([:to_h, :ann_manga=, :find_info])
+	end
+
+	##
+	# These methods are created via create_method in the constructor
+
+	# @return [[String]] returns the number of tankoubon
+	def num_tankoubon; end
+
+	# @return [[String]] returns the number of tankoubon
+	def num_pages; end
+end