ann_wrapper 1.1.4 → 1.1.5

data/lib/ann_wrapper/ann_media.rb

@@ -0,0 +1,67 @@
+require_relative 'ann'
+
+class ANN_Media < ANN
+
+	# @return [Nokogiri::XML::NodeSet] return all info with provided key
+	def find_info(obj, key)
+		obj.search("info[@type=\"#{key}\"]")
+	end
+
+	# create methods inside calling object
+	def create_methods(obj, dictionary)
+		dictionary.each do |name, key|
+			create_method(name) do
+				# find_info in calling object
+				info = find_info(key)
+				return nil if info.nil?
+				info.map do |i|
+					i.content
+				end
+			end
+		end
+	end
+
+	# @return [[String]] returns title(s)
+	def title; end
+	# @return [[String]] returns synopsis
+	def synopsis; end
+	# @return [[String]] returns array of genres
+	def genres; end
+	# @return [[String]] returns array of themes
+	def themes; end
+	# @return [[String]] returns array of vintage(s)
+	def vintage; end
+
+	# @return [[ANN_Image]] returns array of ANN_Image
+	def images
+		@images ||= find_info("Picture").xpath("./img").map do |i|
+			ANN_Image.new(i['src'], i['width'], i['height'])
+		end
+	end
+
+	# @return [[ANN_Staff]] returns array of ANN_Staff
+	def staff(obj)
+		@staff ||= obj.xpath("./staff").map do |s|
+			task = s.at_xpath("task")
+			person = s.at_xpath("person")
+			ANN_Staff.new(person['id'], task.content, person.content)
+		end
+	end
+
+	# @return [Hash] returns hash of titles grouped by language abbreviation
+	def alt_titles
+		titles = find_info("Alternative title").group_by {|title| title['lang']}
+		titles.each do |key, value|
+			value.map! do |title|
+				title.content
+			end
+		end
+	end
+
+	# @return [[ANN_Rating]] returns array of ANN_Episode
+	def ratings(obj)
+		@ratings ||= obj.xpath("./ratings").map do |r|
+			ANN_Rating.new(r['nb_votes'], r['weighted_score'], r['bayesian_score'])
+		end
+	end
+end

data/lib/ann_wrapper/ann_report.rb

@@ -0,0 +1,26 @@
+require_relative 'ann'
+
+class ANN_Report < ANN
+	# initialize and build access methods
+	def initialize(ann_report)
+		@id, @type, @name, @precision, @vintage = ""
+		@ann_report = ann_report
+
+		self.instance_variables.each do |iv|
+			var_name = iv[1..-1]
+			create_method(var_name) { get_info_on(var_name) }
+		end
+	end
+
+	# get info from xml
+	def get_info_on(var_name)
+		body = @ann_report.at_xpath(var_name)
+		body.content unless body.nil?
+	end
+
+	# @return [Hash] hash of self
+	def to_h
+		# create hash excluding some methods
+		to_hash([:to_h, :ann_report, :get_info_on])
+	end
+end

data/lib/ann_wrapper/version.rb

@@ -1,3 +1,3 @@
 module AnnWrapper
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

data/spec/ann_anime_spec.rb

@@ -1,152 +1,122 @@
+# encoding: utf-8
 require 'spec_helper'
 
+
+
 describe ANN_Anime do
 
-	def array_of_strings(input)
-		expect(input).to be_instance_of Array
-		expect(input[0]).to be_instance_of String
+	shared_examples_for "an Array of" do |method, object, expected, index=0|
+		let(:result) {ANN_Wrapper.fetch_anime(11770).send(method.to_sym)}
+		it "#{object} objects" do
+			expect(result).to be_an_instance_of Array
+			expect(result.first).to be_an_instance_of object
+		end
+		it "containing the correct #{method}" do
+			expect(result[index]).to eql expected
+		end
 	end
 
-	before(:each) do
-		@anime = ANN_Wrapper.fetch_anime(11770)
+	shared_examples_for "a String" do |method, expected|
+		it "containing the correct #{method}" do
+			anime = ANN_Wrapper.fetch_anime 11770
+			result = anime.send(:"#{method}")
+			expect(result).to be_an_instance_of String
+			expect(result).to eql expected
+		end
 	end
 
-	describe "#id" do
-		it "returns a string containing an anime id" do
-			expect(@anime.id).to be_instance_of String
-			expect(@anime.id.size).to be > 0
+	shared_examples_for "a Hash of" do |method, object, key, expected|
+		let(:result) {ANN_Wrapper.fetch_anime(11770).send(method.to_sym)}
+		it "#{object}s" do
+			expect(result).to be_an_instance_of Hash
+			expect(result.first).to be_an_instance_of object
 		end
