gds-api-adapters 0.0.1

data/README.md

@@ -0,0 +1,11 @@
+A set of API adapters to work with the GDS APIs, extracted from the frontend app.
+
+Example usage:
+
+    publisher_api = GdsApi::Publisher.new("environment")
+    ostruct_publication = publisher.publication_for_slug('my-published-item')
+
+    panopticon_api = GdsApi::Panopticon.new("environment")
+    ostruct_metadata = panopticon_api.artefact_for_slug('my-published-item')
+
+Very much still a work in progress.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require "bundler/gem_tasks"
+require "rdoc/task"
+require 'rake/testtask'
+
+RDoc::Task.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+Rake::TestTask.new("test") do |t|
+  t.ruby_opts << "-rubygems"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test

data/lib/gds_api/base.rb

@@ -0,0 +1,28 @@
+require_relative 'json_utils'
+
+class GdsApi::Base
+  include GdsApi::JsonUtils
+
+  def initialize(platform, endpoint_url = nil)
+    adapter_name = self.class.to_s.split("::").last.downcase
+
+    # This should get simpler if we can be more consistent with our domain names
+    if endpoint_url
+      self.endpoint = endpoint_url
+    elsif platform == 'development'
+      self.endpoint = "http://#{adapter_name}.dev.gov.uk"
+    else
+      self.endpoint = "http://#{adapter_name}.#{platform}.alphagov.co.uk"
+    end
+  end
+  
+  def url_for_slug(slug,options={})
+    base = "#{base_url}/#{slug}.json"
+    params = options.map { |k,v| "#{k}=#{v}" }
+    base = base + "?#{params.join("&")}" unless options.empty? 
+    base
+  end
+  
+  private
+    attr_accessor :endpoint
+end

data/lib/gds_api/contactotron.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+# This adapter's a bit different from the others as it assumes we know
+# the full URI for a contact and just want to grab its json serialization
+# and convert it to an ostruct.
+class GdsApi::Contactotron < GdsApi::Base
+  def initialize
+  end
+
+  def contact_for_uri(uri)
+    to_ostruct get_json(uri)
+  end
+end

data/lib/gds_api/core-ext/openstruct.rb

@@ -0,0 +1,5 @@
+class OpenStruct
+   def to_json
+     table.to_json
+   end
+ end

data/lib/gds_api/imminence.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+class GdsApi::Imminence < GdsApi::Base
+  def api_url(type,lat,lon,limit=5)
+    "#{@endpoint}/places/#{type}.json?limit=#{limit}&lat=#{lat}&lng=#{lon}"
+  end
+
+  def places(type,lat,lon,limit=5)
+    places = get_json(api_url(type,lat,lon,limit)) || []
+    places.map do |o|
+      o['latitude'] = o['location'][0]
+      o['longitude'] = o['location'][1]
+      o['address'] = [o['address1'], o['address2']].reject { |a| a.nil? or a == '' }.map { |a| a.strip }.join(', ')
+      o
+    end
+  end
+
+end

data/lib/gds_api/json_utils.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'net/http'
+require 'ostruct'
+require_relative 'core-ext/openstruct'
+
+module GdsApi::JsonUtils
+  USER_AGENT = "GDS Api Client v. #{GdsApi::VERSION}"
+  
+  def get_json(url)
+    url = URI.parse(url)
+    request = url.path
+    request = request + "?" + url.query if url.query
+
+    response = Net::HTTP.start(url.host, url.port) do |http|
+      http.get(request, {'Accept' => 'application/json', 'User-Agent' => USER_AGENT})
+    end
+    if response.code.to_i != 200
+      return nil
+    else
+      return JSON.parse(response.body)
+    end
+  end
+  
+  def post_json(url,params)
+    url = URI.parse(url)
+    Net::HTTP.start(url.host, url.port) do |http|
+      post_response = http.post(url.path, params.to_json, {'Content-Type' => 'application/json', 'User-Agent' => USER_AGENT})
+      if post_response.code == '200'
+        return JSON.parse(post_response.body)
+      end
+    end
+    return nil
+  end
+
+  def to_ostruct(object)
+    case object
+    when Hash
+      OpenStruct.new Hash[object.map { |key, value| [key, to_ostruct(value)] }]
+    when Array
+      object.map { |k| to_ostruct(k) }
+    else
+      object
+    end
+  end
+end

data/lib/gds_api/panopticon.rb

@@ -0,0 +1,15 @@
+require_relative 'base'
+
+class GdsApi::Panopticon < GdsApi::Base
+
+  def artefact_for_slug(slug)
+    return nil if slug.nil? or slug == ''
+    
+    to_ostruct get_json(url_for_slug(slug))
+  end
+
+  private
+    def base_url
+      "#{endpoint}/artefacts"
+    end
+end

data/lib/gds_api/part_methods.rb

