zendesk2 1.5.11 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3fcbdbdb4b58bb78f1860e9674718eca73bb298
-  data.tar.gz: 6b69e843cb4cafd7dd347ee2e1158c40c5f27548
+  metadata.gz: 2704a7e73413c045698c7d7c28204609d114bcf6
+  data.tar.gz: 875403304d611be75c6d2e33ee0611e6d2e026c5
 SHA512:
-  metadata.gz: f4c24ea86731f7cdd3e02d50d784fdb33da1977c89d4d823a7e3c3044d649b376e8829e385489e5cb84e4324c09759b7d8539f647fed14b7e5aa92737e3e0614
-  data.tar.gz: 27b45d88a7854e86f1999ace2a1b01b9d54d4a9ae1df5374611284fbdbd3d6e8cf8c8cd00ae784b4709becdb99b531378674b519dd97aac1737e89b3ece5b09d
+  metadata.gz: 0ec9a8b932f31698c6b09a81e197ae80593302f1444fa12b2f5f83d440d827eb4d3c125d5c74160d1a6b7593e2c6c2e0d5958bea893f1c64d53780e108550a1e
+  data.tar.gz: 7bd85661df9a778aecd039da44763b0fc0c2d616b23a46b4d6462946bc5b5fd49a5b1eeda71dcd7c6b9e99ae59858ab9eb573d7b48d835f9c20bf9209918313d

data/Gemfile

@@ -16,4 +16,5 @@ group :test do
   gem 'guard-bundler', require: false
   gem 'guard-rspec', '~> 4.3', require: false
   gem 'rspec', '~> 3.2'
+  gem 'rack-test'
 end

data/lib/zendesk2/client/real.rb

@@ -24,18 +24,28 @@ class Zendesk2::Client < Cistern::Service
       raise "Missing required options: :username" unless @username
       raise "Missing required options: :password or :token" unless password || @token
 
-      @service = Faraday.new({url: @url}.merge(service_options)) do |builder|
+      @service = Faraday.new({url: @url}.merge(service_options)) do |connection|
         # response
-        builder.use Faraday::Request::BasicAuthentication, @username, @auth_token
-        builder.use Faraday::Response::RaiseError
-        builder.response :json, content_type: /\bjson/
+        connection.use Faraday::Request::BasicAuthentication, @username, @auth_token
+        connection.use Faraday::Response::RaiseError
+        connection.response :json, content_type: /\bjson/
 
         # request
-        builder.request :multipart
-        builder.request :json
+        connection.request :multipart
+        connection.request :json
 
-        builder.use Zendesk2::Logger, @logger
-        builder.adapter adapter
+        # idempotency
+        connection.request :retry,
+          :max                 => 30,
+          :interval            => 1,
+          :interval_randomness => 0.2,
+          :backoff_factor      => 2
+
+        # rate limit
+        connection.use Zendesk2::RateLimit, logger: @logger
+
+        connection.use Zendesk2::Logger, @logger
+        connection.adapter(*adapter)
       end
     end
 

data/lib/zendesk2/rate_limit.rb

@@ -0,0 +1,36 @@
+require "logger"
+
+module Zendesk2
+  class RateLimit
+
+    attr_reader :logger
+
+    def initialize(app, options={})
+      @app    = app
+      @logger = options[:logger] || ::Logger.new(nil)
+    end
+
+    def call(env)
+      original_env = env.dup
+      response = @app.call(env)
+
+      if response.env[:status] == 429
+        delay = (response.env[:response_headers][:retry_after]).to_f
+        logger.warn "Rate limited! Retrying after #{delay} seconds."
+
+        sleep(delay)
+
+        call(original_env).tap { |r| increment(r, delay) }
+      else
+        response
+      end
+    end
+
+    private
+
+    def increment(response, delay)
+      existing_delay = response.headers[:rate_limits] || 0.0
+      response.headers[:rate_limits] = existing_delay.to_f + delay.to_f
+    end
+  end
+end

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "1.5.11"
+  VERSION = "1.5.12"
 end

data/lib/zendesk2.rb

@@ -38,5 +38,6 @@ require 'zendesk2/error'
 require 'zendesk2/searchable'
 require 'zendesk2/logger'
 require 'zendesk2/paged_collection'
+require 'zendesk2/rate_limit'
 
 require 'zendesk2/client'

data/spec/lib/rate_limit_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Zendesk2::RateLimit do
+  class Puppet
+    def self.add_response(response)
+      self.responses.unshift(response)
+    end
+
+    def self.responses
+      @responses ||= []
+    end
+
+    def self.call(env)
+      self.responses.shift || raise("not response set")
+    end
+  end
+
+  it "should delay requests for the specified time" do
+    client = Faraday.new do |connection|
+      connection.use Zendesk2::RateLimit
+      connection.adapter :rack, Puppet
+    end
+
+    Puppet.responses << [429, {"Retry-After" => 0.1}, []]
+    Puppet.responses << [429, {"Retry-After" => 0.2}, []]
+    Puppet.responses << [200, {}, ["something"]]
+
+    response = client.get("/")
+
+    expect(response.status).to eq(200)
+    expect(response.headers[:rate_limits].to_s).to match(/^0\.3/) # ugh float math
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 1.5.11
+  version: 1.5.12
 platform: ruby
 authors:
 - Josh Lane
@@ -231,6 +231,7 @@ files:
 - lib/zendesk2/error.rb
 - lib/zendesk2/logger.rb
 - lib/zendesk2/paged_collection.rb
+- lib/zendesk2/rate_limit.rb
 - lib/zendesk2/searchable.rb
 - lib/zendesk2/version.rb
 - spec/categories_spec.rb
@@ -240,6 +241,7 @@ files:
 - spec/help_center/categories_spec.rb
 - spec/help_center/sections_spec.rb
 - spec/lib/paged_collection_spec.rb
+- spec/lib/rate_limit_spec.rb
 - spec/memberships_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/zendesk_resource.rb
@@ -286,6 +288,7 @@ test_files:
 - spec/help_center/categories_spec.rb
 - spec/help_center/sections_spec.rb
 - spec/lib/paged_collection_spec.rb
+- spec/lib/rate_limit_spec.rb
 - spec/memberships_spec.rb
 - spec/organizations_spec.rb
 - spec/shared/zendesk_resource.rb