journal 0.0.1 → 0.0.2

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: bundler
+BUNDLE_DISABLE_SHARED_GEMS: '1'

data/.gitignore

@@ -0,0 +1,2 @@
+bundler/*
+*.gem

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p125@journal --create

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gemspec
+
+# gem "mocha"
+gem "rake"
+gem "rspec"
+gem 'active_support'
+gem 'redis'
+
+
+group :development do
+  gem "ruby-debug",   :platforms => :mri_18
+  gem "ruby-debug19", :platforms => :mri_19
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    journal (0.0.2)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.9)
+    redis (2.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  journal!
+  rake
+  redis
+  rspec
+  ruby-debug
+  ruby-debug19

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Thomas Riboulet riboulet@gmail.com
+
+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,39 @@
+# Journal
+
+This gem is intended to provide an easy way to log activities. It uses Redis as storage, if you want to use a similar thing with CouchDB or MongoDB or anyother DB please create a separate Gem for that.
+
+## How to use
+
+Put the following line into your Gemfile
+
+```
+gem "journal"
+```
+
+Then create an initializer or some other file loaded by your app and put the following config in it (with proper values) :
+
+```Ruby
+Journal.setup do |config|
+  config.host = ""
+  config.port = ""
+  config.expiry = 604800
+  config.password = ""
+end
+```
+
+
+## how to call
+
+To create an new entry you just have to call the Journal.log method passing the data you want and a key :
+
+```
+Journal.log("oh", "some data")
+```
+
+You can then retrieve a JournalEntry object using the Journal.last method :
+
+```
+a = Journal.last("oh")
+a.inspect
+# #<JournalEntry:0x007f980c8dacd8 @key="awesome+key", @data="some data@1337007458", @timestamp="1337007458", @date=#<DateTime: 2012-05-14T16:57:38+02:00 ((2456062j,53858s,0n),+7200s,2299161j)>
+```

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require "bundler"
+  Bundler::GemHelper.install_tasks
+rescue Exception => e
+end
+
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+require "journal"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+require "rake/rdoctask"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Journal #{Journal::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :spec

data/journal.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'journal'
+  s.version     = '0.0.2'
+  s.date        = '2012-05-14'
+  s.summary     = "Journal!"
+  s.description = "Simple way to log activity on an object using a redis db"
+  s.authors     = [ "Thomas Riboulet"]
+  s.email       = 'riboulet@gmail.com'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage    = 'http://github.com/mcansky/journal'
+  s.add_dependency 'redis'
+  s.add_development_dependency 'rspec', '~> 2.7'
+end

data/lib/generators/templates/journal.rb

@@ -0,0 +1,6 @@
+Journal.setup do |config|
+  config.host = ""
+  config.port = ""
+  config.expiry = 604800
+  config.password = ""
+end

data/lib/journal/handler.rb

@@ -0,0 +1,10 @@
+module Journal
+  def self.log(key, data, score)
+    return @@redis.zadd(key, score, "#{data}@#{score}")
+  end
+
+  def self.last(key, _count = 1)
+    return JournalEntry.new(key, @@redis.zrange(key, -1, -1).first) unless _count > 1
+    return JournalEntry.from_array(key, @@redis.zrange(key, _count * -1, -1).reverse)
+  end
+end

data/lib/journal/rack/reloader.rb

@@ -0,0 +1,15 @@
+module Journal
+  module Rack
+    # Rack middleware the reloads RailsConfig on every request (only use in dev mode)
+    class Reloader
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Journal.load_and_set_settings!
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/journal/version.rb

@@ -0,0 +1,3 @@
+module Journal
+  VERSION = '0.0.1'
+end

data/lib/journal.rb

@@ -1,6 +1,8 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 require 'active_support/core_ext/module/attribute_accessors'
-require "journal/handler.rb"
-require "journal/version.rb"
+require "journal/version"
+require "journal/handler"
 require 'rubygems'
 require 'redis'
 

data/redis.cf.sample

@@ -0,0 +1 @@
+requirepass 34524GVQSDCA2CT34CZDX2

data/spec/journal_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Journal do
+
+  context "Test Configuration" do
+    before :each do
+      Journal.setup do |config| 
+        config.host = "localhost"
+        config.port = "6379"
+        config.expiry = 604800
+        config.password = "34524GVQSDCA2CT34CZDX2"
+      end
+    end
+    it { Journal.host.should eql("localhost") }
+    it { Journal.port.should eql("6379") }
+    it { Journal.expiry.should eql(604800) }
+    it { Journal.password.should eql("34524GVQSDCA2CT34CZDX2") }
+  end
+  
+  context "Test Configuration again !" do
+    it { Journal.host.should eql("localhost") }
+    it { Journal.port.should eql("6379") }
+    it { Journal.expiry.should eql(604800) }
+    it { Journal.password.should eql("34524GVQSDCA2CT34CZDX2") }
+  end
+  
+  context "Test Configuration" do
+    before :each do
+      Journal.setup do |config| 
+        config.host = "localhost"
+        config.port = "6379"
+        config.expiry = 604800
+        config.password = "34524GVQSDCA2CT34CZDX2"
+      end
+      Journal.load_and_set_settings!
+    end
+    it "Test constantes" do
+      ['JOURNAL_HOST','JOURNAL_PORT','JOURNAL_EXPIRY','JOURNAL_PASSWORD'].each do |constant|
+        Kernel.const_defined?(constant).should be_true
+      end
+    end
+    it { JOURNAL_HOST.should eql("localhost") }
+    it { JOURNAL_PORT.should eql("6379") }
+    it { JOURNAL_EXPIRY.should eql(604800) }
+    it { JOURNAL_PASSWORD.should eql("34524GVQSDCA2CT34CZDX2") }
+  end
+
+  context "Test Redis link" do
+    before :each do
+      Journal.setup do |config| 
+        config.host = "localhost"
+        config.port = "6379"
+        config.expiry = 604800
+        config.password = "34524GVQSDCA2CT34CZDX2"
+      end
+      Journal.load_and_set_settings!
+      Journal.redis
+    end
+    it { Journal.redis.should_not eql nil }
+    it { Journal.redis.class.should eql Redis }
+  end
+
+  context "Test Function" do
+    before :each do
+      Journal.setup do |config| 
+        config.host = "localhost"
+        config.port = "6379"
+        config.expiry = 604800
+        config.password = "34524GVQSDCA2CT34CZDX2"
+      end
+      Journal.load_and_set_settings!
+      Journal.redis
+      Journal.redis.flushdb
+    end
+    it "Test setting an entry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp)
+      Journal.redis.zrange(key,0,1).first.should eql "#{data}@#{timestamp}"
+    end
+
+    it "Test creating a JournalEntry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      JournalEntry.new(key, "#{data}@#{timestamp}").entry.should eql "#{data}"
+    end
+
+    it "Test getting date from a JournalEntry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      JournalEntry.new(key, "#{data}@#{timestamp}").date.should eql Time.at(timestamp).to_datetime
+    end
+
+    it "Test setting an entry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp).should eql true
+    end
+
+    it "Test getting an entry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp)
+      Journal.last(key).class.should eql JournalEntry
+    end
+
+    it "Test getting last entry" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp)
+      Journal.log(key, data, timestamp + 10)
+      Journal.last(key).raw.should eql "#{data}@#{timestamp + 10}"
+    end
+
+    it "Test getting back several entries" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp)
+      Journal.log(key, data, timestamp + 10)
+      Journal.last(key,10).class.should eql Array
+    end
+
+    it "Test getting back several entries from the end" do
+      key = "awesome+key"
+      data = "created object num 42"
+      timestamp = Time.now.to_i
+      Journal.log(key, data, timestamp)
+      Journal.log(key, data, timestamp + 10)
+      Journal.last(key,10).first.class.should eql JournalEntry
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'journal'
+require 'journal_entry'
+require 'bundler/setup'
+
+RSpec.configure do |c|
+  c.run_all_when_everything_filtered = true
+  # config.mock_with :mocha
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: journal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,14 +10,52 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-05-14 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70105044468000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105044468000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70105044467400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70105044467400
 description: Simple way to log activity on an object using a redis db
 email: riboulet@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .bundle/config
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- journal.gemspec
+- lib/generators/templates/journal.rb
 - lib/journal.rb
+- lib/journal/handler.rb
+- lib/journal/rack/reloader.rb
+- lib/journal/version.rb
+- redis.cf.sample
+- spec/journal_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/mcansky/journal
 licenses: []
 post_install_message: 
@@ -42,4 +80,6 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Journal!
-test_files: []
+test_files:
+- spec/journal_spec.rb
+- spec/spec_helper.rb