-		it "returns the correct anime id" do
-			expect(@anime.id).to eql "11770"
+		it "containing the correct #{method}" do
+			expect(result[key].first).to eql expected
 		end
 	end
 
-	describe "#title" do
-		it "returns an array of strings" do
-			array_of_strings(@anime.title)
-		end
-		it "returns the correct titles" do
-			expect(@anime.title[0]).to eql "Steins;Gate"
+	describe "#find_info" do
+		let(:anime) {ANN_Wrapper.fetch_anime(11770)}
+		context "invalid key" do
+			it "returns an empty array" do
+				expect(anime.find_info("DOES NOT EXIST").size).to eql 0
+			end
 		end
 	end
 
+	describe "#id" do
+		it_returns "a String", :id, "11770"
+	end
+
+	describe "#title" do
+		it_returns "an Array of", :title, String, "Steins;Gate"
+	end
+
 	describe "#alt_titles" do
-		it "returns a hash of alternate titles" do
-			expect(@anime.alt_titles).to be_instance_of Hash
-			array_of_strings(@anime.alt_titles["JA"])
-		end
-		it "JA array is not empty" do
-			expect(@anime.alt_titles["JA"][0].size).to be > 0
-		end
+		it_returns "a Hash of", :alt_titles, Array, "PT", "Steins-Gate e a Teoria do Caos"
 	end
 
 	describe "#synopsis" do
-		it "returns an Array containing a synopsis string" do
-			array_of_strings @anime.synopsis
-		end
-		it "returns the correct synopsis" do
-			expect(@anime.synopsis[0]).to include "Rintaro Okabe is a self-proclaimed"
-		end
+		it_returns "an Array of", :synopsis, String, "Rintaro Okabe is a self-proclaimed \"mad scientist\" who believes that an international organization is conspiring to reshape the world according to its own interests. He and his friend Itaru Hashida inadvertently create a gadget able to send messages to the past. The discovery and experimentation of this instrument become the catalyst of fundamental alterations to the present. Oblivious of the consequences of their actions, Rintaro and his friends end up creating modifications of grievous proportions. He must then try to find a way to return as close as possible to the original timeline in order to save his precious lab members."
 	end
 
 	describe "#num_episodes" do
-		it "returns an Array containing a string of the number of episodes" do
-			array_of_strings @anime.num_episodes
-		end
-		it "returns the correct number of episodes" do
-			expect(@anime.num_episodes).to eql ["24"]
-		end
+		it_returns "an Array of", :num_episodes, String, "24"
 	end
 
 	describe "#vintage" do
-		it "returns an Array containing vintage strings" do
-			array_of_strings @anime.vintage
-		end
-		it "returns the correct vintage" do
-			expect(@anime.vintage[0]).to eql "2011-04-03 (Advanced screening)"
-		end
+		it_returns "an Array of", :vintage, String, "2011-04-03 (Advanced screening)"
 	end
 
 	describe "#genres" do
-		it "returns an Array containing genre strings" do
-			array_of_strings @anime.genres
-		end
-		it "returns the correct genres" do
-			expect(@anime.genres[0]).to eql "adventure"
-		end
+		it_returns "an Array of", :genres, String, "adventure"
 	end
 
 	describe "#themes" do
-		it "returns an Array containing theme strings" do
-			array_of_strings @anime.themes
-		end
-		it "returns the correct themes" do
-			expect(@anime.themes[0]).to eql "butterfly effect"
-		end
+		it_returns "an Array of", :themes, String, "butterfly effect"
 	end
 
 	describe "#op_theme" do
-		it "returns an Array containing op_theme strings" do
-			array_of_strings @anime.op_theme
-		end
-		it "returns the correct op themes" do
-			expect(@anime.op_theme[0]).to eql "\"Hacking to the Gate\" by Kanako Ito"
-		end
+		it_returns "an Array of", :op_theme, String, "\"Hacking to the Gate\" by Kanako Ito"
 	end
 
 	describe "#ed_theme" do
-		it "returns an Array containing ed_theme strings" do
-			array_of_strings @anime.ed_theme
-		end
-		it "returns the correct ed_themes" do
-			expect(@anime.ed_theme[2]).to eql "#3: \"Another Heaven\" by Kanako Itou (ep 24)"
-		end
+		it_returns "an Array of", :ed_theme, String, "#3: \"Another Heaven\" by Kanako Itou (ep 24)", 2
+	end
+
+	describe "#ratings" do
+		it_returns "an Array of", :ratings, ANN_Rating, ANN_Rating.new("3788", "9.1129", "9.1075")
+	end
+
+	describe "#episodes" do
+		it_returns "an Array of", :episodes, ANN_Episode, ANN_Episode.new("1", "Prologue of the Beginning and End", "EN")
 	end
 
 	describe "#cast" do
-		it "returns an Array containing ANN_Cast" do
-			expect(@anime.cast).to be_instance_of Array
-			expect(@anime.cast[0]).to be_instance_of ANN_Cast
-		end
-		it "correctly stores cast information in an ANN_Cast" do
-			first_cast = ANN_Cast.new("1386", "Yugo \"Braun\" Tennoji", "Christopher R. Sabat", "EN")
-			expect(@anime.cast[0]).to eql first_cast
-		end
+		it_returns "an Array of", :cast, ANN_Cast, ANN_Cast.new("110469", "Rintarō Okabe", "Peter Lehn", "DE")
 	end
 
 	describe "#staff" do
-		it "returns an Array containing ANN_Staff" do
-			expect(@anime.staff).to be_instance_of Array
-			expect(@anime.staff[1]).to be_instance_of ANN_Staff
-		end
-		it "correctly stores staff information in an ANN_Staff" do
-			first_staff = ANN_Staff.new("9693", "Director", "Hiroshi Hamasaki")
-			expect(@anime.staff[1]).to eql first_staff
-		end
+		it_returns "an Array of", :staff, ANN_Staff, ANN_Staff.new("9693", "Director", "Hiroshi Hamasaki"), 1
 	end
 
 	describe "#images" do
-		it "returns an Array containing ANN_Image" do
-			expect(@anime.images).to be_instance_of Array
-			expect(@anime.images[0]).to be_instance_of ANN_Image
-		end
-		it "correctly stores image information in an ANN_Image" do
-			first_image = ANN_Image.new("http://cdn.animenewsnetwork.com/thumbnails/fit200x200/encyc/A11770-1864351140.1370764886.jpg", "200", "125")
-			expect(@anime.images[0]).to eql first_image
-		end
+		it_returns "an Array of", :images, ANN_Image, ANN_Image.new("http://cdn.animenewsnetwork.com/thumbnails/hotlink-fit200x200/encyc/A11770-1864351140.1370764886.jpg", "200", "125")
 	end
 
 	describe "#to_h" do
-		it "returns a hash of all information" do
-			anime_hash = @anime.to_h
+		let(:anime) {ANN_Wrapper.fetch_anime(11770)}
+		it "returns a hash of anime information" do
+			anime_hash = anime.to_h
 			expect(anime_hash).to be_instance_of Hash
 			expect(anime_hash[:id]).to eql "11770"
 		end
 		it "correctly converts structs to hash" do
-			anime_hash = @anime.to_h
+			anime_hash = anime.to_h
 			staff_hash = ANN_Staff.new("9693", "Director", "Hiroshi Hamasaki").hash
 			expect(anime_hash[:staff][1]).to eql staff_hash
 		end
 	end
 end
-		
+

