token_pagination 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 633f8feea7395ccdfb2d4e12ed37bb4600fc8f0c
+  data.tar.gz: 3176ad8711d7cb965d57f3f83d9cd6f4d6fe1fbb
+SHA512:
+  metadata.gz: f6fabc35624e5d91d5ebdfa7e7de28df34cf664692ba3ac2fffedd39ccec25c24ab25142de35142aa6eb56a855190525066deb41e98ac35a5da1aa5abe1ccf94
+  data.tar.gz: 30f206aeb3fbb3b6a50481cf147f07b9d420cfd81a07e9d5d3727344858a378e309efdcb39e953ce7154bb2c63adfabe3a03c3ae483cf387ddf1808df7670f0f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= TokenPagination
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TokenPagination'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/token_pagination.rb

@@ -0,0 +1,11 @@
+require "token_pagination/version"
+require "token_pagination/page_token"
+require "token_pagination/active_record_relation_extention"
+require "token_pagination/railtie"
+require "token_pagination/collection"
+
+module TokenPagination
+  # Your code goes here...
+  class JWTDecodeError < StandardError; end
+  class UnmatchCollectionError < StandardError; end
+end

data/lib/token_pagination/active_record_relation_extention.rb

@@ -0,0 +1,116 @@
+require 'jwt'
+require 'digest'
+require 'active_support/concern'
+require 'token_pagination/page_token'
+module TokenPagination
+  module ActiveRecordRelationExtention
+    extend ActiveSupport::Concern
+    included do
+      def page_by_token(count, page_token_string=nil)
+        begin
+          page_by_token!(count, page_token_string)
+        rescue TokenPagination::JWTDecodeError
+          return TokenPagination::Collection.new([])
+        rescue TokenPagination::UnmatchCollectionError
+          return TokenPagination::Collection.new([])
+        end 
+      end
+
+      def page_by_token!(count, page_token_string=nil)
+        result_set = self
+        
+        if self.order_values.empty? then
+          raise "Order caluse must be specified"
+        end
+
+        unless page_token_string.nil? then
+          token = TokenPagination::PageToken.from_string(page_token_string).verify_c_hash!(self.to_c_hash)
+          result_set = result_set.where(pointer_to_where_values(token.pointer_instance))
+        end
+        
+        result = result_set.take(count+1)
+
+        if result.size == count+1 then
+          result.pop
+          pointer_instance =  result.last
+          pointer_instance_values = self.order_values.map{|item| item.value.name }.map{| attribute| pointer_instance.send(attribute) }
+          next_page_token = TokenPagination::PageToken.new(to_c_hash, pointer_instance_values).to_s
+        end
+
+        result = TokenPagination::Collection.new(result)
+        result.next_page_token = next_page_token
+        result
+      end  
+
+      # attribute1 >= val AND (attribute 1 > val or ( attribute2 > val OR ( attribute2 >= val AND attribute3 > val) OR (attribute 2 >= val AND attribute3 >= val AND attribute 4 > val )
+      def pointer_to_where_values(pointer_instance)
+        orders = self.order_values.dup  # copy
+        primal_order = orders.shift
+        primal_attribute = primal_order.value.relation[primal_order.value.name]
+        primal_value = pointer_instance.shift
+
+        primal_condition =  _eq_or_next(primal_order, primal_attribute, primal_value)
+        on_boader_condition = _next(primal_order, primal_attribute, primal_value)
+        
+        all_eq_upto = primal_attribute.eq(primal_value)
+
+        orders.each do|o|
+          attribute = o.value.relation[o.value.name]
+          value = pointer_instance.shift
+
+          on_boader_condition = on_boader_condition.or(
+            all_eq_upto.and(
+              _next(o, attribute, value)
+            )
+          )
+          all_eq_upto =  all_eq_upto.and(attribute.eq(value))
+        end
+        result = primal_condition.and(on_boader_condition)
+        return result
+      end
+
+      def to_c_hash
+        Digest::MD5.hexdigest(self.to_sql) #TODO
+      end
+
+      private 
+        # These methods respec mysql behaviour
+        # Mysql treets nil as bottom elements when ordered ascending
+        # But when specified with where query, column >= NULL returns empty set.
+        # These method allows as to order by null
+
+        def _eq_or_next(order, attr, value) 
+          if order.ascending? then
+            if value.nil? then
+              # everything matches
+              return nil
+            else
+              return attr.gteq(value)
+            end
+          else 
+            if value.nil? then
+              return attr.eq(nil)
+            else
+              return attr.lteq(value)
+            end
+          end
+        end
+
+        def _next(order, attr, value)
+          if order.ascending? then
+            if value.nil? then
+              return attr.not_eq(nil)
+            else
+              return attr.gt(value)
+            end
+          else 
+            if value.nil? then
+              return attr.lt(nil) # Nothing matches
+            else
+              return attr.lt(value) 
+            end
+          end
+        end
+    end
+  end
+end

data/lib/token_pagination/collection.rb

@@ -0,0 +1,5 @@
+module TokenPagination
+  class Collection < Array
+    attr_accessor :next_page_token
+  end
+end

data/lib/token_pagination/page_token.rb

@@ -0,0 +1,35 @@
+require 'jwt'
+module TokenPagination
+  class PageToken
+    attr_reader :c_hash, :pointer_instance
+    def initialize(c_hash, pointer_instance)
+      @c_hash = c_hash
+      @pointer_instance = pointer_instance
+    end
+
+    def self.from_string(token_string)
+      begin 
+        claims, header = JWT.decode(token_string, Rails.application.secrets.secret_key_base)
+        return self.new(claims["_ext"]["c_hash"], claims["_ext"]["pointer_instance"])
+      rescue JWT::DecodeError => e
+        raise TokenPagination::JWTDecodeError.new("token not decoded: #{e.to_s}")
+      end
+    end
+
+    def to_s	
+      JWT.encode({
+        _ext: {
+          c_hash: @c_hash,
+          pointer_instance: @pointer_instance
+        }
+      }, Rails.application.secrets.secret_key_base)
+    end
+
+    def verify_c_hash!(c_hash_string)
+      if (c_hash_string != self.c_hash) then
+        raise TokenPagination::UnmatchCollectionError.new("c_hash not match")
+      end
+      self
+    end
+  end
+end

data/lib/token_pagination/railtie.rb

@@ -0,0 +1,9 @@
+module TokenPagination
+  class Railtie < ::Rails::Railtie
+    initializer 'token_pagination' do |_app|
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Relation.send :include, TokenPagination::ActiveRecordRelationExtention
+      end  
+    end
+  end
+end

data/lib/token_pagination/version.rb

@@ -0,0 +1,3 @@
+module TokenPagination
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: token_pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- maedama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides page token based pagination for your active record
+email:
+- maedama85@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/token_pagination.rb
+- lib/token_pagination/active_record_relation_extention.rb
+- lib/token_pagination/collection.rb
+- lib/token_pagination/page_token.rb
+- lib/token_pagination/railtie.rb
+- lib/token_pagination/version.rb
+homepage: http://maedama.hatenablog.com
+licenses:
+- MIT
+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: Provides page token based pagination for your active record
+test_files: []