cartodb-rb-client 0.1.8

data/spec/model/data_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe 'CartoDB model data methods' do
+
+  it "should initialize attributes of the model without persisting them into cartodb using the `new` method" do
+
+    losail_circuit = new_circuit
+
+    records = CartoDB::Connection.records 'moto_gp_circuit'
+    records.total_rows.should == 0
+    records.rows.should be_empty
+
+    losail_circuit.name.should be == 'Losail Circuit'
+    losail_circuit.description.should be == 'The fabulous Losail International Circuit lies on the outskirts of Doha, the capital city of Qatar. Built in little over a year, the track cost $58 million USD and required round-the-clock dedication from almost 1,000 workers in order to get it ready for the inaugural event - the Marlboro Grand Prix of Qatar on the 2nd October 2004.'
+    losail_circuit.latitude.should be == 25.488840
+    losail_circuit.longitude.should be == 51.453352
+    losail_circuit.length.should be == '5380m'
+    losail_circuit.width.should be == '12m'
+    losail_circuit.left_corners.should be == 6
+    losail_circuit.right_corners.should be == 10
+    losail_circuit.longest_straight.should be == '1068m'
+    losail_circuit.constructed.should be == Date.new(2004, 1, 1)
+    losail_circuit.modified.should be == Date.new(2004, 1, 1)
+  end
+
+  it "should persist into cartodb using the save method" do
+    losail_circuit = new_circuit
+
+    expect {
+      losail_circuit.save.should be_true
+    }.to change{CartoDB::Connection.records('moto_gp_circuit').total_rows}.from(0).to(1)
+
+    record = CartoDB::Connection.row 'moto_gp_circuit', losail_circuit.cartodb_id
+    record.cartodb_id.should             be == 1
+    record.name.should             be == 'Losail Circuit'
+    record.description.should      match /The fabulous Losail International Circuit lies/
+    record.latitude.should         be == 25.488840
+    record.longitude.should        be == 51.453352
+    record.length.should           be == '5380m'
+    record.width.should            be == '12m'
+    record.left_corners.should     be == 6
+    record.right_corners.should    be == 10
+    record.longest_straight.should be == '1068m'
+    record.constructed.should be == Date.new(2004, 1, 1)
+    record.modified.should    be == Date.new(2004, 1, 1)
+
+    losail_circuit.cartodb_id.should be == 1
+    losail_circuit.name.should be == 'Losail Circuit'
+    losail_circuit.description.should be == 'The fabulous Losail International Circuit lies on the outskirts of Doha, the capital city of Qatar. Built in little over a year, the track cost $58 million USD and required round-the-clock dedication from almost 1,000 workers in order to get it ready for the inaugural event - the Marlboro Grand Prix of Qatar on the 2nd October 2004.'
+    losail_circuit.latitude.should be == 25.488840
+    losail_circuit.longitude.should be == 51.453352
+    losail_circuit.length.should be == '5380m'
+    losail_circuit.width.should be == '12m'
+    losail_circuit.left_corners.should be == 6
+    losail_circuit.right_corners.should be == 10
+    losail_circuit.longest_straight.should be == '1068m'
+    losail_circuit.constructed.should be == Date.new(2004, 1, 1)
+    losail_circuit.modified.should be == Date.new(2004, 1, 1)
+  end
+
+  it "should persist into cartodb using the static create method" do
+    losail_circuit = MotoGPCircuit.create new_losail_circuit_attributes
+
+    record = CartoDB::Connection.row 'moto_gp_circuit', losail_circuit.cartodb_id
+    record.cartodb_id.should             be == 1
+    record.name.should             be == 'Losail Circuit'
+    record.description.should      match /The fabulous Losail International Circuit lies/
+    record.latitude.should         be == 25.488840
+    record.longitude.should        be == 51.453352
+    record.length.should           be == '5380m'
+    record.width.should            be == '12m'
+    record.left_corners.should     be == 6
+    record.right_corners.should    be == 10
+    record.longest_straight.should be == '1068m'
+    record.constructed.should be == Date.new(2004, 1, 1)
+    record.modified.should    be == Date.new(2004, 1, 1)
+
+    losail_circuit.cartodb_id.should be == 1
+    losail_circuit.name.should be == 'Losail Circuit'
+    losail_circuit.description.should be == 'The fabulous Losail International Circuit lies on the outskirts of Doha, the capital city of Qatar. Built in little over a year, the track cost $58 million USD and required round-the-clock dedication from almost 1,000 workers in order to get it ready for the inaugural event - the Marlboro Grand Prix of Qatar on the 2nd October 2004.'
+    losail_circuit.latitude.should be == 25.488840
+    losail_circuit.longitude.should be == 51.453352
+    losail_circuit.length.should be == '5380m'
+    losail_circuit.width.should be == '12m'
+    losail_circuit.left_corners.should be == 6
+    losail_circuit.right_corners.should be == 10
+    losail_circuit.longest_straight.should be == '1068m'
+    losail_circuit.constructed.should be == Date.new(2004, 1, 1)
+    losail_circuit.modified.should be == Date.new(2004, 1, 1)
+  end
+
+  it "should update an existing record" do
+    losail_circuit = MotoGPCircuit.create new_losail_circuit_attributes
+
+    losail_circuit.name = 'Prueba'
+    losail_circuit.description = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'
+    losail_circuit.latitude = 40.582394
+    losail_circuit.longitude = -3.994131
+    losail_circuit.length = '1243m'
+
+     expect {
+      losail_circuit.save
+    }.to change{CartoDB::Connection.records('moto_gp_circuit').total_rows}.by(0)
+
+
+    record = CartoDB::Connection.row 'moto_gp_circuit', losail_circuit.cartodb_id
+    record.cartodb_id.should       be == 1
+    record.name.should             be == 'Prueba'
+    record.description.should      match /Lorem ipsum dolor sit amet, consectetur adipisicing elit/
+    record.latitude.should         be == 40.582394
+    record.longitude.should        be == -3.9941309999999817
+    record.length.should           be == '1243m'
+
+    losail_circuit.name.should be == 'Prueba'
+    losail_circuit.description.should match /Lorem ipsum dolor sit amet, consectetur adipisicing elit/
+    losail_circuit.latitude.should be == 40.582394
+    losail_circuit.longitude.should be == -3.994131
+    losail_circuit.length.should be == '1243m'
+  end
+
+  it "should destroy a previously created record" do
+    losail_circuit = MotoGPCircuit.create new_losail_circuit_attributes
+
+     expect {
+      losail_circuit.destroy
+    }.to change{CartoDB::Connection.records('moto_gp_circuit').total_rows}.by(-1)
+
+  end
+
+end

