heroics 0.0.25 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e68ba785351a943b6f0074745b8feda4a605e784b041fa5b1bfa6f6508737f94
-  data.tar.gz: 0215babfbc42434506a8ee778db394b0ed352b54dd7e56536a45ae9df2ab43f1
+  metadata.gz: 5647a8b91b25c77f40182266db987cd58c4f189eae45a70a694ba4d21f736d19
+  data.tar.gz: 7a723886449d51423484019452f5f22be13bef2874f94d85c90153c7e4b16aa5
 SHA512:
-  metadata.gz: 61535d6335adbf12786d56b27fa2b53dfc13b7f835fe7bba7040bcb4b9724391de3d6b0ae0254fff3ad1580b64e44f48dcc47a5f8ef7ac664f20f1260743be26
-  data.tar.gz: 905ea0ed8f1310471be27d7d50608cd4afdd0f393b82557a000c42c7b73ac002195ccdf4a400042d4a6ad0fa59e2585f30fd16280dbe4dcaabd670b2e0a28eed
+  metadata.gz: adfc5e7f5a5159d9264215bcc8496e334535ace0f5b770fb46de19f331a03425423a7c2aee7f21cf990c57aa4a36e724206bd1f280f70e68c0f7d15640930390
+  data.tar.gz: 75d171e2daf0bc99a5d1d675661684e15f4d128ccb1cc1f02deabddfc56cef955de82bbd85f366e17dd6f915452cd2df2d8d223830f4de0593d6bf149ba76f27

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.1.0
+
+- Introduced rate throttling integration point (https://github.com/interagent/heroics/pull/95)
+

data/heroics.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep('^(test|spec|features)/')
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'minitest', '4.7.5'
   spec.add_development_dependency 'netrc'
   spec.add_development_dependency 'rake'

data/lib/heroics/configuration.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 module Heroics
+  module NullRateLimit
+    def self.call
+      yield
+    end
+  end
+
   # Attempts to load configuration, provides defaults, and provide helpers to access that data
   class Configuration
     attr_reader :base_url,
@@ -22,7 +28,7 @@ module Heroics
       @options = {}
       @options[:cache] = 'Moneta.new(:Memory)'
       @options[:default_headers] = {}
-
+      @options[:rate_throttle] = NullRateLimit
       @ruby_name_replacement_patterns = { /[\s-]+/ => '_' }
 
       yield self if block_given?
@@ -57,5 +63,9 @@ module Heroics
       raise "Must provide a hash of replacements" unless patterns.is_a?(Hash)
       @ruby_name_replacement_patterns = patterns
     end
+
+    def rate_throttle=(rate_throttle)
+      @options[:rate_throttle] = rate_throttle
+    end
   end
 end

data/lib/heroics/link.rb

@@ -18,6 +18,7 @@ module Heroics
       @link_schema = link_schema
       @default_headers = options[:default_headers] || {}
       @cache = options[:cache] || {}
+      @rate_throttle = options[:rate_throttle] || Heroics::Configuration.defaults.options[:rate_throttle]
     end
 
     # Make a request to the server.
@@ -108,7 +109,10 @@ module Heroics
         etag = @cache["etag:#{cache_key}"]
         options[:headers] = options[:headers].merge({'If-None-Match' => etag}) if etag
       end
-      response = connection.request(options)
+
+      response = @rate_throttle.call do
+        connection.request(options)
+      end
 
       if response.status == 304
         body = @cache["data:#{cache_key}"]

data/lib/heroics/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Heroics
-  VERSION = '0.0.25'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroics
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.1.0
 platform: ruby
 authors:
 - geemus
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2019-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +177,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - CONTRIBUTORS.md
 - Gemfile
@@ -220,8 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby client generator for HTTP APIs described with a JSON schema