geoloqi 0.9.36 → 0.9.37

data/README.md

@@ -31,22 +31,28 @@ If you're using Geoloqi with OAuth or making multiple requests, we recommend usi
 
 Which returns a hash with the following:
 
-	{"layer_id"=>"Gx", "user_id"=>"4", "type"=>"normal", "name"=>"USGS Earthquakes",
-	 "description"=>"Real-time notifications of earthquakes near you.",
-	 "icon"=>"http://beta.geoloqi.com/images/earthquake-layer.png", "public"=>"1",
-	 "url"=>"https://a.geoloqi.com/layer/description/Gx", "subscription"=>false, "settings"=>false}
+	{:layer_id     => "Gx", 
+	 :user_id      => "4", 
+	 :type         => "normal", 
+	 :name         => "USGS Earthquakes",
+	 :description  => "Real-time notifications of earthquakes near you.",
+	 :icon         => "http://beta.geoloqi.com/images/earthquake-layer.png", 
+	 :public       => "1",
+	 :url          => "https://a.geoloqi.com/layer/description/Gx", 
+	 :subscription => false, 
+	 :settings     => false}
 
 Both GET and POST are supported. To send a POST to create a place (in this case, the entire city of Portland, Oregon):
 
 	response = geoloqi.post 'place/create', {
-	  "layer_id" => "1Wn",
-	  "name" => "3772756364",
-	  "latitude" => "45.5037078163837",
-	  "longitude" => "-122.622699737549",
-	  "radius" => "3467.44",
-	  "extra" => {
-	    "description" => "Portland",
-	     "url" => "http://en.wikipedia.org/wiki/Portland"
+	  :layer_id  => "1Wn",
+	  :name      => "3772756364",
+	  :latitude  => "45.5037078163837",
+	  :longitude => "-122.622699737549",
+	  :radius    => "3467.44",
+	  :extra     => {
+	    :description => "Portland",
+	    :url         => "http://en.wikipedia.org/wiki/Portland"
 	  }
 	}
 
@@ -88,7 +94,7 @@ Implementing OAuth2 is not difficult, because we've done all the hard work for y
     end
 
     get '/?' do
-      username = geoloqi.get('account/username')['username']
+      username = geoloqi.get('account/username')[:username]
       "You have successfully logged in as #{username}!"
     end
 

data/examples/simple.rb

@@ -10,12 +10,12 @@ layer_id = geoloqi.post('layer/create', :name => 'Test Layer')[:layer_id]
 puts geoloqi.get("layer/info/#{layer_id}")
 
 place_id = geoloqi.post('place/create', {
-  :layer_id => layer_id,
-  :name => "Munich on the Willamette",
-  :latitude => "45.5037078163837",
+  :layer_id  => layer_id,
+  :name      => "Munich on the Willamette",
+  :latitude  => "45.5037078163837",
   :longitude => "-122.622699737549",
-  :radius => "3467.44",
-  :extra => {
+  :radius    => "3467.44",
+  :extra     => {
     :description => "Portland",
     :url => "http://en.wikipedia.org/wiki/Portland,_Oregon"
   }

data/examples/sinatra_synchrony.rb

@@ -1,9 +1,11 @@
 # A simple Sinatra example demonstrating OAuth2 implementation with Geoloqi
 
-# This version of the example uses sinatra-synchrony to implement a fast, EventMachine-based app.
+# This version of the example uses sinatra-synchrony to implement an EventMachine-based app.
 # Run this example with Thin (which uses EventMachine under the hood): ruby sinatra_synchrony.rb -s thin
 # Works on anything that supports Thin (Rack, EY, Heroku, etc..)
 # To install deps: gem install sinatra sinatra-synchrony geoloqi
+#
+# More information: http://kyledrake.net/sinatra-synchrony
 
 require 'sinatra'
 require 'sinatra/geoloqi'

data/lib/geoloqi.rb

@@ -7,6 +7,7 @@ require 'geoloqi/config'
 require 'geoloqi/error'
 require 'geoloqi/response'
 require 'geoloqi/session'
+require 'geoloqi/batch'
 require 'geoloqi/version'
 
 module Geoloqi

data/lib/geoloqi/batch.rb

@@ -0,0 +1,44 @@
+module Geoloqi
+  # This class is a builder/DSL class used to construct batch queries against the Geoloqi API. The best way to use this is
+  # to use it from the Session class.
+  # @see Session#batch
+  class Batch
+    # This keeps the batcher from going overboard.
+    PER_REQUEST_LIMIT = 200 
+
+    class NotImplementedError < StandardError; end
+
+    def initialize(session, &block)
+      @jobs = []
+      @session = session
+      self.instance_eval(&block)
+    end
+
+    def post(path, query=nil, headers={})
+      @jobs << {
+        :relative_url => path,
+        :body => query,
+        :headers => headers
+      }
+    end
+
+    def get(path, query=nil, headers={})
+      raise NotImplementedError, 'get requests are not yet implemented in batch'
+    end
+
+    def run!
+      results = []
+
+      until @jobs.empty?
+        queued_jobs = @jobs.slice! 0, PER_REQUEST_LIMIT
+
+        results << @session.post('batch/run', {
+          :access_token => @session.access_token,
+          :batch => queued_jobs
+        })[:result]
+      end
+
+      results.flatten!
+    end
+  end
+end

data/lib/geoloqi/config.rb

@@ -46,7 +46,7 @@ module Geoloqi
     #
     # @return [Boolean]
     # @example
-    #  Geoloqi.config :throw_exceptions = false
+    #  Geoloqi.config.throw_exceptions = false
     attr_accessor :throw_exceptions
     
     # Use dynamic error class names, which inherit from Geoloqi::ApiError. This may be deprecated in a future release.

data/lib/geoloqi/session.rb

@@ -178,6 +178,22 @@ module Geoloqi
       Response.new raw.status, raw.headers, raw.body
     end
 
+    # Make a batch request to the Geoloqi API. Compiles POST requests (provided in a block) and returns an array of the results,
+    # which includes the response code, headers, and body. Calls are made synchronously on the server, and the results are returned in
+    # the same order. This should be much faster for scenarios where inserting/updating hundreds or thousands of records is needed.
+    # @return [Array] - An array of Hash objects containing the response code, headers, and body.
+    # @see Batch
+    # @example
+    #  # Create 3 layers at once, return responses in an array
+    #  responses_array = geoloqi_session.batch do
+    #    post 'layer/create', :name => 'Layer 1'
+    #    post 'layer/create', :name => 'Layer 2'
+    #    post 'layer/create', :name => 'Layer 3'
+    #  end
+    def batch(&block)
+      Batch.new(self, &block).run!
+    end
+
     # Used to retrieve the access token from the Geoloqi OAuth2 server. This is fairly low level and you shouldn't need to use it directly.
     #
     # @return [Hash] - The auth hash used to persist the session object.

data/lib/geoloqi/version.rb

@@ -3,6 +3,6 @@ module Geoloqi
   #
   # @return [String]
   def self.version
-    '0.9.36'
+    '0.9.37'
   end
 end

data/spec/geoloqi/session_spec.rb

@@ -81,6 +81,40 @@ describe Geoloqi::Session do
       @session = Geoloqi::Session.new :access_token => ACCESS_TOKEN
     end
 
+    it 'successfully makes a batch request' do
+      stub_request(:post, api_url('batch/run')).
+        with(:body => {
+         :access_token => 'access_token1234',
+         :batch => [
+           {:relative_url => '/layer/create', :body => {:name => 'Test 1'}, :headers => {}},
+           {:relative_url => '/layer/create', :body => {:name => 'Test 2'}, :headers => {}}
+          ]
+        }.to_json, 
+        :headers => { 
+          'Authorization' => 'OAuth access_token1234',
+          'Content-Type'  => 'application/json'}).
+        to_return(:status => 200, :body => {:result => [
+          {:code => 201, 
+           :headers => [{:name => "Date", :value => "Wed, 08 Feb 2012 02:16:11 GMT"}],
+           :body => {:layer_id => "abc", :name => "Test 1"},
+           :time_ms => 11.373
+          },
+          {:code => 201,
+           :headers => [{:name => "Date", :value => "Wed, 08 Feb 2012 02:16:11 GMT"}],
+           :body => { :layer_id => "def", :name => "Test 2" },
+           :time_ms => 10.735
+          }]}.to_json)
+
+      response = @session.batch do
+        post '/layer/create', :name => 'Test 1'
+        post '/layer/create', :name => 'Test 2'
+      end
+
+      expect { response.first[:code] == 201 }
+      expect { response.first[:body][:layer_id] == 'abc' }
+      expect { response.last[:body][:layer_id] == 'def' }
+    end
+
     it 'throws an exception on a hard request error' do
       stub_request(:get, api_url('crashing_method')).
         with(:headers => auth_headers).

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 36
-  version: 0.9.36
+  - 37
+  version: 0.9.37
 platform: ruby
 authors: 
 - Kyle Drake
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-08 00:00:00 -08:00
+date: 2012-02-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -147,6 +147,7 @@ files:
 - examples/sinatra_synchrony.rb
 - geoloqi.gemspec
 - lib/geoloqi.rb
+- lib/geoloqi/batch.rb
 - lib/geoloqi/config.rb
 - lib/geoloqi/data/ca-certificates.crt
 - lib/geoloqi/error.rb