data/spec/model/metadata_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe 'CartoDB model metadata methods' do
+
+  it "should have a valid CartoDB::Client instance as a connection object" do
+    model = MotoGPCircuit.new
+    model.connection.should_not be_nil
+    table = model.connection.create_table 'model_connection_test'
+    table.should_not be_nil
+    table.name.should be == 'model_connection_test'
+  end
+
+  it "should have a valid table name" do
+    model = MotoGPCircuit.new
+    model.table_name.should be == 'moto_gp_circuit'
+  end
+
+  it "should create the table in cartodb if it doesn't exists" do
+    model = MotoGPCircuit.new
+
+    model.cartodb_table_exists?.should be_true
+  end
+
+  it "should create a table with custom name if specified" do
+    model = CustomTableName.new
+
+    model.table_name.should be == 'my_table_with_custom_name'
+  end
+
+  it "should contain an array of columns" do
+    model = MotoGPCircuit.new
+
+    model.columns.should_not be_nil
+    model.columns.should have(13).items
+    model.columns.should include({:name => 'cartodb_id',       :type => 'number'})
+    model.columns.should include({:name => 'name',             :type => 'string'})
+    model.columns.should include({:name => 'description',      :type => 'string'})
+    model.columns.should include({:name => 'the_geom',         :type => 'geometry', :geometry_type => 'point'})
+    model.columns.should include({:name => 'created_at',       :type => 'date'})
+    model.columns.should include({:name => 'updated_at',       :type => 'date'})
+    model.columns.should include({:name => 'length',           :type => 'string'})
+    model.columns.should include({:name => 'width',            :type => 'string'})
+    model.columns.should include({:name => 'left_corners',     :type => 'number'})
+    model.columns.should include({:name => 'right_corners',    :type => 'number'})
+    model.columns.should include({:name => 'longest_straight', :type => 'string'})
+    model.columns.should include({:name => 'constructed',      :type => 'date'})
+    model.columns.should include({:name => 'modified',         :type => 'date'})
+  end
+
+  it "should add more columns if the table previously exists and doesn't have all model columns" do
+    table = CartoDB::Connection.create_table 'moto_gp_circuit'
+    table.schema.should include(["cartodb_id", "number"])
+    table.schema.should include(["name", "string"])
+    table.schema.should include(["the_geom", "geometry", "geometry", "point"])
+    table.schema.should include(["description", "string"])
+    table.schema.should include(["created_at", "date"])
+    table.schema.should include(["updated_at", "date"])
+    table.schema.should_not include(['length', 'string'])
+    table.schema.should_not include(['width','string'])
+    table.schema.should_not include(['left_corners', 'number'])
+    table.schema.should_not include(['right_corners', 'number'])
+    table.schema.should_not include(['longest_straight', 'string'])
+    table.schema.should_not include(['constructed', 'date'])
+    table.schema.should_not include(['modified', 'date'])
+
+    model = MotoGPCircuit.new
+
+    model.columns.should_not be_nil
+    model.columns.should have(13).items
+    model.columns.should include({:name => 'cartodb_id',       :type => 'number'})
+    model.columns.should include({:name => 'name',             :type => 'string'})
+    model.columns.should include({:name => 'description',      :type => 'string'})
+    model.columns.should include({:name => 'the_geom',         :type => 'geometry', :geometry_type => 'point'})
+    model.columns.should include({:name => 'created_at',       :type => 'date'})
+    model.columns.should include({:name => 'updated_at',       :type => 'date'})
+    model.columns.should include({:name => 'length',           :type => 'string'})
+    model.columns.should include({:name => 'width',            :type => 'string'})
+    model.columns.should include({:name => 'left_corners',     :type => 'number'})
+    model.columns.should include({:name => 'right_corners',    :type => 'number'})
+    model.columns.should include({:name => 'longest_straight', :type => 'string'})
+    model.columns.should include({:name => 'constructed',      :type => 'date'})
+    model.columns.should include({:name => 'modified',         :type => 'date'})
+
+  end
+
+  it "should return only data columns" do
+    columns = MotoGPCircuit.data_columns
+    columns.should_not include({:name => 'cartodb_id',       :type => 'number'})
+    columns.should_not include({:name => 'created_at',       :type => 'date'})
+    columns.should_not include({:name => 'updated_at',       :type => 'date'})
+    columns.should include({:name => 'name',             :type => 'string'})
+    columns.should include({:name => 'description',      :type => 'string'})
+    columns.should include({:name => 'the_geom',         :type => 'geometry', :geometry_type => 'point'})
+    columns.should include({:name => 'length',           :type => 'string'})
+    columns.should include({:name => 'width',            :type => 'string'})
+    columns.should include({:name => 'left_corners',     :type => 'number'})
+    columns.should include({:name => 'right_corners',    :type => 'number'})
+    columns.should include({:name => 'longest_straight', :type => 'string'})
+    columns.should include({:name => 'constructed',      :type => 'date'})
+    columns.should include({:name => 'modified',         :type => 'date'})
+
+    columns = StandardModel.data_columns
+    columns.should_not include({:name => 'cartodb_id',       :type => 'number'})
+    columns.should_not include({:name => 'created_at',       :type => 'date'})
+    columns.should_not include({:name => 'updated_at',       :type => 'date'})
+    columns.should include({:name => 'name',             :type => 'string'})
+    columns.should include({:name => 'description',      :type => 'string'})
+    columns.should include({:name => 'the_geom',         :type => 'geometry', :geometry_type => 'point'})
+  end
+
+  it "should create model with custom data types columns" do
+    columns = CustomDataTypeColumnModel.data_columns
+    columns.should include({:name => 'test', :type => 'number'})
+  end
+
+end

