arcgis 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb19680c0b9305d014b4ba531b316cee6448b754
+  data.tar.gz: c2196e8f2d6aea46643267433c28e7612ef27262
+SHA512:
+  metadata.gz: faff1e282f34001b2604cbca4dec2ef257cf15990e0d053ecd6fa4e3f14e0ccc8471954599ddd77dc2f68e1ce88af9ca068311963f05d23044cfc3b5022039ef
+  data.tar.gz: 7d8d32cce9c5dcf15a9493a82faa3e225c5c6ad6a57becfb51cc225c06f5a94371a8629b8ea19663a0c397e51d30dc2bb4046701aef4fbc372b5393a6b56d211

data/LICENSE.txt

@@ -0,0 +1,48 @@
+Apache License – 2.0
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+1.	You must give any other recipients of the Work or Derivative Works a copy of this License; and
+2.	You must cause any modified files to carry prominent notices stating that You changed the files; and
+3.	You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+4.	If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,78 @@
+# ArcGIS Online Ruby Library
+
+This library is a simple wrapper around the ArcGIS API's for GeoServices and ArcGIS Online using the sharing API.
+
+The library currently just exposes the service endpoints and accepts unverified hashes of input parameters as specified in the [ArcGIS API](http://www.arcgis.com/apidocs/rest/). As it evolves more endpoints will be added as well as more Ruby-like objects for the various API capabilities.
+
+
+
+## Instructions
+
+```ruby
+# Create a client
+@online = Arcgis::Online.new(:host => "http://www.arcgis.com/sharing/rest/")
+# Do an unauthenticated search
+results = @online.search(:q => "weather", :itemtype => "Web Map")
+
+# For features with permissions, first log in
+@online.login(:username => @username, :password => @password)
+
+# Create an item
+response = @online.item_add( :title => "Weather Station Temperatures",
+                  :type => "CSV",
+                  :file => File.open("my_data.csv"),
+                  :tags  => %w{temperature stations}.join(","))
+
+@id = response["id"]
+puts "This item has #{response['numComments']} comments."
+
+# Publish as a feature service
+analysis = @online.item_analyze(:id => @id, :type => "CSV")
+publish = @online.item_publish(:id => @id,
+                               :filetype => "Feature Service",
+                               :publishParameters => analysis["publishParameters"].to_json)
+
+puts "Feature Service URL: " + publish["services"].first["serviceurl"]
+
+# Clean up
+@online.item_delete(:items => [@id, publish["services"].first["serviceItemId"]])
+```
+
+### Testing
+
+arcgis-ruby uses RSpec for tests. First copy @config.yml.example@ to @config.yml@ and modify the username and password. Then from the command line run:
+
+    $ rspec
+
+If your arcgis online user is a public user, i.e. not allowed to create groups or publish items, then run:
+
+    $ rspec --tag ~@privileged 
+
+This will skip tests that require publisher access.
+
+
+## Requirements
+
+* Ruby
+
+## Resources
+
+* [ArcGIS Portal API](http://www.arcgis.com/apidocs/rest/)
+
+## Licensing
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [license.txt](./license.txt) file.
+
+[](Esri Tags: ArcGIS Ruby API AGOL Public)
+[](Esri Language: Ruby)

data/lib/arcgis.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/arcgis/base'
+require File.dirname(__FILE__) + '/arcgis/configurable'
+require File.dirname(__FILE__) + '/arcgis/online'
+require File.dirname(__FILE__) + '/contrib/multipart'

data/lib/arcgis/base.rb

@@ -0,0 +1,29 @@
+module Arcgis
+  module Base
+    def self.included(base)
+      base.extend ClassMethods
+    end
+      
+    module ClassMethods
+      # Factory for building API endpoints from Definitions
+      def extend_api(api,definition)
+        definition.each do |parent,ops|
+          ops.each do |op,methods|
+            methods.each do |method|
+              # build the method, but allow for 'root' level methods with the parent 
+              # (e.g. /community/user = user_community; /community/user/update = user_update)
+              subapi = method.length == 0 ? parent.to_s : method
+              define_method("#{api}_#{subapi}".gsub(/_$/,'')) { |options| 
+                # differentiate 'items' for /content/ from '' for /community/ - e.g. content/users/id vs. community/users/id
+                url = "#{self.send(parent.to_s+'_url')}#{self.send(api.to_s+'_url')}#{options.delete(:id)}/#{method.gsub(/items/,'')}"
+                url.gsub!(/\/+/, '/')
+                url.gsub!(/community\/community/,'community')
+                self.send(op,url,options) 
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arcgis/client.rb

@@ -0,0 +1,8 @@
+module Arcgis
+  class Client
+    include Arcgis::Configurable
+
+
+
+  end
+end

data/lib/arcgis/configurable.rb

@@ -0,0 +1,22 @@
+module Arcgis
+  module Configurable
+    attr_accessor :host, :username, :password, :token, :debug
+    class << self
+      # TODO: include defaults? - ajturner
+      def keys
+        @keys ||= [
+          :host,
+          :username,
+          :password,
+          :token,
+          :debug
+        ]
+      end
+    end
+
+    def configure
+      yield self
+      self
+    end
+  end
+end

data/lib/arcgis/online.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__)  + '/../arcgis/base'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/community'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/item'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/search'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/user'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/group'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/features'
+require File.dirname(__FILE__)  + '/../arcgis/sharing/comment'
+require File.dirname(__FILE__)  + '/../arcgis/portal/portal'
+require 'json'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'date'
+module Arcgis
+  class Online
+    include Arcgis::Base
+    include Arcgis::Sharing::Community
+    include Arcgis::Sharing::Item
+    include Arcgis::Sharing::Search
+    include Arcgis::Sharing::User
+    include Arcgis::Sharing::Group
+    include Arcgis::Sharing::Features
+    include Arcgis::Sharing::Comment
+    include Arcgis::Portal
+    include Arcgis::Configurable
+
+    class ErrorResponse < RuntimeError
+      attr_accessor :response
+      def initialize(response={})
+        message = response["message"] || response[:message] || response[:code] || response.inspect
+        message += response["details"].join("\n") if response["details"]
+        super(message)
+        @response = response
+      end
+    end
+
+    
+    def initialize(options={})
+      update_configuration(options)
+    end
+
+    # The root path or url in the service
+    def root_url
+      "" #host included in #get and #post
+    end
+
+    def client
+      @client = Arcgis::Client.new(options) unless defined?(@client) && @client.hash == options.hash        
+      @client
+    end
+           
+    attr_accessor :token, :token_expires
+    # username, password, referrer
+    def login(options={})
+      update_configuration(options)
+      @token = nil if (@token_expires && @token_expires < DateTime.now)
+      if(@token.nil?)
+        user = post("/generateToken", {:secure => true, :username => @username, :password => @password,
+                               :referer => "http://arcgis.com"}.merge(options))
+        @token = user["token"]
+        @token_expires = DateTime.strptime((user["expires"]/1000).to_s, "%s")
+      end
+    end
+    def logout
+      @token = nil
+      @token_expires = nil
+    end
+    
+    def get(path,options={})
+      path.gsub!(/%username%/,@username || "")
+      uri = URI.parse(@host + path)
+      uri.query = URI.encode_www_form({:f => "json",
+                             :token => @token}.merge(options))
+
+      return handle_response(Net::HTTP.get_response(uri))
+    end
+
+    def post(path, options={})
+      secure = options.delete(:secure) || false
+      path.gsub!(/%username%/,@username || "")
+      uri = URI.parse(@host + path)
+      http = Net::HTTP.new(uri.host, secure ? 443 : uri.port)
+      if(secure)
+        http.use_ssl = true
+        # http.ssl_version = :SSLv3
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      params = {:f => "json", :token => @token}.merge(options)
+      request.set_multipart_form_data(params)
+      
+      return handle_response(http.request(request))
+    end
+
+    private
+    # TODO: Add defaults for this? - ajturner
+    def update_configuration(options={})
+      Arcgis::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key]) if options.include?(key)
+      end
+    end
+
+    def handle_response(res) 
+      if res.is_a?(Net::HTTPSuccess)
+        unless res.nil? or res.body.nil? or res.body == 'null'
+          response = JSON.parse(res.body) 
+          raise ErrorResponse.new(response["error"]) if response["error"]
+          return response
+        else
+          nil
+        end
+      else
+        throw res.status
+      end
+    end
+  end
+end

data/lib/arcgis/portal/portal.rb

@@ -0,0 +1,14 @@
+module Arcgis
+  module Portal
+    # API Docs: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Portal_Self/02r3000001m7000000/
+    # http://dcdev.maps.arcgis.com/sharing/rest/portals/self
+    include Arcgis::Base
+    def portal_url
+      "portals/"
+    end
+    
+    def organization(options = {})
+      get("#{portal_url}/self",options)
+    end
+  end
+end

data/lib/arcgis/sharing/comment.rb

@@ -0,0 +1,36 @@
+module Arcgis
+  module Sharing
+    module Comment
+      include Arcgis::Base
+      # API Docs: http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#/Item_Comments/02r300000088000000/
+      def comment_url
+        "comments/"
+      end
+
+      # TODO is this better as a const or a method? - ajturner
+      GROUP_METHODS = {
+        :content => {
+          :get => [""],
+          :post => ["update","delete"]
+        },
+        :community => {}
+      }
+
+      extend_api(self.name.split("::").last.downcase,GROUP_METHODS)
+
+      # Helper function for finding a group
+      def comment(options)
+        get("/content/items/#{options.delete(:item)}/comments/#{options[:id]}",options)
+      end
+
+      def comment_update(options)
+        post("/content/items/#{options.delete(:item)}/comments/#{options[:id]}/update",options)
+      end
+
+      def comment_delete(options)
+        post("/content/items/#{options.delete(:item)}/comments/#{options[:id]}/delete",options)
+      end
+
+    end
+  end
+end

