cloudflair 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4669b1632efb2191777972709d0f9adfa5ed8aff
-  data.tar.gz: b196ca2d670f3d2aa0cb2ef04e72c43fd1952183
+SHA256:
+  metadata.gz: 966bf25156f0cedddd418a9b070227eb819e128984175fe2da2aaca46189da7a
+  data.tar.gz: 2da3f8e7083bc2534ef799125b57294521030581724dd6247327f8fb93b47195
 SHA512:
-  metadata.gz: c9d0d0bfc5784c16e1f7e2e35340da7851939db39a9fd93e1fd941d160751b68e0a58f7376f02bb85b1a02e7512639a8c3c8d54a2ceb7182380cb2c0bfc08bcb
-  data.tar.gz: 25bc5ddea914d14d5771dfe4ae0e3c4d75a4e79caa7ca71beb7031b1b331615bfe21e553116ce17be840c24236a1be6a15f79cf93300677ef481698ba3accee9
+  metadata.gz: de912a3e2901d8f4d70caf78fe489789953100b0afa83b19743ab9c648f3e7bf8674454a62db79d58e83163b7e9da54100ce01cb456a931de1380ac90ffb68e9
+  data.tar.gz: a36444251a1c61347f2c5990ac9ba749002cbba09e62be188a881a645ca30da4ddf43cbd8dbaadb77a3b421c57eabf5ced3789b45991d87c8ac9607da67eb8ea

data/.rubocop.yml

@@ -0,0 +1,38 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/**/*'
+  TargetRubyVersion: 2.6.1
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Metrics/BlockLength:
+  Exclude:
+    - Guardfile
+    - 'spec/**/*spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - Guardfile
+  Max: 110
+
+Rails:
+  Enabled: true
+
+Rails/HttpPositionalArguments:
+  Exclude:
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+cloudflair

data/.ruby-version

@@ -1 +1 @@
-2.3.4
+2.7.5

data/.travis.yml

@@ -9,3 +9,13 @@ notifications:
     on_success: never
   slack:
     secure: o1rlXNKZgQUIIfpzz//KpClcUS/ea5ECbbTaexQYHn84hqPNlsBdWhSrLg2s6MIJ1zSml4NBKQgwQJCV/6keel06XeNPvGPdQLVmSsBCWS4EJ/CvAAsXadghmSDYdsZlTaXvwa2ZdIaCHrM/SncZYi7I+KIiGsbV0KJgYVTlWGPWuN1kh3od1Ixw6W+TFUKONz8OqVFGo2yCr68zDtxUvrY8G/TNRRtWUINHPSIHL7+7JxzOtDZKOITptcLii8tmqi07HtmU7+78lDMlze8ejhchEDKoycTwVOQDRxjjLbDKZsV33nqG5XYRqW8FQv6zJ2c3eCfd2M2Lm+WkPe/ZBQ25Ok4/wK35T0oPt5lW6LKRNt202nQiI6vqn54489knOUpvA60z2r6taIgI3Os8kCdG8rX95Hob4gpU4zLqPNz26vqGiB0vz4DFSJWpRlYK15YT7SpEEMW2luPcTGHaclRSUFgjo/JkVH6zg+1rcMW4ZbKoxJZoNu+nmk9m1Xaz0r5tfJHBzB5XguRcKakRWkhb0rV4Nvo1as1PFtpxt9tiZsIXNTDNtf+upQeJs1Tevm6z4zBGXOIp//MIJEUyUkJ7Fkb+pyRbDOh30JSQJs0Z1y+/LA0rNkbQ+/jjeoKAepnFvawsXZF6UVWZxsBzAkIWTe+bwghnxX4Gm454RiI=
+deploy:
+  provider: rubygems
+  api_key:
+    secure: GisVn77etjRfIwmjsktJVFU182lSuZqbQBsb8jkMoBr0/01fE/tWpZHOMNnKU5JoIaaQAGA0F1w+OXk/eAldvWHbu++074/XcgGerMBV5kxhBOpKEaSu5/cxUfgtGIi2eBBS4xe+GEwtlkI08c6BCiX9pUuUn8LwuUvN7NLNd7nLnZhhnawAoG75aWoMXnudqbIoX/1kGIem8XMuugWwxcr7PsnBy43Mj3yYXmtbO5IW4LC1sDywYc3O/lHmC7hner5yFJSa3kCNN9IMEieRW8/bZAlu3HncfJoORha3tZq37Po/kV8OBuYMoHwxQouCnrh0OW3QNrsmFF+tTy8z132GDjOIaNHwKZyvtXHgfmq4KXdSU5dTlDR5U4Z7jFTbOifc1+UuU1B3RHMHsrqtJgb5ihoXAjtZI8JSjQ7aI+bX9aSt3OpELymuAzoW1mV/Rf4kuNq23jmgDKBEhnR6YdQ864pFGnPL00kPhMUQ+iVX4OFQMZ2/eayYuNGz1LV1WDfFoFSsinZtr/erNnziYJHuzULfFdVg7+ZGMkmLFl7RHiRlphrylW+IN0K+hKEaTDFJ/yVYlLvr/OakR2l4kiPlxfQPXAtmh4MRe1vJdyT3RlGha9qecPddGuzWw3kG8A8bJv9H15YaplHRsu8HryMH5Zt5Tup8cnN37kMrILg=
+  gem: cloudflair
+  on:
+    tags: true
+    repo: ninech/cloudflair
+    condition: "$TRAVIS_RUBY_VERSION == 2.4"
+  skip_cleanup: true

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cloudflair.gemspec

data/README.md

@@ -5,8 +5,6 @@
 
 A simple Ruby-wrapper around Cloudflare's v4 API.
 