data/spec/model/scopes_spec.rb

@@ -0,0 +1,171 @@
+require 'spec_helper'
+
+describe 'CartoDB model scopes' do
+  it "should return all records paginated" do
+    create_random_circuits(20)
+
+    circuits = MotoGPCircuit.all
+
+    circuits.should have(10).circuits
+    circuits.first.should be_a_kind_of(MotoGPCircuit)
+    circuits.first.cartodb_id.should be == 1
+    circuits.first.name.should be == 'circuit #1'
+    circuits.first.description.should be == 'awesome circuit #1'
+    circuits.first.latitude.should be == 25.488840
+    circuits.first.longitude.should be == 51.453352
+    circuits.first.length.should be == '5380m'
+    circuits.first.width.should be == '12m'
+    circuits.first.left_corners.should be == 6
+    circuits.first.right_corners.should be == 10
+    circuits.first.longest_straight.should be == '1068m'
+    circuits.first.constructed.should be == DateTime.parse("2004-01-01").to_date
+    circuits.first.modified.should be == DateTime.parse("2004-01-01").to_date
+  end
+
+  it "should count all records" do
+    create_random_circuits(20)
+
+    MotoGPCircuit.count.should be == 20
+
+    create_random_circuit
+
+    MotoGPCircuit.count.should be == 21
+  end
+
+  it "should find a record by its id" do
+    create_random_circuits(20)
+
+    circuit = MotoGPCircuit.where(:cartodb_id => 1)
+
+    circuit.cartodb_id.should be == 1
+    circuit.name.should be == 'circuit #1'
+    circuit.description.should be == 'awesome circuit #1'
+    circuit.latitude.should be == 25.488840
+    circuit.longitude.should be == 51.453352
+    circuit.length.should be == '5380m'
+    circuit.width.should be == '12m'
+    circuit.left_corners.should be == 6
+    circuit.right_corners.should be == 10
+    circuit.longest_straight.should be == '1068m'
+    circuit.constructed.should be == DateTime.parse("2004-01-01").to_date
+    circuit.modified.should be == DateTime.parse("2004-01-01").to_date
+
+    same_circuit = MotoGPCircuit.find(1)
+
+    same_circuit.cartodb_id.should be == 1
+    same_circuit.name.should be == 'circuit #1'
+    same_circuit.description.should be == 'awesome circuit #1'
+    same_circuit.latitude.should be == 25.488840
+    same_circuit.longitude.should be == 51.453352
+    same_circuit.length.should be == '5380m'
+    same_circuit.width.should be == '12m'
+    same_circuit.left_corners.should be == 6
+    same_circuit.right_corners.should be == 10
+    same_circuit.longest_straight.should be == '1068m'
+    same_circuit.constructed.should be == DateTime.parse("2004-01-01").to_date
+    same_circuit.modified.should be == DateTime.parse("2004-01-01").to_date
+  end
+
+  it "should search records by certain filters" do
+
+    new_circuit(:name => 'Losail circuit',       :left_corners => 6, :right_corners => 10).save
+    new_circuit(:name => 'Jerez',                :left_corners => 5, :right_corners => 8).save
+    new_circuit(:name => 'Estoril',              :left_corners => 4, :right_corners => 9).save
+    new_circuit(:name => 'Lemans',               :left_corners => 4, :right_corners => 9).save
+    new_circuit(:name => 'Circuit de Catalunya', :left_corners => 5, :right_corners => 8).save
+
+    circuits = MotoGPCircuit.where(:left_corners => 4).where(:right_corners => 9)
+
+    circuits.should have(2).circuits
+    circuits.first.name.should be == 'Estoril'
+    circuits.last.name.should be == 'Lemans'
+    circuits.all.should have(2).circuits
+    circuits.all.first.name.should be == 'Estoril'
+    circuits.all.last.name.should be == 'Lemans'
+
+    circuits = MotoGPCircuit.where("left_corners = ?", 4).where("right_corners = ?", 9)
+
+    circuits.should have(2).circuits
+    circuits.first.name.should be == 'Estoril'
+    circuits.last.name.should be == 'Lemans'
+    circuits.all.should have(2).circuits
+    circuits.all.first.name.should be == 'Estoril'
+    circuits.all.last.name.should be == 'Lemans'
+  end
+
+  it "should paginate results" do
+    create_random_circuits(20)
+
+    circuits = MotoGPCircuit.page(1)
+
+    circuits.should have(10).circuits
+    circuits.first.cartodb_id.should be == 1
+    circuits.last.cartodb_id.should be == 10
+
+    circuits = MotoGPCircuit.page(2)
+
+    circuits.should have(10).circuits
+    circuits.first.cartodb_id.should be == 11
+    circuits.last.cartodb_id.should be == 20
+
+    circuits = MotoGPCircuit.page(1).per_page(20)
+
+    circuits.should have(20).circuits
+    circuits.first.cartodb_id.should be == 1
+    circuits.last.cartodb_id.should be == 20
+
+    circuits = MotoGPCircuit.where('CARTODB_ID > 0').page(1).per_page(20)
+
+    circuits.should have(20).circuits
+    circuits.first.cartodb_id.should be == 1
+    circuits.last.cartodb_id.should be == 20
+  end
+
+  it "should order results" do
+    create_random_circuits(20)
+
+    circuits = MotoGPCircuit.order('CARTODB_ID DESC')
+
+    circuits.should have(10).circuits
+    circuits.first.cartodb_id.should be == 20
+    circuits.last.cartodb_id.should be == 11
+  end
+
+  it "should allow to select the specified fiels" do
+    create_random_circuits(20)
+
+    circuits = MotoGPCircuit.select('cartodb_id, name').where('cartodb_id <= 10')
+
+    circuits.should have(10).circuits
+    circuits.first.cartodb_id.should be == 1
+    circuits.first.name.should be == 'circuit #1'
+    circuits.first.description.should be_nil
+    circuits.first.latitude.should be_nil
+    circuits.first.longitude.should be_nil
+    circuits.first.length.should be_nil
+    circuits.first.width.should be_nil
+    circuits.first.left_corners.should be_nil
+    circuits.first.right_corners.should be_nil
+    circuits.first.longest_straight.should be_nil
+    circuits.first.constructed.should be_nil
+    circuits.first.modified.should be_nil
+
+    circuits = MotoGPCircuit.select(:cartodb_id, :name).where('cartodb_id <= 10')
+
+    circuits.should have(10).circuits
+    circuits.first.cartodb_id.should be == 1
+    circuits.first.name.should be == 'circuit #1'
+    circuits.first.description.should be_nil
+    circuits.first.latitude.should be_nil
+    circuits.first.longitude.should be_nil
+    circuits.first.length.should be_nil
+    circuits.first.width.should be_nil
+    circuits.first.left_corners.should be_nil
+    circuits.first.right_corners.should be_nil
+    circuits.first.longest_straight.should be_nil
+    circuits.first.constructed.should be_nil
+    circuits.first.modified.should be_nil
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'yaml'
+require 'cartodb-rb-client'
+require 'cartodb-rb-client/cartodb'
+require 'active_support/core_ext/array/random_access.rb'
+
+CartoDB::Settings = YAML.load_file("#{File.dirname(__FILE__)}/support/cartodb_config.yml") unless defined? CartoDB::Settings
+CartoDB::Connection = CartoDB::Client::Connection::Base.new unless defined? CartoDB::Connection
+# CartoDB::Settings = YAML.load_file("#{File.dirname(__FILE__)}/support/database.yml") unless defined? CartoDB::Settings
+# CartoDB::Connection = CartoDB::Client::Connection::Base.new unless defined? CartoDB::Connection
+
+RgeoFactory = ::RGeo::Geographic.spherical_factory(:srid => 4326)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:each) do
+    drop_all_cartodb_tables
+  end
+
+  config.after(:all) do
+    drop_all_cartodb_tables
+  end
+end

