cloudflair 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f7b07b6a0fac5738b738c9297a932f101e3dc78
-  data.tar.gz: 4aaead028eefb8c1d2bdbe95bfc14f02076de102
+  metadata.gz: 6af6e2d4ab47ef06e9cae85280c935cf7ccd30fe
+  data.tar.gz: e2bbcb00bd5a0d93713e16f02c29a6ff73737e35
 SHA512:
-  metadata.gz: 46d9cbe6c1f217fc1cfbaa781340ab568653b00cd8fe0de0fbc43af9d235fb77495899772a8544e97af29f02781e8c77a47a70956f3c93cba115cf40a5d4e907
-  data.tar.gz: f24eda1248e1c86f68980f9eb08c83b06a676739cf47493207f9af999a6762d7a92276e569aa9c5e9d3f9cf1ad609d0dd23da7b14669f829b1288138a67b4279
+  metadata.gz: cd498ded8ec3fb1093dd554063b5f79514e866a792beda3b27d401ced0e1b4d23f9f48f2c2742907902e5e4c2eeb53bf95f14bf0df99f1989f88b375afb67928
+  data.tar.gz: 73658e1f85c007d0ab71f55c2d83f84e0d51ef7df4f52e99bd0815653b5d6ea82c0ee3586914bcf4865756ef4f6ae9d0a3be3e2a80cd5bf07b2835e3cc7fe2f3

data/README.md

@@ -48,7 +48,7 @@ end
 
 ### Call An API Endpoint
 
-This gem is organized along the URL schema of cloudflair.
+This gem is organized along the URL schema of CloudFlare.
 
 ```ruby
 require 'cloudflair'

data/cloudflair.gemspec

@@ -21,12 +21,11 @@ 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 'faraday', ['~> 0.8.11']
-  spec.add_runtime_dependency 'faraday_middleware', ['~> 0.10.0']
-  spec.add_runtime_dependency 'dry-configurable', ['~> 0.1.7']
+  spec.add_runtime_dependency 'faraday', '~> 0.9.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
 
   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 'rubocop', '~> 0.44.1'
 end

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

@@ -0,0 +1,27 @@
+require 'cloudflair/communication'
+
+module Cloudflair
+  class PurgeCache
+    attr_reader :zone_id
+
+    include Cloudflair::Communication
+
+    def initialize(zone_id)
+      @zone_id = zone_id
+    end
+
+    def purge_all_files(purge_everything=false)
+
+    end
+
+    ##
+    # @param [Hash] cache_identifier Consists of :files and :tags, which are String Arrays themselves. Sample: <code>{files: ['https://foo.bar/index.htmll'], tags: ['css','js']}
+    def purge(cache_identifier = {})
+
+    end
+
+    def connection
+      Connection.new
+    end
+  end
+end

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

@@ -1,19 +1,21 @@
-require 'cloudflair/communication'
+require 'cloudflair/entity'
 
 module Cloudflair
   class DevelopmentMode
-    include Cloudflair::Communication
+    include Cloudflair::Entity
 
     attr_accessor :zone_id
 
     patchable_fields :value
 
-    def path
-      "/zones/#{zone_id}/settings/development_mode"
-    end
-
     def initialize(zone_id)
       @zone_id = zone_id
     end
+
+    private
+
+    def path
+      "zones/#{zone_id}/settings/development_mode"
+    end
   end
 end

data/lib/cloudflair/api/zone.rb

@@ -1,5 +1,5 @@
 require 'cloudflair/api/zone/settings'
-require 'cloudflair/communication'
+require 'cloudflair/entity'
 
 module Cloudflair
   def self.zone(zone_id)
@@ -7,11 +7,12 @@ module Cloudflair
   end
 
   class Zone
-    include Cloudflair::Communication
+    include Cloudflair::Entity
 
     attr_reader :zone_id
 
     patchable_fields :paused, :vanity_name_servers, :plan
+    deletable true
 
     def initialize(zone_id)
       @zone_id = zone_id
@@ -24,7 +25,7 @@ module Cloudflair
     private
 
     def path
-      "/zones/#{zone_id}"
+      "zones/#{zone_id}"
     end
   end
 end

data/lib/cloudflair/communication.rb

@@ -4,110 +4,6 @@ require 'cloudflair/connection'
 
 module Cloudflair
   module Communication
-    def self.included(other_klass)
-      other_klass.extend ClassMethods
-    end
-
-    module ClassMethods
-      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
-      end
-    end
-
-    def revert
-      dirty.clear
-    end
-
-    def reload
-      @data = get
-      revert
-      self
-    end
-
-    def patch
-      return self if dirty.empty?
-
-      @data = response connection.patch path, dirty
-      revert
-      self
-    end
-
-    def update(updated_fields)
-      checked_updated_fields = {}
-      updated_fields.each do |key, values|
-        s_key = normalize_accessor key
-
-        checked_updated_fields[s_key] = values if patchable_fields.include? s_key
-      end
-
-      dirty.merge! checked_updated_fields
-      patch
-    end
-
-    def method_missing(name_as_symbol, *args, &block)
-      name = normalize_accessor name_as_symbol
-
-      if name.end_with?('=')
-        if patchable_fields.include?(name[0..-2])
-          dirty[name[0..-2]] = args[0]
-          return
-        else
-          super
-        end
-      end
-
-      # allow access to the original data using 'zone.always_string!' or 'zone._name!'
-      if name.end_with?('!') && data.keys.include?(name[0..-2])
-        return data[name[0..2]]
-      end
-
-      return dirty[name] if dirty.keys.include? name
-      return data[name] if data.keys.include? name
-
-      super
-    end
-
-    def respond_to_missing?(name_as_symbol, *args)
-      name = normalize_accessor name_as_symbol
-
-      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 dirty.keys.include? name
-      return true if data.keys.include? name
-
-      super
-    end
-
-    alias get! reload
-    alias save patch
-
-    private
-
-    def normalize_accessor(symbol_or_string)
-      always_string = symbol_or_string.to_s
-
-      # allows access to remote data who's name conflicts with pre-defined methods
-      # e.g. write 'zone._zone_id' instead of 'zone.zone_id' to access the remote value of 'zone_id'
-      always_string.start_with?('_') ? always_string[1..-1] : always_string
-    end
-
-    def data
-      @data ||= get
-    end
-
-    def get
-      response connection.get path
-    end
-
     def response(response)
       body = response.body
 
@@ -119,16 +15,8 @@ module Cloudflair
       body['result']
     end
 
-    def dirty
-      @dirty ||= {}
-    end
-
     def connection
-      Connection.new
-    end
-
-    def patchable_fields
-      self.class.patchable_fields
+      Cloudflair::Connection.new
     end
   end
 end

data/lib/cloudflair/connection.rb

@@ -1,25 +1,27 @@
-class Connection
-  def self.new
-    config = Cloudflair.config
+module Cloudflair
+  class Connection
+    def self.new
+      config = Cloudflair.config
 
-    Faraday.new(url: config.cloudflare.api_base_url, headers: headers) do |faraday|
-      faraday.request  :url_encoded
-      faraday.response :logger
-      faraday.response :json, content_type: /\bjson$/
+      Faraday.new(url: config.cloudflare.api_base_url, headers: headers) do |faraday|
+        faraday.request :url_encoded
+        faraday.response :logger
+        faraday.response :json, content_type: /\bjson$/
 
-      faraday.adapter config.faraday.adapter || Faraday.default_adapter
+        faraday.adapter config.faraday.adapter || Faraday.default_adapter
+      end
     end
-  end
 
-  def self.headers
-    headers = {}
-    cloudflare_auth_config = Cloudflair.config.cloudflare.auth
-    if cloudflare_auth_config.user_service_key.nil?
-      headers['X-Auth-Key'] = cloudflare_auth_config.key
-      headers['X-Auth-Email'] = cloudflare_auth_config.email
-    else
-      headers['X-Auth-User-Service-Key'] = cloudflare_auth_config.user_service_key
+    def self.headers
+      headers = {}
+      cloudflare_auth_config = Cloudflair.config.cloudflare.auth
+      if cloudflare_auth_config.user_service_key.nil?
+        headers['X-Auth-Key'] = cloudflare_auth_config.key
+        headers['X-Auth-Email'] = cloudflare_auth_config.email
+      else
+        headers['X-Auth-User-Service-Key'] = cloudflare_auth_config.user_service_key
+      end
+      headers
     end
-    headers
   end
 end

data/lib/cloudflair/entity.rb

@@ -0,0 +1,139 @@
+require 'cloudflair/communication'
+
+module Cloudflair
+  module Entity
+    include Cloudflair::Communication
+
+    def self.included(other_klass)
+      other_klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      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
+      end
+
+      def deletable(deletable = false)
+        return @deletable unless @deletable.nil?
+
+        @deletable = deletable
+      end
+    end
+
+    def revert
+      dirty.clear
+    end
+
+    def reload
+      @data = get
+      revert
+      self
+    end
+
+    def patch
+      return self if dirty.empty?
+
+      @data = response connection.patch path, dirty
+      revert
+      self
+    end
+
+    def delete
+      fail Cloudflair::CloudflairError, "Can't delete unless deletable=true" unless deletable
+      return self if @deleted
+
+      @data = response connection.delete path
+      @deleted = true
+      revert
+      self
+    end
+
+    def update(updated_fields)
+      checked_updated_fields = {}
+      updated_fields.each do |key, values|
+        s_key = normalize_accessor key
+
+        checked_updated_fields[s_key] = values if patchable_fields.include? s_key
+      end
+
+      dirty.merge! checked_updated_fields
+      patch
+    end
+
+    def method_missing(name_as_symbol, *args, &block)
+      name = normalize_accessor name_as_symbol
+
+      if name.end_with?('=')
+        if patchable_fields.include?(name[0..-2])
+          dirty[name[0..-2]] = args[0]
+          return
+        else
+          super
+        end
+      end
+
+      # allow access to the original data using 'zone.always_string!' or 'zone._name!'
+      if name.end_with?('!') && data.keys.include?(name[0..-2])
+        return data[name[0..2]]
+      end
+
+      return dirty[name] if dirty.keys.include? name
+      return data[name] if data.keys.include? name
+
+      super
+    end
+
+    def respond_to_missing?(name_as_symbol, *args)
+      name = normalize_accessor name_as_symbol
+
+      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 dirty.keys.include? name
+      return true if data.keys.include? name
+
+      super
+    end
+
+    alias get! reload
+    alias save patch
+
+    private
+
+    def normalize_accessor(symbol_or_string)
+      always_string = symbol_or_string.to_s
+
+      # allows access to remote data who's name conflicts with pre-defined methods
+      # e.g. write 'zone._zone_id' instead of 'zone.zone_id' to access the remote value of 'zone_id'
+      always_string.start_with?('_') ? always_string[1..-1] : always_string
+    end
+
+    def data
+      @data ||= get
+    end
+
+    def get
+      response connection.get path
+    end
+
+    def patchable_fields
+      self.class.patchable_fields
+    end
+
+    def deletable
+      self.class.deletable
+    end
+
+    def dirty
+      @dirty ||= {}
+    end
+  end
+end

data/lib/cloudflair/version.rb

@@ -1,3 +1,3 @@
 module Cloudflair
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/cloudflair.rb

@@ -24,7 +24,7 @@ module Cloudflair
   extend Dry::Configurable
 
   setting :cloudflare do
-    setting :api_base_url, 'https://api.cloudflare.com'
+    setting :api_base_url, 'https://api.cloudflare.com/client/v4/'
     setting :auth do
       setting :key
       setting :email

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflair
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.44.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.44.1
 description: Cloudflair aims to provide easy access to CloudFlares public API.
 email:
 - christian.maeder@nine.ch
@@ -128,10 +114,12 @@ files:
 - cloudflair.gemspec
 - lib/cloudflair.rb
 - lib/cloudflair/api/zone.rb
+- lib/cloudflair/api/zone/purge_cache.rb
 - lib/cloudflair/api/zone/settings.rb
 - lib/cloudflair/api/zone/settings/development_mode.rb
 - lib/cloudflair/communication.rb
 - lib/cloudflair/connection.rb
+- lib/cloudflair/entity.rb
 - lib/cloudflair/error/cloudflair_error.rb
 - lib/cloudflair/error/cloudflare_error.rb
 - lib/cloudflair/version.rb