fastly 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e44e269ced0743d4656f7373ccc0c5d1aeee74a
-  data.tar.gz: 0e665bf5745afc421ce6362c2b23bb9459eecc3a
+  metadata.gz: 303ad518137e3776d1eb3d3c8f01248428cb9cae
+  data.tar.gz: 4eb4cceb4e98c19e9da337df56ab520b271cdb8c
 SHA512:
-  metadata.gz: f0629f64bb97d2608d3d43192434b1a3e1668ad8d7f5deec2cec452157172f57eba1b4af5fddd892b08338d0973047bc8acc307d4cacbf570c85472d00d096df
-  data.tar.gz: e357b6626db187915cdfed105a40c45550f43d5da05740f41ebf215fecf148481e9f86495286aaa7ad89a6d06aa53879d71824d6cdac99513585c87d4263d620
+  metadata.gz: efe685e5ffb5ed74d0817ee3fda2a4e9e4239685e817c20df42a56fa6ac7ae5d53d8f21c2a52a05fb6a4a9454a59121c8b6d8cbaa3a311cd7f632f629dcf1551
+  data.tar.gz: e6156561472906f58a67ccd7e6da2586836b6926397371b31732516f05675f32632126d60268d7aa642a2919fcce314af44d2543cb7d841e3ade9b86cf0af288

data/.travis.yml

@@ -2,6 +2,8 @@ language: ruby
 script: 'bundle exec rake test:unit'
 sudo: false
 rvm:
-  - '1.9.3'
-  - '2.1.1'
-  - '2.3.0'
+  - 1.9.3
+  - 2.0.0
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1

data/lib/fastly.rb

@@ -14,6 +14,7 @@ require 'fastly/cache_setting'
 require 'fastly/condition'
 require 'fastly/customer'
 require 'fastly/dictionary'
+require 'fastly/dictionary_item'
 require 'fastly/director'
 require 'fastly/domain'
 require 'fastly/header'
@@ -46,6 +47,10 @@ 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'."
+    end
+
     client(opts)
     self
   end
@@ -138,7 +143,7 @@ class Fastly
     client.get_stats('/stats/regions')
   end
 
-  [User, Customer, Backend, CacheSetting, Condition, Dictionary, Director, Domain, Header, Healthcheck, Gzip, Match, Origin, RequestSetting, ResponseObject, Service, S3Logging, Syslog, VCL, Version].each do |klass|
+  [User, Customer, Backend, CacheSetting, Condition, Dictionary, DictionaryItem, Director, Domain, Header, Healthcheck, Gzip, Match, Origin, RequestSetting, ResponseObject, Service, S3Logging, Syslog, VCL, Version].each do |klass|
     type = Util.class_to_path(klass)
 
     if klass.respond_to?(:pluralize)
@@ -182,6 +187,10 @@ class Fastly
   # :method: create_dictionary(opts)
   # opts must contain service_id, version and name params
 
+  ##
+  # :method: create_dictionary_item(opts)
+  # opts must contain service_id, dictionary_id, item_key and item_value params
+
   ##
   # :method: create_director(opts)
   # opts must contain service_id, version and name params
@@ -262,6 +271,10 @@ class Fastly
   # :method: get_dictionary(service_id, number, name)
   # Get a single dictionary
 
+  ##
+  # :method: get_dictionary_item(service_id, dictionary_id, name)
+  # Get a single dictionary item
+
   ##
   # :method: get_director(service_id, number, name)
   # Get a Director
@@ -356,6 +369,11 @@ class Fastly
   # You can also call
   #    dictionary.save!
 
+  ##
+  # :method: update_dictionary_item(dictionary_item)
+  # You can also call
+  #    dictionary_item.save!
+
   ##
   # :method: update_director(director)
   # You can also call
@@ -466,6 +484,11 @@ class Fastly
   # You can also call
   #    dictionary.delete!
 
+  ##
+  # :method: delete_dictionary_item(dictionary_item)
+  # You can also call
+  #    dictionary_item.delete!
+
   ##
   # :method: delete_director(backend)
   # You can also call
@@ -569,6 +592,10 @@ class Fastly
   #
   # Get a list of all dictionaries
 
+  # :method: list_dictionary_items(:service_id => service.id, :dictionary_id => dictionary.name)
+  #
+  # Get a list of all items belonging to a dictionary
+
   # :method: list_domains(:service_id => service.id, :version => version.number)
   #
   # Get a list of all domains

data/lib/fastly/client.rb

@@ -6,6 +6,9 @@ require 'openssl'
 class Fastly
   # The UserAgent to communicate with the API
   class Client #:nodoc: all
+
+    DEFAULT_URL = 'https://api.fastly.com'.freeze
+
     attr_accessor :http, :api_key, :user, :password, :cookie, :customer
 
     def initialize(opts)
@@ -15,7 +18,7 @@ class Fastly
       @customer = opts.fetch(:customer, nil)
       @oldpurge = opts.fetch(:use_old_purge_method, false)
 
