game_of_thrones_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a078977179fabc795d32224b634241e1626bdf99
-  data.tar.gz: 9fb064b4100378430cf6bb61ec2a43d68bbce462
+  metadata.gz: a183c141181b06da9971102948278966afc87107
+  data.tar.gz: f71d6fb00c936bf1384c9dc9cf4f348b6107d3d1
 SHA512:
-  metadata.gz: 5002c3711cba6322a1fa72f19322b0a89c8c42cb85dcf430eb830c7e251f1a55328ca50e01f7b7c9ae3b88d1648c59112e202e3f957ec274c4283991b0b5701f
-  data.tar.gz: b38bfb700b90b3ac0f6ee66b78e708ec534a87ce624f76d485943100e336598f7828f22b4d6c82f93c2f45abf1f7ce730988c86e1bc9d82e8da88949c3d25451
+  metadata.gz: 7009e890f25fc8619098ede5ad2212d541680db6d9d38bd33f7f25a75fca3d7f9942772e1a50f0da4fb82d1c916cf46adcfbbb14aa53b8dd92b2619d08be3ac6
+  data.tar.gz: b7e9aee365b8195b9d60e563a62a15e2d1d6d074a7ff3f3e512fcf2e7c95132d836838d953bbe956baf5fa58efee03affffe4e39d60c0a96e329221fa6d5e6ab

data/README.md

@@ -1,12 +1,12 @@
 # GameOfThronesApi
 
-Something for *Game of Thrones* & *A Song of Fire and Ice* fans.
+Something for **Game of Thrones** & **A Song of Ice and Fire** fans.
 
