socrata 0.1.0

data/lib/socrata.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2010 Socrata.
+#
+# 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.
+
+require 'logger'
+require 'rubygems'
+require 'httparty'
+require 'curb'
+require 'json'
+require 'date'
+require 'pp'
+
+# Dynamically load dependencies
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'socrata/data')
+
+class Socrata
+  include HTTParty
+
+  attr_reader :error, :config, :batching
+
+  default_options[:headers] = {'Content-type' => 'application/json'}
+  format :json
+
+  DEFAULT_CONFIG = {
+    :base_uri => "http://www.socrata.com/api"
+  }
+
+  def initialize(params = {})
+    @config = DEFAULT_CONFIG.merge(symbolize_keys(params))
+    @logger = @config[:logger] || Logger.new(STDOUT)
+    @batching = false
+    @batch_queue = []
+
+    if @config[:username]
+      self.class.basic_auth(@config[:username],
+                            @config[:password])
+    else
+      self.class.default_options[:basic_auth] = nil
+    end
+
+    self.class.base_uri @config[:base_uri]
+
+    # Keep around a self reference because we need it
+    @party = self.class
+  end
+
+  def user(uid_or_login)
+    return User.new(get_request("/users/#{uid_or_login}.json"), @party)
+  end
+
+  def view(uid)
+    return View.new(get_request("/views/#{uid}.json"), @party)
+  end
+
+  # Wrap a proc for a batch request
+  def batch_request()
+    @batching = true
+    @batch_queue = []
+    yield
+    @batching = false
+    flush_batch_queue();
+  end
+
+  protected
+    def get_request(path, options = {})
+      if @batching
+        # Batch up the request
+        @batch_queue << {:url => path, :requestType => "GET"}
+      else
+        # Actually execute the request
+        response = @party.get(path, options);
+        check_error! response
+        return response
+      end
+    end
+
+    def post_request(path, options = {})
+      if @batching
+        # Batch up the request
+        @batch_queue << {:url => path, :body => options[:body], :requestType => "POST"}
+      else
+        # Actually execute the request
+        response = @party.post(path, options)
+        check_error! response
+        return response
+      end
+    end
+
+    def put_request(path, options = {})
+      if @batching
+        # Batch up the request
+        @batch_queue << {:url => path, :body => options[:body], :requestType => "PUT"}
+      else
+        # Actually execute the request
+        response = @party.put(path, options)
+        check_error! response
+        return response
+      end
+    end
+
+    def delete_request(path, options = {})
+      if @batching
+        # Batch up the request
+        @batch_queue << {:url => path, :body => options[:body], :requestType => "DELETE"}
+      else
+        # Actually execute the request
+        response = @party.delete(path, options)
+        check_error! response
+        return response
+      end
+    end
+
+    # Flush a queued batch of requests
+    def flush_batch_queue
+      if !@batch_queue.empty?
+        result = @party.post('/batches', :body => {:requests => @batch_queue}.to_json)
+        results_parsed = JSON.parse(result.body)
+        if results_parsed.is_a? Array
+          results_parsed.each_with_index do |result, i|
+            if result['error']
+              raise "Received error in batch response for operation " +
+                @batch_queue[i][:requestType] + " " + @batch_queue[i][:url] + ". Error: " +
+                result['errorCode'] + " - " + result['errorMessage']
+            end
+          end
+        else
+          raise "Expected array response from a /batches request, and didn't get one."
+        end
+        @batch_queue.clear
+      end
+      return results_parsed
+    end
+
+    # Reads response and checks for error code
+    def check_error!(response)
+      if !response.nil? && response['error']
+        raise "Got error from server: Code: #{response['code']}, Message: #{response['message']}"
+      end
+    end
+
+    # Sends a multipart-formdata encoded POST request
+    def multipart_post(url, contents, field = 'file', mimetype = "application/json")
+      c = Curl::Easy.new(@party.default_options[:base_uri] + url.to_s)
+      c.multipart_form_post = true
+
+      c.userpwd = @party.default_options[:basic_auth][:username] +
+        ":" + @party.default_options[:basic_auth][:password]
+      c.http_post(Curl::PostField.content(field, contents, mimetype))
+
+      return JSON.parse(c.body_str)
+    end
+
+    def multipart_post_file(url, filename, field = 'file', remote_filename = filename)
+      c = Curl::Easy.new(@party.default_options[:base_uri] + url.to_s)
+      c.multipart_form_post = true
+
+      c.userpwd = @party.default_options[:basic_auth][:username] +
+        ":" + @party.default_options[:basic_auth][:password]
+      c.http_post(Curl::PostField.file(field, filename, remote_filename))
+
+      return JSON.parse(c.body_str)
+    end
+
+    def symbolize_keys(obj)
+      case obj
+      when Array
+        obj.inject([]){|res, val|
+          res << case val
+          when Hash, Array
+            symbolize_keys(val)
+          else
+            val
+          end
+          res
+        }
+      when Hash
+        obj.inject({}){|res, (key, val)|
+          nkey = case key
+          when String
+            key.to_sym
+          else
+            key
+          end
+          nval = case val
+          when Hash, Array
+            symbolize_keys(val)
+          else
+            val
+          end
+          res[nkey] = nval
+          res
+        }
+      else
+        obj
+      end
+    end
+end

