ogc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b4a0d0329246bcf846876e206fdb9cfff55897e
+  data.tar.gz: 1328d76adc737a5eef0f7307571816a2cdfab737
+SHA512:
+  metadata.gz: 46337235bb4f7fcd81ddbcad19e535d09c89e17df875401ec5a5bee601cec975b38669d57aebba7472ca98bde0eae1e4a2dae35a25de2f2100cfaa7a4b607fd0
+  data.tar.gz: cbaf676f1fd2441deec67ea49e8b942f04e701450a9eb8bccd3ba24f229533f55441515dfca6b385a1c318f46c89c871ca3578f07bae27ab3ef171c843ff2b59

data/.gitignore

@@ -0,0 +1,18 @@
+# Bundler files
+/.bundle/
+/Gemfile.lock
+
+# YarDOC files
+/.yardoc
+/_yardoc/
+
+# Miscellaneous files
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# RBenv files
+.ruby-version
+.rbenv-gemsets
+.gems/*

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Documentation:
+  Enabled: false
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/AndOr:
+  EnforcedStyle: always
+
+Style/Encoding:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Metrics/LineLength:
+  Max: 82

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ogc.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Geoffrey ROGUELON
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Ogc
+[![Build Status](https://travis-ci.org/GRoguelon/ogc.svg?branch=master)](https://travis-ci.org/GRoguelon/ogc)
+[![Code Climate](https://codeclimate.com/github/GRoguelon/ogc/badges/gpa.svg)](https://codeclimate.com/github/GRoguelon/ogc)
+[![GitHub version](https://badge.fury.io/gh/groguelon%2Fogc.svg)](https://badge.fury.io/gh/groguelon%2Fogc)
+
+This gems allow you to make calls in using WFS or WPS protocol defined by OGC organization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ogc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ogc
+
+## Usage
+
+Currently the gem OGC handles only some Web Feature Service calls.
+
+To use it, you have two ways.
+
+Either, you use the shortcut method of `WebFeatureService`module:
+
+```ruby
+# GetCapabilities
+Ogc::WebFeatureService.get_capabilities('http://localhost/wfs', version: '1.0.0', key: 'SECRET')
+#=> #<Ogc::WebFeatureService::GetCapabilities:0x007ffba414adc8 @url="http://localhost/wfs", @params={"version"=>"1.0.0", "key"=>"SECRET", "service"=>"wfs"}>
+
+# GetFeature
+Ogc::WebFeatureService.get_feature('http://localhost/wfs', version: '1.0.0', key: 'SECRET')
+#=> #<Ogc::WebFeatureService::GetFeature:0x007ffba41ad720 @url="http://localhost/wfs", @params={"version"=>"1.0.0", "key"=>"SECRET", "service"=>"wfs"}>
+```
+
+Or use the class directly:
+
+```ruby
+# GetCapabilities
+Ogc::WebFeatureService::GetCapabilies.new('http://localhost/wfs', version: '1.0.0', key: 'SECRET')
+#=> #<Ogc::WebFeatureService::GetCapabilities:0x007ffba414adc8 @url="http://localhost/wfs", @params={"version"=>"1.0.0", "key"=>"SECRET", "service"=>"wfs"}>
+
+# GetFeature
+Ogc::WebFeatureService::GetFeature.new('http://localhost/wfs', version: '1.0.0', key: 'SECRET')
+#=> #<Ogc::WebFeatureService::GetFeature:0x007ffba41ad720 @url="http://localhost/wfs", @params={"version"=>"1.0.0", "key"=>"SECRET", "service"=>"wfs"}>
+```
+
+After that, you can use the methods `#get` and `#post` to resquest the endpoint.
+
+```ruby
+ogc = Ogc::WebFeatureService::GetFeature.new('http://localhost/wfs', version: '1.0.0', key: 'SECRET')
+ogc.get(:FEATURE_1, filter '…')
+#=> Nokogiri::XML::Document
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ogc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ogc'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ogc.rb

@@ -0,0 +1,9 @@
+module Ogc; end
+
+# Refinements:
+require 'ogc/clean_xml'
+require 'ogc/query'
+
+require 'ogc/exceptions'
+require 'ogc/version'
+require 'ogc/web_feature_service'

data/lib/ogc/clean_xml.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/string/filters'
+
+module Ogc
+  module CleanXML
+    refine String do
+      def clean_xml!
+        self.gsub!(/>\n+ *\t*</, '><')
+        self.squish!
+        self
+      end
+    end
+  end
+end

data/lib/ogc/exceptions.rb

@@ -0,0 +1,8 @@
+module Ogc
+  module Exceptions; end
+end
+
+require 'ogc/exceptions/ogc_exception'
+require 'ogc/exceptions/exception_report'
+require 'ogc/exceptions/request_error_exception'
+require 'ogc/exceptions/request_failed_exception'

data/lib/ogc/exceptions/exception_report.rb

@@ -0,0 +1,44 @@
+require 'ogc/exceptions/ogc_exception'
+
+module Ogc
+  module Exceptions
+    class ExceptionReport < OgcException
+      ROOTS = %w( ServiceExceptionReport ExceptionReport ).freeze
+
+      attr_reader :report
+
+      class << self
+        def exception?(report)
+          ROOTS.include?(report.root.name)
+        end
+      end
+
+      def initialize(report)
+        raise ArgumentError unless self.class.exception?(report)
+        @report = report
+        super(first_exception_message)
+      end
+
+      def at_xpath(xpath)
+        @report.at_xpath(xpath)
+      end
+
+      def xpath(xpath)
+        @report.xpath(xpath)
+      end
+
+      def version
+        xpath = @report.at_xpath('/*/@version')
+        xpath ? xpath.text : nil
+      end
+
+    private
+
+      def first_exception_message
+        message   = @report.at_xpath('//xmlns:ServiceException')
+        message ||= @report.at_xpath('//xmlns:ExceptionText')
+        message && message.content
+      end
+    end
+  end
+end

