extendi-cassandra_object 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b77415cb2c51774f219ad7ea643874e4186f1f22
+  data.tar.gz: 12ee0bc7d6a6f32e2649643966ebd76bd5aa89d3
+SHA512:
+  metadata.gz: 5ebe0edf6aca769e39f7cfbf226ebad99aa7cd9d1d26d4d311fce86d530276d050bfe277a71627d1d1a9e8cce1570823668a646ea1aa8e51e40d88e9ee00f974
+  data.tar.gz: 1d291cc9b6e5c1c34020effa7372fb11787dfac4aab5c02cc5c8110569c1015cb3bbd7551d207da2a6510c0389ecaef870ecbfe8db78861bcc7434b48e071ee8

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+*.gem
+.idea
+.byebug_history
+.ruby-version

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.0
+env:
+  - CASSANDRA_VERSION=2.1.2
+  - CASSANDRA_VERSION=3.0.10
+  - CASSANDRA_VERSION=3.9
+
+jdk:
+  - oraclejdk8
+
+before_install:
+  - sudo apt-get install libjna-java
+  - sudo apt-get install python-support
+  - sudo easy_install pyYaml
+  - sudo easy_install pip
+  - sudo pip install ccm
+
+install:
+  - ccm create -n 1 -v $CASSANDRA_VERSION -i 127.0.0. -s -b test-cluster
+  - ccm start
+  - bundle install

data/Gemfile

