cloudflare_client_rb 4.0.0

data/lib/cloudflare_client/organization/railgun.rb

@@ -0,0 +1,79 @@
+class CloudflareClient::Organization::Railgun < CloudflareClient::Organization
+  ##
+  # org railgun
+
+  ##
+  # list railguns
+  def create(name:)
+    id_check('name', name)
+    data = {name: name}
+    cf_post(path: "/organizations/#{org_id}/railguns", data: data)
+  end
+
+  ##
+  # list railguns
+  def list(page: 1, per_page: 50, direction: 'desc')
+    params = {}
+
+    unless direction.nil?
+      valid_value_check(:direction, direction, VALID_DIRECTIONS)
+      params[:direction] = direction
+    end
+
+    unless page.nil?
+      range_check(:page, page, 1)
+      params[:page] = page
+    end
+
+    unless per_page.nil?
+      range_check(:per_page, per_page, 5, 50)
+      params[:per_page] = per_page
+    end
+
+    cf_get(path: "/organizations/#{org_id}/railguns", params: params)
+  end
+
+  ##
+  # show railgun details
+  def show(id:)
+    id_check(:id, id)
+
+    cf_get(path: "/organizations/#{org_id}/railguns/#{id}")
+  end
+
+  ##
+  # get zones connected to a given railgun
+  def zones(id:)
+    id_check(:id, id)
+
+    cf_get(path: "/organizations/#{org_id}/railguns/#{id}/zones")
+  end
+
+  ##
+  # enable a railgun
+  def enable(id:)
+    update_enabled(id: id, enabled: true)
+  end
+
+  ##
+  # disable a railgun
+  def disable(id:)
+    update_enabled(id: id, enabled: false)
+  end
+
+  ##
+  # delete an org railgun
+  def delete(id:)
+    id_check(:id, id)
+
+    cf_delete(path: "/organizations/#{org_id}/railguns/#{id}")
+  end
+
+  private
+
+  def update_enabled(id:, enabled:)
+    id_check(:id, id)
+
+    cf_patch(path: "/organizations/#{org_id}/railguns/#{id}", data: {enabled: enabled})
+  end
+end

data/lib/cloudflare_client/organization/role.rb

@@ -0,0 +1,19 @@
+class CloudflareClient::Organization::Role < CloudflareClient::Organization
+  ##
+  # org roles
+  #
+
+  ##
+  # list all organization roles
+  def list
+    cf_get(path: "/organizations/#{org_id}/roles")
+  end
+
+  ##
+  # get details of an organization role
+  def show(id:)
+    id_check(:id, id)
+
+    cf_get(path: "/organizations/#{org_id}/roles/#{id}")
+  end
+end

data/lib/cloudflare_client/railgun.rb

@@ -0,0 +1,63 @@
+class CloudflareClient::Railgun < CloudflareClient
+  ##
+  # Railgun methods
+  def initialize(*args)
+    super
+  end
+
+  ##
+  # create(name: 'name of railgun')
+  def create(name:)
+    raise 'Railgun name cannot be nil' if name.nil?
+    data = {name: name}
+    cf_post(path: '/railguns', data: data)
+  end
+
+  ##
+  # Get all the railguns
+  def list(page: 1, per_page: 50, direction: 'desc')
+    raise 'direction must be either desc | asc' unless direction == 'desc' || direction == 'asc'
+    params = {page: page, per_page: per_page, direction: direction}
+    cf_get(path: '/railguns', params: params)
+  end
+
+  ##
+  # Get a single railgun
+  def show(id:)
+    raise 'must provide the id of the railgun' if id.nil?
+    cf_get(path: "/railguns/#{id}")
+  end
+
+  ##
+  # Get CF zones associated with a railgun
+  def zones(id:)
+    raise 'must provide the id of the railgun' if id.nil?
+    cf_get(path: "/railguns/#{id}/zones")
+  end
+
+  ##
+  # Enable a railgun
+  def enable(id:)
+    update_enabled(id: id, enabled: true)
+  end
+
+  ##
+  # Disable a railgun
+  def disable(id:)
+    update_enabled(id: id, enabled: false)
+  end
+
+  ##
+  # delete a railgun
+  def delete(id:)
+    raise 'must provide the id of the railgun' if id.nil?
+    cf_delete(path: "/railguns/#{id}")
+  end
+
+  private
+
+  def update_enabled(id:, enabled:)
+    raise 'must provide the id of the railgun' if id.nil?
+    cf_patch(path: "/railguns/#{id}", data: {enabled: enabled})
+  end
+end

