gis_scraper 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7418ca46fc872f0665cf06bb5becfbe72acd1ad2
+  data.tar.gz: e3d7888a862011049f123da0941726b1231b8565
+SHA512:
+  metadata.gz: d8e75fe1ac4c5a7f1a8712fb8fa1b9268b64dc79be61ed8d13f409ceb21d836b0f4f624e4119f3fb1aec4c31f9c4c302708a98f620ca9f434fac45e89215cf80
+  data.tar.gz: e35a53941f8e4788e655cff6806af3cf901748106f2f9620b6ce7951050b23ec1e3601249afb719390d95b97e013b411844230943081a1f5336de3d79a1f1a09

data/.gitignore

@@ -0,0 +1,2 @@
+**/.DS_Store
+

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.3
+  - rbx-2.9
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    gis_scraper (0.1.0.pre)
+      mechanize (~> 2.7)
+      parallel (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mechanize (2.7.3)
+      domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0)
+      mime-types (~> 2.0)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    mime-types (2.99)
+    mini_portile2 (2.0.0)
+    net-http-digest_auth (1.4)
+    net-http-persistent (2.9.4)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    ntlm-http (0.1.1)
+    parallel (1.6.1)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    webrobots (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  gis_scraper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.10.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruce Steedman
+
+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,22 @@
+# gis_scraper Ruby Gem
+[![Gem Version](https://badge.fury.io/rb/gis_scraper.svg)](http://badge.fury.io/rb/gis_scraper)
+[![Build status](https://secure.travis-ci.org/MatzFan/gis_scraper.svg)](http://travis-ci.org/MatzFan/gis_scraper)
+
+Utility to recursively scrape ArcGIS MapServer data using REST API.
+
+ArcGIS MapServer REST queries are limited to 1,000 objects in some cases. This tool makes repeated calls until all data for a given layer is extracted. It then merges the resulting JSON files into a single file. This allows GIS clients like QGIS to add a layer from a single file.
+
+**Usage**
+
+The executable is called 'gisget' and takes one required arg - a MapServer/Layer URL (ending in an integer representing the layer number). An optional file output path may also be specified. If omitted the file will be saved in current directory. Example:
+
+```
+gisget http://gps.digimap.gg/arcgis/rest/services/StatesOfJersey/JerseyMappingOL/MapServer/0 ~/Desktop
+```
+
+If the layer is type 'Feature Layer', a single file of JSON data will be saved (named the same as the layer). If the layer is type 'Group Layer', the sub-group structure is traversed recursively thus: Directories for each sub-group layer are created and JSON data files for each constituent feature layer written to them.
+
+**Specification and Tests**
+
+rspec spec
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gis_scraper'
+
+# 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/gisget

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+start = Time.now
+Layer.new(*ARGV).write
+puts "Finished in #{Time.now - start} seconds"

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/gis_scraper.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gis_scraper/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'gis_scraper'
+  s.version       = GisScraper::VERSION
+  s.authors       = ['Bruce Steedman']
+  s.email         = ['bruce.steedman@gmail.com']
+
+  s.summary       = %q{Scrapes ArcGIS data from MapServer REST API}
+  s.description   = %q{Scrapes ArcGIS data from MapServer REST API}
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+
+  s.add_runtime_dependency 'mechanize', '~> 2.7'
+  s.add_runtime_dependency 'parallel', '~> 1.6'
+end

data/lib/gis_scraper/feature_scraper.rb

@@ -0,0 +1,82 @@
+class JSONParser < Mechanize::File
+  attr_reader :json
+
+  def initialize(uri=nil, response=nil, body=nil, code=nil)
+    super(uri, response, body, code)
+    @json = JSON.parse(body)
+  end
+end
+
+class FeatureScraper
+
+  attr_reader :name
+
+  def initialize(url)
+    @url = url
+    @agent = Mechanize.new
+    @agent.pluggable_parser['text/plain'] = JSONParser
+    @layer = layer # hash
+    @name = name
+    @pk = pk
+    @max = max # maxRecordCount - usually 1000
+    @form = form
+    @loops = loops
+    @threads = GisScraper.config[:threads]
+  end
+
+  def json_data
+    data(0).merge({'features' => features(@threads)}).to_json
+  end
+
+  private
+
+  def layer
+    @agent.get(@url + '?f=pjson').json
+  end
+
+  def name
+    @layer['name']
+  end
+
+  def pk
+    @layer['fields'].select { |f| f['type'] == 'esriFieldTypeOID' }[0]['name']
+  end
+
+  def max
+    @layer['maxRecordCount'].to_i
+  end
+
+  def form
+    @agent.get(@url + '/query').forms.first
+  end
+
+  def count
+    set_query_params
+    @form.submit(@form.buttons[1]).json['count'].to_i
+  end
+
+  def set_query_params(loop_num = nil)
+    @form.fields[0].value = where_text(loop_num)
+    loop_num ? @form.radiobuttons[4].uncheck : @form.radiobuttons[4].check # count only true
+    @form.fields[6].value = '*'
+    @form.field_with(name: 'f').options[1].select # for JSON
+  end
+
+  def data(n)
+    set_query_params(n)
+    @form.submit(@form.buttons[1]).json
+  end
+
+  def features(t)
+    Parallel.map(0...@loops, in_threads: t) { |n| data(n)['features'] }.flatten
+  end
+
+  def loops
+    (count.to_f/@max).ceil
+  end
+
+  def where_text(n)
+    n ? "#{pk} > #{n * @max} AND #{pk} <= #{(n + 1) * @max}" : "#{pk} > 0"
+  end
+
+end

data/lib/gis_scraper/layer.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+
+class Layer
+
+  class JSONParser < Mechanize::File
+    attr_reader :json
+
+    def initialize(uri=nil, response=nil, body=nil, code=nil)
+      super(uri, response, body, code)
+      @json = JSON.parse(body)
+    end
+  end
+
+  class UnknownLayerType < StandardError; end
+
+  attr_reader :type, :id, :name
+
+  TYPES = ['Group Layer',
+           'Feature Layer',
+           'Annotation Layer',
+           'Annotation SubLayer']
+  QUERYABLE = ['Feature Layer', 'Annotation Layer']
+
+  def initialize(url, path = '.')
+    @url, @path = url, File.expand_path(path)
+    @ms_url = ms_url # map server url ending '../MapServer'
+    @id = id
+    @agent = Mechanize.new
+    @agent.pluggable_parser['text/plain'] = JSONParser
+    validate_url
+    @page_json = page_json
+    @type = type
+    @name = name
+  end
+
+  def write
+    QUERYABLE.any? { |l| @type == l } ? write_json_files : process_sub_layers
+  end
+
+  private
+
+  def ms_url
+    @url.split('/')[0..-2].join('/')
+  end
+
+  def id
+    @url.split('/').last
+  end
+
+  def validate_url
+    raise ArgumentError, 'URL must end with layer id' if  @id.to_i.to_s != @id
+    raise ArgumentError, 'Bad MapServer URL' if @ms_url[-9..-1] != 'MapServer'
+  end
+
+  def page_json
+    @agent.get(@url + '?f=pjson').json
+  end
+
+  def type
+    validate_type @page_json['type']
+  end
+
+  def name
+    replace_forwardslashes_with_underscores @page_json['name']
+  end
+
+  def validate_type(type)
+    raise UnknownLayerType, type unless (TYPES.any? { |t| t == type })
+    type
+  end
+
+  def sub_layer_id_names
+    @page_json['subLayers'] || []
+  end
+
+  def json_data(url)
+    FeatureScraper.new(url).json_data
+  end
+
+  def write_json_files
+    File.write "#{@path}/#{@name}.json", json_data("#{@ms_url}/#{@id}")
+  end
+
+  def process_sub_layers
+    sub_layer_id_names.each do |hash|
+      name, id = hash['name'], hash['id']
+      path = "#{@path}/#{name}"
+      recurse sub_layer(id, path), path
+    end
+  end
+
+  def recurse(layer, dir)
+    FileUtils.mkdir dir
+    layer.write
+  end
+
+  def sub_layer(id, path)
+    Layer.new "#{@ms_url}/#{id}", path
+  end
+
+  def replace_forwardslashes_with_underscores(string)
+    string.gsub /\//, '_'
+  end
+
+end

data/lib/gis_scraper/version.rb

@@ -0,0 +1,3 @@
+module GisScraper
+  VERSION = '0.1.0.pre'
+end

data/lib/gis_scraper.rb

@@ -0,0 +1,37 @@
+require 'gis_scraper/version'
+require 'gis_scraper/feature_scraper'
+require 'gis_scraper/layer'
+
+require 'yaml'
+require 'mechanize'
+require 'parallel'
+
+# stackoverflow.com/questions/6233124/where-to-place-access-config-file-in-gem
+module GisScraper
+
+  @config = {threads: 8} # threads used for scraping
+  @valid_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each { |k,v| @config[k.to_sym] = v if @valid_keys.include? k.to_sym }
+  end
+
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      puts "YAML configuration file couldn't be found. Using defaults"
+      return
+    rescue Psych::SyntaxError
+      puts 'YAML configuration file contains invalid syntax. Using defaults'
+      return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: gis_scraper
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Bruce Steedman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Scrapes ArcGIS data from MapServer REST API
+email:
+- bruce.steedman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gisget
+- bin/setup
+- gis_scraper.gemspec
+- lib/gis_scraper.rb
+- lib/gis_scraper/feature_scraper.rb
+- lib/gis_scraper/layer.rb
+- lib/gis_scraper/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Scrapes ArcGIS data from MapServer REST API
+test_files: []