parliament-utils 0.1.0

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

@@ -0,0 +1,29 @@
+module Parliament
+  module Utils
+    module Helpers
+      module FlagHelper
+        def self.dissolution?
+          # When in the dissolution period
+          BANDIERA_CLIENT.enabled?('parliament', 'show-dissolution')
+        end
+
+        def self.register_to_vote?
+          # When in dissolution but still in the registration period
+          BANDIERA_CLIENT.enabled?('parliament', 'show-register')
+        end
+
+        def self.election?
+          BANDIERA_CLIENT.enabled?('parliament', 'show-election')
+        end
+
+        def self.post_election?
+          BANDIERA_CLIENT.enabled?('parliament', 'show-post-election')
+        end
+
+        def self.election_period?
+          (election? == true || post_election? == true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Parliament
+  module Utils
+    module Helpers
+      module FormatHelper
+        DATA_FORMATS = ['text/csv',
+          'text/vnd.graphviz',
+          'text/n3',
+          'application/json',
+          'application/n-triples',
+          'application/rdf+xml',
+          'application/rdf+json',
+          'application/xml',
+          'text/tab-separated-values',
+          'text/turtle'].freeze
+        end
+      end
+    end
+  end

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

@@ -0,0 +1,80 @@
+module Parliament
+  module Utils
+    module Helpers
+      module HousesHelper
+        # Checks if house is the House of Commons and sets @commons_id and @lords_id if not already set.
+        #
+        # @param [Grom::Node] house a Grom::Node with type http://id.ukpds.org/schema/House.
+        # @return [Boolean] boolean depending on whether the house has the same id as the House of Commons.
+        def self.commons?(house)
+          set_ids
+
+          house.graph_id == @commons_id
+        end
+
+        # Checks if house is the House of Lords and sets @commons_id and @lords_id if not already set.
+        #
+        # @param [Grom::Node] house a Grom::Node with type http://id.ukpds.org/schema/House.
+        # @return [Boolean] boolean depending on whether the house has the same id as the House of Lords.
+        def self.lords?(house)
+          !commons?(house)
+        end
+
+        # Sets and returns the id for the House of Commons.
+        #
+        # @return [String] @commons_id the id for the House of Commons.
+        def self.commons_id
+          set_ids
+
+          @commons_id
+        end
+
+        # Sets and returns the id for the House of Lords.
+        #
+        # @return [String] @lords_id the id for the House of Lords.
+        def self.lords_id
+          set_ids
+
+          @lords_id
+        end
+
+        # Returns the current house id for the page alongside the other house id.
+        #
+        # @param [Grom::Node] house The house that a particular person is linked to.
+        # @return [Array<String, String>] The current house id and other house id.
+        def self.house_id_string(house)
+          is_commons = self.commons?(house)
+
+          house_ids = [commons_id, lords_id]
+          return house_ids if is_commons
+
+          house_ids.reverse
+        end
+
+        # Returns the current
+        #
+        # @param [Grom::Node] house The house that a particular person is linked to.
+        # @return [Array<String, String>] The current person type and other person type.
+        def self.person_type_string(house)
+          is_mp = self.commons?(house)
+
+          types = [I18n.t('mp_plural'), I18n.t('lord_plural')]
+
+          return types if is_mp
+
+          types.reverse
+        end
+
+        private_class_method
+
+        def self.set_ids
+          return if @commons_id && @lords_id
+          houses = Parliament::Utils::Helpers::ParliamentHelper.parliament_request.houses.get.filter('http://id.ukpds.org/schema/House').sort_by(:name)
+
+          @commons_id = houses.first.graph_id
+          @lords_id = houses.last.graph_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'parliament'
+require 'parliament/ntriple'
+
+module Parliament
+  module Utils
+    module Helpers
+      module ParliamentHelper
+        def self.parliament_request
+          Parliament::Request::UrlRequest.new(
+          builder:    Parliament::Builder::NTripleResponseBuilder,
+          headers:    { 'Ocp-Apim-Subscription-Key': ENV['PARLIAMENT_AUTH_TOKEN'] },
+          decorators: Parliament::Grom::Decorator
+          )
+        end
+
+        def parliament_request
+          Parliament::Utils::Helpers::ParliamentHelper.parliament_request
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require 'i18n'
+require 'parliament/utils/helpers/translation_helper' unless defined?(::Rails)
+
+# attr [String] previous_path the path to redirect back to in the case of an error.
+module Parliament
+  module Utils
+    module Helpers
+      module PostcodeHelper
+
+        include Parliament::Utils::Helpers::TranslationHelper unless defined?(::Rails)
+
+        attr_accessor :previous_path
+
+        # Makes requests to the postcode_lookup endpoint.
+        # @param [String] raw_input the data inputted by the user.
+        # @return [Parliament::Response::NTripleResponse, Parliament::ClientError, Parliament::ServerError] if successful, a response is returned, otherwise an error is returned.
+        def self.lookup(raw_input)
+          postcode = clean_input(raw_input)
+
+          begin
+            Parliament::Utils::Helpers::ParliamentHelper.parliament_request.constituencies.postcode_lookup(postcode).get
+          rescue Parliament::ClientError
+            raise(PostcodeError, I18n.t('error.no_constituency').capitalize)
+          rescue Parliament::ServerError
+            raise(PostcodeError, I18n.t('error.lookup_unavailable').capitalize)
+          end
+        end
+
+        # Replaces whitespace with a hyphen.
+        # @param [String] postcode the string to be hyphenated.
+        # @return [String] a hyphenated string.
+        def self.hyphenate(postcode)
+          postcode.strip.gsub(/\s+/, '-')
+        end
+
+        # Replaces a hyphen with whitespace, restoring a postcode to its usual format.
+        # @param [String] postcode the string to be processed.
+        # @return [String] the restored postcode with hyphen replaced by whitespace.
+        def self.unhyphenate(postcode)
+          postcode.tr('-', ' ')
+        end
+
+        # Returns the previous path variable.
+        # @return [String] previous_path the path to redirect back to in the case of an error.
+        def self.previous_path
+          @previous_path
+        end
+
+        # Sets the previous path variable.
+        # @return [String] previous_path the path to redirect back to in the case of an error.
+        def self.previous_path=(path)
+          @previous_path = path
+        end
+
+        private_class_method
+
+        # We decided to use a loose regex - this matches the different postcode formats, but doesn't validate against invalid letters and numbers, only their positions.
+        def self.clean_input(raw_input)
+          postcode = raw_input.gsub(/\s+/, '').upcase
+
+          postcode.match(/[A-Z]{1,2}[0-9][0-9A-Z]?\s?[0-9][A-Z]{2}/).nil? ? raise(PostcodeError, I18n.t('error.postcode_invalid').capitalize) : postcode
+        end
+
+        class PostcodeError < StandardError
+          def initialize(message)
+            super(message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# Namespace for Parliament::Request helper methods.
+module Parliament
+  module Utils
+    module Helpers
+      module RequestHelper
+        # Takes a Parliament::Request and calls the #get method.
+        # Then maps the #value method on the resulting response.
+        #
+        # @param [Parliament::Request] request a built Parliament::Request object that can just be called with #get
+        #
+        # @return [Array<String>]
+        def self.process_available_letters(request)
+          response = request.get
+          response.map(&:value)
+        end
+
+        # Takes a Parliament::Request and a optional amount of filters and calls the #get method on on the request.
+        # Then calls Parliament::Response#filter with the filters as the parameters on the resulting response.
+        #
+        # @param [Parliament::Request] request a built Parliament::Request object that can just be called with #get
+        #
+        # @return [Parliament::Response]
+        def self.filter_response_data(request, *filters)
+          response = request.get
+          response.filter(*filters)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Parliament
+  module Utils
+    module Helpers
+      module TranslationHelper
+        require 'i18n'
+        
+        I18n.load_path = ['config/locales/en.yml']
+        I18n.backend.load_translations
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# Namespace for helper methods to generate a vcard.
+module Parliament
+  module Utils
+    module Helpers
+      module VCardHelper
+        # Generates a vcard for the given contact point.
+        #
+        # @param [Grom::Node] contact_point a Grom::Node with type: http://id.ukpds.org/schema/ContactPoint.
+        # @return [Vcard::Vcard] a vcard with person, postal address and contact details set.
+        def create_vcard(contact_point)
+          Vcard::Vcard::Maker.make2 do |maker|
+            maker.add_name do |name|
+              person_set(contact_point, name)
+              postal_address_set(contact_point, maker)
+              contacts_set(contact_point, maker)
+            end
+          end
+        end
+
+        # Sets the contact details of a vcard.
+        #
+        # @param [Grom::Node] contact_point a Grom::Node with type: http://id.ukpds.org/schema/ContactPoint.
+        # @param [Vcard::Vcard::Maker] maker a Vcard builder.
+        # @return [Vcard::Vcard::Maker] a Vcard maker with contact details set.
+        def contacts_set(contact_point, maker)
+          maker.add_email(contact_point.email) unless contact_point.email == ''
+          maker.add_tel(contact_point.phone_number) unless contact_point.phone_number == ''
+          maker.add_tel(contact_point.fax_number) { |f| f.location = 'fax' } unless contact_point.fax_number == ''
+        end
+
+        # Sets the postal address of a vcard.
+        #
+        # @param [Grom::Node] contact_point a Grom::Node with type: http://id.ukpds.org/schema/ContactPoint.
+        # @param [Vcard::Vcard::Maker] maker a Vcard builder.
+        # @return [Vcard::Vcard::Maker, Boolean] a Vcard maker with postal address set or false if the contact point has no postal addresses.
+        def postal_address_set(contact_point, maker)
+          return false if contact_point.postal_addresses.empty?
+          address = contact_point.postal_addresses.first.full_address
+          maker.add_addr do |addr|
+            addr.street = address unless address == ''
+          end
+        end
+
+        # Sets the person details of a vcard.
+        #
+        # @param [Grom::Node] contact_point a Grom::Node with type: http://id.ukpds.org/schema/ContactPoint.
+        # @param [Object] name a Vcard::Name.
+        # @return [Vcard::Vcard::Maker, Boolean] a Vcard maker with person details set or false if the contact point is not associated with a person.
+        def person_set(contact_point, name)
+          return false if contact_point.incumbency.nil? || contact_point.incumbency.member.nil?
+          name.given = contact_point.incumbency.member.given_name
+          name.family = contact_point.incumbency.member.family_name
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/helpers.rb

@@ -0,0 +1,18 @@
+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'
+require_relative './helpers/request_helper'
+require_relative './helpers/v_card_helper'
+
+require 'parliament/grom/decorator'
+
+module Parliament
+  module Utils
+    module Helpers
+
+    end
+  end
+end

data/lib/parliament/utils/railtie.rb

@@ -0,0 +1,12 @@
+require_relative './helpers/application_helper'
+
+module Parliament
+  module Utils
+    class Railtie < Rails::Railtie
+      initializer 'parliament-utils.view_helpers' do
+        require 'parliament/utils/config/initializers'
+        ActionView::Base.send(:include, Helpers::ApplicationHelper)
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers/bandiera_helper.rb

@@ -0,0 +1,19 @@
+require 'bandiera/client'
+require 'pugin/bandiera'
+
+module Parliament
+  module Utils
+    module TestHelpers
+      module BandieraHelper
+        def self.load_rspec_config(config)
+          #Stubs Bandiera::Client methods enabled? and get_features_for_group to clean up logs
+          #and streamline cassettes
+          config.before(:each) do
+            allow(BANDIERA_CLIENT).to receive(:enabled?).and_return(false)
+            allow(Pugin::PuginBandieraClient::BANDIERA_CLIENT).to receive(:get_features_for_group).and_return({})
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers/rails_helper.rb

@@ -0,0 +1,42 @@
+module Parliament
+  module Utils
+    module TestHelpers
+      module RailsHelper
+        def self.load_rspec_config(config)
+          Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+#           # RSpec Rails can automatically mix in different behaviours to your tests
+#           # based on their file location, for example enabling you to call `get` and
+#           # `post` in specs under `spec/controllers`.
+#           #
+#           # You can disable this behaviour by removing the line below, and instead
+#           # explicitly tag your specs with their type, e.g.:
+#           #
+#           #     RSpec.describe UsersController, :type => :controller do
+#           #       # ...
+#           #     end
+#           #
+#           # The different available types are documented in the features, such as in
+#           # https://relishapp.com/rspec/rspec-rails/docs
+          config.infer_spec_type_from_file_location!
+#
+#           # Filter lines from Rails gems in backtraces.
+          config.filter_rails_from_backtrace!
+#           # arbitrary gems may also be filtered via:
+#           # config.filter_gems_from_backtrace("gem name")
+          config.include Parliament::Utils::Helpers::ApplicationHelper
+#
+#           # Set Parliament::Utils::Helpers::HousesHelper#set_ids instance variables to nil after each spec.
+#           # Calling certain Parliament::Utils::Helpers::HousesHelper methods (e.g. Parliament::Utils::Helpers::HousesHelper#commons?) causes
+#           # Parliament::Utils::Helpers::HousesHelper#set_ids to be called which sets @commons_id and @lords_id.
+#           # Setting these to nil causes each spec that requires them to make another
+#           # Parliament::Utils::Helpers::ParliamentHelper request and generate a VCR cassette and stops any RSpec
+#           # ordering issues where they may or may not have been set by the previous spec.
+          config.after(:each) do
+            Parliament::Utils::Helpers::HousesHelper.instance_variable_set(:@commons_id, nil)
+            Parliament::Utils::Helpers::HousesHelper.instance_variable_set(:@lords_id, nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers/rspec_helper.rb

@@ -0,0 +1,76 @@
+module Parliament
+  module Utils
+    module TestHelpers
+      module RSpecHelper
+
+        def self.load_rspec_config(config)
+          # RSpec.configure do |config|
+            # rspec-expectations config goes here. You can use an alternate
+            # assertion/expectation library such as wrong or the stdlib/minitest
+            # assertions if you prefer.
+            config.expect_with :rspec do |expectations|
+              # This option will default to `true` in RSpec 4. It makes the `description`
+              # and `failure_message` of custom matchers include text for helper methods
+              # defined using `chain`, e.g.:
+              #     be_bigger_than(2).and_smaller_than(4).description
+              #     # => "be bigger than 2 and smaller than 4"
+              # ...rather than:
+              #     # => "be bigger than 2"
+              expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+            end
+
+            # rspec-mocks config goes here. You can use an alternate test double
+            # library (such as bogus or mocha) by changing the `mock_with` option here.
+            config.mock_with :rspec do |mocks|
+              # Prevents you from mocking or stubbing a method that does not exist on
+              # a real object. This is generally recommended, and will default to
+              # `true` in RSpec 4.
+              mocks.verify_partial_doubles = true
+            end
+
+            # These two settings work together to allow you to limit a spec run
+            # to individual examples or groups you care about by tagging them with
+            # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+            # get run.
+            config.filter_run :focus
+            config.run_all_when_everything_filtered = true
+
+            # Disable RSpec exposing methods globally on `Module` and `main`
+            config.disable_monkey_patching!
+
+            # Many RSpec users commonly either run the entire suite or an individual
+            # file, and it's useful to allow more verbose output when running an
+            # individual spec file.
+            if config.files_to_run.one?
+              # Use the documentation formatter for detailed output,
+              # unless a formatter has already been configured
+              # (e.g. via a command-line flag).
+              config.default_formatter = 'doc'
+            end
+
+            # Print the 10 slowest examples and example groups at the
+            # end of the spec run, to help surface which specs are running
+            # particularly slow.
+            config.profile_examples = 10
+
+            config.expect_with :rspec do |c|
+              c.syntax = :expect
+            end
+
+            # Run specs in random order to surface order dependencies. If you find an
+            # order dependency and want to debug it, you can fix the order by providing
+            # the seed, which is printed after each run.
+            #     --seed 1234
+            config.order = :random
+
+            # Seed global randomization in this process using the `--seed` CLI option.
+            # Setting this allows you to use `--seed` to deterministically reproduce
+            # test failures related to randomization by passing the same `--seed` value
+            # as the one that triggered the failure.
+            Kernel.srand config.seed
+          # end
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers/simplecov_helper.rb

@@ -0,0 +1,20 @@
+module Parliament
+  module Utils
+    module TestHelpers
+      module SimpleCovHelper
+        
+        require 'coveralls'
+        require 'simplecov'
+
+        def self.load_rspec_config(config)
+
+          SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+            Coveralls::SimpleCov::Formatter,
+            SimpleCov::Formatter::HTMLFormatter
+            ])
+            SimpleCov.start
+          end
+        end
+      end
+    end
+  end

data/lib/parliament/utils/test_helpers/vcr_helper.rb

@@ -0,0 +1,83 @@
+module Parliament
+  module Utils
+    module TestHelpers
+      module VCRHelper
+        require 'vcr'
+
+        def self.load_rspec_config(config)
+
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+            config.hook_into :webmock
+            config.configure_rspec_metadata!
+
+            config.default_cassette_options = {
+              # record: :new_episodes
+              record: :once
+            }
+
+            # Create a simple matcher which will 'filter' any request URIs on the fly
+            config.register_request_matcher :filtered_uri do |request_1, request_2|
+              parliament_match = request_1.uri.sub(ENV['PARLIAMENT_BASE_URL'], 'http://localhost:3030') == request_2.uri.sub(ENV['PARLIAMENT_BASE_URL'], 'http://localhost:3030')
+              bandiera_match = request_1.uri.sub(ENV['BANDIERA_URL'], 'http://localhost:5000') == request_2.uri.sub(ENV['BANDIERA_URL'], 'http://localhost:5000')
+
+              parliament_match || bandiera_match
+            end
+
+            config.default_cassette_options = { match_requests_on: [:method, :filtered_uri] }
+
+            # Dynamically filter our sensitive information
+            config.filter_sensitive_data('<AUTH_TOKEN>') { ENV['PARLIAMENT_AUTH_TOKEN'] }
+            config.filter_sensitive_data('http://localhost:3030') { ENV['PARLIAMENT_BASE_URL'] }
+            config.filter_sensitive_data('http://localhost:5000') { ENV['BANDIERA_URL'] }
+
+            # Dynamically filter n-triple data
+            config.before_record do |interaction|
+              should_ignore = ['_:node', '^^<http://www.w3.org/2001/XMLSchema#date>', '^^<http://www.w3.org/2001/XMLSchema#integer>']
+
+              # Check if content type header exists and if it includes application/n-triples
+              if interaction.response.headers['Content-Type'] && interaction.response.headers['Content-Type'].include?('application/n-triples')
+                # Split our data by line
+                lines = interaction.response.body.split("\n")
+
+                # How many times have we seen a predicate?
+                predicate_occurrances = Hash.new(1)
+
+                # Iterate over each line, decide if we need to filter it.
+                lines.each do |line|
+                  next if should_ignore.any? { |condition| line.include?(condition) }
+                  next unless line.include?('"')
+
+                  # require 'pry'; binding.pry
+                  # Split on '> <' to get a Subject and Predicate+Object split
+                  subject, predicate_and_object = line.split('> <')
+
+                  # Get the actual object
+                  predicate, object = predicate_and_object.split('> "')
+
+                  # Get the last part of a predicate URI
+                  predicate_type = predicate.split('/').last
+
+                  # Get the number of times we've seen this predicate
+                  occurrance = predicate_occurrances[predicate_type]
+                  predicate_occurrances[predicate_type] = predicate_occurrances[predicate_type] + 1
+
+                  # Try and build a new object value based on the predicate
+                  new_object = "#{predicate_type} - #{occurrance}\""
+
+                  # Replace the object value
+                  index = object.index('"')
+
+                  object[0..index] = new_object if index
+
+                  new_line = "#{subject}> <#{predicate}> \"#{object}"
+                  config.filter_sensitive_data(new_line) { line }
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers/webmock_helper.rb

@@ -0,0 +1,13 @@
+module Parliament
+  module Utils
+    module TestHelpers
+      module WebmockHelper
+        def self.load_rspec_config(config)
+          require 'webmock/rspec'
+
+          WebMock.disable_net_connect!(allow_localhost: true)
+        end
+      end
+    end
+  end
+end

data/lib/parliament/utils/test_helpers.rb

@@ -0,0 +1,19 @@
+require_relative './test_helpers/rails_helper' if defined?(::Rails)
+require_relative './test_helpers/rspec_helper'
+require_relative './test_helpers/simplecov_helper'
+require_relative './test_helpers/vcr_helper'
+require_relative './test_helpers/webmock_helper'
+require_relative './test_helpers/bandiera_helper'
+
+module Parliament
+  module Utils
+    module TestHelpers
+      include Parliament::Utils::TestHelpers::RailsHelper if defined?(::Rails)
+      include Parliament::Utils::TestHelpers::RSpecHelper
+      include Parliament::Utils::TestHelpers::SimpleCovHelper
+      include Parliament::Utils::TestHelpers::VCRHelper
+      include Parliament::Utils::TestHelpers::WebmockHelper
+      include Parliament::Utils::TestHelpers::BandieraHelper
+    end
+  end
+end

data/lib/parliament/utils/version.rb

@@ -0,0 +1,5 @@
+module Parliament
+  module Utils
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/parliament/utils.rb

@@ -0,0 +1,10 @@
+require 'parliament/utils/version'
+require 'parliament/utils/helpers'
+require 'parliament/utils/config/initializers/bandiera'
+require 'parliament/utils/test_helpers'
+require 'parliament/utils/railtie' if defined?(Rails)
+
+module Parliament
+  module Utils
+  end
+end