fastly 2.5.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc8a553cdbdfbe2e476bae280ce2773a1a12d82810ca7e35d6d32242f6e89adc
-  data.tar.gz: 8985329230915385a17eb5db0ce577296ad1e4913cf74343c67051aba383c86f
+  metadata.gz: 1e44661612cc70c25283004a7817bad49b3a74cf021cda947d58a508c0032707
+  data.tar.gz: 61a36603f52e2d930450bd1f25963ac65517a5073f090ed4998b6606327938de
 SHA512:
-  metadata.gz: 80f1b15c3236123511de643ac4d3c5b9a2890f76b445eefb8386ae5576d3446588383f83e21816312d4d8f8df7e0b008c563eec6dd9df4ed8d3cc4b86a181426
-  data.tar.gz: fc81a4d00879da356801482e75d763b88c2a584fc8c7d117f8ab108b2e7d32475817c81a6a53d3265255859e773a8eb5b0e003cd833206a9e35049f06ec92c99
+  metadata.gz: a70fa226cb6b9169b89bef2c22febf1d6afad9868cc9b2f6f681c341205b526d8f527f135dffae8e25251b29d8c1e0d81c3a87af4b67507b70cb91e34df020ed
+  data.tar.gz: f527b3149e5c63ed2f2343641761e357f5662bc923c2f3cce44a7d4b5db673db8e2c5abfe1fe150c1ea2b2604db1e40ff8a769b998fa8c692140e9bbf9ffc56f

data/.env.example

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

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Change Log
 