data/lib/socrata/data.rb

@@ -0,0 +1,80 @@
+# Copyright (c) 2010 Socrata.
+#
+# 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.
+
+class Socrata
+  class Data < Socrata
+    attr_reader :data
+
+    def initialize(data, party)
+      @data = data
+      @party = party
+    end
+
+    def method_missing(method)
+      key = @data[method.to_s]
+    end
+
+    def id
+      @data["id"]
+    end
+  end
+
+  class User < Data; end
+
+  class View < Data
+    # Get the rows for this View as a raw array of arrays
+    def raw_rows(params = {})
+      return get_request("/views/#{self.id}/rows.json", :query => params)
+    end
+
+    # Get the rows as an array of hashes by their column ID or something
+    # overriden with the second param
+    def rows(params = {}, by = "name")
+      # TODO: I really hate this method, I'd like to redo it.
+
+      # Get the raw rows
+      response = get_request("/views/#{self.id}/rows.json", :query => params)
+
+      # Create a mapping from array index to ID
+      columns = response["meta"]["view"]["columns"]
+      mapping = Hash.new
+      columns.each_index do |idx|
+        mapping[idx] = columns[idx][by]
+      end
+
+      # Loop over the rows, replacing each with a proper hash
+      rows = response["data"]
+      new_rows = Array.new
+      rows.each do |row_arr|
+        row_hash = Hash.new
+
+        # Loop over the row, building our hash
+        row_arr.each_index do |idx|
+          row_hash[mapping[idx]] = row_arr[idx]
+        end
+
+        # Add a few meta columns
+        row_hash["_id"] = row_arr[0]
+
+        new_rows.push row_hash
+      end
+
+      return new_rows
+    end
+
+    def get_row(row_id)
+      return get_request("/views/#{self.id}/rows/#{row_id}.json")
+    end
+  end
+end

data/lib/socrata/user.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2010 Socrata.
+#
+# 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.
+
+#module Socrata
+  #class User < SocrataAPI
+    #def initialize(params = {})
+      #@user = params[:username]
+      #raise ArgumentError, 'No username specified' if @user.nil?
+      #super
+    #end
+    
+    #def datasets
+      #sets = []
+      #self.class.get("/users/#{@user}/views.json").each do |set|
+        #dataset = Dataset.new(:config => @config)
+        #dataset.attach(set['id'])
+        #sets << dataset
+      #end
+      #sets
+    #end
+    
+    #def profile
+      #self.class.get("/users/#{@user}.json")
+    #end
+  #end
+#end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: socrata
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aiden Scandella
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 4
+        - 0
+        version: 0.5.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 6
+        version: 1.1.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id003
+description: Access the Socrata data platform via Ruby
+email: aiden.scandella@socrata.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/socrata.rb
+- lib/socrata/data.rb
+- lib/socrata/user.rb
+has_rdoc: true
+homepage: http://api.socrata.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Access the Socrata data platform via Ruby
+test_files: []
+