halo-api 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64d185252ce2e1aa3141aef30fa2d920271d7f1c
-  data.tar.gz: ecf4da6883b446f590d0fcfa8764de508760de99
+  metadata.gz: d241a3a1fe1f27c5cb995fafd2d02b4a9d861a9e
+  data.tar.gz: 2f16787de453f9975aba2c683ef74b4cebc9ab14
 SHA512:
-  metadata.gz: 23c8dc1d1b6c53d17bf88ac0d8f696478ba5ade17d641e3421416c2926cd9bc35adbb06da8114845508cbb0c896f7150ef4c8105bd1d559c0e396db797f75593
-  data.tar.gz: f7359da19034d9f54523f8c971fa8e5453365ed92de7ef23a1860a4a88a0dce1f9d16a783e47e9de28d6b48671689a6d8e9132ee159cd035ede6ad07f369901b
+  metadata.gz: 98e71bf3bb6b85f0d9386ed8c9e83615e11a5a2abdb4228817af018557c4aebfd596d0c48a4a173b0acacbfa4e8efdbc3edfb27ee5e9fa1cd808504283cfbc82
+  data.tar.gz: b9d1cc843c195d556b896ccc87fb7d7e3656ca46ac40a68103102ac37914e6853b6e0dc54bc618d6f27aa0ce7373a78865c7b79ae723fb8fca8a0e64fc4da511

data/.gitignore

@@ -10,5 +10,10 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Environment
 .env
-/.idea
+
+# rvm
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
---require spec_helper
+--require spec_helper
+--fail-fast

data/.travis.yml

@@ -1,10 +1,10 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.0
+  - 2.2.2
   - 2.3.0
   - 2.4.1
   - ruby-head
 before_install: gem install bundler -v 1.15.4
+services:
+  - redis-server

data/README.md

@@ -25,11 +25,19 @@ Or install it yourself as:
 
 ## Usage
 
-Basic examples:
+Basic configuration:
+````ruby
+Halo.configure do |config|
+  config.api_key = ENV['HALO_API_KEY']
+end
+````
+
+With redis and region (optional parameters)
 ````ruby
 Halo.configure do |config|
   config.api_key = ENV['HALO_API_KEY']
   config.region  = ENV['HALO_REGION']
+  config.redis   = ENV['HALO_REDIS']
 end
 ````
 
@@ -47,6 +55,10 @@ h2w_campaign_levels = halo_wars2_client.metadata.campaign_levels
 
 - [x] Halo 5 endpoints
 - [x] Halo Wars 2 endpoints
+- [x] Redis response caching support
+- [ ] Request rate limiter
+- [ ] Custom query builder
+- [ ] Paged requests
 - [ ] Documentation
 
 ## Contributing

data/halo-api.gemspec

@@ -22,18 +22,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # This gem will work with 2.0.0 or greater
-  spec.required_ruby_version = '>= 2.0.0'
+  # This gem will work with 2.2.2 or greater
+  spec.required_ruby_version = '>= 2.2.2'
 
   spec.add_runtime_dependency 'httparty', '~> 0.15.6'
   spec.add_runtime_dependency 'addressable', '~> 2.5', '>= 2.5.2'
+  spec.add_runtime_dependency 'redis', '~> 4.0'
 
   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 'rake', '~> 12.1'
+  spec.add_development_dependency 'rspec', '~> 3.6'
   spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.1'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
   spec.add_development_dependency 'coveralls', '~> 0.8.21'
-  spec.add_development_dependency 'pry', '~> 0.10.3'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'wwtd', '~> 1.3'
 end

data/lib/halo-api/api_response.rb

@@ -1,18 +1,61 @@
+require 'httparty'
+require 'addressable/uri'
+
 module Halo
-  class APIResponse
+  class InvalidCacheStore < StandardError; end
 
-    attr_accessor :data
+  class APIResponse
+    include HTTParty
 
     def initialize(options = {})
