gds-api-adapters 0.0.3 → 0.0.4

data/lib/gds_api/base.rb

@@ -1,28 +1,36 @@
 require_relative 'json_utils'
+require 'cgi'
 
 class GdsApi::Base
   include GdsApi::JsonUtils
 
-  def initialize(platform, endpoint_url = nil)
+  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"
+    self.endpoint = endpoint_url || endpoint_for_platform(adapter_name, platform)
+  end
+
+  def url_for_slug(slug, options={})
+    base = "#{base_url}/#{slug}.json#{query_string(options)}"
+  end
+
+private
+  attr_accessor :endpoint
+
+  # This should get simpler if we can be more consistent with our domain names
+  def endpoint_for_platform(adapter_name, platform)
+    if platform == 'development'
+      "http://#{adapter_name}.dev.gov.uk"
     else
-      self.endpoint = "http://#{adapter_name}.#{platform}.alphagov.co.uk"
+      "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
+
+  def query_string(params)
+    return "" if params.empty?
+
+    "?" << params.sort.map { |kv|
+      kv.map { |a| CGI.escape(a.to_s) }.join("=")
+    }.join("&")
   end
-  
-  private
-    attr_accessor :endpoint
-end
+end

data/lib/gds_api/contactotron.rb

@@ -4,6 +4,7 @@ require_relative 'base'
 # 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
 

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

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

data/lib/gds_api/imminence.rb

@@ -1,18 +1,21 @@
 require_relative 'base'
 
 class GdsApi::Imminence < GdsApi::Base
-  def api_url(type,lat,lon,limit=5)
+
+  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]
+  def places(type, lat, lon, limit=5)
+    places = get_json(api_url(type, lat, lon, limit)) || []
+    places.map { |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['address']   = [
+        o['address1'],
+        o['address2']
+      ].reject { |a| a.nil? or a == '' }.map(&:strip).join(', ')
       o
-    end
+    }
   end
-
 end

data/lib/gds_api/json_utils.rb

@@ -6,7 +6,7 @@ require_relative 'version'
 
 module GdsApi::JsonUtils
   USER_AGENT = "GDS Api Client v. #{GdsApi::VERSION}"
-  
+
   def get_json(url)
     url = URI.parse(url)
     request = url.path
@@ -21,8 +21,8 @@ module GdsApi::JsonUtils
       return JSON.parse(response.body)
     end
   end
-  
-  def post_json(url,params)
+
+  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})
@@ -43,4 +43,4 @@ module GdsApi::JsonUtils
       object
     end
   end
-end
+end

data/lib/gds_api/panopticon.rb

@@ -2,14 +2,19 @@ require_relative 'base'
 
 class GdsApi::Panopticon < GdsApi::Base
 
-  def artefact_for_slug(slug)
+  def artefact_for_slug(slug, opts = {})
     return nil if slug.nil? or slug == ''
     
-    to_ostruct get_json(url_for_slug(slug))
+    details = get_json(url_for_slug(slug))
+    if opts[:as_hash]
+      details
+    else
+      to_ostruct(details) 
+    end
   end
 
-  private
-    def base_url
-      "#{endpoint}/artefacts"
-    end
+private
+  def base_url
+    "#{endpoint}/artefacts"
+  end
 end

data/lib/gds_api/part_methods.rb

@@ -1,4 +1,5 @@
 module GdsApi::PartMethods
+
   def part_index(slug)
     parts.index { |p| p.slug == slug }
   end
@@ -8,37 +9,33 @@ module GdsApi::PartMethods
     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
+    !! (has_previous_part?(part) || has_next_part?(part))
   end
 
   def has_previous_part?(part)
     index = part_index(part.slug)
-    !index.nil? && index > 0 && true
+    !! (index && index > 0)
   end
 
   def has_next_part?(part)
     index = part_index(part.slug)
-    !index.nil? && (index + 1) < parts.length && true
+    !! (index && (index + 1) < parts.length)
+  end
+
+  def part_after(part)
+    part_at(part, 1)
   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]
+    part_at(part, -1)
+  end
+
+private
+  def part_at(part, relative_offset)
+    return nil unless current_index = part_index(part.slug)
+    other_index = current_index + relative_offset
+    return nil unless (0 ... parts.length).include?(other_index)
+    parts[other_index]
   end
 end

data/lib/gds_api/publisher.rb

@@ -2,40 +2,41 @@ require_relative 'base'
 require_relative 'part_methods'
 
 class GdsApi::Publisher < GdsApi::Base
+
   def publications
-    get_json(base_url) 
+    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 
+    if publication_hash
       container = to_ostruct(publication_hash)
       container.extend(GdsApi::PartMethods) if container.parts
       convert_updated_date(container)
       container
     else
-      return nil
+      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']
+      json['snac']
     else
