browsing_history 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44240900447de64eee1d917a42c10dc18b72fe26
-  data.tar.gz: 3c110cb5e9e00d6e7904bcf8083296297bf0dd2a
+  metadata.gz: 9c6749dcc724b60d799405589828bc3d4127426a
+  data.tar.gz: 8693a8ab2b98f9507ea1766598c9b66532ef89bd
 SHA512:
-  metadata.gz: 2bf2adee9b2b6a105b181e70786952ce483696491b654aad786b594dc8cb453d45b2c16e75ac60b8e30fd6458efb227b8a63dc978b8d176527dec7c3d9f68c9a
-  data.tar.gz: 890e06144a100e76889787f04834942fcedcc1f231da633e95121aadd8ed52d052c792e3ece8c4ace9bbc21be266108ce794d951c36b6b6de22e4ab3f839e248
+  metadata.gz: a12cc8849558b2f85e12efc27edcbeb4eaad0a0127a359b43539d6434d97cda45c4f7cb28e544c9b026fe8fd47289477ce947c50be014114ec424fb98188a2ee
+  data.tar.gz: a87326513214ca2cb178c2c23db8113b60e13fb957f695deaf9ae45c8e01cd6c66493a3c5e40d53378d64df59830f2550942a537c7cf45599090198a81b88096

data/README.md

