halo-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a11b3b39ac1be76eaa4c74a309c0f426a91c4d00
+  data.tar.gz: 213699928a19c61341082683d93fecd7f76298a5
+SHA512:
+  metadata.gz: 0bb4d80a077baac394163ce1f077305f1f0d976163cd8dfb3916cce40f6a6100034264c1f77b927defcb639e6fa58bc6bcd7268c2e1817f5b32f11bf4784eb39
+  data.tar.gz: b29f2e0251db8164f04188f8b3247354f73942cef671fadda57b72e22f4725affaab67f4d069dad5826af8d0a9d73e66ff95792859d4eada36724a585377419f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+/.idea

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+halo-api

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in halo-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carlos Ruiz
+
+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,60 @@
+# HaloAPI
+[![GitHub version](https://badge.fury.io/gh/xarlybovi%2Fhalo-api.png)](https://badge.fury.io/gh/xarlybovi%2Fhalo-api)
+[![Dependency Status](https://gemnasium.com/badges/github.com/xarlybovi/halo-api.svg)](https://gemnasium.com/github.com/xarlybovi/halo-api)
+[![Code Climate](https://codeclimate.com/github/xarlybovi/halo-api.png)](https://codeclimate.com/github/xarlybovi/halo-api)
+[![Build Status](https://travis-ci.org/xarlybovi/halo-api.svg?branch=master)](https://travis-ci.org/xarlybovi/halo-api)
+[![Coverage Status](https://coveralls.io/repos/github/xarlybovi/halo-api/badge.svg?branch=master)](https://coveralls.io/github/xarlybovi/halo-api?branch=master)
+
+Wrapper for Halo Public API (BETA). https://developer.haloapi.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'halo-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install halo-api
+
+## Usage
+
+Basic example:
+````ruby
+Halo.configure do |config|
+  config.api_key = ENV['HALO_API_KEY']
+  config.region  = ENV['HALO_REGION']
+end
+````
+
+````ruby
+metadata = Halo.h5_metadata
+
+missions = metadata.campaign_missions.all
+
+````
+
+## TODO
+
+- [x] Halo 5 endpoints
+- [ ] Halo Wars 2 endpoints
+
+## Contributing
+
+Bug reports and pull requests are welcome!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## 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 "halo-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(__FILE__)

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/halo-api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'halo-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'halo-api'
+  spec.version       = Halo::VERSION
+  spec.authors       = ['Carlos Ruiz']
+  spec.email         = ['xarlybovi@gmail.com']
+
+  spec.summary       = 'Wrapper for Halo Public API.'
+  spec.description   = 'Wrapper for Halo Public API (BETA). https://developer.haloapi.com'
+  spec.homepage      = 'https://github.com/xarlybovi/halo-api.git'
+  spec.license       = 'MIT'
+  
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty', '~> 0.15.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.1'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency 'pry', '~> 0.10.3'
+end

data/lib/halo-api.rb

@@ -0,0 +1,33 @@
+require 'halo-api/version'
+require 'halo-api/configuration'
+require 'halo-api/client'
+require 'halo-api/api_response'
+
+require 'halo-api/modules/metadata/halo5_metadata_client'
+require 'halo-api/modules/profile/halo5_profile_client'
+require 'halo-api/modules/stats/halo5_stats_client'
+require 'halo-api/modules/ugc/halo5_ugc_client'
+
+
+module Halo
+  extend Configuration
+
+  class << self
+    def h5_metadata(options = {})
+      Halo::Metadata::Halo5MetadataClient.new(options)
+    end
+
+    def h5_profile(options = {})
+      Halo::Profile::Halo5ProfileClient.new(options)
+    end
+
+    def h5_stats(options = {})
+      Halo::Stats::Halo5StatsClient.new(options)
+    end
+
+    def h5_ugc(options = {})
+      Halo::Ugc::Halo5UgcClient.new(options)
+    end
+  end
+
+end

data/lib/halo-api/api_response.rb

@@ -0,0 +1,19 @@
+module Halo
+  class APIResponse
+
+    attr_accessor :data
+
+    def initialize(options = {})
+      @data           = []
+      @client         = options[:client]
+      @endpoint       = options[:client].endpoint
+    end
+
+    def get_data(path, options)
+      return if @client.nil?
+      response = @client.get(path, options)
+      @data = response.parsed_response
+    end
+
+  end
+end

data/lib/halo-api/client.rb

@@ -0,0 +1,56 @@
+require 'halo-api/version'
+require 'halo-api/api_response'
+require 'httparty'
+
+
+module Halo
+  class Client
+    include HTTParty
+
+    attr_accessor(*Configuration::OPTIONS)
+
+    def initialize(options = {})
+      @api_key = options[:api_key]
+      @region = options[:region]
+      @endpoint = options[:endpoint]
+
+      options = Halo.options.merge(options)
+
+      Halo::Configuration::OPTIONS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    def endpoint
+      raise 'Invalid API Endpoint' if @endpoint.nil?
+      @endpoint
+    end
+
+    def get(path, params = {})
+      make_request :get, path, params
+    end
+
+    def make_request(verb, path, params = {})
+      options = {}
+      headers = {
+        'Ocp-Apim-Subscription-Key': @api_key,
+        'Accept-Language': @region
+      }
+
+      url = "https://www.haloapi.com#{path}"
+
+      options[:headers] = headers unless headers.empty?
+      options[:query]   = params unless params.empty?
+
+      self.class.send(verb, url, options)
+    end
+
+
+    private
+
+    def merge_options_and_return_obj(options, obj)
+      opts = options.merge(client: self)
+      obj.new(opts)
+    end
+  end
+end

data/lib/halo-api/configuration.rb

@@ -0,0 +1,22 @@
+module Halo
+  module Configuration
+
+    OPTIONS = %i[api_key region].freeze
+
+    DEFAULT_API_KEY = nil
+    DEFAULT_REGION = :en
+
+    attr_accessor(*OPTIONS)
+
+    def configure
+      yield self
+    end
+
+    def options
+      OPTIONS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class CampaignMissions < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/campaign-missions", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class Commendations < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/commendations", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class CsrDesignations < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/csr-designations", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class Enemies < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/enemies", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class FlexibleStats < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/flexible-stats", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Halo
+  module Metadata
+    module Halo5
+      class GameBaseVariants < Halo::APIResponse
+
+        def initialize(options = {})
+          super(options)
+        end
+
+        def all(options = {})
+          get_data("#{@endpoint}/game-base-variants", options)
+        end
+
+      end
+    end
+  end
+end