data/lib/ogc/exceptions/ogc_exception.rb

@@ -0,0 +1,5 @@
+module Ogc
+  module Exceptions
+    class OgcException < StandardError; end
+  end
+end

data/lib/ogc/exceptions/request_error_exception.rb

@@ -0,0 +1,7 @@
+require 'ogc/exceptions/ogc_exception'
+
+module Ogc
+  module Exceptions
+    class RequestErrorException < OgcException; end
+  end
+end

data/lib/ogc/exceptions/request_failed_exception.rb

@@ -0,0 +1,12 @@
+module Ogc
+  module Exceptions
+    class RequestFailedException < OgcException
+      attr_reader :code
+
+      def initialize(http_error)
+        super(http_error.message)
+        @code = http_error.code
+      end
+    end
+  end
+end

data/lib/ogc/query.rb

@@ -0,0 +1,11 @@
+require 'uri'
+
+module Ogc
+  module Query
+    refine Hash.singleton_class do
+      def from_query(query)
+        Hash[URI.decode_www_form(query.to_s)]
+      end
+    end
+  end
+end

data/lib/ogc/version.rb

@@ -0,0 +1,3 @@
+module Ogc
+  VERSION = '0.1.0'
+end

data/lib/ogc/web_feature_service.rb

@@ -0,0 +1,19 @@
+require 'ogc/web_feature_service/base'
+require 'ogc/web_feature_service/get_capabilities'
+require 'ogc/web_feature_service/get_feature'
+
+require 'active_support/core_ext/string/inflections'
+
+module Ogc
+  module WebFeatureService
+    SUPPORTED_METHODS = %i( get_capabilities get_feature ).freeze
+
+    class << self
+      SUPPORTED_METHODS.each do |method|
+        define_method(method) do |*args|
+          "#{self}::#{method.to_s.camelize}".constantize.new(*args)
+        end
+      end
+    end
+  end
+end

data/lib/ogc/web_feature_service/base.rb

@@ -0,0 +1,95 @@
+require 'ogc/exceptions'
+
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/to_query'
+require 'active_support/core_ext/string/inflections'
+require 'nokogiri'
+
+module Ogc
+  module WebFeatureService
+    class Base
+      include Exceptions
+
+      using CleanXML
+      using Query
+
+      attr_reader :params, :response, :url
+
+      DEFAULT_PARAMS = { 'service' => 'wfs' }.freeze
+
+      class << self
+        def request_name
+          @request_name ||= to_s.demodulize
+        end
+      end
+
+      def initialize(url, params = {})
+        @url    = url
+        @params = params.stringify_keys!.merge(DEFAULT_PARAMS)
+      end
+
+      def get(extra_params, &block)
+        fetch(:get, extra_params ? extra_params.merge(@params) : @params, &block)
+      end
+
+      def post(body, &block)
+        fetch(:post, body.respond_to?(:to_xml) ? body.to_xml : body, &block)
+      end
+
+      def http
+        @http ||= Net::HTTP.new(uri.host, uri.port)
+      end
+
+    private
+
+      def fetch(type, content, &block)
+        request = request(type, content)
+        block.call(request) if block
+        handle_response(request)
+      end
+
+      def handle_response(request)
+        case (response = http.request(request))
+        when Net::HTTPSuccess
+          @response = Nokogiri::XML(response.body.clean_xml!).tap do |xml|
+            # rubocop:disable Style/RaiseArgs
+            raise ExceptionReport.new(xml) if ExceptionReport.exception?(xml)
+            # rubocop:enable Style/RaiseArgs
+          end
+        else
+          # rubocop:disable Style/RaiseArgs
+          raise RequestFailedException.new(response)
+          # rubocop:enable Style/RaiseArgs
+        end
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+             Net::ProtocolError
+        raise RequestErrorException
+      end
+
+      def request(type, content)
+        case type
+        when :get then Net::HTTP::Get.new(uri_with_params(content))
+        when :post
+          Net::HTTP::Post.new(uri_without_params).tap do |req|
+            req.body = content
+          end
+        end
+      end
+
+      def uri_with_params(extra_params)
+        return uri_without_params if extra_params.blank?
+
+        uri_without_params.dup.tap do |uri|
+          uri.query = Hash.from_query(uri.query).merge!(extra_params).to_query
+        end
+      end
+
+      def uri_without_params
+        @uri ||= URI(@url)
+      end
+      alias_method :uri, :uri_without_params
+    end
+  end
+end