data/lib/arcgis/sharing/community.rb

@@ -0,0 +1,24 @@
+module Arcgis
+  module Sharing
+    module Community
+      include Arcgis::Base
+      # API Docs: http://www.arcgis.com/apidocs/rest/community.html
+      def community_url
+        root_url + "community/"
+      end
+      def content_url
+        root_url + "content/"
+      end
+      
+      COMMUNITY_METHODS = {
+        :community => {
+          :get => ["users", "groups"],
+          :post => ["createGroup"]
+        }
+      }
+
+      extend_api("community", COMMUNITY_METHODS)
+
+    end
+  end
+end

data/lib/arcgis/sharing/features.rb

@@ -0,0 +1,19 @@
+module Arcgis
+  module Sharing
+    module Features
+      include Arcgis::Base
+      # API Docs: http://devext.arcgis.com/apidocs/rest/features.html
+      def features_url
+        "features/"
+      end
+      
+      FEATURES_METHODS = {
+        :content => {
+          :post => ["analyze", "generate"]
+        }
+      }
+      
+      extend_api(self.name.split("::").last.downcase,FEATURES_METHODS)
+    end
+  end
+end

data/lib/arcgis/sharing/group.rb

@@ -0,0 +1,30 @@
+module Arcgis
+  module Sharing
+    module Group
+      include Arcgis::Base
+      # API Docs: http://www.arcgis.com/apidocs/rest/group.html
+      def group_url
+        "groups/"
+      end
+      
+      # TODO is this better as a const or a method? - ajturner
+      GROUP_METHODS = {
+        :content => {
+          :get => ["", "items"]
+        },
+        :community => {
+          :post => %w{update reassign delete join invite leave removeUsers },
+          :get => ["", "users", "applications"]
+        }
+      }
+      
+      extend_api(self.name.split("::").last.downcase,GROUP_METHODS)
+      
+      # Helper function for finding a group
+      def group(options)
+        group_community(options)
+      end
+      
+    end
+  end
+end

data/lib/arcgis/sharing/item.rb

