fastly 2.3.1 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee6396bd0e7d921f65997b2e7ed8c76b2e3c88e625ed3c3d4031d63d7a84e4c
-  data.tar.gz: 23d32988518aa888155cd666723ae0cb8e3d755f485ee07ff6fdded248717e3d
+  metadata.gz: ff6374dedf0a4320acb1bb370b700f31dffbb841ad039e717c9b6bd713a6cb5a
+  data.tar.gz: f53667b8fa95b6e9cf013ec23c94feee19b860c28de60aba3fee4ddd17ffaa4c
 SHA512:
-  metadata.gz: 3ac2c02f762d8d6bcbac8251e22952e8f676507a7738b9e3220d63c30d91d81c2d7ded9dd99d176d8e60c96cfe47d5816890e23b43dcf26e15d48a56de8b80b8
-  data.tar.gz: d12772e06afba3f1577b76fce4c4818b772ac4189a12b6fb831ac99540078a0b0709b777e62e70b6e42e4d863b463e44ebf096b1bc2b0f01693a4e5f07395ecf
+  metadata.gz: f3115a7e69149466f180e3d823c13ef9d4a895178a6e33e02522afa1b5551df59da7655dd3c316eba9cb0be0df2494b2b2f4a6803a2ec6b04cb8f4f1b06be11f
+  data.tar.gz: c7a1a39686da60e1986b24d7ef7d94cdba247e29117a99bed51924e23716da3dc72cc44869e1b711f75745309ff71597c165d2048fb5b43ed38fa6d0d2fc4e88

data/.env.example

@@ -0,0 +1,3 @@
+FASTLY_TEST_USER=
+FASTLY_TEST_PASSWORD=
+FASTLY_TEST_API_KEY=

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change Log
 