@@ -0,0 +1,44 @@
+module GdsApi::PartMethods
+  def part_index(slug)
+    parts.index { |p| p.slug == slug }
+  end
+
+  def find_part(slug)
+    return nil unless index = part_index(slug)
+    parts[index]
+  end
+
+  def part_after(part)
+    return nil unless index = part_index(part.slug)
+    next_index = index + 1
+    return nil if next_index >= parts.length
+    parts[next_index]
+  end
+  
+  def has_parts?(part)
+    prev_part = has_previous_part?(part)
+    next_part = has_next_part?(part)
+    if prev_part || next_part 
+      true
+    else
+      false
+    end
+  end
+
+  def has_previous_part?(part)
+    index = part_index(part.slug)
+    !index.nil? && index > 0 && true
+  end
+
+  def has_next_part?(part)
+    index = part_index(part.slug)
+    !index.nil? && (index + 1) < parts.length && true
+  end
+
+  def part_before(part)
+    return nil unless index = part_index(part.slug)
+    previous_index = index - 1
+    return nil if previous_index < 0
+    parts[previous_index]
+  end
+end

data/lib/gds_api/publisher.rb

@@ -0,0 +1,41 @@
+require_relative 'base'
+require_relative 'part_methods'
+
+class GdsApi::Publisher < GdsApi::Base
+  def publications
+    get_json(base_url) 
+  end
+
+  def publication_for_slug(slug,options = {})
+    return nil if slug.nil? or slug == ''
+    
+    publication_hash = get_json(url_for_slug(slug, options))
+    if publication_hash 
+      container = to_ostruct(publication_hash)
+      container.extend(GdsApi::PartMethods) if container.parts
+      convert_updated_date(container)
+      container
+    else
+      return nil
+    end
+  end
+  
+  def council_for_transaction(transaction,snac_codes)
+    if json = post_json("#{@endpoint}/local_transactions/#{transaction.slug}/verify_snac.json",{'snac_codes' => snac_codes})
+      return json['snac']
+    else
+      return nil
+    end
+  end
+  
+  private
+    def convert_updated_date(container)
+      if container.updated_at && container.updated_at.class == String
+        container.updated_at = Time.parse(container.updated_at)
+      end
+    end
+    
+    def base_url
+      "#{@endpoint}/publications"
+    end
+end

data/lib/gds_api/version.rb

@@ -0,0 +1,3 @@
+module GdsApi
+  VERSION = '0.0.1'
+end

data/test/contactotron_api_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'gds_api/contactotron'
+
+class ContactotronApiTest < MiniTest::Unit::TestCase
+  def api
+    GdsApi::Contactotron.new
+  end
+
+  def test_should_fetch_and_parse_JSON_into_ostruct
+    uri = "http://contactotron.platform/contacts/1"
+    stub_request(:get, uri).
+      to_return(:status => 200, :body => '{"detail":"value"}')
+    assert_equal OpenStruct, api.contact_for_uri(uri).class
+  end
+end

data/test/panopticon_api_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+require 'gds_api/panopticon'
+
+class PanopticonApiTest < MiniTest::Unit::TestCase
+  EXPECTED_ENDPOINT = 'http://panopticon.test.alphagov.co.uk'
+
+  def api
+    GdsApi::Panopticon.new('test')
+  end
+
+  def test_given_a_slug__should_fetch_artefact_from_panopticon
+    slug = 'an-artefact'
+    artefact_json = { name: 'An artefact' }.to_json
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/artefacts/#{slug}.json").to_return(body: artefact_json)
+
+    artefact = api.artefact_for_slug(slug)
+    assert_equal 'An artefact', artefact.name
+  end
+
+  def should_fetch_and_parse_JSON_into_hash
+    url = "#{EXPECTED_ENDPOINT}/some.json"
+    stub_request(:get, url).to_return(body: {}.to_json)
+
+    assert_equal Hash, api.get_json(url).class
+  end
+
+  def test_should_return_nil_if_404_returned_from_EXPECTED_ENDPOINT
+    url = "#{EXPECTED_ENDPOINT}/some.json"
+    stub_request(:get, url).to_return(status: Rack::Utils.status_code(:not_found))
+
+    assert_nil api.get_json(url)
+  end
+
+  def test_should_construct_correct_url_for_a_slug
+    assert_equal "#{EXPECTED_ENDPOINT}/artefacts/slug.json", api.url_for_slug('slug')
+  end
+
+  def artefact_with_contact_json
+    {
+      name: 'An artefact',
+      slug: 'an-artefact',
+      contact: {
+        name: 'Department for Environment, Food and Rural Affairs (Defra)',
+        email_address: 'helpline@defra.gsi.gov.uk'
+      }
+    }.to_json
+  end
+
+  def test_contacts_should_be_deserialised_into_whole_objects
+    slug = 'an-artefact'
+    artefact_json = artefact_with_contact_json
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/artefacts/#{slug}.json").to_return(body: artefact_json)
+
+    artefact = api.artefact_for_slug(slug)
+    assert_equal 'Department for Environment, Food and Rural Affairs (Defra)', artefact.contact.name
+    assert_equal 'helpline@defra.gsi.gov.uk', artefact.contact.email_address
+  end
+end

