fastly 1.00 → 1.01

data/Changes

@@ -1,3 +1,13 @@
+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/README.md

@@ -1,56 +1,60 @@
 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
+
+```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!
+```
 
 # Copyright
  

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"

data/lib/fastly.rb

@@ -4,9 +4,7 @@
 
 # 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/fetcher'
   require 'fastly/client'
 
@@ -89,6 +87,64 @@ 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]
@@ -151,6 +207,10 @@ 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: get_user(id)
@@ -273,6 +333,11 @@ class Fastly
   # You can also call
   #    vcl.save!
 
+  ## 
+  # :method: update_condition(condition)
+  # You can also call
+  #    condition.save!
+
   ## 
   # :method: update_version(version)
   # You can also call
@@ -345,6 +410,11 @@ class Fastly
   # You can also call
   #    vcl.delete!
 
+  ## 
+  # :method: delete_condition(condition)
+  # You can also call
+  #    condition.delete!
+
   ## 
   # :method: delete_version(version)
   # You can also call
@@ -397,6 +467,10 @@ class Fastly
   # :method: list_vcls 
   # 
   # Get a list of all vcls
+  
+  # :method: list_conditions 
+  # 
+  # Get a list of all conditions
 
   # :method: list_versions 
   # 

data/lib/fastly/backend.rb

@@ -2,7 +2,7 @@ class Fastly
   # An individual host you want to serve assets off
   class Backend < BelongsToServiceAndVersion
     attr_accessor :service_id, :name, :address, :ipv4, :ipv6, :hostname, :use_ssl, :client_cert, :port, 
-                  :connect_timeout, :first_byte_timeout, :between_bytes_timeout, :error_threshold, :max_conn, :weight, :comment, :healthcheck
+                  :connect_timeout, :first_byte_timeout, :between_bytes_timeout, :error_threshold, :max_conn, :weight, :comment, :healthcheck, :auto_loadbalance, :request_condition
 
     ## 
     # :attr: service_id
@@ -99,6 +99,15 @@ class Fastly
     # :attr: healthcheck
     #
     # the name of a healthcheck to associate with this backend. See the Healthcheck object
-
+    
+    ## 
+    # :attr: auto_loadbalance
+    #
+    # set to true if you want to auto_loadbalance, set to false if you don't want to auto_loadbalance
+    
+    ##
+    # :attr: request_condition
+    #
+    # name of a request_condition to filter the backend on
   end
 end

data/lib/fastly/belongs_to_service_and_version.rb

@@ -19,6 +19,11 @@ class Fastly
     def version_number
       @version
     end
+
+    # :nodoc:
+    def as_hash 
+      super.delete_if { |var| ["service_id", "version"].include?(var) }
+    end
     
     private
     

data/lib/fastly/client.rb

@@ -62,6 +62,12 @@ class Fastly
             raise Fastly::Error, resp.message unless resp.success?
             JSON.parse(resp.body)
         end
+        
+        def get_stats(path, params={})
+            content = get(path, params)
+            raise Fastly::Error, content["message"] unless content["status"] == 'success'
+            content["data"]
+        end
 
         def post(path, params={})
             post_and_put(:post, path, params)

data/lib/fastly/condition.rb

@@ -0,0 +1,40 @@
+class Fastly
+    # An endpoint to stream syslogs to 
+    class Condition < BelongsToServiceAndVersion
+        attr_accessor :service_id, :name, :priority, :statement, :type
+
+        ## 
+        # :attr: service_id
+        #
+        # The id of the service this belongs to.
+
+        ## 
+        # :attr: version
+        #
+        # The number of the version this belongs to.
+
+        ## 
+        # :attr: name
+        #
+        # The name of the condition
+
+        ## 
+        # :attr: statement
+        #
+        # The statement of the condition, should be a varnish if statement line
+
+        ## 
+        # :attr: priority
+        #
+        # What order to run them in, higher priority gets executed after lower priority
+
+        ## 
+        # :attr: type
+        #
+        # request, cache or response
+        #
+        # request has req. object only
+        # cache has req. and beresp.
+        # response has req. and resp.
+    end
+end

data/lib/fastly/gem_version.rb

@@ -0,0 +1,4 @@
+class Fastly
+  # The current version of the library
+  VERSION = "1.01"
+end

data/lib/fastly/service.rb

@@ -59,13 +59,13 @@ class Fastly
 
     # Purge all assets from this service.
     def purge_all
