cloudflare_client_rb 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53055d6f6789ba960ef43045e6b102ffb4e97baf
-  data.tar.gz: 3ef8b8314e81ae120c8c3711b75997d56e5f0e0e
+  metadata.gz: 97207869fc9f1586e9c8f2d51b1e2467d615020c
+  data.tar.gz: b3c6f6042a41012d3629f2e93364bbc34c0b4051
 SHA512:
-  metadata.gz: ba0a7b3a325441795cbfe180f351a8385bf5770b79c9b8b6008770438f9fbe4497af207ded9bc20f207482769c6418dee161e1b4311e669a2632031a60f4d468
-  data.tar.gz: f26ff45885f8efb43349310c4ea943522742b0dbbd320154e531104c2e2846b0c1b339af79c605656bc09c9e148beb779eb687e415a9640f6b73df897dd19000
+  metadata.gz: 49a932c5de6eeb9601d598fe49acdef3d234c20c70cd22f24fab7a4807f8b653d1610be67372ff13c55bb59e0f7ab918ff11ab8cad39c056bef0da909bdd3e15
+  data.tar.gz: e97e7da2f1201ed21693d4c87879d962dba9101fcdf16b1f70d518a592f493a9f76af60d82fd88b44966ac1544fb3de1dab5176427abf5451a665a70f3d86bc9

data/lib/cloudflare_client.rb

@@ -6,6 +6,7 @@ class CloudflareClient
   require 'date'
   require 'byebug'
   Dir[File.expand_path('../cloudflare_client/*.rb', __FILE__)].each { |f| require f }
+  require 'cloudflare_client/middleware/response/raise_error'
 
   API_BASE             = 'https://api.cloudflare.com/client/v4'.freeze
   VALID_BUNDLE_METHODS = %w[ubiquitous optimal force].freeze
@@ -136,6 +137,7 @@ class CloudflareClient
     client                                      = Faraday.new(url: API_BASE) do |conn|
       conn.request :multipart
       conn.request :url_encoded
+      conn.use Middleware::Response::RaiseError
       conn.adapter :net_http
     end
     client.headers['X-Auth-Key']                = params[:auth_key]

data/lib/cloudflare_client/middleware/response/raise_error.rb