+## [v3.0.1](https://github.com/fastly/fastly-ruby/tree/v3.0.1) (2021-02-03)
+
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v3.0.0...v3.0.1)
+
+**Merged pull requests:**
+
+- Remove deprecation warning [\#174](https://github.com/fastly/fastly-ruby/pull/174) ([conniechu929](https://github.com/conniechu929))
+
+## [v3.0.0](https://github.com/fastly/fastly-ruby/tree/v3.0.0) (2021-02-03)
+
+[Full Changelog](https://github.com/fastly/fastly-ruby/compare/v2.5.3...v3.0.0)
+
+**Merged pull requests:**
+
+- Removes session authentication [\#170](https://github.com/fastly/fastly-ruby/pull/170) ([conniechu929](https://github.com/conniechu929))
+
 ## [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:**
@@ -478,4 +495,4 @@ Add Healthchecks and Syslog endpoint streaming
 Initial releasee
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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

@@ -2,6 +2,12 @@
 
 Client library for interacting with the Fastly web acceleration service [API](http://docs.fastly.com/api)
 
+### A Note About Authentication
+
+Authenticating with a username/password is deprecated and will no longer be available starting September 2020.
+
+Authenticating with an API Token is shown in the example section below. For more information on API Tokens, please see [Fastly's API Token documentation](https://developer.fastly.com/reference/api/auth/). For more information about authenticating to our API, please see our [Authentication section](https://developer.fastly.com/reference/api/#authentication).
+
 ## Examples
 
 Add fastly to your Gemfile:
@@ -13,7 +19,8 @@ Create a fastly client:
 
 ```ruby
 # some_file.rb
-# use {api_key: 'your-key'} or {user: 'username', password: 'password'} as login options
+# username/password authentication is deprecated and will not be available
+# starting September 2020; use {api_key: 'your-key'} as the login option
 fastly = Fastly.new(login_opts)
 
 current_user     = fastly.current_user
@@ -202,19 +209,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.
+
+To run the test suite:
+
+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 API key (found at https://app.fastly.com/#account)
+  * `FASTLY_TEST_USER` - Your user email
+  * `FASTLY_TEST_PASSWORD` - Your account password
+  * `FASTLY_TEST_API_KEY` - Your personal token
 
-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.
+3. Run the tests via `bundle exec rake test:unit`
 
 ## Copyright
 
-Copyright 2011-2014 - Fastly Inc
+Copyright 2011-2020 - Fastly, Inc.
 
 ## Redistribution
 

data/RELEASE.md

@@ -0,0 +1,15 @@
+**Release Process**
+
+1. Sign up for an account on Ruby Gems (https://rubygems.org/sign_up)
+2. Go to the `#app-eng-backends` channel and get added to the ruby gem (https://rubygems.org/gems/fastly)
+3. Merge PR after CI passes
+4. Open new PR to update `CHANGELOG.md`
+5. Merge `CHANGELOG.md` PR
+6. Rebase latest remote master branch locally (`git pull --rebase origin master`).
+7. Tag a new release (`git tag vX.Y.Z && git push origin vX.Y.Z`)
+8. Copy and paste `CHANGELOG.md` into the draft release
+9. Publish draft release
+10. Publish the gem to RubyGems.org (you will need your username and password on Ruby Gems)
+
+- generate a new gem spec file with the new version `gem build fastly.gemspec`
+- update RubyGems.org `gem push fastly-{VERSION}.gem`

data/lib/fastly.rb

@@ -55,8 +55,8 @@ class Fastly
   #
   # Some methods require full username and password rather than just auth token.
   def initialize(opts)
-    if opts[:api_key].nil? && (opts[:password].nil? || opts[:user].nil?)
-      raise ArgumentError, "Required options missing. Please pass either ':api_key' or both ':user' and ':password'."
+    if opts[:api_key].nil?
+      raise ArgumentError, "Required option missing. Please pass ':api_key'."
     end
 
     client(opts)

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

@@ -11,7 +11,7 @@ class Fastly
 
     DEFAULT_URL = 'https://api.fastly.com'.freeze
 
-    attr_accessor :api_key, :base_url, :debug, :user, :password, :cookie, :customer
+    attr_accessor :api_key, :base_url, :debug, :user, :password, :customer
 
     def initialize(opts)
       @api_key            = opts.fetch(:api_key, nil)
@@ -24,19 +24,9 @@ class Fastly
       @thread_http_client = if defined?(Concurrent::ThreadLocalVar)
                               Concurrent::ThreadLocalVar.new { build_http_client }
                             end
-
-      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), 
-        {'Content-Type' =>  'application/x-www-form-urlencoded'}
-      )
-      if resp.kind_of?(Net::HTTPSuccess)
-        @cookie = resp['Set-Cookie']
-      else
-        fail Unauthorized, "Invalid auth credentials. Check username/password."
+      
+      if api_key.nil?
+        fail Unauthorized, "Invalid auth credentials. Check api_key."
       end
 
       self
@@ -146,9 +136,7 @@ class Fastly
 
     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? })

data/lib/fastly/gem_version.rb

@@ -1,4 +1,4 @@
 # The current version of the library
 class Fastly
-  VERSION = "2.5.0"
+  VERSION = "3.0.1"
 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

@@ -21,12 +21,16 @@ class Fastly
   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
+    if client.fully_authed?
+      opts[:username] = client.user
+      opts[:password] = client.password
+      opts[:include_auth] = false
+      
+      token = create(Token, opts)
+      token.nil? ? nil : token
+    else
+      raise ArgumentError, "Required options missing. Please pass :api_key, :user and :password." 
+    end
   end
 
   def customer_tokens(opts)

data/test/api_key_test.rb

@@ -50,7 +50,7 @@ class Fastly
           end
         end
 
-        describe 'with cookie and api key' do
+        describe 'with username/password and api key' do
           before do
             @opts = login_opts(:both)
             @client = Fastly::Client.new(@opts)
@@ -75,26 +75,6 @@ class Fastly
             assert_equal 'ok', response['status']
           end
         end
-
-        describe 'with cookie only' do
-          before do
-            @opts = login_opts(:full)
-            @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 'does not allow purging' do
-            assert_raises Fastly::KeyAuthRequired do
-              @service.purge_by_key('somekey')
-            end
-          end
-        end
       end
     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
@@ -20,13 +20,17 @@ describe Fastly::Client do
       assert_equal nil, client.password
     end
 
+    it 'raises Unauthorized if api_key is not passed in the options' do
+      assert_raises(Fastly::Unauthorized) { Fastly::Client.new(user: user, password: password)}
+    end
+
     it 'raises Unauthorized if user/pass provided but are invalid' do
       stub_request(:any, /api.fastly.com/).to_return(status: 400)
 
       e = assert_raises(Fastly::Unauthorized) {
-        Fastly::Client.new(user: user, password: pass)
+        Fastly::Client.new(user: user, password: password)
       }
-      assert_equal "Invalid auth credentials. Check username/password.", e.message
+      assert_equal "Invalid auth credentials. Check api_key.", e.message
     end
 
     it 'initializes an http client' do
@@ -38,23 +42,13 @@ describe Fastly::Client do
       assert client.http.use_ssl?
     end
 
-    it 'sets a cookie when auth with valid user/pass' do
-      stub_request(:any, /api.fastly.com/).
-        to_return(body: JSON.generate(i: "dont care"), status: 200, headers: { 'Set-Cookie' => 'tasty!' })
-
-      client = Fastly::Client.new(user: user, password: pass)
-      assert_equal "tasty!", client.cookie
-    end
-
     it 'raises an Error if username is used in place of user as an option' do
       stub_request(:any, /api.fastly.com/).
-        to_return(body: JSON.generate(i: "dont care"), status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+        to_return(body: JSON.generate(i: "dont care"), status: 200)
 
-      assert_raises(ArgumentError) { Fastly.new(username: user, password: pass) }
+      assert_raises(ArgumentError) { Fastly.new(username: user, password: password) }
 
-      Fastly.new(user: user, password: pass)
-      Fastly.new(api_key: api_key)
-      Fastly.new(api_key: api_key, user: user, password: pass)
+      Fastly.new(api_key: api_key, user: user, password: password)
     end
   end
 
@@ -107,7 +101,7 @@ describe Fastly::Client do
           'Content-Accept'=>'application/json',
           'Content-Type'=>'application/x-www-form-urlencoded',
           #'Fastly-Key'=>'notasecreteither',
-          'User-Agent'=>'fastly-ruby-v2.4.0'
+          'User-Agent'=> /fastly-ruby/
           }).
         to_return(body: JSON.generate(i: "dont care"), status: 200)
 