-      return nil
+      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"
+
+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

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/test/gds_api_base_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+require 'gds_api/base'
+require 'uri'
+
+class GdsApiBaseTest < MiniTest::Unit::TestCase
+
+  class ConcreteApi < GdsApi::Base
+    def base_url
+      endpoint
+    end
+  end
+
+  def setup
+    @api = ConcreteApi.new('test')
+  end
+
+  def test_should_construct_escaped_query_string
+    api = ConcreteApi.new('test')
+    url = api.url_for_slug("slug", "a" => " ", "b" => "/")
+    u = URI.parse(url)
+    assert_equal "a=+&b=%2F", u.query
+  end
+
+  def test_should_not_add_a_question_mark_if_there_are_no_parameters
+    api = ConcreteApi.new('test')
+    url = api.url_for_slug("slug")
+    refute_match /\?/, url
+  end
+
+  def test_should_use_platform_in_url
+    api = ConcreteApi.new("test")
+    url = api.url_for_slug("slug")
+    u = URI.parse(url)
+    assert_match /test\.alphagov\.co\.uk$/, u.host
+  end
+
+  def test_should_override_platform_with_endpoint_url
+    api = ConcreteApi.new("test", "http://foo.bar")
+    url = api.url_for_slug("slug")
+    u = URI.parse(url)
+    assert_equal "foo.bar", u.host
+  end
+
+  def test_should_use_dev_for_development_platform
+    api = ConcreteApi.new("development")
+    url = api.url_for_slug("slug")
+    u = URI.parse(url)
+    assert_match /dev\.gov\.uk$/, u.host
+  end
+
+  def test_should_derive_adapter_name_from_class
+    api = ConcreteApi.new("test")
+    url = api.url_for_slug("slug")
+    u = URI.parse(url)
+    assert_match /^concreteapi\.test/, u.host
+  end
+
+end

data/test/panopticon_api_test.rb

@@ -17,6 +17,15 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     assert_equal 'An artefact', artefact.name
   end
 
+  def test_given_a_slug_can_fetch_artefact_as_hash
+    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, :as_hash => true)
+    assert artefact.is_a?(Hash)
+  end
+
   def should_fetch_and_parse_JSON_into_hash
     url = "#{EXPECTED_ENDPOINT}/some.json"
     stub_request(:get, url).to_return(body: {}.to_json)

data/test/publisher_api_test.rb

@@ -3,11 +3,11 @@ 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":[""],
@@ -18,8 +18,8 @@ class GdsApi::PublisherTest < MiniTest::Unit::TestCase
       "body":"Something",
       "title":"A publication"}@
     stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
-      :body => publication,:status=>200)     
-    
+      :body => publication,:status=>200)
+
     pub = api.publication_for_slug(slug)
 
     assert_equal "Something",pub.body
@@ -35,22 +35,22 @@ class GdsApi::PublisherTest < MiniTest::Unit::TestCase
       "body":"Something",
       "title":"A publication"}@
     stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json?edition=678").to_return(
-      :body => publication,:status=>200)     
-    
+      :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) 
+      :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) 
+      :body => "{}",:status=>404)
      assert_nil api.get_json(url)
   end
 
@@ -92,8 +92,8 @@ class GdsApi::PublisherTest < MiniTest::Unit::TestCase
     slug = "a-publication"
     publication = publication_with_parts(slug)
     stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
-      :body => publication,:status=>200)     
-    
+      :body => publication,:status=>200)
+
     pub = api.publication_for_slug(slug)
     assert_equal 3, pub.parts.size
     assert_equal "introduction", pub.parts.first.slug
@@ -103,8 +103,8 @@ class GdsApi::PublisherTest < MiniTest::Unit::TestCase
     slug = "a-publication"
     publication = publication_with_parts(slug)
     stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
-      :body => publication,:status=>200)     
-    
+      :body => publication,:status=>200)
+
     pub = api.publication_for_slug(slug)
     assert_equal pub.part_index("introduction"),0
   end
@@ -113,8 +113,8 @@ class GdsApi::PublisherTest < MiniTest::Unit::TestCase
     slug = "a-publication"
     publication = publication_with_parts(slug)
     stub_request(:get, "#{EXPECTED_ENDPOINT}/publications/#{slug}.json").to_return(
-      :body => publication,:status=>200)     
-    
+      :body => publication,:status=>200)
+
     pub = api.publication_for_slug(slug)
     assert_equal Time, pub.updated_at.class
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-06 00:00:00.000000000Z
+date: 2011-12-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
-  requirement: &70126514816420 !ruby/object:Gem::Requirement
+  requirement: &70227649209100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70126514816420
+  version_requirements: *70227649209100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70126514812480 !ruby/object:Gem::Requirement
+  requirement: &70227649208160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70126514812480
+  version_requirements: *70227649208160
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70126514790760 !ruby/object:Gem::Requirement
+  requirement: &70227649207100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *70126514790760
+  version_requirements: *70227649207100
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70126514787500 !ruby/object:Gem::Requirement
+  requirement: &70227649206060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70126514787500
+  version_requirements: *70227649206060
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70126514775900 !ruby/object:Gem::Requirement
+  requirement: &70227649205440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,7 +65,7 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *70126514775900
+  version_requirements: *70227649205440
 description: A set of adapters providing easy access to the GDS gov.uk APIs
 email:
 - jystewart@gmail.com
@@ -85,6 +85,7 @@ files:
 - README.md
 - Rakefile
 - test/contactotron_api_test.rb
+- test/gds_api_base_test.rb
 - test/panopticon_api_test.rb
 - test/publisher_api_test.rb
 - test/test_helper.rb
@@ -114,6 +115,7 @@ specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files:
 - test/contactotron_api_test.rb
+- test/gds_api_base_test.rb
 - test/panopticon_api_test.rb
 - test/publisher_api_test.rb
 - test/test_helper.rb