cartodb-rb-client 0.2.0 → 0.3.0

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-bin/
+bin/
+spec/support/cartodb_config.yml

data/Gemfile

@@ -5,8 +5,8 @@ gemspec
 
 group :development do
   gem "rspec", "~> 2.3.0"
-  gem "bundler", "~> 1.0.0"
-  gem "rcov", ">= 0"
+  gem "spork", "~> 0.9.0"
+  gem "bundler", "> 1.0.0"
   gem 'ruby-debug', :platforms => :mri_18
   gem 'ruby-debug19', :require => 'ruby-debug', :platforms => :mri_19
 end

data/README.markdown

@@ -38,17 +38,13 @@ Setup
         username: 'YOUR_CARTODB_USERNAME'
         password: 'YOUR_CARTODB_PASSWORD'
 
-3. Setup your cartoDB connection object. To do so, load the YAML file and assign it to a CartoDB::Config object:
-
-        CartoDB::Settings = YAML.load_file(Rails.root.join('config/cartodb_config.yml'))
-        CartoDB::Connection = CartoDB::Client::Connection.new
+3. Setup your cartoDB connection object:
 
+        CartoDB::Init.start YAML.load_file(Rails.root.join('config/cartodb_config.yml'))
+        
 And that's it. Now you should be able to run querys against the cartoDB servers using the CartoDB::Connection object.
 
-Rails apps
-----------
-
-If you're developing a Rails app, you just need to add the cartodb\_config.yml file to your rails app config directory. And that's it. You can access cartoDB anywhere in your app's code using the CartoDB::Connection class.
+Note: You have to use strings instead of symbols for the configuration hash keys.
 
 Using the cartoDB API
 -----------
@@ -63,11 +59,11 @@ Arguments:
 
 - **table\_name**: table's name.
 
-- **schema**: list of fields the table will contain.
+- **schema_or_file**: this parameter can be a list of fields the table will contain, or a File class containing the data the table will contain. It supports all file types supported by cartoDB.
 
 - **the\_geom\_type**: Type of geometry the\_geom field will have. Currently we only support 'POINT', but we'll support more types soon.
 
-Example:
+Example 1:
 
     CartoDB::Connection.create_table 'table #1', [{:name => 'field1', :type => 'text'}], 'POINT'
 
@@ -81,6 +77,40 @@ Results:
       ["updated_at", "date"],
       ["created_at", "date"]]}
 
+Example 2:
+
+    CartoDB::Connection.create_table 'whs_sites', File.open("#{File.dirname(__FILE__)}/support/whs_features.csv", 'r')
+
+Results:
+
+    {:id=>242,
+     :name=>"_20120314_21932_1fx2580whs_features",
+     :schema=>
+     [["cartodb_id", "number"],
+      ["the_geom", "geometry", "geometry", "point"],
+      ["comments", "string"],
+      ["country", "string"],
+      ["criteria", "string"],
+      ["date_of_inscription", "string"],
+      ["description", "string"],
+      ["edited_region", "string"],
+      ["endangered_reason", "string"],
+      ["endangered_year", "string"],
+      ["external_links", "string"],
+      ["iso_code", "string"],
+      ["latitude", "string"],
+      ["longitude", "string"],
+      ["name", "string"],
+      ["region", "string"],
+      ["size", "string"],
+      ["title", "string"],
+      ["type", "string"],
+      ["whs_site_id", "string"],
+      ["whs_source_page", "string"],
+      ["wikipedia_link", "string"],
+      ["created_at", "date"],
+      ["updated_at", "date"]]}
+
 ####2. Add column.
 
 Adds a new column to an existing table.
@@ -178,7 +208,7 @@ Results:
      :name => "table_1",
      :privacy => "PRIVATE",
      :tags => "",
