fastly 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f311beb83bf3886557b6da399d17d49682ec4ffb
-  data.tar.gz: f47f3014d3b66738f9938e3b84e5ab4d46b9a8d5
+  metadata.gz: 98cf194db3451a553915a60698cccafb1551cd17
+  data.tar.gz: 0cc9c5cf4265b30629c84ba203df8288a37408e0
 SHA512:
-  metadata.gz: be5c1f769e551f2bbf7a16bab3508a14191c42cee4f9e7a95075c4be14f9e76aee9d1294e14b4d0bfa13f4bad7de9cb2f130bb6670a6e37ebee7217649dc0f4f
-  data.tar.gz: 9b8c4b14104b4d3148e2c9679a92db0a8e5f59fd2e0e4fbf21ddebb908f37ddd2fe8e4746974333074a665046cb8cda70eca279b5789cee1fb37d89b4959d008
+  metadata.gz: 8b5fe7fff0fc9283303bd7ccbc22c2d9c7ba91942d77fc2d2955dac37ab657ab2a55548e58da3e4ce16d2f8bc8a7c37ebb6b954b73fc5555d692052e69345ba6
+  data.tar.gz: 8ae29620a8c2dd856f245c45035b30e56c15cdff6bc4d700c4603fde9459ee5c40f5e2d11a6fbc2e1592ed6081127eac127b7a1bfd062269870a699ff8ff8603

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 run_test.sh
 doc/*
 .*.sw?
+.env

data/Gemfile

@@ -8,4 +8,5 @@ group :development, :test do
   gem 'minitest', '~> 5.3.4'
   gem 'pry'
   gem 'rubocop'
+  gem 'webmock'
 end

data/HISTORY.md

@@ -1,5 +1,9 @@
 # HEAD
 
+## 2015-02-05 v1.2.0
+* remove curb-fu. Net::HTTP is used instead - https://github.com/fastly/fastly-ruby/pull/44
+* better client error handling - https://github.com/fastly/fastly-ruby/pull/48
+
 ## 2014-12-15 v1.1.5
 * major refactor and reorganization of code (merged branch https://github.com/fastly/fastly-ruby/pull/31)
 * bump curb dep to 0.8.6 for ruby 2.1 support (see https://github.com/fastly/fastly-ruby/issues/43)

data/fastly.gemspec

@@ -16,7 +16,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
-
-  s.add_dependency 'curb', '~> 0.8.6'
-  s.add_dependency 'curb-fu', '~> 0.6.2'
 end

data/lib/fastly.rb

@@ -5,10 +5,8 @@
 # A client library for interacting with the Fastly web acceleration service
 require 'fastly/gem_version'
 require 'fastly/util'
-require 'ext/curb_fu/response/base'
 require 'fastly/fetcher'
 require 'fastly/client'
-
 require 'fastly/base'
 require 'fastly/belongs_to_service_and_version'
 require 'fastly/backend'

data/lib/fastly/client.rb

@@ -1,7 +1,6 @@
 require 'json'
 require 'cgi'
-require 'uri'
-require 'fastly/client/curl'
+require 'net/http' # also requires uri
 
 class Fastly
   # The UserAgent to communicate with the API
@@ -16,26 +15,24 @@ class Fastly
 
       base      = opts.fetch(:base_url, 'https://api.fastly.com')
       uri       = URI.parse(base)
-
-      @http     = Curl.new(uri)
+      @http     = Net::HTTP.start(uri.host, uri.port, use_ssl: true)
 
       return self unless fully_authed?
 
-      # If we're fully authed (i.e username and password ) then we need to log in
+      # If full auth creds (user/pass) then log in and set a cookie
       resp = http.post('/login', make_params(user: user, password: password))
 
-      if resp.success?
+      if resp.kind_of?(Net::HTTPSuccess)
         @cookie = resp['Set-Cookie']
       else
-        fail Unauthorized
+        fail Unauthorized, "Invalid auth credentials. Check username/password."
       end
 
       self
     end
 
     def require_key!
-      raise Fastly::AuthRequired.new("This request requires an API key") if api_key.nil?
-
+      raise Fastly::KeyAuthRequired.new("This request requires an API key") if api_key.nil?
       @require_key = true
     end
 
@@ -55,18 +52,18 @@ class Fastly
     def get(path, params = {})
       path += "?#{make_params(params)}" unless params.empty?
       resp  = http.get(path, headers)
-      return nil if 404 == resp.status
-      fail Error, resp.message unless resp.success?
+      fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
       JSON.parse(resp.body)
     end
 
     def get_stats(path, params = {})
-      content = get(path, params)
+      resp = get(path, params)
 
-      case content['status']
-      when 'success' then content['data']
+      # return meta data, not just the actual stats data
+      if resp['status'] == 'success'
+        resp
       else
-        fail Error, content['message']
+        fail Error, resp['msg']
       end
     end
 
@@ -80,7 +77,7 @@ class Fastly
 
     def delete(path)
       resp  = http.delete(path, headers)
-      resp.success?
+      resp.kind_of?(Net::HTTPSuccess)
     end
 
     private
@@ -88,13 +85,7 @@ class Fastly
     def post_and_put(method, path, params = {})
       query = make_params(params)
       resp  = http.send(method, path, query, headers.merge('Content-Type' =>  'application/x-www-form-urlencoded'))
-
-      if resp.success?
-        JSON.parse(resp.body)
-      else
-        fail Error, resp.message
-      end
-
+      fail Error, resp.body unless resp.kind_of?(Net::HTTPSuccess)
       JSON.parse(resp.body)
     end
 

data/lib/fastly/fetcher.rb

@@ -2,6 +2,8 @@ class Fastly
   # :nodoc:
   class AuthRequired < RuntimeError; end
   # :nodoc:
+  class KeyAuthRequired < AuthRequired; end
+  # :nodoc:
   class FullAuthRequired <  AuthRequired; end
   # :nodoc:
   class Error < RuntimeError; end

data/lib/fastly/gem_version.rb

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

data/lib/fastly/invoice.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 # Invoice object
 class Fastly
   # An invoice for a time period

data/test/fastly/client_test.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+
+describe Fastly::Client do
+  let(:user)        { "test@example.com" }
+  let(:password)    { "notasecret" }
+  let(:api_key)     { "notasecreteither" }
+
+  describe 'initialize' do
+    it 'raises ArgumentError when no options provided' do
+      assert_raises(ArgumentError) {
+        Fastly::Client.new()
+      }
+    end
+
+    it 'does not log in if user/pass are not provided' do
+      client = Fastly::Client.new(api_key: api_key)
+
+      assert_equal api_key, client.api_key
+      assert_equal nil, client.user
+      assert_equal nil, client.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)
+      }
+      assert_equal "Invalid auth credentials. Check username/password.", e.message
+    end
+
+    it 'initializes an http client' do
+      client = Fastly::Client.new(api_key: api_key)
+
+      assert_equal Net::HTTP, client.http.class
+      assert_equal 443, client.http.port
+      assert_equal 'api.fastly.com', client.http.address
+      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
+  end
+
+  describe 'get' do
+    let(:client) { Fastly::Client.new(api_key: api_key) }
+
+    it 'accepts a path and returns a parsed json hash' do
+      stub_request(:any, /api.fastly.com/).
+        to_return(body: JSON.generate(i: "dont care"), status: 200)
+
+      resp = client.get('/service/blah')
+      assert_equal resp.class, Hash
+      assert_includes resp, "i"
+    end
+
+    it 'raises Fastly::Error on unsuccessful GETs' do
+      stub_request(:any, /api.fastly.com/).to_return(status: 400)
+
+      assert_raises(Fastly::Error) {
+        client.get('/service/blah')
+      }
+    end
+  end
+
+  describe 'post' do
+    let(:client) { Fastly::Client.new(api_key: api_key) }
+
+    it 'raises Fastly::Error on unsuccessful POST' do
+      stub_request(:any, /api.fastly.com/).to_return(status: 400)
+
+      assert_raises(Fastly::Error) {
+        client.post('/service/blah')
+      }
+    end
+
+    it 'can make a successful POST' do
+      stub_request(:any, /api.fastly.com/).
+        to_return(body: JSON.generate(i: "dont care"), status: 200)
+
+      resp = client.post('/service/blah')
+      assert_equal resp.class, Hash
+      assert_includes resp, "i"
+    end
+  end
+
+  describe 'get_stats' do
+    let(:client) { Fastly::Client.new(api_key: api_key) }
+
+    it 'raises Fastly::Error when unsuccessful get' do
+      stub_request(:any, /api.fastly.com/).to_return(status: 400)
+
+      assert_raises(Fastly::Error) {
+        client.get_stats('/stats')
+      }
+    end
+
+    it 'can make a successful stats GET' do
+      stub_request(:any, /api.fastly.com/).
+        to_return(body: JSON.generate(i: "dont care", status: 'success', data: {}), status: 200)
+
+      resp = client.get_stats('/stats')
+      assert_equal resp.class, Hash
+
+    end
+  end
+end

data/test/full_login_test.rb

@@ -83,7 +83,9 @@ class Fastly
       it 'should allow us to delete a user' do
         user_id = user.id
         assert_equal true, fastly.delete_user(user)
-        assert_equal nil, fastly.get_user(user_id)
+        assert_raises(Fastly::Error) do
+          fastly.get_user(user_id)
+        end
       end
     end
   end

data/test/missing_api_key_test.rb

@@ -19,7 +19,7 @@ class MissingApiKeyTest < Fastly::TestCase
     service_name = "fastly-test-service-#{random_string}"
     service      = @fastly.create_service(:name => service_name)
 
-    assert_raises Fastly::AuthRequired do
+    assert_raises Fastly::KeyAuthRequired do
       service.purge_by_key('somekey')
     end
   ensure

data/test/stats_test.rb

@@ -23,42 +23,35 @@ class StatsTest < Fastly::TestCase
 
   def test_usage
     usage = @fastly.usage(:from => FROM)
-    assert(usage['usa'], 'Found a USA region in usage')
-    assert(usage['usa']['requests'], 'USA region has a requests field')
+    # usage can be and empty hash if no usage stats
+    # this client is not responsiblew for verifying the stats api,
+    # just that requests to stats work
+    assert(usage)
+    assert(usage['meta'])
+    assert_equal 'success', usage['status']
 
     usage = @fastly.usage(:from => FROM, :by_service => 1)
-    assert(usage['usa'], 'Found a USA region in usage')
-    assert(usage['usa']['requests'].nil?, "USA region doesn't have a requests field")
+    assert(usage)
+    assert(usage['meta'])
+    assert_equal 'success', usage['status']
   end
 
   def test_stats
     stats = @fastly.stats(:from => FROM)
-    service1, service2 = stats.keys
-    assert(stats[service1][0]['requests'], 'Found requests')
-    assert(stats[service1][0]['hits'], 'Found hits')
-    assert(stats[service2][0]['requests'], 'Found requests')
-    assert(stats[service2][0]['hits'], 'Found hits')
+    # stats can be and empty hash if no usage stats
+    assert(stats)
+    assert_equal 'success', stats['status']
+    assert_equal 'all', stats['meta']['region']
 
     stats = @fastly.stats(:from => FROM, :field => 'requests')
-    assert(stats[service1][0]['requests'],  'Found requests')
-    assert(stats[service1][0]['hits'].nil?, "Didn't find hits")
-    assert(stats[service2][0]['requests'],  'Found requests')
-    assert(stats[service2][0]['hits'].nil?, "Didn't find hits")
-
-    stats = @fastly.stats(:from => FROM, :service => service1)
-    assert_equal(stats[0]['service_id'], service1, 'Got correct service id')
-    assert(stats[0]['requests'], 'Found requests')
-    assert(stats[0]['hits'], 'Found hits')
-
-    stats = @fastly.stats(:from => FROM, :field => 'requests', :service => service1)
-    assert_equal(stats[0]['service_id'], service1, 'Got correct service id')
-    assert(stats[0]['requests'], 'Found requests')
-    assert(stats[0]['hits'].nil?, "Didn't find hits")
+    assert(stats)
+    assert_equal 'success', stats['status']
+    assert_equal 'all', stats['meta']['region']
 
     stats = @fastly.stats(:from => FROM, :aggregate => true)
-    assert(stats[0]['service_id'].nil?, 'No service id')
-    assert(stats[0]['requests'], 'Found requests')
-    assert(stats[0]['hits'], 'Found hits')
+    assert(stats)
+    assert_equal 'success', stats['status']
+    assert_equal 'all', stats['meta']['region']
 
     # stats aggregate with field
     assert_raises Fastly::Error do
@@ -67,11 +60,11 @@ class StatsTest < Fastly::TestCase
 
     # stats aggregate with service
     assert_raises Fastly::Error do
-      @fastly.stats(:from => FROM, :service => service1, :aggregate => true)
+      @fastly.stats(:from => FROM, :service => 'myserviceId', :aggregate => true)
     end
 
     assert_raises Fastly::Error do
-      @fastly.stats(:from => FROM, :service => service1, :field => 'requests', :aggregate => true)
+      @fastly.stats(:from => FROM, :service => 'datServiceID', :field => 'requests', :aggregate => true)
     end
   end
 end

data/test/test_helper.rb

@@ -1,2 +1,3 @@
 require 'minitest/autorun'
+require 'webmock/minitest'
 require 'fastly'

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: curb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.8.6
-- !ruby/object:Gem::Dependency
-  name: curb-fu
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.2
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies: []
 description: Client library for the Fastly acceleration system
 email:
 - simon@fastly.com
@@ -60,14 +32,12 @@ files:
 - bin/fastly_create_domain
 - bin/fastly_upload_vcl
 - fastly.gemspec
-- lib/ext/curb_fu/response/base.rb
 - lib/fastly.rb
 - lib/fastly/backend.rb
 - lib/fastly/base.rb
 - lib/fastly/belongs_to_service_and_version.rb
 - lib/fastly/cache_setting.rb
 - lib/fastly/client.rb
-- lib/fastly/client/curl.rb
 - lib/fastly/condition.rb
 - lib/fastly/customer.rb
 - lib/fastly/director.rb
@@ -93,6 +63,7 @@ files:
 - test/admin_test.rb
 - test/api_key_test.rb
 - test/common.rb
+- test/fastly/client_test.rb
 - test/fastly/util_test.rb
 - test/full_login_test.rb
 - test/helper.rb
@@ -127,6 +98,7 @@ test_files:
 - test/admin_test.rb
 - test/api_key_test.rb
 - test/common.rb
+- test/fastly/client_test.rb
 - test/fastly/util_test.rb
 - test/full_login_test.rb
 - test/helper.rb

data/lib/ext/curb_fu/response/base.rb

@@ -1,20 +0,0 @@
-require 'curb-fu'
-
-module CurbFu
-  module Response
-    # :nodoc: all
-    class Base
-      def get_fields(key)
-        if (match = @headers.find { |k, _| k.downcase == key.downcase })
-          [match.last].flatten
-        else
-          []
-        end
-      end
-
-      def [](key)
-        get_fields(key).last
-      end
-    end
-  end
-end

data/lib/fastly/client/curl.rb

@@ -1,57 +0,0 @@
-require 'curb-fu'
-
-class Fastly
-  class Client
-    # :nodoc: all
-    class Curl
-      attr_accessor :uri, :host, :port, :protocol
-
-      def initialize(uri)
-        @uri      = uri
-        @host     = uri.host
-        @port     = uri.port
-        @protocol = uri.scheme
-      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 put(path, params, headers = {})
-        CurbFu.put({
-                     host:     host,
-                     port:     port,
-                     path:     path,
-                     headers:  headers,
-                     protocol: protocol
-                   }, params)
-      end
-
-      def delete(path, headers = {})
-        CurbFu.delete({
-                        host:     host,
-                        port:     port,
-                        path:     path,
-                        headers:  headers,
-                        protocol: protocol
-                      })
-      end
-    end
-  end
-end