-      res = client.put(get_path(self.id)+"/purge_all")
+      res = fetcher.client.post(Fastly::Service.get_path(self.id)+"/purge_all")
     end
 
 
     # Purge anything with the specific key from the given service.
     def purge_by_key(key)
-       res = client.put(get_path(self.id)+"/purge/#{key}")
+       res = fetcher.client.post(Fastly::Service.get_path(self.id)+"/purge/#{key}")
     end
 
     # Set all the versions that this service has had.
@@ -85,7 +85,7 @@ class Fastly
     
     # A deep hash of nested details
     def details(opts={})
-      client.get(get_path(self.id)+"/details", opts);
+      fetcher.client.get(Fastly::Service.get_path(self.id)+"/details", opts);
     end
     
     # Get the Customer object for this Service
@@ -109,4 +109,4 @@ class Fastly
     return nil if hash.nil?
     klass.new(hash, self)
   end
-end
+end

data/lib/fastly/settings.rb

@@ -19,7 +19,6 @@ class Fastly
     #
     # Return a hash containing key/value pairs of settings
     #
-    
 
     # :nodoc:
     def self.get_path(service, number)
@@ -38,12 +37,12 @@ class Fastly
 
     # :nodoc:
     def self.post_path 
-      raise "You can't POST to an invoice"
+      raise "You can't POST to an setting"
     end
 
     # :nodoc:
     def self.delete_path
-      raise "You can't DELETE to an invoice"
+      raise "You can't DELETE to an setting"
     end
     
     # :nodoc:
@@ -59,7 +58,13 @@ class Fastly
   
   # Get the Settings object for the specified Version
   def get_settings(service, number)
-    get(Fastly::Settings, service, number)
+    klass            = Fastly::Settings
+    hash             = client.get(Fastly::Settings.get_path(service, number))
+    
+    return nil if hash.nil?
+    hash["settings"] = Hash[["general.default_host", "general.default_ttl"].collect { |var| [var, hash.delete(var)] }]
+    
+    return klass.new(hash, self)
   end
 
   # Update the Settings object for the specified Version

data/lib/fastly/syslog.rb

@@ -1,7 +1,7 @@
 class Fastly
     # An endpoint to stream syslogs to 
     class Syslog < BelongsToServiceAndVersion
-        attr_accessor :service_id, :name, :comment, :ipv4, :ipv6, :hostname, :port, :format
+        attr_accessor :service_id, :name, :comment, :ipv4, :ipv6, :hostname, :port, :format, :response_conditions
 
         ## 
         # :attr: service_id
@@ -61,5 +61,10 @@ class Fastly
         # :attr: format
         # 
         # Format to log like in apache format
+        
+        ## 
+        # :attr: response_condition
+        #
+        # name of a response_condition to filter the log on, if empty it always logs
     end
 end

data/test/common.rb

@@ -139,9 +139,12 @@ module CommonTests
     assert tmp
     assert_equal name, tmp.name
 
-    stats       = service.stats
-    assert stats
-    
+    begin
+      stats       = service.stats
+    rescue Fastly::Error => e
+    end
+    assert stats.nil?
+       
     stats       = service.stats(:all, :year => 2011, :month => 10)
     assert stats    
   end

data/test/helper.rb

@@ -1,3 +1,4 @@
+require 'fastly'
 require File.expand_path(File.dirname(__FILE__) + '/common')
 
 def login_opts(mode=:full)

