game_of_thrones_api 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5bd6e56b8e7824f68bd7ac7986630639c2390cc3
4
+ data.tar.gz: 029801b8def9109f1bebb81596dc88e245baddc3
5
+ SHA512:
6
+ metadata.gz: ba15cf937e98ce214145f2c52addb9214ab89d20548dd5f089a5dc171c59ff85fda04608c7b8d9c1a50b9f8481a131ac1a03d1d221a9a586baf81913d9b02ed6
7
+ data.tar.gz: 0a421f4cb0ffaa6e41ce96e546ae96cd5aaa44b452c5359f3d521a201775d1d05019ebd0be99ca0578e5dcb91461e7cff4e89617aed4e5542273d3020430ed41
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.1.3
4
+ before_install: gem install bundler -v 1.11.2
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in game_of_thrones_api.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Jason Tam
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,69 @@
1
+ # GameOfThronesApi
2
+
3
+ Something for *Game of Thrones* & *A Song of Fire and Ice* fans.
4
+
5
+ API Wrapper using [An API Of Ice And Fire](https://anapioficeandfire.com/)
6
+
7
+ Still In developement. Basic Functionality. Find Books, Characters and Houses.
8
+
9
+ ##### TODO: Better filtering, incorporate pagination, complete API functionality and of course tests.
10
+
11
+ ## Installation
12
+
13
+ Add this line to your application's Gemfile:
14
+
15
+ ```ruby
16
+ gem 'game_of_thrones_api'
17
+ ```
18
+
19
+ And then execute:
20
+
21
+ $ bundle
22
+
23
+ Or install it yourself as:
24
+
25
+ $ gem install game_of_thrones_api
26
+
27
+ ## Usage
28
+
29
+ #### An API Of Ice And Fire is Public, no authentication required
30
+
31
+ #### Retrieve Books
32
+ ```
33
+ GameOfThronesApi.get_books
34
+ ```
35
+
36
+ #### Find a single book
37
+ ```
38
+ GameOfThronesApi.find_book('A Game of Thrones')
39
+ ```
40
+
41
+ #### Retrieve Characters
42
+ ```
43
+ GameOfThronesApi.get_characters
44
+ ```
45
+
46
+ #### Find a character
47
+ ```
48
+ GameOfThronesApi.find_book('Jon Snow')
49
+ ```
50
+
51
+ #### Retrieve House
52
+ ```
53
+ GameOfThronesApi.get_houses
54
+ ```
55
+
56
+ #### Find a single book
57
+ ```
58
+ GameOfThronesApi.find_house('targaryen')
59
+ ```
60
+
61
+ ## Contributing
62
+
63
+ Bug reports and pull requests are welcome on GitHub at https://github.com/jzntam/game_of_thrones_api. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
64
+
65
+
66
+ ## License
67
+
68
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
69
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "game_of_thrones_api"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'game_of_thrones_api/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "game_of_thrones_api"
8
+ spec.version = GameOfThronesApi::VERSION
9
+ spec.authors = ["Jason Tam"]
10
+ spec.email = ["jzntam@github.com"]
11
+
12
+ spec.summary = %q{Game of Thrones}
13
+ spec.description = %q{An API Of Ice And Fire.}
14
+ spec.homepage = "https://github.com/jzntam/game_of_thrones_api"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency 'httparty', '~> 0.13'
23
+ spec.add_development_dependency "bundler", "~> 1.11"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ end
@@ -0,0 +1,47 @@
1
+ require "game_of_thrones_api/version"
2
+ require "httparty"
3
+
4
+ module GameOfThronesApi
5
+ include HTTParty
6
+ format :json
7
+
8
+ BASE_ENDPOINT = "http://anapioficeandfire.com/api"
9
+
10
+ def self.get_books
11
+ get("#{BASE_ENDPOINT}/books").parsed_response
12
+ end
13
+
14
+ def self.find_book(name)
15
+ name = name_query(filter)
16
+ get("#{BASE_ENDPOINT}/books#{name}").parsed_response
17
+ end
18
+
19
+ def self.get_characters
20
+ get("#{BASE_ENDPOINT}/characters").parsed_response
21
+ end
22
+
23
+ def self.find_character(name)
24
+ name = name_query(filter)
25
+ get("#{BASE_ENDPOINT}/characters#{name}").parsed_response
26
+ end
27
+
28
+ def self.get_houses
29
+ filter = name_query(filter) if filter
30
+ get("#{BASE_ENDPOINT}/houses#{filter}").parsed_response
31
+ end
32
+
33
+ def self.find_house(name)
34
+ filter = name_query(filter) if filter
35
+ get("#{BASE_ENDPOINT}/houses#{filter}").parsed_response
36
+ end
37
+
38
+ module_function
39
+
40
+ def name_query(filter)
41
+ "/?name=#{uri_escape(filter)}"
42
+ end
43
+
44
+ def uri_escape(term)
45
+ term.gsub(' ', '%20')
46
+ end
47
+ end
@@ -0,0 +1,3 @@
1
+ module GameOfThronesApi
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,112 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: game_of_thrones_api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jason Tam
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-09-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: httparty
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.13'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: An API Of Ice And Fire.
70
+ email:
71
+ - jzntam@github.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - bin/console
84
+ - bin/setup
85
+ - game_of_thrones_api.gemspec
86
+ - lib/game_of_thrones_api.rb
87
+ - lib/game_of_thrones_api/version.rb
88
+ homepage: https://github.com/jzntam/game_of_thrones_api
89
+ licenses:
90
+ - MIT
91
+ metadata: {}
92
+ post_install_message:
93
+ rdoc_options: []
94
+ require_paths:
95
+ - lib
96
+ required_ruby_version: !ruby/object:Gem::Requirement
97
+ requirements:
98
+ - - ">="
99
+ - !ruby/object:Gem::Version
100
+ version: '0'
101
+ required_rubygems_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - ">="
104
+ - !ruby/object:Gem::Version
105
+ version: '0'
106
+ requirements: []
107
+ rubyforge_project:
108
+ rubygems_version: 2.5.1
109
+ signing_key:
110
+ specification_version: 4
111
+ summary: Game of Thrones
112
+ test_files: []