+## [v2.5.0](https://github.com/fastly/fastly-ruby/tree/v2.5.0) (2020-01-16)
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v2.4.0...v2.5.0)
+
+**Merged pull requests:**
+
+- Add tokens.rb [\#150](https://github.com/fastly/fastly-ruby/pull/150) ([malachy-mcconnell](https://github.com/malachy-mcconnell))
+
+## [v2.4.0](https://github.com/fastly/fastly-ruby/tree/v2.4.0) (2019-07-29)
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v2.3.1...v2.4.0)
+
+**Merged pull requests:**
+
+- \[Backend\] Add override\_host attribute for Backend [\#146](https://github.com/fastly/fastly-ruby/pull/146) ([werkshy](https://github.com/werkshy))
+
+## [v2.3.1](https://github.com/fastly/fastly-ruby/tree/v2.3.1) (2019-07-25)
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v2.3.0...v2.3.1)
+
+**Merged pull requests:**
+
+- Correct stats API path [\#147](https://github.com/fastly/fastly-ruby/pull/147) ([thommahoney](https://github.com/thommahoney))
+
 ## [v2.3.0](https://github.com/fastly/fastly-ruby/tree/v2.3.0) (2019-04-26)
 [Full Changelog](https://github.com/fastly/fastly-ruby/compare/v2.2.0...v2.3.0)
 

data/Gemfile

@@ -4,10 +4,14 @@ gemspec
 
 group :development, :test do
   gem 'appraisal', '~> 2.1'
-  gem 'rake', '~> 10.3.2'
+  gem 'rake', '>= 12.3.3'
   gem 'rdoc', '~> 4.1.1'
   gem 'minitest', '~> 5.3.4'
   gem 'pry'
   gem 'rubocop', '~> 0.57.2', require: false
   gem 'webmock'
 end
+
+group :test do
+  gem 'dotenv'
+end

data/README.md

@@ -202,19 +202,23 @@ This option should not be used in a production setting as all HTTP headers, requ
 
 ### Notes for testing
 
-The test suite requires the following `ENV` variables to be set:
+The test suite tests create and delete three services in sequence, so you may want to create an account just for these tests.
 
-* `FASTLY_TEST_USER` - Your user email
-* `FASTLY_TEST_PASSWORD` - Your account password
-* `FASTLY_TEST_API_KEY` - Your API key (found at https://app.fastly.com/#account)
+To run the test suite:
 
-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.
+1. Generate a personal token for these tests: https://manage.fastly.com/account/personal/tokens
+
+2. Copy `.env.example` to `.env` and add the values for the variables:
+
+  * `FASTLY_TEST_USER` - Your user email
+  * `FASTLY_TEST_PASSWORD` - Your account password
+  * `FASTLY_TEST_API_KEY` - Your personal token
+
+3. Run the tests via `bundle exec rake test:unit`
 
 ## Copyright
 
-Copyright 2011-2014 - Fastly Inc
+Copyright 2011-2020 - Fastly, Inc.
 
 ## Redistribution
 

data/lib/fastly.rb

@@ -34,6 +34,7 @@ require 'fastly/snippet'
 require 'fastly/dynamic_snippet'
 require 'fastly/sumologic_logging'
 require 'fastly/syslog'
+require 'fastly/token'
 require 'fastly/s3_logging'
 require 'fastly/gcs_logging'
 require 'fastly/user'
@@ -151,7 +152,7 @@ class Fastly
     client.get_stats('/stats/regions')
   end
 
-  [ACL, ACLEntry, User, Customer, Backend, CacheSetting, Condition, Dictionary, DictionaryItem, Director, Domain, Header, Healthcheck, Gzip, Match, PapertrailLogging, RequestSetting, ResponseObject, Service, Snippet, S3Logging, Syslog, VCL, Version].each do |klass|
+  [ACL, ACLEntry, User, Customer, Backend, CacheSetting, Condition, Dictionary, DictionaryItem, Director, Domain, Header, Healthcheck, Gzip, Match, PapertrailLogging, RequestSetting, ResponseObject, Service, Snippet, S3Logging, Syslog, Token, VCL, Version].each do |klass|
     type = Util.class_to_path(klass)
 
     if klass.respond_to?(:pluralize)

data/lib/fastly/backend.rb

@@ -4,7 +4,7 @@ class Fastly
     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, :auto_loadbalance, :request_condition,
                   :ssl_check_cert, :ssl_hostname, :ssl_cert_hostname, :ssl_sni_hostname, :min_tls_version, :max_tls_version, :ssl_ciphers,
-                  :shield
+                  :shield, :override_host
 
     ##
     # :attr: service_id

data/lib/fastly/belongs_to_service_and_version.rb

@@ -16,9 +16,9 @@ class Fastly
     end
 
     # Get the number of the Version this belongs to
-    def version_number # rubocop:disable all
-      @version
-    end # rubocop:enable all
+    def version_number
+      @version ||= nil
+    end
 
     # :nodoc:
     def as_hash

data/lib/fastly/client.rb

@@ -27,9 +27,16 @@ class Fastly
 
       return self unless fully_authed?
 
-      # If full auth creds (user/pass) then log in and set a cookie
-      resp = http.post('/login', make_params(user: user, password: password))
+      warn("DEPRECATION WARNING: Username/password authentication is deprecated
+      and will not be available starting September 2020;
+      please migrate to API tokens as soon as possible.")
 
+      # If full auth creds (user/pass) then log in and set a cookie
+      resp = http.post(
+        '/login', 
+        make_params(user: user, password: password), 
+        {'Content-Type' =>  'application/x-www-form-urlencoded'}
+      )
       if resp.kind_of?(Net::HTTPSuccess)
         @cookie = resp['Set-Cookie']
       else
@@ -59,8 +66,9 @@ class Fastly
 
     def get(path, params = {})
       extras = params.delete(:headers) || {}
+      include_auth = params.key?(:include_auth) ? params.delete(:include_auth) : true
       path += "?#{make_params(params)}" unless params.empty?
-      resp  = http.get(path, headers(extras))
+      resp  = http.get(path, headers(extras, include_auth))
       fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
       JSON.parse(resp.body)
     end
@@ -86,7 +94,8 @@ class Fastly
 
     def delete(path, params = {})
       extras = params.delete(:headers) || {}
-      resp  = http.delete(path, headers(extras))
+      include_auth = params.key?(:include_auth) ? params.delete(:include_auth) : true
+      resp  = http.delete(path, headers(extras, include_auth))
       resp.kind_of?(Net::HTTPSuccess)
     end
 
@@ -132,16 +141,20 @@ class Fastly
 
     def post_and_put(method, path, params = {})
       extras = params.delete(:headers) || {}
+      include_auth = params.key?(:include_auth) ? params.delete(:include_auth) : true
       query = make_params(params)
-      resp  = http.send(method, path, query, headers(extras).merge('Content-Type' =>  'application/x-www-form-urlencoded'))
+      resp  = http.send(method, path, query, headers(extras, include_auth).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(extras={})
-      headers = fully_authed? ? { 'Cookie' => cookie } : {}
-      headers['Fastly-Key'] = api_key if api_key
-
+    def headers(extras={}, include_auth=true)
+      headers = {}
+      # Some endpoints (POST /tokens) break if any auth headers including cookies are sent
+      if include_auth
+        headers['Cookie'] = cookie if fully_authed?
+        headers['Fastly-Key'] = api_key if api_key
+      end
       headers.merge('Content-Accept' => 'application/json', 'User-Agent' => "fastly-ruby-v#{Fastly::VERSION}").merge(extras.keep_if {|k,v| !v.nil? })
     end
 

data/lib/fastly/gem_version.rb

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

data/lib/fastly/service.rb

@@ -2,7 +2,8 @@
 class Fastly
   # Represents something you want to serve - this can be, for example, a whole web site, a Wordpress site, or just your image servers
   class Service < Base
-    attr_accessor :id, :customer_id, :name, :comment, :versions
+    attr_accessor :id, :customer_id, :name, :comment
+    attr_writer :versions
 
     @versions = []
 

data/lib/fastly/token.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Token object
+class Fastly
+  class Token < Base
+    attr_accessor :id, :access_token, :user_id, :services, :name,  :scope, :created_at, :last_used_at, :expires_at, :ip, :user_agent
+    
+    private
+
+    def self.get_path(*_args)
+      '/tokens'
+    end
+
+    def self.post_path(*_args)
+      '/tokens'
+    end
+    
+    def self.delete_path(opts)
+      "/tokens/#{opts.id}"
+    end
+  end
+
+  def new_token(opts)
+    opts[:username] = client.user
+    opts[:password] = client.password
+    opts[:include_auth] = false
+    
+    token = create(Token, opts)
+    token.nil? ? nil : token
+  end
+
+  def customer_tokens(opts)
+    hash = client.get("/customer/#{opts[:customer_id]}/tokens")
+    hash.map { |token_hash| Token.new(token_hash, Fastly::Fetcher) }
+  end
+end

data/test/fastly/client_test.rb

@@ -12,7 +12,7 @@ describe Fastly::Client do
       }
     end
 
-    it 'does not log in if user/pass are not provided' do
+    it 'does not set the user/pass if they are not provided' do
       client = Fastly::Client.new(api_key: api_key)
 
       assert_equal api_key, client.api_key
@@ -29,6 +29,13 @@ describe Fastly::Client do
       assert_equal "Invalid auth credentials. Check username/password.", e.message
     end
 
+    it 'surfaces a deprecation message when a username or password is provided' do
+      stub_request(:any, /api.fastly.com/).
+        to_return(body: JSON.generate(i: "dont care"), status: 200)
+
+      assert_output('', /DEPRECATION WARNING:/) { Fastly::Client.new(user: user, password: pass) }
+    end
+
     it 'initializes an http client' do
       client = Fastly::Client.new(api_key: api_key)
 
@@ -98,6 +105,25 @@ describe Fastly::Client do
       assert_equal resp.class, Hash
       assert_includes resp, "i"
     end
+
+    it 'can make a POST without auth if asked to do so' do
+      stub_request(:post, /api.fastly.com/).
+        with(headers: {
+          'Accept'=>'*/*',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Accept'=>'application/json',
+          'Content-Type'=>'application/x-www-form-urlencoded',
+          #'Fastly-Key'=>'notasecreteither',
+          'User-Agent'=> /fastly-ruby/
+          }).
+        to_return(body: JSON.generate(i: "dont care"), status: 200)
+
+      resp = client.post(
+        '/service/blah',
+        {include_auth: false}
+      )
+    end
+
   end
 
   describe 'get_stats' do

data/test/fastly/token_test.rb

@@ -0,0 +1,131 @@
+require_relative '../test_helper'
+
+describe Fastly::Token do
+
+  let(:elevated_fastly) { Fastly.new(user: 'test@example.com', password: 'password') }
+  let(:fastly) { Fastly.new(api_key:'my_api_key') }
+
+  before {
+    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+  }
+
+  describe '#fastly' do
+
+    it 'cannot create itself because POST /tokens must have no auth headers)' do
+      stub_request(:post, "https://api.fastly.com/tokens").
+      with(
+        body: {"name"=>"name_of_token", "scope"=>"token_scope such_as purge_all purge_select", "services"=>"service_id_that_token_can_access"},
+        headers: {
+        'Accept'=>'*/*',
+        'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+        'Content-Accept'=>'application/json',
+        'Content-Type'=>'application/x-www-form-urlencoded',
+        'Cookie'=>'tasty!',
+        'User-Agent'=> /fastly-ruby/
+        }).
+      to_return(status: 403, body: '{"msg":"You must POST /sudo to access this endpoint"}', headers: {})
+
+      assert_raises(Fastly::Error,'{"msg":"You must POST /sudo to access this endpoint"}') do
+        elevated_fastly.create_token(
+          name: 'name_of_token',
+          services: 'service_id_that_token_can_access',
+          scope: 'token_scope such_as purge_all purge_select'
+        )
+      end
+    end
+    
+    it 'can create a new token only if there are no auth headers' do
+      response_body = %q(
+        {
+          "id": "5Yo3XXnrQpjc20u0ybrf2g",
+          "access_token": "YOUR_FASTLY_TOKEN",
+          "user_id": "4y5K5trZocEAQYkesWlk7M",
+          "services": ["service_id_that_token_can_access"],
+          "name": "name_of_token",
+          "scope": "optional token_scope such_as purge_all purge_select",
+          "created_at": "2016-06-22T03:19:48+00:00",
+          "last_used_at": "2016-06-22T03:19:48+00:00",
+          "expires_at": "2016-07-28T19:24:50+00:00",
+          "ip": "127.17.202.173",
+          "user_agent": "fastly-ruby-v2.4.0"
+        }
+      )
+
+      stub_request(:post, "https://api.fastly.com/tokens").
+      with(
+        body: {"name"=>"name_of_token", "password"=>"password", "scope"=>"optional token_scope such_as purge_all purge_select", "services"=>"service_id_that_token_can_access", "username"=>"test@example.com"},
+        headers: {
+        'Accept'=>'*/*',
+        'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+        'Content-Accept'=>'application/json',
+        'Content-Type'=>'application/x-www-form-urlencoded',
+        'User-Agent'=> /fastly-ruby/
+        }).
+      to_return(status: 200, body: response_body, headers: {})
+
+      token = elevated_fastly.new_token(
+        name: 'name_of_token',
+        services: 'service_id_that_token_can_access',
+        scope: 'optional token_scope such_as purge_all purge_select'
+      )
+      assert_equal token.id, '5Yo3XXnrQpjc20u0ybrf2g'
+      assert_equal token.user_id, '4y5K5trZocEAQYkesWlk7M'
+      assert_equal token.services[0], 'service_id_that_token_can_access'
+      assert_equal token.name, 'name_of_token'
+      assert_equal token.scope, 'optional token_scope such_as purge_all purge_select'
+      assert_equal token.created_at, '2016-06-22T03:19:48+00:00'
+      assert_equal token.last_used_at, '2016-06-22T03:19:48+00:00'
+      assert_equal token.expires_at, '2016-07-28T19:24:50+00:00'
+      assert_equal token.ip, '127.17.202.173'
+      assert_equal token.user_agent, 'fastly-ruby-v2.4.0'
+      assert_equal token.access_token, 'YOUR_FASTLY_TOKEN'
+    end
+    
+    it 'would delete a token' do
+      stub_request(:delete, "https://api.fastly.com/tokens/").
+      with(
+        headers: {
+        'Accept'=>'*/*',
+        'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+        'Content-Accept'=>'application/json',
+        'Fastly-Key'=>'my_api_key',
+        'User-Agent'=> /fastly-ruby/
+        }).
+      to_return(status: 204, body: "", headers: {})
+
+      token = Fastly::Token.new({acess_token: 'my_api_key'}, Fastly::Fetcher)  
+      fastly.delete_token(token) 
+    end
+
+    it 'would list all the tokens belonging to a token' do
+      stub_request(:get, "https://api.fastly.com/tokens").
+        with(
+          headers: {
+          'Accept'=>'*/*',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Accept'=>'application/json',
+          'Fastly-Key'=>'my_api_key',
+          'User-Agent'=> /fastly-ruby/
+          }).
+        to_return(status: 200, body: "[]", headers: {})
+
+      fastly.list_tokens()
+    end
+
+    it 'would list all the tokens belonging to a customer' do
+      stub_request(:get, "https://api.fastly.com/customer/customer_account_number/tokens").
+        with(
+          headers: {
+          'Accept'=>'*/*',
+          'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
+          'Content-Accept'=>'application/json',
+          'Fastly-Key'=>'my_api_key',
+          'User-Agent'=> /fastly-ruby/
+          }).
+        to_return(status: 200, body: "[]", headers: {})
+
+      fastly.customer_tokens({customer_id: 'customer_account_number'})
+    end
+
+  end
+end

data/test/helper.rb

@@ -2,6 +2,7 @@ require 'common'
 require 'fastly'
 require 'minitest/autorun'
 require 'pry'
+require 'dotenv/load'
 
 class Fastly
   class TestCase < Minitest::Test; end

data/test/token_test.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+# Testing client components related to tokens
+class Fastly
+  describe 'TokenTest' do
+    let(:opts)             { login_opts(:both) }
+    let(:fastly)           { Fastly.new(opts) }
+
+    let(:service_name) { "fastly-test-service-#{random_string}" } 
+    let(:service) { fastly.create_service(:name => service_name) }
+    let(:current_customer) { fastly.current_customer }
+
+    def create_a_test_token(name, service, scope)
+      fastly.new_token(
+          name: name,
+          services: service,
+          scope: scope
+      )      
+    end
+
+    it 'creates a new token' do
+      token = create_a_test_token('name_vi',service.id,'purge_all purge_select')
+      assert_equal token.name, 'name_vi'
+      assert_equal token.services[0], service.id
+      assert_equal token.scope, 'purge_all purge_select'
+      fastly.delete_token(token)
+    end
+    
+    it 'deletes a token by passed-in token' do
+        token = create_a_test_token('name_vi',service.id,'purge_all purge_select')
+        
+        tokens = fastly.customer_tokens({customer_id: current_customer.id})
+        before_count = tokens.count
+        
+        fastly.delete_token(token)
+        
+        tokens = fastly.customer_tokens({customer_id: current_customer.id})
+        after_count = tokens.count
+
+        assert_equal 1, before_count - after_count
+    end
+      
+    it 'returns a list of tokens belonging to the customer or to the auth token' do
+      @token_i = create_a_test_token('name_i',service.id,'purge_all purge_select')
+      @token_ii = create_a_test_token('name_ii',service.id,'purge_all purge_select')
+      @token_iii = create_a_test_token('name_iii',service.id,'purge_all purge_select')
+      @token_iv = create_a_test_token('name_iv',service.id,'purge_all purge_select')
+      @token_v = create_a_test_token('name_v',service.id,'purge_all purge_select')
+
+      tokens = fastly.customer_tokens({customer_id: current_customer.id})
+      assert tokens.count > 4
+
+      tokens = fastly.list_tokens
+      assert tokens.count > 4
+
+      fastly.delete_token(@token_i)
+      fastly.delete_token(@token_ii)
+      fastly.delete_token(@token_iii)
+      fastly.delete_token(@token_iv)
+      fastly.delete_token(@token_v)
+      fastly.delete_service(service)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.5.3
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Client library for the Fastly acceleration system
 email:
@@ -21,6 +21,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -68,6 +69,7 @@ files:
 - lib/fastly/snippet.rb
 - lib/fastly/sumologic_logging.rb
 - lib/fastly/syslog.rb
+- lib/fastly/token.rb
 - lib/fastly/user.rb
 - lib/fastly/util.rb
 - lib/fastly/vcl.rb
@@ -81,12 +83,14 @@ files:
 - test/fastly/customer_test.rb
 - test/fastly/dictionary_test.rb
 - test/fastly/syslog_test.rb
+- test/fastly/token_test.rb
 - 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
+- test/token_test.rb
 homepage: http://github.com/fastly/fastly-ruby
 licenses:
 - MIT
@@ -106,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Client library for the Fastly acceleration system
@@ -120,9 +124,11 @@ test_files:
 - test/fastly/customer_test.rb
 - test/fastly/dictionary_test.rb
 - test/fastly/syslog_test.rb
+- test/fastly/token_test.rb
 - 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
+- test/token_test.rb