Client library for interacting with the Fastly web acceleration service API
Examples
Add fastly to your Gemfile:
gem 'fastly'
Create a fastly client:
# some_file.rb
# use {api_key: 'your-key'} or {user: 'username', password: 'password'} as login options
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}"
List the 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)
Activate the service:
latest_version.activate!
You're now hosted on Fastly.
Let's look at the VCL that Fastly generated for us:
vcl = latest_version.generated_vcl
puts "Generated VCL file is:"
puts 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)
Upload some custom VCL (presuming we have permissions):
custom_vcl = File.read(vcl_file)
new_version.upload_vcl(vcl_name, custom_vcl)
Set the custom VCL as the service's main VCL
new_version.vcl(vcl_name).set_main!
new_version.activate!
Efficient purging
Purging requires your Fastly credentials and the service you want to purge content from. To purge efficiently you do not want to look up the service every time you issue a purge:
fastly = Fastly.new(api_key: 'YOUR_API_KEY')
service = Fastly::Service.new({ id: 'YOUR_SERVICE_ID' }, fastly)
# purge an individual url
fastly.purge(url)
# purge everything:
service.purge_all
# purge by key:
service.purge_by_key('YOUR_SURROGATE_KEY')
# 'soft' purging
# see https://docs.fastly.com/guides/purging/soft-purges
fastly.purge(url, true)
service.purge_by_key('YOUR_SURROGATE_KEY', true)
You can also purge without involving the Fastly client by sending a PURGE request directly
to the URL you want to purge. You can also send a POST request to the API with your Fastly API key
in a Fastly-Key
header:
curl -X PURGE YOUR URL
curl -H 'Fastly-Key: YOUR_API_KEY' -X POST \
https://api.fastly.com/service/YOUR_SERVICE_ID/purge/YOUR_SURROGATE_KEY
Previously purging made an POST call to the /purge
endpoint of the Fastly API.
The new method of purging is done by making an HTTP request against the URL using the PURGE
HTTP method.
This gem now uses the new method. The old method can be used by passing the use_old_purge_method
option into the constructor.
fastly = Fastly.new(login_opts.merge(use_old_purge_method: true))
fastly.purge(url, true)
service.purge_by_key('YOUR_SURROGATE_KEY', true)
See the Fastly purging API documentation for more information and examples.
Usage notes
If you are performing many purges per second we recommend you use the API directly with an HTTP client of your choice. See Efficient Purging above.
fastly-ruby has not been audited for thread-safety. If you are performing actions that require multiple threads (such as performing many purges) we recommend you use the API directly.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Notes for testing
The test suite requires the following ENV
variables to be set:
FASTLY_TEST_USER
- Your user emailFASTLY_TEST_PASSWORD
- Your account passwordFASTLY_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.