gds-api-adapters 7.9.1 → 7.10.0

data/lib/gds_api/organisations.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+class GdsApi::Organisations < GdsApi::Base
+
+  def organisations
+    get_list! "#{base_url}/organisations"
+  end
+
+  def organisation(organisation_slug)
+    get_json "#{base_url}/organisations/#{organisation_slug}"
+  end
+
+private
+  def base_url
+    "#{endpoint}/api"
+  end
+end

data/lib/gds_api/test_helpers/common_responses.rb

@@ -9,6 +9,13 @@ module GdsApi
         end
       end
 
+      # expects a slug like "ministry-of-funk"
+      # returns an acronym like "MOF"
+      def acronymize_slug(slug)
+        initials = slug.gsub(/\b\w+/) {|m| m[0] }.gsub("-", "")
+        initials.upcase
+      end
+
       def response_base
         {
           "_response_info" => {

data/lib/gds_api/test_helpers/organisations.rb

@@ -0,0 +1,101 @@
+require 'gds_api/test_helpers/json_client_helper'
+require 'gds_api/test_helpers/common_responses'
+
+module GdsApi
+  module TestHelpers
+    module Organisations
+      include GdsApi::TestHelpers::CommonResponses
+
+      ORGANISATIONS_API_ENDPOINT = Plek.current.find('whitehall-admin')
+
+      # Sets up the index endpoints for the given organisation slugs
+      # The stubs are setup to paginate in chunks of 20
+      #
+      # This also sets up the individual endpoints for each slug
+      # by calling organisations_api_has_organisation below
+      def organisations_api_has_organisations(organisation_slugs)
+        organisation_slugs.each {|s| organisations_api_has_organisation(s) }
+        pages = []
+        organisation_slugs.each_slice(20) do |slugs|
+          pages << slugs.map {|s| organisation_details_for_slug(s) }
+        end
+
+        pages.each_with_index do |page, i|
+          page_details = plural_response_base.merge({
+            "results" => page,
+            "total" => organisation_slugs.size,
+            "pages" => pages.size,
+            "current_page" => i + 1,
+            "page_size" => 20,
+            "start_index" => i * 20 + 1,
+          })
+
+          links = {:self => "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 1}" }
+          links[:next] = "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 2}" if pages[i+1]
+          links[:previous] = "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i}" unless i == 0
+          page_details["_response_info"]["links"] = []
+          link_headers = []
+          links.each do |rel, href|
+            page_details["_response_info"]["links"] << {"rel" => rel, "href" => href}
+            link_headers << "<#{href}>; rel=\"#{rel}\""
+          end
+
+          stub_request(:get, links[:self]).
+            to_return(:status => 200, :body => page_details.to_json, :headers => {"Link" => link_headers.join(", ")})
+          if i == 0
+            # First page exists at URL with and without page param
+            stub_request(:get, links[:self].sub(/\?page=1/, '')).
+              to_return(:status => 200, :body => page_details.to_json, :headers => {"Link" => link_headers.join(", ")})
+          end
+        end
+      end
+
+      def organisations_api_has_organisation(organisation_slug, details=nil)
+        details ||= organisation_for_slug(organisation_slug)
+        stub_request(:get, "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{organisation_slug}").
+          to_return(:status => 200, :body => details.to_json)
+      end
+
+      def organisations_api_does_not_have_organisation(organisation_slug)
+        stub_request(:get, "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{organisation_slug}").to_return(:status => 404)
+      end
+
+      def organisation_for_slug(slug)
+        singular_response_base.merge(organisation_details_for_slug(slug))
+      end
+
+      # Constructs a sample organisation
+      #
+      # if the slug contains 'ministry' the format will be set to 'Ministerial department'
+      # otherwise it will be set to 'Executive agency'
+      def organisation_details_for_slug(slug)
+        {
+          "id" => "https://www.gov.uk/api/organisations/#{slug}",
+          "title" => titleize_slug(slug, :title_case => true),
+          "format" => (slug =~ /ministry/ ? "Ministerial department" : "Executive agency"),
+          "updated_at" => "2013-03-25T13:06:42+00:00",
+          "web_url" => "https://www.gov.uk/government/organisations/#{slug}",
+          "details" => {
+            "slug" => slug,
+            "acronym" => acronymize_slug(slug),
+            "closed_at" => nil,
+            "govuk_status" => (slug =~ /ministry/ ? "live" : "joining"),
+          },
+          "parent_organisations" => [
+            {
+              "id" => "https://www.gov.uk/api/organisations/#{slug}-parent-1",
+              "web_url" => "https://www.gov.uk/government/organisations/#{slug}-parent-1"
+            },
+          ],
+          "child_organisations" => [
+            {
+              "id" => "https://www.gov.uk/api/organisations/#{slug}-child-1",
+              "web_url" => "https://www.gov.uk/government/organisations/#{slug}-child-1"
+            },
+          ],
+        }
+      end
+
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.9.1'
+  VERSION = '7.10.0'
 end

data/test/organisations_api_test.rb

@@ -0,0 +1,53 @@
+require_relative 'test_helper'
+require 'gds_api/organisations'
+require 'gds_api/test_helpers/organisations'
+
+describe GdsApi::Organisations do
+  include GdsApi::TestHelpers::Organisations
+
+  before do
+    @base_api_url = GdsApi::TestHelpers::Organisations::ORGANISATIONS_API_ENDPOINT
+    @api = GdsApi::Organisations.new(@base_api_url)
+  end
+
+  describe "fetching list of organisations" do
+    it "should get the organisations" do
+      organisation_slugs = %w(ministry-of-fun, tea-agency)
+      organisations_api_has_organisations(organisation_slugs)
+
+      response = @api.organisations
+      assert_equal organisation_slugs, response.map {|r| r.details.slug }
+      assert_equal "Tea Agency", response.results[1].title
+    end
+
+    it "should handle the pagination" do
+      organisation_slugs = (1..50).map {|n| "organisation-#{n}" }
+      organisations_api_has_organisations(organisation_slugs)
+
+      response = @api.organisations
+      assert_equal organisation_slugs, response.with_subsequent_pages.map {|r| r.details.slug }
+    end
+
+    it "should raise error if endpoint 404s" do
+      stub_request(:get, "#{@base_api_url}/api/organisations").to_return(:status => 404)
+      assert_raises GdsApi::HTTPNotFound do
+        @api.organisations
+      end
+    end
+  end
+
+  describe "fetching an organisation" do
+    it "should return the details" do
+      organisations_api_has_organisation('ministry-of-fun')
+
+      response = @api.organisation('ministry-of-fun')
+      assert_equal 'Ministry Of Fun', response.title
+    end
+
+    it "should return nil for a non-existent organisation" do
+      organisations_api_does_not_have_organisation('non-existent')
+
+      assert_nil @api.organisation('non-existent')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 7.9.1
+  version: 7.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -273,6 +273,7 @@ files:
 - lib/gds_api/test_helpers/need_api.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/organisations.rb
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/worldwide.rb
 - lib/gds_api/test_helpers/mapit.rb
@@ -284,6 +285,7 @@ files:
 - lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/common_responses.rb
 - lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/organisations.rb
 - lib/gds_api/needotron.rb
 - lib/gds_api/null_cache.rb
 - lib/gds_api/imminence.rb
@@ -313,6 +315,7 @@ files:
 - test/json_client_test.rb
 - test/content_api_test.rb
 - test/response_test.rb
+- test/organisations_api_test.rb
 - test/imminence_api_test.rb
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt
@@ -335,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 584452250631713984
+      hash: 4439822392201911705
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -344,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 584452250631713984
+      hash: 4439822392201911705
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -365,6 +368,7 @@ test_files:
 - test/json_client_test.rb
 - test/content_api_test.rb
 - test/response_test.rb
+- test/organisations_api_test.rb
 - test/imminence_api_test.rb
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt