id_cipher 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74f924321f133c41cb1535778bc0052b3920bc10
-  data.tar.gz: f129f899c3cb6481d4954bfd683b4cfe7158f6b9
+  metadata.gz: 18ba804318b65f79e23788ccb72b5f22e968e6d9
+  data.tar.gz: cb6afe17b901c11990cc1bb129055b5ac581a018
 SHA512:
-  metadata.gz: e6ee9d4d131e8ec6132d8e7eba70690ec910274c9649149ff81505544f0953b3b04c0d164c259c3a8a7f15992f99a7440afa873e287913a6e42510306a85b715
-  data.tar.gz: eff0ffd56a39fe4c5966db316091b3f0603c3e8dac91147021ef457d27076df41560a4931dd40acc21a30b899dcc9eb9b53a1cb5dd5c1b5c9f907ac8d189cfc7
+  metadata.gz: 115201215dfad785f5c93e50987cb5aa9b173129c12cf4a89769c476df139219dd8e44372b26c57b6df48c18f06c2060d3fe86c2e3dd29f54bf0f059fdddfb7b
+  data.tar.gz: 35cb57637414f4b612584df85e60815d9a1ce556272f01f02e2ff13449ae7314dde06d5c9d0103bbf87e74d0412c719e00b5962118f10acb034d2bdbb9f104e8

data/README.md

@@ -1,6 +1,6 @@
 # IdCipher
 
-cipher Integer to another Integer, make people confused with the real number.
+cipher Integer to another Integer, make customer confused with the real number
 
 ## Installation
 
@@ -18,12 +18,34 @@ Or install it yourself as:
 
 ## Usage
 
-set a key: use it like Settings.id_cipher_key='something.like.this'
+set cipher slat in two ways:
 
-IdCipher.encrypt(1) # puts 42491238512
-IdCipher.decrypt(42491238512) # puts 1
+1. if use this in ruby on rails, add config in ``settings.yml``:
 
-the result about encrypt is depend on key
+        Settings.id_cipher_key = 'something.like.this'
+        
+2. or set IdCipher::KEY direct
+
+        module IdCipher
+            KEY = 'something.like.this'
+        end
+        
+notice: the key length must be over 16, should not longer than 256.
+
+#### code example
+
+> IdCipher.encrypt(1) # puts 42491238512
+
+>IdCipher.decrypt(42491238512) # puts 1
+
+**the result about encrypt is depend on key**
+
+IdCipher has two method, most of time, result of two method will be same.
+but **DO NOT** use them obscurely.
+
+ID cipher use C ``pack`` function, so it has up limmit for id,
+``pack`` function use 'L' type pack id, it's a unsigned long type, 
+value range is 0~(2**32 - 1), means it must less than 4294967295
 
 ## Contributing
 

data/id_cipher.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'id_cipher/version'
+require 'id_cipher'
 
 Gem::Specification.new do |spec|
   spec.name          = "id_cipher"
@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{cipher integer to another integer}
   spec.description   = %q{only used to cipher integer, use in confused with ID}
   spec.homepage      = "https://github.com/delongw/ruby-id-cipher"
+  spec.required_ruby_version = '>= 2.0'
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,5 +20,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", "~> 10.4"
 end

data/lib/id_cipher.rb

@@ -1,5 +1,9 @@
 require 'openssl'
-require "id_cipher/version"
+
+
+module IdCipher
+  VERSION = "0.1.0"
+end
 
 
 module IdCipher
@@ -25,29 +29,34 @@ module IdCipher
 
     def initialize
       @cipher = OpenSSL::Cipher::Cipher.new('rc4')
-      @key = Setting.id_cipher_key
+    end
+
+    def key
+      (defined? Setting) && Setting.id_cipher_key ||
+          IdCipher::KEY ||
+          (raise TypeError, 'no cipher key found. you can set key within Settings.yml, id_cipher_key="cipher slat" or refine IdCipher::KEY')
     end
 
     def pack(number)
-      raise TypeError, "#{number} is not a Fixnum" if number.class != Fixnum
       [number].pack('L')
     end
 
     def unpack(crypto_text)
-      raise TypeError, "#{crypto_text} is not a String" if crypto_text.class != String
       crypto_text.unpack('L')[0]
     end
 
     def encrypt(id)
+      id = id.to_i
       @cipher.encrypt
-      @cipher.key = @key
+      @cipher.key = key
       self.unpack @cipher.update(self.pack(id))
     end
 
-    def decrypt(id)
+    def decrypt(eid)
+      eid = eid.to_i
       @cipher.decrypt
-      @cipher.key = @key
-      self.unpack @cipher.update(self.pack(id))
+      @cipher.key = key
+      self.unpack @cipher.update(self.pack(eid))
     end
 
   end

data/spec/id_cipher_spec.rb

@@ -0,0 +1,32 @@
+require 'minitest/autorun'
+require_relative '../lib/id_cipher.rb'
+
+
+module IdCipher
+  KEY = '0123456789abcdef'
+end
+
+
+class TestCipher < MiniTest::Unit::TestCase
+
+  def setup
+
+  end
+
+  def test_encrypt
+    assert_equal 1497393285, IdCipher.encrypt(1)
+  end
+
+  def test_decrypt
+    assert_equal 1, IdCipher.decrypt(1497393285)
+  end
+
+  def test_encrypt_with_string
+    assert_equal 1497393407, IdCipher.encrypt('123')
+  end
+
+  def test_decrypt_with_string
+    assert_equal 123, IdCipher.encrypt('1497393407')
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: id_cipher
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - delong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 description: only used to cipher integer, use in confused with ID
 email:
 - w.del@qq.com
@@ -52,7 +52,7 @@ files:
 - Rakefile
 - id_cipher.gemspec
 - lib/id_cipher.rb
-- lib/id_cipher/version.rb
+- spec/id_cipher_spec.rb
 homepage: https://github.com/delongw/ruby-id-cipher
 licenses:
 - MIT
@@ -65,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -77,4 +77,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: cipher integer to another integer
-test_files: []
+test_files:
+- spec/id_cipher_spec.rb

data/lib/id_cipher/version.rb

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