@@ -0,0 +1,127 @@
+module Arcgis
+  module Sharing
+    # API Docs: http://www.arcgis.com/apidocs/rest/item.html
+    module Item
+      MAX_SERVICENAME_LIMIT = 80
+
+      include Arcgis::Base
+      def item_url
+        "items/"
+      end
+
+      # Methods:
+      # <item-url> GET comments rating relatedItems
+      # <item-url> POST addComment addRating deleteRating
+      ITEM_METHODS = {
+        :content => {
+          :get => ["", "comments", "rating", "relatedItems", "data","groups"],
+          :post => %w{addRelationship deleteRelationship addItem addComment addRating deleteRating share unshare}
+        }
+      }
+
+      extend_api(self.name.split("::").last.downcase,ITEM_METHODS)
+
+      # Helper function for loading an item
+      def item(options)
+        item_content(options)
+      end
+
+      # http://www.arcgis.com/sharing/rest/content/items/{id}?f=json
+      # def initialize(options)
+      #   options.each do |k,v|
+      #     self[k] = v
+      #   end
+      # end
+
+      # def item(options)
+      #   item = get("/content/items/#{options[:id]}")
+      #   # return Item.new(item)
+      # end
+      #
+      # def item_groups(options={})
+      #   get("/content/items/#{item["id"]}/groups",)
+      # end
+      # # http://www.arcgis.com/apidocs/rest/itemshareitem.html
+ #      # options
+ #      #   everyone <boolean>
+ #      #   org <boolean>
+ #      #   groups <array>
+ #      def item_share(options={})
+ #        options[:groups] = options.delete(:groups).join(",") if options.include?(:groups) && options.is_a?(Array)
+ #        post("/content/items/#{item["id"]}/share",options)
+ #      end
+ #
+ #      # http://www.arcgis.com/apidocs/rest/itemunshareitem.html
+ #      def item_unshare(options={})
+ #        options[:groups] = options.delete(:groups).join(",") if options.include?(:groups) && options.is_a?(Array)
+ #        post("/content/items/#{item["id"]}/unshare",options)
+ #      end
+
+
+       #
+       # USER CONTENT
+       #
+
+      # Register a new item in ArcGIS Online
+      #
+      # username is optional. If included it will be added to that user.
+      #  Otherwise it will use the username of the login credentials
+      def item_add(options={})
+        options = options.dup
+        username = options.delete(:username) || "%username%"
+        options[:file] = File.open(options.delete[:file]) if options.include?(:file) && options[:file].is_a?(String)
+        post("/content/users/#{username}/addItem",options)
+      end
+
+      # Delete an item from ArcGIS Online
+      #
+      # options
+      #   items array of item id's
+      # Returns {"error"=>{"code"=>400, "messageCode"=>"CONT_0001", "message"=>"Item '8960a63b2f1443f9a0a07922fc4bffec' does not exist or is inaccessible.", "details"=>[]}}
+      def item_delete(options={})
+        options = options.dup
+        username = options.delete(:username) || "%username%"
+        post("/content/users/#{username}/deleteItems",{:items => options[:items].join(",")})
+      end
+
+
+
+      def item_update(options={})
+        options = options.dup
+        id = options.delete(:id)
+        item = get("/content/items/#{id}")
+        item = post("/content/users/#{item["owner"]}/items/#{item["id"]}/update",options)
+      end
+
+      # http://www.arcgis.com/apidocs/rest/itemunshareitem.html
+      #
+      # itemId
+      # filetype serviceDefinition | shapefile | csv | Tile Package | Feature Service
+      # publishParameters
+      # outputType
+      #
+      # name (required)
+      def item_publish(options={})
+        options = options.dup
+        options[:itemId] = options.delete(:id) unless options.include?(:itemId)
+        post("/content/users/#{username}/publish",options)
+      end
+
+      # Analyze returns information about an item including the fields present as well as sample records.
+      # http://www.arcgis.com/apidocs/rest/analyze.html
+      #
+      # id - id of the item
+      # type shapefile | csv
+      # file
+      # text
+      #
+      def item_analyze(options={})
+        options = options.dup
+        options[:itemId] = options.delete(:id) unless options.include?(:itemId)
+        response = post("/content/features/analyze",options)
+        response["publishParameters"]["name"] = response["publishParameters"]["name"][0..MAX_SERVICENAME_LIMIT] if response["publishParameters"]["name"].length > MAX_SERVICENAME_LIMIT
+        response
+      end
+    end
+  end
+end

data/lib/arcgis/sharing/search.rb

@@ -0,0 +1,71 @@
+require 'uri'
+module Arcgis
+  module Sharing
+    module Search
+      include Arcgis
+      
+      # q  Description: The query string to search with. 
+# 
+#       Example: q=relands+map
+#       bbox  
+#       Description: The bounding box for a spatial search and is defined as minx, miny, maxx, maxy. Search requires q, bbox or both.
+# 
+#       Spatial search is an overlaps/intersects function of the query bbox and the extent of the document.
+# 
+#       Documents that have no extent (e.g., mxds, 3dds, lyr) will not be found when doing a bbox search.
+# 
+#       Document extent is assumed to be in the WGS84 geographic coordinate system.
+# 
+#       Example: bbox=-118,32,-116,34
+# 
+#       start  Description: The number of the first entry in the result set response. The index number is 1-based. 
+# 
+#       The default value of start is 1. (i.e. the first search result) 
+# 
+#       The start parameter, along with the num parameter can be used to paginate the search results. 
+# 
+#       Example: start=11 (return result #11 as the first entry in the response)
+#       num  Description: The maximum number of results to be included in the result set response. 
+# 
+#       The default value is 10 and the maximum allowed value is 100 
+# 
+#       The start parameter, along with the num parameter can be used to paginate the search results. 
+# 
+#       Note that the actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num. 
+# 
+#       Example: num=50 (return a max of 50 results in the response)
+#       sortField  Description: Field to sort by. You can also sort by multiple fields for an item, comma separated.
+#       The allowed sort field names are title, created, type, owner, avgRating, numRatings, numComments and numViews.
+      # sortOrder Values: asc | desc
+
+        # q only:
+#       id  Id of the item, for example, id: 4e770315ad9049e7950b552aa1e40869 returns the item for that id.
+# itemtype  Item type is either URL, Text, or File. See Item Types for a listing of the different types. This field is pre-defined. For example, itemtype:file return items of the type file.
+# owner  Owner of the item, for example, owner:esri returns all content published by Esri.
+# created  Created is the date created, for example created: [0000001249084800000 TO 0000001249548000000] finds all items published between August 1, 2009, 12:00AM to August 6, 2009 08:40AM.
+# title  Item title, for example, title:"Southern California" returns items with Southern California in the title.
+# type  Type returns the type of item and is a pre-defined field. See Item Types for a listing of the different types. For example, type:map returns items with map as the type, such as map documents and map services.
+# typekeywords  Type keywords, for example, typekeywords:tool returns items with the tool type keyword such as Network Analysis or Geoprocessing services. See Item Types for a listing of the different types.
+# description  Item description, for example, description:California finds all items with the term California in the description.
+# tags  The tag field, for example, tags:"San Francisco" returns items tagged with the term San Francisco.
+# snippet  Snippet or summary of the item, for example, snippet:"natural resources" returns items with natural resources in the snippet.
+# extent  The bounding rectangle of the item. For example, extent: [-114.3458, 21.7518] - [-73.125, 44.0658] returns items within that extent.
+# spatialreference  Spatial reference, for example, spatialreference:102100 returns items in the Web Mercator Auxiliary Sphere projection.
+# accessinformaton  Accessinformaton, for example, accessinformation:esri returns items with esri as the source credit.
+# access  The access field, for example, access:public returns public items. This field is pre-defined and the options are public, private or shared. You will only see private or shared items that you have access to.
+# group  The id of the group, for example, group:1652a410f59c4d8f98fb87b25e0a2669 returns items within the given group.
+# numratings  Number of Ratings, for example, numratings:6 returns items with six ratings.
+# numcomments  Number of comments, for example, numcomments:[1 TO 3] returns items that have one to three comments.
+# avgrating  Average rating, for example, avgrating:3.5 returns items with 3.5 as the average rating.
+# culture  Culture, for example, culture:en-US, returns the locale of the item. The search engine treats the two parts of the culture code as two different terms and searches for individual languages can be done. For example, culture:en returns all records that have an 'en' in their culture code. There may be overlaps between the codes used for language and the codes used for country, for instance fr-FR, but if the client needs to target a code with this problem they can pass in the complete code.
+      SEARCH_OPTIONS = %w{q bbox start num sortField sortOrder}
+      SEARCH_FIELDS = %w{id itemtype owner created title type typekeywords description tags snippet extent spatialreference accessinformation access group numratings numcomments avgrating culture}
+      def search(options)
+        options = options.inject({}) {|hash,(k,v)| hash[k.to_s] = v; hash}
+        options['q'] = (SEARCH_FIELDS.collect {|s| "#{s}:#{'"'+options.delete(s)+'"'}" if options.keys.include?(s) } + [options['q']]).compact.join(" AND ")
+        # results["results"] = results["results"].collect { |r| Arcgis::Sharing::Item.new(r) }
+        get("/search",options)
+      end
+    end
+  end
+end

data/lib/arcgis/sharing/user.rb

@@ -0,0 +1,74 @@
+module Arcgis
+  module Sharing
+    # API Docs: http://www.arcgis.com/apidocs/rest/user.html
+    module User
+      include Arcgis::Base
+
+      def user_url
+        "users/"
+      end
+
+      # TODO add SubResource methods for Invitations, Notifications
+      # TODO is this better as a const or a method? - ajturner
+      USER_METHODS = {
+        :content => {
+          :get => ["items", ""],
+          :post => ["deleteItems", "addRelationship", "deleteRelationship", 
+            "publishItem", "exportItem", "shareItems", "unshareItems", "moveItems", "deleteItems"]
+        },
+        :community => {
+          :get => ["", "notifications","tags","invitations"],
+          :post => %w{update delete}
+        }
+      }
+
+      extend_api(self.name.split("::").last.downcase,USER_METHODS)
+
+      # simple placeholder for getting users.
+      def user(options)
+        user_community(options)
+      end
+
+      def user_createFolder(options)
+        username = options.delete(:username) || "%username%"
+        post("content/users/#{username}/createFolder",options)
+      end
+
+      def user_deleteFolder(options)
+        username = options.delete(:username) || "%username%"
+        post("content/users/#{username}/#{options[:id]}/delete",options)
+      end
+      # # http://www.arcgis.com/apidocs/rest/usersearch.html
+      # # http://www.arcgis.com/apidocs/rest/commonparams.html#commonparameters
+      # def user_search(options = {})
+      #   get("/community/users",options)
+      # end
+      #
+      # def user(options = {})
+      #   get("/community/users/#{options[:user]}")
+      # end
+      #
+      # # http://www.arcgis.com/apidocs/rest/updateuser.html
+      # # Parameters:
+      # #  - http://www.arcgis.com/apidocs/rest/commonparams.html#commonparameters
+      # #  - http://www.arcgis.com/apidocs/rest/commonparams.html#user
+      # def user_update(options = {})
+      #   post("/community/users/#{options[:user]}/update",options)
+      # end
+      #
+      # # http://www.arcgis.com/apidocs/rest/commonparams.html
+      # # Parameters:
+      # #  - http://www.arcgis.com/apidocs/rest/commonparams.html#commonparameters
+      # def user_delete(options = {})
+      #   post("/community/users/#{options[:user]}/delete",options)
+      # end
+      #
+      # # http://www.arcgis.com/apidocs/rest/usercontent.html
+      # def user_items(options = {})
+      #   url = "/content/users/#{options[:user]}"
+      #   url << "/#{options[:folder]}" if options.include?(:folder)
+      #   get(url)
+      # end
+    end
+  end
+end

data/lib/contrib/multipart.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+require 'digest/sha1'
+require "erb"
+include ERB::Util
+
+class Net::HTTP::Post
+  def set_multipart_form_data(params, boundary=nil)
+    boundary ||= Digest::SHA1.hexdigest(params.inspect)
+    chunks = params.map { |k,v|
+      if(v.is_a?(File))
+        %Q{Content-Disposition: form-data; name="#{k}"; filename="#{File.basename(v.path)}"\r\n} +
+        %Q{Content-Transfer-Encoding: binary\r\nContent-Type: application/octet-stream\r\n\r\n} +
+        %Q{#{v.read}\r\n}
+      else 
+        %Q{Content-Disposition: form-data; name="#{url_encode(k)}"\r\n} +
+        %Q{\r\n#{v}\r\n} 
+      end
+    }
+    self.body = "--#{boundary}\r\n" + chunks.join("--#{boundary}\r\n") + "--#{boundary}--\r\n"
+    self.content_type = "multipart/form-data; boundary=#{boundary}"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: arcgis
+version: !ruby/object:Gem::Version
+  version: 0.0.15
+platform: ruby
+authors:
+- Andrew Turner
+autorequire: arcgis
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: 
+email: aturner@esri.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/arcgis.rb
+- lib/arcgis/base.rb
+- lib/arcgis/client.rb
+- lib/arcgis/configurable.rb
+- lib/arcgis/online.rb
+- lib/arcgis/portal/portal.rb
+- lib/arcgis/sharing/comment.rb
+- lib/arcgis/sharing/community.rb
+- lib/arcgis/sharing/features.rb
+- lib/arcgis/sharing/group.rb
+- lib/arcgis/sharing/item.rb
+- lib/arcgis/sharing/search.rb
+- lib/arcgis/sharing/user.rb
+- lib/contrib/multipart.rb
+homepage: 
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A simple wrapper for ArcGIS Online sharing API
+test_files: []
+has_rdoc: