gds-api-adapters 10.8.0 → 10.9.0

data/lib/gds_api/asset_manager.rb

@@ -19,6 +19,22 @@ class GdsApi::AssetManager < GdsApi::Base
     post_multipart("#{base_url}/assets", { :asset => asset })
   end
 
+  # Updates an asset given attributes
+  #
+  # Makes a `PUT` request to the asset manager api to update an asset.
+  # The api accepts the following attributes:
+  #
+  # * `file` - a File object
+  #
+  # @param id [String] The asset identifier
+  # @param asset [Hash] The attributes for the asset to send to the api.
+  # @return [Net::HTTPResponse] The raw http response from the api.
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def update_asset(id, asset)
+    put_multipart("#{base_url}/assets/#{id}", { :asset => asset })
+  end
+
   # Fetches an asset given the id
   #
   # @param id [String] The asset identifier

data/lib/gds_api/base.rb

@@ -23,6 +23,7 @@ class GdsApi::Base
                           :put_json, :put_json!,
                           :delete_json!,
                           :get_raw, :get_raw!,
+                          :put_multipart,
                           :post_multipart
 
   attr_reader :options

data/lib/gds_api/json_client.rb

@@ -99,6 +99,13 @@ module GdsApi
       Response.new(r)
     end
 
+    def put_multipart(url, params)
+      r = do_raw_request(:put, url, params.merge({
+        :multipart => true
+      }))
+      Response.new(r)
+    end
+
     private
     def do_raw_request(method, url, params = nil)
       response = do_request(method, url, params)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '10.8.0'
+  VERSION = '10.9.0'
 end

data/test/asset_manager_test.rb

@@ -1,39 +1,72 @@
 require 'test_helper'
 require 'gds_api/asset_manager'
 require 'gds_api/test_helpers/asset_manager'
+require 'json'
 
 describe GdsApi::AssetManager do
   include GdsApi::TestHelpers::AssetManager
 
-  before do
-    @base_api_url = Plek.current.find("asset-manager")
-    @api = GdsApi::AssetManager.new(@base_api_url)
-  end
+  let(:base_api_url) { Plek.current.find('asset-manager') }
+  let(:api) { GdsApi::AssetManager.new(base_api_url) }
 
-  it "can create an asset with a file" do
-    stub_request(:post, "#{@base_api_url}/assets").
-      with(:body => %r{Content\-Disposition: form\-data; name="asset\[file\]"; filename="hello\.txt"\r\nContent\-Type: text/plain}).
-      to_return(:body => '{"asset":{"id":"http://asset-manager.dev.gov.uk/assets/51278b2b686c82076c000003"}}', :status => 201)
+  let(:file_fixture) { load_fixture_file("hello.txt") }
 
-    file = load_fixture_file("hello.txt")
-    response = @api.create_asset(:file => file)
+  let(:asset_url) { [base_api_url, "assets", asset_id].join("/") }
+  let(:asset_id) { "new-asset-id" }
 
-    assert_equal "http://asset-manager.dev.gov.uk/assets/51278b2b686c82076c000003", response.asset.id
-  end
+  let(:asset_manager_response) {
+    {
+      asset: {
+        id: asset_url,
+      }
+    }
+  }
 
-  it "can get an asset" do
-    asset_manager_has_an_asset("test-id", { "name" => "photo.jpg", "content_type" => "image/jpeg", "file_url" => "http://fooey.gov.uk/media/photo.jpg" })
+  it "creates an asset with a file" do
+    req = stub_request(:post, "#{base_api_url}/assets").
+      with(:body => %r{Content\-Disposition: form\-data; name="asset\[file\]"; filename="hello\.txt"\r\nContent\-Type: text/plain}).
+      to_return(:body => JSON.dump(asset_manager_response), :status => 201)
 
-    asset = @api.asset("test-id")
+    response = api.create_asset(:file => file_fixture)
 
-    assert_equal "photo.jpg", asset.name
-    assert_equal "image/jpeg", asset.content_type
-    assert_equal "http://fooey.gov.uk/media/photo.jpg", asset.file_url
+    assert_equal asset_url, response.asset.id
+    assert_requested(req)
   end
 
   it "returns nil when an asset does not exist" do
     asset_manager_does_not_have_an_asset("not-really-here")
 
-    assert_nil @api.asset("not-really-here")
+    assert_nil api.asset("not-really-here")
+  end
+
+  describe "an asset exists" do
+    before do
+      asset_manager_has_an_asset(
+        asset_id,
+        "name" => "photo.jpg",
+        "content_type" => "image/jpeg",
+        "file_url" => "http://fooey.gov.uk/media/photo.jpg",
+      )
+    end
+
+    let(:asset_id) { "test-id" }
+
+    it "updates an asset with a file" do
+      req = stub_request(:put, "http://asset-manager.dev.gov.uk/assets/test-id").
+        to_return(:body => JSON.dump(asset_manager_response), :status => 200)
+
+      response = api.update_asset(asset_id, :file => file_fixture)
+
+      assert_equal "#{base_api_url}/assets/#{asset_id}", response.asset.id
+      assert_requested(req)
+    end
+
+    it "retrieves an asset" do
+      asset = api.asset(asset_id)
+
+      assert_equal "photo.jpg", asset.name
+      assert_equal "image/jpeg", asset.content_type
+      assert_equal "http://fooey.gov.uk/media/photo.jpg", asset.file_url
+    end
   end
 end

data/test/json_client_test.rb

@@ -695,6 +695,35 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
+  # EXACTLY the same as the post_multipart tests
+  def test_client_can_put_multipart_responses
+    url = "http://some.endpoint/some.json"
+    stub_request(:put, url).
+      with(:body => %r{Content\-Disposition: form\-data; name="a"\r\n\r\n123}, :headers => {'Content-Type' => %r{multipart/form-data; boundary=\d+}}).
+      to_return(:body => '{"b": "1"}', :status => 200)
+
+    response = @client.put_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    assert_equal "1", response["b"]
+  end
+
+  def test_put_multipart_should_raise_exception_if_not_found
+    url = "http://some.endpoint/some.json"
+    stub_request(:put, url).to_return(:body => '', :status => 404)
+
+    assert_raises GdsApi::HTTPNotFound do
+      @client.put_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    end
+  end
+
+  def test_put_multipart_should_raise_error_responses
+    url = "http://some.endpoint/some.json"
+    stub_request(:put, url).to_return(:body => '', :status => 500)
+
+    assert_raises GdsApi::HTTPErrorResponse do
+      @client.put_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    end
+  end
+
   def test_should_raise_error_if_attempting_to_disable_timeout
     assert_raises RuntimeError do
       GdsApi::JsonClient.new(:disable_timeout => true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 10.8.0
+  version: 10.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -376,7 +376,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1895053804403919519
+      hash: -553660564906139153
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -385,7 +385,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1895053804403919519
+      hash: -553660564906139153
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23