fastly 2.5.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6374dedf0a4320acb1bb370b700f31dffbb841ad039e717c9b6bd713a6cb5a
-  data.tar.gz: f53667b8fa95b6e9cf013ec23c94feee19b860c28de60aba3fee4ddd17ffaa4c
+  metadata.gz: d0331b2215d245985194128508980192db08a0ae94c0da70c1f3b417a4309df7
+  data.tar.gz: d3ab806682ed8e8141a301886fb2bf21b91102f478866dee281b3be2c7480a5c
 SHA512:
-  metadata.gz: f3115a7e69149466f180e3d823c13ef9d4a895178a6e33e02522afa1b5551df59da7655dd3c316eba9cb0be0df2494b2b2f4a6803a2ec6b04cb8f4f1b06be11f
-  data.tar.gz: c7a1a39686da60e1986b24d7ef7d94cdba247e29117a99bed51924e23716da3dc72cc44869e1b711f75745309ff71597c165d2048fb5b43ed38fa6d0d2fc4e88
+  metadata.gz: 4e738dcf185c95ff25b675f2795fbdd62154894c1c00098dccd48f39d1dfb854491f8f007b5a1c1bef1c0689aad5392b0b5c3facb22ed0a956b501a7300017c3
+  data.tar.gz: f76512046a815ab57aa559abc71f9ab9108246defb81f2c710579f0d11296eb2f422897bb97440aa8a18f9c57b363ae1570db95257e50e9f1ed12736a7a959ac

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Change Log
 
+## [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:**

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

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/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)
@@ -25,22 +25,12 @@ class Fastly
                               Concurrent::ThreadLocalVar.new { build_http_client }
                             end
 
-      return self unless fully_authed?
-
       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
-        fail Unauthorized, "Invalid auth credentials. Check username/password."
+      
+      if api_key.nil?
+        fail Unauthorized, "Invalid auth credentials. Check api_key."
       end
 
       self
@@ -150,9 +140,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.3"
+  VERSION = "3.0.0"
 end

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

@@ -20,20 +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
-    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) }
+      assert_equal "Invalid auth credentials. Check api_key.", e.message
     end
 
     it 'initializes an http client' do
@@ -45,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
 

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/
         }).
       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'
@@ -63,7 +59,7 @@ describe Fastly::Token do
         }).
       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'

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 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies: []
 description: Client library for the Fastly acceleration system
 email:
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Client library for the Fastly acceleration system