data/test/fastly/customer_test.rb

@@ -7,7 +7,7 @@ describe Fastly::Customer do
   let(:owner_id)    { SecureRandom.hex(6) }
 
   let(:customer) do
-    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200)
 
     customer_body = JSON.dump(
       'id' => customer_id,

data/test/fastly/dictionary_test.rb

@@ -2,13 +2,13 @@ require_relative '../test_helper'
 
 describe Fastly::Dictionary do
 
-  let(:client)     { Fastly.new(user: 'test@example.com', password: 'password') }
+  let(:client)     { Fastly.new(api_key: 'notasecrettestkey') }
   let(:service_id) { SecureRandom.hex(6) }
   let(:version)    {  1 }
   let(:dictionary) { Fastly::Dictionary.new({id: SecureRandom.hex(6), service_id: service_id, version: 1}, client) }
 
   before {
-    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200)
   }
 
   describe '#item' do

data/test/fastly/syslog_test.rb

@@ -2,13 +2,13 @@ require_relative '../test_helper'
 
 describe Fastly::Syslog do
 
-  let(:client)     { Fastly.new(user: 'test@example.com', password: 'password') }
+  let(:client)     { Fastly.new(api_key: 'notasecrettestkey', user: 'test@example.com', password: 'password') }
   let(:service_id) { SecureRandom.hex(6) }
   let(:version)    { 1 }
   let(:syslog) { Fastly::Syslog.new({ name: 'test_syslog', service_id: service_id, version: 1 }, client) }
 
   before {
-    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200)
   }
 
   describe '#item' do

data/test/fastly/token_test.rb

@@ -1,17 +1,14 @@
 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') }
+  let(:fastly) { Fastly.new(api_key:'my_api_key', user: 'test@example.com', password: 'password') }
 
   before {
-    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200, headers: { 'Set-Cookie' => 'tasty!' })
+    stub_request(:post, "#{Fastly::Client::DEFAULT_URL}/login").to_return(body: '{}', status: 200)
   }
 
   describe '#fastly' do
-
-    it 'cannot create itself because POST /tokens must have no auth headers)' 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"},
@@ -20,13 +17,12 @@ describe Fastly::Token do
         '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-v2.4.0'
+        '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(
+        fastly.create_token(
           name: 'name_of_token',
           services: 'service_id_that_token_can_access',
           scope: 'token_scope such_as purge_all purge_select'
@@ -59,11 +55,11 @@ describe Fastly::Token do
         '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-v2.4.0'
+        'User-Agent'=> /fastly-ruby/
         }).
       to_return(status: 200, body: response_body, headers: {})
 
-      token = elevated_fastly.new_token(
+      token = fastly.new_token(
         name: 'name_of_token',
         services: 'service_id_that_token_can_access',
         scope: 'optional token_scope such_as purge_all purge_select'
@@ -89,7 +85,7 @@ describe Fastly::Token do
         '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-v2.4.0'
+        'User-Agent'=> /fastly-ruby/
         }).
       to_return(status: 204, body: "", headers: {})
 
@@ -105,7 +101,7 @@ describe Fastly::Token do
           '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-v2.4.0'
+          'User-Agent'=> /fastly-ruby/
           }).
         to_return(status: 200, body: "[]", headers: {})
 
@@ -120,7 +116,7 @@ describe Fastly::Token do
           '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-v2.4.0'
+          'User-Agent'=> /fastly-ruby/
           }).
         to_return(status: 200, body: "[]", headers: {})
 

data/test/full_login_test.rb

@@ -3,7 +3,7 @@ require 'helper'
 # Test username/password login access to user and customer objects
 class Fastly
   describe 'FullLoginTest' do
-    let(:opts)             { login_opts(:full) }
+    let(:opts)             { login_opts(:both) }
     let(:client)           { Client.new(opts) }
     let(:fastly)           { Fastly.new(opts) }
     let(:current_user)     { fastly.current_user }

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2021-03-08 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"
@@ -30,6 +31,7 @@ files:
 - HISTORY.md
 - LICENSE
 - README.md
+- RELEASE.md
 - Rakefile
 - bin/fastly_create_domain
 - bin/fastly_upload_vcl
@@ -109,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Client library for the Fastly acceleration system