ann_wrapper 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20fb6fdc088155e3d21d55bdd957fe895863f6ea
-  data.tar.gz: e7e94ec1418f697cdc0764495fdcd31a0ad962e7
+  metadata.gz: 8527b835977682de747e937629083821269c86f3
+  data.tar.gz: 37915e0c85143251ea32954ee34be0236002a10a
 SHA512:
-  metadata.gz: 32aac6ddb361a0dc399cc1cb3df6e28be891c42d08e5f5447bddec6ee27877641f1288205869073de2fbfdc4853c1cd81135b7928ad8fc40703c8142655f1b05
-  data.tar.gz: ba760c4c2e2e4c7ffd9c784c3fdca0cc3581aef517a4e99b2ce536736df3c53fdfe3ccb5948eede7d3c812ac8f7ea1ef210a44dcab317f5f46638902860045e2
+  metadata.gz: a039e4b0a25587dbc4ead543fa1512788ad7990e8b271b88367d7312b90aec131d3927caf388cb7184c7fe20ede10740631b92ddc8287d0f08caa621c75c6fee
+  data.tar.gz: 871b0a8e7033996ecf74afb762c2cfab678bcca359311cf519ff9a03ff273e1fb759397cf98765a558b256510fbbb0e6a5db6a07af0cd874e284e5d4f368fe45

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ann_wrapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 shawntoffel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# ann_wrapper
+
+
+[![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)
+
+
+A simple ruby wrapper/abstraction for the [Anime News Network API](http://www.animenewsnetwork.com/encyclopedia/api.php)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ann_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ann_wrapper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/ann_wrapper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ann_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ann_wrapper"
+  spec.version       = AnnWrapper::VERSION
+  spec.authors       = ["shawntoffel"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+	spec.required_ruby_version = ">= 1.9"
+
+	spec.add_runtime_dependency "nokogiri"
+	
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/ann_wrapper/ann_objects.rb

@@ -2,9 +2,11 @@
 # 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)
@@ -22,6 +24,7 @@ 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
@@ -50,7 +53,7 @@ class ANN_Anime < ANN
 
 	end
 
-	# return all info with provided key
+	# @return [Nokogiri::XML::NodeSet] return all info with provided key
 	def find_info(key)
 		begin
 			@ann_anime.search("info[@type=\"#{key}\"]")
@@ -59,7 +62,27 @@ class ANN_Anime < ANN
 		end
 	end
 
-	# returns array of titles grouped by language abbreviation
+	##
+	# These methods are created via create_method in the constructor
+
+	# @return [[String]] returns title(s)
+	def title; end
+	# @return [[String]] returns synopsis
+	def synopsis; end
+	# @return [[String]] returns number of episodes
+	def num_episodes; 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 [[String]] returns op theme(s)
+	def op_theme; end
+	# @return [[String]] returns ed theme(s)
+	def ed_theme; end
+
+	# @return [Hash] returns hash of titles grouped by language abbreviation
 	def alt_titles
 		begin
 			titles = find_info("Alternative title").group_by {|title| title['lang']}
@@ -74,11 +97,12 @@ class ANN_Anime < ANN
 		end
 	end
 
+	# @return [String] returns anime type
 	def type
 		@type ||= @ann_anime['type']
 	end
 		
-	# returns array of ANN_Image
+	# @return [[ANN_Image]] returns array of ANN_Image
 	def images
 		begin
 			@images ||= find_info("Picture").map do |i|
@@ -89,7 +113,7 @@ class ANN_Anime < ANN
 		end
 	end
 
-	# returns array of ANN_Episode
+	# @return [[ANN_Episode]] returns array of ANN_Episode
 	def episodes
 		begin
 			@episodes ||= @ann_anime.xpath("//episode").map do |e|
@@ -101,7 +125,7 @@ class ANN_Anime < ANN
 		end
 	end
 
-	# returns array of ANN_Staff
+	# @return [[ANN_Staff]] returns array of ANN_Staff
 	def staff
 		begin
 			@staff ||= @ann_anime.xpath("//staff").map do |s|
@@ -114,7 +138,7 @@ class ANN_Anime < ANN
 		end
 	end
 
-	# returns array of ANN_Cast
+	# @return [[ANN_Cast]] returns array of ANN_Cast
 	def cast
 		begin
 			@cast ||= @ann_anime.xpath("//cast").map do |s|

data/lib/ann_wrapper/version.rb

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

data/spec/ann_wrapper_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+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.should_not be_nil
+			anime.title.first.should eql "Steins;Gate"
+		end
+	end
+
+	context "an invalid id is provided" do
+		it "should return an ANN_Error" do
+			anime = ANN_Wrapper.instance.fetch_ann_anime(117700)
+			anime.should_not be_nil
+			anime.should be_kind_of(ANN_Error)
+			anime.message.should_not be_nil
+		end
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'ann_wrapper'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

metadata

@@ -1,26 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: ann_wrapper
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
-- getkura
+- shawntoffel
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2014-01-07 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple wrapper for the Anime News Network API
-email: getkura+ann_wrapper@gmail.com
-executables:
-- example
+email:
+- getkura+ann_wrapper@gmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ann_wrapper.gemspec
 - lib/ann_wrapper.rb
 - lib/ann_wrapper/ann_objects.rb
-- bin/example
-homepage: http://rubygems.org/gems/ann_wrapper
+- lib/ann_wrapper/version.rb
+- spec/ann_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -32,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -44,4 +109,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Anime News Network API wrapper
-test_files: []
+test_files:
+- spec/ann_wrapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/bin/example

@@ -1,59 +0,0 @@
-#!/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