-API Wrapper using [An API Of Ice And Fire](https://anapioficeandfire.com/)
+A Ruby API Wrapper using [An API Of Ice And Fire](https://anapioficeandfire.com/). All credit goes to **Joakim Skoog** the creator of the API.
 
 Still In developement. Basic Functionality. Find Books, Characters and Houses.
 
-##### TODO: Better filtering, fuzzy find for houses, complete API functionality and of course tests.
+##### TODO: Implement better filtering, complete API functionality and of course tests.
 
 ## Installation
 
@@ -26,36 +26,44 @@ Or install it yourself as:
 
 ## Usage
 
-#### An API Of Ice And Fire is Public, no authentication required
+#### [An API Of Ice And Fire](https://anapioficeandfire.com/) is public, no authentication required
 
-#### Retrieve Books
-```
+#### Retrieve all Books
+```ruby
 GameOfThronesApi.get_books
 ```
 
-#### Find a single book
-```
+#### Find a Book by Title or Partial Title.
+```ruby
 GameOfThronesApi.find_book('A Dance with Dragons')
-```
 
-#### Retrieve Characters
+or
+
+GameOfThronesApi.find_book('dragon')
 ```
+
+#### Retrieve all Characters
+```ruby
 GameOfThronesApi.get_characters
 ```
 
-#### Find a character
-```
-GameOfThronesApi.find_book('Jon Snow')
-```
+#### Find a Character by Name or Partial Name
+```ruby
+GameOfThronesApi.find_character('Jon Snow')
+
+or
 
-#### Retrieve House
+GameOfThronesApi.find_character('baratheon')
 ```
+
+#### Retrieve all Houses
+```ruby
 GameOfThronesApi.get_houses
 ```
 
-#### Find a specific House, must be complete house name. Will implement a fuzzy search in the future.
-```
-GameOfThronesApi.find_house("House Targaryen of King's Landing")
+#### Find a House by Name
+```ruby
+GameOfThronesApi.find_house('targaryen')
 ```
 
 ## Contributing

data/lib/game_of_thrones_api.rb

@@ -1,46 +1,70 @@
-require "game_of_thrones_api/version"
-require "httparty"
+require 'game_of_thrones_api/version'
+require 'httparty'
+
+# There are 3 'get' methods, each method returns an Array of all the records
+# for that specific category.
+#
+# Currently there are 12 Books, 2134 Characters and 444 Family Houses.
+#
+# Each 'get' method is memoized for performance and to reduce API calls.
+#
+# Each 'find' method takes a 'term' and searches the name column of that
+# category for any matches.
 
 module GameOfThronesApi
   include HTTParty
   format :json
 
-  BASE_ENDPOINT = "http://anapioficeandfire.com/api"
+  BASE_ENDPOINT  = "http://anapioficeandfire.com/api".freeze
+
+  WORD_PARTICLES = %w(and or the over to the a but of for with).freeze
 
   def self.get_books
-    response    = get("#{BASE_ENDPOINT}/books?page=1&pageSize=50")
-    total_pages = get_page_count(response)
+    @get_books ||= begin
+      response    = get("#{BASE_ENDPOINT}/books?page=1&pageSize=50")
+      total_pages = get_page_count(response)
 
-    get_all_records('books', response, total_pages)
+      get_all_records('books', response, total_pages)
+    end
   end
 
   def self.find_book(name)
-    name = name_query(name)
-    get("#{BASE_ENDPOINT}/books#{name}").parsed_response
+    books ||= GameOfThronesApi.get_books
+    query   = titleize_query(name)
+
+    books.select { |book| book['name'].include?(query) }
   end
 
   def self.get_characters
-    response    = get("#{BASE_ENDPOINT}/characters?page=1&pageSize=50")
-    total_pages = get_page_count(response)
+    @get_characters ||= begin
+      response    = get("#{BASE_ENDPOINT}/characters?page=1&pageSize=50")
+      total_pages = get_page_count(response)
 
-    get_all_records('characters', response, total_pages)
+      get_all_records('characters', response, total_pages)
+    end
   end
 
   def self.find_character(name)
-    name = name_query(name)
-    get("#{BASE_ENDPOINT}/characters#{name}").parsed_response
+    characters ||= GameOfThronesApi.get_characters
+    query        = titleize_query(name)
+
+    characters.select { |character| character['name'].include?(query) }
   end
 
   def self.get_houses
-    response    = get("#{BASE_ENDPOINT}/houses?page=1&pageSize=50")
-    total_pages = get_page_count(response)
+    @get_houses ||= begin
+      response    = get("#{BASE_ENDPOINT}/houses?page=1&pageSize=50")
+      total_pages = get_page_count(response)
 
-    get_all_records('houses', response, total_pages)
+      get_all_records('houses', response, total_pages)
+    end
   end
 
   def self.find_house(name)
-    name = name_query(name)
-    get("#{BASE_ENDPOINT}/houses#{name}").parsed_response
+    houses ||= GameOfThronesApi.get_houses
+    query    = titleize_query(name)
+
+    houses.select { |house| house['name'].include?(query) }
   end
 
   module_function
@@ -53,11 +77,30 @@ module GameOfThronesApi
     term.gsub(' ', '%20')
   end
 
+  # The pagination information is in the Headers
+  # We retrieve the links from the Headers using a regex
+  # There will always be 3 links, the last link, redirects to the last page.
+  # We take the page number from the last link as our page count.
   def get_page_count(response)
     page_links = response.headers['link'].scan(/<(\S+)>/).flatten
     /\?page\=(\d+)\&/.match(page_links.last)[1].to_i
   end
 
+  def titleize_query(query)
+    split_words =
+      query.split.map.with_index do |word, index|
+        if WORD_PARTICLES.exclude?(word) || index.zero?
+          word.capitalize
+        else
+          word
+        end
+      end
+
+    split_words.join(' ')
+  end
+
+  # The API results are paginated, just looping through the pages to collect
+  # all the records associated with the category.
   def get_all_records(category, response, total_pages, page = 1)
     characters  = response.parsed_response
 

data/lib/game_of_thrones_api/version.rb

@@ -1,3 +1,3 @@
 module GameOfThronesApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: game_of_thrones_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Tam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty