imgix 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c573b0b53304a06886cb1848fd233109975021d
-  data.tar.gz: ab4b939716370098523381acbcbd3817fdc63b02
+  metadata.gz: 2f2350801ae6efed0843066ea4e479508d23d7da
+  data.tar.gz: 00df9bd86854aef93cf18f0004d204f9034f30cf
 SHA512:
-  metadata.gz: ef8647b9485547eb1af90b6b7d6758099d7028c72745ab55c37f31076a657ed9a4a88872708137b62101bb5b1aa7b940b9673300cc845dc8d72fd9585cac1cd2
-  data.tar.gz: c0b9567ab4201cb685ce94da7d1d61e2e55af6692d83ac916bfc964e5fca97b1cc4b807071353ab797ea2f803aa0f532cb70dfbd64f97cdd58f8dcec7c4b8b1f
+  metadata.gz: fd1bdd5bcee45f9b6fff784aa8603fd9c3781f9cdb94c4382f009fc0ecfc2686021b6e5b92fddc23db4eac47f8d4b131760a4300fa95be1c20bb32b396579329
+  data.tar.gz: bda8d65d92c3803a95e36e129b9f64581c0be82064f6d26f4cbd437cab667c402713192d9f335bc687c4a2ba972e6edfb23226d07813940e877f0723f88aecea

data/.travis.yml

@@ -8,4 +8,4 @@ rvm:
   - 2.2.4
   - 2.1.8
   - jruby-9.0.5.0
-  - rbx-2.11
+  - rbx-3.107

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.2.0] - October 29, 2018
+
+* Added `Client#purge` method to allow purging assets from our cache [#37](https://github.com/imgix/imgix-rb/pull/37)
+
 ## [1.1.0] - February 24, 2016
 
 * Added automatic Base64 encoding for all Base64 variant parameters.

data/Gemfile

@@ -5,4 +5,6 @@ gemspec
 
 gem 'rake'
 gem 'minitest'
+gem 'webmock'
 gem 'addressable'
+gem 'http'

data/README.md

@@ -1,6 +1,6 @@
 # Imgix
 
-Official Ruby Gem for signing [imgix](http://imgix.com) URLs. Tested under 1.9.2, 2.2.2, JRuby 1.7.19, and Rubinius 2.2.7.
+Official Ruby Gem for signing [imgix](http://imgix.com) URLs. Tested under 2.3.0, 2.2.4, 2.1.8, jruby-9.0.5.0, and rbx-2.11.
 
 [![Build Status](https://travis-ci.org/imgix/imgix-rb.png?branch=master)](https://travis-ci.org/imgix/imgix-rb)
 
@@ -78,6 +78,18 @@ For example to use the noise reduction:
 path.noise_reduction(50,50)
 ```
 
+
+## Purge Cache
+
+If you need to remove or update an image on imgix, you can purge it from our cache by initializing a client with your api_key, then calling Imgix::Client#purge with the resource path.
+
+```ruby
+client = Imgix::Client.new(host: 'your-subdomain.imgix.net', api_key: 'your-key')
+client.purge('/images/demo.png')
+```
+
+To learn more about purging assets with imgix, [see our docs](https://docs.imgix.com/setup/purging-images).
+
 ## URL encoding and signed ImgIX URLs
 
 Some important third parties (like Facebook) apply URL escaping to query string components, which can cause correctly signed ImgIX URLs to to be transformed into incorrectly signed ones. We URL encode the query part of the URL before signing, so you don't have to worry about this.

data/imgix.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.0'
   spec.add_dependency 'addressable'
+  spec.add_dependency 'http'
+  spec.add_development_dependency 'webmock'
 end

data/lib/imgix/client.rb

@@ -1,6 +1,8 @@
 require 'digest'
 require 'addressable/uri'
 require 'zlib'
+require 'net/http'
+require 'uri'
 
 module Imgix
   class Client
@@ -11,6 +13,7 @@ module Imgix
 
       @hosts = Array(options[:host]) + Array(options[:hosts]) and validate_hosts!
       @secure_url_token = options[:secure_url_token]
+      @api_key = options[:api_key]
       @use_https = options[:use_https]
       @shard_strategy = options[:shard_strategy] and validate_strategy!
       @include_library_param = options.fetch(:include_library_param, true)
@@ -24,6 +27,19 @@ module Imgix
       p
     end
 
+    def purge(path)
+      raise "Authentication token required" unless !!(@api_key)
+      url = prefix(path)+path
+      uri = URI.parse('https://api.imgix.com/v2/image/purger')
+      req = Net::HTTP::Post.new(uri.path, {"User-Agent" => "imgix #{@library}-#{@version}"})
+      req.basic_auth @api_key, ''
+      req.set_form_data({'url' => url})
+      sock = Net::HTTP.new(uri.host, uri.port)
+      sock.use_ssl = true
+      res = sock.start {|http| http.request(req) }
+      res
+    end
+
     def prefix(path)
       "#{@use_https ? 'https' : 'http'}://#{get_host(path)}"
     end

data/lib/imgix/version.rb

@@ -1,3 +1,3 @@
 module Imgix
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/test_helper.rb

@@ -4,6 +4,8 @@ Bundler.require :test
 
 require 'minitest/autorun'
 require 'imgix'
+require 'webmock/minitest'
+include WebMock::API
 
 class Imgix::Test < MiniTest::Test
 end

data/test/units/purge_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class PurgeTest < Imgix::Test
+  def test_runtime_error_without_api_key
+    assert_raises(RuntimeError) {
+      Imgix::Client.new(host: 'demo.imgix.net', include_library_param: false)
+      .purge('https://demo.imgix.net/images/demo.png')
+    }
+  end
+  
+  def test_successful_purge
+    stub_request(:post, "https://api.imgix.com/v2/image/purger").
+      with(
+        body: {"url"=>"https://demo.imgix.net/images/demo.png"}).
+      to_return(status: 200)
+
+    Imgix::Client.new(host: 'demo.imgix.net', api_key: '10adc394')
+    .purge('/images/demo.png')
+    
+    assert_requested :post, 'https://api.imgix.com/v2/image/purger',
+      body:  'url=https%3A%2F%2Fdemo.imgix.net%2Fimages%2Fdemo.png',
+      headers: {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Basic MTBhZGMzOTQ6', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>"imgix rb-#{ Imgix::VERSION}"},
+      times: 1
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgix
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kelly Sutton
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-24 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -28,6 +28,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easily create and sign imgix URLs.
 email:
 - kelly@imgix.com
@@ -56,6 +84,7 @@ files:
 - test/test_helper.rb
 - test/units/domains_test.rb
 - test/units/path_test.rb
+- test/units/purge_test.rb
 - test/units/url_test.rb
 homepage: https://github.com/imgix/imgix-rb
 licenses:
@@ -77,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Official Ruby Gem for easily creating and signing imgix URLs.
@@ -85,4 +114,5 @@ test_files:
 - test/test_helper.rb
 - test/units/domains_test.rb
 - test/units/path_test.rb
+- test/units/purge_test.rb
 - test/units/url_test.rb