cloudflair 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67a0d783e6d7240e8f30e85be978a8627fe4c6b0
-  data.tar.gz: ec8881baddadb7e284d235a94c2f1652d2b06235
+  metadata.gz: 0640657c68c426446004505f4a0d6267f33fce54
+  data.tar.gz: f05ed55855749550cf313803694dcb098d957ae3
 SHA512:
-  metadata.gz: 24335795c9cb61c816efd5afa6d1e1e9ec915ce9642ad2601b6f0e65141fc13d4f3bad3f784f1e16ae032f65d8ce67e0f463dc5d8bc02074cb17779717a4cace
-  data.tar.gz: ff1fa5d1789e5db5c3c2dae30d556242b8e8b0b83f113b7359f8cbf76d293142ee0da42a6a9b72616c465c728580d0cdda39fde591112c42118693134c1e5d4d
+  metadata.gz: 4514e38db0d4502bbdebbd5fb6c6db83fd5b8c96a1251804c644ca416d7f817b1ea8d5e50c03fb8e08e8463bdfaf92878155dcd2fc246f8ef51a01ff80827eef
+  data.tar.gz: c68a2f703a277480ac68e34da528f27c7c59ceea93456a2eb73715eba8980045ec194616e66feac598400df73bd648937c66955043b6db81515627c6802eae45

data/README.md

@@ -3,9 +3,7 @@
 [![Build Status](https://travis-ci.org/ninech/cloudflair.svg?branch=master)](https://travis-ci.org/ninech/cloudflair)
 [![Gem Version](https://badge.fury.io/rb/cloudflair.svg)](https://badge.fury.io/rb/cloudflair)
 
-**UNDER CONSTRUCTION**
-
-A simple Ruby-wrapper around CloudFlare's v4 API.
+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)
 
@@ -50,11 +48,19 @@ end
 
 ### Call An API Endpoint
 
-This gem is organized along the URL schema of CloudFlare.
+This gem is organized along the URL schema of Cloudflare (as shown in the examples below). So you're good off to check the original Cloudflare [API documentation](https://api.cloudflare.com) for more information on the URL schema.
 
 ```ruby
 require 'cloudflair'
 
+# GET https://api.cloudflare.com/client/v4/railguns
+Cloudflair.railguns
+# => [...]
+
+# GET https://api.cloudflare.com/client/v4/zones
+Cloudflair.zones
+# => [...]
+
 # GET https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
 Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').name
 # => "blog.example.com"
@@ -73,11 +79,61 @@ end
 
 # GET https://api.cloudflare.com/client/v4/zones/023e105f4ecef8ad9ca31a8372d0c353/dns_records/372e67954025e0ba6aaa6d586b9e0b59
 Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').dns_record('372e67954025e0ba6aaa6d586b9e0b59').name
+# => "examples.com"
 ```
 
-You can use any field that Cloudflare's API returns. If a field is covered by some internal field, use `_field`. 
-
-A good reference are also the specs.
+You can use any field that Cloudflare's API returns. If a field is covered by some internal field, use `_field`. When you set a new value for a field and then want to access original value, you can use `field!` and `_field!`, respectively.
+
+A good reference on how to use this wrapper are also the Rspecs.
+
+## Implemented Endpoints
+
+* `/railguns` GET, POST
+* `/railguns/:railgun_id` GET, PATCH, DELETE
+* `/railguns/:railgun_id/zones` GET
+* `/zones` GET, POST
+* `/zones/:zone_id` GET, PATCH, DELETE
+* `/zones/:zone_id/analytics/dashboard` GET
+* `/zones/:zone_id/analytics/colos` GET
+* `/zones/:zone_id/available_plans` GET
+* `/zones/:zone_id/available_plans/:plan_id` GET
+* `/zones/:zone_id/available_rate_plans`
+* `/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/railguns` GET
+* `/zones/:zone_id/railguns/:railgun_id` GET
+* `/zones/:zone_id/railguns/:railgun_id/diagnose` GET, PATCH
+* `/zones/:zone_id/settings/advanced_ddos` GET
+* `/zones/:zone_id/settings/always_online` GET, PATCH
+* `/zones/:zone_id/settings/browser_cache_ttl` GET, PATCH
+* `/zones/:zone_id/settings/browser_check` GET, PATCH
+* `/zones/:zone_id/settings/cache_level` GET, PATCH
+* `/zones/:zone_id/settings/challenge_ttl` GET, PATCH
+* `/zones/:zone_id/settings/development_mode` GET, PATCH
+* `/zones/:zone_id/settings/email_obfuscation` GET, PATCH
+* `/zones/:zone_id/settings/hotlink_protection` GET, PATCH
+* `/zones/:zone_id/settings/ip_geolocation` GET, PATCH
+* `/zones/:zone_id/settings/ipv6` GET, PATCH
+* `/zones/:zone_id/settings/minify` GET, PATCH
+* `/zones/:zone_id/settings/mirage` GET, PATCH
+* `/zones/:zone_id/settings/mobile_redirect` GET, PATCH
+* `/zones/:zone_id/settings/origin_error_page_pass_thru` GET, PATCH
+* `/zones/:zone_id/settings/polish` GET, PATCH
+* `/zones/:zone_id/settings/prefetch_preload` GET, PATCH
+* `/zones/:zone_id/settings/response_buffering` GET, PATCH
+* `/zones/:zone_id/settings/rocket_loader` GET, PATCH
+* `/zones/:zone_id/settings/security_header` GET, PATCH
+* `/zones/:zone_id/settings/server_side_exclude` GET, PATCH
+* `/zones/:zone_id/settings/server_level` GET, PATCH
+* `/zones/:zone_id/settings/sort_query_string_for_cache` GET, PATCH
+* `/zones/:zone_id/settings/ssl` GET, PATCH
+* `/zones/:zone_id/settings/tls_1_2_only` GET, PATCH
+* `/zones/:zone_id/settings/tls_1_3` GET, PATCH
+* `/zones/:zone_id/settings/tls_client_auth` GET, PATCH
+* `/zones/:zone_id/settings/true_client_ip_header` GET, PATCH
+* `/zones/:zone_id/settings/waf` GET, PATCH
+* `/zones/:zone_id/settings/websockets` GET, PATCH
 
 ## Development
 
@@ -85,28 +141,27 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at [ninech/cloudflair](https://github.com/ninech/cloudflair).
-
-## License
+### Developing Guidelines
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+* The number one aim of this API wrapper is to mimic the Cloudflare API as it is laid out in the URL. So if the url is `/zones/:zone_id/analytics/dashboard`, then the corresponding Ruby code should become `Cloudflair.zones('abcdefg').analytics.dashboard`.
+* The API should load resources only when required to. So `Cloudflair.zones('abcdefg')` alone would not call out to Cloudflare, but only when `Cloudflair.zones('abcdefg').name` is called. Likewise, `Cloudflair.zones` will immediately call Cloudflare, as it requires the result immediately. (Unless we begin to introduce a kind of 'delayed Array'. Yet we probably don't want that.)
+* Adding additional wrappers for the API shall be easy and done in only a few minutes. (Most of the `/zones/:zone_id/settings/*` API calls were implemented in about five minutes.) So the cloudflair internal API should hide the complexity away. (E.g. the complexity of the fetching, parsing, error handling, etc. should be hidden away. See `Connection`, `Communication` and `Entity`, which contain almost all of the complexity of this Gem.)
+* Please write Rspecs for each new API endpoint. Use the JSON provided in the official Cloudflare API documentation as test data.
 
-## Roadmap
+## Contributing
 
-* ~~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
+Bug reports and pull requests are welcome on GitHub at [ninech/cloudflair](https://github.com/ninech/cloudflair).
 
 ### Whishlist
 
+* Full API support
 * Metrics reporting
 * Rate Limit Tracking
-* (Global) Rate Limit Tracking (redis?)
+* (Global/Distributed) Rate Limit Tracking
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ## About
 

data/bin/cloudflair

@@ -18,7 +18,5 @@ if ENV['CF_ZONE']
   end
 end
 
-#p.everything true
-
 require 'irb'
 IRB.start

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

@@ -37,7 +37,8 @@ module Cloudflair
       @zone_id = zone_id
     end
 
-    { advanced_ddos: Cloudflair::AdvancedDdos,
+    {
+      advanced_ddos: Cloudflair::AdvancedDdos,
       always_online: Cloudflair::AlwaysOnline,
       browser_cache_ttl: Cloudflair::BrowserCacheTtl,
       browser_check: Cloudflair::BrowserCheck,

data/lib/cloudflair/api/zone__dns_records.rb

@@ -2,7 +2,7 @@ require 'cloudflair/api/zone/dns_record'
 
 module Cloudflair
   class Zone
-    def dns_records(filter={})
+    def dns_records(filter = {})
       raw_records = response connection.get("#{path}/dns_records", filter)
 
       raw_records.map { |raw_record| build_dns_record(raw_record) }

data/lib/cloudflair/api/zone__railguns.rb

@@ -2,7 +2,7 @@ require 'cloudflair/api/zone/railgun'
 
 module Cloudflair
   class Zone
-    def railguns(filter={})
+    def railguns(filter = {})
       raw_railguns = response connection.get("#{path}/railguns", filter)
 
       raw_railguns.map do |raw_railgun|

data/lib/cloudflair/communication.rb

@@ -17,15 +17,16 @@ module Cloudflair
     end
 
     def hash_to_object(hash)
-      objectified = (Class.new).new
+      objectified_class = Class.new
+      objectified_instance = objectified_class.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)
+        variable_name = "_#{variable_name}" if objectified_instance.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}") }
+        objectified_instance.instance_variable_set("@#{variable_name}", v)
+        objectified_class.send :define_method, variable_name, proc { instance_variable_get("@#{variable_name}") }
       end
-      objectified
+      objectified_instance
     end
 
     private
@@ -73,7 +74,7 @@ module Cloudflair
     end
 
     def sanitize_variable_name(raw_name)
-      raw_name.gsub /[^a-zA-Z0-9_]/, '_'
+      raw_name.gsub(/[^a-zA-Z0-9_]/, '_')
     end
   end
 end

data/lib/cloudflair/connection.rb

@@ -20,7 +20,7 @@ module Cloudflair
       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.'
+        fail CloudflairError, 'Neither email & key nor user_service_key have been defined.'
       end
       headers
     end

data/lib/cloudflair/entity.rb

@@ -65,18 +65,23 @@ module Cloudflair
         if fields_to_class_map.nil? || fields_to_class_map.empty?
           @array_object_fields = {}
         else
-          fields_map = {}
-          fields_to_class_map.each do |field|
-            if field.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.to_s] = nil
+          fields_map = turn_all_items_into_a_single_hash(fields_to_class_map)
+          @array_object_fields = fields_map
+        end
+      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
             end
+          else
+            fields_map[field_definition.to_s] = nil
           end
-          @array_object_fields = fields_map
         end
+        fields_map
       end
     end
 
@@ -211,7 +216,8 @@ module Cloudflair
     def objectify(name)
       hash_to_object data[name]
     end
-    def arrayify(name, klass_or_proc=nil)
+
+    def arrayify(name, klass_or_proc = nil)
       data[name].map do |data|
         if klass_or_proc.nil?
           hash_to_object data

data/lib/cloudflair/error/cloudflare_error.rb

@@ -9,10 +9,12 @@ 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 ', '} ]"
+      if cloudflare_errors.empty?
+        '[ "An error happened, but no error message/code was given by CloudFlare." (Code: 0000) ]'
+      else
+        strings = cloudflare_errors.map { |error| "\"#{error['message']}\" (Code: #{error['code']})" }
+        "[ #{strings.join ', '} ]"
+      end
     end
   end
 end

data/lib/cloudflair/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudflair
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Christian Mäder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Wrapper to CloudFlare's v4 REST API.