cloudflair 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56fd1197bf91ccbbbc25632cc55246356689b74f
-  data.tar.gz: 77fc8bb524ef60c7a64e089799a3b32ed17b49b7
+  metadata.gz: 67a0d783e6d7240e8f30e85be978a8627fe4c6b0
+  data.tar.gz: ec8881baddadb7e284d235a94c2f1652d2b06235
 SHA512:
-  metadata.gz: cdf21b581458669d7c5a41df55ca8e9cd4f6547564e691af98afec05f86b45f9b77eff79b1fd5995679eba1946022a9ebba31a66a509dc52b3f6a0f4e28e94c3
-  data.tar.gz: e55e62b873549576a13b085afd5fbd0bb3fbf53f6e12091d009929d47e03bb00f16958a8ab72db69073cef116839956830b4c1a6de5ed9f8f91e960112fa8b03
+  metadata.gz: 24335795c9cb61c816efd5afa6d1e1e9ec915ce9642ad2601b6f0e65141fc13d4f3bad3f784f1e16ae032f65d8ce67e0f463dc5d8bc02074cb17779717a4cace
+  data.tar.gz: ff1fa5d1789e5db5c3c2dae30d556242b8e8b0b83f113b7359f8cbf76d293142ee0da42a6a9b72616c465c728580d0cdda39fde591112c42118693134c1e5d4d

data/README.md

@@ -55,14 +55,24 @@ This gem is organized along the URL schema of CloudFlare.
 ```ruby
 require 'cloudflair'
 
-# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
+# GET https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
 Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').name
-# :=> "blog.example.com"
+# => "blog.example.com"
 
-# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
+# GET https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
 Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').settings.development_mode.value
-# :=> "on"
-# :=> "off"
+# => "on"
+# => "off"
+
+# PATCH https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
+# {"value"="on"}
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').settings.development_mode.tap do |dm|
+  dm.value = 'on'
+  dm.save
+end
+
+# GET https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').dns_record('372e67954025e0ba6aaa6d586b9e0b59').name
 ```
 
 You can use any field that Cloudflare's API returns. If a field is covered by some internal field, use `_field`. 
@@ -85,11 +95,15 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Roadmap
 
-* Pull Zone Information
-* Zone Name to Zone ID Lookup
-* Developer Mode, Cache Purge, Selective Cache Purge
-* Airbrake error reporting
+* ~~Pull Zone Information~~ ✅
+* ~~Zone Name to Zone ID Lookup~~ ✅ 
+* ~~Developer Mode, Cache Purge, Selective Cache Purge~~ ✅
+* ~~Airbrake error reporting~~ ❌ (It's the responsibility of the application, not the Gem)
+* Full read-only `/zones` API support
 * Full API support
+
+### Whishlist
+
 * Metrics reporting
 * Rate Limit Tracking
 * (Global) Rate Limit Tracking (redis?)

data/bin/cloudflair

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cloudflair'
+require 'dotenv'
+
+Dotenv.load
+
+Cloudflair.configure do |c|
+  c.cloudflare.auth.key = ENV['AUTH_KEY']
+  c.cloudflare.auth.email = ENV['AUTH_MAIL']
+  c.faraday.logger = :detailed_logger
+end
+
+if ENV['CF_ZONE']
+  def z
+    @z ||= Cloudflair.zone ENV['CF_ZONE']
+  end
+end
+
+#p.everything true
+
+require 'irb'
+IRB.start

data/cloudflair.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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 CloudFlares public API.'
+  spec.description   = "Cloudflair aims to provide easy access to CloudFlare's public API."
   spec.homepage      = 'https://github.com/ninech/cloudflair'
   spec.license       = 'MIT'
 
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   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'
 end

data/lib/cloudflair/api/railguns.rb

@@ -0,0 +1,24 @@
+require 'cloudflair/entity'
+
+module Cloudflair
+  class Railguns
+    include Cloudflair::Entity
+
+    attr_reader :railgun_id
+    patchable_fields :enabled
+    deletable true
+    path 'railguns/:railgun_id'
+
+    def initialize(railgun_id)
+      @railgun_id = railgun_id
+    end
+
+    def zones
+      raw_response = connection.get "#{path}/zones"
+      parsed_responses = response raw_response
+      parsed_responses.map do |parsed_response|
+        hash_to_object parsed_response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'cloudflair/entity'
+
+module Cloudflair
+  class Analytics
+    include Cloudflair::Communication
+
+    def initialize(zone_id)
+      @path = "zones/#{zone_id}/analytics"
+    end
+
+    def dashboard(filter = {})
+      raw_response = connection.get "#{@path}/dashboard", filter
+      parsed_response = response raw_response
+      hash_to_object parsed_response
+    end
+
+    def colos(filter = {})
+      raw_response = connection.get "#{@path}/colos", filter
+      parsed_responses = response raw_response
+      parsed_responses.map do |parsed_response|
+        hash_to_object parsed_response
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'cloudflair/entity'
+
+module Cloudflair
+  class DnsRecord
+    include Cloudflair::Entity
+
+    attr_reader :zone_id, :record_id
+    deletable true
+    path 'zones/:zone_id/dns_records/:record_id'
+
+    def initialize(zone_id, record_id)
+      @zone_id = zone_id
+      @record_id = record_id
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'cloudflair/entity'
+
+module Cloudflair
+  class Railgun
+    include Cloudflair::Entity
+
+    attr_reader :zone_id, :railgun_id
+    patchable_fields :connected
+    path 'zones/:zone_id/railguns/:railgun_id'
+
+    def initialize(zone_id, railgun_id)
+      @zone_id = zone_id
+      @railgun_id = railgun_id
+    end
+
+    def diagnose
+      raw_response = connection.get "#{path}/diagnose"
+      parsed_response = response raw_response
+      hash_to_object parsed_response
+    end
+  end
+end

data/lib/cloudflair/api/zone.rb

@@ -1,3 +1,4 @@
+require 'cloudflair/api/zone/analytics'
 require 'cloudflair/api/zone/available_plan'
 require 'cloudflair/api/zone/available_rate_plan'
 require 'cloudflair/api/zone/purge_cache'
@@ -8,6 +9,10 @@ module Cloudflair
   class Zone
     include Cloudflair::Entity
 
+    require 'cloudflair/api/zone__dns_records'
+    require 'cloudflair/api/zone__available_plans'
+    require 'cloudflair/api/zone__railguns'
+
     attr_reader :zone_id
 
     patchable_fields :paused, :vanity_name_servers, :plan
@@ -31,14 +36,8 @@ module Cloudflair
       Cloudflair::AvailableRatePlan.new zone_id
     end
 
-    def available_plans
-      raw_plans = response connection.get("#{path}/available_plans")
-
-      raw_plans.map do |raw_plan|
-        zone = Cloudflair::AvailablePlan.new(zone_id, raw_plan['id'])
-        zone.data = raw_plan
-        zone
-      end
+    def analytics
+      Cloudflair::Analytics.new zone_id
     end
   end
 end

data/lib/cloudflair/api/zone__available_plans.rb

@@ -0,0 +1,19 @@
+require 'cloudflair/api/zone/available_plan'
+
+module Cloudflair
+  class Zone
+    def available_plans
+      raw_plans = response connection.get("#{path}/available_plans")
+
+      raw_plans.map do |raw_plan|
+        zone = available_plan raw_plan['id']
+        zone.data = raw_plan
+        zone
+      end
+    end
+
+    def available_plan(plan_id)
+      Cloudflair::AvailablePlan.new zone_id, plan_id
+    end
+  end
+end

data/lib/cloudflair/api/zone__dns_records.rb

@@ -0,0 +1,29 @@
+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
+
+    def dns_record(record_id)
+      Cloudflair::DnsRecord.new zone_id, record_id
+    end
+
+    def new_dns_record(record_data)
+      raw_record = response connection.post("#{path}/dns_records", record_data)
+
+      build_dns_record raw_record
+    end
+
+    private
+
+    def build_dns_record(raw_record)
+      record = dns_record raw_record['id']
+      record.data = raw_record
+      record
+    end
+  end
+end

data/lib/cloudflair/api/zone__railguns.rb

@@ -0,0 +1,19 @@
+require 'cloudflair/api/zone/railgun'
+
+module Cloudflair
+  class Zone
+    def railguns(filter={})
+      raw_railguns = response connection.get("#{path}/railguns", filter)
+
+      raw_railguns.map do |raw_railgun|
+        railgun = railgun raw_railgun['id']
+        railgun.data = raw_railgun
+        railgun
+      end
+    end
+
+    def railgun(railgun_id)
+      Cloudflair::Railgun.new zone_id, railgun_id
+    end
+  end
+end

data/lib/cloudflair/api.rb

@@ -1,4 +1,5 @@
 require 'cloudflair/api/zone'
+require 'cloudflair/api/railguns'
 require 'cloudflair/communication'
 
 module Cloudflair
@@ -9,7 +10,7 @@ module Cloudflair
   end
 
   def self.zones(filter = {})
-    raw_zones = response connection.get('zones', filter)
+    raw_zones = response connection.get 'zones', filter
 
     raw_zones.map do |raw_zone|
       zone = Zone.new(raw_zone['id'])
@@ -17,4 +18,18 @@ module Cloudflair
       zone
     end
   end
+
+  def self.railgun(railgun_id)
+    Railguns.new railgun_id
+  end
+
+  def self.railguns(filter = {})
+    raw_railguns = response connection.get 'railguns', filter
+
+    raw_railguns.map do |raw_railgun|
+      railgun = Railguns.new(raw_railgun['id'])
+      railgun.data = raw_railgun
+      railgun
+    end
+  end
 end

data/lib/cloudflair/communication.rb

@@ -16,6 +16,18 @@ module Cloudflair
       Cloudflair::Connection.new
     end
 
+    def hash_to_object(hash)
+      objectified = (Class.new).new
+      hash.each do |k, v|
+        variable_name = sanitize_variable_name(k)
+        variable_name = "_#{variable_name}" if objectified.methods.map(&:to_s).include?(variable_name)
+
+        objectified.instance_variable_set("@#{variable_name}", v)
+        objectified.class.send :define_method, variable_name, proc { self.instance_variable_get("@#{variable_name}") }
+      end
+      objectified
+    end
+
     private
 
     def read(response)
@@ -59,5 +71,9 @@ module Cloudflair
         fail Cloudflair::CloudflairError, "#{status} Request Error"
       end
     end
+
+    def sanitize_variable_name(raw_name)
+      raw_name.gsub /[^a-zA-Z0-9_]/, '_'
+    end
   end
 end

data/lib/cloudflair/connection.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday/detailed_logger'
+require 'cloudflair/error/cloudflair_error'
 
 module Cloudflair
   class Connection
@@ -13,11 +14,13 @@ module Cloudflair
     def self.headers
       headers = {}
       cloudflare_auth_config = Cloudflair.config.cloudflare.auth
-      if cloudflare_auth_config.user_service_key.nil?
+      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
-      else
+      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.'
       end
       headers
     end

data/lib/cloudflair/entity.rb

@@ -211,16 +211,6 @@ module Cloudflair
     def objectify(name)
       hash_to_object data[name]
     end
-
-    def hash_to_object(hash)
-      objectified = Class.new
-      hash.each do |k, v|
-        objectified.instance_variable_set("@#{k}", v)
-        objectified.class.send(:define_method, k, proc { self.instance_variable_get("@#{k}") })
-      end
-      objectified
-    end
-
     def arrayify(name, klass_or_proc=nil)
       data[name].map do |data|
         if klass_or_proc.nil?

data/lib/cloudflair/error/cloudflare_error.rb

@@ -9,6 +9,8 @@ module Cloudflair
     end
 
     def to_s
+      return '[ "An error happened, but no error message/code was given by CloudFlare." (Code: 0000) ]' if cloudflare_errors.empty?
+
       strings = cloudflare_errors.map { |cf_e| "\"#{cf_e[:message]}\" (Code: #{cf_e[:code]})" }
       "[ #{strings.join ', '} ]"
     end

data/lib/cloudflair/version.rb

@@ -1,3 +1,3 @@
 module Cloudflair
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflair
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,7 +108,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Cloudflair aims to provide easy access to CloudFlares public API.
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Cloudflair aims to provide easy access to CloudFlare's public API.
 email:
 - christian.maeder@nine.ch
 executables: []
@@ -123,15 +137,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cloudflair
 - bin/console
 - bin/setup
 - cloudflair.gemspec
 - lib/cloudflair.rb
 - lib/cloudflair/api.rb
+- lib/cloudflair/api/railguns.rb
 - lib/cloudflair/api/zone.rb
+- 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/dns_record.rb
 - lib/cloudflair/api/zone/purge_cache.rb
+- lib/cloudflair/api/zone/railgun.rb
 - lib/cloudflair/api/zone/settings.rb
 - lib/cloudflair/api/zone/settings/advanced_ddos.rb
 - lib/cloudflair/api/zone/settings/always_online.rb
@@ -163,6 +182,9 @@ files:
 - lib/cloudflair/api/zone/settings/true_client_ip_header.rb
 - 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__dns_records.rb
+- lib/cloudflair/api/zone__railguns.rb
 - lib/cloudflair/communication.rb
 - lib/cloudflair/connection.rb
 - lib/cloudflair/entity.rb