virsandra 0.5.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert Crim
+
+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,93 @@
+# Virsandra [![Build Status](https://travis-ci.org/ottbot/virsandra.png)](https://travis-ci.org/ottbot/virsandra) [![Code Climate](https://codeclimate.com/github/ottbot/virsandra.png)](https://codeclimate.com/github/ottbot/virsandra) [![Dependency Status](https://gemnasium.com/ottbot/virsandra.png)](https://gemnasium.com/ottbot/virsandra) [![Coverage Status](https://coveralls.io/repos/ottbot/virsandra/badge.png?branch=master)](https://coveralls.io/r/ottbot/virsandra)
+
+The Cassandra backed models with Virtus gem with a stupid name.
+
+## Moving target
+
+Virsandra is meant to make it easy to use cassandra for persistence
+for models build with virtus.
+
+The feature set will likely remain simple, the idea is to not block
+development of other projects while the implementation of CQL changes
+quickly.
+
+## Schema yourself
+
+At this stage, you're on your own in terms of schema management. The
+gem expects you to maintain table <=> model attribute mappings
+yourself.
+
+## Example usage
+
+````ruby
+require 'virsandra'
+
+Virsandra.configure |c|
+  c.servers = "127.0.0.1:9160"
+  c.keyspace = "example_keyspace"
+end
+````
+
+To define a `Company` model backed by a table `companies` using a composite primary key of `name text, founder text`:
+````ruby
+class Company
+  include Virsandra::Model
+
+  attribute :name, String
+  attribute :founder, String
+  attribute :turnover, Fixnum
+  attribute :founded, Date
+
+  table :companies
+  key :name, :founder
+end
+````
+
+Create a company:
+````ruby
+company = Company.new(name: "Gooble",
+                      founder: "Larry Brin",
+                      turnover: 2000000,
+                      founded: 1884)
+company.save
+````
+
+Find the company by key:
+````ruby
+company = Company.find(name: "Gooble", founder: "Larry Brin")
+````
+
+Find or initialize a company. If there is a row with the same primary
+key, this will load missing attributes from cassandra and merge new
+ones.
+
+````ruby
+company = Company.load(name: "Gooble", founder: "Larry Brin", foundec: 2012)
+company.attributes
+#=> {name: "Gooble", founder: "Larry Brin", turnover: 2000000, founded: 2012}
+````
+
+Search for companies:
+````ruby
+companies = Companies.all
+
+googbles = Companies.where(name: 'Gooble')
+
+company_names = Companies.all.map(&:name)
+````
+
+## TODO / Missing
+1. Create / filter with index
+2. Model attributes that are not Cassandra columns
+3. Counters
+4. Schema creation / migration
+5. Support for
Set, List, and Map column types
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+  spec.rcov_opts = "--exclude 'spec/*'"
+end
+
+task :default => :spec

data/lib/virsandra.rb

@@ -0,0 +1,89 @@
+require 'virtus'
+require 'cql'
+require 'simple_uuid'
+require 'forwardable'
+
+
+require "virsandra/version"
+require 'virsandra/errors'
+require "virsandra/configuration"
+
+module Virsandra
+
+  class << self
+    def configuration
+      Thread.current[:configuration] ||= Virsandra::Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def connection
+      if dirty?
+        disconnect!
+        Thread.current[:connection] = Virsandra::Connection.new(configuration)
+        configuration.accept_changes
+      end
+      Thread.current[:connection]
+    end
+
+    def disconnect!
+      if Thread.current[:connection].respond_to?(:disconnect!)
+        Thread.current[:connection].disconnect!
+      end
+      Thread.current[:connection] = nil
+    end
+
+    def reset!
+      configuration.reset!
+    end
+
+    def reset_configuration!
+      Thread.current[:configuration] = nil
+    end
+
+    def consistency
+      configuration.consistency
+    end
+
+    def keyspace
+      configuration.keyspace
+    end
+
+    def servers
+      configuration.servers
+    end
+
+    def consistency=(value)
+      configuration.consistency = value
+    end
+
+    def keyspace=(value)
+      configuration.keyspace = value
+    end
+
+    def servers=(value)
+      configuration.servers = value
+    end
+
+    def execute(query)
+      connection.execute(query)
+    end
+
+    private
+
+    def dirty?
+      Thread.current[:connection].nil? || configuration.changed?
+    end
+
+  end
+end
+
+
+
+require "virsandra/connection"
+require "virsandra/cql_value"
+require "virsandra/query"
+require "virsandra/model_query"
+require "virsandra/model"

