fastly 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41770bdcf1d13d916bbc1c33620497ced6259270
-  data.tar.gz: ddf4eb5b4b18d0932ddf340dffe73571ac47f68b
+  metadata.gz: 6d5c728bbd87d08a643b21e96f1fb7876e6ff740
+  data.tar.gz: 7a140e024d66ce6d6117f60ad7e0b13aa8d6094a
 SHA512:
-  metadata.gz: 9602cf07f2d1f405f13afb0ea0aca1238722ebf5539b0c1e8079058b487027d541ce29d83f31145fcc4fb3e7c7e40c7e48976eac113265c8149dfa089c92890f
-  data.tar.gz: 529cc34f51929cf9dbb8b876002a79709348427ba57b1e4e698fa7f5d20549d11188b88714c9535b2a83446acf96b58446728de4ec0c99f526c5cd2aacaac9c7
+  metadata.gz: 18e471560d67453d3c1fe17f91542050f1e8feb5aac1b2566b0bace8703e1ac50c8fd6eb55803c670f6f1aab345edb2661995be4b62caaad7f6e9e228398d136
+  data.tar.gz: 18da338c2b1c674c2c1bc982ba361751b3c032efb5329a4b67e70fabddd52bfa43cc7f470f73597eb5a1a46586fb9577d3f127daa61a94d606b13888143ae302

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 1.4.0 / 2016-05-09
+  * Adds support for soft purge for a service
+
 ### 1.3.0 / 2016-04-04
   * Adds missing fields for Backend, Healthcheck, S3, & Syslog (@raybejjani)
   * URL escape names when used in URLs (@raybejjani)

data/README.md

@@ -132,21 +132,44 @@ 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 at all by sending a POST
-request with your Fastly API key in a `Fastly-Key` header:
+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.
+
+```ruby
+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](https://docs.fastly.com/api/purge)
 for more information and examples.
 

data/lib/fastly.rb

@@ -74,8 +74,8 @@ class Fastly
   end
 
   # Purge the specified path from your cache.
-  def purge(path)
-    client.post("/purge/#{path}")
+  def purge(url, soft=false)
+    client.purge(url, soft ? { headers: { 'Fastly-Soft-Purge' => "1"} } : {})
   end
 
   # Fetches historical stats for each of your fastly services and groups the results by service id.

data/lib/fastly/client.rb

@@ -13,6 +13,7 @@ class Fastly
       @user     = opts.fetch(:user, nil)
       @password = opts.fetch(:password, nil)
       @customer = opts.fetch(:customer, nil)
+      @oldpurge = opts.fetch(:use_old_purge_method, false)  
 
       base    = opts.fetch(:base_url, 'https://api.fastly.com')
       uri     = URI.parse(base)
@@ -60,8 +61,9 @@ class Fastly
     end
 
     def get(path, params = {})
+      extras = params.delete(:headers) || {}
       path += "?#{make_params(params)}" unless params.empty?
-      resp  = http.get(path, headers)
+      resp  = http.get(path, headers(extras))
       fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
       JSON.parse(resp.body)
     end
@@ -85,23 +87,37 @@ class Fastly
       post_and_put(:put, path, params)
     end
 
-    def delete(path)
-      resp  = http.delete(path, headers)
+    def delete(path, params = {})
+      extras = params.delete(:headers) || {}
+      resp  = http.delete(path, headers(extras))
       resp.kind_of?(Net::HTTPSuccess)
     end
 
+    def purge(url, params = {})
+      return post("/purge/#{url}", params) if @oldpurge
+
+      extras = params.delete(:headers) || {}
+      uri    = URI.parse(url)
+      http   = Net::HTTP.new(uri.host, uri.port)
+      resp   = http.request Net::HTTP::Purge.new(uri.request_uri, headers(extras))
+
+      fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
+      JSON.parse(resp.body)
+    end
+
     private
 
     def post_and_put(method, path, params = {})
+      extras = params.delete(:headers) || {}
       query = make_params(params)
-      resp  = http.send(method, path, query, headers.merge('Content-Type' =>  'application/x-www-form-urlencoded'))
+      resp  = http.send(method, path, query, headers(extras).merge('Content-Type' =>  'application/x-www-form-urlencoded'))
       fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
       JSON.parse(resp.body)
     end
 
-    def headers
+    def headers(extras={})
       headers = fully_authed? ? { 'Cookie' => cookie } : { 'Fastly-Key' => api_key }
-      headers.merge('Content-Accept' => 'application/json')
+      headers.merge('Content-Accept' => 'application/json').merge(extras.keep_if {|k,v| !v.nil? })
     end
 
     def make_params(params)
@@ -122,3 +138,10 @@ class Fastly
     end
   end
 end
+
+# See Net::HTTPGenericRequest for attributes and methods.
+class Net::HTTP::Purge < Net::HTTPRequest
+  METHOD = 'PURGE'
+  REQUEST_HAS_BODY = false
+  RESPONSE_HAS_BODY = true
+end

data/lib/fastly/gem_version.rb

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

data/lib/fastly/service.rb

@@ -69,9 +69,9 @@ class Fastly
     # Purge anything with the specific key from the given service.
     #
     # See README.md for examples of purging
-    def purge_by_key(key)
+    def purge_by_key(key, soft=false)
       require_api_key!
-      fetcher.client.post("#{Service.get_path(id)}/purge/#{key}")
+      fetcher.client.post("#{Service.get_path(id)}/purge/#{key}", soft ? { headers: { 'Fastly-Soft-Purge' => "1"} } : {})
     end
 
     # Get a sorted array of all the versions that this service has had.

data/test/api_key_test.rb

@@ -22,6 +22,32 @@ class Fastly
         assert_instance_of Hash, client.get('/current_customer')
         assert_instance_of Customer, fastly.current_customer
       end
+
+      describe 'purging' do
+        before do
+          @opts = login_opts(:api_key)
+            @client = Fastly::Client.new(@opts)
+            @fastly = Fastly.new(@opts)
+          service_name = "fastly-test-service-#{random_string}"
+          @service      = @fastly.create_service(:name => service_name)
+        end
+
+        after do
+          @fastly.delete_service(@service)
+        end
+
+        it 'allows purging' do
+          response = @service.purge_by_key('somekey')
+
+          assert_equal 'ok', response['status']
+        end
+
+        it 'allows soft purging' do
+          response = @service.purge_by_key('somekey', soft: true)
+
+          assert_equal 'ok', response['status']
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies: []
 description: Client library for the Fastly acceleration system
 email: