ogc 0.1.0

data/lib/ogc/web_feature_service/get_capabilities.rb

@@ -0,0 +1,9 @@
+module Ogc
+  module WebFeatureService
+    class GetCapabilities < Base
+      def get(&block)
+        super(request: self.class.request_name, &block)
+      end
+    end
+  end
+end

data/lib/ogc/web_feature_service/get_feature.rb

@@ -0,0 +1,14 @@
+module Ogc
+  module WebFeatureService
+    class GetFeature < Base
+      def get(type_name, extra_params = {}, &block)
+        params = {
+          'request'  => self.class.request_name,
+          'typeName' => type_name
+        }.merge!(extra_params)
+
+        super(params, &block)
+      end
+    end
+  end
+end

data/ogc.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'English'
+require 'ogc/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.name    = 'ogc'
+  spec.version = Ogc::VERSION
+  spec.authors = ['Geoffrey Roguelon']
+  spec.email   = ['geoffrey.roguelon@gmail.com']
+
+  spec.summary     = 'Allow you to use WFS protocol defined by OGC.'
+  spec.description = <<-STR
+    This gems allow you to make calls in using Web Feature Service protocol
+    defined by OGC (Open Geospatial Consortium) organization.
+  STR
+  spec.homepage    = 'https://github.com/GRoguelon/ogc'
+  spec.license     = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    # rubocop:disable Metrics/LineLength
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+    # rubocop:enable Metrics/LineLength
+  end
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.6', '>= 1.6.6'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'guard', '~> 2.13'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+end

data/test/ogc/clean_xml_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+require 'active_support/core_ext/string/strip'
+
+module Ogc
+  class CleanXMLTest < TestCase
+    using CleanXML
+
+    setup do
+      @xml = <<-XML.strip_heredoc
+        <class name="FakeClass"
+               extends="Object">
+          <methods>
+            <class-method name="clean" arity="1">
+              <arguements>
+                <argument name="xml" />
+              </arguments>
+          </methods>
+        </class>
+      XML
+
+      @cleaned_xml  = '<class name="FakeClass" extends="Object"><methods>'
+      @cleaned_xml += '<class-method name="clean" arity="1">'
+      @cleaned_xml += '<arguements><argument name="xml" /></arguments>'
+      @cleaned_xml += '</methods></class>'
+    end
+
+    test 'clean_xml! method remove the breaklines' do
+      assert_equal @cleaned_xml, @xml.clean_xml!
+    end
+  end
+end

data/test/ogc/exceptions/exception_report_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+module Ogc
+  module Exceptions
+    class ExceptionReportTest < TestCase
+      using CleanXML
+
+      setup do
+        @xml_100    = read_xml('wfs/service_exception_report')
+        @report_100 = ExceptionReport.new(@xml_100)
+
+        @xml_110    = read_xml('wfs/exception_report')
+        @report_110 = ExceptionReport.new(@xml_110)
+
+        @xml_fake = read_xml('wfs/fake_report')
+      end
+
+      test 'class inherits from OgcException' do
+        assert ExceptionReport < OgcException
+      end
+
+      test 'ROOTS constant is a frozen array of string' do
+        assert ExceptionReport::ROOTS.frozen?
+        assert_kind_of Array, ExceptionReport::ROOTS
+      end
+
+      test 'exception? class method return boolean' do
+        assert ExceptionReport.exception?(@xml_100)
+        refute ExceptionReport.exception?(@xml_fake)
+      end
+
+      test 'constructor takes xml and sets the attribute' do
+        assert_equal @xml_100.to_xml, @report_100.report.to_xml
+        assert_equal @xml_110.to_xml, @report_110.report.to_xml
+      end
+
+      test 'constructor raises ArgumentError is not an WFS exception' do
+        assert_raises(ArgumentError) { ExceptionReport.new(@xml_fake) }
+      end
+
+      test 'constructor sets the message of StandardError attribute' do
+        msg = 'Unable to INSERT STMT'
+        assert_equal msg, @report_100.message
+
+        msg = 'parse error: missing closing tag for element wkbGeom'
+        assert_equal msg, @report_110.message
+      end
+
+      test 'at_xpath method delegates to report instance variable' do
+        assert_equal '1.2.0', @report_100.at_xpath('/*/@version').text
+        assert_equal '1.1.0', @report_110.at_xpath('/*/@version').text
+      end
+
+      test 'xpath method delegates to report instance variable' do
+        expected_xml  = '<ServiceException code="999" locator="INSERT STMT 01">'
+        expected_xml += 'Unable to INSERT STMT'
+        expected_xml += '</ServiceException>'
+        actual_xml    = @report_100.xpath('//xmlns:ServiceException').first.to_xml
+        assert_equal expected_xml, actual_xml
+
+        expected_xml  = '<ExceptionText>'
+        expected_xml += 'parse error: missing closing tag for element wkbGeom'
+        expected_xml += '</ExceptionText>'
+        actual_xml    = @report_110.xpath('//xmlns:ExceptionText').first.to_xml
+        assert_equal expected_xml, actual_xml
+      end
+
+      test 'version method returns version attribute' do
+        assert_equal '1.2.0', @report_100.version
+        assert_equal '1.1.0', @report_110.version
+      end
+    end
+  end
+end

data/test/ogc/exceptions/ogc_exception_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module Ogc
+  module Exceptions
+    class OgcExceptionTest < TestCase
+      test 'class inherits from StandardError' do
+        assert OgcException < StandardError
+      end
+    end
+  end
+end

data/test/ogc/exceptions/request_error_exception_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module Ogc
+  module Exceptions
+    class RequestErrorExceptionTest < TestCase
+      test 'class inherits from OgcException' do
+        assert RequestErrorException < OgcException
+      end
+    end
+  end
+end

data/test/ogc/exceptions/request_failed_exception_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'minitest/mock'
+
+module Ogc
+  module Exceptions
+    class RequestFailedExceptionTest < TestCase
+      setup do
+        @mock = Minitest::Mock.new
+        @mock.expect :code, 666
+        @mock.expect :message, 'Hello Wolrd'
+      end
+
+      test 'class inherits from OgcException' do
+        assert RequestFailedException < OgcException
+      end
+
+      test 'constructor takes a HTTP error' do
+        ex = RequestFailedException.new(@mock)
+        assert 666, ex.code
+        assert 'Hello World', ex.message
+        @mock.verify
+      end
+    end
+  end
+end

data/test/ogc/exceptions_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module Ogc
+  class ExceptionsTest < TestCase
+    test 'Exceptions module is defined' do
+      refute_nil Exceptions
+    end
+  end
+end

data/test/ogc/query_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+require 'active_support/core_ext/object/to_query'
+
+module Ogc
+  class QueryTest < TestCase
+    using Query
+
+    setup do
+      @hash = {
+        'service' => 'wfs',
+        'srsname' => 'epsg:4326',
+        'version' => '1.0.0'
+      }
+      @query = @hash.to_query
+    end
+
+    test 'query method converts a query to hash' do
+      assert_equal @hash, Hash.from_query(@query)
+    end
+  end
+end

data/test/ogc/version_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module Ogc
+  class VersionTest < TestCase
+    SEMANTIV_VERSION_REGEX = /\A\d+\.\d+\.\d+(\.[a-z0-9]+)?\z/
+
+    test 'ogc version is defined' do
+      assert_kind_of String, VERSION
+    end
+
+    test 'ogc version respects semantic versions' do
+      assert_match SEMANTIV_VERSION_REGEX, VERSION
+    end
+  end
+end

data/test/ogc/web_feature_service/base_test.rb

@@ -0,0 +1,145 @@
+require 'test_helper'
+
+module Ogc
+  module WebFeatureService
+    class BaseTest < TestCase
+      include Exceptions
+      using CleanXML
+
+      URL         = 'http://localhost/wfs'
+      PARAMS      = { 'version' => '1.0.0', 'key' => 'ABCDE' }
+      FULL_PARAMS = PARAMS.merge(Base::DEFAULT_PARAMS)
+
+      # Fake exception
+      CalledBlockException = Class.new(StandardError)
+
+      setup do
+        @base = Base.new(URL, PARAMS)
+
+        # XML files
+        @request   = read_file('wfs/get_capabilities_request')
+        @response  = read_file('wfs/get_capabilities_response')
+        @exception = read_file('wfs/exception_report')
+
+        query = FULL_PARAMS.merge(request: :hello).to_query
+
+        # Get method returns xml response:
+        stub_request(:get, "#{URL}?#{query}").to_return(body: @response)
+
+        # Get method returns xml exception:
+        stub_request(:get, "#{URL}?ex=xml&#{query}")
+          .to_return(body: @exception)
+
+        # Get method returns Timeout exception:
+        stub_request(:get, "#{URL}?ex=timeout&#{query}")
+          .to_raise(Timeout::Error)
+
+        # Get method returns NotFound return:
+        stub_request(:get, "#{URL}?ex=notFound&#{query}")
+          .to_return(status: [404, 'Not Found'])
+
+        # Post method returns xml response:
+        stub_request(:post, "#{URL}").with(body: @request)
+          .to_return(body: @response)
+      end
+
+      test 'DEFAULT_PARAMS constant is frozen' do
+        assert Base::DEFAULT_PARAMS.frozen?
+      end
+
+      test 'request_name class method returns the name of the class' do
+        assert_equal 'Base', Base.request_name
+        assert_same Base.request_name, Base.request_name
+
+        FakeService = Class.new(Base)
+        assert_equal 'FakeService', FakeService.request_name
+      end
+
+      test 'constructor takes an url and some params as arguments' do
+        assert_equal URL, @base.url
+        refute_same PARAMS, @base.params
+        assert_equal FULL_PARAMS, @base.params
+      end
+
+      test 'constructor stringifies the keys of params' do
+        base = Base.new(URL, PARAMS.symbolize_keys)
+        assert_equal FULL_PARAMS, base.params
+      end
+
+      test 'http method exposes the http object' do
+        assert_instance_of Net::HTTP, @base.http
+      end
+
+      test 'get method returns xml response' do
+        xml = Nokogiri::XML(@response.clean_xml!).to_xml
+        assert_equal xml, @base.get(request: 'hello').to_xml
+      end
+
+      test 'get method takes a block to overload the request' do
+        assert_raises CalledBlockException do
+          @base.get(request: 'hello') do |_|
+            raise CalledBlockException
+          end
+        end
+      end
+
+      test 'get method takes a block which exposes the request' do
+        @base.get(request: :hello) do |request|
+          assert_instance_of Net::HTTP::Get, request
+        end
+      end
+
+      test 'post method returns xml response' do
+        xml = Nokogiri::XML(@response.clean_xml!).to_xml
+        assert_equal xml, @base.post(@request).to_xml
+      end
+
+      test 'post method takes a block to overload the request' do
+        assert_raises CalledBlockException do
+          @base.post(@request) do |_|
+            raise CalledBlockException
+          end
+        end
+      end
+
+      test 'post method takes a block which exposes the request' do
+        @base.post(@request) do |request|
+          assert_instance_of Net::HTTP::Post, request
+        end
+      end
+
+      test 'exception is raised if WFS returns exception' do
+        assert_raises ExceptionReport do
+          @base.get(request: :hello, ex: :xml)
+        end
+      end
+
+      test 'exception is raised if Timeout is raised' do
+        assert_raises RequestErrorException do
+          @base.get(request: :hello, ex: :timeout)
+        end
+      end
+
+      test 'exception raised has a cause' do
+        begin
+          @base.get(request: :hello, ex: :timeout)
+          assert false # In case where the exception is not raised.
+        rescue RequestErrorException => ex
+          assert_instance_of Timeout::Error, ex.cause
+        end
+      end
+
+      test 'request error raises RequestFailedException exception' do
+        assert_raises RequestFailedException do
+          @base.get(request: :hello, ex: :notFound)
+        end
+      end
+
+      test 'response is cached' do
+        assert_nil @base.response
+        @base.get(request: 'hello')
+        refute_nil @base.response
+      end
+    end
+  end
+end

data/test/ogc/web_feature_service/get_capabilities_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+module Ogc
+  module WebFeatureService
+    class GetCapabilitiesTest < TestCase
+      using CleanXML
+
+      URL         = 'http://localhost/wfs'
+      PARAMS      = { 'version' => '1.0.0', 'key' => 'ABCDE' }
+      FULL_PARAMS = PARAMS.merge(Base::DEFAULT_PARAMS)
+
+      setup do
+        @base = GetCapabilities.new(URL, PARAMS)
+
+        # XML files
+        @response = read_file('wfs/get_capabilities_response')
+
+        query = FULL_PARAMS.merge(request: GetCapabilities.request_name).to_query
+
+        # Get method returns xml response:
+        stub_request(:get, "#{URL}?#{query}").to_return(body: @response)
+      end
+
+      test 'class inherits from Base' do
+        assert GetCapabilities < Base
+      end
+
+      test 'get method returns xml response' do
+        xml = Nokogiri::XML(@response.clean_xml!).to_xml
+        assert_equal xml, @base.get.to_xml
+      end
+    end
+  end
+end