@@ -1,2 +1,258 @@
-# browsing_history
-Record browsing history by browser like users or something more simple and graceful.
+# BrowsingHistory
+
+BrowsingHistory is recording browsing history simply.
+it backed by Redis.
+
+
+## Compatibility
+The gem has been build and tested Rails 4.2 and Ruby 2.2.3
+
+
+## Usage
+At first, you include 2 moudles.
+```
+class User < ActiveRecord::Base
+  include BrowsingHistory::Browser
+end
+
+class Article < ActiveRecord::Base
+  include BrowsingHistory::Historizable
+end
+```
+
+Then, you can access `browsing_histories` method on a user instance to add a article to the user's browsing history.
+```
+# create a article
+article = Article.new(title: 'welcome to browsing_history')
+
+# add the article to user's browsing history
+user.browsing_histories << article
+
+# access user's browsing histories of Article class
+user.browsing_histories.recent(Article)
+# => [#<Article id: 1, title: "welcome to browsing_history", created_at: "2016-04-29 10:13:15", updated_at: "2016-04-29 10:13:15">]
+```
+
+For example,  
+if you want add a articls to browsing histoy when a user watch the article page,
+you should add the method on article_controller#show.
+
+```
+# app/controllers/articles_controller
+# GET /articles/:id
+def show
+  @user.browsing_histories << @article
+end
+```
+
+
+## How it works
+- recording historizable instances to browser's history on redis
+- getting past historizable instances on browser's browsing history with like activerecord options(limit, between, at)
+- clering browser's browsing history with like activerecord options(limit, between, at)
+- recording above history on some kind of storages(redis, activerecord, mongoid...) by same interface and user creat own interface a storage.
+
+
+### Description Elements
+There are 4 elements working on browsing_history.
+
+- **BrowsingHistory::Browser(Module)**  
+It provide access methods to browsing_history for a browser class included it.   
+example: `User, Crawler`
+
+- **BrowsingHistory::Historizable(Module)**  
+The class included it can be recorded on browsing_history  
+example: `Article, Review`
+
+- **BrowsingHistory::History(class)**  
+It's class based on ActiveModel. It record historizable instance on browser's browsing_history
+and exec some operations for them like add, where, count, clear.
+
+- **BrowsingHistory::Storage(Module)**  
+It provide abstruct interface of some kind of storages like redis, activerecord, mongoid.
+It is included BrowsingHistory::History and allow it to access above storages by same methods.
+
+### Storages
+There is 1 storage interface
+- **BrowsingHistory::Storages::Redis**  
+It's interface of redis for BrowsingHistory::Storage.
+it depends on redis, redis-objects, redis-namespace.
+
+
+## Getting Started
+
+### 1. install gem
+add a follow sentence to Gemfile
+
+```
+# Gemfile
+gem 'browsing_history'
+```
+
+### 2. Configure
+if you want choose storage to save history or modify namespace which is key-prefix on redis,
+add configuration to environments or your own config file.
+but now, you can use :redis only as storage.
+```
+# config/environments/{your environment} or create config/initializers/browsing_history.rb
+
+# It's default configuration
+BrowsingHistory.configure do |config|
+  config.storage_types = %i(redis active_record)
+  config.storage_type  = :redis
+  config.namespace     = 'browsing_history'
+end
+```
+
+
+### 3. Include modules
+you should include only 2 moudles.
+
+```
+# example models
+class User < ActiveRecord::Base
+  include BrowsingHistory::Browser
+end
+
+class Article < ActiveRecord::Base
+  include BrowsingHistory::Historizable
+end
+```
+
+### 4. Access browsing history
+
+#### BrowsingHistory::Browser#browsing_histories
+you can access to browsing_history by browsing_histories method.
+this method is provided BrowsingHistory::Browser and return BrowsingHistory::Browser::Assosiation
+
+BrowsingHistory::Browser::Assosiation is provided following 4 methods.
+1. recent
+1. previous
+1. add
+1. count
+
+and you can give following 2 argumetns for all of the methods.
+
+- Target class included historizable or their instance you want to get from history like `Article, article, Review, review,w`
+
+```
+# when browser is user, historizable is Articles
+user     = User.first
+articles = user.browsing_histories.recent(Article) 
+
+# you can give instance instead of class, both return same result.
+user     = User.first
+article  = Article.first
+articles = user.browsing_histories.recent(article) 
+
+# when you want mautipul historizable such as article and review
+user     = User.first
+articles = user.browsing_histories.recent(article) 
+reviews  = user.browsing_histories.recent(Review) 
+```
+
+- Range option like activerecord for instance `limit, between, at, all....`
+
+```
+# when you want to get recent 20(default) articles on browsing_history
+articles = user.browsing_histories.recent(Article) 
+
+# when you want to get recent 100 articles on browsing_history
+articles_100 = user.browsing_histories.recent(Article, limit: 100) 
+```
+
+#### #### BrowsingHistory::Browser::Assosiation methods
+```
+# recent
+# get user's browsing histories in order form the new one
+articles     = user.browsing_histories.recent(Article) 
+articles_100 = user.browsing_histories.recent(Article, limit: 100) 
+
+# previous
+# getting articles that user browsed between today to 1 day ago and in order form the new one
+articles = user.browsing_histories.previous(Article, Time.zone.now..1.day.ago)
+
+# add
+# add the article to user's browsing history
+user.browsing_histories << article
+
+# count
+
+# count user's browsing history
+number_of_histories = user.browsing_histories.count(Article) 
+```
+
+#### BrowsingHistory::History
+you can access browsing_history using also BrowsingHistory::History not only BrowsingHistory::Browser::Assosiation
+
+BrowsingHistory::History is provided following 4 methods.
+1. create
+1. create!
+1. where 
+1. clear
+1. count
+
+it's based ActiveModel and its method format is similar ActiveRecord.
+```
+user    = User.create(name: 'browser')
+article = Article.create(title: 'welcome to browsing_history')
+
+# add the article to user's browsing_history
+BrowsingHistories::History.create(browser: user, historizable: article)
+```
+
+it is able to conbine some options to access browsing_history so more flexibly than BrowsingHistory::Browser::Assosiation.
+```
+BrowsingHistories::History.where(
+  user: user, 
+  historizable: review,
+  between: 1.day.ago..2.days.ago,
+  limit: 50
+)
+```
+
+#### BrowsingHistory::History methods
+
+```
+user = User.first
+
+# where
+# get user's browsing histories in order form the new one ≒ user.browsing_history.recent
+articls     = BrowsingHistories::History.where(user: user, historizable: Article) # default all
+articls_100 = BrowsingHistories::History.where(user: user, historizable: Article, limit: 100)
+
+# get the article 5th from the newest
+article     = Article.find(100)
+articls_5th = BrowsingHistories::History.where(user: user, historizable: Article, at: 5)
+
+# getting articles that user browsed between 1 day ago to 2 days ago and in order form the new one ≒ user.browsing_history.previous
+articles = BrowsingHistories::History.where(user: user, historizable: review, between: 1.day.ago..2.days.ago)
+
+# conbining some options
+# getting articles that user browsed between 1 day ago to 2 days ago and it's limit 50 in order from the new one
+BrowsingHistories::History.where(
+  user: user, 
+  historizable: review,
+  between: 1.day.ago..2.days.ago,
+  limit: 50
+)
+
+# count
+# count user's browsing history ≒ user.browsing_history.count
+articls = BrowsingHistories::History.count(user: user, historizable: Article)
+number_of_histories = BrowsingHistories::History.count(user: user, historizable: Article) 
+
+# clear
+# clear the article from user's browsing history
+article = Article.first
+BrowsingHistory::History.clear(browseer: user, historizable: article)
+
+# clear all user's browsing history
+BrowsingHistory::History.clear(browseer: user, historizable: Article)
+# or
+article = Article.first
+BrowsingHistory::History.clear(browseer: user, historizable: article, all: true)
+```
+
+## Advanced
+