data/lib/cloudflare_client/version.rb

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

data/lib/cloudflare_client/virtual_dns_cluster.rb

@@ -0,0 +1,133 @@
+class CloudflareClient::VirtualDnsCluster < CloudflareClient
+  require_relative '../cloudflare_client/virtual_dns_cluster/analytic.rb'
+
+  VALID_SCOPES = %i[user organization].freeze
+
+  attr_reader :uri_prefix
+
+  ##
+  # virtual DNS
+  # using scope to determine if this is for users or for orgs
+  def initialize(args)
+    scope  = args.delete(:scope)&.to_sym
+    org_id = args.delete(:org_id)
+
+    valid_value_check(:scope, scope, VALID_SCOPES)
+
+    if scope == :user
+      @uri_prefix = '/user'
+    else
+      id_check(:org_id, org_id)
+
+      @uri_prefix = "/organizations/#{org_id}"
+    end
+
+    super
+  end
+
+  ##
+  # list virutal dns clsuters for a user or an org
+  def list
+    cf_get(path: "#{uri_prefix}/virtual_dns")
+  end
+
+  ##
+  # create a virtual dns cluster
+  def create(name:,
+             origin_ips:,
+             minimum_cache_ttl: nil,
+             maximum_cache_ttl: nil,
+             deprecate_any_request: nil,
+             ratelimit: nil)
+    id_check(:name, name)
+    max_length_check(:name, name, 160)
+    non_empty_array_check(:origin_ips, origin_ips)
+
+    data = {name: name, origin_ips: origin_ips}
+
+    unless minimum_cache_ttl.nil?
+      range_check(:minimum_cache_ttl, minimum_cache_ttl, 30, 36000)
+      data[:minimum_cache_ttl] = minimum_cache_ttl
+    end
+
+    unless maximum_cache_ttl.nil?
+      range_check(:maximum_cache_ttl, maximum_cache_ttl, 30, 36000)
+      data[:maximum_cache_ttl] = maximum_cache_ttl
+    end
+
+    unless deprecate_any_request.nil?
+      valid_value_check(:deprecate_any_request, deprecate_any_request, [true, false])
+      data[:deprecate_any_request] = deprecate_any_request
+    end
+
+    unless ratelimit.nil?
+      range_check(:ratelimit, ratelimit, 0, 100000000)
+      data[:ratelimit] = ratelimit
+    end
+
+    cf_post(path: "#{uri_prefix}/virtual_dns", data: data)
+  end
+
+  ##
+  # details of a cluster
+  def show(id:)
+    id_check(:id, id)
+
+    cf_get(path: "#{uri_prefix}/virtual_dns/#{id}")
+  end
+
+  ##
+  # delete a dns cluster (user)
+  def delete(id:)
+    id_check(:id, id)
+
+    cf_delete(path: "#{uri_prefix}/virtual_dns/#{id}")
+  end
+
+  ##
+  # updates a dns cluster (user)
+  def update(id:,
+             name: nil,
+             origin_ips: nil,
+             minimum_cache_ttl: nil,
+             maximum_cache_ttl: nil,
+             deprecate_any_request: nil,
+             ratelimit: nil)
+    id_check(:id, id)
+
+    data = {}
+
+    unless name.nil?
+      id_check(:name, name)
+      max_length_check(:name, name, 160)
+      data[:name] = name
+    end
+
+    unless origin_ips.nil?
+      non_empty_array_check(:origin_ips, origin_ips)
+      data[:origin_ips] = origin_ips
+    end
+
+    unless minimum_cache_ttl.nil?
+      range_check(:minimum_cache_ttl, minimum_cache_ttl, 30, 36000)
+      data[:minimum_cache_ttl] = minimum_cache_ttl
+    end
+
+    unless maximum_cache_ttl.nil?
+      range_check(:maximum_cache_ttl, maximum_cache_ttl, 30, 36000)
+      data[:maximum_cache_ttl] = maximum_cache_ttl
+    end
+
+    unless deprecate_any_request.nil?
+      valid_value_check(:deprecate_any_request, deprecate_any_request, [true, false])
+      data[:deprecate_any_request] = deprecate_any_request
+    end
+
+    unless ratelimit.nil?
+      range_check(:ratelimit, ratelimit, 0, 100000000)
+      data[:ratelimit] = ratelimit
+    end
+
+    cf_patch(path: "#{uri_prefix}/virtual_dns/#{id}", data: data)
+  end
+end

