arcserver.rb 0.1.4 → 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0580a4cf8a670d854075a114b3fcfeb5fccd5870
+  data.tar.gz: 0fb023619950781916f907879555b0644a666a0c
+SHA512:
+  metadata.gz: 986d032ccc0529bdb992a90668bdfd6abc321fbdfe3a30e7afabf357ccbf1a1d94893c777422b45353f5090a7a38f074bc8114a695dfbe2056667989c3a77b65
+  data.tar.gz: ef320fcb0ff7b3d10701ec603d6ba19574dfbbfefd386613d77a97314740b8807b4a4433ddb0703b5ab27cfafa9ccbf4cb85510edfb78c27fd35a0aa3b6d22c6

data/.gitignore

@@ -0,0 +1,10 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+doc
+.yardoc
+doc
+pkg
+nbproject
+.idea

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+platforms :rbx do
+  gem 'rubysl'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,274 @@
+PATH
+  remote: .
+  specs:
+    arcserver.rb (0.1.5)
+      activesupport
+      httparty
+      httpclient
+      json
+      nokogiri
+      rufus-scheduler
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    atomic (1.1.14)
+    atomic (1.1.14-java)
+    diff-lcs (1.2.5)
+    factory_girl (4.3.0)
+      activesupport (>= 3.0.0)
+    ffi2-generators (0.1.1)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    httpclient (2.3.4.1)
+    i18n (0.6.9)
+    json (1.8.1)
+    json (1.8.1-java)
+    mini_portile (0.5.2)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    nokogiri (1.6.1-java)
+      mini_portile (~> 0.5.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubysl (2.0.15)
+      rubysl-abbrev (~> 2.0)
+      rubysl-base64 (~> 2.0)
+      rubysl-benchmark (~> 2.0)
+      rubysl-bigdecimal (~> 2.0)
+      rubysl-cgi (~> 2.0)
+      rubysl-cgi-session (~> 2.0)
+      rubysl-cmath (~> 2.0)
+      rubysl-complex (~> 2.0)
+      rubysl-continuation (~> 2.0)
+      rubysl-coverage (~> 2.0)
+      rubysl-csv (~> 2.0)
+      rubysl-curses (~> 2.0)
+      rubysl-date (~> 2.0)
+      rubysl-delegate (~> 2.0)
+      rubysl-digest (~> 2.0)
+      rubysl-drb (~> 2.0)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-english (~> 2.0)
+      rubysl-enumerator (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-etc (~> 2.0)
+      rubysl-expect (~> 2.0)
+      rubysl-fcntl (~> 2.0)
+      rubysl-fiber (~> 2.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-find (~> 2.0)
+      rubysl-forwardable (~> 2.0)
+      rubysl-getoptlong (~> 2.0)
+      rubysl-gserver (~> 2.0)
+      rubysl-io-console (~> 2.0)
+      rubysl-io-nonblock (~> 2.0)
+      rubysl-io-wait (~> 2.0)
+      rubysl-ipaddr (~> 2.0)
+      rubysl-irb (~> 2.0)
+      rubysl-logger (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-matrix (~> 2.0)
+      rubysl-mkmf (~> 2.0)
+      rubysl-monitor (~> 2.0)
+      rubysl-mutex_m (~> 2.0)
+      rubysl-net-ftp (~> 2.0)
+      rubysl-net-http (~> 2.0)
+      rubysl-net-imap (~> 2.0)
+      rubysl-net-pop (~> 2.0)
+      rubysl-net-protocol (~> 2.0)
+      rubysl-net-smtp (~> 2.0)
+      rubysl-net-telnet (~> 2.0)
+      rubysl-nkf (~> 2.0)
+      rubysl-observer (~> 2.0)
+      rubysl-open-uri (~> 2.0)
+      rubysl-open3 (~> 2.0)
+      rubysl-openssl (~> 2.0)
+      rubysl-optparse (~> 2.0)
+      rubysl-ostruct (~> 2.0)
+      rubysl-pathname (~> 2.0)
+      rubysl-prettyprint (~> 2.0)
+      rubysl-prime (~> 2.0)
+      rubysl-profile (~> 2.0)
+      rubysl-profiler (~> 2.0)
+      rubysl-pstore (~> 2.0)
+      rubysl-pty (~> 2.0)
+      rubysl-rational (~> 2.0)
+      rubysl-readline (~> 2.0)
+      rubysl-resolv (~> 2.0)
+      rubysl-rexml (~> 2.0)
+      rubysl-rinda (~> 2.0)
+      rubysl-rss (~> 2.0)
+      rubysl-scanf (~> 2.0)
+      rubysl-securerandom (~> 2.0)
+      rubysl-set (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+      rubysl-singleton (~> 2.0)
+      rubysl-socket (~> 2.0)
+      rubysl-stringio (~> 2.0)
+      rubysl-strscan (~> 2.0)
+      rubysl-sync (~> 2.0)
+      rubysl-syslog (~> 2.0)
+      rubysl-tempfile (~> 2.0)
+      rubysl-thread (~> 2.0)
+      rubysl-thwait (~> 2.0)
+      rubysl-time (~> 2.0)
+      rubysl-timeout (~> 2.0)
+      rubysl-tmpdir (~> 2.0)
+      rubysl-tsort (~> 2.0)
+      rubysl-un (~> 2.0)
+      rubysl-uri (~> 2.0)
+      rubysl-weakref (~> 2.0)
+      rubysl-webrick (~> 2.0)
+      rubysl-xmlrpc (~> 2.0)
+      rubysl-yaml (~> 2.0)
+      rubysl-zlib (~> 2.0)
+    rubysl-abbrev (2.0.4)
+    rubysl-base64 (2.0.0)
+    rubysl-benchmark (2.0.1)
+    rubysl-bigdecimal (2.0.2)
+    rubysl-cgi (2.0.1)
+    rubysl-cgi-session (2.0.1)
+    rubysl-cmath (2.0.0)
+    rubysl-complex (2.0.0)
+    rubysl-continuation (2.0.0)
+    rubysl-coverage (2.0.3)
+    rubysl-csv (2.0.2)
+      rubysl-english (~> 2.0)
+    rubysl-curses (2.0.1)
+    rubysl-date (2.0.6)
+    rubysl-delegate (2.0.1)
+    rubysl-digest (2.0.3)
+    rubysl-drb (2.0.1)
+    rubysl-e2mmap (2.0.0)
+    rubysl-english (2.0.0)
+    rubysl-enumerator (2.0.0)
+    rubysl-erb (2.0.1)
+    rubysl-etc (2.0.3)
+      ffi2-generators (~> 0.1)
+    rubysl-expect (2.0.0)
+    rubysl-fcntl (2.0.4)
+      ffi2-generators (~> 0.1)
+    rubysl-fiber (2.0.0)
+    rubysl-fileutils (2.0.3)
+    rubysl-find (2.0.1)
+    rubysl-forwardable (2.0.1)
+    rubysl-getoptlong (2.0.0)
+    rubysl-gserver (2.0.0)
+      rubysl-socket (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-io-console (2.0.0)
+    rubysl-io-nonblock (2.0.0)
+    rubysl-io-wait (2.0.0)
+    rubysl-ipaddr (2.0.0)
+    rubysl-irb (2.0.4)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-readline (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-logger (2.0.0)
+    rubysl-mathn (2.0.0)
+    rubysl-matrix (2.1.0)
+      rubysl-e2mmap (~> 2.0)
+    rubysl-mkmf (2.0.1)
+      rubysl-fileutils (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+    rubysl-monitor (2.0.0)
+    rubysl-mutex_m (2.0.0)
+    rubysl-net-ftp (2.0.1)
+    rubysl-net-http (2.0.4)
+      rubysl-cgi (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-singleton (~> 2.0)
+    rubysl-net-imap (2.0.1)
+    rubysl-net-pop (2.0.1)
+    rubysl-net-protocol (2.0.1)
+    rubysl-net-smtp (2.0.1)
+    rubysl-net-telnet (2.0.0)
+    rubysl-nkf (2.0.1)
+    rubysl-observer (2.0.0)
+    rubysl-open-uri (2.0.0)
+    rubysl-open3 (2.0.0)
+    rubysl-openssl (2.1.0)
+    rubysl-optparse (2.0.1)
+      rubysl-shellwords (~> 2.0)
+    rubysl-ostruct (2.0.4)
+    rubysl-pathname (2.0.0)
+    rubysl-prettyprint (2.0.2)
+    rubysl-prime (2.0.1)
+    rubysl-profile (2.0.0)
+    rubysl-profiler (2.0.1)
+    rubysl-pstore (2.0.0)
+    rubysl-pty (2.0.2)
+    rubysl-rational (2.0.1)
+    rubysl-readline (2.0.2)
+    rubysl-resolv (2.1.0)
+    rubysl-rexml (2.0.2)
+    rubysl-rinda (2.0.1)
+    rubysl-rss (2.0.0)
+    rubysl-scanf (2.0.0)
+    rubysl-securerandom (2.0.0)
+    rubysl-set (2.0.1)
+    rubysl-shellwords (2.0.0)
+    rubysl-singleton (2.0.0)
+    rubysl-socket (2.0.1)
+    rubysl-stringio (2.0.0)
+    rubysl-strscan (2.0.0)
+    rubysl-sync (2.0.0)
+    rubysl-syslog (2.0.1)
+      ffi2-generators (~> 0.1)
+    rubysl-tempfile (2.0.1)
+    rubysl-thread (2.0.2)
+    rubysl-thwait (2.0.0)
+    rubysl-time (2.0.3)
+    rubysl-timeout (2.0.0)
+    rubysl-tmpdir (2.0.0)
+    rubysl-tsort (2.0.1)
+    rubysl-un (2.0.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-optparse (~> 2.0)
+    rubysl-uri (2.0.0)
+    rubysl-weakref (2.0.0)
+    rubysl-webrick (2.0.0)
+    rubysl-xmlrpc (2.0.0)
+    rubysl-yaml (2.0.4)
+    rubysl-zlib (2.0.1)
+    rufus-scheduler (3.0.3)
+      tzinfo
+    sdoc (0.3.20)
+      json (>= 1.1.3)
+      rdoc (~> 3.10)
+    thread_safe (0.1.3)
+      atomic
+    thread_safe (0.1.3-java)
+      atomic
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  arcserver.rb!
+  bundler
+  factory_girl
+  rake
+  rspec
+  rubysl
+  sdoc

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Colin Casey
-
-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.
+Copyright (c) 2009 Colin Casey
+
+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,160 @@
+# Arcserver.rb
+
+Arcserver.rb is an interface for interacting with ESRI ArcGIS Server  REST APIs from Ruby.
+
+[ArcGIS rest specification](http://www.esri.com/library/whitepapers/pdfs/geoservices-rest-spec.pdf)
+
+
+[![Build Status](https://travis-ci.org/lukefx/arcserver.rb.png?branch=master)](https://travis-ci.org/lukefx/arcserver.rb)
+[![Code Climate](https://codeclimate.com/github/lukefx/arcserver.rb.png)](https://codeclimate.com/github/lukefx/arcserver.rb)
+
+## Installation
+
+    [sudo] gem install arcserver.rb
+
+If you want to use it in with Bundler add to your Gemfile
+
+    gem 'arcserver.rb', '~> 0.1.5'
+
+## Quick Example
+
+```ruby
+require 'arcserver'
+```
+
+Connect to a map server instance using either its REST url
+
+```ruby
+map_server = ArcServer::MapServer.new('http://sampleserver1.arcgisonline.com/ArcGIS/services/Portland/ESRI_LandBase_WebMercator/MapServer')
+```
+
+and export an image
+
+```ruby
+puts map_server.export
+```
+
+Query for retreive some features, the result will be a FeatureSet, which is a wrapper for the layer information and the features found
+
+```ruby
+query = ArcServer::REST::Query.new({ where: "district='4'", outFields: "*" })
+feature_set = query.execute('0', "http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer")
+
+puts feature_set.features
+```
+
+Or directly within a MapServer or FeatureServer and his Layer number
+
+```ruby
+feature_server = ArcServer::FeatureServer.new("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer")
+feature_set = feature_server.query('0', { where: "district='Lugano'", outFields: "*" })
+```
+
+Query is possible in different ways, like through geometry
+
+```ruby
+feature_server = ArcServer::FeatureServer.new("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer")
+feature_set = feature_server.query('0', { geometryType: 'esriGeometryEnvelope', geometry: '{"xmin":997878.8354556253,"ymin":5783588.635939264,"xmax":998147.5593831083,"ymax":5783767.785224252,"spatialReference":{"wkid":102100}}', outFields: "*", inSR: 102100, outSR: 102100 })
+
+puts feature_set.features
+```
+
+An Identify operation is a query but applied to all layers in the MapServer
+
+```ruby
+map_server = ArcServer::MapServer.new("http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StateCityHighway_USA/MapServer")
+results = map_server.identify({ geometryType: "esriGeometryPoint", geometry: "-120,40", tolerance: "10", mapExtent: "-119,38,-121,41", imageDisplay: "400,300,96" })
+
+puts results # each results has its own feature and metadata
+```
+
+A feature is a simple class with Geometry and attributes, create one is easy
+
+```ruby
+f = ArcServer::Graphics::Feature.new({ geometry: { x: 997986.5006082746, y: 5783631.06234916, spatialReference: { wkid: 102100 }}, attributes: {status:1,req_id:"12345",req_type:"Graffiti Complaint – Private Property",req_date:"30.09.2013",req_time:"14:00",address:"via dei matti 0",district:"4"} })
+```
+
+Once you have a feature, it's ready to be saved on a feature layer
+
+```ruby
+fs = ArcServer::FeatureServer.new("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer")
+results = fs.applyEdits('0', [ f ], [], []) # adds, updates, deletes
+```
+
+You can simply edit a feature if you have an objectId, maybe retrieved with a Query
+
+```ruby
+f = ArcServer::Graphics::Feature.new({ attributes: { objectId: 12345, address: "via dei matti 0", district: "4"} })
+results = fs.applyEdits('0', [], [ f ], []) # adds, updates, deletes
+```
+
+And if you want to delete some features?
+
+```ruby
+feature_server = ArcServer::FeatureServer.new("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/SanFrancisco/311Incidents/FeatureServer")
+feature_set = feature_server.query('0', { geometryType: 'esriGeometryEnvelope', geometry: '{"xmin":997878.8354556253,"ymin":5783588.635939264,"xmax":998147.5593831083,"ymax":5783767.785224252,"spatialReference":{"wkid":102100}}', outFields: "*", inSR: 102100, outSR: 102100 })
+# we have to create an array of ids like this: '80012, 93002'
+deletes = feature_set.features.map { |f| f.attributes[:objectid] }.join(',')
+results = feature_server.applyEdits('0', [], [], deletes)
+```
+
+## GeoProcessing Tool
+
+Geoprocessing is a fundamental part of enterprise GIS operations. Geoprocessing provides the data analysis, data management, and data conversion tools necessary for all GIS users.
+
+The ArcGIS Server supports two types of GPServer: Sync and Async.
+
+The message in a bottle example, sync
+
+```ruby
+gp = ArcServer::GPServer.new("http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_Currents_World/GPServer/MessageInABottle")
+
+feature = ArcServer::Graphics::Feature.new({ geometry: ArcServer::Geometry::Point.new({ x: -76.2890625, y: 35.859375, spatialReference: { wkid: 4326 } }) })
+
+feature_set = ArcServer::Graphics::FeatureSet.new({ features: [ feature ] })
+
+params = { Input_Point: feature_set.to_json, Days: 1 }
+results =  gp.execute(params)
+
+puts results # => {"paramName"=>"Output", "dataType"=>"GPFeatureRecordSetLayer", "value"=>{"geometryType"=>"esriGeometryPolyline", "spatialReference"=>{"wkid"=>4326}, "features"=>[{"attributes"=>{"FID"=>1, "FNODE_"=>0, "Shape_Length"=>0.19891537566450523}, "geometry"=>{"paths"=>[[[-76.2890625, 35.859375], [-76.09141540527344, 35.88180160522461]]]}}], "exceededTransferLimit"=>false}}
+```
+
+Example for async service:
+
+```ruby
+gp = ArcServer::GPServer.new("http://sampleserver6.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task")
+
+params = { Web_Map_as_JSON: '{ ... super long map in json ... }', Format: 'JPG', Layout_Template: 'MAP_ONLY' }
+gp.submitJob(params) do |results|
+  puts results['Output_File']['url'] # => http://sampleserver6.arcgisonline.com ... /map.jpg
+end
+```
+
+## Contributors
+
+This is a fork of arcserver.rb originally written by:
+
+* Colin Casey
+* Glenn Goodrich
+
+## Contribute
+
+If you'd like to hack on arcserver.rb, start by forking my repo on GitHub:
+
+  http://github.com/lukefx/arcserver.rb
+
+To get all of the dependencies, install the gem first. The best way to get your changes merged back into core is as follows:
+
+1. Clone your fork
+2. Create a thoughtfully named topic branch to contain your change
+3. Hack away
+4. Add tests and make sure everything still passes by running rake
+5. If you are adding new functionality, document it in the README
+6. Do not change the version number, I will do that on my end
+7. If necessary, rebase your commits into logical chunks, without errors
+8. Push the branch up to GitHub
+9. Send me a pull request for your branch
+
+## Copyright
+
+Copyright (c) 2010 Colin Casey. See LICENSE for details.