-      @data           = []
-      @client         = options[:client]
+      client       = options.delete(:client)
+      @api_key     = client.api_key
+      @region      = client.region
+      @cache_store = client.cache_store || {}
+
+      raise InvalidCacheStore if cached? && !redis_store.is_a?(Redis)
+
+      self.class.base_uri 'https://www.haloapi.com'
     end
 
-    def get_data(path, options)
-      return if @client.nil?
-      response = @client.get(path, options)
-      @data = response.parsed_response
+    def get_data(path, options = {})
+      if cached?
+        result = redis_store.get("#{path}#{options}")
+        return JSON.parse(result) if result
+      end
+      response = perform_uncached_request(:get, path, options)
+      redis_store.setex "#{path}#{options}", ttl, response.to_json if cached?
+      response
     end
 
+    def perform_uncached_request(verb, path, params = {})
+      options = {}
+      headers = {
+        'Ocp-Apim-Subscription-Key' => @api_key,
+        'Accept-Language' => @region
+      }
+
+      options[:headers] = headers unless headers.empty?
+      options[:query]   = params unless params.empty?
+
+      response = self.class.send(verb, Addressable::URI.encode(path), options)
+
+      response.respond_to?(:parsed_response) ? response.parsed_response : response
+    end
+
+    # @return [Redis] returns the cache store
+    def redis_store
+      @cache_store[:redis]
+    end
+
+    # @return [Boolean] true if the request should be cached
+    def cached?
+      @cache_store[:cached]
+    end
+
+    # @return [Integer] the ttl to apply to cached keys
+    def ttl
+      @cache_store[:ttl]
+    end
   end
 end

data/lib/halo-api/client.rb

@@ -1,7 +1,8 @@
 require 'halo-api/version'
 require 'halo-api/api_response'
-require 'httparty'
-require 'addressable/uri'
+require 'halo-api/configuration'
+
+require 'redis'
 
 
 module Halo
@@ -11,34 +12,35 @@ module Halo
     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
 
-      self.class.base_uri "https://www.haloapi.com#{@endpoint}"
+      set_up_cache(options.delete(:redis), options.delete(:ttl))
     end
 
-    def get(path, params = {})
-      make_request :get, path, params
+    def set_up_cache(redis_url, ttl)
+      return @cached = false unless redis_url
+      @ttl = ttl || Halo::Configuration::DEFAULT_TTL
+      @cached = true
+      @redis = Redis.new url: redis_url
     end
 
-    def make_request(verb, path, params = {})
-      options = {}
-      headers = {
-        'Ocp-Apim-Subscription-Key' => @api_key,
-        'Accept-Language' => @region
+    # Returns an options hash with cache keys
+    # @return [Hash]
+    def cache_store
+      {
+        redis: @redis,
+        ttl: @ttl,
+        cached: @cached
       }
+    end
 
-      options[:headers] = headers unless headers.empty?
-      options[:query]   = params unless params.empty?
-
-      self.class.send(verb, Addressable::URI.encode(path), options)
+    # @return [Boolean] true if the request should be cached
+    def cached?
+      cache_store[:cached]
     end
 
 

data/lib/halo-api/configuration.rb

@@ -1,10 +1,12 @@
 module Halo
   module Configuration
 
-    OPTIONS = %i[api_key region].freeze
+    OPTIONS = %i[api_key region redis ttl].freeze
 
     DEFAULT_API_KEY = nil
-    DEFAULT_REGION = :en
+    DEFAULT_REGION = 'en'
+    DEFAULT_REDIS = 'redis://localhost:6379'
+    DEFAULT_TTL = 1800
 
     attr_accessor(*OPTIONS)
 

data/lib/halo-api/version.rb

@@ -1,3 +1,3 @@
 module Halo
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: halo-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Carlos Ruiz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -64,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -112,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0.50'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +154,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: wwtd
   requirement: !ruby/object:Gem::Requirement
@@ -171,8 +185,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -206,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.ruby-gemset

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

data/.ruby-version

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