halo-api 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +2 -0
- data/.ruby-gemset +1 -0
- data/.ruby-version +1 -0
- data/.travis.yml +5 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +60 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/halo-api.gemspec +34 -0
- data/lib/halo-api.rb +33 -0
- data/lib/halo-api/api_response.rb +19 -0
- data/lib/halo-api/client.rb +56 -0
- data/lib/halo-api/configuration.rb +22 -0
- data/lib/halo-api/modules/metadata/halo5/campaign_missions.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/commendations.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/csr_designations.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/enemies.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/flexible_stats.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/game_base_variants.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/game_variant.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/impulses.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/map_variant.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/maps.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/medals.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/playlist.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/requisition.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/requisition_pack.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/seasons.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/skulls.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/spartan_ranks.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/team_colors.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/vehicles.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5/weapons.rb +17 -0
- data/lib/halo-api/modules/metadata/halo5_metadata_client.rb +120 -0
- data/lib/halo-api/modules/profile/halo5/player_appearance.rb +17 -0
- data/lib/halo-api/modules/profile/halo5/player_emblem_image.rb +17 -0
- data/lib/halo-api/modules/profile/halo5/player_spartan_image.rb +17 -0
- data/lib/halo-api/modules/profile/halo5_profile_client.rb +36 -0
- data/lib/halo-api/modules/stats/halo5/company.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/company_commendations.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/leaderboard_player_csr.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/match_events.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/match_result_arena.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/match_result_campaign.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/match_result_custom.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/match_result_warzone.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/pc_match_result_custom.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/pc_player_match_history.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/pc_player_service_records_custom.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_commendations.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_match_history.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_service_records_arena.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_service_records_campaign.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_service_records_custom.rb +17 -0
- data/lib/halo-api/modules/stats/halo5/player_service_records_warzone.rb +17 -0
- data/lib/halo-api/modules/stats/halo5_stats_client.rb +105 -0
- data/lib/halo-api/modules/ugc/halo5/player_game_variant.rb +17 -0
- data/lib/halo-api/modules/ugc/halo5/player_game_variants.rb +17 -0
- data/lib/halo-api/modules/ugc/halo5/player_map_variant.rb +17 -0
- data/lib/halo-api/modules/ugc/halo5/player_map_variants.rb +17 -0
- data/lib/halo-api/modules/ugc/halo5_ugc_client.rb +40 -0
- data/lib/halo-api/version.rb +3 -0
- metadata +227 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: a11b3b39ac1be76eaa4c74a309c0f426a91c4d00
|
4
|
+
data.tar.gz: 213699928a19c61341082683d93fecd7f76298a5
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0bb4d80a077baac394163ce1f077305f1f0d976163cd8dfb3916cce40f6a6100034264c1f77b927defcb639e6fa58bc6bcd7268c2e1817f5b32f11bf4784eb39
|
7
|
+
data.tar.gz: b29f2e0251db8164f04188f8b3247354f73942cef671fadda57b72e22f4725affaab67f4d069dad5826af8d0a9d73e66ff95792859d4eada36724a585377419f
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.ruby-gemset
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
halo-api
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
ruby-2.4.1
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Carlos Ruiz
|
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,60 @@
|
|
1
|
+
# HaloAPI
|
2
|
+
[![GitHub version](https://badge.fury.io/gh/xarlybovi%2Fhalo-api.png)](https://badge.fury.io/gh/xarlybovi%2Fhalo-api)
|
3
|
+
[![Dependency Status](https://gemnasium.com/badges/github.com/xarlybovi/halo-api.svg)](https://gemnasium.com/github.com/xarlybovi/halo-api)
|
4
|
+
[![Code Climate](https://codeclimate.com/github/xarlybovi/halo-api.png)](https://codeclimate.com/github/xarlybovi/halo-api)
|
5
|
+
[![Build Status](https://travis-ci.org/xarlybovi/halo-api.svg?branch=master)](https://travis-ci.org/xarlybovi/halo-api)
|
6
|
+
[![Coverage Status](https://coveralls.io/repos/github/xarlybovi/halo-api/badge.svg?branch=master)](https://coveralls.io/github/xarlybovi/halo-api?branch=master)
|
7
|
+
|
8
|
+
Wrapper for Halo Public API (BETA). https://developer.haloapi.com
|
9
|
+
|
10
|
+
## Installation
|
11
|
+
|
12
|
+
Add this line to your application's Gemfile:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
gem 'halo-api'
|
16
|
+
```
|
17
|
+
|
18
|
+
And then execute:
|
19
|
+
|
20
|
+
$ bundle
|
21
|
+
|
22
|
+
Or install it yourself as:
|
23
|
+
|
24
|
+
$ gem install halo-api
|
25
|
+
|
26
|
+
## Usage
|
27
|
+
|
28
|
+
Basic example:
|
29
|
+
````ruby
|
30
|
+
Halo.configure do |config|
|
31
|
+
config.api_key = ENV['HALO_API_KEY']
|
32
|
+
config.region = ENV['HALO_REGION']
|
33
|
+
end
|
34
|
+
````
|
35
|
+
|
36
|
+
````ruby
|
37
|
+
metadata = Halo.h5_metadata
|
38
|
+
|
39
|
+
missions = metadata.campaign_missions.all
|
40
|
+
|
41
|
+
````
|
42
|
+
|
43
|
+
## TODO
|
44
|
+
|
45
|
+
- [x] Halo 5 endpoints
|
46
|
+
- [ ] Halo Wars 2 endpoints
|
47
|
+
|
48
|
+
## Contributing
|
49
|
+
|
50
|
+
Bug reports and pull requests are welcome!
|
51
|
+
|
52
|
+
1. Fork it
|
53
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
54
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
55
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
56
|
+
5. Create new Pull Request
|
57
|
+
|
58
|
+
## License
|
59
|
+
|
60
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "halo-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(__FILE__)
|
data/bin/setup
ADDED
data/halo-api.gemspec
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
|
3
|
+
lib = File.expand_path('../lib', __FILE__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require 'halo-api/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = 'halo-api'
|
9
|
+
spec.version = Halo::VERSION
|
10
|
+
spec.authors = ['Carlos Ruiz']
|
11
|
+
spec.email = ['xarlybovi@gmail.com']
|
12
|
+
|
13
|
+
spec.summary = 'Wrapper for Halo Public API.'
|
14
|
+
spec.description = 'Wrapper for Halo Public API (BETA). https://developer.haloapi.com'
|
15
|
+
spec.homepage = 'https://github.com/xarlybovi/halo-api.git'
|
16
|
+
spec.license = 'MIT'
|
17
|
+
|
18
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
19
|
+
f.match(%r{^(test|spec|features)/})
|
20
|
+
end
|
21
|
+
spec.bindir = 'exe'
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ['lib']
|
24
|
+
|
25
|
+
spec.add_runtime_dependency 'httparty', '~> 0.15.6'
|
26
|
+
|
27
|
+
spec.add_development_dependency 'bundler', '~> 1.15'
|
28
|
+
spec.add_development_dependency 'rake', '~> 12.0'
|
29
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
30
|
+
spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.1'
|
31
|
+
spec.add_development_dependency 'rubocop', '~> 0.49.1'
|
32
|
+
spec.add_development_dependency 'coveralls', '~> 0.8.21'
|
33
|
+
spec.add_development_dependency 'pry', '~> 0.10.3'
|
34
|
+
end
|
data/lib/halo-api.rb
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
require 'halo-api/version'
|
2
|
+
require 'halo-api/configuration'
|
3
|
+
require 'halo-api/client'
|
4
|
+
require 'halo-api/api_response'
|
5
|
+
|
6
|
+
require 'halo-api/modules/metadata/halo5_metadata_client'
|
7
|
+
require 'halo-api/modules/profile/halo5_profile_client'
|
8
|
+
require 'halo-api/modules/stats/halo5_stats_client'
|
9
|
+
require 'halo-api/modules/ugc/halo5_ugc_client'
|
10
|
+
|
11
|
+
|
12
|
+
module Halo
|
13
|
+
extend Configuration
|
14
|
+
|
15
|
+
class << self
|
16
|
+
def h5_metadata(options = {})
|
17
|
+
Halo::Metadata::Halo5MetadataClient.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
def h5_profile(options = {})
|
21
|
+
Halo::Profile::Halo5ProfileClient.new(options)
|
22
|
+
end
|
23
|
+
|
24
|
+
def h5_stats(options = {})
|
25
|
+
Halo::Stats::Halo5StatsClient.new(options)
|
26
|
+
end
|
27
|
+
|
28
|
+
def h5_ugc(options = {})
|
29
|
+
Halo::Ugc::Halo5UgcClient.new(options)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module Halo
|
2
|
+
class APIResponse
|
3
|
+
|
4
|
+
attr_accessor :data
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
@data = []
|
8
|
+
@client = options[:client]
|
9
|
+
@endpoint = options[:client].endpoint
|
10
|
+
end
|
11
|
+
|
12
|
+
def get_data(path, options)
|
13
|
+
return if @client.nil?
|
14
|
+
response = @client.get(path, options)
|
15
|
+
@data = response.parsed_response
|
16
|
+
end
|
17
|
+
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
require 'halo-api/version'
|
2
|
+
require 'halo-api/api_response'
|
3
|
+
require 'httparty'
|
4
|
+
|
5
|
+
|
6
|
+
module Halo
|
7
|
+
class Client
|
8
|
+
include HTTParty
|
9
|
+
|
10
|
+
attr_accessor(*Configuration::OPTIONS)
|
11
|
+
|
12
|
+
def initialize(options = {})
|
13
|
+
@api_key = options[:api_key]
|
14
|
+
@region = options[:region]
|
15
|
+
@endpoint = options[:endpoint]
|
16
|
+
|
17
|
+
options = Halo.options.merge(options)
|
18
|
+
|
19
|
+
Halo::Configuration::OPTIONS.each do |key|
|
20
|
+
send("#{key}=", options[key])
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
def endpoint
|
25
|
+
raise 'Invalid API Endpoint' if @endpoint.nil?
|
26
|
+
@endpoint
|
27
|
+
end
|
28
|
+
|
29
|
+
def get(path, params = {})
|
30
|
+
make_request :get, path, params
|
31
|
+
end
|
32
|
+
|
33
|
+
def make_request(verb, path, params = {})
|
34
|
+
options = {}
|
35
|
+
headers = {
|
36
|
+
'Ocp-Apim-Subscription-Key': @api_key,
|
37
|
+
'Accept-Language': @region
|
38
|
+
}
|
39
|
+
|
40
|
+
url = "https://www.haloapi.com#{path}"
|
41
|
+
|
42
|
+
options[:headers] = headers unless headers.empty?
|
43
|
+
options[:query] = params unless params.empty?
|
44
|
+
|
45
|
+
self.class.send(verb, url, options)
|
46
|
+
end
|
47
|
+
|
48
|
+
|
49
|
+
private
|
50
|
+
|
51
|
+
def merge_options_and_return_obj(options, obj)
|
52
|
+
opts = options.merge(client: self)
|
53
|
+
obj.new(opts)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
module Halo
|
2
|
+
module Configuration
|
3
|
+
|
4
|
+
OPTIONS = %i[api_key region].freeze
|
5
|
+
|
6
|
+
DEFAULT_API_KEY = nil
|
7
|
+
DEFAULT_REGION = :en
|
8
|
+
|
9
|
+
attr_accessor(*OPTIONS)
|
10
|
+
|
11
|
+
def configure
|
12
|
+
yield self
|
13
|
+
end
|
14
|
+
|
15
|
+
def options
|
16
|
+
OPTIONS.inject({}) do |option, key|
|
17
|
+
option.merge!(key => send(key))
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Halo
|
2
|
+
module Metadata
|
3
|
+
module Halo5
|
4
|
+
class CampaignMissions < Halo::APIResponse
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
super(options)
|
8
|
+
end
|
9
|
+
|
10
|
+
def all(options = {})
|
11
|
+
get_data("#{@endpoint}/campaign-missions", options)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Halo
|
2
|
+
module Metadata
|
3
|
+
module Halo5
|
4
|
+
class Commendations < Halo::APIResponse
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
super(options)
|
8
|
+
end
|
9
|
+
|
10
|
+
def all(options = {})
|
11
|
+
get_data("#{@endpoint}/commendations", options)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Halo
|
2
|
+
module Metadata
|
3
|
+
module Halo5
|
4
|
+
class CsrDesignations < Halo::APIResponse
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
super(options)
|
8
|
+
end
|
9
|
+
|
10
|
+
def all(options = {})
|
11
|
+
get_data("#{@endpoint}/csr-designations", options)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Halo
|
2
|
+
module Metadata
|
3
|
+
module Halo5
|
4
|
+
class FlexibleStats < Halo::APIResponse
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
super(options)
|
8
|
+
end
|
9
|
+
|
10
|
+
def all(options = {})
|
11
|
+
get_data("#{@endpoint}/flexible-stats", options)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
module Halo
|
2
|
+
module Metadata
|
3
|
+
module Halo5
|
4
|
+
class GameBaseVariants < Halo::APIResponse
|
5
|
+
|
6
|
+
def initialize(options = {})
|
7
|
+
super(options)
|
8
|
+
end
|
9
|
+
|
10
|
+
def all(options = {})
|
11
|
+
get_data("#{@endpoint}/game-base-variants", options)
|
12
|
+
end
|
13
|
+
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|