-      base    = opts.fetch(:base_url, 'https://api.fastly.com')
+      base    = opts.fetch(:base_url, DEFAULT_URL)
       uri     = URI.parse(base)
       options = if uri.is_a? URI::HTTPS
                   {

data/lib/fastly/dictionary.rb

@@ -2,6 +2,38 @@ class Fastly
   class Dictionary < BelongsToServiceAndVersion
     attr_accessor :id, :name, :service_id
 
+    def items
+      fetcher.list_dictionary_items(:service_id => service_id, :dictionary_id => id)
+    end
+
+    # Returns a Fastly::DictionaryItem corresponding to this dictionary and the +key+
+    #
+    # * +key+ - Key of the dictionary item
+    def item(key)
+      fetcher.get_dictionary_item(service_id, id, key)
+    rescue Fastly::Error => e
+      raise unless e.message =~ /Record not found/
+    end
+
+    def add_item(key, value)
+      fetcher.create_dictionary_item(service_id: service_id, dictionary_id: id, item_key: key, item_value: value)
+    end
+
+    def update_item(key, value)
+      di = items.select {|item| item.item_key.eql? key }.first
+      if di
+        di.item_value = value
+        fetcher.update_dictionary_item(di)
+      else
+        add_item(key, value)
+      end
+    end
+
+    def delete_item(key)
+      di = items.select {|item| item.item_key.eql? key }.first
+      fetcher.delete_dictionary_item(di) if di
+    end
+
     def self.pluralize
       'dictionaries'
     end

data/lib/fastly/dictionary_item.rb

@@ -0,0 +1,40 @@
+require 'cgi'
+
+class Fastly
+  class DictionaryItem < Base
+    attr_accessor :dictionary_id, :item_key, :item_value, :service_id
+
+    alias_method :key, :item_key
+    alias_method :value, :item_value
+
+    # Return the Service object this belongs to
+    def service
+      @service ||= fetcher.get(Service, service_id)
+    end
+
+    # :nodoc:
+    def as_hash
+      super.delete_if { |var| %w(service_id dictionary_id).include?(var) }
+    end
+
+    def self.get_path(service, dictionary_id, item_key, _opts = {})
+      "/service/#{service}/dictionary/#{dictionary_id}/item/#{CGI::escape(item_key)}"
+    end
+
+    def self.post_path(opts)
+      "/service/#{opts[:service_id]}/dictionary/#{opts[:dictionary_id]}/item"
+    end
+
+    def self.put_path(obj)
+      get_path(obj.service_id, obj.dictionary_id, obj.item_key)
+    end
+
+    def self.delete_path(obj)
+      put_path(obj)
+    end
+
+    def self.list_path(opts = {})
+      "/service/#{opts[:service_id]}/dictionary/#{opts[:dictionary_id]}/items"
+    end
+  end
+end

data/lib/fastly/gem_version.rb

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

data/test/fastly/client_test.rb

@@ -1,9 +1,9 @@
-require 'test_helper'
+require_relative '../test_helper'
 
 describe Fastly::Client do
-  let(:user)        { "test@example.com" }
-  let(:password)    { "notasecret" }
-  let(:api_key)     { "notasecreteither" }
+  let(:user)     { "test@example.com" }
+  let(:password) { "notasecret" }
+  let(:api_key)  { "notasecreteither" }
 
   describe 'initialize' do
     it 'raises ArgumentError when no options provided' do
@@ -45,6 +45,17 @@ describe Fastly::Client do
       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!' })
+
+      assert_raises(ArgumentError) { Fastly.new(username: user, password: pass) }
+
+      Fastly.new(user: user, password: pass)
+      Fastly.new(api_key: api_key)
+      Fastly.new(api_key: api_key, user: user, password: pass)
+    end
   end
 
   describe 'get' do

data/test/fastly/dictionary_test.rb

@@ -0,0 +1,53 @@
+require_relative '../test_helper'
+
+describe Fastly::Dictionary do
+
+  let(:client)     { Fastly.new(user: 'test@example.com', password: 'password') }
+  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!' })
+  }
+
+  describe '#item' do
+    it 'returns the nil when item is not present' do
+      item_key   = 'key'
+      get_item_url = "#{Fastly::Client::DEFAULT_URL}/service/#{service_id}/dictionary/#{dictionary.id}/item/#{item_key}"
+
+      response_body = JSON.dump(
+        "msg"    => "Record not found",
+        "detail" => "Couldn't find dictionary item '{ service => #{service_id}, dictionary_id => #{dictionary.id}, item_key => #{item_key}, deleted => 0000-00-00 00:00:00'",
+      )
+
+      stub_request(:get, get_item_url).to_return(body: response_body, status: 404)
+
+      assert_nil dictionary.item('key')
+    end
+
+    it 'returns the corresponding dictionary item when present' do
+      item_key   = 'key'
+      item_value = 'value'
+
+      response_body = JSON.dump(
+        "dictionary_id" => dictionary.id,
+        "service_id"    => service_id,
+        "item_key"      => item_key,
+        "item_value"    => item_value,
+        "created_at"    => "2016-04-21T18:14:32+00:00",
+        "deleted_at"    => nil,
+        "updated_at"    => "2016-04-21T18:14:32+00:00",
+      )
+
+      get_item_url = "#{Fastly::Client::DEFAULT_URL}/service/#{service_id}/dictionary/#{dictionary.id}/item/#{item_key}"
+
+      stub_request(:get, get_item_url).to_return(body: response_body, status: 200)
+
+      item = dictionary.item('key')
+
+      assert_equal item_key, item.key
+      assert_equal item_value, item.value
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastly
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Fastly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies: []
 description: Client library for the Fastly acceleration system
 email:
@@ -42,6 +42,7 @@ files:
 - lib/fastly/condition.rb
 - lib/fastly/customer.rb
 - lib/fastly/dictionary.rb
+- lib/fastly/dictionary_item.rb
 - lib/fastly/director.rb
 - lib/fastly/domain.rb
 - lib/fastly/fetcher.rb
@@ -66,6 +67,7 @@ files:
 - test/api_key_test.rb
 - test/common.rb
 - test/fastly/client_test.rb
+- test/fastly/dictionary_test.rb
 - test/fastly/util_test.rb
 - test/full_login_test.rb
 - test/helper.rb
@@ -101,9 +103,11 @@ test_files:
 - test/api_key_test.rb
 - test/common.rb
 - test/fastly/client_test.rb
+- test/fastly/dictionary_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
+has_rdoc: