cartomodel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5c3063fdba6f802ecad416c4028764171507277
+  data.tar.gz: 385944e4e94f45ffbb272a0898ca5af535ae520b
+SHA512:
+  metadata.gz: 74e38bac4b0d5f436958b391b288478ba730bfbaf205fbfbe8664d47b4d093c469c6f996c16c5454dab799ac549b0ce56a55c263a62e4b831be97d17f022042f
+  data.tar.gz: 09262f7ccb56f3785daae85436f72a7ba6242affc83448e2699871d9b17237a5f3bfb413a771222fae306e3f0b22288912d3fac950d57cc957e0aabbdd09b0cc

data/README.md

@@ -0,0 +1,39 @@
+# Cartomodel
+
+[![Build Status](https://travis-ci.org/Vizzuality/cartomodel.svg?branch=master)](https://travis-ci.org/Vizzuality/cartomodel)
+
+ActiveRecord integration for Cartowrap gem
+
+Currently happy case based, not very configurable
+
+PRs are welcome ;)
+
+# Usage
+
+This gem integrates [Cartowrap](https://github.com/tiagojsag/cartowrap) with ActiveRecord.
+Before using, follow the configuration instructions of Cartowrap.
+
+You must manually configure your CartoDB account, create the table and ensure that the structure matches
+
+Once that is done, configure your local model like so:
+
+```
+class YourModelClass < ApplicationRecord
+  include Cartomodel::Model::Synchronizable
+
+  def cartodb_table
+    'indicator_config'
+  end
+end
+```
+
+Make sure that your model has the two following columns:
+
+```
+class AddCartomodelColumnsYourModel < ActiveRecord::Migration
+  def change
+    add_column :indicator_configs, :cartodb_id, :integer
+    add_column :indicator_configs, :sync_state, :integer
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec'
+end

data/lib/cartomodel/errors.rb

@@ -0,0 +1,5 @@
+module Cartomodel
+
+  class CartomodelError < StandardError; end
+
+end

data/lib/cartomodel/models/synchronizable.rb

@@ -0,0 +1,101 @@
+module Cartomodel
+  module Model
+    module Synchronizable
+      extend ActiveSupport::Concern
+
+      STATE_UNSYNCED = 0
+      STATE_SYNCED = 1
+      STATE_FAILED = 2
+
+      def initialize(*args, &block)
+        @api_endpoint = Cartowrap::API.new()
+        super
+      end
+
+      def create_on_cartodb
+        prepare_dependencies
+
+        self.sync_state == STATE_UNSYNCED
+
+        attributes = prepare_attributes
+
+        query = @query_generator.insert(attributes)
+        begin
+          response = @api_endpoint.send_query(query)
+          json = ActiveSupport::JSON.decode(response)
+          self.cartodb_id = json['rows'].first['cartodb_id']
+          self.sync_state = STATE_SYNCED
+        rescue
+          self.sync_state = STATE_FAILED
+        end
+      end
+
+      def update_on_cartodb
+        prepare_dependencies
+
+        self.sync_state == STATE_UNSYNCED
+
+        attributes = prepare_attributes
+
+        query = @query_generator.update(attributes, :cartodb_id, self.cartodb_id)
+        begin
+          response = @api_endpoint.send_query(query)
+          json = ActiveSupport::JSON.decode(response)
+          self.cartodb_id = json['rows'].first['cartodb_id']
+          self.sync_state = STATE_SYNCED
+        rescue
+          self.sync_state = STATE_FAILED
+        end
+      end
+
+      def delete_on_cartodb
+        prepare_dependencies
+
+        query = @query_generator.delete(:cartodb_id, self.cartodb_id)
+        @api_endpoint.send_query(query)
+      end
+
+      def self.included(base)
+        unless base.ancestors.include? ActiveRecord::Base
+          raise RuntimeError.new('Cartomodel::Synchronizable can only extend ActiveRecord instances')
+        end
+
+        unless base.new.attributes.include? 'cartodb_id' and base.new.attributes.include? 'sync_state'
+          raise RuntimeError.new('Cartomodel::Synchronizable requires \'cartodb_id\' and \'sync_state\' attributes')
+        end
+
+        base.before_create :create_on_cartodb
+        base.before_update :update_on_cartodb
+        base.before_destroy :delete_on_cartodb
+      end
+
+      private
+
+      def prepare_dependencies
+        unless self.respond_to? :cartodb_table
+          raise RuntimeError.new('CartoDB table name not defined')
+        end
+
+        if cartodb_table.nil?
+          raise RuntimeError.new('CartoDB table name not defined')
+        end
+
+        if @query_generator.nil?
+          @query_generator = Cartomodel::QueryGenerator.new(cartodb_table)
+        end
+
+        if @api_endpoint.nil?
+          @api_endpoint = Cartowrap::API.new()
+        end
+      end
+
+      def prepare_attributes
+        attributes = self.attributes.dup
+        attributes.delete('id')
+        attributes.delete('sync_state')
+        attributes.delete('cartodb_id')
+        attributes
+      end
+    end
+  end
+end

data/lib/cartomodel/query_generator.rb

@@ -0,0 +1,45 @@
+module Cartomodel
+  class QueryGenerator
+    def initialize(table_name)
+      @table_name = table_name
+      @table = Arel::Table.new(@table_name)
+    end
+
+    def insert(raw_values)
+      manager = Arel::InsertManager.new()
+      manager.into @table
+      values = []
+
+      raw_values.each do |key, value|
+        values << [@table[key], value]
+      end
+
+      manager.insert(values)
+      manager.to_sql + ' RETURNING cartodb_id'
+    end
+
+    def update(raw_values, id_column, id_value)
+      values = []
+
+      raw_values.each do |key, value|
+        values << [@table[key], value]
+      end
+
+      manager = Arel::UpdateManager.new
+      manager.table @table
+      manager.where @table[id_column].eq(id_value)
+      manager.set values
+      return manager.to_sql
+    end
+
+    def delete(id_column, id_value)
+      manager = Arel::DeleteManager.new
+      manager.from @table
+
+      manager.where @table[id_column].eq(id_value)
+
+      return manager.to_sql
+    end
+
+  end
+end

data/lib/cartomodel/version.rb

@@ -0,0 +1,3 @@
+module Cartomodel
+  VERSION = "0.1.0"
+end

data/lib/cartomodel.rb

@@ -0,0 +1,9 @@
+require 'active_support/concern'
+require 'active_record'
+require 'cartomodel/version'
+require 'cartomodel/models/synchronizable'
+require 'cartomodel/query_generator'
+require 'cartowrap'
+
+module Cartomodel
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: cartomodel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiago Garcia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  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: sqlite3
+  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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.beta3
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: cartowrap
+  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'
+description: CartoDB sync for ActiveRecord objects
+email:
+- tiagojsag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/cartomodel.rb
+- lib/cartomodel/errors.rb
+- lib/cartomodel/models/synchronizable.rb
+- lib/cartomodel/query_generator.rb
+- lib/cartomodel/version.rb
+homepage: http://vizzuality.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: CartoDB sync for ActiveRecord objects
+test_files: []