@@ -0,0 +1,17 @@
+source 'http://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'thin'
+
+group :test do
+  gem 'rails'
+  gem 'mocha', require: false
+  gem 'snappy'
+  gem 'lz4-ruby'
+  gem 'byebug'
+end
+
+group :cassandra do
+  gem 'cassandra-driver'
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2009 Koziarski Software Ltd
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [Michael Koziarski]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,177 @@
+# Cassandra Object
+[![Build Status](https://secure.travis-ci.org/giovannelli/cassandra_object.png)](http://travis-ci.org/giovannelli/cassandra_object) [![Code Climate](https://codeclimate.com/github/giovannelli/cassandra_object/badges/gpa.svg)](https://codeclimate.com/github/giovannelli/cassandra_object)
+
+Cassandra Object uses ActiveModel to mimic much of the behavior in ActiveRecord. 
+Use cql3 provided by ruby-driver gem and uses the old thrift structure with the possible option at [this link](https://docs.datastax.com/en/cql/3.1/cql/cql_reference/create_table_r.html?hl=create%2Ctable):
+
+```shell
+
+CREATE TABLE keyspace.table (
+    key text,
+    column1 text,
+    value blob,
+    PRIMARY KEY (key, column1)
+) WITH 
+    COMPACT STORAGE
+    AND CLUSTERING ORDER BY (column1 ASC)
+    AND bloom_filter_fp_chance = 0.001
+    AND caching = '{"keys":"ALL", "rows_per_partition":"NONE"}'
+    AND comment = ''
+    AND compaction = {'min_sstable_size': '52428800', 'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy'}
+    AND compression = {'chunk_length_kb': '64', 'sstable_compression': 'org.apache.cassandra.io.compress.LZ4Compressor'}
+    AND dclocal_read_repair_chance = 0.0
+    AND default_time_to_live = 0
+    AND gc_grace_seconds = 864000
+    AND max_index_interval = 2048
+    AND memtable_flush_period_in_ms = 0
+    AND min_index_interval = 128
+    AND read_repair_chance = 1.0
+    AND speculative_retry = 'NONE';
+```
+
+You can also use the a custom schema structure with the possible options at [this link](https://docs.datastax.com/en/cql/3.3/cql/cql_reference/cqlCreateTable.html#tabProp):
+
+```shell
+
+CREATE TABLE keyspace.table (
+    key text,
+    field1 text,
+    field2 varchar,
+    field3 float,
+    PRIMARY KEY (key)
+) WITH 
+    bloom_filter_fp_chance = 0.001
+    AND caching = {'keys':'ALL', 'rows_per_partition':'NONE'}'
+    AND comment = ''
+    AND compaction = {'min_sstable_size': '52428800', 'class': 'org.apache.cassandra.db.compaction.SizeTieredCompactionStrategy'}
+    AND compression = {'chunk_length_kb': '64', 'sstable_compression': 'org.apache.cassandra.io.compress.LZ4Compressor'}
+    AND dclocal_read_repair_chance = 0.0
+    AND default_time_to_live = 0
+    AND gc_grace_seconds = 864000
+    AND max_index_interval = 2048
+    AND memtable_flush_period_in_ms = 0
+    AND min_index_interval = 128
+    AND read_repair_chance = 1.0
+    AND speculative_retry = 'NONE';
+```
+
+## Installation
+
+Add the following to your Gemfile:
+```ruby
+gem 'extendi-cassandra_object'
+```
+
+Change the version of Cassandra accordingly. Recent versions have not been backward compatible.
+
+## Defining Models
+
+Schemaless model:
+```ruby
+class Widget < CassandraObject::BaseSchemaless
+  string :name
+  string :description
+  integer :price
+  array :colors, unique: true
+
+  validates :name, presence: :true
+
+  before_create do
+    self.description = "#{name} is the best product ever"
+  end
+end
+```
+
+Schemaless with dynamic attributes model:
+```ruby
+class Widget < CassandraObject::BaseSchemalessDynamic
+  string :name
+  string :description
+  integer :price
+  array :colors, unique: true
+
+  validates :name, presence: :true
+
+  before_create do
+    self.description = "#{name} is the best product ever"
+  end
+end
+```
+
+Schema model:
+```ruby
+class Widget < CassandraObject::BaseSchema
+  string :name
+  string :description
+  integer :price
+  array :colors, unique: true
+
+  validates :name, presence: :true
+
+  before_create do
+    self.description = "#{name} is the best product ever"
+  end
+end
+```
+## Using with Cassandra
+  
+Add a config/cassandra.yml:
+
+```yaml
+development:
+  keyspace: my_app_development
+  hosts: ["127.0.0.1"]
+  compression: :lz4,
+  connect_timeout: 0.1,
+  request_timeout: 0.1,
+  consistency: :any/:one/:two/:three/:quorum/:all/:local_quorum/:each_quorum/:serial/:local_serial/:local_one,
+  protocol_version: 3,
+  page_size: 10000,
+  trace: true/false
+```
+
+## Creating and updating records
+
+Cassandra Object has equivalent methods as ActiveRecord:
+
+```ruby
+widget = Widget.new
+widget.valid?
+widget = Widget.create(name: 'Acme', price: 100)
+widget.update_attribute(:price, 1200)
+widget.update_attributes(price: 1200, name: 'Acme Corporation')
+widget.attributes = {price: 300}
+widget.price_was
+widget.save
+widget.save!
+```
+
+## Finding records
+
+```ruby
+  widget = Widget.find(uuid)
+  widget = Widget.first
+  widgets = Widget.all
+  Widget.find_each do |widget|
+  # Codez
+end
+```
+
+## Scoping
+
+Some lightweight scoping features are available:
+```ruby
+  Widget.where(color: :red)
+  Widget.select([:name, :color])
+  Widget.limit(10)
+```
+
+## Plain response scoping
+
+cql_response return an hash where the key is the model key and values is an hash where key is the column name and the value is the column value.
+
+```ruby
+  Widget.cql_response.where(color: :red)
+  Widget.cql_response([:name, :color])
+  Widget.cql_response.limit(10)
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'rake'
+require 'rake/testtask'
+
+task default: :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/unit/**/*_test.rb'
+  t.verbose = true
+end

data/extendi-cassandra_object.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'extendi-cassandra_object'
+  s.version = '1.0.0'
+  s.description = 'Cassandra ActiveModel'
+  s.summary = 'Cassandra ActiveModel'
+  s.authors = ['Duccio Giovannelli', 'gotime']
+  s.email = 'giovannelli@extendi.it'
+  s.homepage = 'https://github.com/giovannelli/cassandra_object'
+
+  s.required_ruby_version     = '>= 1.9.2'
+  s.required_rubygems_version = '>= 1.3.5'
+
+  s.extra_rdoc_files = ['README.md']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('activemodel', '>= 3.0')
+  s.add_runtime_dependency('cassandra-driver', '>= 3.1.0')
+  s.add_runtime_dependency('lz4-ruby', '>= 0.3.3')
+
+  s.platform = Gem::Platform::RUBY
+  s.add_development_dependency('bundler')
+end

data/lib/cassandra_object.rb

@@ -0,0 +1,73 @@
+require 'active_support/all'
+require 'active_model'
+require 'cassandra_object/errors'
+
+module CassandraObject
+  extend ActiveSupport::Autoload
+
+  autoload :AttributeMethods
+  autoload :Base
+  autoload :BaseSchema
+  autoload :BaseSchemaless
+  autoload :BaseSchemalessDynamic
+  autoload :BelongsTo
+  autoload :Callbacks
+  autoload :Connection
+  autoload :Core
+  autoload :Identity
+  autoload :Inspect
+  autoload :Model
+  autoload :Persistence
+  autoload :Schema
+  autoload :Schemaless
+  autoload :Scope
+  autoload :Scoping
+  autoload :Serialization
+  autoload :Timestamps
+  autoload :Type
+  autoload :Validations
+
+  module AttributeMethods
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Definition
+      autoload :Dirty
+      autoload :PrimaryKey
+      autoload :Typecasting
+    end
+  end
+
+  module Adapters
+    extend ActiveSupport::Autoload
+
+    autoload :AbstractAdapter
+    autoload :CassandraAdapter
+    autoload :CassandraSchemalessAdapter
+  end
+
+  module BelongsTo
+    extend ActiveSupport::Autoload
+
+    autoload :Association
+    autoload :Builder
+    autoload :Reflection
+  end
+
+  module Types
+    extend ActiveSupport::Autoload
+
+    autoload :BaseType
+    autoload :ArrayType
+    autoload :BooleanType
+    autoload :DateType
+    autoload :FloatType
+    autoload :IntegerType
+    autoload :JsonType
+    autoload :StringType
+    autoload :TimeType
+    autoload :TypeHelper
+  end
+end
+
+require 'cassandra_object/railtie' if defined?(Rails)

data/lib/cassandra_object/adapters/abstract_adapter.rb

@@ -0,0 +1,61 @@
+module CassandraObject
+  module Adapters
+    class AbstractAdapter
+      attr_reader :config
+      def initialize(config)
+        @config = config
+      end
+
+      # Read records from a instance of CassandraObject::Scope
+      def select(scope) # abstract
+      end
+
+      # Insert a new row
+      def insert(table, id, attributes) # abstract
+      end
+
+      # Update an existing row
+      def update(table, id, attributes) # abstract
+      end
+
+      # Delete rows by an array of ids
+      def delete(table, ids) # abstract
+      end
+
+      def execute_batch(statements) # abstract
+      end
+
+      def batching?
+        !@batch_statements.nil?
+      end
+
+      def batch
+        @batch_statements = []
+        yield
+        execute_batch(@batch_statements) if !@batch_statements.nil? && @batch_statements.any?
+      ensure
+        @batch_statements = nil
+      end
+
+      def statement_with_options(stmt, options)
+        if options.present?
+          with_stmt = options.split(',').map do |o|
+            "#{o}"
+          end.join(' AND ')
+
+          stmt = "#{stmt} WITH #{with_stmt}"
+        end
+        stmt
+      end
+
+      def execute_batchable(statements)
+        if defined?(@batch_statements) && @batch_statements
+          @batch_statements += statements
+        else
+          execute_batch(statements)
+        end
+      end
+    end
+
+  end
+end