data/lib/browsing_history/browser.rb

@@ -22,7 +22,7 @@ module BrowsingHistory::Browser
     end
 
     def browser_instance?
-      !instance_of?(Object)
+      self.class != Class
     end
   end
 

data/lib/browsing_history/configuration.rb

@@ -1,4 +1,7 @@
 module BrowsingHistory::Configuration
+  class BrowsingHistory::InvalidStorageType < BrowsingHistory::Error; end
+  class BrowsingHistory::StorageNotSet < BrowsingHistory::Error; end
+
   # storage type
   attr_writer :storage_types
 
@@ -17,6 +20,11 @@ module BrowsingHistory::Configuration
     @storage_types ||= %i(redis active_record)
   end
 
+  def storage_types=(types)
+    raise BrowsingHistory::StoragesNotSet if types.empty?
+    @storage_types = types
+  end
+
   # BrowsingHistory storage
   #
   # @return the BrowsingHistory storage. default of :redis if not set.
@@ -25,7 +33,7 @@ module BrowsingHistory::Configuration
   end
 
   def storage_type=(type)
-    return false unless storage_types.incude?(type)
+    raise BrowsingHistory::InvalidStorageType unless storage_types.include?(type)
     @storage_type = type
   end
 

data/lib/browsing_history/historizable.rb

@@ -20,7 +20,7 @@ module BrowsingHistory::Historizable
     end
 
     def historizable_instance?
-      !instance_of?(Object)
+      self.class != Class
     end
   end
 end

data/lib/browsing_history/history.rb

@@ -51,8 +51,15 @@ class BrowsingHistory::History
 
     def count(browser: nil, historizable: nil)
       return 0 if !browser && !historizable
+
       current_storage.count(browser, historizable)
     end
+
+    def clear(browser: nil, historizable: nil, **opts)
+      return 0 if !browser && !historizable
+
+      current_storage.clear(browser, historizable, **opts)
+    end
   end
 
   private

data/lib/browsing_history/storage.rb

@@ -1,8 +1,6 @@
 require 'browsing_history/storages/base'
 
 module BrowsingHistory::Storage
-  class InvalidStorage < BrowsingHistory::Error; end
-  class StoragesNotSet < BrowsingHistory::Error; end
 
   def self.included(klass)
     klass.extend ConfigureMethods
@@ -27,7 +25,7 @@ module BrowsingHistory::Storage
         storage.connect(opts)
         @current_storage_type = storage_type
       else
-        raise InvalidStorage
+        raise BrowsingHistory::InvalidStorageType
       end
     end
 
@@ -37,7 +35,7 @@ module BrowsingHistory::Storage
           "BrowsingHistory::Storages::#{key.to_s.camelize}".constantize
       end
 
-      raise StoragesNotSet if storages.empty?
+      raise BrowsingHistory::StoragesNotSet if storages.empty?
       attach_storage(storages.keys.first)
     end
   end

data/lib/browsing_history/storages/redis.rb

@@ -10,6 +10,7 @@ class BrowsingHistory::Storages::Redis < BrowsingHistory::Storages::Base
       history.at(opts[:at])
     else
       limit = opts[:limit].try(:-, 1) || opts.delete(:end)
+
       history.revrange(opts.delete(:start), limit, **opts)
     end
   end
@@ -26,8 +27,10 @@ class BrowsingHistory::Storages::Redis < BrowsingHistory::Storages::Base
       clear_expiration(opts)
     elsif opts[:all]
       clear_all
-    else
+    elsif historizable.historizable_instance?
       history.delete(historizable)
+    else
+      clear_all
     end
   end
 

data/lib/browsing_history/version.rb

@@ -1,3 +1,3 @@
 module BrowsingHistory
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/spec/browsing_history/browser_spec.rb

@@ -19,6 +19,11 @@ describe BrowsingHistory::Browser do
       it { is_expected.to respond_to(:browser_type) }
       it { is_expected.to respond_to(:browser_class) }
       it { is_expected.to respond_to(:browser_instance?) }
