cloudflair 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bf3b3a1ecdcf50e770990c51d35f6be706407a5
-  data.tar.gz: d9869e1e84f959ede37c7114bdbed44ccd159e5e
+  metadata.gz: 5f7b07b6a0fac5738b738c9297a932f101e3dc78
+  data.tar.gz: 4aaead028eefb8c1d2bdbe95bfc14f02076de102
 SHA512:
-  metadata.gz: 094b8be97ce303da51dcdc5b5a8cc8c337092733f50194437a38e872b5cee8c8d978a045317a6632c2125256f27ec4d0f3b10fe503e399e9e6b32c01ee335d99
-  data.tar.gz: cb78861951938689b65012148a9ed0837fe55e498337bef1d311eb4848d044cfe5306de7505ba5984f92aa34d3636d387295ca044429f2c540048489b5864960
+  metadata.gz: 46d9cbe6c1f217fc1cfbaa781340ab568653b00cd8fe0de0fbc43af9d235fb77495899772a8544e97af29f02781e8c77a47a70956f3c93cba115cf40a5d4e907
+  data.tar.gz: f24eda1248e1c86f68980f9eb08c83b06a676739cf47493207f9af999a6762d7a92276e569aa9c5e9d3f9cf1ad609d0dd23da7b14669f829b1288138a67b4279

data/README.md

@@ -1,6 +1,7 @@
 # Cloudflair
 
 [![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**
 
@@ -26,8 +27,13 @@ Or install it yourself as:
 
 ## Usage
 
+### Configuration
+
+Put this somewhere, where it runs, before any call to anything else of Cloudflair.
+If you are using Rails, then this would probably be somewhere beneath `/config`.
+
 ```ruby
-require "cloudflair"
+require 'cloudflair'
 Cloudflair.configure do |config|
   config.cloudflare.auth.key = 'YOUR_API_KEY'
   config.cloudflare.auth.email = 'YOUR_ACCOUNT_EMAIL'
@@ -40,9 +46,26 @@ Cloudflair.configure do |config|
 end
 ```
 
-TODO: Write usage instructions here
+### Call An API Endpoint
+
+This gem is organized along the URL schema of cloudflair.
+
+```ruby
+require 'cloudflair'
+
+# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').name
+# :=> "blog.example.com"
+
+# https://api.cloudflare.com/client/v4/zones/cd7d068de3012345da9420df9514dad0/settings/development_mode
+Cloudflair.zone('023e105f4ecef8ad9ca31a8372d0c353').settings.development_mode.value
+# :=> "on"
+# :=> "off"
+```
+
+You can use any field that Cloudflare's API returns. If a field is covered by some internal field, use `_field`. 
 
-Along the lines of `Cloudflair.new_connection.zone('zone_id').some_action`
+A good reference are also the specs.
 
 ## Development
 

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

@@ -1,3 +1,5 @@
+require 'cloudflair/communication'
+
 module Cloudflair
   class DevelopmentMode
     include Cloudflair::Communication

data/lib/cloudflair/communication.rb

@@ -1,5 +1,6 @@
 require 'cloudflair/error/cloudflare_error'
 require 'cloudflair/error/cloudflair_error'
+require 'cloudflair/connection'
 
 module Cloudflair
   module Communication

data/lib/cloudflair/version.rb

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

data/lib/cloudflair.rb

@@ -1,3 +1,6 @@
+require 'cloudflair/api/zone'
+require 'cloudflair/communication'
+require 'cloudflair/connection'
 require 'cloudflair/version'
 require 'dry-configurable'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflair
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Christian Mäder