fastly 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a2ede9580b2a60043debfc3a95545c6ec6d88dce770e53f626975d508922230
-  data.tar.gz: 88471ec1a779279a3b35bbf42c2882caef0adc6fd54161eb0f0793180a1f9e0a
+  metadata.gz: cc8a553cdbdfbe2e476bae280ce2773a1a12d82810ca7e35d6d32242f6e89adc
+  data.tar.gz: 8985329230915385a17eb5db0ce577296ad1e4913cf74343c67051aba383c86f
 SHA512:
-  metadata.gz: d66d4a875d04d5889dd0f7d094073abc575cc9ef3f8c698d03050e35a1236ce3f2d94356503d9391f494a95f7cc47ff0dc581e04a342db79e0689b8038d4ed74
-  data.tar.gz: 257ca1ae2413695c47394fecd8b9a77e9be2d073232ea0a2ea186045c7356e96b562a1d66cafb9b7e2a71fe2760b52c5f121aacae98d99184cd768c10f4aa5b2
+  metadata.gz: 80f1b15c3236123511de643ac4d3c5b9a2890f76b445eefb8386ae5576d3446588383f83e21816312d4d8f8df7e0b008c563eec6dd9df4ed8d3cc4b86a181426
+  data.tar.gz: fc81a4d00879da356801482e75d763b88c2a584fc8c7d117f8ab108b2e7d32475817c81a6a53d3265255859e773a8eb5b0e003cd833206a9e35049f06ec92c99

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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)
 
@@ -471,4 +478,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/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/client.rb

@@ -28,8 +28,11 @@ 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))
-
+      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 +62,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 +90,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 +137,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.4.0"
+  VERSION = "2.5.0"
 end

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

@@ -98,6 +98,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-v2.4.0'
+          }).
+        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-v2.4.0'
+        }).
+      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-v2.4.0'
+        }).
+      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-v2.4.0'
+        }).
+      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-v2.4.0'
+          }).
+        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-v2.4.0'
+          }).
+        to_return(status: 200, body: "[]", headers: {})
+
+      fastly.customer_tokens({customer_id: 'customer_account_number'})
+    end
+
+  end
+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.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies: []
 description: Client library for the Fastly acceleration system
 email:
@@ -68,6 +68,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 +82,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,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Client library for the Fastly acceleration system
@@ -121,9 +123,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