fastly 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ef98fd25ca8d8bc9e1b8a59c3f9871bf55297c3
-  data.tar.gz: ca25acfcc5fc2530bb4fe0b3684444de0cc2060b
+  metadata.gz: 0270d26d5f2da61fe372839853d8710120d239bb
+  data.tar.gz: a5354c14c11c76a1a0ec5e4a129f7a90a0cd6fe2
 SHA512:
-  metadata.gz: 342af0046a3402e92d87d2c0dfabf93ffba77674ffe817e21f11ff66f65c0ec14f8b3f02278359865b3898394fe2c8016f6b12297adc1c64d8da8a1d10b2821a
-  data.tar.gz: b9a5b946c3525e4bfe6f6ccf7a186136a5349c5bd9f87d633f3309873a850061397a8b19f3525dcadec20b9f0cf4d1738dd48a9d38860fc578b3feb92e10d3a1
+  metadata.gz: 85ec2dddf754bdc0f3f8f574877641195bd6c19ede0782a8008ca785a7530b4a4bf56ca2d10aa3449b21b294f30183dbfcbbd3fbc7c858bfd4bfc2cf27356d65
+  data.tar.gz: d2d3c5ede4170d3592266be5865f6165e75c6ba71204999859fa53107a9f21ac8b820622143db28320f052f411d1e5e17c0c1426ca9f214ce4a5428c9ed1c39f

data/HISTORY.md

@@ -1,14 +1,16 @@
 # HEAD
 
+# 2014-09-29 v1.1.4
+* Require API for purge by key
 
-# 2014-07-25 v1.1.3
+#### 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
+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/bin/fastly_create_domain

@@ -1,10 +1,10 @@
 #!/bin/env ruby
 
 ##
-# fastly_upload_vcl - upload raw VCL files to Fastly
+# fastly_create_domain - ruby script to quickly create a fastly domain
 #
 # Author::   Fastly Inc <support@fastly.com>
-# Copyright:: Copyright (c) 2011 Fastly Inc
+# Copyright:: Copyright (c) 2014 Fastly Inc
 # License::   Distributes under the same terms as Ruby
 #
 # = USAGE
@@ -19,7 +19,7 @@
 # 
 # Alternatively you can pass in any of those options on the command line
 # 
-#     fastly_create_domain --api_key=<key> <service id> <domain name>
+#     $ ruby fastly_create_domain --api_key=<key> <service id> <domain name>
 
 require 'rubygems'
 require 'fastly'

data/lib/fastly/base.rb

@@ -11,51 +11,54 @@ class Fastly
         @keys.push(key)
       end
       self.fetcher = fetcher
-     end
-
-     # Save this object
-     def save!
-       fetcher.update(self.class, self)
-     end
-
-     # Delete this object
-     def delete!
-       fetcher.delete(self.class, self)
-     end
-
-     ##
-     # :nodoc:
-     def as_hash
-       ret = {}
-       @keys.each do |key|
-         ret[key] = self.send("#{key}") unless key =~ /^_/;
-       end
-       ret
-     end
-
-     def self.path
-       Util.class_to_path(self)
-     end
-
-     def self.get_path(id)
-       "/#{path}/#{id}"
-     end
-
-     def self.post_path(opts={})
-       "/#{path}"
-     end
-
-     def self.list_path(opts={})
-       post_path(opts)
-     end
-
-     def self.put_path(obj)
-       get_path(obj.id)
-     end
-
-     def self.delete_path(obj)
-       put_path(obj)
-     end
+    end
 
+    # Save this object
+    def save!
+      fetcher.update(self.class, self)
+    end
+
+    # Delete this object
+    def delete!
+      fetcher.delete(self.class, self)
+    end
+
+    ##
+    # :nodoc:
+    def as_hash
+      ret = {}
+      @keys.each do |key|
+        ret[key] = self.send("#{key}") unless key =~ /^_/;
+      end
+      ret
+    end
+
+    def require_api_key!
+      fetcher.client.require_key!
+    end
+
+    def self.path
+      Util.class_to_path(self)
+    end
+
+    def self.get_path(id)
+      "/#{path}/#{id}"
+    end
+
+    def self.post_path(opts={})
+      "/#{path}"
+    end
+
+    def self.list_path(opts={})
+      post_path(opts)
+    end
+
+    def self.put_path(obj)
+      get_path(obj.id)
+    end
+
+    def self.delete_path(obj)
+      put_path(obj)
+    end
   end
 end