@@ -0,0 +1,109 @@
+class CloudflareClient
+  class ResponseError < StandardError
+    # The Faraday::Response object that caused the exception to be raised.
+    attr_reader :response, :method, :uri, :url
+
+    def initialize(message = nil, response = nil, method = nil, uri = nil, url = nil)
+      super(message)
+      @response = response
+      @method = method
+      @uri = uri
+      @url = url
+    end
+  end
+
+  # An exception that is raised when a response status in the 4xx range is
+  # encountered. There's a number of subclasses that allow you to granularly
+  # handle specific status codes.
+  class ClientError < ResponseError; end
+
+  # Client errors:
+  class BadRequest < ClientError; end
+  class Unauthorized < ClientError; end
+  class Forbidden < ClientError; end
+  class ResourceNotFound < ClientError; end
+  class Conflict < ClientError; end
+  class Gone < ClientError; end
+  class PreconditionFailed < ClientError; end
+  class UnprocessableEntity < ClientError; end
+  class TooManyRequests < ClientError; end
+  class Locked < ClientError; end
+
+  # An exception that is raised when a response status in the 5xx range is
+  # encountered. There's a number of subclasses that allow you to granularly
+  # handle specific status codes.
+  class ServerError < ResponseError; end
+
+  # Server errors:
+  class InternalServerError < ServerError; end
+  class BadGateway < ServerError; end
+  class ServiceUnavailable < ServerError; end
+  class GatewayTimeout < ServerError; end
+
+  module Middleware
+    module Response
+      # Raises ResponseError exceptions when a response status in either the
+      # 4xx range or the 5xx range is encountered. There are a number of specific
+      # exception mappings as well as general exception types covering the
+      # respective ranges.
+      class RaiseError
+        CLIENT_ERRORS = 400...500
+        SERVER_ERRORS = 500...600
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          response = @app.call(env)
+          handle_status(response, env.method, env.url.request_uri, env.url.to_s)
+          response
+        end
+
+        private
+
+        def handle_status(response, method, uri, url)
+          case response.status
+          when 400
+            raise CloudflareClient::BadRequest.new('400 Bad Request', response, method, uri, url)
+          when 401
+            raise CloudflareClient::Unauthorized.new('401 Unauthorized', response, method, uri, url)
+          when 403
+            raise CloudflareClient::Forbidden.new('403 Forbidden', response, method, uri, url)
+          when 404
+            raise CloudflareClient::ResourceNotFound.new('404 Not Found', response, method, uri, url)
+          when 407
+            # Mimic the behavior that we get with proxy requests with HTTPS. We still
+            # use Faraday exceptions for network errors, as it's difficult to reliably
+            # wrap these in CloudflareClient without losing information.
+            raise Faraday::ConnectionFailed.new('407 Proxy Authentication Required', response)
+          when 409
+            raise CloudflareClient::Conflict.new('409 Conflict', response, method, uri, url)
+          when 410
+            raise CloudflareClient::Gone.new('410 Gone', response, method, uri, url)
+          when 412
+            raise CloudflareClient::PreconditionFailed.new('412 Precondition Failed', response, method, uri, url)
+          when 422
+            raise CloudflareClient::UnprocessableEntity.new('422 Unprocessable Entity', response, method, uri, url)
+          when 423
+            raise CloudflareClient::Locked.new('423 Locked', response, method, uri, url)
+          when 429
+            raise CloudflareClient::TooManyRequests.new('429 Too Many Requests', response, method, uri, url)
+          when 500
+            raise CloudflareClient::InternalServerError.new('500 Internal Server Error', response, method, uri, url)
+          when 502
+            raise CloudflareClient::BadGateway.new('502 Bad Gateway', response, method, uri, url)
+          when 503
+            raise CloudflareClient::ServiceUnavailable.new('503 Service Unavailable', response, method, uri, url)
+          when 504
+            raise CloudflareClient::GatewayTimeout.new('504 Gateway Timeout', response, method, uri, url)
+          when CLIENT_ERRORS
+            raise CloudflareClient::ClientError.new(response.status.to_s, response, method, uri, url)
+          when SERVER_ERRORS
+            raise CloudflareClient::ServerError.new(response.status.to_s, response, method, uri, url)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloudflare_client/version.rb

@@ -1,3 +1,3 @@
 class CloudflareClient
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/lib/cloudflare_client/zone/dns.rb

@@ -9,6 +9,8 @@ class CloudflareClient::Zone::DNS < CloudflareClient::Zone::Base
   def create(name:, type:, content:, ttl: nil, proxied: nil)
     raise ("type must be one of #{VALID_TYPES.flatten}") unless VALID_TYPES.include?(type)
     data = {name: name, type: type, content: content}
+    data[:ttl] = ttl unless ttl.nil?
+    data[:proxied] = proxied unless proxied.nil?
     cf_post(path: "/zones/#{zone_id}/dns_records", data: data)
   end
 

data/lib/cloudflare_client/zone/page_rule.rb

@@ -20,7 +20,7 @@ class CloudflareClient::Zone::PageRule < CloudflareClient::Zone::Base
 
   ##
   # list all the page rules for a zone
-  def list(status: 'disabled', order: 'priority', direction: 'desc', match: 'all')
+  def list(status: 'active', order: 'priority', direction: 'desc', match: 'all')
     valid_value_check(:status, status, VALID_STATUSES)
     valid_value_check(:order, order, VALID_ORDERS)
     valid_value_check(:direction, direction, VALID_DIRECTIONS)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare_client_rb
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - ian waters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: iwaters@zendesk.com
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - lib/cloudflare_client.rb
 - lib/cloudflare_client/certificate.rb
+- lib/cloudflare_client/middleware/response/raise_error.rb
 - lib/cloudflare_client/organization.rb
 - lib/cloudflare_client/organization/access_rule.rb
 - lib/cloudflare_client/organization/invite.rb