ice_and_fire_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f77fb7efd2311b54522eb2b3b6068e980ad0a840
+  data.tar.gz: e5dd492666eb7d2c024af3cf1ed1d9950d5fa676
+SHA512:
+  metadata.gz: 55926bdf3919d6155fcecb8dc164edebe7619d973d6b99917e57b089f715af5fa3d6168a710fa4812b6becbebd952673ac5c7f2cdd829aedc751260744d59dc7
+  data.tar.gz: 3fd67214fcacb66db082277ae3258f04712f8775eecff5e2e44bad966d21ea4b2089b1b3ab11e4f26dc13e67a0f40db3cfb8ffe13e920095b55ada501d74fdf6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Max: 20
+
+AbcSize:
+  Max: 25
+
+LineLength:
+  Max: 90
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dan Belling
+
+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,86 @@
+# IceAndFireApi
+
+This gem provides an interface for the [Ice And Fire API](https://anapioficeandfire.com/). It was motivated by the current [lack of support](https://anapioficeandfire.com/Documentation#library-elixir) for a ruby library. More response fields and schema information for `House`, `Character`, and `Book` resources is available through the [documentation](https://anapioficeandfire.com/Documentation#root).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ice_and_fire_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ice_and_fire_api
+
+## Usage
+
+The [Ice and Fire API](https://anapioficeandfire.com/) contains endpoints for the following resources:
+
+  * [`Root`](https://anapioficeandfire.com/Documentation#root)
+
+    **Fetch information about all resources available in the API.**
+
+    ```ruby
+      IceAndFireApi::Root.fetch
+    ```
+
+  * [`Books`](https://anapioficeandfire.com/Documentation#books)
+
+    **Find a book resource from its associated ID.**
+
+    ```ruby
+      IceAndFireApi::Book.find(5)
+    ```
+
+    or
+
+    **Find a book resource through a name filter.**
+
+    ```ruby
+      IceAndFireApi::Book.find_by_name('A Game of Thrones')
+    ```
+  * [`Characters`](https://anapioficeandfire.com/Documentation#characters)
+
+    **Find a character resource from its associated ID.**
+
+    ```ruby
+      IceAndFireApi::Character.find(88)
+    ```
+
+    or
+
+    **Find a character resource through a name filter.**
+
+    ```ruby
+      IceAndFireApi::Character.find('Eddard Stark')
+    ```
+
+  * [`Houses`](https://anapioficeandfire.com/Documentation#houses)
+
+    **Find a house resource from its associated ID.**
+
+    ```ruby
+      IceAndFireApi::House.find(42)
+    ```
+
+    or
+
+    **Find a house resource through its associated ID.**
+
+    ```ruby
+      IceAndFireApi::House.find('House Algood')
+    ```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dbelling/ice_and_fire_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ice_and_fire_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ice_and_fire_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ice_and_fire_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ice_and_fire_api'
+  spec.version       = IceAndFireApi::VERSION
+  spec.authors       = ['Dan Belling']
+  spec.email         = ['danhbelling@gmail.com']
+
+  spec.summary       = "All the data from the universe \
+                        of Ice And Fire you've ever wanted"
+  spec.description   = 'A wrapper gem for http://www.anapioficeandfire.com/api'
+  spec.homepage      = 'https://github.com/dbelling/ice_and_fire_api'
+  spec.license       = 'MIT'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~>10.0'
+  spec.add_development_dependency 'rspec', '~>3.0.0', '>=3.0.0'
+  spec.add_development_dependency 'vcr', '~>3.0.0', '>=3.0.0'
+
+  spec.add_dependency 'faraday', '~>0.9.2'
+  spec.add_dependency 'json', '~>1.8.2', '>=1.8.2'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = 'bin'
+  spec.executables   = `git ls-files -- bin/*`
+                       .split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/ice_and_fire_api/book.rb

@@ -0,0 +1,38 @@
+module IceAndFireApi
+  class Book
+    attr_reader :url, :name, :isbn, :authors,
+                :numberOfPages, :publisher, :country,
+                :mediaType, :released, :characters, :povCharacters
+
+    def initialize(attributes)
+      @url = attributes['url']
+      @name = attributes['name']
+      @isbn = attributes['isbn']
+      @authors = attributes['authors']
+      @number_of_pages = attributes['numberOfPages']
+      @publisher = attributes['publisher']
+      @country = attributes['country']
+      @media_type = attributes['mediaType']
+      @released = attributes['released']
+      @characters = attributes['characters']
+      @pov_characters = attributes['povCharacters']
+    end
+
+    def self.find(id)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/books/#{id}")
+      attributes = JSON.parse(response.body)
+      new(attributes)
+    end
+
+    def self.find_by_name(name)
+      name_query = URI.encode_www_form_component(name.to_s)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/books?name=#{name_query}")
+      attributes_response = JSON.parse(response.body)
+      attributes_array = []
+      attributes_response.each do |attributes|
+        attributes_array << new(attributes)
+      end
+      attributes_array
+    end
+  end
+end

data/lib/ice_and_fire_api/character.rb

@@ -0,0 +1,44 @@
+module IceAndFireApi
+  class Character
+    attr_reader :url, :name, :gender, :culture,
+                :born, :died, :titles, :aliases,
+                :father, :mother, :spouse, :allegiances,
+                :books, :pov_books, :tv_series, :played_by
+
+    def initialize(attributes)
+      @url = attributes['url']
+      @name = attributes['name']
+      @gender = attributes['gender']
+      @culture = attributes['culture']
+      @born = attributes['born']
+      @died = attributes['died']
+      @titles = attributes['titles']
+      @aliases = attributes['aliases']
+      @father = attributes['father']
+      @mother = attributes['mother']
+      @spouse = attributes['spouse']
+      @allegiances = attributes['allegiances']
+      @books = attributes['books']
+      @pov_books = attributes['povBooks']
+      @tv_series = attributes['tvSeries']
+      @played_by = attributes['playedBy']
+    end
+
+    def self.find(id)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/characters/#{id}")
+      attributes = JSON.parse(response.body)
+      new(attributes)
+    end
+
+    def self.find_by_name(name)
+      name_query = URI.encode_www_form_component(name.to_s)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/characters?name=#{name_query}")
+      attributes_response = JSON.parse(response.body)
+      attributes_array = []
+      attributes_response.each do |attributes|
+        attributes_array << new(attributes)
+      end
+      attributes_array
+    end
+  end
+end

data/lib/ice_and_fire_api/house.rb

@@ -0,0 +1,45 @@
+module IceAndFireApi
+  class House
+    attr_reader :url, :name, :region, :coat_of_arms,
+                :words, :titles, :seats, :current_lord,
+                :heir, :overlord, :founded, :founder,
+                :died_out, :ancestral_weapons, :cadet_branches,
+                :sworn_members
+
+    def initialize(attributes)
+      @url = attributes['url']
+      @name = attributes['name']
+      @region = attributes['region']
+      @coat_of_arms = attributes['coatOfArms']
+      @words = attributes['words']
+      @titles = attributes['titles']
+      @seats = attributes['seats']
+      @current_lord = attributes['currentLord']
+      @heir = attributes['heir']
+      @overlord = attributes['overlord']
+      @founded = attributes['founded']
+      @founder = attributes['founder']
+      @died_out = attributes['diedOut']
+      @ancestral_weapons = attributes['ancestralWeapons']
+      @cadet_branches = attributes['cadetBranches']
+      @sworn_members = attributes['swornMembers']
+    end
+
+    def self.find(id)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/houses/#{id}")
+      attributes = JSON.parse(response.body)
+      new(attributes)
+    end
+
+    def self.find_by_name(name)
+      name_query = URI.encode_www_form_component(name.to_s)
+      response = Faraday.get("#{IceAndFireApi::API_URL}/houses?name=#{name_query}")
+      attributes_response = JSON.parse(response.body)
+      attributes_array = []
+      attributes_response.each do |attributes|
+        attributes_array << new(attributes)
+      end
+      attributes_array
+    end
+  end
+end

data/lib/ice_and_fire_api/root.rb

@@ -0,0 +1,17 @@
+module IceAndFireApi
+  class Root
+    attr_reader :books, :characters, :houses
+
+    def initialize(attributes)
+      @books = attributes['books']
+      @characters = attributes['characters']
+      @houses = attributes['houses']
+    end
+
+    def self.fetch
+      response = Faraday.get(IceAndFireApi::API_URL.to_s)
+      attributes = JSON.parse(response.body)
+      new(attributes)
+    end
+  end
+end

data/lib/ice_and_fire_api/version.rb

@@ -0,0 +1,3 @@
+module IceAndFireApi
+  VERSION = '1.0.0'.freeze
+end

data/lib/ice_and_fire_api.rb

@@ -0,0 +1,12 @@
+require 'ice_and_fire_api/version'
+require 'ice_and_fire_api/book'
+require 'ice_and_fire_api/character'
+require 'ice_and_fire_api/house'
+require 'ice_and_fire_api/root'
+require 'json'
+require 'faraday'
+require 'uri'
+
+module IceAndFireApi
+  API_URL = 'http://www.anapioficeandfire.com/api'.freeze
+end