data/lib/fastly/client.rb

@@ -6,168 +6,183 @@ require 'pp'
 require 'uri'
 
 class Fastly
-    # The UserAgent to communicate with the API
-    class Client #:nodoc: all
-        begin
-            require 'curb-fu'
-            CURB_FU=true
-        rescue LoadError
-            CURB_FU=false
-        end
+  # The UserAgent to communicate with the API
+  class Client #:nodoc: all
+    begin
+      require 'curb-fu'
+      CURB_FU=true
+    rescue LoadError
+      CURB_FU=false
+    end
 
-        attr_accessor :http, :api_key, :user, :password, :cookie, :customer
-
-        def initialize(opts)
-            [:api_key, :user, :password].each do |key|
-                self.send("#{key}=", opts[key]) if opts.has_key?(key)
-            end
-            base      = opts[:base_url]      || "https://api.fastly.com"
-            customer  = opts[:customer]
-            uri       = URI.parse(base)
-            scheme    = uri.scheme
-            host      = uri.host
-            curb      = opts.has_key?(:use_curb)  ? !!opts[:use_curb] && CURB_FU : CURB_FU
-            port      = opts.has_key?(:base_port) ?   opts[:base_port]           : (scheme == "https") ? 443 : 80
-            self.http = curb ? Fastly::Client::Curl.new(host, port) : Net::HTTP.new(host, port)
-            self.http.use_ssl = (scheme == "https")
-            return self unless fully_authed?
-
-            # If we're fully authed (i.e username and password ) then we need to log in
-            resp = self.http.post('/login', make_params(:user => user, :password => password))
-            raise Fastly::Unauthorized unless resp.success?
-            self.cookie = resp['set-cookie']
-            content     = JSON.parse(resp.body)
-            #return self, content['user'], content['content']
-            self
-        end
+    attr_accessor :http, :api_key, :user, :password, :cookie, :customer
+
+    def initialize(opts)
+      [:api_key, :user, :password].each do |key|
+        self.send("#{key}=", opts[key]) if opts.has_key?(key)
+      end
+      base      = opts[:base_url]      || "https://api.fastly.com"
+      uri       = URI.parse(base)
+      scheme    = uri.scheme
+      host      = uri.host
+      curb      = opts.has_key?(:use_curb)  ? !!opts[:use_curb] && CURB_FU : CURB_FU
+      port      = opts.has_key?(:base_port) ?   opts[:base_port]           : (scheme == "https") ? 443 : 80
+      self.http = curb ? Fastly::Client::Curl.new(host, port) : Net::HTTP.new(host, port)
+      self.http.use_ssl = (scheme == "https")
+      return self unless fully_authed?
+
+      # If we're fully authed (i.e username and password ) then we need to log in
+      resp = self.http.post('/login', make_params(:user => user, :password => password))
+      raise Fastly::Unauthorized unless resp.success?
+      self.cookie = resp['set-cookie']
+    end
 
+    def require_key!
+      raise Fastly::AuthRequired.new("This request requires an API key") if api_key.nil?
 
-        def authed?
-            !api_key.nil? || fully_authed?
-        end
+      @require_key = true
+    end
 
-        # Some methods require full username and password rather than just auth token
-        def fully_authed?
-            !(user.nil? || password.nil?)
-        end
+    def require_key?
+      !!@require_key
+    end
 
-        def set_customer(id)
+    def authed?
+      !api_key.nil? || fully_authed?
+    end
 
-        end
+    # Some methods require full username and password rather than just auth token
+    def fully_authed?
+      !(user.nil? || password.nil?)
+    end
 
-        def get(path, params={})
-            path += "?"+make_params(params) unless params.empty?
-            resp  = self.http.get(path, headers)
-            return nil if 404 == resp.status
-            raise Fastly::Error, resp.message unless resp.success?
-            JSON.parse(resp.body)
-        end
+    def set_customer(id)
 
