fastlyctl 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c99e7a36c4d22a02bd9dc8547be8e57e026b5e781eca956454bf29567ab0ff12
+  data.tar.gz: a5c608f10b5259f9f08d61ee77f18c874a46aae079943b812854bc615eddc7ef
+SHA512:
+  metadata.gz: 6b33f5cdc219afdb8be0872a893577264c7a1c7c16911a29646807dddf75f8cef941f3dd5c9aaa2b28c770705da12a7dbdadf7a8844d70d10e07d9a8977f09a7
+  data.tar.gz: 9326d1f7ba46d301582fffd593d6a6821df4b4a2aab124d889a49f261c8bb3a250d780c8cded06b4b94512864aa4388cb8a65b7ecf0f73ebcc9d1afcdbd0ce6b

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.DS_Store

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    fastlyctl (1.0.0)
+      bundler (~> 1.10)
+      diffy (~> 3.2.1)
+      launchy (~> 2.4.3, >= 2.4.3)
+      thor (~> 0.19.4)
+      typhoeus (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    diffy (3.2.1)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.10.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    public_suffix (3.0.3)
+    thor (0.19.4)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fastlyctl!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stephen Basile
+
+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,324 @@
+# FastlyCTL
+
+CLI for manipulating objects with [Fastly's API](https://docs.fastly.com/api/config).
+
+## Dependencies
+
+ * Ruby 2.2+
+ * diff
+ * Bundler 
+
+## Installation
+
+```
+gem install fastlyctl
+```
+
+## Workflow
+
+Basic setup for a service:
+
+```
+$ fastlyctl download --service 72rdJo8ipqaHRFYnn12G2q
+No VCLs on this service, however a folder has been created. Create VCLs in this folder and upload.
+$ cd Sandbox\ -\ 72rdJo8ipqaHRFYnn12G2q/
+$ fastlyctl skeleton
+Boilerplate written to main.vcl.
+$ fastlyctl upload
+VCL main does not currently exist on the service, would you like to create it? y
+[You will see a diff here for the new VCL]
+Given the above diff, are you sure you want to upload your changes? y
+main uploaded to 72rdJo8ipqaHRFYnn12G2q
+VCL(s) have been uploaded to version 286 and validated.
+$ fastlyctl activate
+Version 286 on 72rdJo8ipqaHRFYnn12G2q activated.
+```
+
+Once you are past this point you can edit your VCLs and use the commmand `fastlyctl upload && fastlyctl activate`. The service ID will be automatically inferred from the folder you are currently in. In fact, all commands will attempt to assume the service ID of the current directory if it is relevant.
+
+You may find it useful to keep a Github repo with one folder created by this command for each service. This way you can version your VCL files.
+
+## Command Reference
+
+### acl
+
+Manipulate ACLs on a service.
+
+Usage:
+
+```
+fastlyctl acl [action] [acl_name] [ip_or_subnet]
+```
+
+Available Actions:
+  * create: Creates a new ACL. `ip_or_subnet` parameter is omitted.
+  * delete: Deletes an ACL. `ip_or_subnet` parameter is omitted.
+  * list: Lists all ACLs. `ip_or_subnet` parameter is omitted.
+  * add: Adds a new IP or Subnet to an ACL.
+  * remove: Removes an IP or Subnet from an ACL.
+  * list_ips: Lists all IPs/Subnets in an ACL.
+  * bulk_add: Adds multiple items to an ACL. See [this documentation](https://docs.fastly.com/api/config#acl_entry_c352ca5aee49b7898535cce488e3ba82) for information on the format.
+
+Flags:
+  * --s: The service ID to use. Current working directory is assumed.
+  * --v: The version to use. Latest writable version is assumed.
+
+### activate
+
+Activates a service version. 
+
+Usage:
+
+```
+fastlyctl activate
+```
+
+Flags: 
+  * --s: The service ID to activate. Current working directory is assumed.
+  * --v: The version to activate. Latest writable version is assumed.
+  * --c: Adds a comment to the version.
+ 
+### clone
+
+Clones a service version to a new version on another service. 
+
+Usage: 
+
+```
+fastlyctl clone [sid_1] [sid_2]
+```
+
+Flags
+  * --v: The version to clone. The currently active version is assumed.
+  * --sl: Skip logging objects during the clone.
+
+### copy
+
+Copies an object from one service to another
+
+Usage: 
+
+```
+fastlyctl copy [sid_1] [sid_2] [obj_type] [obj_name]
+```
+
+Flags
+  * --v1: The version to clone from on the source service. The currently active version is assumed.
+  * --v2: The version to clone to on the target service. Latest writable version is assumed.
+
+### create_service
+
+Creates a new service.
+
+Usage:
+
+```
+fastlyctl create_service [name]
+```
+
+Flags:
+  * --c: [Admin only] The customer ID to create the service on.
+
+### dictionary
+
+Manipulate edge dictionaries on a service.
+
+Usage:
+
+```
+fastlyctl dictionary [action] [dictionary_name] [key] [value]
+```
+
+Available Actions:
+  * create: Creates a new dictionary. Key and value parameters are omitted.
+  * delete: Deletes a dictionary. Key and value parameters are omitted.
+  * list: Lists all dictionaries. Key and value parameters are omitted.
+  * upsert: Inserts a new item into a dictionary. If the item exists, its value will be updated.
+  * remove: Removes an item from a dictionary.
+  * list_items: Lists all items in a dictionary.
+  * bulk_add: Adds multiple items to a dictionary. See [this documentation](https://docs.fastly.com/api/config#dictionary_item_dc826ce1255a7c42bc48eb204eed8f7f) for information on the format.
+
+Flags:
+  * --s: The service ID to use. Current working directory is assumed.
+  * --v: The version to use. Latest writable version is assumed.
+
+### diff
+
+Provides a diff of two service versions. You may optionally specify which two service IDs and which two versions to diff. If you do not provide service IDs, the context of the current working directory is assumed. 
+
+ * If you provide no service IDs, the service ID of the working directory is assumed.
+  * If you do not specify versions, active VCL will be diffed with local VCL in the current directory.
+  * If you specify version 1 but not version 2, version 1 will be diffed with local VCL
+  * If you specify both versions, they will be diffed with each other.
+ * If you provide service 1 but not service 2, service 2 will be assumed from the current working directory.
+ * Regardless of how you specify services, if service 1 and service 2 are _different_, the versions will default to the active versions instead of local VCL.
+
+Usage:
+
+```
+fastlyctl diff
+```
+
+  * --s1: The first service to diff against.
+  * --v1: The version to diff.
+  * --s2: The second service to diff against.
+  * --v2: The second service's version to diff.
+  * --g: Diffs the generated VCL instead of the custom VCL.
+
+### domain
+
+Manipulate domains on a service.
+
+Usage:
+
+```
+fastlyctl domain [action] [hostname]
+```
+
+Available Actions:
+  * create: Create a new domain.
+  * delete: Delete a domain.
+  * list: List all domains.
+  * check: Check the DNS of all domains on a service and print the status.
+
+Flags:
+  * --s: The service ID to use. Current working directory is assumed.
+  * --v: The version to use. Latest writable version is assumed.
+
+### download
+
+Download the VCLs and snippets on a service. If you are not in a service directory already, a new directory will be created.
+
+Usage:
+
+```
+fastlyctl download
+```
+
+Flags:
+  * --s: The service ID to download. Current working directory is assumed.
+  * --v: The version to download. The currently active version is assumed.
+
+### login
+
+Login to the Fastly app and create an API token. This token will be stored in your home directory for the CLI to use for all requests.
+
+If your origanization uses SSO to login to Fastly, this command will prompt you to create a token and save it to `~/.fastlyctl_token` on your computer. You may also create the token and save it to the fastlyctl_token file without using the `fastlyctl login` command at all.
+
+Usage:
+
+```
+fastlyctl login
+```
+
+### open
+
+Opens the Fastly app for a service for a hostname of a service ID.
+
+Usage:
+
+```
+fastlyctl open [hostname]
+```
+
+Flags:
+  * --s: The service ID to open. Current working directory is assumed.
+
+### purge_all
+
+Perform a purge all on a service.
+
+Usage:
+
+```
+fastlyctl purge_all
+```
+Flags:
+  * --s: The service ID to purge. Current working directory is assumed.
+
+### skeleton
+
+Download the VCL boilerplate into the current directory.
+
+Usage
+
+```
+fastlyctl skeleton [local_filename]
+```
+
+### snippet
+
+Manipulate snippets on a service.
+
+Usage:
+
+```
+fastlyctl snippet [action] [snippet_name]
+```
+
+Available Actions:
+  * create: Create a new snippet
+  * upload: Upload a specific dynamic snippet
+  * delete: Delete a snippet
+  * list: List all snippets
+
+Flags:
+  * --s: The service ID to use. Current working directory is assumed.
+  * --v: The version to use. Latest writable version is assumed.
+  * --t: The type of snippet to create. Types are named after subroutines--for instance a snippet for `vcl_recv` would be of type `recv`. Use `init` for snippets outside of a subroutine.
+  * --d: When used with the create command, specifies that the snippet should be dynamic.
+
+### token
+
+Manipulate tokens for an account.
+
+Usage:
+
+```
+fastlyctl token [action]
+```
+
+Available Actions:
+  * create: Create a token
+  * delete: Delete a token
+  * list: List all tokens on the account
+
+Flags:
+  * --scope: Scope of the token. See Fastly's public API documentation for a [list of scopes](https://docs.fastly.com/api/auth#scopes).
+  * --s: The services to restrict this token to. The token cannot be used to modify any services not on this list if this option is specified.
+
+### upload
+
+Upload VCLs and snippets to a service.
+
+Usage:
+
+```
+fastlyctl upload
+```
+
+Flags:
+  * --v: The version to upload the VCL to. The latest writable version is assumed.
+  * --c: Adds a comment to the version.
+
+### watch
+
+Watch live stats on a service.
+
+Usage:
+
+```
+fastlyctl watch [pop]
+```
+
+Flags:
+  * --s: The service ID to watch. Current working directory is assumed.
+
+## Contributing
+
+Submit a pull request. Don't break anything.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fastlyctl"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/build.rb

@@ -0,0 +1,3 @@
+require_relative 'lib/fastlyctl/version.rb'
+
+system("gem build fastlyctl.gemspec && gem install ./fastlyctl-#{FastlyCTL::VERSION}.gem && gem cleanup fastlyctl")

data/exe/fastlyctl

@@ -0,0 +1,6 @@
+#!ruby
+
+require "bundler/setup"
+require "fastlyctl"
+
+FastlyCTL::CLI.start(ARGV)

data/fastlyctl.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastlyctl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fastlyctl"
+  spec.version       = FastlyCTL::VERSION
+  spec.authors       = ["Stephen Basile"]
+  spec.email         = ["stephen@fastly.com"]
+
+  spec.summary       = %q{CLI tool for interacting with the Fastly API}
+  spec.description   = %q{This gem provides a CLI for managing Fastly configurations}
+  spec.homepage      = "http://www.github.com/fastly/fastlyctl"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.executables << "fastlyctl"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "bundler", "~> 1.10"
+  spec.add_runtime_dependency "typhoeus", "~> 1.3.1"
+  spec.add_runtime_dependency "thor", "~> 0.19.4"
+  spec.add_runtime_dependency 'diffy', '~> 3.2.1'
+  spec.add_runtime_dependency 'launchy', '~> 2.4.3', '>= 2.4.3'
+end

data/lib/fastlyctl/cli.rb

@@ -0,0 +1,43 @@
+require "fastlyctl/commands/purge_all"
+require "fastlyctl/commands/open"
+require "fastlyctl/commands/download"
+require "fastlyctl/commands/diff"
+require "fastlyctl/commands/upload"
+require "fastlyctl/commands/activate"
+require "fastlyctl/commands/skeleton"
+require "fastlyctl/commands/clone"
+require "fastlyctl/commands/create_service"
+require "fastlyctl/commands/dictionary"
+require "fastlyctl/commands/login"
+require "fastlyctl/commands/watch"
+require "fastlyctl/commands/token"
+require "fastlyctl/commands/domain"
+require "fastlyctl/commands/snippet"
+require "fastlyctl/commands/acl"
+require "fastlyctl/commands/copy"
+
+
+module FastlyCTL
+  class CLI < Thor
+    class_option :debug, :desc => 'Enabled debug mode output'
+
+    def initialize(a,b,c)
+      unless File.exist?(FastlyCTL::TOKEN_FILE)
+        if yes?("Unable to locate API token. Would you like to login first?")
+          self.login
+        end
+      end
+
+      super
+
+      if options.key?(:debug)
+        Typhoeus::Config.verbose = true
+      end
+    end
+
+    desc "version", "Displays version of the VCL gem."
+    def version
+      say("VCL gem version is #{FastlyCTL::VERSION}")
+    end
+  end
+end

data/lib/fastlyctl/clone_utils.rb

@@ -0,0 +1,149 @@
+module FastlyCTL
+  module CloneUtils
+    OBJECT_TYPES = {
+      "condition" => {},
+      "acl" => {child: "entry", include_version: false},
+      "healthcheck" => {},
+      "cache_settings" => {},
+      "backend" => {},
+      "director" => {},
+      "dictionary" => {child: "item", include_version: false},
+      "gzip" => {},
+      "header" => {},
+      "request_settings" => {},
+      "response_object" => {},
+      "settings" => {method: :put},
+      "vcl" => {},
+      "snippet" => {},
+      "logging/s3" => {},
+      "logging/s3canary" => {},
+      "logging/azureblob" => {},
+      "logging/cloudfiles" => {},
+      "logging/digitalocean" => {},
+      "logging/ftp" => {},
+      "logging/bigquery" => {},
+      "logging/gcs" => {},
+      "logging/honeycomb" => {},
+      "logging/logshuttle" => {},
+      "logging/logentries" => {},
+      "logging/loggly" => {},
+      "logging/heroku" => {},
+      "logging/openstack" => {},
+      "logging/papertrail" => {},
+      "logging/scalyr" => {},
+      "logging/splunk" => {},
+      "logging/sumologic" => {},
+      "logging/syslog" => {}
+    }
+
+    def self.copy(obj,type,sid,version)
+      meta = FastlyCTL::CloneUtils::OBJECT_TYPES[type]
+      meta ||= {}
+
+      abort "No service ID on object" unless obj.key?("service_id")
+      source_sid = obj["service_id"]
+      abort "No version on object" unless obj.key?("version")
+      source_version = obj["version"]
+
+      if type == "director"
+        backends = obj["backends"].dup
+      end
+
+      if type == "snippet" && obj["dynamic"] == "1"
+        obj.merge!(FastlyCTL::Fetcher.api_request(:get, "/service/#{source_sid}/snippet/#{obj["id"]}"))
+      end
+
+      obj_id = obj["id"]
+      obj = FastlyCTL::CloneUtils.filter(type,obj)
+
+      obj = FastlyCTL::Fetcher.api_request(meta.key?(:method) ? meta[:method] : :post, "/service/#{sid}/version/#{version}/#{type}", body: obj )
+
+      if type == "director"
+        backends.each do |b|
+          FastlyCTL::Fetcher.api_request(:post, "/service/#{sid}/version/#{version}/director/#{obj["name"]}/backend/#{b}", body: obj )
+        end
+      end
+
+      return obj unless meta.key?(:child)
+      new_obj_id = obj["id"] 
+      child = meta[:child]
+
+      path = FastlyCTL::CloneUtils.construct_path(source_sid,source_version,meta[:include_version])
+
+      items = []
+      entries = []
+      FastlyCTL::Fetcher.api_request(:get, "#{path}/#{type}/#{obj_id}/#{FastlyCTL::CloneUtils.pluralize(child)}").each do |child_obj|
+        case child
+        when "item"
+          items.push({
+            "op" => "create","item_key" => child_obj["item_key"],"item_value" => child_obj["item_value"]
+          })
+          next
+        when "entry"
+          entries.push({
+            "op" => "create","ip" => child_obj["ip"],"subnet" => child_obj["subnet"]
+          })
+          next
+        end
+
+        child_obj = FastlyCTL::CloneUtils.filter(type,child_obj)
+
+        path = FastlyCTL::CloneUtils.construct_path(sid,version,meta[:include_version])
+
+        FastlyCTL::Fetcher.api_request(:post, "#{path}/#{type}/#{new_obj_id}/#{child}", body: child_obj )
+      end
+
+      FastlyCTL::Fetcher.api_request(:patch, "/service/#{sid}/dictionary/#{new_obj_id}/items", body: {"items" => items}.to_json, headers: {"Content-Type" => "application/json"} ) if items.length > 0
+      FastlyCTL::Fetcher.api_request(:patch, "/service/#{sid}/acl/#{new_obj_id}/entries", body: {"entries" => entries}.to_json, headers: {"Content-Type" => "application/json"} ) if entries.length > 0
+
+      return obj
+    end
+
+    def self.filter(type,obj)
+      filter_keys = ["version","id","service_id","created_at","updated_at","deleted_at","locked"]
+
+      obj.delete_if { |key, value| filter_keys.include?(key) }
+      obj.delete_if { |key, value| value.nil? }
+
+      case type
+      when "backend"
+        obj.delete("ipv4")
+        obj.delete("hostname")
+        obj.delete("ipv6")
+      when "director"
+        obj.delete("backends")
+      when "snippet"
+        obj.delete("snippet_id")
+      when "settings"
+        # this is to account for a bug in the API which disallows even setting this to zero
+        obj.delete("general.default_pci") if obj["general.default_pci"] == 0
+      end 
+
+      return obj
+    end
+
+    def self.construct_path(id,version,include_version)
+      if include_version != false
+        path = "/service/#{id}/version/#{version}"
+      else
+        path = "/service/#{id}"
+      end
+
+      return path
+    end
+
+    def self.unpluralize(type)
+      type = type.dup
+      type.sub!(/ies/,"y")
+      type.sub!(/s$/,"")
+      return type
+    end
+
+    def self.pluralize(type)
+      type = type.dup
+      type += "s" unless type[-1] == "s"
+      type.sub!(/ys$/,"ies")
+      return type
+    end
+  end
+end