parliament-utils 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64ce1d55fb093dc97a517a40072fb71ba279c4bb
-  data.tar.gz: c629dabd75388bc880432c2d361f64097460ffff
+  metadata.gz: 871a37fca2da71b9bfc844d0f0bfe43d4aadd852
+  data.tar.gz: 66d8d17514fef3ad370fd90a1008b0e6f1dcc63a
 SHA512:
-  metadata.gz: ead9e70107217a9d1adeec2228335369ea410337edcd699c77fcc90add5e7e592765b21f4e11e044884d62639a7789855698713fc2f438d39b019910cc1a87a7
-  data.tar.gz: 531a3c67da969c45518b89b3c004daaa79229282af8381bfe267f19c5ab18af2e1264888394e07cbdf0cc8a25ea91bad55af8ac65841acff8c12e6ea2e379e27
+  metadata.gz: a58fc72377b9b4fb8988c549c3cf3f716b14e00b47d9a356c0e72d677587ca888b2dd4bf324237335ced4926a80e18ed691abe36a49cdf0a7876bb31a3bb6bef
+  data.tar.gz: d9cfa7367b95145edf62f4ea9048075a333b11c74ae52fa245b3374b6f1b9f6b8bf27131a6815e55fa138b5bcbfab7766f4be5e2ae2030c0d0ed35632a04fa5c

data/lib/parliament/utils/config/initializers/mime_types.rb

@@ -3,12 +3,9 @@
 # Add new mime types for use in respond_to blocks:
 # Mime::Type.register "text/richtext", :rtf
 
-Mime::Type.register 'application/n-triples', :nt
-Mime::Type.register 'text/turtle', :ttl
-Mime::Type.register 'application/sparql-results+xml', :srx
-Mime::Type.register 'application/sparql-results+json', :srj
-Mime::Type.register 'text/tab-separated-values', :tsv
-Mime::Type.register 'text/vnd.graphviz', :gv, [], [:dot]
-Mime::Type.register 'application/rdf+xml', :rdf, [], [:rdfxml]
-Mime::Type.register 'application/rdf+ld', :jsonld
+Parliament::Utils::Helpers::ApplicationHelper::API_MIME_TYPE_CONFIG.each do |mime_type|
+  primary = mime_type.shift
+  alternatives = mime_type
 
+  Mime::Type.register primary[1], primary[0], alternatives.values, alternatives.keys
+end

data/lib/parliament/utils/helpers/application_helper.rb

@@ -2,6 +2,54 @@ module Parliament
   module Utils
     module Helpers
       module ApplicationHelper
+        # What MIME types does the API accept?
+        #
+        # Note: All of the below are used to generate MIME types that our application will answer to, but NOT the
+        # alternatives shown in our header. See ALTERNATIVE_MIME_TYPE_CONFIG.
+        API_MIME_TYPE_CONFIG = [
+            {
+                nt: 'application/n-triples'
+            },
+            {
+                ttl: 'text/turtle'
+            },
+            {
+                tsv: 'text/tab-separated-values'
+            },
+            {
+                csv: 'text/csv'
+            },
+            {
+                rj: 'application/json+rdf'
+            },
+            {
+                jsonld: 'application/json+ld',
+                json:   'application/json'
+            },
+            {
+                rdfxml: 'application/rdf+xml',
+                rdf:    'application/xml',
+                xml:    'text/xml'
+            }
+        ].freeze
+
+        # Use the above, minus the last two entries (json & xml), to build an alternative URL list.
+        # Then re-create JSON and XML with the correct alternatives
+        ALTERNATIVE_MIME_TYPE_CONFIG = API_MIME_TYPE_CONFIG.take(API_MIME_TYPE_CONFIG.size-2).concat(
+            [
+                {
+                    json: 'application/json+ld'
+                },
+                {
+                    xml: 'application/rdf+xml'
+                }
+            ]
+        )
+
+        API_MIME_TYPES                   = Parliament::Utils::Helpers::ApplicationHelper::API_MIME_TYPE_CONFIG.map { |mime_type| mime_type.values }.flatten.freeze
+        API_FILE_EXTENSIONS              = Parliament::Utils::Helpers::ApplicationHelper::API_MIME_TYPE_CONFIG.map { |mime_type| mime_type.keys   }.flatten.freeze
+        ALTERNATIVE_MIME_TYPES_FLATTENED = Parliament::Utils::Helpers::ApplicationHelper::ALTERNATIVE_MIME_TYPE_CONFIG.reduce(:merge)
+
         # Sets the title for a page.
         #
         # @param [String] page_title the title of the page.
@@ -15,7 +63,7 @@ module Parliament
         def data_check
           # Check format to see if it is available from the data API
           # We DO NOT offer data formats for constituency maps
-          return if !Parliament::Utils::Helpers::FormatHelper::DATA_FORMATS.include?(request.formats.first) || (params[:controller] == 'constituencies' && params[:action] == 'map')
+          return if !API_MIME_TYPES.include?(request.formats.first) || (params[:controller] == 'constituencies' && params[:action] == 'map')
 
           # Find the current controller/action's API url
           @data_url = data_url
@@ -58,12 +106,10 @@ module Parliament
         def populate_alternates(url)
           alternates = []
 
-          Parliament::Utils::Helpers::FormatHelper::DATA_FORMATS.each do |format|
+          ALTERNATIVE_MIME_TYPES_FLATTENED.each do |extension, format| # (key, value)
             uri =  URI.parse(url)
+            uri.path = "#{uri.path}.#{extension}"
 
-            uri_form = URI.decode_www_form(String(uri.query)) << ['format',format]
-
-            uri.query = URI.encode_www_form(uri_form)
             alternates << { type: format, href: uri.to_s }
           end
 

data/lib/parliament/utils/helpers.rb

@@ -1,6 +1,5 @@
 require_relative './helpers/application_helper'
 require_relative './helpers/flag_helper'
-require_relative './helpers/format_helper'
 require_relative './helpers/houses_helper'
 require_relative './helpers/parliament_helper'
 require_relative './helpers/postcode_helper'

data/lib/parliament/utils/version.rb

@@ -1,5 +1,5 @@
 module Parliament
   module Utils
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.7.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parliament-utils
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Rebecca Appleyard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parliament-ruby
@@ -292,7 +292,6 @@ files:
 - lib/parliament/utils/helpers/application_helper.rb
 - lib/parliament/utils/helpers/filter_helper.rb
 - lib/parliament/utils/helpers/flag_helper.rb
-- lib/parliament/utils/helpers/format_helper.rb
 - lib/parliament/utils/helpers/houses_helper.rb
 - lib/parliament/utils/helpers/parliament_helper.rb
 - lib/parliament/utils/helpers/postcode_helper.rb

data/lib/parliament/utils/helpers/format_helper.rb

@@ -1,21 +0,0 @@
-module Parliament
-  module Utils
-    module Helpers
-      module FormatHelper
-        DATA_FORMATS = %w(
-            application/n-triples
-            text/turtle
-            application/sparql-results+xml
-            application/sparql-results+json
-            text/csv
-            text/tab-separated-values
-            text/vnd.graphviz
-            application/rdf+xml
-            application/xml
-            application/json+ld
-            application/json
-        ).freeze
-        end
-      end
-    end
-  end