twitter-redis-identitymap 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.0.1
+
+Initial commit

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kevin Fullerton
+
+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,104 @@
+twitter-redis-identitymap
+=========================
+[![Build Status](https://secure.travis-ci.org/kgfullerton/twitter-redis-identitymap.png?branch=master)][travis]
+[travis]: http://travis-ci.org/kgfullerton/twitter-redis-identitymap
+
+###	Redis IdentityMap store for sferik/twitter gem
+
+## Installation
+```sh
+gem install twitter-redis-identitymap
+```
+
+## Usage
+
+```ruby
+Twitter.configure do |config|
+  config.consumer_key = YOUR_CONSUMER_KEY
+  config.consumer_secret = YOUR_CONSUMER_SECRET
+  config.oauth_token = YOUR_OAUTH_TOKEN
+  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+	config.identity_map = TwitterRedisIdentityMap::Base
+end
+```
+
+This will use the default Redis URL (redis://localhost:6379/0)
+
+By default it uses a key namespace of tri:cache: followed by the id to store
+
+## To Do
+
+* Allow configuring Redis location and namespace
+* Allow Redis TTL expiring of keys automatically
+
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by fixing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/kgfullerton/twitter-redis-identitymap/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
+
+## Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+version:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be personally responsible for providing patches in a
+timely fashion. If critical issues for a particular implementation exist at the
+time of a major release, support for that Ruby version may be dropped.
+
+## Copyright
+Copyright (c) 2012 Kevin Fullerton.
+See [LICENSE][] for details.
+Thanks to the contributors and maintainers of the [Twitter gem][twittergem] who the tests were used from to ensure compatibility
+
+[license]: https://github.com/kgfullerton/twitter-redis-identitymap/blob/master/LICENSE.md
+[twittergem]: https://github.com/sferik/twitter

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/twitter-redis-identitymap.rb

@@ -0,0 +1 @@
+require 'twitter-redis-identitymap/base'

data/lib/twitter-redis-identitymap/base.rb

@@ -0,0 +1,33 @@
+require 'redis'
+
+module TwitterRedisIdentityMap
+	class Base
+		def initialize(options = nil)
+			raise ArgumentError if !options.nil? && !options.is_a?(Hash)
+			@options = options.nil? ? {} : options
+			@options[:namespace] = "tri:cache:" unless @options[:namespace]
+			@redis = @options[:redis].nil? ? Redis.new : Redis.new({:url => @options[:redis]})			
+		end
+
+		def fetch(id)
+			raise ArgumentError if id.nil?
+			id = Marshal.load(id)
+			object = nil
+			if @redis.exists("#{@options[:namespace]}#{id[:id]}")
+				val = @redis.get("#{@options[:namespace]}#{id[:id]}")
+				object = Marshal.load(val)
+			end
+			object			
+		end
+
+		def store(attrs, object)
+			raise ArgumentError if (attrs.nil? || object.nil?)
+			attrs = Marshal.load(attrs)
+			@redis.set("#{@options[:namespace]}#{attrs[:id]}", Marshal.dump(object)) == "OK" ? object : nil
+		end
+
+		def redis
+			@redis
+		end
+	end
+end

data/lib/twitter-redis-identitymap/version.rb

@@ -0,0 +1,14 @@
+module TwitterRedisIdentityMap
+	class Version
+		MAJOR = 0
+		MINOR = 0
+		PATCH = 1
+		PRE = nil
+
+		class << self
+			def to_s
+				[MAJOR, MINOR, PATCH, PRE].compact.join(".")
+			end
+		end
+	end
+end

data/spec/helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start do
+	add_filter 'spec'
+end
+
+require 'twitter-redis-identitymap'
+require 'twitter'

data/spec/twitter-redis-identitymap/base_spec.rb

@@ -0,0 +1,105 @@
+require 'helper'
+
+describe TwitterRedisIdentityMap::Base do
+	context "base class" do
+		before(:each) do
+			@map = TwitterRedisIdentityMap::Base.new
+		end
+
+		it "should respond_to fetch" do
+			@map.respond_to?(:fetch).should be_true
+		end
+
+		it "should respond_to store" do
+			@map.respond_to?(:store).should be_true
+		end
+
+		it "should respond_to redis" do
+			@map.respond_to?(:redis).should be_true
+		end
+	end
+
+	context "base initializer" do
+		it "should return a default redis instance with no parameters" do
+			@map = TwitterRedisIdentityMap::Base.new
+			@map.redis.should be_a(Redis)
+			@map.redis.client.location.should eq("127.0.0.1:6379")
+			@map.redis.client.db.should eq(0)
+		end
+		it "should allow connecting to a different redis instance" do
+			options = {:redis => "redis://127.0.0.1:6379/1" }
+			@map = TwitterRedisIdentityMap::Base.new(options)
+			@map.redis.client.location.should eq("127.0.0.1:6379")
+			@map.redis.client.db.should eq(1)
+		end
+	end
+
+	context "integration with Twitter::Base" do
+		before do
+			Twitter.identity_map = TwitterRedisIdentityMap::Base
+			Twitter::Base.identity_map.redis.flushdb
+			object = Twitter::Base.new(:id => 3)
+			@base = Twitter::Base.store(object)
+		end
+
+		after do
+			Twitter::Base.identity_map.redis.flushdb
+			Twitter.identity_map = nil
+		end
+
+		describe ".identity_map" do
+			it "returns an instance of the identity map" do
+				Twitter::Base.identity_map.should be_a TwitterRedisIdentityMap::Base
+			end
+		end
+
+		describe ".store" do
+			it "stores Twitter::Base objects" do
+				object = Twitter::Base.new(:id => 1)
+				Twitter::Base.identity_map.redis.exists("tri:cache:1").should eq(false)
+				Twitter::Base.store(object).should be_a(Twitter::Base)
+				Twitter::Base.identity_map.redis.exists("tri:cache:1").should eq(true)
+			end
+		end
+
+		describe ".fetch" do
+			it "returns existing objects" do
+				Twitter::Base.fetch(:id => 3).should be
+			end
+			it "raises an error on objects that don't exist" do
+				expect { Twitter::Base.fetch(:id => 999) }.to raise_error(Twitter::Error::IdentityMapKeyError)
+			end
+		end
+
+		describe ".fetch_or_new" do
+			it "returns existing objects" do
+				Twitter::Base.fetch(:id => 3).should be
+			end
+			it "creates new objects and stores them" do
+				expect { Twitter::Base.fetch(:id => 7) }.to raise_error(Twitter::Error::IdentityMapKeyError)
+				Twitter::Base.fetch_or_new(:id => 7).should be
+				Twitter::Base.fetch(:id => 7).should be
+			end
+		end
+
+		describe "#[]" do
+			it "calls methods using [] with symbol" do
+				@base[:object_id].should be_an Integer
+			end
+			it "calls methods using [] with string" do
+				@base['object_id'].should be_an Integer
+			end
+			it "returns nil for missing methods" do
+				@base[:foo].should be_nil
+				@base['foo'].should be_nil
+			end
+		end
+
+		describe "#to_hash" do
+			it "returns a hash" do
+				@base.to_hash.should be_a Hash
+				@base.to_hash[:id].should eq(3)
+			end
+		end
+	end
+end

data/twitter-redis-identitymap.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/twitter-redis-identitymap/version',__FILE__)
+
+Gem::Specification.new do |spec|
+	spec.add_dependency 'redis'
+
+	spec.add_development_dependency 'rake'
+	spec.add_development_dependency 'rspec'
+	spec.add_development_dependency 'simplecov'
+	spec.add_development_dependency 'twitter', '~> 4.0.0'
+
+	spec.authors = ["Kevin Fullerton"]
+	spec.description = %q{A redis IdentityMap store for the twitter gem}
+	spec.email = ["github@kenwa-solutions.co.uk"]
+	spec.files = %w{CHANGELOG.md LICENSE.md README.md Rakefile twitter-redis-identitymap.gemspec}
+	spec.files += Dir.glob("lib/**/*.rb")
+	spec.files += Dir.glob("spec/**/*")
+	spec.homepage = "http://github.com/kgfullerton/twitter-redis-identitymap"
+	spec.name = "twitter-redis-identitymap"
+	spec.require_paths = ["lib"]
+	spec.required_rubygems_version = Gem::Requirement.new(">= 1.3.6")
+	spec.summary = spec.description
+	spec.test_files = Dir.glob("spec/**/*")
+	spec.version = TwitterRedisIdentityMap::Version
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: twitter-redis-identitymap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Fullerton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: A redis IdentityMap store for the twitter gem
+email:
+- github@kenwa-solutions.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- Rakefile
+- twitter-redis-identitymap.gemspec
+- lib/twitter-redis-identitymap/version.rb
+- lib/twitter-redis-identitymap/base.rb
+- lib/twitter-redis-identitymap.rb
+- spec/twitter-redis-identitymap/base_spec.rb
+- spec/helper.rb
+homepage: http://github.com/kgfullerton/twitter-redis-identitymap
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A redis IdentityMap store for the twitter gem
+test_files:
+- spec/twitter-redis-identitymap/base_spec.rb
+- spec/helper.rb