soda-ruby 0.2.13 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 465ea1cbe79b189bc29e2798e6e907e677a21963
-  data.tar.gz: d1c223e502052c9a07e34c95298ffdc237660b4c
+  metadata.gz: e08ae803c8dea78e00b08a07bc2be1cc4b87cd95
+  data.tar.gz: a9e5a9781c7fcfd40f599698128ed84063bee1d1
 SHA512:
-  metadata.gz: db13c563d0055fcfdaa4ded0d8bf56874e0346085b0b10a2ec4165d633c6d292c0abee3f334940629d416f2e7f77b4a52d5e1545b71583a808a78739575ced2a
-  data.tar.gz: 4a09101c6259b561b5ade89efc45d2ed39ee8e5231d2e212efa982174848c58832594a43d56ca6e592ccfeba0a8b5946b979eb439ce4cde978949266201ad6bb
+  metadata.gz: 70975c06355fbcb43a20571dc20d2c0e75ff3f197b59977bd6adaf804f8069e75dd465b311addd7691017074e41aec6474d0f07b6ad19f227bbd286719cc7498
+  data.tar.gz: ea997e8681e790a13e0b59f34e196d62367240a7c15929389e07f2536343f719d7098dcb3a535f85555b37b1e403038f729a4c1ba230f28bae0a8ec3f9bbceec

data/README.mkd

@@ -18,10 +18,30 @@ Create a new client. Register for an application token at <http://dev.socrata.co
 client = SODA::Client.new({:domain => "explore.data.gov", :app_token => "CGxadgoQlgQSev4zyUh5aR5J3"})
 ```
 
-Issue a simple query. `644b-gaut` is the identifier for the dataset we want to access:
+Issue a filter query. `644b-gaut` is the identifier for the dataset we want to access. The return object is an array of [Hashie::Mash](https://github.com/intridea/hashie) objects:
 
 ```ruby
 response = client.get("644b-gaut", {"$limit" => 1, :namelast => "WINFREY", :namefirst => "OPRAH"})
 
- => [#<Hashie::Mash appt_end_date="12/3/09 23:59" appt_made_date="12/2/09 18:05" appt_start_date="12/3/09 9:30" caller_name_first="SALLY" caller_name_last="ARMBRUSTER" last_updatedby="J7" lastentrydate="12/2/09 18:05" meeting_loc="WH" meeting_room="DIP ROOM" namefirst="OPRAH" namelast="WINFREY" post="WIN" release_date=1269586800 terminal_suffix="J7" total_people="10" type_of_access="VA" uin="U60816" visitee_namefirst="SEMONTI" visitee_namelast="STEPHENS">]
+ #=> [#<Hashie::Mash appt_end_date="12/3/09 23:59" appt_made_date="12/2/09 18:05" appt_start_date="12/3/09 9:30" caller_name_first="SALLY" caller_name_last="ARMBRUSTER" last_updatedby="J7" lastentrydate="12/2/09 18:05" meeting_loc="WH" meeting_room="DIP ROOM" namefirst="OPRAH" namelast="WINFREY" post="WIN" release_date=1269586800 terminal_suffix="J7" total_people="10" type_of_access="VA" uin="U60816" visitee_namefirst="SEMONTI" visitee_namelast="STEPHENS">]
 ```
+
+You can use other simple query SoQL methods found here: <http://dev.socrata.com/docs/queries.html>
+
+```ruby
+client = SODA::Client.new({:domain => "soda.demo.socrata.com"})
+magnitude_response = client.get("4tka-6guv", {"$where" => "magnitude > '3.0'"})
+
+#=> [#<Hashie::Mash datetime="2012-09-14T09:28:55" depth="20" earthquake_id="12258012" location=#<Hashie::Mash latitude="19.7859" longitude="-64.0849" needs_recoding=false> magnitude="3.1" number_of_stations="6" region="north of the Virgin Islands" source="pr" version="0">, #<Hashie::Mash datetime="2012-09-14T07:58:39" depth="74" earthquake_id="12258011" location=#<Hashie::Mash latitude="19.5907" longitude="-64.1723" needs_recoding=false> magnitude="3.3" number_of_stations="4" region="Virgin Islands region" source="pr" version="0">, ... ]
+
+datetime_response = client.get("4tka-6guv", {"$where" => "datetime > '2012-09-14T09:28:55' AND datetime < '2012-12-25T09:00:00'"})
+
+#=> [#<Hashie::Mash datetime="2012-09-14T10:10:19" depth="8.2" earthquake_id="00388609" location=#<Hashie::Mash latitude="36.9447" longitude="-117.6778" needs_recoding=false> magnitude="1.7" number_of_stations="29" region="Northern California" source="nn" version="9">, #<Hashie::Mash datetime="2012-09-14T10:06:11" depth="6.4" earthquake_id="00388607" location=#<Hashie::Mash latitude="36.9417" longitude="-117.6903" needs_recoding=false> magnitude="1.7" number_of_stations="29" region="Central California" source="nn" version="9">, ... ]
+```
+
+All the field names have built in getter methods since the objects are Hashie::Mashes.
+
+```ruby
+magnitude_response.first.number_of_stations   #=> "6"
+```
+*Note that the return value is a string object.*

data/lib/soda.rb

@@ -1 +1 @@
-require "soda/client"
+require 'soda/client'

data/lib/soda/client.rb

@@ -10,9 +10,18 @@ require 'uri'
 require 'json'
 require 'cgi'
 require 'hashie'
+require 'sys/uname'
+require 'soda/version'
+include Sys
 
 module SODA
   class Client
+    class << self
+      def generate_user_agent
+        "soda-ruby/#{SODA::VERSION} (#{Uname.uname.sysname}/#{Uname.uname.release}; Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+      end
+    end
+
     ##
     #
     # Creates a new SODA client.
@@ -34,7 +43,8 @@ module SODA
     #   client = SODA::Client.new({ :domain => "data.agency.gov", :app_token => "CGxarwoQlgQSev4zyUh5aR5J3" })
     #
     def initialize(config = {})
-      @config = config.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      @config = Hashie.symbolize_keys! config
+      @user_agent = SODA::Client.generate_user_agent
     end
 
     ##
@@ -114,120 +124,127 @@ module SODA
       connection(:delete, resource, body, params)
     end
 
-    def post_form(path, fields = {}, params = {})
+    def post_form(resource, body = {}, params = {})
       query = query_string(params)
-      resource = resoure_path(path)
-
-      # Create our request
-      uri = URI.parse("https://#{@config[:domain]}#{resource}.json?#{query}")
-      http = build_http_client(uri.host, uri.port)
+      path = resource_path(resource)
+      uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
 
       request = Net::HTTP::Post.new(uri.request_uri)
-      request.add_field("X-App-Token", @config[:app_token])
-      request.set_form_data(fields)
+      add_default_headers_to_request(request)
+      request.set_form_data(body)
 
       # Authenticate if we're supposed to
-      if @config[:username]
-        request.basic_auth @config[:username], @config[:password]
-      end
+      authenticate(request)
 
       # BAM!
-      return handle_response(http.request(request))
+      http = build_http_client(uri.host, uri.port)
+      handle_response(http.request(request))
     end
 
     private
-      def query_string(params)
-        # Create query string of escaped key, value pairs
-        return params.collect{ |key, val| "#{key}=#{CGI::escape(val.to_s)}" }.join("&")
-      end
 
-      def resource_path(resource)
-        # If we didn't get a full path, assume "/resource/"
-        if !resource.start_with?("/")
-          resource = "/resource/" + resource
-        end
+    def query_string(params)
+      # Create query string of escaped key, value pairs
+      params.map { |key, val| "#{key}=#{CGI.escape(val.to_s)}" }.join('&')
+    end
 
-        # Check to see if we were given an output type
-        extension = ".json"
-        if matches = resource.match(/^(.+)(\.\w+)$/)
-          resource = matches.captures[0]
-          extension = matches.captures[1]
-        end
+    def resource_path(resource)
+      # If we didn't get a full path, assume "/resource/"
+      resource = '/resource/' + resource unless resource.start_with?('/')
 
-        return resource + extension
+      # Check to see if we were given an output type
+      extension = '.json'
+      if matches = resource.match(/^(.+)(\.\w+)$/)
+        resource = matches.captures[0]
+        extension = matches.captures[1]
       end
 
-      def handle_response(response)
-        # Check our response code
-        if !["200", "202"].include? response.code
-          raise "Error in request: #{response.body}"
+      resource + extension
+    end
+
+    def handle_response(response)
+      # Check our response code
+      check_response_fail(response)
+      if response.body.nil? || response.body.empty?
+        return nil
+      elsif response['Content-Type'].include?('application/json')
+        # Return a bunch of mashes if we're JSON
+        response = JSON.parse(response.body, :max_nesting => false)
+        if response.is_a? Array
+          return response.map { |r| Hashie::Mash.new(r) }
         else
-          if response.body.nil? || response.body.empty?
-            return nil
-          elsif response["Content-Type"].include?("application/json")
-            # Return a bunch of mashes if we're JSON
-            response = JSON::parse(response.body, :max_nesting => false)
-            if response.is_a? Array
-              return response.collect { |r| Hashie::Mash.new(r) }
-            else
-              return Hashie::Mash.new(response)
-            end
-          else
-            # We don't partically care, just return the raw body
-            return response.body
-          end
+          return Hashie::Mash.new(response)
         end
+      else
+        # We don't partically care, just return the raw body
+        return response.body
       end
+    end
 
-      def connection(method = "Get", resource = nil, body = nil, params = {})
-        method = method.to_sym.capitalize
+    def check_response_fail(response)
+      return if %w(200 202).include? response.code
+      fail "Error in request: #{response.body}"
+    end
 
-        query = query_string(params)
+    def connection(method = 'Get', resource = nil, body = nil, params = {})
+      method = method.to_sym.capitalize
 
-        path = resource_path(resource)
+      query = query_string(params)
+      path = resource_path(resource)
+      uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
 
-        uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
+      request = eval("Net::HTTP::#{method}").new(uri.request_uri)
+      add_default_headers_to_request(request)
 
-        http = build_http_client(uri.host, uri.port)
-        request = eval("Net::HTTP::#{method.capitalize}").new(uri.request_uri)
-        request.add_field("X-App-Token", @config[:app_token])
+      # Authenticate if we're supposed to
+      authenticate(request)
 
-        if method === :Post || :Put || :Delete
-          request.content_type = "application/json"
-          request.body = body.to_json(:max_nesting => false)
-        end
+      http = request_by_method(method, body, request, uri)
+      send_request(method, http, request)
+    end
 
-        # Authenticate if we're supposed to
+    def send_request(method, http, request)
+      return delete_method_response(method, http, request) if method === :Delete
+      handle_response(http.request(request))
+    end
 
-        if @config[:username]
-          request.basic_auth @config[:username], @config[:password]
-        end
+    def delete_method_response(http, request)
+      response = http.request(request)
+      return response if response.code == '200'
+      fail "Error querying \"#{uri}\": #{response.body}"
+    end
 
-        if method === :Delete
-          response = http.request(request)
-          # Check our response code
-          if response.code != "200"
-            raise "Error querying \"#{uri.to_s}\": #{response.body}"
-          else
-            # Return a bunch of mashes
-            return response
-          end
-        else
-          return handle_response(http.request(request))
-        end
-      end
+    def net_http_class(method)
+      Object.const_get("Net::HTTP::#{method}")
+    end
 
-      def build_http_client(host, port)
-        http = Net::HTTP.new(host, port)
-        http.use_ssl = true
-        if @config[:ignore_ssl]
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        end
-        if @config[:timeout]
-          http.read_timeout = @config[:timeout]
-        end
-        http
+    def request_by_method(method, body, request, uri)
+      if method === :Post || :Put || :Delete
+        request.content_type = 'application/json'
+        request.body = body.to_json(:max_nesting => false)
       end
 
+      build_http_client(uri.host, uri.port)
+    end
+
+    def build_http_client(host, port)
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @config[:ignore_ssl]
+      http.read_timeout = @config[:timeout] if @config[:timeout]
+      http
+    end
+
+    def authenticate(request)
+      return unless @config[:username]
+      # Authenticate if we're supposed to
+      request.basic_auth @config[:username], @config[:password]
+    end
+
+    def add_default_headers_to_request(request)
+      request.delete('User-Agent')
+      request.add_field('X-App-Token', @config[:app_token])
+      request.add_field('User-Agent', @user_agent)
+    end
   end
 end

data/lib/soda/version.rb

@@ -1,3 +1,3 @@
 module SODA
-  VERSION = "0.2.13"
+  VERSION = '0.2.15'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soda-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.15
 platform: ruby
 authors:
 - Chris Metcalf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -24,13 +24,153 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple wrapper for SODA 2.0
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sys-uname
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple wrapper for SODA 2.0. Includes an OmniAuth provider for OAuth
+  2.0
 email: chris.metcalf@socrata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.mkd
 - LICENSE
 - README.mkd
 - lib/omniauth-socrata.rb
@@ -57,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: soda-ruby
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby for SODA 2.0

data/CHANGELOG.mkd

@@ -1,11 +0,0 @@
-0.2.0 - Initial Public Release
-0.2.1 - Point release to update gemspec dependencies
-...
-0.2.4 - Point release including tests that are now mocked properly
-0.2.6 - Code cleanup from @raykao
-0.2.7 - Removing dead code and an un-needed dependency
-0.2.8 - Removing the nesting limit on the JSON parser
-0.2.10 - Removing a nesting limit that we missed
-0.2.11 - We weren't properly handling an empty payload response
-0.2.12 - Added a global option to disable SSL checking from https://github.com/socrata/soda-ruby/pull/7
-0.2.13 - Added a global :timeout option to override the default Net:HTTP timeout, and accepting 202 as an "OK" response code, which should only occur during import.