cassandra_archive 0.2.0

data/.gitignore

@@ -0,0 +1,10 @@
+.idea/
+*.gem
+*.rbc
+.yardoc
+_yardoc
+doc/
+pkg
+rdoc
+test/tmp
+test/version_tmp

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+gem 'activesupport', '~> 3'
+gem 'activemodel', '~> 3'
+gem 'activerecord', '~> 3'
+gem 'exception_helper'
+
+gem "cassandra", :require => 'cassandra/1.2'
+gem 'active_attr', :git => "http://github.com/backupify/active_attr.git"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+   gem "shoulda"
+   gem "factory_girl"
+   gem "bundler"
+   gem 'mocha'
+   gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GIT
+  remote: http://github.com/backupify/active_attr.git
+  revision: 69951a36e62bc348b6d2c86ce50c1251ad709e34
+  specs:
+    active_attr (0.8.2)
+      activemodel (>= 3.0.2, < 4.1)
+      activesupport (>= 3.0.2, < 4.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    cassandra (0.22.0)
+      json
+      rake
+      simple_uuid (~> 0.2.0)
+      thrift_client (~> 0.7, < 0.9)
+    exception_helper (0.1.2)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    i18n (0.6.5)
+    json (1.8.0)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.9)
+    rake (10.1.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    simple_uuid (0.2.0)
+    sqlite3 (1.3.8)
+    thrift (0.8.0)
+    thrift_client (0.8.4)
+      thrift (~> 0.8.0)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_attr!
+  activemodel (~> 3)
+  activerecord (~> 3)
+  activesupport (~> 3)
+  bundler
+  cassandra
+  exception_helper
+  factory_girl
+  mocha
+  shoulda
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Backupify
+
+MIT License
+
+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,61 @@
+# Description
+
+  The active record extension implements the archive functionality to cassandra database. After record get deleted it replicates the copy of all attributes of that object to cassandra.
+
+# Example of usage
+
+Before you start using library you need to create column family where archived records will be stored
+
+    create keyspace CassandraArchive_test;
+    create column family DeletedRecords with column_type='Super' and comparator='UTF8Type' and subcomparator='UTF8Type';
+
+initialize cassandra connection
+
+    ::CASSANDRA_CLIENT = Cassandra.new(keyspace, hosts)
+
+and include module into model you want to archive after destroying
+
+    class Service < ActiveRecord::Base
+      include CassandraArchive
+    end
+
+After you delete a record, it will be automatically replicated to cassandra in the following format
+
+    column_family will be 'DeletedRecords'
+    row_id will be the same as table name, for example above it will be 'services'
+    column_name is the removal timestamp, it looks like '1361974054666398'
+    column_attributes will contain the active record attributes
+
+The model will be extended with :archived method
+
+    Service.archived                      # returns list of all archived records for that model
+    Service.archived(:after => 3.day.ago) # returns list of archived records for last 3 days
+
+    Service.archived do |timestamp, attributes|
+      # the block is called for each archived record
+      # timestamp shows when record has been archived
+    end
+
+You may want to store the data which is not presented as active record attribute, it can be dynamic attribute or something like that. For that purpose you define :cassandra_archive_attributes method where you define the list of attributes you want to archive.
+
+    class Service < ActiveRecord::Base
+      include CassandraArchive
+
+      def cassandra_archive_attributes
+        # all active record attributes will be archived plus :account_name
+        attributes.keys + [:account_name]
+      end
+
+      def account_name
+        # the code here does request to the service in order to get account name
+      end
+    end
+
+## Running tests
+
+Before you run tests do this in cassandra-cli:
+
+    use CassandraArchive_test; # create it first if it doesn't exist
+    create column family DeletedRecords with column_type='Super' and comparator='UTF8Type' and subcomparator='UTF8Type';
+
+then run rake

data/Rakefile

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

data/cassandra_archive.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cassandra_archive/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cassandra_archive"
+  gem.version       = CassandraArchive::VERSION
+  gem.authors       = ["Alexander Litvinovsky","Jason Haruska"]
+  gem.email         = ["dev@backupify.com"]
+  gem.description   = "The library allows to archive destroyed record to cassandra. For that moment ActiveRecord is supported."
+  gem.summary       = "Archiving and retrieving records to cassandra"
+  gem.homepage      = "http://github.com/backupify/cassandra_archive"
+  gem.license       = "MIT"
+
+  gem.add_runtime_dependency("activerecord", [">= 3.0.0"])
+  gem.add_runtime_dependency("cassandra", [">= 0.12.2"])
+
+  gem.add_development_dependency('sqlite3')
+  gem.add_development_dependency('shoulda')
+  gem.add_development_dependency('mocha')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/cassandra_archive.rb

@@ -0,0 +1,62 @@
+require 'cassandra'
+require 'active_support/concern'
+
+require 'cassandra_archive/version'
+require 'cassandra_archive/helper'
+
+module CassandraArchive
+  extend ActiveSupport::Concern
+
+  included do
+    after_commit :on => :destroy do
+      archive
+    end
+  end
+
+  def archive
+    time = DateTime.current
+
+    cassandra_timestamp = Helper.timestamp(time)
+    unix_timestamp = time.to_i.to_s
+
+    cassandra_attributes = archived_attributes.merge('archived_at' => unix_timestamp)
+    ::CASSANDRA_CLIENT.insert('DeletedRecords', self.class.table_name, {cassandra_timestamp.to_s => cassandra_attributes})
+  end
+
+  def cassandra_archive_attributes
+    # return active record attributes by default
+    attributes.keys
+  end
+
+  def archived_attributes
+    cassandra_archive_attributes.inject({}) do |hash, attribute|
+      value = send(attribute).to_s
+      cassandra_encoded_value = Helper.encode_for_cassandra(value)
+      hash[attribute.to_s] = cassandra_encoded_value
+      hash
+    end
+  end
+
+  module ClassMethods
+    def archived(options = {})
+      if time = options.delete(:after)
+        options[:start] = Helper.timestamp(time).to_s
+      end
+
+      records = ::CASSANDRA_CLIENT.get('DeletedRecords', table_name, options)
+
+      # encode attributes to utf8
+      records.each_entry do |entry|
+        entry.last.keys.each do |key|
+          entry.last[key].force_encoding('UTF-8')
+        end
+      end
+
+      if block_given?
+        records.each {|key, value| yield key, value}
+      end
+
+      records
+    end
+  end
+end

data/lib/cassandra_archive/helper.rb

@@ -0,0 +1,17 @@
+module CassandraArchive
+  module Helper
+    def self.timestamp(time)
+      (time.to_f * 1_000_000).to_i
+    end
+
+    def self.encode_for_cassandra(str, opts = {})
+      encode_opts = {
+          :invalid => :replace,
+          :undef => :replace,
+          :replace => ''
+      }.merge(opts)
+
+      str.encode('UTF-8', encode_opts).force_encoding('ASCII-8BIT')
+    end
+  end
+end

data/lib/cassandra_archive/version.rb

@@ -0,0 +1,4 @@
+module CassandraArchive
+  VERSION = '0.2.0'
+end
+

data/test/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :test_models, :force => true do |t|
+    t.column :firstname, :string
+    t.column :lastname, :string
+    t.column :created_at, :timestamp
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'cassandra_archive'
+
+::CASSANDRA_CLIENT = Cassandra.new('CassandraArchive_test', %w[localhost:9160])
+
+class Test::Unit::TestCase
+  def setup
+    ::CASSANDRA_CLIENT.clear_keyspace!
+  end
+end
+
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database  => ":memory:")
+load(File.dirname(__FILE__) + "/schema.rb")
+
+# enable coverage reports for jenkins only
+if ENV['CI']
+  puts "Enabling simplecov(rcov) for jenkins"
+  require 'simplecov'
+  require 'simplecov-rcov'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start
+end

