eve_badger 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bc45c7eb50a097472bc492371e1e500712dfca9
-  data.tar.gz: 9a0307ae74ba1477a86911ebf27f252ec77982f0
+  metadata.gz: 6d466155cb066385f95d91b504852a9e926229b7
+  data.tar.gz: f20836c0e7d123b9d3f841300b1178ec38eded52
 SHA512:
-  metadata.gz: 6d4ebf620cbc554ba9eb5066e4bc43c6d284c16377e0dbef12bb23e44b601506724504bdfcd7a5875519f134be148d91ef71ba3225186ec9c3e22be385db8416
-  data.tar.gz: 72ed8c09f93b607f7db34483d23d564f7285374d12fe35c5242919ef1fb32d1b6418c08d3216aff4bc05b4a375d3cdca4d278b8d93b3e3740bcdf05c04b3c055
+  metadata.gz: a6309c1516bf5e704f878ba241e9480d47ab9609e4be1e48404c19fdeb39c05c8dd3dc11e21edec7c96837591abc9bb338fa115c9bfb15bc77e7ec13e7deb97c
+  data.tar.gz: 85a43012be2168f6f89e11a79be09a60054467445a9974619d882fb054c2383d1bd1dbdec8e2f8a8827e51f1313105ad333bcb430faed7aa9248055a37849dc6

data/README.md

@@ -14,7 +14,7 @@ I wrote this for 3 reasons:
 
 ## What does it do?
 
-* Obeys CCP's default request rate limit (can be disabled if you have an exception)
+* Can throttle the request rate so you don't hit CCP's default rate limit. (Disabled by default.)
 * Uses Moneta to cache responses with whatever supported backend you prefer. (Disabled by default.)
 * Automatically fetches missing access_mask and key_type values from the API Key Info endpoint.
 * Respects access masks for keys and endpoints (it will raise an exception instead of making an HTTP request if you try to access an endpoint that isn't allowed by the key's access mask)
@@ -100,18 +100,41 @@ end
 api = EveBadger::EveAPI.new(server: :sisi)
 api.key_id = my_key_id
 api.vcode = my_vcode
-api.character_id = my_character_id)
+api.character_id = my_character_id
 # then continue as normal
 ```
 
-### Enable Request Caching
+### Request Caching
 ```ruby
-# EveBadger::Cache.enable! takes the same arguments as Moneta.new
+# EveBadger::Cache.enable takes the same arguments as Moneta.new
 # See Moneta API docs for possible configurations:
 # http://www.rubydoc.info/gems/moneta/frames
-# Note: EveBadger will automatically merge in {expires: true} if the
+#
+# EveBadger will automatically merge in {expires: true} if the
 # chosen adapter doesn't support expiration natively.
-EveBadger::Cache.enable!(:Redis)
+#
+# Caching is handled automatically while a cache adapter is enabled.
+EveBadger::Cache.enable(:Redis)
+
+# You can also disable an enabled cache if you want to for some reason
+# just keep in mind that all your cached data will go poof if you use
+# an the :Memory adapter.
+EveBadger::Cache.disable
+```
+
+### Request Throttling
+```ruby
+# EveBadger::Thottle.enable_default will set CCPs default rate
+# limit of 30 requests per minute.
+EveBadger::Throttle.enable_default
+
+# Use EveBadger::Throttle.enable_custom to set a custom limit if
+# you have arranged for an exception for your app.
+requests_per_minute = 100
+EveBadger::Throttle.enable_custom(requests_per_minute)
+
+# Like caching, you may disable a previously enabled throttle.
+EveBadger::Throttle.disable
 ```
 
 ### Tips for Edge Cases

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/eve_badger/cache.rb

@@ -2,7 +2,7 @@ require 'moneta'
 require 'digest/sha1'
 
 module EveBadger
-  # A wrapper around a Moneta object that provides automatic request caching for Evebadger::EveAPI when enabled.
+  # A wrapper around a Moneta object that provides automatic request caching for Evebadger::EveAPI while enabled.
   module Cache
     # Cache is disabled by default
     @cache = nil
@@ -11,15 +11,14 @@ module EveBadger
 
     # Enable the cache with a specified Moneta adapter.
     # See Moneta API documentation for possible configurations: http://www.rubydoc.info/gems/moneta/frames
-    def self.enable!(*args, **kwargs)
+    def self.enable(*args, **kwargs)
       unless @native_expires.any? { |name| args.include?(name) }
-      # unless false
         kwargs.merge!({expires: true})
       end
       @cache = Moneta.new(*args, **kwargs)
     end
 
-    def self.disable!
+    def self.disable
       @cache = nil
     end
 

data/lib/eve_badger/eve_api.rb

@@ -1,10 +1,6 @@
 require 'nokogiri'
 require 'time'
 require 'open-uri'
-require 'eve_badger'
-require 'eve_badger/endpoints'
-require 'eve_badger/response'
-require 'eve_badger/cache'
 require 'digest/sha1'
 
 module EveBadger
@@ -13,11 +9,7 @@ module EveBadger
     attr_reader :key_id, :vcode, :character_id, :domain
 
     def initialize(args={})
-      if args[:server] == :sisi
-        @domain = EveBadger.sisi_domain
-      else
-        @domain = EveBadger.tq_domain
-      end
+      @domain = args[:sisi] ? EveBadger.default_sisi_domain : EveBadger.default_tq_domain
       @user_agent = EveBadger.default_user_agent
       @key_id = args[:key_id].to_s if args[:key_id]
       @vcode = args[:vcode].to_s if args[:vcode]
@@ -148,7 +140,7 @@ module EveBadger
       end
     end
 
-    # Hash URI's before use as a cache key so that API key/vcode combinations don't leak from the cache monitor or logs.
+    # Hash URI's before use as a cache key so that API key/vcode combinations don't into log files of dependencies.
     def hash_of(uri)
       Digest::SHA1.hexdigest(uri)
     end

data/lib/eve_badger/response.rb

@@ -28,12 +28,9 @@ module EveBadger
       Badgerfish::Parser.new.load(@content)['eveapi']['result']
     end
 
-    # raise an exception if the response contains an Eve API error
-    def raise_for_api_errors!(response)
-      document = Nokogiri::XML(response)
-      if document.xpath('//error').any?
-        raise EveBadger::CCPPleaseError, "#{document.xpath('//error').first}"
-      end
+    def api_errors
+      document = Nokogiri::XML(@content)
+      document.xpath('//error')
     end
   end
 

data/lib/eve_badger/throttle.rb

@@ -0,0 +1,31 @@
+require 'slowweb'
+
+module EveBadger
+  module Throttle
+    def self.disable
+      SlowWeb.reset
+    end
+
+    # enables the default rate limit of 30 requests per minute which ccp expects users to obey
+    def self.enable_default
+      SlowWeb.limit(EveBadger.default_tq_domain, 30, 60)
+      SlowWeb.limit(EveBadger.default_sisi_domain, 30, 60)
+    end
+
+    #
+    def self.enable_custom(requests_per_minute)
+      SlowWeb.reset
+      SlowWeb.limit(EveBadger.default_tq_domain, requests_per_minute, 60)
+      SlowWeb.limit(EveBadger.default_sisi_domain, requests_per_minute, 60)
+    end
+
+
+    def self.enabled?
+     if SlowWeb.get_limit(EveBadger.default_tq_domain) || SlowWeb.get_limit(EveBadger.default_sisi_domain)
+       true
+     else
+       false
+     end
+    end
+  end
+end

data/lib/eve_badger.rb

@@ -1,5 +1,8 @@
-require 'slowweb'
 require 'eve_badger/eve_api'
+require 'eve_badger/endpoints'
+require 'eve_badger/response'
+require 'eve_badger/cache'
+require 'eve_badger/throttle'
 
 module EveBadger
   def self.version
@@ -10,30 +13,11 @@ module EveBadger
     "EveBadger-#{EveBadger.version}/Ruby-#{RUBY_VERSION}"
   end
 
-  def self.tq_domain
+  def self.default_tq_domain
     'https://api.eveonline.com/'
   end
 
-  def self.sisi_domain
+  def self.default_sisi_domain
     'https://api.testeveonline.com/'
   end
-
-  # According to CCP the default limit for API access is 30 requests per minute.
-  SlowWeb.limit(tq_domain, 30, 60)
-  SlowWeb.limit(sisi_domain, 30, 60)
-
-  def self.disable_throttling
-    SlowWeb.reset
-  end
-
-  def self.enable_default_throttling
-    SlowWeb.limit(tq_domain, 30, 60)
-    SlowWeb.limit(sisi_domain, 30, 60)
-  end
-
-  def self.enable_custom_throttling(requests_per_minute)
-    SlowWeb.reset
-    SlowWeb.limit(tq_domain, requests_per_minute, 60)
-    SlowWeb.limit(sisi_domain, requests_per_minute, 60)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eve_badger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Corey Smedstad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-30 00:00:00.000000000 Z
+date: 2015-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,8 +66,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-description: For more information look at the README in the github repository (homepage
-  link).
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: load_path
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+description: 'Easily get XML or JSON from the Eve: Online API with optional caching
+  and throttling.'
 email: smedstadc@gmail.com
 executables: []
 extensions: []
@@ -85,6 +113,7 @@ files:
 - lib/eve_badger/json/corporation_endpoints.json
 - lib/eve_badger/json/detail_endpoints.json
 - lib/eve_badger/response.rb
+- lib/eve_badger/throttle.rb
 homepage: https://github.com/smedstadc/eve_badger
 licenses:
 - MIT
@@ -108,5 +137,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: 'A gem for interacting with the Eve: Online XML API.'
+summary: 'A gem for interacting with the Eve: Online API.'
 test_files: []