fastly 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ef96a7f613dfa4a86cf2312c52bce16235bf7cf
-  data.tar.gz: 4d5b36b94d9d90f263f3f831dc72cfb333d88813
+  metadata.gz: 4ef98fd25ca8d8bc9e1b8a59c3f9871bf55297c3
+  data.tar.gz: ca25acfcc5fc2530bb4fe0b3684444de0cc2060b
 SHA512:
-  metadata.gz: 128bb682ee2ed4be291c9eb7d0bbf420e88d4c2f33c139dd606696bc80aefd74638040a3d77b034cefa3f8ba0e6d4f003be5e5f627762b88f4f4f5ffd8e6038b
-  data.tar.gz: a3bfafd5d8517237b3f0a452d2bb4397d3f57a6685c7cad38a57b582730e898d758ee49d5106b7c76431937b986f7f9a16adb1d30e085f76f4897713e6cb7a16
+  metadata.gz: 342af0046a3402e92d87d2c0dfabf93ffba77674ffe817e21f11ff66f65c0ec14f8b3f02278359865b3898394fe2c8016f6b12297adc1c64d8da8a1d10b2821a
+  data.tar.gz: b9a5b946c3525e4bfe6f6ccf7a186136a5349c5bd9f87d633f3309873a850061397a8b19f3525dcadec20b9f0cf4d1738dd48a9d38860fc578b3feb92e10d3a1

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# inherit_from:
+  # - rubocop-todo.yml
+
+LineLength:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+RescueModifier:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
+script: 'bundle exec rake test:unit'
 rvm:
-  - "1.9.2"
-  - "1.9.3"
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
+  - '1.9.3'
+  - '2.1.1'

data/Gemfile

@@ -7,4 +7,5 @@ group :development, :test do
   gem 'rdoc', '~> 4.1.1'
   gem 'minitest', '~> 5.3.4'
   gem 'pry'
+  gem 'rubocop'
 end

data/HISTORY.md

@@ -1,4 +1,14 @@
-# 2014-06-12 v1.1.2
+# HEAD
+
+
+# 2014-07-25 v1.1.3
+* Add test:unit rake task
+* Add Rubocop and some rubocop cleanup
+* Clarify gem name in documentation
+* Fix a bug in the `Fastly.get_options` method
+* Add `bin/fastly_create_domain` script to easily create domain
+
+#### 2014-06-12 v1.1.2
 * Replace `String#underscore` with `Fastly::Util.class_to_path` method.
 * Add first true unit test
 * Add `test_helper.rb`

data/README.md