data/test/unit/cassandra_archive_test.rb

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper.rb')
+
+class TestModel < ActiveRecord::Base
+  include ::CassandraArchive
+
+  def cassandra_archive_attributes
+    [:id, :firstname, :lastname, :fullname]
+  end
+
+  def fullname
+    "#{firstname} #{lastname}"
+  end
+end
+
+class CassandraArchiveTest < Test::Unit::TestCase
+  context 'archived' do
+    setup do
+      @record = TestModel.create(:firstname => "firstname", :lastname => "lastname")
+      @record.destroy
+    end
+
+    should 'archive record to cassandra after record destroying' do
+      archived_record = find_archived_record(@record)
+
+      assert_equal @record.id.to_s, archived_record['id']
+      assert_equal @record.firstname, archived_record['firstname']
+      assert_equal @record.lastname, archived_record['lastname']
+      assert_equal @record.fullname, archived_record['fullname']
+
+      # we didn't list created_at attribute in cassandra_archive_attributes method, so it should not be archived
+      assert_equal nil, archived_record['created_at']
+    end
+
+    should 'archive record if attributes contain not ASCII chars' do
+      @record = TestModel.create(:firstname => "Иван", :lastname => "Иванов")
+      @record.destroy
+
+      archived_record = find_archived_record(@record)
+
+      assert_equal @record.id.to_s, archived_record['id']
+      assert_equal @record.firstname, archived_record['firstname']
+      assert_equal @record.lastname, archived_record['lastname']
+      assert_equal @record.fullname, archived_record['fullname']
+
+      # we didn't list created_at attribute in cassandra_archive_attributes method, so it should not be archived
+      assert_equal nil, archived_record['created_at']
+    end
+
+    should 'set archived_at attribute' do
+      time = DateTime.current
+      DateTime.stubs(:current).returns(time)
+
+      archived_at = time.to_i.to_s
+
+      record = TestModel.create(:firstname => "firstname", :lastname => "lastname")
+      record.destroy
+
+      archived_record = find_archived_record(@record)
+      assert_equal archived_at, archived_record['archived_at']
+    end
+
+    should 'return the number of archived records' do
+      assert_equal 1, TestModel.archived.size
+
+      another_record = TestModel.create(:firstname => "firstname", :lastname => "lastname")
+      another_record.destroy
+
+      assert_equal 2, TestModel.archived.size
+    end
+
+    should 'return records archived after specified date if :after option is passed as timestamp' do
+      assert_equal 1, TestModel.archived(:after => @record.created_at.to_i).size
+    end
+
+    should 'return records archived after specified date if :after option is passed via rails helper' do
+      assert_equal 1, TestModel.archived(:after => 10.seconds.ago).size
+      assert_equal 0, TestModel.archived(:after => 10.seconds.since(DateTime.current)).size
+    end
+
+    should 'go through each archived record if block passed' do
+      TestModel.archived do |timestamp, attributes|
+        assert_equal @record.id.to_s, attributes['id']
+        assert_equal @record.firstname, attributes['firstname']
+        assert_equal @record.lastname, attributes['lastname']
+        assert_equal @record.fullname, attributes['fullname']
+
+        # we didn't list created_at attribute in cassandra_archive_attributes method, so it should not be archived
+        assert_equal nil, attributes['created_at']
+      end
+    end
+  end
+
+  def find_archived_record(record)
+    # find archived record, it returns array with two elements
+    # first element is key, second is hash with attributes
+    archived_record = record.class.archived.find do |key, value|
+      value['id'] == record.id.to_s
+    end
+
+    # return record attributes
+    archived_record.last
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: cassandra_archive
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Litvinovsky
+- Jason Haruska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: activerecord
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: cassandra
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: sqlite3
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: shoulda
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: mocha
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: The library allows to archive destroyed record to cassandra. For that
+  moment ActiveRecord is supported.
+email:
+- dev@backupify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- cassandra_archive.gemspec
+- lib/cassandra_archive.rb
+- lib/cassandra_archive/helper.rb
+- lib/cassandra_archive/version.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/unit/cassandra_archive_test.rb
+homepage: http://github.com/backupify/cassandra_archive
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Archiving and retrieving records to cassandra
+test_files:
+- test/schema.rb
+- test/test_helper.rb
+- test/unit/cassandra_archive_test.rb
+has_rdoc: