halo-api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 160879805c22e91b7548e66fa7664c1967bfe792
-  data.tar.gz: 113d6084e6798d33bbac99bb238a4b18c9a38ca5
+  metadata.gz: c1ce1d46c92a1d8fc7cb8efcee4f2f4a71733c5d
+  data.tar.gz: 8e8d22b2cf42e899c244c127ff58e109140f42c7
 SHA512:
-  metadata.gz: fcf6ec4ae19b77839ff132ffe57ace8d26ab4b534615b501a6da151965db9aad5ddfa0e6b63a14a892d8a77a4f7ea4fb8d2c965b2e1edc2b0b723c57a9d9963f
-  data.tar.gz: cea7f4dff7ece594b1616c0d23ecc9c6b900a5250ea79318913e9f4f2cd2f473031bc8a20cfb6c35cef9b92a0dc1f60ea8e9a00925153d92dcbae9f479f37a8f
+  metadata.gz: '05837cea2dc1a99ed2d2dd9d0687faf6d4743c9ae52e80bf68faf839c59c18e87c3d2b6f34556a1875e914aeb6c698e6245628dc34334c5bf8068e6b30b8c629'
+  data.tar.gz: 7a5f26195c8676ef75a888c05623f10cf2d66ac23fd6d8e33d25f4f08f624058bc20e406e64a4f4582c03a8b9a5096119330a740af104176b1e156f90fac1991

data/README.md

@@ -25,7 +25,7 @@ Or install it yourself as:
 
 ## Usage
 
-Basic example:
+Basic examples:
 ````ruby
 Halo.configure do |config|
   config.api_key = ENV['HALO_API_KEY']
@@ -34,9 +34,12 @@ end
 ````
 
 ````ruby
-metadata = Halo.h5_metadata
+halo5_client = Halo.halo5
+halo_wars2_client = Halo.halo_wars2
 
-missions = metadata.campaign_missions.all
+h5_missions = halo5_client.metadata.campaign_missions
+h5_player_appearance = halo5_client.profile(player: 'xarly bovi').player_appearance
+h2w_campaign_levels = halo_wars2_client.metadata.campaign_levels
 
 ````
 

data/lib/halo-api.rb

@@ -3,47 +3,22 @@ require 'halo-api/configuration'
 require 'halo-api/client'
 require 'halo-api/api_response'
 
-require 'halo-api/clients/halo5_metadata_client'
-require 'halo-api/clients/halo_wars2_metadata_client'
-require 'halo-api/clients/halo5_profile_client'
-require 'halo-api/clients/halo5_stats_client'
-require 'halo-api/clients/halo_wars2_stats_client'
-require 'halo-api/clients/halo5_ugc_client'
+require 'halo-api/clients/halo5_client'
+require 'halo-api/clients/halo_wars2_client'
 
 
 module Halo
   extend Configuration
 
   class << self
-    # Halo 5 Metadata Client
-    def h5_metadata(options = {})
-      Halo::Clients::Halo5MetadataClient.new(options)
-    end
-
-    # Halo Wars 2 Metadata Client
-    def hw2_metadata(options = {})
-      Halo::Clients::HaloWars2MetadataClient.new(options)
-    end
 
-    # Halo 5 Profile Client
-    def h5_profile(options = {})
-      Halo::Clients::Halo5ProfileClient.new(options)
+    def halo5(options = {})
+      Halo::Clients::Halo5Client.new(options)
     end
 
-    # Halo 5 Stats Client
-    def h5_stats(options = {})
-      Halo::Clients::Halo5StatsClient.new(options)
+    def halo_wars2(options = {})
+      Halo::Clients::HaloWars2Client.new(options)
     end
 
-    # Halo Wars 2 Stats Client
-    def hw2_stats(options = {})
-      Halo::Clients::HaloWars2StatsClient.new(options)
-    end
-
-    # Halo 5 UGC Client
-    def h5_ugc(options = {})
-      Halo::Clients::Halo5UgcClient.new(options)
-    end
   end
-
 end

data/lib/halo-api/clients/halo5_client.rb

@@ -0,0 +1,37 @@
+require 'halo-api/client'
+
+require 'halo-api/modules/halo5/metadata'
+require 'halo-api/modules/halo5/profile'
+require 'halo-api/modules/halo5/stats'
+require 'halo-api/modules/halo5/ugc'
+
+
+module Halo
+  module Clients
+
+    # Halo 5 Client
+    class Halo5Client < Client
+
+      def initialize(options = {})
+        super(options)
+      end
+
+      def metadata(options = {})
+        merge_options_and_return_obj(options, Halo::Halo5::Metadata)
+      end
+
+      def profile(options = {})
+        merge_options_and_return_obj(options, Halo::Halo5::Profile)
+      end
+
+      def stats(options = {})
+        merge_options_and_return_obj(options, Halo::Halo5::Stats)
+      end
+
+      def ugc(options = {})
+        merge_options_and_return_obj(options, Halo::Halo5::Ugc)
+      end
+
+    end
+  end
+end

data/lib/halo-api/clients/halo_wars2_client.rb

@@ -0,0 +1,27 @@
+require 'halo-api/client'
+
+require 'halo-api/modules/halo_wars2/metadata'
+require 'halo-api/modules/halo_wars2/stats'
+
+
+module Halo
+  module Clients
+
+    # Halo Wars 2 Client
+    class HaloWars2Client < Client
+
+      def initialize(options = {})
+        super(options)
+      end
+
+      def metadata(options = {})
+        merge_options_and_return_obj(options, Halo::HaloWars2::Metadata)
+      end
+
+      def stats(options = {})
+        merge_options_and_return_obj(options, Halo::HaloWars2::Stats)
+      end
+
+    end
+  end
+end

data/lib/halo-api/modules/halo5/metadata.rb

@@ -0,0 +1,93 @@
+module Halo
+  module Halo5
+    class Metadata < APIResponse
+
+      def initialize(options = {})
+        @endpoint = '/metadata/h5/metadata'
+
+        super(options)
+      end
+
+      def campaign_missions(options = {})
+        get_data("#{@endpoint}/campaign-missions", options)
+      end
+
+      def commendations(options = {})
+        get_data("#{@endpoint}/commendations", options)
+      end
+
+      def csr_designations(options = {})
+        get_data("#{@endpoint}/csr-designations", options)
+      end
+
+      def enemies(options = {})
+        get_data("#{@endpoint}/enemies", options)
+      end
+
+      def flexible_stats(options = {})
+        get_data("#{@endpoint}/flexible-stats", options)
+      end
+
+      def game_base_variants(options = {})
+        get_data("#{@endpoint}/game-base-variants", options)
+      end
+
+      def game_variant(id, options = {})
+        get_data("#{@endpoint}/game-variants/#{id}", options)
+      end
+
+      def impulses(options = {})
+        get_data("#{@endpoint}/impulses", options)
+      end
+
+      def map_variant(id, options = {})
+        get_data("#{@endpoint}/map-variants/#{id}", options)
+      end
+
+      def maps(options = {})
+        get_data("#{@endpoint}/maps", options)
+      end
+
+      def medals(options = {})
+        get_data("#{@endpoint}/medals", options)
+      end
+
+      def playlist(options = {})
+        get_data("#{@endpoint}/playlist", options)
+      end
+
+      def requisition(id, options = {})
+        get_data("#{@endpoint}/requisitions/#{id}", options)
+      end
+
+      def requisition_pack(options = {})
+        get_data("#{@endpoint}/requisition-packs/#{id}", options)
+      end
+
+      def seasons(options = {})
+        get_data("#{@endpoint}/seasons", options)
+      end
+
+      def skulls(options = {})
+        get_data("#{@endpoint}/skulls", options)
+      end
+
+      def spartan_ranks(options = {})
+        get_data("#{@endpoint}/spartan-ranks", options)
+      end
+
+      def team_colors(options = {})
+        get_data("#{@endpoint}/team-colors", options)
+      end
+
+      def vehicles(options = {})
+        get_data("#{@endpoint}/vehicles", options)
+      end
+
+      def weapons(options = {})
+        get_data("#{@endpoint}/weapons", options)
+      end
+
+    end
+  end
+end

data/lib/halo-api/modules/halo5/profile.rb

@@ -0,0 +1,25 @@
+module Halo
+  module Halo5
+    class Profile < APIResponse
+
+      def initialize(options = {})
+        @player = options.delete(:player)
+        @endpoint = "/profile/h5/profiles/#{@player}"
+
+        super(options)
+      end
+
+      def player_appearance(options = {})
+        get_data("#{@endpoint}/appearance", options)
+      end
+
+      def player_emblem_image(options = {})
+        get_data("#{@endpoint}/emblem", options)
+      end
+
+      def player_spartan_image(options = {})
+        get_data("#{@endpoint}/spartan", options)
+      end
+    end
+  end
+end

data/lib/halo-api/modules/halo5/stats.rb

