soda-ruby 0.2.4 → 0.2.5

data/CHANGELOG.mkd

@@ -1,2 +1,4 @@
 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

data/README.mkd

@@ -1 +1,18 @@
 The humble beginnings of a [SODA 2.0](http://dev.socrata.com) wrapper for Ruby.
+
+Installation
+------------
+
+SODA is distributed as a gem, which is how it should be used in your app.
+
+Include the gem and hashie in your Gemfile:
+
+```ruby
+gem 'soda-ruby', :require => 'soda'
+```
+
+Quick Start
+-----------
+```ruby
+@client = SODA::Client.new({:domain => "sandbox.demo.socrata.com", :app_token => "K6rLY8NBK0Hgm8QQybFmwIUQw" })
+```

data/lib/soda/client.rb

@@ -6,6 +6,7 @@ require 'uri'
 require 'json'
 require 'cgi'
 require 'hashie'
+require 'curb'
 
 module SODA
   class Client
@@ -15,21 +16,10 @@ module SODA
 
     def get(resource, params = {})
       query = query_string(params)
-
-      # If we didn't get a full path, assume "/resource/"
-      if !resource.start_with?("/")
-        resource = "/resource/" + resource
-      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
+      path = resource_path(resource)
 
       # Create our request
-      uri = URI.parse("https://#{@config[:domain]}#{resource}#{extension}?#{query}")
+      uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
@@ -42,37 +32,15 @@ module SODA
       end
 
       # BAM!
-      response = http.request(request)
-
-      # Check our response code
-      if response.code != "200"
-        raise "Error querying \"#{uri.to_s}\": #{response.body}"
-      else
-        if extension == ".json"
-          # Return a bunch of mashes if we're JSON
-          response = JSON::parse(response.body)
-          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
-      end
+      return handle_response(http.request(request))
     end
 
     def post(resource, body = "", params = {})
       query = query_string(params)
-
-      # If we didn't get a full path, assume "/resource/"
-      if !resource.start_with?("/")
-        resource = "/resource/" + resource
-      end
+      path = resource_path(resource)
 
       # Create our request
-      uri = URI.parse("https://#{@config[:domain]}#{resource}.json?#{query}")
+      uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
@@ -87,23 +55,44 @@ module SODA
       end
 
       # BAM!
-      response = http.request(request)
+      return handle_response(http.request(request))
+    end
 
-      # Check our response code
-      if response.code != "200"
-        raise "Error querying \"#{uri.to_s}\": #{response.body}"
-      else
-        # Return a bunch of mashes
-        response = JSON::parse(response.body)
-        if response.is_a? Array
-          return response.collect { |r| Hashie::Mash.new(r) }
-        else
-          return Hashie::Mash.new(response)
-        end
+    def put(resource, body = "", params = {})
+      query = query_string(params)
+      path = resource_path(resource)
+
+      # Create our request
+      uri = URI.parse("https://#{@config[:domain]}#{path}?#{query}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP::Put.new(uri.request_uri)
+      request.add_field("X-App-Token", @config[:app_token])
+      request.content_type = "application/json"
+      request.body = body.to_json
+
+      # Authenticate if we're supposed to
+      if @config[:username]
+        request.basic_auth @config[:username], @config[:password]
       end
+
+      # BAM!
+      return handle_response(http.request(request))
     end
 
-    def put(resource, body = "", params = {})
+    def upload_file(path, filename, params = {}, field = 'file', remote_filename = filename)
+      # c = Curl::Easy.new("https://#{@config[:domain]}#{path}?#{query_string(params)}")
+      # c.multipart_form_post = true
+      # c.http_auth_types = :basic
+      # c.username = @config[:username]
+      # c.password = @config[:password]
+      # c.headers['X-App-Token'] = @config[:app_token]
+      # c.http_post(Curl::PostField.file(field, filename, remote_filename))
+
+      # puts c.body_str.inspect
+      # return Hashie::Mash.new(JSON.parse(c.body_str))
+
       query = query_string(params)
 
       # If we didn't get a full path, assume "/resource/"
@@ -116,7 +105,7 @@ module SODA
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
 
-      request = Net::HTTP::Put.new(uri.request_uri)
+      request = Net::HTTP::Post.new(uri.request_uri)
       request.add_field("X-App-Token", @config[:app_token])
       request.content_type = "application/json"
       request.body = body.to_json
@@ -127,20 +116,32 @@ module SODA
       end
 
       # BAM!
-      response = http.request(request)
+      return handle_response(http.request(request))
+    end
 
-      # Check our response code
-      if response.code != "200"
-        raise "Error querying \"#{uri.to_s}\": #{response.body}"
-      else
-        # Return a bunch of mashes
-        response = JSON::parse(response.body)
-        if response.is_a? Array
-          return response.collect { |r| Hashie::Mash.new(r) }
-        else
-          return Hashie::Mash.new(response)
-        end
+    def post_form(path, fields = {}, params = {})
+      query = query_string(params)
+      resource = resoure_path(path)
+
+      # Create our request
+      uri = URI.parse("https://#{@config[:domain]}#{resource}.json?#{query}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      if @config[:ignore_ssl]
+        http.auth.ssl.verify_mode = openssl::ssl::verify_none
+      end
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.add_field("X-App-Token", @config[:app_token])
+      request.set_form_data(fields)
+
+      # Authenticate if we're supposed to
+      if @config[:username]
+        request.basic_auth @config[:username], @config[:password]
       end
+
+      # BAM!
+      return handle_response(http.request(request))
     end
 
     def delete(resource, body = "", params = {})
@@ -179,9 +180,45 @@ module SODA
     end
 
     private
-      def query_string(params) 
+      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
+
+        # 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
+
+        return resource + extension
+      end
+
+      def handle_response(response)
+        # Check our response code
+        if response.code != "200"
+          raise "Error in request: #{response.body}"
+        else
+          if response["Content-Type"].include?("application/json")
+            # Return a bunch of mashes if we're JSON
+            response = JSON::parse(response.body)
+            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
+        end
+      end
   end
 end

data/lib/soda/version.rb

@@ -1,3 +1,3 @@
 module SODA
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soda-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie