cloudflair 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bf3b3a1ecdcf50e770990c51d35f6be706407a5
+  data.tar.gz: d9869e1e84f959ede37c7114bdbed44ccd159e5e
+SHA512:
+  metadata.gz: 094b8be97ce303da51dcdc5b5a8cc8c337092733f50194437a38e872b5cee8c8d978a045317a6632c2125256f27ec4d0f3b10fe503e399e9e6b32c01ee335d99
+  data.tar.gz: cb78861951938689b65012148a9ed0837fe55e498337bef1d311eb4848d044cfe5306de7505ba5984f92aa34d3636d387295ca044429f2c540048489b5864960

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format progress
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+notifications:
+  email:
+    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=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudflair.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian Mäder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Cloudflair
+
+[![Build Status](https://travis-ci.org/ninech/cloudflair.svg?branch=master)](https://travis-ci.org/ninech/cloudflair)
+
+**UNDER CONSTRUCTION**
+
+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:
+
+```ruby
+gem 'cloudflair'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloudflair
+
+## Usage
+
+```ruby
+require "cloudflair"
+Cloudflair.configure do |config|
+  config.cloudflare.auth.key = 'YOUR_API_KEY'
+  config.cloudflare.auth.email = 'YOUR_ACCOUNT_EMAIL'
+  # if you have a user_service_key, you don't need auth.key and auth.email
+  config.cloudflare.auth.user_service_key = 'YOUR_USER_SERVICE_KEY'
+
+  # these are optional:
+  config.cloudflare.api_base_url = 'https://your_cloudflare_mock.local'
+  config.faraday.adapter = :your_preferred_faraday_adapter
+end
+```
+
+TODO: Write usage instructions here
+
+Along the lines of `Cloudflair.new_connection.zone('zone_id').some_action`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Roadmap
+
+* Pull Zone Information
+* Zone Name to Zone ID Lookup
+* Developer Mode, Cache Purge, Selective Cache Purge
+* Airbrake error reporting
+* Full API support
+* Metrics reporting
+* Rate Limit Tracking
+* (Global) Rate Limit Tracking (redis?)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cloudflair'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloudflair.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.authors       = ['Christian Mäder']
+  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.homepage      = 'https://github.com/ninech/cloudflair'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  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_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/settings/development_mode.rb

@@ -0,0 +1,17 @@
+module Cloudflair
+  class DevelopmentMode
+    include Cloudflair::Communication
+
+    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
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'cloudflair/api/zone/settings/development_mode'
+
+module Cloudflair
+  class Settings
+    attr_reader :zone_id
+
+    def initialize(zone_id)
+      @zone_id = zone_id
+    end
+
+    def development_mode
+      Cloudflair::DevelopmentMode.new @zone_id
+    end
+  end
+end

data/lib/cloudflair/api/zone.rb

@@ -0,0 +1,30 @@
+require 'cloudflair/api/zone/settings'
+require 'cloudflair/communication'
+
+module Cloudflair
+  def self.zone(zone_id)
+    Zone.new zone_id
+  end
+
+  class Zone
+    include Cloudflair::Communication
+
+    attr_reader :zone_id
+
+    patchable_fields :paused, :vanity_name_servers, :plan
+
+    def initialize(zone_id)
+      @zone_id = zone_id
+    end
+
+    def settings
+      @settings ||= Cloudflair::Settings.new zone_id
+    end
+
+    private
+
+    def path
+      "/zones/#{zone_id}"
+    end
+  end
+end

data/lib/cloudflair/communication.rb

@@ -0,0 +1,133 @@
+require 'cloudflair/error/cloudflare_error'
+require 'cloudflair/error/cloudflair_error'
+
+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
+
+      unless body['success']
+        fail Cloudflair::CloudflairError, "Unrecognized response format: '#{body}'" unless body['errors']
+        fail Cloudflair::CloudflareError, body['errors']
+      end
+
+      body['result']
+    end
+
+    def dirty
+      @dirty ||= {}
+    end
+
+    def connection
+      Connection.new
+    end
+
+    def patchable_fields
+      self.class.patchable_fields
+    end
+  end
+end

data/lib/cloudflair/connection.rb

@@ -0,0 +1,25 @@
+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.adapter config.faraday.adapter || Faraday.default_adapter
+    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
+    end
+    headers
+  end
+end

data/lib/cloudflair/error/cloudflair_error.rb

@@ -0,0 +1,4 @@
+module Cloudflair
+  class CloudflairError < StandardError
+  end
+end

data/lib/cloudflair/error/cloudflare_error.rb

@@ -0,0 +1,16 @@
+module Cloudflair
+  class CloudflareError < StandardError
+    attr_reader :cloudflare_errors
+
+    def initialize(cloudflare_errors)
+      @cloudflare_errors = cloudflare_errors
+
+      super(to_s)
+    end
+
+    def to_s
+      strings = cloudflare_errors.map { |cf_e| "\"#{cf_e[:message]}\" (Code: #{cf_e[:code]})" }
+      "[ #{strings.join ', '} ]"
+    end
+  end
+end

data/lib/cloudflair/version.rb

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

data/lib/cloudflair.rb

@@ -0,0 +1,35 @@
+require 'cloudflair/version'
+require 'dry-configurable'
+
+##
+# To configure cloudflair
+# <code>
+# require "cloudflair"
+# Cloudflair.configure do |config|
+#   config.cloudflare.auth.key = 'YOUR_API_KEY'
+#   config.cloudflare.auth.email = 'YOUR_ACCOUNT_EMAIL'
+#   # if you have a user_service_key, you don't need auth.key and auth.email
+#   config.cloudflare.auth.user_service_key = 'YOUR_USER_SERVICE_KEY'
+#
+#   # these are optional:
+#   config.cloudflare.api_base_url = 'https://your_cloudflare_mock.local'
+#   config.faraday.adapter = :your_preferred_faraday_adapter
+# end
+# </code>
+module Cloudflair
+  # Your code goes here...
+  extend Dry::Configurable
+
+  setting :cloudflare do
+    setting :api_base_url, 'https://api.cloudflare.com'
+    setting :auth do
+      setting :key
+      setting :email
+      setting :user_service_key
+    end
+  end
+
+  setting :faraday do
+    setting :adapter, :net_http
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: cloudflair
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Mäder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.11
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudflair.gemspec
+- lib/cloudflair.rb
+- lib/cloudflair/api/zone.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/error/cloudflair_error.rb
+- lib/cloudflair/error/cloudflare_error.rb
+- lib/cloudflair/version.rb
+homepage: https://github.com/ninech/cloudflair
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wrapper to CloudFlare's v4 REST API.
+test_files: []