fastly 1.00 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  data.tar.gz: 173bc2e9d43fbf193a73830700cbd0909e8999a204605330cfbfb9b8d773aacde089c9902f98ddedaad8166d8d412e2475c44bc784e7d0884a61b6c8599d7fd2
-  metadata.gz: 68c1f14d18fd3894e3c15864509db3984f57a4dde8a9b804ffe20b24df981d3512eb4f7446042971d677d138017ec1a092fe022bc2036c89ee8a90c24af84bc9
-SHA1: 
-  data.tar.gz: 3090d1395750ed869ebd3cc8947d38c688f99217
-  metadata.gz: 43141d3014baaca138f007d90e1de1411e80bf2a
+---
+SHA1:
+  metadata.gz: 32433fc4e1827f9659e820237e1169cd7daac028
+  data.tar.gz: 10af32d40745105a372f0701d8dbe248d679ec8c
+SHA512:
+  metadata.gz: 9d9206b598514df93cb6ea04802fbe25cfeff699037d37881655323a893757c357695356fed7c45f162844acd3757f92c7d4f41c822112aa64ff7aa88edd2696
+  data.tar.gz: 26ec2fb0e1fb0ee4633f09a3e4203dc342b2c235c474f637d8f13ed620a48e9c5ae180bff79b9de4bfb7b26e0e2f97354205d117a1b5170efb0ffc55a183709f

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 run_test.sh
 doc/*
+.*.sw?

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Changes

@@ -1,3 +1,17 @@
+2013-11-26 v1.02
+
+Fix rdoc dependency and quorum spelling (Kristoffer Renholm)
+
+2013-10-03 v1.01
+
+Add historical stats functionality
+Fix settings
+Add conditions
+Add in auto_loadbalancing for backends
+Fix some doc stuff (Sam Sharpe)
+Reorganize library (Eric Saxby & Paul Henry)
+Fix purge_all, purge_by_key and details (Kazuki Ohta)
+
 2013-07-16 v1.00
 
 Fix delete VCL (thanks Andrian Jardan)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2012-2014 Fastly, Inc.
+
+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

@@ -1,65 +1,98 @@
-Fastly - client library for interacting with the Fastly web acceleration service
-
-# Example
- 
-    fastly = Fastly.new(login_opts)
-
-    current_user     = fastly.current_user
-    current_customer = fastly.current_customer
-
-    user     = fastly.get_user(current_user.id)
-    customer = fastly.get_customer(current_customer.id)
-
-    puts "Name: #{user.name}"
-    puts "Works for #{user.customer.name}"
-    puts "Which is the same as #{customer.name}"
-    puts "Which has the owner #{customer.owner.name}"
-
-    # Let's see which services we have defined
-    fastly.list_services.each do |service|
-      puts "Service ID: #{service.id}"
-      puts "Service Name: #{service.name}"
-      puts "Service Versions:"
-      service.versions.each do |version|
-          puts "\t#{version.number}"
-      end
-    end
-
-    service        = fastly.create_service(:name => "MyFirstService")
-    latest_version = service.version
-
-    # Create a domain and a backend for the service ...
-    domain         = fastly.create_domain(:service_id => service.id, :version => latest_version.number, :name => "www.example.com")
-    backend        = fastly.create_backend(:service_id => service.id, :version => latest_version.number, :name => "Backend 1", :ipv4 => "192.0.43.10", :port => 80)
-
-    # ... and activate it. You're now hosted on Fastly.
-    latest_version.activate
-
-    # Let's take a peek at the VCL that Fastly generated for us
-    vcl = latest_version.generated_vcl
-    puts "Generated VCL file is:\n#{vcl.content}"
-
-    # Now let's create a new version ...
-    new_version    = latest_version.clone
-    # ... add a new backend ...
-    new_backend    = fastly.create_backend(:service_id => service.id, :version => new_version.number, :name => "Backend 2", :ipv4 => "74.125.224.136", :port => 8080)
-    # ... add a director to switch between them
-    director       = fastly.create_director(:service_id => service.id, :version => new_version.number, :name => "My Director")
-    director.add_backend(backend)
-    director.add_backend(new_backend)
-    # ... and upload some custom vcl (presuming we have permissions)
-    new_version.upload_vcl(vcl_name, File.read(vcl_file))
-
-    new_version.activate
-
-# Copyright
- 
-Copyright 2011 - Fastly Inc
+# Fastly
+
+Client library for interacting with the Fastly web acceleration service [API](http://docs.fastly.com/api)
+
+## Example
+
+```ruby
+fastly = Fastly.new(login_opts)
+
+current_user     = fastly.current_user
+current_customer = fastly.current_customer
+
+user     = fastly.get_user(current_user.id)
+customer = fastly.get_customer(current_customer.id)
+
+puts "Name: #{user.name}"
+puts "Works for #{user.customer.name}"
+puts "Which is the same as #{customer.name}"
+puts "Which has the owner #{customer.owner.name}"
+
+# Let's see which services we have defined
+fastly.list_services.each do |service|
+  puts "Service ID: #{service.id}"
+  puts "Service Name: #{service.name}"
+  puts "Service Versions:"
+  service.versions.each do |version|
+    puts "\t#{version.number}"
+  end
+end
+
+service        = fastly.create_service(:name => "MyFirstService")
+latest_version = service.version
+
+# Create a domain and a backend for the service ...
+domain         = fastly.create_domain(:service_id => service.id, :version => latest_version.number, :name => "www.example.com")
+backend        = fastly.create_backend(:service_id => service.id, :version => latest_version.number, :name => "Backend 1", :ipv4 => "192.0.43.10", :port => 80)
+
+# ... and activate it. You're now hosted on Fastly.
+latest_version.activate!
+
+# Let's take a peek at the VCL that Fastly generated for us
+vcl = latest_version.generated_vcl
+puts "Generated VCL file is:\n#{vcl.content}"
+
+# Now let's create a new version ...
+new_version    = latest_version.clone
+# ... add a new backend ...
+new_backend    = fastly.create_backend(:service_id => service.id, :version => new_version.number, :name => "Backend 2", :ipv4 => "74.125.224.136", :port => 8080)
+# ... add a director to switch between them
+director       = fastly.create_director(:service_id => service.id, :version => new_version.number, :name => "My Director")
+director.add_backend(backend)
+director.add_backend(new_backend)
+# ... and upload some custom vcl (presuming we have permissions)
+new_version.upload_vcl(vcl_name, File.read(vcl_file))
+# ... and set it as the service's main vcl
+fastly.client.put("/service/#{service.id}/version/#{new_version.number}/vcl/#{vcl_name}/main")
+
+new_version.activate!
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Notes for testing
+
+The test suite requires the following `ENV` variables to be set:
+
+* `FASTLY_TEST_USER` - Your user email
+* `FASTLY_TEST_NAME` - Your name on your account (ie "John Smith")
+* `FASTLY_TEST_PASSWORD` - Your account password
+* `FASTLY_TEST_CUSTOMER` - Your customer or company name (ie. "Fastly" or "Acme, Inc.")
+* `FASTLY_TEST_API_KEY` - Your API key (found at https://app.fastly.com/#account)
+
+While the test suite is safe to be run on all accounts and isn't harmful to your
+data, the tests will create and delete 3 services in sequence so you may want
+to create an account just for tests.
+
+## Copyright
+
+Copyright 2011-2014 - Fastly Inc
+
+## Redistribution
+
+MIT license, see LICENSE.
+
+## Contact
 
 Mail support at fastly dot com if you have problems.
- 
-# Developers
 
-http://github.com/fastly/fastly-ruby
+## Developers
 
-http://www.fastly.com/documentation
+* http://github.com/fastly/fastly-ruby
+* http://www.fastly.com/documentation

data/Rakefile

@@ -1 +1,10 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end

data/fastly.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "fastly"
+require 'fastly/gem_version'
 
 Gem::Specification.new do |s|
   s.name        = "fastly"
@@ -10,14 +10,16 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/fastly/fastly-ruby"
   s.summary     = %q{Client library for the Fastly acceleration system}
   s.description = %q{Client library for the Fastly acceleration system}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
+  s.add_dependency 'rake'
   s.add_dependency 'json'
   s.add_dependency 'curb', '>=0.7.15'
   s.add_dependency 'curb-fu', '>=0.6.1'
-  s.add_dependency 'rdoc', '>=3.11'
+  s.add_development_dependency 'rdoc', '>=3.4'
 end

data/lib/fastly.rb

@@ -4,25 +4,31 @@
 
 # A client library for interacting with the Fastly web acceleration service
 class Fastly
-  # The current version of the library
-  VERSION = "1.00"
-
+  require 'fastly/gem_version'
+  require 'fastly/string'
   require 'fastly/fetcher'
   require 'fastly/client'
 
   require 'fastly/base'
   require 'fastly/belongs_to_service_and_version'
   require 'fastly/backend'
+  require 'fastly/cache_setting'
+  require 'fastly/condition'
   require 'fastly/customer'
   require 'fastly/director'  
   require 'fastly/domain'
+  require 'fastly/header'
   require 'fastly/healthcheck'
+  require 'fastly/gzip'
   require 'fastly/invoice'
   require 'fastly/match'
   require 'fastly/origin'
+  require 'fastly/request_setting'
+  require 'fastly/response_object'
   require 'fastly/service'
   require 'fastly/settings'
   require 'fastly/syslog'
+  require 'fastly/s3_logging'
   require 'fastly/user'
   require 'fastly/vcl'
   require 'fastly/version'
@@ -89,9 +95,67 @@ class Fastly
     #res = client.post("/purge/", :path => path)
   end
 
+  # Fetches historical stats for each of your fastly services and groups the results by service id.
+  #
+  # If you pass in a :field opt then fetches only the specified field.
+  # If you pass in a :service opt then fetches only the specified service.
+  # The :field and :service opts can be combined.
+  #
+  # If you pass in an :aggregate flag then fetches historical stats information aggregated across all of your Fastly services. This cannot be combined with :field and :service.
+  #
+  # Other options available are:
+  #
+  # from:: earliest time from which to fetch historical statistics
+  # to:: latest time from which to fetch historical statistics
+  # by:: the sampling rate used to produce the result set (minute, hour, day)
+  # region:: restrict query to a particular region
+  #
+  # 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
+
+  # Returns usage information aggregated across all Fastly services and grouped by region.
+  #
+  # If the :by_service flag is passed then teturns usage information aggregated by service and grouped by service & region.
+  #
+  # Other options available are:
+  #
+  # from:: earliest time from which to fetch historical statistics
+  # to:: latest time from which to fetch historical statistics
+  # by:: the sampling rate used to produce the result set (minute, hour, day)
+  # region:: restrict query to a particular region
+  #
+  # See http://docs.fastly.com/docs/stats for details.
+  def usage(opts)
+    url  = "/stats/usage";
+    url += "_by_service" if opts.delete(:by_service)
+    client.get_stats(url, opts)
+  end
+
+  # Fetches the list of codes for regions that are covered by the Fastly CDN service.
+  def regions
+    client.get_stats("/stats/regions")
+  end
 
-  [User, Customer, Backend, Director, Domain, Healthcheck, Match, Origin, Service, Syslog, VCL, Version].each do |klass|   
-    type = klass.to_s.downcase.split("::")[-1]
+  [User, Customer, Backend, CacheSetting, Condition, Director, Domain, Header, Healthcheck, Gzip, Match, Origin, RequestSetting, ResponseObject, Service, S3Logging, Syslog, VCL, Version].each do |klass|   
+    type = klass.to_s.split("::")[-1].underscore
     # 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)
         self.send :define_method, "list_#{type}s".to_sym do |*args|
@@ -144,6 +208,10 @@ class Fastly
   # :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
+
   ##
   # :method: create_syslog(opts)
   # opts must contain service_id, version and name params
@@ -151,6 +219,30 @@ 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
+
+  ##
+  # :method: create_cache_setting(opts)
+  # opts must contain service_id, version and name params
+
+  ##
+  # :method: create_header(opts)
+  # opts must contain service_id, version and name params
+
+  ##
+  # :method: create_gzip(opts)
+  # opts must contain service_id, version and name params
+
+  ##
+  # :method: create_request_setting(opts)
+  # opts must contain service_id, version and name params
+
+  ##
+  # :method: create_response_object(opts)
+  # opts must contain service_id, version and name params
 
   ##
   # :method: get_user(id)
@@ -191,6 +283,10 @@ class Fastly
   ## 
   # :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)
@@ -208,6 +304,30 @@ class Fastly
   # :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
+
   ##
   # :method: update_user(user)
   # You can also call
@@ -263,6 +383,11 @@ class Fastly
   # 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
@@ -273,6 +398,36 @@ class Fastly
   # 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
@@ -334,6 +489,11 @@ class Fastly
   # 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
@@ -345,60 +505,114 @@ class Fastly
   # 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
+  # :method: list_users(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all users
 
-  # :method: list_customers 
+  # :method: list_customers(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all customers
 
-  # :method: list_versions
+  # :method: list_versions(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all versions
 
-  # :method: list_services 
+  # :method: list_services(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all services
 
-  # :method: list_backends 
+  # :method: list_backends(:service_id => service.id, :version => version.number) 
   # 
   # Get a list of all backends
 
-  # :method: list_directors 
+  # :method: list_directors(:service_id => service.id, :version => version.number) 
   # 
   # Get a list of all directors
 
-  # :method: list_domains 
+  # :method: list_domains(:service_id => service.id, :version => version.number) 
   # 
   # Get a list of all domains
 
-  # :method: list_healthchecks
+  # :method: list_healthchecks(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all healthchecks
 
-  # :method: list_matchs 
+  # :method: list_matchs(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all matches
 
-  # :method: list_origins 
+  # :method: list_origins(:service_id => service.id, :version => version.number) 
   # 
   # Get a list of all origins
 
-  # :method: list_syslogs
+  # :method: list_syslogs(:service_id => service.id, :version => version.number)
   # 
   # Get a list of all syslogs
 
-  # :method: list_vcls 
+  # :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) 
+  # 
+  # 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_versions 
+  # :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
 
@@ -456,3 +670,4 @@ class Fastly
     options;
   end
 end
+