gds-api-adapters 4.9.0 → 5.0.0

data/lib/gds_api/asset_manager.rb

@@ -0,0 +1,37 @@
+require_relative 'base'
+require_relative 'exceptions'
+
+class GdsApi::AssetManager < GdsApi::Base
+  include GdsApi::ExceptionHandling
+
+  # Creates an asset given attributes
+  #
+  # Makes a `POST` request to the asset manager api to create an asset. The api accepts
+  #   the following attributes:
+  #
+  # * `file` - a File object
+  #
+  # @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 create_asset(asset)
+    post_multipart("#{base_url}/assets", { :asset => asset })
+  end
+
+  # Fetches an asset given the id
+  #
+  # @param id [String] The asset identifier
+  # @return [Response, nil] A response object containing the parsed JSON response. If
+  #   the asset cannot be found, nil wil be returned.
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def asset(id)
+    get_json("#{base_url}/assets/#{id}")
+  end
+
+  private
+    def base_url
+      endpoint
+    end
+end

data/lib/gds_api/base.rb

@@ -21,7 +21,7 @@ class GdsApi::Base
                           :post_json, :post_json!,
                           :put_json, :put_json!,
                           :delete_json!,
-                          :get_raw
+                          :get_raw, :post_multipart
 
   attr_reader :options
 

data/lib/gds_api/content_api.rb

@@ -45,16 +45,13 @@ class GdsApi::ContentApi < GdsApi::Base
   end
 
   def artefact(slug, params={})
-    edition = params[:edition]
-    snac = params[:snac]
-
     url = "#{base_url}/#{CGI.escape(slug)}.json"
     query = params.map { |k,v| "#{k}=#{v}" }
     if query.any?
       url += "?#{query.join("&")}"
     end
 
-    if edition && ! options.include?(:bearer_token)
+    if params[:edition] && ! options.include?(:bearer_token)
       raise GdsApi::NoBearerToken
     end
     get_json(url)
@@ -122,10 +119,6 @@ class GdsApi::ContentApi < GdsApi::Base
     super(url, &create_response)
   end
 
-  def countries
-    parse_times(get_json!("#{base_url}/foreign-travel-advice.json"))
-  end
-
   private
     def base_url
       endpoint
@@ -141,13 +134,4 @@ class GdsApi::ContentApi < GdsApi::Base
         batch_response
       end
     end
-
-    def parse_times(response)
-      response["results"].map do |result|
-        if result.has_key?("updated_at")
-          result["updated_at"] = Time.parse(result["updated_at"])
-        end
-      end
-      response
-    end
 end

data/lib/gds_api/imminence.rb

@@ -19,9 +19,9 @@ class GdsApi::Imminence < GdsApi::Base
   end
 
   def places_kml(type)
-    get_raw("#{@endpoint}/places/#{type}.kml")
+    get_raw("#{@endpoint}/places/#{type}.kml").body
   end
-  
+
   def business_support_schemes(facets_hash)
     query = facets_hash.keys.sort.map { |k| "#{k.to_s}=#{facets_hash[k]}" }.join("&")
     query = "?#{query}" unless query.empty?

data/lib/gds_api/json_client.rb

@@ -72,16 +72,22 @@ module GdsApi
       do_request(:delete, url, params)
     end
 
+    def post_multipart(url, params)
+      r = do_raw_request(:post, url, params.merge({
+        :multipart => true
+      }))
+      Response.new(r)
+    end
+
     private
     def do_raw_request(method, url, params = nil)
       response = do_request(method, url, params)
-      response.body
 
     rescue RestClient::ResourceNotFound => e
       raise GdsApi::HTTPNotFound.new(e.http_code)
 
     rescue RestClient::Exception => e
-      raise GdsApi::HTTPErrorResponse.new(response.code.to_i), e.response.body
+      raise GdsApi::HTTPErrorResponse.new(e.response.code.to_i), e.response.body
     end
 
     # method: the symbolic name of the method to use, e.g. :get, :post
@@ -92,7 +98,7 @@ module GdsApi
     def do_json_request(method, url, params = nil, &create_response)
 
       begin
-        response = do_request_with_cache(method, url, params)
+        response = do_request_with_cache(method, url, params.to_json)
 
       rescue RestClient::ResourceNotFound => e
         raise GdsApi::HTTPNotFound.new(e.http_code)
@@ -169,7 +175,7 @@ module GdsApi
         url: url,
         headers: DEFAULT_REQUEST_HEADERS
       }