data/spec/ann_manga_spec.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ANN_Manga do
+
+	shared_examples_for "an Array of" do |method, object, expected, index=0|
+		let(:result) {ANN_Wrapper.fetch_manga(16086).send(method.to_sym)}
+		it "#{object} objects" do
+			expect(result).to be_an_instance_of Array
+			expect(result.first).to be_an_instance_of object
+		end
+		it "containing the correct #{method}" do
+			expect(result[index]).to eql expected
+		end
+	end
+
+	shared_examples_for "a String" do |method, expected|
+		it "containing the correct #{method}" do
+			manga = ANN_Wrapper.fetch_manga 16086
+			result = manga.send(:"#{method}")
+			expect(result).to be_an_instance_of String
+			expect(result).to eql expected
+		end
+	end
+
+	shared_examples_for "a Hash of" do |method, object, key, expected|
+		let(:result) {ANN_Wrapper.fetch_manga(16086).send(method.to_sym)}
+		it "#{object}s" do
+			expect(result).to be_an_instance_of Hash
+			expect(result.first).to be_an_instance_of object
+		end
+		it "containing the correct #{method}" do
+			expect(result[key].first).to eql expected
+		end
+	end
+
+  describe "#find_info" do
+    let(:manga) {ANN_Wrapper.fetch_manga(16086)}
+    context "invalid key" do
+      it "returns an empty array" do
+        expect(manga.find_info("DOES NOT EXIST").size).to eql 0
+      end
+    end
+  end
+
+  describe "#id" do
+    it_returns "a String", :id, "16086"
+  end
+
+  describe "#title" do
+    it_returns "an Array of", :title, String, "Tokyo Ghoul"
+  end
+
+  describe "#alt_titles" do
+    it_returns "a Hash of", :alt_titles, Array, "JA", "東京喰種トーキョーグール"
+  end
+
+  describe "#synopsis" do
+    it_returns "an Array of", :synopsis, String, "Ken Kaneki is a bookworm college student who meets a girl named Rize at a cafe he frequents. They're the same age and have the same interests, so they quickly become close. Little does Kaneki know that Rize is a ghoul - a kind of monster that lives by hunting and devouring human flesh. When part of her special organ - \"the red child\" - is transplanted into Kaneki, he becomes a ghoul himself, trapped in a warped world where humans are not the top of the food chain."
+
+  end
+
+  describe "#vintage" do
+    it_returns "an Array of", :vintage, String, "2011-09-08 to 2014-09-18 (serialized in Weekly Young Jump)"
+  end
+
+	describe "#ratings" do
+		it_returns "an Array of", :ratings, ANN_Rating, ANN_Rating.new("32", "8.5385", "8.4562")
+	end
+
+  describe "#num_tankoubon" do
+    it_returns "an Array of", :num_tankoubon, String, "9"
+  end
+
+  describe "#num_pages" do
+    it_returns "an Array of", :num_pages, String, "202"
+  end
+
+  describe "#genres" do
+    it_returns "an Array of", :genres, String, "horror"
+  end
+
+  describe "#themes" do
+    it_returns "an Array of", :themes, String, "monsters"
+  end
+
+  describe "#staff" do
+    it_returns "an Array of", :staff, ANN_Staff, ANN_Staff.new("123563", "Story & Art", "Sui Ishida")
+  end
+
+  describe "#images" do
+    it_returns "an Array of", :images, ANN_Image, ANN_Image.new("http://cdn.animenewsnetwork.com/thumbnails/hotlink-fit200x200/encyc/A16086-3098213756.1401567064.jpg", "141", "200")
+  end
+
+  describe "#to_h" do
+    let(:manga) {ANN_Wrapper.fetch_manga(16086)}
+    it "returns a hash of manga information" do
+      manga_hash = manga.to_h
+      expect(manga_hash).to be_instance_of Hash
+      expect(manga_hash[:id]).to eql "16086"
+    end
+    it "correctly converts structs to hash" do
+      manga_hash = manga.to_h
+      staff_hash = ANN_Staff.new("123563", "Story & Art", "Sui Ishida").hash
+      expect(manga_hash[:staff][0]).to eql staff_hash
+    end
+  end
+end
+

data/spec/ann_report_spec.rb

@@ -0,0 +1,62 @@
+# clear global definitions
+
+require 'spec_helper'
+
+
+describe ANN_Report do
+	shared_examples_for "a String" do |method, expected|
+		it "containing the correct #{method}" do
+			report = ANN_Wrapper.fetch_titles({type: "anime", nskip: 0, nlist: 5})[0]
+			result = report.send(:"#{method}")
+			expect(result).to be_an_instance_of String
+			expect(result).to eql expected
+		end
+	end
+
+	describe "#id" do
+		it_returns "a String", :id, "15847"
+	end
+
+	describe "#type" do
+		it_returns "a String", :type, "TV"
+	end
+
+	describe "#name" do
+		it_returns "a String", :name, "Nandaka Velonica"
+	end
+
+	describe "#precision" do
+		it_returns "a String", :precision, "TV"
+	end
+
+	describe "#vintage" do
+		it_returns "a String", :vintage, "2014-03-10 to 2014-03-21"
+	end
+
+	describe "get_info_on" do
+		let(:report) {ANN_Wrapper.fetch_titles({type: "anime", nskip: 0, nlist: 5})[0]}
+		context "when a valid info key is provided" do
+			it "returns the correct value for the key" do
+				result = report.get_info_on("id")
+				expect(result).to be_an_instance_of String
+				expect(result).to eql "15847"
+			end
+		end
+
+		context "when an invalid info key is provided" do
+			it "returns nil" do
+				result = report.get_info_on("INVALID")
+				expect(result).to be nil
+			end
+		end
+	end
+
+	describe "#to_h" do
+		let(:report) {ANN_Wrapper.fetch_titles({type: "anime", nskip: 0, nlist: 5})[0]}
+		it "returns a hash of report information" do
+			report_hash = report.to_h
+			expect(report_hash).to be_instance_of Hash
+			expect(report_hash[:id]).to eql "15847"
+		end
+	end
+end