data/spec/support/cartodb_config.yml

@@ -0,0 +1,15 @@
+#############################
+# CartoDB Credentials
+#############################
+host: https://cartodb-rb-client.cartodb.com
+oauth_key: 0gRpcgKQK8bpcvSzM5ED4NqaSbNQ8ivS4q0pVdJF
+oauth_secret: gE01QAOqvfTYuH9QcOZmToGtiLy8j99njENTazie
+oauth_access_token: QLcGdmRFgVq2kybk5I97Wc4zj855LgoqUUub4QYr
+oauth_access_token_secret: zHizyBxrUsTn2tu03C9Lkx4KFtPcbjvnPT3kQjQ7
+# username: cartodb-rb-client
+# password: cartodb-rb-client
+
+# cache_timeout: 60
+# debug: true
+# ssl_peer_verification: true
+# type_casting: true

data/spec/support/cartodb_factories.rb

@@ -0,0 +1,33 @@
+module Factories
+  def new_circuit(values = {})
+    defaults = new_losail_circuit_attributes
+    defaults = defaults.merge(values)
+    MotoGPCircuit.new defaults
+  end
+
+  def create_random_circuits(ammount = 1)
+    ammount.times do |i|
+      new_circuit(:name => "circuit ##{i + 1}", :description => "awesome circuit ##{i + 1}").save
+    end
+  end
+
+  alias create_random_circuit create_random_circuits
+
+  def new_losail_circuit_attributes
+    {
+      :name             => 'Losail Circuit',
+      :description      => 'The fabulous Losail International Circuit lies on the outskirts of Doha, the capital city of Qatar. Built in little over a year, the track cost $58 million USD and required round-the-clock dedication from almost 1,000 workers in order to get it ready for the inaugural event - the Marlboro Grand Prix of Qatar on the 2nd October 2004.',
+      :latitude         => 25.488840,
+      :longitude        => 51.453352,
+      :length           => '5380m',
+      :width            => '12m',
+      :left_corners     => 6,
+      :right_corners    => 10,
+      :longest_straight => '1068m',
+      :constructed      => Date.new(2004, 1, 1),
+      :modified         => Date.new(2004, 1, 1)
+    }
+  end
+end
+
+RSpec.configure{ include Factories }