-      method_params[:payload] = params.to_json if params
+      method_params[:payload] = params
       method_params = with_auth_options(method_params)
       method_params = with_timeout(method_params)
       if URI.parse(url).is_a? URI::HTTPS

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -0,0 +1,26 @@
+module GdsApi
+  module TestHelpers
+    module AssetManager
+
+      ASSET_ENDPOINT = Plek.current.find('asset-manager')
+
+      def asset_manager_has_an_asset(id, atts)
+        response = atts.merge({
+          "_response_info" => { "status" => "ok" }
+        })
+
+        stub_request(:get, "#{ASSET_ENDPOINT}/assets/#{id}")
+          .to_return(:body => response.to_json, :status => 200)
+      end
+
+      def asset_manager_does_not_have_an_asset(id)
+        response = {
+          "_response_info" => { "status" => "not found" }
+        }
+
+        stub_request(:get, "#{ASSET_ENDPOINT}/assets/#{id}")
+          .to_return(:body => response.to_json, :status => 404)
+      end
+    end
+  end
+end

data/lib/gds_api/test_helpers/content_api.rb

@@ -301,23 +301,6 @@ module GdsApi
         @stubbed_content_api_licences << details
       end
 
-      def content_api_has_countries(countries)
-        response = response_base.merge({
-          "results" => countries.map { |slug, values|
-            updated_at = values.has_key?(:updated_at) ? {"updated_at" => values[:updated_at]} : {}
-            {
-              "id" => "#{CONTENT_API_ENDPOINT}/foreign-travel-advice/#{slug}.json",
-              "name" => values[:name],
-              "identifier" => slug,
-              "web_url" => "http://www.test.gov.uk/foreign-travel-advice/#{slug}",
-            }.merge(updated_at)
-          },
-          "total" => countries.length
-        })
-
-        stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/foreign-travel-advice\.json}).to_return(status: 200, body: response.to_json, headers: { })
-      end
-
       private
 
         def titleize_slug(slug)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '4.9.0'
+  VERSION = '5.0.0'
 end

data/test/asset_manager_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'gds_api/asset_manager'
+require 'gds_api/test_helpers/asset_manager'
+
+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
+
+  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)
+
+    file = load_fixture_file("hello.txt")
+    response = @api.create_asset(:file => file)
+
+    assert_equal "http://asset-manager.dev.gov.uk/assets/51278b2b686c82076c000003", response.asset.id
+  end
+
+  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" })
+
+    asset = @api.asset("test-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
+
+  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")
+  end
+end

data/test/content_api_test.rb

@@ -556,32 +556,6 @@ describe GdsApi::ContentApi do
     end
   end
 
-  describe "countries" do
-    before(:each) do
-      content_api_has_countries({
-        'afghanistan' => {:name => 'Afghanistan', :updated_at => "2013-02-11T16:12:22+00:00" },
-        'albania' => {:name => 'Albania'},
-        'algeria' => {:name => 'Algeria'}
-      })
-
-      @results = @api.countries['results']
-    end
-
-    it "should fetch the list of countries" do
-      assert_equal 3, @results.length
-
-      assert_equal ['afghanistan', 'albania', 'algeria'], @results.map {|c| c['identifier'] }
-      assert_equal ['Afghanistan', 'Albania', 'Algeria'], @results.map {|c| c['name'] }
-
-      assert_equal "#{@base_api_url}/foreign-travel-advice/afghanistan.json", @results.first['id']
-      assert_equal 'http://www.test.gov.uk/foreign-travel-advice/afghanistan', @results.first['web_url']
-    end
-
-    it "should parse all updated_at values to Time objects" do
-      assert_equal [Time.parse("2013-02-11T16:12:22+00:00"), nil, nil], @results.map {|c| c['updated_at'] }
-    end
-  end
-
   def api_response_for_results(results)
     {
       "_response_info" => {

data/test/fixtures/hello.txt

@@ -0,0 +1 @@
+Hello, world!

data/test/imminence_api_test.rb

@@ -111,9 +111,36 @@ class ImminenceApiTest < MiniTest::Unit::TestCase
 
     schemes = c.business_support_schemes(sectors: "agriculture,healthcare,manufacturing",
       business_types: "private-company", stages: "grow-and-sustain", types: "award,loan")
-    
+
     assert_equal 3, schemes.size
     assert_equal "bar-business-award", schemes.first["business_support_identifier"]
     assert_equal "Foo small business loan.", schemes.last["title"]
   end
+
+  def test_places_kml
+    kml_body = <<-EOS
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://www.opengis.net/kml/2.2" xmlns:atom="http://www.w3.org/2005/Atom">
+  <Document>
+    <name>DVLA Offices</name>
+    <Placemark>
+      <atom:link/>
+      <name>DVLA Aberdeen local office</name>
+      <description>For enquiries about vehicles: 0300 790 6802 (Textphone minicom users 0300 123 1279).For enquiries about driving licences: 0300 790 6801 (Textphone minicom users 0300 123 1278).Please note, all calls are handled initially by our call centre based in Swansea</description>
+      <address>Greyfriars House, Gallowgate, Aberdeen, AB10 1WG, UK</address>
+      <Point>
+        <coordinates>-2.0971999005177566,57.150739708305785,0</coordinates>
+      </Point>
+    </Placemark>
+  </document>
+</kml>
+EOS
+
+    stub_request(:get, "#{ROOT}/places/test.kml").
+      with(headers: GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
+      to_return(status: 200, body: kml_body )
+
+    response_body = api_client.places_kml("test")
+    assert_equal kml_body, response_body
+  end
 end

data/test/json_client_test.rb

@@ -443,4 +443,32 @@ class JsonClientTest < MiniTest::Spec
 
     assert_equal "hello", response["test"]
   end
+
+  def test_client_can_post_multipart_responses
+    url = "http://some.endpoint/some.json"
+    stub_request(:post, 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.post_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    assert_equal "1", response["b"]
+  end
+
+  def test_post_multipart_should_raise_exception_if_not_found
+    url = "http://some.endpoint/some.json"
+    stub_request(:post, url).to_return(:body => '', :status => 404)
+
+    assert_raises GdsApi::HTTPNotFound do
+      @client.post_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    end
+  end
+
+  def test_post_multipart_should_raise_error_responses
+    url = "http://some.endpoint/some.json"
+    stub_request(:post, url).to_return(:body => '', :status => 500)
+
+    assert_raises GdsApi::HTTPErrorResponse do
+      @client.post_multipart("http://some.endpoint/some.json", {"a" => "123"})
+    end
+  end
 end

data/test/test_helper.rb

@@ -25,5 +25,9 @@ class MiniTest::Unit::TestCase
   end
 end
 
+def load_fixture_file(filename)
+  File.open( File.join( File.dirname(__FILE__), "fixtures", filename ) )
+end
+
 require 'webmock/minitest'
 WebMock.disable_net_connect!

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.9.0
+  version: 5.0.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-18 00:00:00 Z
+date: 2013-02-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -188,46 +188,50 @@ extra_rdoc_files: []
 
 files: 
 - lib/gds_api/version.rb
-- lib/gds_api/base.rb
-- lib/gds_api/licence_application.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/imminence.rb
-- lib/gds_api/rummager.rb
+- lib/gds_api/asset_manager.rb
 - lib/gds_api/content_api.rb
-- lib/gds_api/mapit.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/response.rb
-- lib/gds_api/content_api/list_response.rb
-- lib/gds_api/content_api/response.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/test_helpers/licence_application.rb
-- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/imminence.rb
+- lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/mapit.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
-- lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/part_methods.rb
+- lib/gds_api/licence_application.rb
+- lib/gds_api/base.rb
+- lib/gds_api/mapit.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/response.rb
+- lib/gds_api/content_api/list_response.rb
+- lib/gds_api/content_api/response.rb
+- lib/gds_api/rummager.rb
 - lib/gds_api/panopticon.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/needotron.rb
+- lib/gds_api/exceptions.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/rummager_test.rb
+- test/panopticon_api_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
-- test/licence_application_api_test.rb
 - test/mapit_test.rb
-- test/panopticon_api_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
+- test/asset_manager_test.rb
+- test/content_api_response_test.rb
 - test/json_client_test.rb
-- test/test_helper.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/fixtures/hello.txt
+- test/test_helper.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -241,7 +245,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2287437040986270059
+      hash: 2029378621472477619
       segments: 
       - 0
       version: "0"
@@ -250,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2287437040986270059
+      hash: 2029378621472477619
       segments: 
       - 0
       version: "0"
@@ -262,15 +266,17 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/rummager_test.rb
+- test/panopticon_api_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
-- test/licence_application_api_test.rb
 - test/mapit_test.rb
-- test/panopticon_api_test.rb
+- test/rummager_test.rb
 - test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/content_api_test.rb
+- test/asset_manager_test.rb
+- test/content_api_response_test.rb
 - test/json_client_test.rb
-- test/test_helper.rb
 - test/gds_api_base_test.rb
-- test/content_api_test.rb
-- test/panopticon_registerer_test.rb
+- test/licence_application_api_test.rb
+- test/fixtures/hello.txt
+- test/test_helper.rb