-     :schema => 
+     :schema =>
      [["cartodb_id", "number"],
       ["myfield", "boolean"],
       ["updated_at", "date"],

data/cartodb-rb-client.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.add_dependency 'typhoeus', '0.2.4'
+  s.add_dependency 'typhoeus', '0.3.3'
   s.add_dependency 'oauth', '0.4.5'
-  s.add_dependency 'mime-types',  '1.16'
-  s.add_dependency 'activesupport', '>= 3.0.0', '<= 3.1.0'
+  s.add_dependency 'mime-types',  '>= 1.16'
+  s.add_dependency 'activesupport', '>= 3.0.0'
   s.add_dependency 'i18n', '>= 0.5.0', '<= 0.6.0'
   s.add_dependency 'rgeo', '0.3.2'
   s.add_dependency 'rgeo-geojson', '0.2.1'

data/lib/cartodb-rb-client/cartodb/client/authorization.rb

@@ -4,11 +4,15 @@ module CartoDB
   module Client
     module Authorization
 
+      CRLF = "\r\n"
+
       def signed_request(request_uri, arguments)
         arguments[:disable_ssl_peer_verification] = true
 
         request = Typhoeus::Request.new(request_uri, arguments)
 
+        request = as_multipart(request, arguments[:params]) if arguments[:multipart] == true
+
         request.headers.merge!({"Authorization" => oauth_helper(request, request_uri).header})
 
         request
@@ -53,6 +57,30 @@ module CartoDB
       end
       private :oauth_helper
 
+      def as_multipart(request, params)
+
+        boundary = Time.now.to_i.to_s(16)
+        request.headers["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+        body = ""
+        params.each do |key,value|
+          esc_key = CGI.escape(key.to_s)
+          body << "--#{boundary}#{CRLF}"
+          if value.respond_to?(:read)
+            body << "Content-Disposition: form-data; name=\"#{esc_key}\"; filename=\"#{File.basename(value.path)}\"#{CRLF}"
+            body << "Content-Type: application/octet-stream#{CRLF*2}"
+            body << value.read.force_encoding('utf-8')
+          else
+            body << "Content-Disposition: form-data; name=\"#{esc_key}\"#{CRLF*2}#{value}"
+          end
+          body << CRLF
+        end
+        body << "--#{boundary}--#{CRLF*2}"
+        request.body = body
+        request.params = {}
+        request
+      end
+      private :as_multipart
+
     end
   end
 end

data/lib/cartodb-rb-client/cartodb/client/connection/cartodb.rb

@@ -14,14 +14,66 @@ module CartoDB
         end
 
         def create_table(table_name = nil, schema_or_file = nil, the_geom_type = 'Point')
-          schema = schema_or_file if schema_or_file && schema_or_file.is_a?(Array)
-          file   = schema_or_file if schema_or_file && schema_or_file.is_a?(File)
 
           params = {:name => table_name}
-          params[:file] = file if file
-          params[:schema] = schema.map{|s| "#{s[:name]} #{s[:type]}"}.join(', ') if schema
+          params[:the_geom_type] = the_geom_type.downcase if the_geom_type.present?
 
-          request = cartodb_request 'tables', :post, :params => params, :the_geom_type => the_geom_type do |response|
+          case schema_or_file
+
+          when String
+
+            params[:the_geom_type] = schema_or_file.downcase
+
+            request = cartodb_request 'tables', :post, :params => params do |response|
+              return Utils.parse_json(response)
+            end
+
+          when Array
+
+            schema = schema_or_file if schema_or_file && schema_or_file.is_a?(Array)
+            params[:schema] = schema.map{|s| "#{s[:name]} #{s[:type]}"}.join(', ') if schema
+
+            request = cartodb_request 'tables', :post, :params => params do |response|
+              return Utils.parse_json(response)
+            end
+
+          when File
+
+            file = schema_or_file if schema_or_file && schema_or_file.is_a?(File)
+
+            request = cartodb_request nil, :post, :url => '/upload', :params => {:file => file}, :multipart => true do |response|
+              upload_response = Utils.parse_json(response)
+
+              params = {:name => table_name}
+              params[:url]           = generate_url upload_response[:file_uri]
+              params[:the_geom_type] = the_geom_type.downcase if the_geom_type.present?
+
+              request = cartodb_request 'tables', :post, :params => params do |response|
+                return Utils.parse_json(response)
+              end
+
+            end
+
+          else
+
+            request = cartodb_request 'tables', :post, :params => params do |response|
+              return Utils.parse_json(response)
+            end
+
+          end
+
+          execute_queue
+
+          request.handled_response
+
+        end
+
+        def rename_table(old_table_name, new_table_name)
+          request = cartodb_request "tables/#{old_table_name}",
+                                    :put,
+                                    :params => {
+                                      :name => new_table_name
+                                    } do |response|
             return Utils.parse_json(response)
           end
 
@@ -101,11 +153,8 @@ module CartoDB
           results = query(<<-SQL
             INSERT INTO #{table_name}
             (#{row.keys.join(',')})
-            VALUES (#{row.values.join(',')});
-
-            SELECT #{table_name}.cartodb_id as id, #{table_name}.*
-            FROM #{table_name}
-            WHERE cartodb_id = currval('public.#{table_name}_cartodb_id_seq');
+            VALUES (#{row.values.join(',')})
+            RETURNING cartodb_id as id, *;
           SQL
           )
 
@@ -119,10 +168,8 @@ module CartoDB
             UPDATE #{table_name}
             SET (#{row.keys.join(',')})
             = (#{row.values.join(',')})
-            WHERE cartodb_id = #{row_id};
-            SELECT #{table_name}.cartodb_id as id, #{table_name}.*
-            FROM #{table_name}
-            WHERE cartodb_id = currval('public.#{table_name}_cartodb_id_seq');
+            WHERE cartodb_id = #{row_id}
+            RETURNING cartodb_id as id, *;
           SQL
           )
 
@@ -178,6 +225,7 @@ module CartoDB
 
           uri = "/api/#{VERSION}/#{uri}"
           url = generate_url uri
+          url = generate_url(arguments[:url]) if arguments[:url]
 
           headers                  = {}
           headers['Accept']        = MIME::Types['application/json']
@@ -187,6 +235,7 @@ module CartoDB
             :method        => method,
             :headers       => headers,
             :params        => params,
+            :multipart     => arguments[:multipart],
             :cache_timeout => settings['cache_timeout'],
             :verbose       => settings['debug']
           )

data/lib/cartodb-rb-client/cartodb/helpers/sql_helper.rb

@@ -1,20 +1,26 @@
 module CartoDB
   module Helpers
     module SqlHelper
+      require 'time'
 
       def prepare_data(hash)
         hash.each do |key, value|
-          hash[key] = format_value(value)
+          hash[key] = format_value(key, value)
         end
         hash
       end
 
-      def format_value(value)
+      def format_value(key, value)
         case value
         when ::String
-          "'#{value}'"
+          #value = value.gsub(/\\/, '\&\&').gsub(/'/, "''")
+          if key.match(/geo/)
+            "#{value}"
+          else
+            "'#{value.gsub(/\\/, '\&\&').gsub(/'/, "''")}'"
+          end
         when ::Date, ::DateTime, ::Time
-          "'#{value}'"
+          "'#{value.to_time.utc}'"
         when RGeo::Feature::Geometry
           "'#{RGeo::WKRep::WKBGenerator.new(:type_format => :ewkb, :emit_ewkb_srid => true, :hex_format => true).generate(value)}'"
         when NilClass

data/lib/cartodb-rb-client/cartodb/model/geo.rb

@@ -34,6 +34,7 @@ module CartoDB
           self.send :define_method, :latitude do
             self.the_geom ? self.the_geom.y : nil
           end
+
           self.send :define_method, :longitude do
             self.the_geom ? self.the_geom.x : nil
           end

data/lib/cartodb-rb-client/cartodb/types/metadata.rb

@@ -2,6 +2,12 @@ module CartoDB
   module Types
     class Metadata < Hash
 
+      RESERVED_WORDS = %w(
+        alias and BEGIN begin break case class def defined? do else elsif END end
+        ensure false for if in module next nil not or redo rescue retry return self
+        super then true undef unless until when while yield
+      )
+
       class << self
         def from_hash(hash = {})
           metadata = self.new
@@ -14,6 +20,8 @@ module CartoDB
       end
 
       def []=(key, value)
+        key = :"#{key}_" if RESERVED_WORDS.include?(key.to_s)
+
         if key.to_s.eql?('the_geom')
           value = _geometry_features(value)
         else

data/lib/cartodb-rb-client/version.rb

@@ -1,7 +1,7 @@
 module Cartodb
   module Rb
     module Client
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

data/spec/client_spec.rb

@@ -20,11 +20,11 @@ describe 'CartoDB client' do
 
   it "should create a table forcing the schema and get its table definition" do
     table = CartoDB::Connection.create_table 'cartodb_spec', [
-                                    {:name => 'field1', :type => 'text'},
-                                    {:name => 'field2', :type => 'numeric'},
-                                    {:name => 'field3', :type => 'date'},
-                                    {:name => 'field4', :type => 'boolean'}
-                                  ]
+      {:name => 'field1', :type => 'text'},
+      {:name => 'field2', :type => 'numeric'},
+      {:name => 'field3', :type => 'date'},
+      {:name => 'field4', :type => 'boolean'}
+    ]
 
     table.should_not be_nil
     table = CartoDB::Connection.table 'cartodb_spec'
@@ -38,43 +38,105 @@ describe 'CartoDB client' do
     table.schema.should include(["field4", "boolean"])
   end
 
-  # it "should create a table from a csv file" do
-  #   table = CartoDB::Connection.create_table 'whs_sites', File.open("#{File.dirname(__FILE__)}/support/whs_features.csv", 'r')
-  #
-  #   table.should_not be_nil
-  #   table[:id].should be > 0
-  #   table = CartoDB::Connection.table 'whs_sites'
-  #   table.schema.should have(23).items
-  #
-  #   records = CartoDB::Connection.records 'whs_sites', :rows_per_page => 1000
-  #   records.should_not be_nil
-  #   records.rows.should have(911).whs_sites
-  #
-  #   records.rows.first.cartodb_id.should be > 0
-  #   records.rows.first.title.should be == "Late Baroque Towns of the Val di Noto (South-Eastern Sicily)"
-  #   records.rows.first.latitude.should be > 0
-  #   records.rows.first.longitude.should be > 0
-  #   records.rows.first.description.should match /Val di Noto \(English: Vallum of Noto\) is a geographical area of south east Sicily/
-  #   records.rows.first.region.should be == "Provinces of Catania, Ragusa, and Syracuse, Sicily"
-  #   records.rows.first.type.should be == "cultural"
-  #   records.rows.first.endangered_reason.should be_nil
-  #   records.rows.first.edited_region.should be == "Provinces of Catania, Ragusa, and Syracuse, Sicily"
-  #   records.rows.first.endangered_year.should be_nil
-  #   records.rows.first.external_links.should be_empty
-  #   records.rows.first.wikipedia_link.should be == "http://en.wikipedia.org/wiki/Val_di_Noto"
-  #   records.rows.first.comments.should be_nil
-  #   records.rows.first.criteria.should be == "[i],[ii],[iv],[v]"
-  #   records.rows.first.iso_code.should be == "IT"
-  #   records.rows.first.size.should be == 1130000.0
-  #   records.rows.first.name.should be == "Late Baroque Towns of the Val di Noto (South-Eastern Sicily)"
-  #   records.rows.first.country.should be == "Italy"
-  #   records.rows.first.whs_site_id.should be == 1024
-  #   records.rows.first.date_of_inscription.should be == "2002"
-  #   records.rows.first.whs_source_page.should be == "http://whc.unesco.org/en/list/1024"
-  #   records.rows.first.created_at.should_not be_nil
-  #   records.rows.first.updated_at.should_not be_nil
-  #
-  # end
+  it "should create a table from a csv file" do
+
+    table = CartoDB::Connection.create_table 'whs_sites', File.open("#{File.dirname(__FILE__)}/support/whs_features.csv", 'r')
+
+    table.should_not be_nil
+    table[:id].should be > 0
+    table = CartoDB::Connection.table table[:name]
+    table.schema.should have(24).items
+
+    records = CartoDB::Connection.records table[:name]
+    records.should_not be_nil
+    records.rows.should have(10).whs_sites
+
+    records.rows.first.cartodb_id.should be > 0
+    records.rows.first.title.should be == "Aflaj Irrigation Systems of Oman"
+    records.rows.first.latitude.should be > 0
+    records.rows.first.longitude.should be > 0
+    records.rows.first.description.should match /A qanāt \(from Arabic: قناة‎\) \(Iran, Syria and Jordan\) is a water management system used to provide/
+    records.rows.first.region.should be == "Dakhiliya, Sharqiya and Batinah Regions"
+    records.rows.first.type.should be == "cultural"
+    records.rows.first.endangered_reason.should be_empty
+    records.rows.first.edited_region.should be == "Dakhiliya, Sharqiya and Batinah Regions"
+    records.rows.first.endangered_year.should be_empty
+    records.rows.first.external_links.should_not be_empty
+    records.rows.first.wikipedia_link.should be == "http://en.wikipedia.org/wiki/Qanat"
+    records.rows.first.comments.should be_empty
+    records.rows.first.criteria.should be == "[v]"
+    records.rows.first.iso_code.should be == "OM"
+    records.rows.first.size.should be == 14560000.0
+    records.rows.first.name.should be == "Aflaj Irrigation Systems of Oman"
+    records.rows.first.country.should be == "Oman"
+    records.rows.first.whs_site_id.should be == 1207
+    records.rows.first.date_of_inscription.should be == 2006
+    records.rows.first.whs_source_page.should be == "http://whc.unesco.org/en/list/1207"
+    records.rows.first.created_at.should_not be_nil
+    records.rows.first.updated_at.should_not be_nil
+
+  end
+
+  it "should import any kind of data file" do
+    Dir["#{File.dirname(__FILE__)}/support/data/*"].each do |file|
+      table = CartoDB::Connection.create_table File.basename(file, '.*'), File.open(file, 'r')
+
+      table.should_not be_nil
+      table[:id].should be > 0
+      table[:name].should_not be_empty
+    end
+  end
+
+  it "should create a table with POINT type geometry" do
+    table = CartoDB::Connection.create_table 'cartodb_spec', 'point'
+
+    table.should_not be_nil
+    table = CartoDB::Connection.table 'cartodb_spec'
+    table.schema.should have(6).items
+    table.schema.should include(["cartodb_id", "number"])
+    table.schema.should include(["created_at", "date"])
+    table.schema.should include(["updated_at", "date"])
+    table.schema.should include(["name", "string"])
+    table.schema.should include(["description", "string"])
+    table.schema.should include(["the_geom", "geometry", "geometry", "point"])
+  end
+
+  it "should create a table with MULTIPOLYGON type geometry" do
+    table = CartoDB::Connection.create_table 'cartodb_spec', 'multipolygon'
+
+    table.should_not be_nil
+    table = CartoDB::Connection.table 'cartodb_spec'
+    table.schema.should have(6).items
+    table.schema.should include(["cartodb_id", "number"])
+    table.schema.should include(["created_at", "date"])
+    table.schema.should include(["updated_at", "date"])
+    table.schema.should include(["name", "string"])
+    table.schema.should include(["description", "string"])
+    table.schema.should include(["the_geom", "geometry", "geometry", "multipolygon"])
+  end
+
+  it "should rename an existing table" do
+    table = CartoDB::Connection.create_table 'cartodb_spec'
+
+    table.name.should be == 'cartodb_spec'
+
+    table = CartoDB::Connection.rename_table 'cartodb_spec', 'renamed_cartodb_spec'
+    table.name.should be == 'renamed_cartodb_spec'
+  end
+
+  it "should create a table with MULTILINESTRING type geometry" do
+    table = CartoDB::Connection.create_table 'cartodb_spec', 'multilinestring'
+
+    table.should_not be_nil
+    table = CartoDB::Connection.table 'cartodb_spec'
+    table.schema.should have(6).items
+    table.schema.should include(["cartodb_id", "number"])
+    table.schema.should include(["created_at", "date"])
+    table.schema.should include(["updated_at", "date"])
+    table.schema.should include(["name", "string"])
+    table.schema.should include(["description", "string"])
+    table.schema.should include(["the_geom", "geometry", "geometry", "multilinestring"])
+  end
 
   it "should add and remove colums in a previously created table" do
     CartoDB::Connection.create_table 'cartodb_spec'
@@ -127,35 +189,34 @@ describe 'CartoDB client' do
 
   it "should insert a row in a table" do
     table = CartoDB::Connection.create_table 'table #1', [
-                                    {:name => 'field1', :type => 'text'},
-                                    {:name => 'field2', :type => 'numeric'},
-                                    {:name => 'field3', :type => 'date'},
-                                    {:name => 'field4', :type => 'boolean'}
-                                  ]
+      {:name => 'field1', :type => 'text'},
+      {:name => 'field2', :type => 'numeric'},
+      {:name => 'field3', :type => 'date'},
+      {:name => 'field4', :type => 'boolean'}
+    ]
 
     today = DateTime.now
 
-    inserted_row = CartoDB::Connection.insert_row 'table_1', {
+    record = CartoDB::Connection.insert_row 'table_1', {
       'field1'      => 'lorem',
       'field2'      => 100.99,
       'field3'      => today,
       'field4'      => true
     }
 
-    record = CartoDB::Connection.row 'table_1', inserted_row.id
-    record.field1.should == 'lorem'
-    record.field2.should == 100.99
+    record.field1.should         == 'lorem'
+    record.field2.should         == 100.99
     record.field3.to_date.should == today.to_date
-    record.field4.should == true
+    record.field4.should         == true
   end
 
   it "should update a row in a table" do
     table = CartoDB::Connection.create_table 'table #1', [
-                                    {:name => 'field1', :type => 'text'},
-                                    {:name => 'field2', :type => 'numeric'},
-                                    {:name => 'field3', :type => 'date'},
-                                    {:name => 'field4', :type => 'boolean'}
-                                  ]
+      {:name => 'field1', :type => 'text'},
+      {:name => 'field2', :type => 'numeric'},
+      {:name => 'field3', :type => 'date'},
+      {:name => 'field4', :type => 'boolean'}
+    ]
 
     today = DateTime.now
 
@@ -166,15 +227,13 @@ describe 'CartoDB client' do
       'field4'      => true
     }
 
-    CartoDB::Connection.update_row 'table_1', record.id, {
+    record = CartoDB::Connection.update_row 'table_1', record.id, {
       'field1'      => 'illum',
       'field2'      => -83.24,
       'field3'      => today + 1,
       'field4'      => false
     }
 
-    record = CartoDB::Connection.row 'table_1', record.id
-
     record.field1.should      == 'illum'
     record.field2.should      == -83.24
     record.field3.to_date.should == (today + 1).to_date
@@ -183,11 +242,11 @@ describe 'CartoDB client' do
 
   it "should delete a table's row" do
     table = CartoDB::Connection.create_table 'table #1', [
-                                    {:name => 'field1', :type => 'text'},
-                                    {:name => 'field2', :type => 'numeric'},
-                                    {:name => 'field3', :type => 'date'},
-                                    {:name => 'field4', :type => 'boolean'}
-                                  ]
+      {:name => 'field1', :type => 'text'},
+      {:name => 'field2', :type => 'numeric'},
+      {:name => 'field3', :type => 'date'},
+      {:name => 'field4', :type => 'boolean'}
+    ]
 
     today = Time.now
 
@@ -275,4 +334,24 @@ describe 'CartoDB client' do
 
   end
 
+  it 'should escape properly input data in insert queries' do
+
+    table = CartoDB::Connection.create_table 'table #1', 'multipolygon'
+    table.schema.should include(["the_geom", "geometry", "geometry", "multipolygon"])
+
+    record = CartoDB::Connection.insert_row 'table_1', {
+      'the_geom' => "ST_GeomFromText('MULTIPOLYGON(((95.67764648436992 59.894444919406,90.75577148436992 54.16886220825434,103.41202148436992 56.75874227547269,95.67764648436992 59.894444919406)))', 4326)"
+    }
+
+    record.id.should_not be_nil
+  end
+
+  it 'should allow reserved words in columns names' do
+    table = CartoDB::Connection.create_table 'table #1', [{:name => 'class', :type => 'text'}]
+    table.schema.should include(["class", "string"])
+
+    record = CartoDB::Connection.insert_row table.name, :class => 'wadus'
+    record.class_.should == 'wadus'
+  end
+
 end