-        def get_stats(path, params={})
-            content = get(path, params)
-            raise Fastly::Error, content["message"] unless content["status"] == 'success'
-            content["data"]
-        end
+    end
 
-        def post(path, params={})
-            post_and_put(:post, path, params)
-        end
+    def get(path, params={})
+      path += "?"+make_params(params) unless params.empty?
+      resp  = self.http.get(path, headers)
+      return nil if 404 == resp.status
+      raise Fastly::Error, resp.message unless resp.success?
+      JSON.parse(resp.body)
+    end
 
-        def put(path, params={})
-            post_and_put(:put, path, params)
-        end
+    def get_stats(path, params={})
+      content = get(path, params)
+      raise Fastly::Error, content["message"] unless content["status"] == 'success'
+      content["data"]
+    end
 
-        def delete(path)
-            resp  = self.http.delete(path, headers)
-            return resp.success?
-        end
+    def post(path, params={})
+      post_and_put(:post, path, params)
+    end
 
-        private
+    def put(path, params={})
+      post_and_put(:put, path, params)
+    end
 
-        def post_and_put(method, path, params={})
-            query = make_params(params)
-            resp  = self.http.send(method, path, query, headers.merge( 'Content-Type' =>  "application/x-www-form-urlencoded"))
-            raise Fastly::Error, resp.message unless resp.success?
-            JSON.parse(resp.body)
-        end
+    def delete(path)
+      resp  = self.http.delete(path, headers)
+      return resp.success?
+    end
 
-        def headers
-            headers = fully_authed? ? { 'Cookie' => cookie } : { 'X-Fastly-Key' => api_key }
-            headers.merge( 'Fastly-Explicit-Customer' => customer ) if customer
-            headers.merge( 'Content-Accept' => 'application/json')
-        end
+    private
 
-        def make_params(params)
-            params.map { |key,val|
-                next if val.nil?
-                unless val.is_a?(Hash)
-                    "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
+    def post_and_put(method, path, params={})
+      query = make_params(params)
+      resp  = self.http.send(method, path, query, headers.merge( 'Content-Type' =>  "application/x-www-form-urlencoded"))
+      raise Fastly::Error, resp.message unless resp.success?
+      JSON.parse(resp.body)
+    end
+
+    def headers
+      headers = if require_key?
+                  api_key_header
                 else
-                    val.map { |sub_key, sub_val|
-                        new_key = "#{key}[#{sub_key}]"
-                        "#{CGI.escape(new_key)}=#{CGI.escape(sub_val.to_s)}"
-                    }
+                  fully_authed? ? { 'Cookie' => cookie } : api_key_header
                 end
-            }.flatten.delete_if { |v| v.nil? }.join("&")
+      headers.merge!('Fastly-Explicit-Customer' => customer) if customer
+      headers.merge!('Content-Accept' => 'application/json')
+    ensure
+      @require_key = nil
+    end
+
+    def api_key_header
+      { 'X-Fastly-Key' => api_key }
+    end
+
+    def make_params(params)
+      params.map { |key,val|
+        next if val.nil?
+        unless val.is_a?(Hash)
+          "#{CGI.escape(key.to_s)}=#{CGI.escape(val.to_s)}"
+        else
+          val.map { |sub_key, sub_val|
+            new_key = "#{key}[#{sub_key}]"
+            "#{CGI.escape(new_key)}=#{CGI.escape(sub_val.to_s)}"
+          }
         end
+      }.flatten.delete_if { |v| v.nil? }.join("&")
+    end
 
-        # :nodoc: all
-        class Curl
-            attr_accessor :host, :port, :protocol
+    # :nodoc: all
+    class Curl
+      attr_accessor :host, :port, :protocol
 
-            def initialize(host, port=443)
-                self.host     = host
-                self.port     = port
-                self.protocol = 'https'
-            end
+      def initialize(host, port=443)
+        self.host     = host
+        self.port     = port
+        self.protocol = 'https'
+      end
 
-            def get(path, headers={})
-                CurbFu.get({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol })
-            end
+      def get(path, headers={})
+        CurbFu.get({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol })
+      end
 
-            def post(path, params, headers={})
-                CurbFu.post({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol }, params)
-            end
+      def post(path, params, headers={})
+        CurbFu.post({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol }, params)
+      end
 
