aerospike-store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7042ab719791c2fe5b0b99c2531716163ada501
+  data.tar.gz: a1861287865bdc253a836ad10bf8663576785361
+SHA512:
+  metadata.gz: a1b256807709757406b8f77c56a63c261f06e8c59a5aeb9d3f5a2747c326de78a7db132150fa34b138141cb5423304f5d2ee3baae86479f22d2ed682095360d1
+  data.tar.gz: 3bbffa3638eb75d9138b0eff6f8ee588b6833491962190ce3f9c890203940ed8a67584809079e06c56ea878b33db30b5726f64904fd9b4fb5f7c3e168b8269ee

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Amir Rahimi Farahani
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,173 @@
+# Aerospike::Store
+
+Use Aerospike as cache store and/or session store for Rails.
+Aerospike easily scales up and besides RAM it also supports SSD for persistency in a highly optimized architecture.
+Find out more about [Aerospike](http://www.aerospike.com)
+
+## Dependencies
+
+[Aerospike Ruby Client](https://github.com/aerospike/aerospike-client-ruby)
+
+This gem will be installed using `bundle`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aerospike-store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aerospike-store
+
+## Usage
+
+### Session Store
+
+Add this line to your `config/initializers/session_store.rb`:
+
+```ruby
+YourAppName::Application.config.session_store :aerospike_store
+```
+
+It is possible to pass aerospike config options here. Defaults are:
+
+```ruby
+AppName::Application.config.session_store :aerospike_store,
+		:host => "127.0.0.1",
+		:port => 3000,
+		:ns => "test",
+		:set => "session",
+		:bin => "data"
+```
+
+Or send in a custom client instance:
+
+```ruby
+YourAppName::Application.config.session_store :aerospike_store,
+		:client => Aerospike::Client.new("127.0.0.1", 3000)
+```
+
+Supported data types are:
+- Integer
+- String
+- List
+- Hash
+
+Storing other data types requires serialization.
+
+#### Sample code
+
+```ruby
+session[:user_id] ||= 42
+session[:user_id] += 1
+session[:numbers] = [1, 3, 5, 6]
+session[:user] = {'title' => 'Amir', 'user_group' => 'root'}
+session[:map_list_mix] = [{'r' => 220, 'g' => 0, 'b' => 80}, {'r' => 100, 'g' => 255, 'b' => 25}] 
+session[:instance] = Marshal.dump(myInstance)
+```
+
+### Cache Store
+
+Add this line to your `config/application.rb`:
+
+```ruby
+config.cache_store = :aerospike_store
+```
+
+It is possible to pass aerospike config options here. Defaults are:
+
+```ruby
+config.cache_store = :aerospike_store,
+		:host => "127.0.0.1",
+                :port => 3000,
+                :ns => "test",
+                :set => "cache",
+                :bin => "entry"
+```
+
+Or send in a custom client instance:
+
+```ruby
+config.cache_store = :aerospike_store,
+		:client => Aerospike::Client.new("127.0.0.1", 3000)
+```
+
+#### Supported options
+- :expires_in
+- :raw
+- :unless_exist
+- Aerospike policies
+
+#### Supported functions
+- increment
+- decrement
+
+#### Sample code
+```ruby
+Rails.cache.read('message')   # => nil
+Rails.cache.write('message', "Aerospike is great!")
+@message = Rails.cache.read('message')    # => "Aerospike is great!"
+```
+
+Using fetch:
+```ruby
+@message = Rails.cache.fetch('LongProcess', :expires_in => 30) {
+	sleep (3) # waste some time!
+	"Processed in 3 seconds!"
+}
+```
+
+`increment` and `decrement` functions only work with `:raw` data:
+```ruby
+Rails.cache.write('hits', 0, {:raw => true, :unless_exist => true})
+Rails.cache.increment('hits', 10)
+Rails.cache.decrement('hits')
+hits = Rails.cache.read('hits', {:raw => true})
+```
+
+*Fragment caching:*
+Enable in `config/environments/development.rb`:
+```ruby
+  config.action_controller.perform_caching = true
+```
+
+Inside a view:
+```ruby
+<% cache("RecentPosts", :expires_in => 30) do %>
+    <% sleep(3) # waste some time! %>
+    <h1> Recent Posts</h1>
+    <ul>
+    	<li>post 234</li>
+    	<li>post 235</li>
+    </ul>
+<% end %>
+```
+
+It is also possible to create and use an AerospikeStore cache instance:
+```ruby
+cache = ActiveSupport::Cache::AerospikeStore.new
+@message = cache.read('message')
+```
+
+
+## Single-Bin
+By default an Aerospike namespace supports multiple `bins` per key. As both cache store and session store only use a single bin for stroing data, it is recommended to to enable `single-bin` option in namespace configuration for higher performance.
+
+## Contributing
+
+1. Fork it ( https://github.com/amirrf/aerospike-store-rails/fork )
+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 a new Pull Request
+
+## License
+
+The Aerospike Ruby Client is made available under the terms of the Apache License, Version 2, as stated in the file `LICENSE`.

data/lib/action_dispatch/middleware/session/aerospike_store.rb

@@ -0,0 +1,67 @@
+require 'active_support/cache'
+require 'action_dispatch/middleware/session/abstract_store'
+require 'aerospike'
+
+module ActionDispatch
+	module Session
+		class AerospikeStore < AbstractStore
+
+	    AEROSPIKE_DEFAULT_OPTIONS = {
+	      :host => '127.0.0.1',
+	      :port => 3000,
+	      :ns   => 'test',
+	      :set  => 'session',
+	      :bin  => 'data'
+	    }
+
+			def initialize(app, options = {})
+	      options.merge!(self.class::AEROSPIKE_DEFAULT_OPTIONS) { |key, v1, v2| v1 }
+	      @client = options.delete(:client) || Aerospike::Client.new(options.delete(:host), options.delete(:port))
+				super
+			end
+
+		  private
+
+			def generate_sid
+				loop do
+					sid = super
+					break sid unless @client.exists(as_key(sid))
+				end
+			end
+
+			def internal_get_session(sid)
+				record = @client.get(as_key(sid))
+				if record 
+					# single-bin namespaces do not return a bin name
+					(record.bins.length == 1)? record.bins.values.first : record.bins[@default_options[:bin]]
+				else
+					nil
+				end
+			end
+
+			def get_session(env, sid)
+				unless sid and session = internal_get_session(sid)
+					sid, session = generate_sid, {}
+				end
+				[sid, session]
+			end
+
+			def set_session(env, sid, session, options)
+				opt = {:send_key => false}
+				opt[:expiration] = options[:expire_after] if options[:expire_after]
+				@client.put(as_key(sid), Aerospike::Bin.new(@default_options[:bin], session), opt)
+				sid
+			end
+
+			def destroy_session(env, sid, options)
+				@client.delete(as_key(sid))
+				generate_sid unless options[:drop]
+			end
+
+			def as_key(sid)
+				Aerospike::Key.new(@default_options[:ns], @default_options[:set], sid)
+			end
+		
+		end # class AerospikeStore
+	end
+end

data/lib/active_support/cache/aerospike_store.rb

@@ -0,0 +1,81 @@
+require 'aerospike'
+require 'active_support'
+
+module ActiveSupport
+  module Cache
+    class AerospikeStore < Store
+
+    AEROSPIKE_DEFAULT_OPTIONS = {
+      :host => '127.0.0.1',
+      :port => 3000,
+      :ns   => 'test',
+      :set  => 'cache',
+      :bin  => 'entry'
+    }
+
+    def initialize(options = {})
+      options.merge!(self.class::AEROSPIKE_DEFAULT_OPTIONS) { |key, v1, v2| v1 }
+      @client = options.delete(:client) || Aerospike::Client.new(options.delete(:host), options.delete(:port))
+      super
+    end
+
+    def increment(name, amount = 1, options = nil)
+      options = merged_options(options)
+      instrument(:increment, name, :amount => amount) do
+        key = namespaced_key(name, options)
+        @client.add(as_key(key, options), {options[:bin] => amount}, options)
+      end
+    end
+
+    def decrement(name, amount = 1, options = nil)
+      options = merged_options(options)
+      instrument(:decrement, name, :amount => amount) do
+        key = namespaced_key(name, options)
+        @client.add(as_key(key, options), {options[:bin] => -1 * amount}, options)
+      end
+    end
+
+    protected
+      def internal_read_entry(key, options)
+        record = @client.get(as_key(key, options))
+        if record 
+          # single-bin namespaces do not return a bin name
+          (record.bins.length == 1)? record.bins.values.first : record.bins[options[:bin]]
+        else
+          nil
+        end
+      end
+
+      def read_entry(key, options)
+        if value = internal_read_entry(key, options)
+          # if it is not raw it is a marshalled ActiveSupport::Cache::Entry
+          value = options[:raw]? ActiveSupport::Cache::Entry.new(value) : Marshal.load(value)
+        else
+          nil
+        end
+      end
+
+      def write_entry(key, entry, options)
+        options[:expiration] ||= options[:expires_in] if options[:expires_in]
+        options[:record_exists_action] ||= options[:unless_exist]? Aerospike::RecordExistsAction::CREATE_ONLY : Aerospike::RecordExistsAction::REPLACE
+        value = options[:raw]? entry.value : Marshal.dump(entry)
+        begin
+          @client.put(as_key(key, options), {options[:bin] => value}, options)
+        rescue Aerospike::Exceptions::Aerospike => e
+          raise unless (e.result_code == Aerospike::ResultCode::KEY_EXISTS_ERROR)
+          false
+        end
+      end
+
+      def delete_entry(key, options)
+        @client.delete(as_key(key, options))
+      end
+
+    private
+      def as_key(key, options)
+        Aerospike::Key.new(options[:ns], options[:set], key)
+      end
+
+    end # class AerospikeStore
+  end
+end

data/lib/aerospike/store.rb

@@ -0,0 +1,9 @@
+require "aerospike/store/version"
+require 'active_support/cache/aerospike_store'
+require 'action_dispatch/middleware/session/aerospike_store'
+
+module Aerospike
+  module Store
+    
+  end
+end

data/lib/aerospike/store/version.rb

@@ -0,0 +1,5 @@
+module Aerospike
+  module Store
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: aerospike-store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amir Rahimi Farahani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: aerospike
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: A session store and a cache store backed by Aerospike for Rails.
+email:
+- amirrf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/action_dispatch/middleware/session/aerospike_store.rb
+- lib/active_support/cache/aerospike_store.rb
+- lib/aerospike/store.rb
+- lib/aerospike/store/version.rb
+homepage: https://github.com/amirrf/aerospike-store-rails
+licenses:
+- Apache2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Aerospike Session and Cache stores for Ruby on Rails
+test_files: []