ann_wrapper 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20fb6fdc088155e3d21d55bdd957fe895863f6ea
+  data.tar.gz: e7e94ec1418f697cdc0764495fdcd31a0ad962e7
+SHA512:
+  metadata.gz: 32aac6ddb361a0dc399cc1cb3df6e28be891c42d08e5f5447bddec6ee27877641f1288205869073de2fbfdc4853c1cd81135b7928ad8fc40703c8142655f1b05
+  data.tar.gz: ba760c4c2e2e4c7ffd9c784c3fdca0cc3581aef517a4e99b2ce536736df3c53fdfe3ccb5948eede7d3c812ac8f7ea1ef210a44dcab317f5f46638902860045e2

data/bin/example

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+##########################################
+#
+# Example usage of ANN wrapper and methods
+#
+##########################################
+
+require 'ann_wrapper'
+
+if ARGV.size < 1
+	puts "Usage: example <ann anime id>"
+	exit
+end
+
+def show(obj, method)
+	puts "#{method}: #{obj.send(method).to_s}"
+end
+
+begin
+	# create ANN API Wrapper instance
+	anime = ANN_Wrapper.instance.fetch_ann_anime(ARGV[0])
+
+	if anime.is_a?(ANN_Error)
+		puts anime.message
+		exit(1)
+	end
+
+	#demo
+	show anime, :title
+	show anime, :alt_titles
+	show anime, :type
+#	show anime, :synopsis
+	show anime, :num_episodes
+	show anime, :genres
+	show anime, :themes
+#	show anime, :op_theme
+#	show anime, :ed_theme
+#	show anime, :episodes
+#	show anime, :staff
+#	show anime, :cast
+#	show anime, :images
+
+#titles = ANN_Wrapper.instance.fetch_titles("anime", 0, 5)
+#if titles.is_a?(ANN_Error)
+#	puts titles.message
+#	exit(1)
+#end
+#
+#titles.each do |title|
+#	puts title.id
+#end
+#
+rescue
+	puts "oops"
+
+	# print last exception and backtrace
+	puts $!.inspect, $@
+end

data/lib/ann_wrapper.rb

@@ -0,0 +1,71 @@
+##################################################
+# ANN_Wrapper
+##################################################
+
+require "net/http"
+require "nokogiri"
+require 'ann_wrapper/ann_objects'
+require 'singleton'
+
+# wrapper class for ANN API
+class ANN_Wrapper
+	include Singleton
+	# 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 data from ANN API via http GET request
+	# returns Nokogiri or ANN_Error
+	def fetch(url)
+		begin
+			# send http GET request with uri parsed from url
+			resp = Net::HTTP.get_response(URI.parse(url))
+
+			# get the response body and try converting to Nokogiri object
+			Nokogiri.XML(resp.body)
+		rescue
+			ANN_Error.new("xml format error, API likely unavailable")
+		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"
+		end
+	end
+
+	# fetch anime and convert to ANN_Anime
+	def fetch_ann_anime(id)
+		# append id to API url and send request
+		url = "#{ANN_API_URL}?anime=#{id.to_s}"
+
+		ann = fetch(url)
+
+		return ann if ann.is_a?(ANN_Error)
+
+		anime = ann.at_xpath('//ann/anime')
+
+		# initialize new ann_anime or error with ann object
+		anime.nil? ? ANN_Error.new(get_xml_error(ann)) : ANN_Anime.new(anime)
+	end
+
+	# fetch list of titles via reports
+	def fetch_titles(type="anime", nskip=0, nlist=50, name="")
+		url = "#{ANN_REPORTS_URL}?id=155&type=#{type}&nskip=#{nskip}&nlist=#{nlist}"
+		report = fetch(url)
+
+		return report if report.is_a?(ANN_Error)
+
+		reports = report.xpath('//report/item')
+
+		return ANN_Error.new(get_xml_error(report)) if reports.nil?
+		
+		reports.map do |item|
+			ANN_Report.new(item)
+		end
+	end
+end

data/lib/ann_wrapper/ann_objects.rb

@@ -0,0 +1,150 @@
+##################################################
+# ANN_Objects
+##################################################
+
+# 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
+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)
+
+class ANN_Anime < ANN
+	# 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
+		@info.each do |name, key|
+			create_method(name) do 
+				info = find_info(key)
+				return nil if info.nil?
+				info.map do |i|
+					i.content
+				end
+			end
+		end
+
+	end
+
+	# return all info with provided key
+	def find_info(key)
+		begin
+			@ann_anime.search("info[@type=\"#{key}\"]")
+		rescue 
+			nil
+		end
+	end
+
+	# returns array of titles grouped by language abbreviation
+	def alt_titles
+		begin
+			titles = find_info("Alternative title").group_by {|title| title['lang']}
+
+			titles.each do |key, value|
+				value.map! do |title|
+					title.content
+				end
+			end
+		rescue NameError
+			nil
+		end
+	end
+
+	def type
+		@type ||= @ann_anime['type']
+	end
+		
+	# returns array of ANN_Image
+	def images
+		begin
+			@images ||= find_info("Picture").map do |i|
+				ANN_Image.new(i['src'], i['width'], i['height'])
+			end
+		rescue NameError
+			nil
+		end
+	end
+
+	# returns array of ANN_Episode
+	def episodes
+		begin
+			@episodes ||= @ann_anime.xpath("//episode").map do |e|
+				title = e.at_xpath("title")
+				ANN_Episode.new(e['num'], title.content, title['lang'])
+			end
+		rescue NameError
+			nil
+		end
+	end
+
+	# returns array of ANN_Staff
+	def staff
+		begin
+			@staff ||= @ann_anime.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
+		rescue NameError
+			nil
+		end
+	end
+
+	# returns array of ANN_Cast
+	def cast
+		begin
+			@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
+		rescue NameError
+			nil
+		end
+	end
+end
+
+class ANN_Report < ANN
+	# initialize and build access methods
+	def initialize(ann_report)
+		@id, @type, @name, @precision, @vintage = ""
+
+		self.instance_variables.each do |iv|
+			var_name = iv.to_s.partition("@").last
+			create_method(var_name) { get_info_on(ann_report, var_name) }
+		end
+	end
+
+	# get info from xml
+	def get_info_on(ann_report, var_name)
+		begin 
+			ann_report.at_xpath(var_name).content
+		rescue NameError
+			nil
+		end
+	end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: ann_wrapper
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- getkura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 00:00:00.000000000 Z
+dependencies: []
+description: A simple wrapper for the Anime News Network API
+email: getkura+ann_wrapper@gmail.com
+executables:
+- example
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ann_wrapper.rb
+- lib/ann_wrapper/ann_objects.rb
+- bin/example
+homepage: http://rubygems.org/gems/ann_wrapper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Anime News Network API wrapper
+test_files: []