ann_wrapper 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8527b835977682de747e937629083821269c86f3
-  data.tar.gz: 37915e0c85143251ea32954ee34be0236002a10a
+  metadata.gz: 5c633706a6c6f24e42f1f8bcb15df77b55438922
+  data.tar.gz: 59bc45c410c7ee4d5f7e438002d02d264ee4f6db
 SHA512:
-  metadata.gz: a039e4b0a25587dbc4ead543fa1512788ad7990e8b271b88367d7312b90aec131d3927caf388cb7184c7fe20ede10740631b92ddc8287d0f08caa621c75c6fee
-  data.tar.gz: 871b0a8e7033996ecf74afb762c2cfab678bcca359311cf519ff9a03ff273e1fb759397cf98765a558b256510fbbb0e6a5db6a07af0cd874e284e5d4f368fe45
+  metadata.gz: b6388bdc6f50cb1058c36d02d5d4ae82fa50eea95bce3f7791839e15747b0e29c2ca31d68e5b0740ae07b930e6324e0d1acffbaf31dfa077939965a09aa74f2d
+  data.tar.gz: 83aebf0d4c30a3f97b3af180773e707d727685c40d6b03757eb6a0eacec80717ea1ecf62c665d2f60db723cb77c409002fd35f191321844b1baae85c878ae4cb

data/README.md

@@ -3,6 +3,7 @@
 
 [![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)
+[![Code Climate](https://codeclimate.com/github/Getkura/ann_wrapper.png)](https://codeclimate.com/github/Getkura/ann_wrapper)
 
 
 A simple ruby wrapper/abstraction for the [Anime News Network API](http://www.animenewsnetwork.com/encyclopedia/api.php)
@@ -23,7 +24,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Fetch an anime:
+
+    steins_gate = ANN_Wrapper.fetch_anime 11770
+
+Info:
+    
+    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:
+    
+    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="35713", task="Director", name="Tomoki Kobayashi">
+        ]
+
+
+Episodes:
+
+    steins_gate.episodes.first
+     => #<struct ANN_Episode number="1", title="Prologue of the Beginning and End", lang="EN">
+
+    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="24", title="The Prologue Begins With the End", lang="EN">
+        ]
+        
+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/fit200x200/encyc/A11770-8.jpg", width="200", height="200">
+        ]
+
+
+
+
 
 ## 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      = ""
+  spec.homepage      = "http://documentup.com/Getkura/ann_wrapper"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/ann_wrapper.rb

@@ -5,43 +5,20 @@
 require "net/http"
 require "nokogiri"
 require 'ann_wrapper/ann_objects'
-require 'singleton'
 
 # wrapper class for ANN API
-class ANN_Wrapper
-	include Singleton
+module ANN_Wrapper
+extend ANN_Wrapper
+
 	# 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)
+	def fetch_anime(id, api_url=ANN_API_URL)
 		# append id to API url and send request
-		url = "#{ANN_API_URL}?anime=#{id.to_s}"
+		url = "#{api_url}?anime=#{id.to_s}"
 
 		ann = fetch(url)
 
@@ -54,8 +31,8 @@ class ANN_Wrapper
 	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}"
+	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}"
 		report = fetch(url)
 
 		return report if report.is_a?(ANN_Error)
@@ -63,9 +40,31 @@ class ANN_Wrapper
 		reports = report.xpath('//report/item')
 
 		return ANN_Error.new(get_xml_error(report)) if reports.nil?
-		
-		reports.map do |item|
-			ANN_Report.new(item)
+
+		reports.map { |item| ANN_Report.new(item) }
+	end
+
+	private
+		# 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
 	end
-end

data/lib/ann_wrapper/ann_objects.rb

@@ -156,17 +156,18 @@ 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.to_s.partition("@").last
-			create_method(var_name) { get_info_on(ann_report, var_name) }
+			create_method(var_name) { get_info_on(var_name) }
 		end
 	end
 
 	# get info from xml
-	def get_info_on(ann_report, var_name)
+	def get_info_on(var_name)
 		begin 
-			ann_report.at_xpath(var_name).content
+			@ann_report.at_xpath(var_name).content
 		rescue NameError
 			nil
 		end

data/lib/ann_wrapper/version.rb

@@ -1,3 +1,3 @@
 module AnnWrapper
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/ann_wrapper_spec.rb

@@ -4,7 +4,7 @@ describe "fetch_ann_anime" do
 
 	context "a valid id is provided" do
 		it "should return data for an ann anime" do
-			anime = ANN_Wrapper.instance.fetch_ann_anime(11770)
+			anime = ANN_Wrapper.fetch_anime(11770)
 			anime.should_not be_nil
 			anime.title.first.should eql "Steins;Gate"
 		end
@@ -12,7 +12,7 @@ describe "fetch_ann_anime" do
 
 	context "an invalid id is provided" do
 		it "should return an ANN_Error" do
-			anime = ANN_Wrapper.instance.fetch_ann_anime(117700)
+			anime = ANN_Wrapper.fetch_anime(117700)
 			anime.should_not be_nil
 			anime.should be_kind_of(ANN_Error)
 			anime.message.should_not be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ann_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - shawntoffel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -85,7 +85,7 @@ files:
 - lib/ann_wrapper/version.rb
 - spec/ann_wrapper_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: http://documentup.com/Getkura/ann_wrapper
 licenses:
 - MIT
 metadata: {}