data/lib/virsandra/configuration.rb

@@ -0,0 +1,61 @@
+module Virsandra
+  class Configuration
+    OPTIONS = [
+      :consistency,
+      :keyspace,
+      :servers,
+    ].freeze
+
+    DEFAULT_OPTION_VALUES = {
+      servers: "127.0.0.1",
+      consistency: :quorum
+    }.freeze
+
+    attr_accessor *OPTIONS
+
+    def initialize(options = {})
+      reset!
+      use_options(options || {})
+      accept_changes
+    end
+
+    def reset!
+      use_options(DEFAULT_OPTION_VALUES)
+    end
+
+    def validate!
+      unless [servers, keyspace].all?
+        raise ConfigurationError.new("A keyspace and server must be defined")
+      end
+    end
+
+    def accept_changes
+      @old_hash = hash
+    end
+
+    def to_hash
+      OPTIONS.each_with_object({}) do |attr, settings|
+        settings[attr] = send(attr)
+      end
+    end
+
+    def changed?
+      hash != @old_hash
+    end
+
+    def hash
+      to_hash.hash
+    end
+
+    private
+
+    def use_options(options)
+      options.each do |key, value|
+        if OPTIONS.include?(key)
+          send(:"#{key}=", value)
+        end
+      end
+    end
+  end
+
+end

data/lib/virsandra/connection.rb

@@ -0,0 +1,39 @@
+module Virsandra
+  class Connection
+
+    extend Forwardable
+
+    attr_reader :handle, :config
+
+    def initialize(config)
+      @config = config
+      config.validate!
+      connect!
+    end
+
+    def connect!
+      @handle = Cql::Client.connect(hosts: @config.servers)
+      @handle.use(@config.keyspace)
+      @handle
+    end
+
+    def disconnect!
+      @handle.close
+    end
+
+    def execute(query, consistency = nil)
+      @handle.execute(query, consistency || config.consistency)
+    end
+
+    # Delegate to CassandraCQL::Database handle
+    def method_missing(method, *args, &block)
+      return super unless @handle.respond_to?(method)
+      @handle.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      @handle.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+end

data/lib/virsandra/cql_value.rb

@@ -0,0 +1,38 @@
+module Virsandra
+  class CQLValue
+
+    def self.convert(val)
+      new(val).to_cql
+    end
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to_cql
+      if value.respond_to?(:to_guid)
+        value.to_guid
+      elsif should_escape?(value)
+        "'#{escape(value)}'"
+      else
+        value.to_s
+      end
+    end
+
+    private
+
+    def should_escape?(value)
+      !![String, Symbol, Time, Date].detect do |klass|
+        value.is_a?(klass)
+      end
+    end
+
+    def escape(str)
+      str = str.to_s.gsub(/'/,"''")
+      str.force_encoding('ASCII-8BIT')
+    end
+
+  end
+end

data/lib/virsandra/errors.rb

@@ -0,0 +1,3 @@
+module Virsandra
+  class ConfigurationError < ArgumentError; ; end
+end

data/lib/virsandra/model.rb

@@ -0,0 +1,86 @@
+module Virsandra
+  module Model
+
+    include Virtus
+
+    def self.included(base)
+      super
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def key
+        self.class.key.reduce({}) do |key, col|
+          key[col] = attributes[col]
+          key
+        end
+      end
+
+      def table
+        self.class.table
+      end
+
+      def valid?
+        self.class.valid_key?(key)
+      end
+
+      def save
+        ModelQuery.new(self).save if valid?
+      end
+
+      def delete
+        ModelQuery.new(self).delete
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && attributes == other.attributes
+      end
+    end
+
+    module ClassMethods
+      def table(name = nil)
+        @table = name if name
+        @table
+      end
+
+      def key(*columns)
+        @key = columns unless columns.empty?
+        @key
+      end
+
+      def find(columns)
+        raise ArgumentError.new("Invalid key") unless valid_key?(columns)
+        load(columns)
+      end
+
+      def load(columns)
+        record = new(columns)
+
+        row = ModelQuery.new(record).find_by_key
+        record.attributes = row.merge(columns)
+        record
+      end
+
+      def valid_key?(columns)
+        return false if columns.length != key.length
+        key.all? {|k| !columns[k].nil? }
+      end
+
+      def attribute_names
+        attribute_set.map(&:name)
+      end
+
+      alias_method :column_names, :attribute_names
+
+      def all
+        where({})
+      end
+
+      def where(params)
+        ModelQuery.new(self).where(params)
+      end
+    end
+
+  end
+end