cloudflarer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a2f6e43fc361748b241c9769ea1d877510f30d3
+  data.tar.gz: e860c81fb5006e1121e97af88e242e17900c8590
+SHA512:
+  metadata.gz: 84594eb4febe34ee17e52b484b824dfb348f61066fb8ac0b2138e186efce4f9dbeda996b5a2af6cbe1fee467030f2e92af04a6a8c4824b36b1c3d6a043ea9800
+  data.tar.gz: 30d684fdd488b0c749a0f5dd1c75574b8d84c193db429bc24e81074ada488ce224248862b435b2d77f809419e4833dff3db8d6d90a03f5fcf52e09ce049fbf50

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jj@bjjb.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 JJ Buckley
+
+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,58 @@
+# Cloudflarer
+
+A Ruby API client and library for [Cloudflare][].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cloudflarer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloudflarer
+
+## Usage
+
+For help with the command-line interface, just run
+
+    cloudflarer --help
+
+once the gem is installed.
+
+The [API][] (v4) is documented by Cloudflare.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake test` 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
+https://github.com/bjjb/cloudflarer. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+
+[Cloudflare]: https://cloudflare.com
+[API]: https://api.cloudflare.com

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cloudflarer'
+
+# 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/cloudflarer.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudflarer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cloudflarer'
+  spec.version       = Cloudflarer::VERSION
+  spec.authors       = ['JJ Buckley']
+  spec.email         = ['jj@bjjb.org']
+
+  spec.summary       = 'A Ruby/Cloudflare CLI/API-client'
+  spec.description   = <<-DESC
+A Ruby API library for managing your cloudflare domains and settings. Comes
+with a simple command-line tool.
+DESC
+  spec.homepage      = "http://bjjb.gitlab.com/cloudflarer"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9.2'
+  spec.add_dependency 'hipsterhash', '>= 0.0.4'
+  spec.add_dependency 'ordu', '>= 0.0.4'
+  spec.add_dependency 'mustache', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/exe/cloudflarer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cloudflarer/cli'
+
+Cloudflarer::CLI.parse!(ARGV)

data/lib/cloudflarer.rb

@@ -0,0 +1,12 @@
+# A library to help manage your Cloudflare domains and settings.
+module Cloudflarer
+  autoload :VERSION, 'cloudflarer/version'
+  autoload :API_VERSION, 'cloudflarer/version'
+  autoload :Client, 'cloudflarer/client'
+  autoload :YAML, 'yaml'
+  autoload :Pathname, 'pathname'
+
+  def self.new(*args)
+    Client.new(*args)
+  end
+end

data/lib/cloudflarer/cli.rb

@@ -0,0 +1,230 @@
+require 'ordu'
+require 'cloudflarer'
+require 'yaml'
+require 'mustache'
+
+module Cloudflarer
+  class CLI < Ordu
+    option('-h', '--help', 'show this message') do
+      puts to_s
+      exit
+    end
+    option('-k', '--api-key API_KEY', 'specify the API key') do |key|
+      CLOUDFLARE_API_KEY = key
+    end
+    option('-e', '--email EMAIL', 'specify the Cloudflare Email') do |email|
+      CLOUDFLARE_EMAIL = email
+    end
+    option('-v', '--[no-]verbose', 'print request/response') do |v|
+      $verbose = v
+    end
+    option('-q', '--[no-]quiet', 'print less information') do |q|
+      $quiet = q
+    end
+    option('-D', '--[no-]debug', 'print lots of internal info') do |d|
+      $debug = d
+    end
+    option('-V', '--version', 'show the version number') do |v|
+      puts "Cloudflarer v#{Cloudflarer::VERSION}"
+      puts "Cloudflare API version #{Cloudflarer::API_VERSION}"
+      exit
+    end
+    option('-f', '--format FMT', 'specify output format') { |f| template(f) }
+    command 'user', 'manage your user' do
+      command 'update', 'change user properties' do
+        option('--first_name NAME', 'First name') { |v| set(first_name: v) }
+        option('--last_name NAME', 'Last name') { |v| set(last_name: v) }
+        option('--telephone PHONE', 'Telephone') { |v| set(telephone: v) }
+        option('--country ISO', 'Country') { |v| set(country: v) }
+        option('--zipcode ZIP', 'Zipcode') { |v| set(zipcode: v) }
+        action { update('user') }
+      end
+
+      action { show('user') }
+    end
+
+    command 'zones', 'manage your zones' do
+      command 'show', 'show a zone' do
+        action do |*ids|
+          die("You need to specify the zone ID") if ids.empty?
+          ids.each { |z| show("zones/#{z}") }
+        end
+      end
+      command 'create', 'create a zone' do
+        option('--[no-]jump_start', 'auto-fetch DNS records') do |j|
+          set(:jump_start, j)
+        end
+        option('--name DOMAIN', 'domain name') { |v| set(name: v) }
+        action { |name| post('zones' ) }
+      end
+      action { list('zones') }
+    end
+
+    command 'records', 'manage DNS records' do
+      option('-z', '--zone ID', 'specify the zone') { |z| set(zone: z) }
+      command 'show', 'show a DNS record' do
+        action do |*ids|
+          die("You need to specify the record ID") if ids.empty?
+          template('{{id}} {{type}} {{name}} {{content}}')
+          zone { |z| ids.each { |r| show("zones/#{z}/dns_records/#{r}") } }
+        end
+      end
+      command 'create', 'create a new DNS record' do
+        option('-z', '--zone ID', 'specify the zone') { |z| set(zone: z) }
+        option('--type TYPE', 'DNS record type') { |v| set(type: v) }
+        option('--name NAME', 'DNS record name') { |v| set(name: v) }
+        option('--content ADDR', 'DNS record content') { |v| set(content: v) }
+        action do
+          zone { |z| create("zones/#{z}/dns_records") }
+        end
+      end
+      command 'delete', 'delete a DNS record' do
+        option('-z', '--zone ID', 'specify the zone') { |z| set(zone: z) }
+        action do |*ids|
+          die('You need to specify te record ID') if ids.empty?
+          zone { |z| ids.each { |r| destroy("zones/#{z}/dns_records/#{r}") } }
+        end
+      end
+
+      action do
+        template('{{id}} {{type}} {{name}} {{content}}')
+        zone { |z| show("zones/#{z}/dns_records") }
+      end
+    end
+
+    # Yields the zone popped from the params, or dies
+    def zone(&block)
+      @zone ||= params.delete(:zone)
+      die('You need to specify the zone (-z)') unless @zone
+      yield @zone
+    end
+
+    # A place to gather params for queries
+    def params
+      @params ||= {}
+    end
+
+    # Sets a param for a query (used by options)
+    def set(params = {})
+      self.params.merge!(params)
+    end
+
+    # Creates a record (using params)
+    def create(path)
+      output { post(path, params) }
+    end
+
+    # Updates a record (using params)
+    def update(path)
+      output { patch(path, params) }
+    end
+
+    # Gets and shows a single resource
+    def show(path)
+      output { get(path) }
+    end
+
+    # Deletes and shows a resource
+    def destroy(path)
+      output { delete(path) }
+    end
+      
+    # Gets and lists multiple resources
+    def list(path)
+      output { get(path) }
+    end
+
+    # Gets a resource
+    def get(path)
+      time("GET #{path}") { Cloudflarer.new.get(path) }
+    end
+
+    # Updates a resource (using params)
+    def patch(path, params)
+      time("PATCH #{path}") { Cloudflarer.new.patch(path, params) }
+    end
+
+    # Creates a resource (using params)
+    def post(path, params)
+      time("POST #{path}") { Cloudflarer.new.post(path, params) }
+    end
+
+    # Destroys a resource
+    def delete(path)
+      time("DELETE #{path}") { Cloudflarer.new.delete(path) }
+    end
+
+    # Times the block, which should return something with a status
+    def time(msg, &block)
+      return(yield) unless $verbose
+      print "#{msg}..."
+      t = Time.now.to_f
+      response = yield
+      print "(%0.2f ms) " % (Time.now.to_f - t)
+      if info = response['result_info']
+        print "[%s/%s/%s/%s] " %
+          info.values_at(*%w(page per_page count total_count)).map(&:to_s)
+      end
+      puts "OK" if response.fetch('success')
+      puts "FAIL" unless response.fetch('success')
+      response
+    end
+
+    # Gets the formatter
+    def format(&block)
+      object = yield
+      return object if object.is_a?(String)
+      return object.to_yaml if template == 'yaml'
+      return object.to_json if template == 'json'
+      return render(template, object) if template.is_a?(String)
+      return tablualte { yield } if template.nil?
+      raise "Invalid template: #{template}"
+    end
+
+    # Gets the template with which to present the object
+    def template(template = nil)
+      $template ||= template
+      $template || '{{id}} {{name}}'
+    end
+
+    # Renders the given object through the Mustache template
+    def render(template, object)
+      return object.map { |o| render(template, o) } if object.is_a?(Array)
+      Mustache.render(template, object)
+    end
+
+    # Filters results, if required. Currently doesn't do anything.
+    def filter(&block)
+      result = yield
+      return result.map { |o| filter { o } } if result.is_a?(Array)
+      result
+    end
+
+    # Outputs in the format requested
+    def output(&block)
+      response = yield
+      if response.fetch('success')
+        puts format { filter { response.fetch('result') } }
+      else
+        puts format { response.fetch('error') }
+      end
+    end
+
+    # Print the result of the block, if $debug is on
+    def debug(msg, &block)
+      result = yield
+      puts "-- #{msg} #{'-' * (74 - msg.length)}" if $debug
+      result
+    end
+
+    # Print the message to STDERR and exit (non-zero)
+    def die(msg, code = 1)
+      STDERR.puts msg
+      exit code
+    end
+  end
+end
+
+if __FILE__ == $0
+  Cloudflarer::CLI.parse!(ARGV)
+end

data/lib/cloudflarer/client.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'json'
+require 'hipsterhash'
+
+module Cloudflarer
+  class Client
+    API_VERSION = 'v4'.freeze
+    HOST = 'api.cloudflare.com'.freeze
+    PATH = "/client/#{API_VERSION}".freeze
+    URL = "https://#{HOST}#{PATH}".freeze
+
+    def initialize(api_key: nil, email: nil)
+      api_key ||= ENV['CLOUDFLARE_API_KEY']
+      raise ArgumentError, "API Key is required." unless api_key
+      email ||= ENV['CLOUDFLARE_EMAIL']
+      raise ArgumentError, "Email is required" unless email
+      headers = { 
+        'X-Auth-Key' => api_key,
+        'X-Auth-Email' => email,
+        'Content-Type': 'application/json'
+      }
+      @connection = Faraday.new(URL, headers: headers)
+    end
+
+    %i(get head delete options).each do |verb|
+      define_method verb do |path|
+        respond { @connection.public_send(verb, path) }
+      end
+    end
+
+    %i(put post patch).each do |verb|
+      define_method verb do |path, data={}|
+        respond { @connection.public_send(verb, path, data.to_json) }
+      end
+    end
+
+    private
+
+    def respond(&block)
+      JSON.parse(yield.body)
+    end
+
+    Error = Class.new(Exception)
+  end
+end

data/lib/cloudflarer/version.rb

@@ -0,0 +1,4 @@
+module Cloudflarer
+  VERSION = '0.0.1'.freeze
+  API_VERSION = '4'.freeze
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: cloudflarer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JJ Buckley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: hipsterhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: ordu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  A Ruby API library for managing your cloudflare domains and settings. Comes
+  with a simple command-line tool.
+email:
+- jj@bjjb.org
+executables:
+- cloudflarer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudflarer.gemspec
+- exe/cloudflarer
+- lib/cloudflarer.rb
+- lib/cloudflarer/cli.rb
+- lib/cloudflarer/client.rb
+- lib/cloudflarer/version.rb
+homepage: http://bjjb.gitlab.com/cloudflarer
+licenses:
+- MIT
+metadata: {}
+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: A Ruby/Cloudflare CLI/API-client
+test_files: []