@@ -0,0 +1,80 @@
+module Halo
+  module Halo5
+    class Stats < APIResponse
+
+      def initialize(options = {})
+        @endpoint = '/stats/h5'
+        super(options)
+      end
+
+      def company(company_id, options = {})
+        get_data("#{@endpoint}/companies/#{company_id}", options)
+      end
+
+      def company_commendations(company_id, options = {})
+        get_data("#{@endpoint}/companies/#{company_id}/commendations", options)
+      end
+
+      def leaderboard_player_csr(season_id, playlist_id, options = {})
+        get_data("#{@endpoint}player-leaderboards/csr/#{season_id}/#{playlist_id}", options)
+      end
+
+      def match_events(match_id, options = {})
+        get_data("#{@endpoint}/matches/#{match_id}/events", options)
+      end
+
+      def match_result_arena(match_id, options = {})
+        get_data("#{@endpoint}/arena/matches/#{match_id}", options)
+      end
+
+      def match_result_campaign(match_id, options = {})
+        get_data("#{@endpoint}/campaign/matches/#{match_id}", options)
+      end
+
+      def match_result_custom(match_id, options = {})
+        get_data("#{@endpoint}/custom/matches/#{match_id}", options)
+      end
+
+      def match_result_warzone(match_id, options = {})
+        get_data("#{@endpoint}/warzone/matches/#{match_id}", options)
+      end
+
+      def player_commendations(player, options = {})
+        get_data("#{@endpoint}/players/#{player}/commendations", options)
+      end
+
+      def player_match_history(player, options = {})
+        get_data("#{@endpoint}/players/#{player}/matches", options)
+      end
+
+      def psr_arena(players, options = {})
+        get_data("#{@endpoint}/servicerecords/arena", options.merge(players: players))
+      end
+
+      def psr_campaign(players, options = {})
+        get_data("#{@endpoint}/servicerecords/campaign", options.merge(players: players))
+      end
+
+      def psr_custom(players, options = {})
+        get_data("#{@endpoint}/servicerecords/custom", options.merge(players: players))
+      end
+
+      def psr_warzone(players, options = {})
+        get_data("#{@endpoint}/servicerecords/warzone", options.merge(players: players))
+      end
+
+      def pc_match_result_custom(match_id, options = {})
+        get_data("#{@endpoint}pc/custom/matches/#{match_id}", options)
+      end
+
+      def pc_player_match_history(player, options = {})
+        get_data("#{@endpoint}pc/players/#{player}/matches", options)
+      end
+
+      def pc_psr_custom(players, options = {})
+        get_data("#{@endpoint}pc/servicerecords/custom", options.merge(players: players))
+      end
+
+    end
+  end
+end

data/lib/halo-api/modules/halo5/ugc.rb

@@ -0,0 +1,30 @@
+module Halo
+  module Halo5
+    class Ugc < APIResponse
+
+      def initialize(options = {})
+        @player = options.delete(:player)
+        @endpoint = "/ugc/h5/players/#{@player}"
+
+        super(options)
+      end
+
+      def player_game_variant(variant, options = {})
+        get_data("#{@endpoint}gamevariants/#{variant}", options)
+      end
+
+      def player_game_variants(options = {})
+        get_data("#{@endpoint}/gamevariants", options)
+      end
+
+      def player_map_variant(variant, options = {})
+        get_data("#{@endpoint}/mapvariants/#{variant}", options)
+      end
+
+      def player_map_variants(options = {})
+        get_data("#{@endpoint}/mapvariants", options)
+      end
+
+    end
+  end
+end

data/lib/halo-api/modules/halo_wars2/metadata.rb

@@ -0,0 +1,77 @@
+module Halo
+  module HaloWars2
+    class Metadata < APIResponse
+
+      def initialize(options = {})
+        @endpoint = '/metadata/hw2'
+
+        super(options)
+      end
+
+      def campaign_levels(options = {})
+        get_data("#{@endpoint}/campaign-levels", options)
+      end
+
+      def campaign_logs(options = {})
+        get_data("#{@endpoint}/campaign-logs", options)
+      end
+
+      def card_keywords(options = {})
+        get_data("#{@endpoint}/card-keywords", options)
+      end
+
+      def cards(options = {})
+        get_data("#{@endpoint}/cards", options)
+      end
+
+      def csr_designations(options = {})
+        get_data("#{@endpoint}/csr-designations", options)
+      end
+
+      def difficulties(options = {})
+        get_data("#{@endpoint}/difficulties", options)
+      end
+
+      def game_object_categories(options = {})
+        get_data("#{@endpoint}/game-object-categories", options)
+      end
+
+      def game_objects(options = {})
+        get_data("#{@endpoint}/game-objects", options)
+      end
+
+      def leader_powers(options = {})
+        get_data("#{@endpoint}/leader-powers", options)
+      end
+
+      def leaders(options = {})
+        get_data("#{@endpoint}/leaders", options)
+      end
+
+      def maps(options = {})
+        get_data("#{@endpoint}/maps", options)
+      end
+
+      def packs(options = {})
+        get_data("#{@endpoint}/packs", options)
+      end
+
+      def playlists(options = {})
+        get_data("#{@endpoint}/playlists", options)
+      end
+
+      def seasons(options = {})
+        get_data("#{@endpoint}/seasons", options)
+      end
+
+      def spartan_ranks(options = {})
+        get_data("#{@endpoint}/spartan-ranks", options)
+      end
+
+      def techs(options = {})
+        get_data("#{@endpoint}/techs", options)
+      end
+
+    end
+  end
+end