-![Animation of Homer Simpson using of a rescue flare.](https://media.giphy.com/media/n8A8omwp1mVAA/giphy.gif)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -114,9 +112,10 @@ A good reference on how to use this wrapper are also the Rspecs.
 * `/zones/:zone_id/available_plans` GET
 * `/zones/:zone_id/available_plans/:plan_id` GET
 * `/zones/:zone_id/available_rate_plans`
+* `/zones/:zone_id/custom_hostnames` GET, POST, PATCH
 * `/zones/:zone_id/dns_records` GET, POST
 * `/zones/:zone_id/dns_records/:record_id` GET, DELETE (PUT not implemented)
-* `/zones/:zone_id/purge_cache` DELETE
+* `/zones/:zone_id/purge_cache` POST
 * `/zones/:zone_id/railguns` GET
 * `/zones/:zone_id/railguns/:railgun_id` GET
 * `/zones/:zone_id/railguns/:railgun_id/diagnose` GET, PATCH
@@ -180,8 +179,6 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## About
 
-This gem is currently maintained and funded by [nine.ch](https://nine.ch).
-
-[![nine.ch Logo](https://blog.nine.ch/assets/logo.png)](https://nine.ch)
+This gem is currently maintained and funded by [nine](https://nine.ch).
 
-We run your Linux server infrastructure – without interruptions, around the clock.
+[![logo of the company 'nine'](https://logo.apps.at-nine.ch/Dmqied_eSaoBMQwk3vVgn4UIgDo=/trim/500x0/logo_claim.png)](https://www.nine.ch)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/cloudflair.gemspec

@@ -1,14 +1,14 @@
-# coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cloudflair/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'cloudflair'
-  spec.version       = Cloudflair::VERSION
+  spec.version       = File.read('VERSION')
   spec.authors       = ['Christian Mäder']
-  spec.email         = %w(christian.maeder@nine.ch)
+  spec.email         = %w[christian.maeder@nine.ch]
 
   spec.summary       = "Wrapper to CloudFlare's v4 REST API."
   spec.description   = "Cloudflair aims to provide easy access to CloudFlare's public API."
@@ -22,15 +22,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
+  spec.add_runtime_dependency "dry-configurable", "> 0.12"
   spec.add_runtime_dependency 'faraday', '>= 0.10.0'
-  spec.add_runtime_dependency 'faraday_middleware'
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
   spec.add_runtime_dependency 'faraday-detailed_logger'
+  spec.add_runtime_dependency 'faraday_middleware'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'dotenv', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.48'
+  spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.15'
 end

data/lib/cloudflair/api/railguns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/analytics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/available_plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/available_rate_plan.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/custom_hostname.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'cloudflair/entity'
+
+module Cloudflair
+  class CustomHostname
+    include Cloudflair::Entity
+
+    attr_reader :zone_id, :custom_hostname_id
+    deletable true
+    patchable_fields :ssl, :custom_origin_server, :custom_metadata
+    path 'zones/:zone_id/custom_hostnames/:custom_hostname_id'
+
+    def initialize(zone_id, custom_hostname_id)
+      @zone_id = zone_id
+      @custom_hostname_id = custom_hostname_id
+    end
+  end
+end

data/lib/cloudflair/api/zone/dns_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair
@@ -6,6 +8,7 @@ module Cloudflair
 
     attr_reader :zone_id, :record_id
     deletable true
+    patchable_fields :content
     path 'zones/:zone_id/dns_records/:record_id'
 
     def initialize(zone_id, record_id)

data/lib/cloudflair/api/zone/purge_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/communication'
 
 module Cloudflair
@@ -13,7 +15,7 @@ module Cloudflair
     ##
     # @param purge_everything must be set to true
     def everything(purge_everything)
-      resp = connection.delete(path) { |req| req.body = { purge_everything: purge_everything } }
+      resp = connection.post(path) { |req| req.body = { purge_everything: purge_everything } }
       response resp
       self
     end
@@ -23,7 +25,7 @@ module Cloudflair
     def selective(cache_identifier = {})
       return self if cache_identifier.nil? || cache_identifier.empty?
 
-      resp = connection.delete(path) { |req| req.body = cache_identifier }
+      resp = connection.post(path) { |req| req.body = cache_identifier }
       response resp
       self
     end

data/lib/cloudflair/api/zone/railgun.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/advanced_ddos.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/always_online.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/browser_cache_ttl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/browser_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/cache_level.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/challenge_ttl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/development_mode.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/email_obfuscation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/hotlink_protection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/ip_geolocation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/ipv6.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/minify.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/mirage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/mobile_redirect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/origin_error_page_pass_thru.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/polish.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/prefetch_preload.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/response_buffering.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/rocket_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/security_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/security_level.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/server_side_exclude.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/sort_query_string_for_cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/ssl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/tls_1_2_only.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/tls_1_3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/tls_client_auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/true_client_ip_header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/waf.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings/websockets.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/entity'
 
 module Cloudflair

data/lib/cloudflair/api/zone/settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone/settings/advanced_ddos'
 require 'cloudflair/api/zone/settings/always_online'
 require 'cloudflair/api/zone/settings/browser_cache_ttl'
@@ -38,36 +40,36 @@ module Cloudflair
     end
 
     {
-      advanced_ddos: Cloudflair::AdvancedDdos,
-      always_online: Cloudflair::AlwaysOnline,
-      browser_cache_ttl: Cloudflair::BrowserCacheTtl,
-      browser_check: Cloudflair::BrowserCheck,
-      cache_level: Cloudflair::CacheLevel,
-      challenge_ttl: Cloudflair::ChallengeTtl,
-      development_mode: Cloudflair::DevelopmentMode,
-      email_obfuscation: Cloudflair::EmailObfuscation,
-      hotlink_protection: Cloudflair::HotlinkProtection,
-      ip_geolocation: Cloudflair::IpGeolocation,
-      ipv6: Cloudflair::Ipv6,
-      minify: Cloudflair::Minify,
-      mirage: Cloudflair::Mirage,
-      mobile_redirect: Cloudflair::MobileRedirect,
+      advanced_ddos:               Cloudflair::AdvancedDdos,
+      always_online:               Cloudflair::AlwaysOnline,
+      browser_cache_ttl:           Cloudflair::BrowserCacheTtl,
+      browser_check:               Cloudflair::BrowserCheck,
+      cache_level:                 Cloudflair::CacheLevel,
+      challenge_ttl:               Cloudflair::ChallengeTtl,
+      development_mode:            Cloudflair::DevelopmentMode,
+      email_obfuscation:           Cloudflair::EmailObfuscation,
+      hotlink_protection:          Cloudflair::HotlinkProtection,
+      ip_geolocation:              Cloudflair::IpGeolocation,
+      ipv6:                        Cloudflair::Ipv6,
+      minify:                      Cloudflair::Minify,
+      mirage:                      Cloudflair::Mirage,
+      mobile_redirect:             Cloudflair::MobileRedirect,
       origin_error_page_pass_thru: Cloudflair::OriginErrorPagePassThru,
-      polish: Cloudflair::Polish,
-      prefetch_preload: Cloudflair::PrefetchPreload,
-      response_buffering: Cloudflair::ResponseBuffering,
-      rocket_loader: Cloudflair::RocketLoader,
-      security_header: Cloudflair::SecurityHeader,
-      security_level: Cloudflair::SecurityLevel,
-      server_side_exclude: Cloudflair::ServerSideExclude,
+      polish:                      Cloudflair::Polish,
+      prefetch_preload:            Cloudflair::PrefetchPreload,
+      response_buffering:          Cloudflair::ResponseBuffering,
+      rocket_loader:               Cloudflair::RocketLoader,
+      security_header:             Cloudflair::SecurityHeader,
+      security_level:              Cloudflair::SecurityLevel,
+      server_side_exclude:         Cloudflair::ServerSideExclude,
       sort_query_string_for_cache: Cloudflair::SortQueryStringForCache,
-      ssl: Cloudflair::Ssl,
-      tls_client_auth: Cloudflair::TlsClientAuth,
-      tls_1_2_only: Cloudflair::Tls12Only,
-      tls_1_3: Cloudflair::Tls13,
-      true_client_ip_header: Cloudflair::TrueClientIpHeader,
-      waf: Cloudflair::Waf,
-      websockets: Cloudflair::Websockets,
+      ssl:                         Cloudflair::Ssl,
+      tls_client_auth:             Cloudflair::TlsClientAuth,
+      tls_1_2_only:                Cloudflair::Tls12Only,
+      tls_1_3:                     Cloudflair::Tls13,
+      true_client_ip_header:       Cloudflair::TrueClientIpHeader,
+      waf:                         Cloudflair::Waf,
+      websockets:                  Cloudflair::Websockets
     }.each do |method, klass|
       define_method method do
         klass.new @zone_id

data/lib/cloudflair/api/zone.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone/analytics'
 require 'cloudflair/api/zone/available_plan'
 require 'cloudflair/api/zone/available_rate_plan'
@@ -12,6 +14,7 @@ module Cloudflair
     require 'cloudflair/api/zone__dns_records'
     require 'cloudflair/api/zone__available_plans'
     require 'cloudflair/api/zone__railguns'
+    require 'cloudflair/api/zone__custom_hostnames'
 
     attr_reader :zone_id
 

data/lib/cloudflair/api/zone__available_plans.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone/available_plan'
 
 module Cloudflair

data/lib/cloudflair/api/zone__custom_hostnames.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'cloudflair/api/zone/custom_hostname'
+
+module Cloudflair
+  class Zone
+    def custom_hostnames(filter = {})
+      raw_hostnames = response connection.get("#{path}/custom_hostnames", filter)
+
+      raw_hostnames.map { |raw_hostname| build_custom_hostname(raw_hostname) }
+    end
+
+    def custom_hostname(custom_hostname_id)
+      Cloudflair::CustomHostname.new zone_id, custom_hostname_id
+    end
+
+    def new_custom_hostname(hostname_data)
+      raw_hostname = response connection.post("#{path}/custom_hostnames", hostname_data)
+
+      build_custom_hostname raw_hostname
+    end
+
+    private
+
+    def build_custom_hostname(raw_hostname)
+      hostname = custom_hostname raw_hostname['id']
+      hostname.data = raw_hostname
+      hostname
+    end
+  end
+end

data/lib/cloudflair/api/zone__dns_records.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone/dns_record'
 
 module Cloudflair
   class Zone
     def dns_records(filter = {})
       raw_records = response connection.get("#{path}/dns_records", filter)
-
       raw_records.map { |raw_record| build_dns_record(raw_record) }
     end
 
@@ -14,7 +15,6 @@ module Cloudflair
 
     def new_dns_record(record_data)
       raw_record = response connection.post("#{path}/dns_records", record_data)
-
       build_dns_record raw_record
     end
 

data/lib/cloudflair/api/zone__railguns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone/railgun'
 
 module Cloudflair

data/lib/cloudflair/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api/zone'
 require 'cloudflair/api/railguns'
 require 'cloudflair/communication'

data/lib/cloudflair/communication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/error/cloudflare_error'
 require 'cloudflair/error/cloudflair_error'
 require 'cloudflair/connection'
@@ -35,8 +37,9 @@ module Cloudflair
       body = response.body
 
       unless body['success']
-        fail Cloudflair::CloudflairError, "Unrecognized response format: '#{body}'" unless body['errors']
-        fail Cloudflair::CloudflareError, body['errors']
+        raise Cloudflair::CloudflairError, "Unrecognized response format: '#{body}'" unless body['errors']
+
+        raise Cloudflair::CloudflareError, body['errors']
       end
 
       body['result']
@@ -44,32 +47,32 @@ module Cloudflair
 
     def raise_on_http_error(status)
       case status
-      when 200..399 then
-      when 400..499 then
+      when 200..399
+      when 400..499
         raise_on_http_client_error status
-      when 500..599 then
-        fail Cloudflair::CloudflairError, "#{status} Remote Error"
+      when 500..599
+        raise Cloudflair::CloudflairError, "#{status} Remote Error"
       else
-        fail Cloudflair::CloudflairError, "#{status} Unknown Error Code"
+        raise Cloudflair::CloudflairError, "#{status} Unknown Error Code"
       end
     end
 
     def raise_on_http_client_error(status)
       case status
-      when 400 then
-        fail Cloudflair::CloudflairError, '400 Bad Request'
-      when 401 then
-        fail Cloudflair::CloudflairError, '401 Unauthorized'
-      when 403 then
-        fail Cloudflair::CloudflairError, '403 Forbidden'
-      when 405 then
-        fail Cloudflair::CloudflairError, '405 Method Not Allowed'
-      when 415 then
-        fail Cloudflair::CloudflairError, '415 Unsupported Media Type'
-      when 429 then
-        fail Cloudflair::CloudflairError, '429 Too Many Requests'
+      when 400
+        raise Cloudflair::CloudflairError, '400 Bad Request'
+      when 401
+        raise Cloudflair::CloudflairError, '401 Unauthorized'
+      when 403
+        raise Cloudflair::CloudflairError, '403 Forbidden'
+      when 405
+        raise Cloudflair::CloudflairError, '405 Method Not Allowed'
+      when 415
+        raise Cloudflair::CloudflairError, '415 Unsupported Media Type'
+      when 429
+        raise Cloudflair::CloudflairError, '429 Too Many Requests'
       else
-        fail Cloudflair::CloudflairError, "#{status} Request Error"
+        raise Cloudflair::CloudflairError, "#{status} Request Error"
       end
     end
 

data/lib/cloudflair/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday/detailed_logger'
@@ -7,25 +9,32 @@ module Cloudflair
   class Connection
     def self.new
       config = Cloudflair.config
-
       new_faraday_from config
     end
 
-    def self.headers
-      headers = {}
+    def self.headers # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       cloudflare_auth_config = Cloudflair.config.cloudflare.auth
-      if !(cloudflare_auth_config.key.nil? || cloudflare_auth_config.email.nil?)
-        headers['X-Auth-Key'] = cloudflare_auth_config.key
-        headers['X-Auth-Email'] = cloudflare_auth_config.email
-      elsif !cloudflare_auth_config.user_service_key.nil?
-        headers['X-Auth-User-Service-Key'] = cloudflare_auth_config.user_service_key
-      else
-        raise CloudflairError, 'Neither email & key nor user_service_key have been defined.'
+
+      if !cloudflare_auth_config.key.nil? && !cloudflare_auth_config.email.nil?
+        return({
+          'X-Auth-Key'   => cloudflare_auth_config.key,
+          'X-Auth-Email' => cloudflare_auth_config.email
+        })
       end
-      headers
+
+      unless cloudflare_auth_config.user_service_key.nil?
+        return({
+          'Authorization' => "Bearer #{cloudflare_auth_config.user_service_key}"
+        })
+      end
+
+      raise(
+        CloudflairError,
+        'Neither email & key nor user_service_key have been defined.'
+      )
     end
 
-    private_class_method def self.new_faraday_from(config)
+    private_class_method def self.new_faraday_from(config) # rubocop:disable Metrics/AbcSize
       Faraday.new(url: config.cloudflare.api_base_url, headers: headers) do |faraday|
         faraday.request :json
         faraday.response config.faraday.logger if config.faraday.logger

data/lib/cloudflair/entity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/communication'
 
 module Cloudflair
@@ -16,13 +18,14 @@ module Cloudflair
       def patchable_fields(*fields)
         return @patchable_fields if @patchable_fields
 
-        if fields.nil?
-          @patchable_fields = []
-        elsif fields.is_a?(Array)
-          @patchable_fields = fields.map(&:to_s)
-        else
-          @patchable_fields = [fields.to_s]
-        end
+        @patchable_fields =
+          if fields.nil?
+            []
+          elsif fields.is_a?(Array)
+            fields.map(&:to_s)
+          else
+            [fields.to_s]
+          end
       end
 
       def deletable(deletable = false)
@@ -34,7 +37,7 @@ module Cloudflair
       def path(path = nil)
         return @path if @path
 
-        fail ArgumentError, 'path is not defined' if path.nil?
+        raise ArgumentError, 'path is not defined' if path.nil?
 
         @path = path
       end
@@ -42,11 +45,12 @@ module Cloudflair
       def object_fields(*fields)
         return @object_fields if @object_fields
 
-        if fields.nil? || fields.empty?
-          @object_fields = []
-        else
-          @object_fields = fields.map(&:to_s)
-        end
+        @object_fields =
+          if fields.nil? || fields.empty?
+            []
+          else
+            fields.map(&:to_s)
+          end
       end
 
       # allowed values:
@@ -69,17 +73,17 @@ module Cloudflair
       end
 
       def turn_all_items_into_a_single_hash(fields_to_class_map)
-        fields_map = {}
-        fields_to_class_map.each do |field_definition|
-          if field_definition.is_a?(Hash)
-            fields_to_class_map[0].each do |field, klass_or_proc|
-              fields_map[field.to_s] = klass_or_proc
+        {}.tap do |fields_map|
+          fields_to_class_map.each do |field_definition|
+            if field_definition.is_a?(Hash)
+              fields_to_class_map[0].each do |field, klass_or_proc|
+                fields_map[field.to_s] = klass_or_proc
+              end
+            else
+              fields_map[field_definition.to_s] = nil
             end
-          else
-            fields_map[field_definition.to_s] = nil
           end
         end
-        fields_map
       end
     end
 
@@ -102,7 +106,7 @@ module Cloudflair
     end
 
     def delete
-      fail Cloudflair::CloudflairError, "Can't delete unless deletable=true" unless deletable
+      raise Cloudflair::CloudflairError, "Can't delete unless deletable=true" unless deletable
       return self if @deleted
 
       @data = response connection.delete path
@@ -126,27 +130,23 @@ module Cloudflair
     def method_missing(name_as_symbol, *args, &block)
       name = normalize_accessor name_as_symbol
 
-      return data if :_raw_data! == name_as_symbol
+      return data if name_as_symbol == :_raw_data!
 
       if name.end_with?('=')
         if patchable_fields.include?(name[0..-2])
           dirty_data[name[0..-2]] = args[0]
           return
-        else
-          super
         end
-      end
 
-      # allow access to the unmodified data using 'zone.always_string!' or 'zone._name!'
-      if name.end_with?('!') && data.keys.include?(name[0..-2])
-        return data[name[0..2]]
+        super
       end
 
+      # allow access to the unmodified data using 'zone.always_string!' or 'zone._name!'
+      return data[name[0..2]] if name.end_with?('!') && data.key?(name[0..-2])
       return objectify(name) if object_fields.include? name
-      return arrayify(name, array_object_fields[name]) if array_object_fields.keys.include? name
-
-      return dirty_data[name] if dirty_data.keys.include? name
-      return data[name] if data.is_a?(Hash) && data.keys.include?(name)
+      return arrayify(name, array_object_fields[name]) if array_object_fields.key?(name)
+      return dirty_data[name] if dirty_data.key?(name)
+      return data[name] if data.is_a?(Hash) && data.key?(name)
 
       super
     end
@@ -154,16 +154,13 @@ module Cloudflair
     def respond_to_missing?(name_as_symbol, *args)
       name = normalize_accessor name_as_symbol
 
-      return true if :_raw_data! == name_as_symbol
-
+      return true if name_as_symbol == :_raw_data!
       return true if name.end_with?('=') && patchable_fields.include?(name[0..-2])
-      return true if name.end_with?('!') && data.keys.include?(name[0..-2])
-
+      return true if name.end_with?('!') && data.key?(name[0..-2])
       return true if object_fields.include? name
-      return true if array_object_fields.keys.include? name
-
-      return true if dirty_data.keys.include? name
-      return true if data.is_a?(Hash) && data.keys.include?(name)
+      return true if array_object_fields.key?(name)
+      return true if dirty_data.key?(name)
+      return true if data.is_a?(Hash) && data.key?(name)
 
       super
     end
@@ -235,9 +232,11 @@ module Cloudflair
 
     def replace_path_variables_in(path)
       interpreted_path = path.clone
+
       path.scan(/:([a-zA-Z_][a-zA-Z0-9_]+[!?=]?)/) do |match, *|
-        interpreted_path.gsub! ":#{match}", send(match).to_s
+        interpreted_path = interpreted_path.gsub ":#{match}", send(match).to_s
       end
+
       interpreted_path
     end
 

data/lib/cloudflair/error/cloudflair_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cloudflair
   class CloudflairError < StandardError
   end

data/lib/cloudflair/error/cloudflare_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cloudflair
   class CloudflareError < StandardError
     attr_reader :cloudflare_errors

data/lib/cloudflair/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
+
 module Cloudflair
-    VERSION = '0.2.0'.freeze
 end

data/lib/cloudflair.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cloudflair/api'
 require 'cloudflair/version'
 require 'dry-configurable'
@@ -25,7 +27,7 @@ module Cloudflair
   extend Dry::Configurable
 
   setting :cloudflare do
-    setting :api_base_url, 'https://api.cloudflare.com/client/v4/'
+    setting :api_base_url, default: "https://api.cloudflare.com/client/v4/"
     setting :auth do
       setting :key
       setting :email
@@ -34,7 +36,7 @@ module Cloudflair
   end
 
   setting :faraday do
-    setting :adapter, :net_http
+    setting :adapter, default: :net_http
     setting :logger
   end
 end

metadata

@@ -1,59 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: cloudflair
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: faraday-detailed_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday-detailed_logger
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,33 +109,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0.48'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -159,12 +159,15 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- VERSION
 - bin/cloudflair
 - bin/console
 - bin/setup
@@ -176,6 +179,7 @@ files:
 - lib/cloudflair/api/zone/analytics.rb
 - lib/cloudflair/api/zone/available_plan.rb
 - lib/cloudflair/api/zone/available_rate_plan.rb
+- lib/cloudflair/api/zone/custom_hostname.rb
 - lib/cloudflair/api/zone/dns_record.rb
 - lib/cloudflair/api/zone/purge_cache.rb
 - lib/cloudflair/api/zone/railgun.rb
@@ -211,6 +215,7 @@ files:
 - lib/cloudflair/api/zone/settings/waf.rb
 - lib/cloudflair/api/zone/settings/websockets.rb
 - lib/cloudflair/api/zone__available_plans.rb
+- lib/cloudflair/api/zone__custom_hostnames.rb
 - lib/cloudflair/api/zone__dns_records.rb
 - lib/cloudflair/api/zone__railguns.rb
 - lib/cloudflair/communication.rb
@@ -239,8 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Wrapper to CloudFlare's v4 REST API.