data/lib/cloudflare_client/virtual_dns_cluster/analytic.rb

@@ -0,0 +1,38 @@
+class CloudflareClient::VirtualDnsCluster::Analytic < CloudflareClient::VirtualDnsCluster
+  attr_reader :virtual_dns_id
+
+  ##
+  # virtual DNS Analytics (users and orgs)
+  #
+  def initialize(args)
+    @virtual_dns_id = args.delete(:virtual_dns_id)
+    id_check(:virtual_dns_id, virtual_dns_id)
+    super
+  end
+
+  def report(dimensions:, metrics:, since_ts:, until_ts:, filters: nil, sort: nil, limit: nil)
+    non_empty_array_check(:dimensions, dimensions)
+    non_empty_array_check(:metrics, metrics)
+    iso8601_check(:since_ts, since_ts)
+    iso8601_check(:until_ts, until_ts)
+
+    params = {dimensions: dimensions, metrics: metrics, since: since_ts, until: until_ts}
+
+    unless sort.nil?
+      non_empty_array_check(:sort, sort)
+      params[:sort] = sort
+    end
+
+    unless filters.nil?
+      basic_type_check(:filters, filters, String)
+      params[:filters] = filters
+    end
+
+    unless limit.nil?
+      basic_type_check(:limit, limit, Integer)
+      params[:limit] = limit
+    end
+
+    cf_get(path: "#{uri_prefix}/virtual_dns/#{virtual_dns_id}/dns_analytics/report", params: params)
+  end
+end

data/lib/cloudflare_client/zone.rb