-            def put(path, params, headers={})
-                CurbFu.put({ :host => host, :port => port, :path => path, :headers => headers, :params => params, :protocol => protocol }, params)
-            end
+      def put(path, params, headers={})
+        CurbFu.put({ :host => host, :port => port, :path => path, :headers => headers, :params => params, :protocol => protocol }, params)
+      end
 
-            def delete(path, headers={})
-                CurbFu.delete({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol })
-            end
+      def delete(path, headers={})
+        CurbFu.delete({ :host => host, :port => port, :path => path, :headers => headers, :protocol => protocol })
+      end
 
-            def use_ssl=(ssl)
-                self.protocol = ssl ? 'https' : 'http'
-            end
-        end
+      def use_ssl=(ssl)
+        self.protocol = ssl ? 'https' : 'http'
+      end
     end
+  end
 end
 
 # :nodoc: all
 class Net::HTTPResponse
-    def success?
-        return Net::HTTPSuccess === self
-    end
+  def success?
+    return Net::HTTPSuccess === self
+  end
 
-    def status
-        return self.code.to_i
-    end
+  def status
+    return self.code.to_i
+  end
 end
 
 
 
 # :nodoc: all
 class CurbFu::Response::Base
-    def get_fields(key)
-        if ( match = @headers.find{|k,v| k.downcase == key.downcase} )
-            [match.last].flatten
-        else
-            []
-        end
+  def get_fields(key)
+    if ( match = @headers.find{|k,v| k.downcase == key.downcase} )
+      [match.last].flatten
+    else
+      []
     end
+  end
 
-    def [](key)
-        get_fields(key).last
-    end
+  def [](key)
+    get_fields(key).last
+  end
 end

data/lib/fastly/gem_version.rb

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

data/lib/fastly/service.rb

@@ -59,13 +59,14 @@ class Fastly
 
     # Purge all assets from this service.
     def purge_all
-      res = fetcher.client.post(Fastly::Service.get_path(self.id)+"/purge_all")
+      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 = fetcher.client.post(Fastly::Service.get_path(self.id)+"/purge/#{key}")
+      require_api_key!
+
+      fetcher.client.post(Fastly::Service.get_path(self.id)+"/purge/#{key}")
     end
 
     # Set all the versions that this service has had.

data/test/api_key_test.rb

@@ -26,7 +26,6 @@ class ApiKeyTest < Fastly::TestCase
     assert_equal @opts[:customer], customer['name']
   end
 
-
   def test_current_user_and_customer
     current_user  = current_customer = nil
     assert_raise(Fastly::FullAuthRequired) {
@@ -39,7 +38,6 @@ class ApiKeyTest < Fastly::TestCase
     assert_equal @opts[:customer], customer.name
   end
 
-
   def test_purging
     #assert @fastly.purge('foo')
     # TODO Won't work until we get fixtures in Heavenly

data/test/missing_api_key_test.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class MissingApiKeyTest < Fastly::TestCase
+  include CommonTests
+
+  def setup
+    # missing API key
+    @opts = login_opts(:full)
+    begin
+      @client = Fastly::Client.new(@opts)
+      @fastly = Fastly.new(@opts)
+    rescue Exception => e
+      pp e
+      exit(-1)
+    end
+  end
+
+  def test_purging
+    service_name = "fastly-test-service-#{get_rand}"
+    service      = @fastly.create_service(:name => service_name)
+
+    assert_raises Fastly::AuthRequired do
+      service.purge_by_key('somekey')
+    end
+  ensure
+    @fastly.delete_service(service)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Fastly Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -92,6 +92,7 @@ files:
 - test/fastly/util_test.rb
 - test/full_login_test.rb
 - test/helper.rb
+- test/missing_api_key_test.rb
 - test/stats_test.rb
 - test/test_helper.rb
 homepage: http://github.com/fastly/fastly-ruby
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Client library for the Fastly acceleration system
@@ -125,5 +126,6 @@ test_files:
 - test/fastly/util_test.rb
 - test/full_login_test.rb
 - test/helper.rb
+- test/missing_api_key_test.rb
 - test/stats_test.rb
 - test/test_helper.rb