data/spec/support/cartodb_helpers.rb

@@ -0,0 +1,14 @@
+module CartodbHelpers
+
+  def drop_all_cartodb_tables
+    return unless CartoDB::Connection
+
+    tables_list = CartoDB::Connection.tables || []
+
+    tables_list.tables.each do |table|
+      CartoDB::Connection.drop_table(table.name) if table && table.name
+    end
+  end
+
+end
+RSpec.configuration.include CartodbHelpers

data/spec/support/cartodb_models.rb

@@ -0,0 +1,22 @@
+class MotoGPCircuit < CartoDB::Model::Base
+  field :name
+  field :description
+  field :length
+  field :width
+  field :longest_straight
+  field :left_corners,  :type => Integer
+  field :right_corners, :type => Integer
+  field :constructed,   :type => Date
+  field :modified,      :type => Date
+end
+
+class StandardModel < CartoDB::Model::Base
+end
+
+class CustomTableName < CartoDB::Model::Base
+  cartodb_table_name 'my_table_with_custom_name'
+end
+
+class CustomDataTypeColumnModel < CartoDB::Model::Base
+  field :test, :type => 'integer'
+end

data/spec/support/database.yml

@@ -0,0 +1,5 @@
+host: localhost
+port: 5432
+user: postgres
+password:
+database: cartodb-rb-client