@@ -0,0 +1,129 @@
+class CloudflareClient
+  class Zone < CloudflareClient
+    require_relative './zone/base.rb'
+    Dir[File.expand_path('../zone/*.rb', __FILE__)].each { |f| require f }
+
+    VALID_ZONE_STATUSES = %w[active pending initializing moved deleted deactivated].freeze
+
+    ##
+    # Zone based operations
+    def initialize(*args)
+      super
+    end
+
+    ##
+    # list_zones will either list all zones or search for zones based on params
+    # results are paginated!
+    # list_zones(name: name_of_zone, status: active|pending, page: page_no)
+    def zones(name: nil, status: nil, per_page: 50, page: 1)
+      params            = {}
+      params[:per_page] = per_page
+      params[:page]     = page
+      params[:name]     = name unless name.nil?
+
+      unless status.nil?
+        raise "status must be one of #{VALID_ZONE_STATUSES.flatten}" unless VALID_ZONE_STATUSES.include?(status)
+        params[:status] = status
+      end
+
+      cf_get(path: '/zones', params: params)
+    end
+
+    ##
+    # create's a zone with a given name
+    # create_zone(name: name_of_zone, jump_start: true|false (default true),
+    # organization: {id: org_id, name: org_name})
+    def create_zone(name:, jump_start: true, organization: {id: nil, name: nil})
+      raise('Zone name required') if name.nil?
+      unless organization[:id].nil? && organization[:name].nil
+        org_data = organization.merge(status: 'active', permissions: ['#zones:read'])
+      end
+      data = {name: name, jump_start: jump_start, organization: org_data}
+      cf_post(path: '/zones', data: data)
+    end
+
+    ##
+    # request another zone activation (ssl) check
+    # zone_activation_check(zone_id:)
+    def zone_activation_check(zone_id:)
+      raise('zone_id required') if zone_id.nil?
+      cf_put(path: "/zones/#{zone_id}/activation_check")
+    end
+
+    ##
+    # return all the details for a given zone_id
+    # zone_details(zone_id: id_of_my_zone
+    def zone(zone_id:)
+      raise('zone_id required') if zone_id.nil?
+      cf_get(path: "/zones/#{zone_id}")
+    end
+
+    ##
+    # edit the properties of a zone
+    # NOTE: some of these options require an enterprise account
+    # edit_zone(zone_id: id_of_zone, paused: true|false,
+    # vanity_name_servers: ['ns1.foo.bar', 'ns2.foo.bar'], plan: {id: plan_id})
+    def edit_zone(zone_id:, paused: nil, vanity_name_servers: [], plan: {id: nil})
+      raise('zone_id required') if zone_id.nil?
+      data                       = {}
+      data[:paused]              = paused unless paused.nil?
+      data[:vanity_name_servers] = vanity_name_servers unless vanity_name_servers.empty?
+      data[:plan]                = plan unless plan[:id].nil?
+      cf_patch(path: "/zones/#{zone_id}", data: data)
+    end
+
+    ##
+    # various zone caching controlls.
+    # supploy an array of tags, or files, or the purge_everything bool
+    def purge_zone_cache(zone_id:, tags: [], files: [], purge_everything: nil)
+      raise('zone_id required') if zone_id.nil?
+      if purge_everything.nil? && (tags.empty? && files.empty?)
+        raise('specify a combination tags[], files[] or purge_everything')
+      end
+      data                    = {}
+      data[:purge_everything] = purge_everything unless purge_everything.nil?
+      data[:tags]             = tags unless tags.empty?
+      data[:files]            = files unless files.empty?
+      cf_delete(path: "/zones/#{zone_id}/purge_cache", data: data)
+    end
+
+    ##
+    # delete a given zone
+    # delete_zone(zone_id: id_of_zone
+    def delete_zone(zone_id:)
+      raise('zone_id required') if zone_id.nil?
+      cf_delete(path: "/zones/#{zone_id}")
+    end
+
+    ##
+    # return all settings for a given zone
+    def zone_settings(zone_id:)
+      raise('zone_id required') if zone_id.nil?
+      cf_get(path: "/zones/#{zone_id}/settings")
+    end
+
+    ##
+    # there are a lot of settings that can be returned.
+    def zone_setting(zone_id:, name:)
+      raise('zone_id required') if zone_id.nil?
+      raise('setting_name not valid') if name.nil? || !valid_setting?(name)
+      cf_get(path: "/zones/#{zone_id}/settings/#{name}")
+    end
+
+    ##
+    # update 1 or more settings in a zone
+    # settings: [{name: value: true},{name: 'value'}...]
+    # https://api.cloudflare.com/#zone-settings-properties
+    def update_zone_settings(zone_id:, settings: [])
+      raise('zone_id required') if zone_id.nil?
+      data = settings.map do |setting|
+        raise("setting_name \"#{setting[:name]}\" not valid") unless valid_setting?(setting[:name])
+        {id: setting[:name], value: setting[:value]}
+      end
+      data = {items: data}
+      cf_patch(path: "/zones/#{zone_id}/settings", data: data)
+    end
+
+    #TODO: zone_rate_plans
+  end
+end