@@ -1,10 +1,14 @@
-# Fastly
+# Fastly [![Build Status](https://travis-ci.org/fastly/fastly-ruby.svg?branch=master)](https://travis-ci.org/fastly/fastly-ruby)
 
 Client library for interacting with the Fastly web acceleration service [API](http://docs.fastly.com/api)
 
 ## Example
 
 ```ruby
+# Gemfile
+gem 'fastly'
+
+# some_file.rb
 fastly = Fastly.new(login_opts)
 
 current_user     = fastly.current_user

data/Rakefile

@@ -1,6 +1,4 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rdoc/task'
 
 desc 'Run library from within a Pry console'
 task :console do
@@ -10,12 +8,39 @@ task :console do
   Pry.start
 end
 
+namespace :clean do
+  desc 'Remove all trailing whitespace from Ruby files in lib and test'
+  task :whitespace do
+    sh "find {test,lib,bin} -name *.rb -exec sed -i '' 's/[ ]*$//' {} \\\;"
+  end
+end
+
+require 'rubocop/rake_task'
+
+desc 'Run rubocop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['bin/*', 'lib/**/*.rb', 'test/**/*.rb']
+  task.formatters = ['fuubar']
+  task.fail_on_error = true
+end
+
+require 'rdoc/task'
+
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'doc'
   rdoc.main = 'README.md'
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 
+namespace :test do
+  desc 'Run all unit tests'
+  task :unit do
+    sh 'bundle exec ruby -Itest -Ilib test/fastly/*_test.rb'
+  end
+end
+
+require 'rake/testtask'
+
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList['test/*test.rb']

data/bin/fastly_create_domain

@@ -0,0 +1,67 @@
+#!/bin/env ruby
+
+##
+# fastly_upload_vcl - upload raw VCL files to Fastly
+#
+# Author::   Fastly Inc <support@fastly.com>
+# Copyright:: Copyright (c) 2011 Fastly Inc
+# License::   Distributes under the same terms as Ruby
+#
+# = USAGE
+# 
+#     fastly_create_domain <options> <service id> <domain name>
+# 
+# = CONFIGURATION
+# 
+# You can either have a config file in ~/.fastly or /etc/fastly with
+# 
+#     api_key = <api_key>
+# 
+# Alternatively you can pass in any of those options on the command line
+# 
+#     fastly_create_domain --api_key=<key> <service id> <domain name>
+
+require 'rubygems'
+require 'fastly'
+
+def get_options(*files)
+  options = {}
+  files.each do |file|
+    next unless File.exist?(file)
+    options = load_config(file)
+    break
+  end
+
+  while (ARGV.size>0 && ARGV[0] =~ /^-+(\w+)\=(\w+)$/) do
+    options[$1.to_sym] = $2;
+    ARGV.shift;
+  end
+  raise"Couldn't find options from command line arguments or #{files.join(', ')}" unless options.size>0
+  options;
+end
+
+
+# :nodoc:
+def die(message)
+  warn message
+  exit -1
+end
+
+
+params = get_options("#{ENV['HOME']}/.fastly", "/etc/fastly")
+
+service_id  = ARGV.shift || die("You must pass in a service id")
+domain_name = ARGV.shift || die("You must pass in a domain name")
+
+die("Couldn't find any of the config files - #{configs.join(',')}") unless params.keys.size>0
+
+fastly = Fastly.new(params)
+
+service = fastly.get_service(service_id) || die("Couldn't find service #{service_id}")
+version = service.version
+cloned_version = version.clone
+domain = fastly.create_domain(:service_id => service.id, :version => cloned_version.number, :name => domain_name)
+cloned_version.activate!
+
+puts "Done! Created Domain: #{domain.name}. Active Version: #{domain.version.number}"
+

data/lib/fastly.rb

@@ -15,7 +15,7 @@ class Fastly
   require 'fastly/cache_setting'
   require 'fastly/condition'
   require 'fastly/customer'
-  require 'fastly/director'  
+  require 'fastly/director'
   require 'fastly/domain'
   require 'fastly/header'
   require 'fastly/healthcheck'
@@ -36,13 +36,13 @@ class Fastly
   include Fastly::Fetcher
 
   # Create a new Fastly client. Options are
-  # 
+  #
   # user:: your Fastly login
   # password:: your Fastly password
   # api_key:: your Fastly api key
-  # 
-  # You only need to pass in C<api_key> OR C<user> and C<password>. 
-  # 
+  #
+  # You only need to pass in C<api_key> OR C<user> and C<password>.
+  #
   # Some methods require full username and password rather than just auth token.
   def initialize(opts)
     self.client(opts)
@@ -78,14 +78,14 @@ class Fastly
   def set_customer(id)
       raise Fastly::FullAuthRequired "You must be fully authed to set the customer" unless self.fully_authed?;
       raise Fastly::AdminRequired "You must be an admin to set the customer" unless self.current_user.can_do?(:admin);
-      @current_customer = nil 
+      @current_customer = nil
       client.set_customer(id);
   end
 
   # Return a hash representing all commands available.
   #
   # Useful for information.
-  def commands 
+  def commands
     client.get('/commands')
   end
 
@@ -113,21 +113,21 @@ class Fastly
   # See http://docs.fastly.com/docs/stats for details.
   def stats(opts)
     raise Fastly::Error.new("You can't specify a field or a service for an aggregate request") if opts[:aggregate] && (opts[:field] || opts[:service])
-    
+
     url  = "/stats"
 
     if opts.delete(:aggregate)
       url += "/aggregate"
     end
-    
+
     if service = opts.delete(:service)
       url += "/service/#{service}"
     end
-      
+
     if field = opts.delete(:field)
       url += "/field/#{field}"
     end
-      
+
     client.get_stats(url, opts);
   end
 
@@ -154,7 +154,7 @@ class Fastly
     client.get_stats("/stats/regions")
   end
 
-  [User, Customer, Backend, CacheSetting, Condition, Director, Domain, Header, Healthcheck, Gzip, Match, Origin, RequestSetting, ResponseObject, Service, S3Logging, Syslog, VCL, Version].each do |klass|   
+  [User, Customer, Backend, CacheSetting, Condition, Director, Domain, Header, Healthcheck, Gzip, Match, Origin, RequestSetting, ResponseObject, Service, S3Logging, Syslog, VCL, Version].each do |klass|
     type = Util.class_to_path(klass)
     # unless the class doesn't have a list path or it already exists
     unless klass.list_path.nil? || klass.respond_to?("list_#{type}s".to_sym)
@@ -162,7 +162,7 @@ class Fastly
             list(klass, *args)
         end
     end
-    
+
     self.send :define_method, "get_#{type}".to_sym do |*args|
       get(klass, *args)
     end
@@ -184,11 +184,11 @@ class Fastly
   # :method: create_version(opts)
   # opts must contain a service_id param
 
-  ## 
+  ##
   # :method: create_backend(opts)
   # opts must contain service_id, version and name params
 
-  ## 
+  ##
   # :method: create_director(opts)
   # opts must contain service_id, version and name params
 
@@ -203,11 +203,11 @@ class Fastly
   ##
   # :method: create_origin(opts)
   # opts must contain service_id, version and name params
-  
+
   ##
   # :method: create_healthcheck(opts)
   # opts must contain service_id, version and name params
-  
+
   ##
   # :method: create_s3_logging(opts)
   # opts must contain service_id, version and name params
@@ -219,7 +219,7 @@ class Fastly
   ##
   # :method: create_vcl(opts)
   # opts must contain service_id, version and name params
-  
+
   ##
   # :method: create_condition(opts)
   # opts must contain service_id, version and name params
@@ -248,11 +248,11 @@ class Fastly
   # :method: get_user(id)
   # Get a User
 
-  ## 
+  ##
   # :method: get_customer(id)
   # Get a customer
 
-  ## 
+  ##
   # :method: get_service(id)
   # Get a Service
 
@@ -264,67 +264,67 @@ class Fastly
   # :method: get_backend(service_id, number, name)
   # Get a backend
 
-  ## 
+  ##
   # :method: get_director(service_id, number, name)
   # Get a Director
 
-  ## 
+  ##
   # :method: get_domain(service_id, number, name)
   # Get a Domain
-  
-  ## 
+
+  ##
   # :method: get_healthcheck(service_id, number, name)
   # Get a Healthcheck
 
-  ## 
+  ##
   # :method: get_match(service_id, number, name)
   # Get a Match
 
-  ## 
+  ##
   # :method: get_origin(service_id, number, name)
   # Get an Origin
 
   ##
   # :method: get_s3_logging(service_id, number, name)
   # Get a S3 logging
-  
-  ## 
+
+  ##
   # :method: get_syslog(service_id, number, name)
   # Get a Syslog
 
-  ## 
+  ##
   # :method: get_vcl(service_id, number, name)
   # Get a VCL
 
-  ## 
+  ##
   # :method: get_version(service_id, number, name)
   # Get a Version
 
-  ## 
+  ##
   # :method: get_settings(service_id, number, name)
   # Get a Settings
 
-  ## 
+  ##
   # :method: get_condition(service_id, number, name)
   # Get a Condition
 
-  ## 
+  ##
   # :method: get_cache_setting(service_id, number, name)
   # Get a Cache Setting
 
-  ## 
+  ##
   # :method: get_gzip(service_id, number, name)
   # Get a Gzip
 
-  ## 
+  ##
   # :method: get_header(service_id, number, name)
   # Get a Header
 
-  ## 
+  ##
   # :method: get_request_setting(service_id, number, name)
   # Get a Request Setting
 
-  ## 
+  ##
   # :method: get_response_object(service_id, number, name)
   # Get a Response Object
 
@@ -333,298 +333,298 @@ class Fastly
   # You can also call
   #    user.save!
 
-  ## 
+  ##
   # :method: update_customer(customer)
   # You can also call
   #    customer.save!
 
-  ## 
+  ##
   # :method: update_service(service)
   # You can also call
   #    service.save!
 
-  ## 
+  ##
   # :method: update_version(version)
   # You can also call
   #    version.save!
 
-  ## 
+  ##
   # :method: update_backend(backend)
   # You can also call
   #    backend.save!
 
-  ## 
+  ##
   # :method: update_director(director)
   # You can also call
   #    director.save!
 
-  ## 
+  ##
   # :method: update_domain(domain)
   # You can also call
   #    domain.save!
-  
-  ## 
+
+  ##
   # :method: update_healthcheck(healthcheck)
   # You can also call
   #    healthcheck.save!
 
-  ## 
+  ##
   # :method: update_match(match)
   # You can also call
   #    match.save!
 
-  ## 
+  ##
   # :method: update_origin(origin)
   # You can also call
   #    origin.save!
-  
-  ## 
+
+  ##
   # :method: update_settings(settings)
   # You can also call
   #    settings.save!
 
-  ## 
+  ##
   # :method: update_s3_logging(s3_logging)
   # You can also call
   #    s3_logging.save!
 
-  ## 
+  ##
   # :method: update_syslog(syslog)
   # You can also call
   #    syslog.save!
 
-  ## 
+  ##
   # :method: update_vcl(vcl)
   # You can also call
   #    vcl.save!
 
-  ## 
+  ##
   # :method: update_cache_setting(cache_setting)
   # You can also call
   #    cache_setting.save!
 
-  ## 
+  ##
   # :method: update_header(header)
   # You can also call
   #    header.save!
 
-  ## 
+  ##
   # :method: update_gzip(gzip)
   # You can also call
   #    gzip.save!
 
-  ## 
+  ##
   # :method: update_request_setting(request_setting)
   # You can also call
   #    request_setting.save!
 
-  ## 
+  ##
   # :method: update_response_object(response_object)
   # You can also call
   #    response_object.save!
 
-  ## 
+  ##
   # :method: update_condition(condition)
   # You can also call
   #    condition.save!
 
-  ## 
+  ##
   # :method: update_version(version)
   # You can also call
   #    version.save!
 
 
-  ## 
-  # :method: delete_user(user) 
+  ##
+  # :method: delete_user(user)
   # You can also call
   #    user.delete!
 
-  ## 
+  ##
   # :method: delete_customer(customer)
   # You can also call
   #    customer.delete!
 
-  ## 
+  ##
   # :method: delete_service(service)
   # You can also call
   #    service.delete!
 
 
-  ## 
+  ##
   # :method: delete_version(version)
   # You can also call
   #    version.delete!
 
 
-  ## 
+  ##
   # :method:delete_backend(backend)
   # You can also call
   #    backend.delete!
 
 
-  ##  
+  ##
   # :method: delete_director(backend)
   # You can also call
   #    backend.delete!
 
 
-  ## 
+  ##
   # :method: delete_domain(domain
   # You can also call
   #    domain.delete!
 
-  ## 
+  ##
   # :method: delete_healthcheck(healthcheck)
   # You can also call
   #    healthcheck.delete!
 
-  ## 
+  ##
   # :method: delete_match(match)
   # You can also call
   #    match.delete!(match)
 
 
-  ## 
+  ##
   # :method: delete_origin(origin)
   # You can also call
   #    origin.delete!
 
-  ## 
+  ##
   # :method: delete_s3_logging(s3_logging)
   # You can also call
   #    s3_logging.delete!
 
-  ## 
+  ##
   # :method: delete_syslog(syslog)
   # You can also call
   #    syslog.delete!
 
 
-  ## 
+  ##
   # :method: delete_vcl(vcl)
   # You can also call
   #    vcl.delete!
 
-  ## 
+  ##
   # :method: delete_cache_setting(cache_setting)
   # You can also call
   #    cache_setting.delete!
 
-  ## 
+  ##
   # :method: delete_header(header)
   # You can also call
   #    header.delete!
 
-  ## 
+  ##
   # :method: delete_gzip(gzip)
   # You can also call
   #    gzip.delete!
 
-  ## 
+  ##
   # :method: delete_request_setting(request_setting)
   # You can also call
   #    request_setting.delete!
 
-  ## 
+  ##
   # :method: delete_response_object(response_object)
   # You can also call
   #    response_object.delete!
 
-  ## 
+  ##
   # :method: delete_condition(condition)
   # You can also call
   #    condition.delete!
 
-  ## 
+  ##
   # :method: delete_version(version)
   # You can also call
   #    version.delete!
 
   # :method: list_users(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all users
 
   # :method: list_customers(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all customers
 
   # :method: list_versions(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all versions
 
   # :method: list_services(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all services
 
-  # :method: list_backends(:service_id => service.id, :version => version.number) 
-  # 
+  # :method: list_backends(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all backends
 
-  # :method: list_directors(:service_id => service.id, :version => version.number) 
-  # 
+  # :method: list_directors(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all directors
 
-  # :method: list_domains(:service_id => service.id, :version => version.number) 
-  # 
+  # :method: list_domains(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all domains
 
   # :method: list_healthchecks(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all healthchecks
 
   # :method: list_matchs(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all matches
 
-  # :method: list_origins(:service_id => service.id, :version => version.number) 
-  # 
+  # :method: list_origins(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all origins
 
   # :method: list_syslogs(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all syslogs
 
-  # :method: list_vcls(:service_id => service.id, :version => version.number) 
-  # 
+  # :method: list_vcls(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all vcls
-  
-  # :method: list_conditions(:service_id => service.id, :version => version.number) 
-  # 
+
+  # :method: list_conditions(:service_id => service.id, :version => version.number)
+  #
   # Get a list of all conditions
 
   # :method: list_cache_settings(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all cache settings
 
   # :method: list_headers(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all headers
 
   # :method: list_gzips(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all gzips
 
   # :method: list_request_settings(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all request_settings
 
   # :method: list_response_objects(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all response_objects
 
   # :method: list_versions(:service_id => service.id, :version => version.number)
-  # 
+  #
   # Get a list of all versions
 
 
 
   ##
   # Attempts to load various config options in the form
-  # 
+  #
   #    <key> = <value>
-  # 
+  #
   # From a file.
-  # 
+  #
   # Skips whitespace and lines starting with C<#>.
   #
   def self.load_config(file)
@@ -646,12 +646,12 @@ class Fastly
   end
 
   ##
-  # Tries to load options from the file[s] passed in using, 
+  # Tries to load options from the file[s] passed in using,
   # C<load_options>, stopping when it finds the first one.
-  # 
-  # Then it overrides those options with command line options 
+  #
+  # Then it overrides those options with command line options
   # of the form
-  # 
+  #
   #     --<key>=<value>
   #
   def self.get_options(*files)
@@ -664,7 +664,7 @@ class Fastly
 
     while (ARGV.size>0 && ARGV[0] =~ /^-+(\w+)\=(\w+)$/) do
       options[$1.to_sym] = $2;
-      @ARGV.shift;
+      ARGV.shift;
     end
     raise"Couldn't find options from command line arguments or #{files.join(', ')}" unless options.size>0
     options;