data/test/stats_test.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+FROM = "2011-01-01 00:00:00"
+
+class StatsTest < Test::Unit::TestCase
+
+  def setup
+    opts = login_opts(:api_key).merge(:use_curb => false)
+    begin
+      @fastly = Fastly.new(opts)
+    rescue Exception => e
+      warn e.inspect
+      warn e.backtrace.join("\n")
+      exit(-1)
+    end
+  end
+
+  def test_regions
+    regions = @fastly.regions
+    assert(regions.size>0)
+  end
+
+  def test_usage
+    usage = @fastly.usage(:from => FROM)
+    assert(usage["usa"], "Found a USA region in usage");
+    assert(usage["usa"]["requests"], "USA region has a requests field");
+
+    usage = @fastly.usage(:from => FROM, :by_service => 1)
+    assert(usage["usa"], "Found a USA region in usage");
+    assert(usage["usa"]["requests"].nil?, "USA region doesn't have a requests field");
+  end
+
+
+  def test_stats
+    stats = @fastly.stats(:from => $FROM)
+    service1, service2 = stats.keys
+    assert(stats[service1][0]["requests"], "Found requests")
+    assert(stats[service1][0]["hits"], "Found hits")
+    assert(stats[service2][0]["requests"], "Found requests")
+    assert(stats[service2][0]["hits"], "Found hits")
+
+    stats = @fastly.stats(:from => $FROM, :field => "requests")
+    assert(stats[service1][0]["requests"],  "Found requests")
+    assert(stats[service1][0]["hits"].nil?, "Didn't find hits")
+    assert(stats[service2][0]["requests"],  "Found requests")
+    assert(stats[service2][0]["hits"].nil?, "Didn't find hits")
+
+    stats = @fastly.stats(:from => $FROM, :service => service1)
+    assert_equal(stats[0]["service_id"], service1, "Got correct service id")
+    assert(stats[0]["requests"], "Found requests")
+    assert(stats[0]["hits"], "Found hits")
+
+    stats = @fastly.stats(:from => $FROM, :field => "requests", :service => service1)
+    assert_equal(stats[0]["service_id"], service1, "Got correct service id")
+    assert(stats[0]["requests"], "Found requests")
+    assert(stats[0]["hits"].nil?, "Didn't find hits")
+
+    stats = @fastly.stats(:from => $FROM, :aggregate => true)
+    assert(stats[0]["service_id"].nil?, "No service id")
+    assert(stats[0]["requests"], "Found requests")
+    assert(stats[0]["hits"], "Found hits")
+
+    stats = nil
+    # stats aggregate with field
+    begin
+      stats = @fastly.stats(:from => $FROM, :field => "requests", :aggregate => true)
+    rescue Fastly::Error => e
+    end
+    assert stats.nil?
+
+    # stats aggregate with service
+    begin
+      stats = @fastly.stats(:from => $FROM, :service => service1, :aggregate => true)
+    rescue Fastly::Error => e
+    end
+    assert stats.nil?
+
+    begin
+      stats = @fastly.stats(:from => $FROM, :service => service1, :field => "requests", :aggregate => true)
+    rescue Fastly::Error => e
+    end
+    assert stats.nil?
+  end
+
+end

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: fastly
 version: !ruby/object:Gem::Version 
-  version: "1.00"
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  version: "1.01"
 platform: ruby
 authors: 
 - Fastly Inc
@@ -9,16 +13,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-16 00:00:00 Z
+date: 2013-10-03 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - &id005 
-      - ">="
+    - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -29,6 +35,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 15
         version: 0.7.15
   type: :runtime
   version_requirements: *id002
@@ -39,6 +49,10 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
         version: 0.6.1
   type: :runtime
   version_requirements: *id003
@@ -49,6 +63,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 11
         version: "3.11"
   type: :runtime
   version_requirements: *id004
@@ -74,10 +91,12 @@ files:
 - lib/fastly/base.rb
 - lib/fastly/belongs_to_service_and_version.rb
 - lib/fastly/client.rb
+- lib/fastly/condition.rb
 - lib/fastly/customer.rb
 - lib/fastly/director.rb
 - lib/fastly/domain.rb
 - lib/fastly/fetcher.rb
+- lib/fastly/gem_version.rb
 - lib/fastly/healthcheck.rb
 - lib/fastly/invoice.rb
 - lib/fastly/match.rb
@@ -93,11 +112,11 @@ files:
 - test/common.rb
 - test/full_login_test.rb
 - test/helper.rb
+- test/stats_test.rb
+has_rdoc: true
 homepage: http://github.com/fastly/fastly-ruby
 licenses: []
 
-metadata: {}
-
 post_install_message: 
 rdoc_options: []
 
@@ -105,16 +124,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - *id005
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - *id005
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Client library for the Fastly acceleration system
 test_files: 
 - test/admin_test.rb
@@ -122,4 +149,4 @@ test_files:
 - test/common.rb
 - test/full_login_test.rb
 - test/helper.rb
-has_rdoc: 
+- test/stats_test.rb

checksums.yaml

@@ -1,7 +0,0 @@
---- 
-SHA512: 
-  data.tar.gz: 173bc2e9d43fbf193a73830700cbd0909e8999a204605330cfbfb9b8d773aacde089c9902f98ddedaad8166d8d412e2475c44bc784e7d0884a61b6c8599d7fd2
-  metadata.gz: 68c1f14d18fd3894e3c15864509db3984f57a4dde8a9b804ffe20b24df981d3512eb4f7446042971d677d138017ec1a092fe022bc2036c89ee8a90c24af84bc9
-SHA1: 
-  data.tar.gz: 3090d1395750ed869ebd3cc8947d38c688f99217
-  metadata.gz: 43141d3014baaca138f007d90e1de1411e80bf2a