+
+      it { expect(user.browser_id).to eql(user.id) }
+      it { expect(user.browser_type).to eql(user.class.to_s) }
+      it { expect(user.browser_class).to eql(user.class) }
+      it { expect(user.browser_instance?).to be(true) }
     end
 
     context 'singleton' do
@@ -28,6 +33,12 @@ describe BrowsingHistory::Browser do
       it { is_expected.to respond_to(:browser_type) }
       it { is_expected.to respond_to(:browser_class) }
       it { is_expected.to respond_to(:browser_instance?) }
+
+      let(:klass) { User }
+      it { expect(klass.browser_id).to eql(nil) }
+      it { expect(klass.browser_type).to eql(klass.to_s) }
+      it { expect(klass.browser_class).to eql(klass) }
+      it { expect(klass.browser_instance?).to be(false) }
     end
   end
 

data/spec/browsing_history/configration_spec.rb

@@ -12,5 +12,22 @@ describe BrowsingHistory::Configuration do
         expect(configuration.namespace).to eql('browsing_history')
       end
     end
+
+    it 'should raise error' do
+      expect do
+        BrowsingHistory.configure do |configuration|
+          configuration.storage_type = :invalid
+        end
+      end.to raise_error(BrowsingHistory::InvalidStorageType)
+    end
+
+    # it 'should not raise error when include original storage' do
+      # expect do
+        # BrowsingHistory.configure do |configuration|
+          # configuration.storage_types = %i(original)
+          # configuration.storage_type  = :original
+        # end
+      # end.not_to raise_error
+    # end
   end
 end

data/spec/browsing_history/history_spec.rb

@@ -200,7 +200,7 @@ describe BrowsingHistory::History do
   describe '.where' do
     it 'should default empty' do
       expect(
-        BrowsingHistory::History.where(
+        described_class.where(
           browser: user,
           historizable: article
         )
@@ -269,4 +269,68 @@ describe BrowsingHistory::History do
       it { expect(historizables_unhit.size).to eq(0) }
     end
   end
+
+  describe '.clear' do
+    context 'default' do
+      before(:each) do
+        articles.each do |article|
+          described_class.create(browser: user, historizable: article)
+        end
+      end
+
+      let(:historizables) do
+        described_class.where(browser: user, historizable: article)
+      end
+
+      it 'should clear target historizable' do
+        described_class.clear(browser: user, historizable: articles[2])
+
+        expect(historizables.size).to eql(articles.size - 1)
+        expect(historizables.map(&:id)).not_to include(2)
+      end
+
+      it 'should clear target historizable' do
+        described_class.clear(browser: user, historizable: Article)
+
+        expect(historizables).to be_empty
+      end
+    end
+
+    context 'with all option' do
+      before(:each) do
+        articles.each do |article|
+          described_class.create(browser: user, historizable: article)
+        end
+
+        described_class.clear(browser: user, historizable: article, all: true)
+      end
+
+      subject { described_class.where(browser: user, historizable: article) }
+      it { is_expected.to be_empty }
+    end
+
+    context 'with expiration option' do
+      before(:each) do
+        Timecop.travel(1.day.ago) do
+          articles.each do |article|
+            described_class.create(browser: user, historizable: article)
+          end
+        end
+
+        described_class.create(browser: user, historizable: article)
+      end
+
+      it do
+        described_class.clear(
+          browser: user,
+          historizable: article,
+          expiration: 23.hours.ago
+        )
+
+        expect(
+          described_class.count(browser: user, historizable: article)
+        ).to eql(1)
+      end
+    end
+  end
 end

data/spec/browsing_history/storage_spec.rb

@@ -38,7 +38,7 @@ describe BrowsingHistory::Storage do
       it 'should raise error' do
         expect do
           include_class_invalid_storage
-        end.to raise_error(BrowsingHistory::Storage::InvalidStorage)
+        end.to raise_error(BrowsingHistory::InvalidStorageType)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browsing_history
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - tkclimb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -185,8 +185,8 @@ files:
 - README.md
 - README.rdoc
 - Rakefile
+- browsing_history-demo.gif
 - browsing_history.gemspec
-- dump.rdb
 - lib/browsing_history.rb
 - lib/browsing_history/browser.rb
 - lib/browsing_history/configuration.rb

data/dump.rdb

@@ -1 +0,0 @@
-REDIS0006�ܳC�Z��V