data/test/publisher_api_test.rb

@@ -0,0 +1,122 @@
+require 'test_helper'
+require 'gds_api/publisher'
+
+class GdsApi::PublisherTest < MiniTest::Unit::TestCase
+  EXPECTED_ENDPOINT = "http://publisher.test.alphagov.co.uk"
+  
+  def api
+    GdsApi::Publisher.new("test")
+  end
+  
+  def test_given_a_slug__should_go_get_resource_from_publisher_app
+    slug = "a-publication"
+    publication = %@{"audiences":[""],
+      "slug":"#{slug}",
+      "tags":"",
+      "updated_at":"2011-07-28T11:53:03+00:00",
+      "type":"answer",
+      "body":"Something",
+      "title":"A publication"}@
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
+      :body => publication,:status=>200)     
+    
+    pub = api.publication_for_slug(slug)
+
+    assert_equal "Something",pub.body
+  end
+
+  def test_should_optionally_accept_an_edition_id
+    slug = "a-publication"
+    publication = %@{"audiences":[""],
+      "slug":"#{slug}",
+      "tags":"",
+      "updated_at":"2011-07-28T11:53:03+00:00",
+      "type":"answer",
+      "body":"Something",
+      "title":"A publication"}@
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json?edition=678").to_return(
+      :body => publication,:status=>200)     
+    
+    pub = api.publication_for_slug(slug,{:edition => 678})
+  end
+
+  def test_should_fetch_and_parse_json_into_hash
+     url = "#{EXPECTED_ENDPOINT}/some.json"
+     stub_request(:get, url).to_return(
+      :body => "{}",:status=>200) 
+     assert_equal Hash,api.get_json(url).class
+  end
+
+  def test_should_return_nil_if_404_returned_from_endpoint
+     url = "#{EXPECTED_ENDPOINT}/some.json"
+     stub_request(:get, url).to_return(
+      :body => "{}",:status=>404) 
+     assert_nil api.get_json(url)
+  end
+
+  def test_should_construct_correct_url_for_a_slug
+    assert_equal "#{EXPECTED_ENDPOINT}/publications/slug.json", api.url_for_slug("slug")
+  end
+
+  def publication_with_parts(slug)
+    publication = %@{"audiences":[""],
+      "slug":"#{slug}",
+      "tags":"",
+      "updated_at":"2011-07-28T11:53:03+00:00",
+      "type":"guide",
+      "body":"Something",
+      "parts" : [
+      {
+         "body" : "You may be financially protected",
+         "number" : 1,
+         "slug" : "introduction",
+         "title" : "Introduction"
+      },
+      {
+         "body" : "All companies selling packag",
+         "number" : 2,
+         "slug" : "if-you-booked-a-package-holiday",
+         "title" : "If you booked a package holiday"
+      },
+      {
+         "body" : "##Know your rights when you b",
+         "number" : 3,
+         "slug" : "if-you-booked-your-trip-independently",
+         "title" : "If you booked your trip independently"
+      }],
+      "title":"A publication"}@
+
+  end
+
+  def test_parts_should_be_deserialised_into_whole_objects
+    slug = "a-publication"
+    publication = publication_with_parts(slug)
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
+      :body => publication,:status=>200)     
+    
+    pub = api.publication_for_slug(slug)
+    assert_equal 3, pub.parts.size
+    assert_equal "introduction", pub.parts.first.slug
+  end
+
+  def test_a_publication_with_parts_should_have_part_specific_methods
+    slug = "a-publication"
+    publication = publication_with_parts(slug)
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
+      :body => publication,:status=>200)     
+    
+    pub = api.publication_for_slug(slug)
+    assert_equal pub.part_index("introduction"),0
+  end
+
+  def test_updated_at_should_be_a_time_on_deserialisation
+    slug = "a-publication"
+    publication = publication_with_parts(slug)
+    stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
+      :body => publication,:status=>200)     
+    
+    pub = api.publication_for_slug(slug)
+    assert_equal Time, pub.updated_at.class
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'rack/utils'
+require 'simplecov'
+
+SimpleCov.start
+WebMock.disable_net_connect!

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: gds-api-adapters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plek
+  requirement: &70189845417140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70189845417140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70189845416360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70189845416360
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70189845415640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70189845415640
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70189845414900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70189845414900
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70189845414200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: *70189845414200
+description: 
+email:
+- jystewart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gds_api/base.rb
+- lib/gds_api/contactotron.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/imminence.rb
+- lib/gds_api/json_utils.rb
+- lib/gds_api/panopticon.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/publisher.rb
+- lib/gds_api/version.rb
+- README.md
+- Rakefile
+- test/contactotron_api_test.rb
+- test/panopticon_api_test.rb
+- test/publisher_api_test.rb
+- test/test_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adapters to work with GDS APIs
+test_files:
+- test/contactotron_api_test.rb
+- test/panopticon_api_test.rb
+- test/publisher_api_test.rb
+- test/test_helper.rb