cuecat 1.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v1.0 (1st November 2008)
+- Initial Release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Peter Yandell
+
+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,34 @@
+A small class for decoding the values returned when scanning a barcode with
+the cheaply available cuecat scanner.
+
+= Installation
+
+gem install cuecat
+
+= Usage
+
+    puts CueCat.valid?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.")
+    => true
+
+    puts CueCat.ean?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.")
+    => true
+
+    code = CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.")
+    puts code.code_type
+
+    => "IBN"
+    puts code.id
+
+    => "000000005112157601"
+    puts code.value
+    => "978184354916"
+
+= Further Reader
+
+- http://en.wikipedia.org/wiki/Cuecat
+- http://www.librarything.com/wiki/index.php/CueCat
+
+= Contributing
+
+Source code is publicly available @ http://github.com/yob/cuecat/tree/master.
+Patches welcome, preferably via a git repo I can pull from.

data/lib/cuecat.rb

@@ -0,0 +1,112 @@
+require 'base64'
+require 'ean13'
+
+# An extra simple class for decoding a cuecat code into
+# its components.
+#
+#    code = CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.")
+#    puts code.code_type
+#    puts code.id
+#    puts code.value
+#
+# This code is based on the PHP version I found here:
+#   http://www.phpbuilder.com/snippet/download.php?type=snippet&id=699
+# Thanks Adam!
+#
+class CueCat
+
+  attr_reader :code_type, :id, :value
+
+  class Version #:nodoc:
+    Major = 1
+    Minor = 0
+    Tiny  = 0
+
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+  class << self
+    # A very basic check to see if the supplied code looks like a cuecat code.
+    # At this stage I'm not aware of any fullproof way to check.
+    #
+    def valid?(code)
+      code = code.to_s
+      if code[0,1] != "."
+        false
+      elsif code[-1,1] != "."
+        false
+      elsif code.scan(/\./).size != 4
+        false
+      else
+        true
+      end
+    end
+
+    def ean?(code)
+      self.new(code).ean?
+    end
+  end
+
+  # process a new cuecat code
+  #
+  def initialize(str)
+    @number = str.to_s
+
+    if valid?
+      swap
+      split_components
+    end
+  end
+
+  # is the supplied code valid?
+  def valid?
+    CueCat.valid? @number
+  end
+
+  def ean?
+    return false if @value.nil?
+    EAN13.valid?(@value)
+  end
+
+  private
+
+  # Swap letters with their upper or lower case equivilants.
+  #
+  # Go go gadget hardcore encryption.
+  #
+  def swap
+    arr = @number.unpack("C*").collect do |c|
+      if c > 64 && c < 91
+        c + 32
+      elsif c > 96 && c < 123
+        c - 32
+      else
+        c
+      end
+    end
+    @number.replace arr.pack("C*")
+  end
+
+  # Split the code by the full stops, and base64 decode each part.
+  #
+  # If the code is an EAN, calculate its check digit
+  #
+  def split_components
+    @number.gsub!("-","/")
+    something, id, code_type, value = *@number.split(".")
+    @id        = bitwise_op(Base64.decode64(id))
+    @code_type = bitwise_op(Base64.decode64(code_type))
+    @value     = bitwise_op(Base64.decode64(value))
+
+    if @code_type == "IBN" && @value.size == 12
+      @value = EAN13.complete(@value)
+    end
+  end
+
+  # bitwise XOR each value with 67. The final step to enlightenment.
+  #
+  def bitwise_op(value)
+    arr = value.unpack("C*").collect { |c| c ^ 67 }
+    arr.pack("C*")
+  end
+end

data/spec/cuecat_spec.rb

@@ -0,0 +1,47 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+
+require 'spec'
+require 'cuecat'
+
+describe "The CueCat class" do
+
+  it "should correctly translate a cuecat code to its component parts" do
+    code = CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.")
+    code.code_type.should eql("IBN")
+    code.id.should eql("000000005112157601")
+    code.value.should eql("9781843549161")
+
+    code = CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7C3T1E3DZDxPWCW.")
+    code.code_type.should eql("IBN")
+    code.id.should eql("000000005112157601")
+    code.value.should eql("9780868406930")
+
+    code = CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGf2.ENr7C3j3C3f7Dxr7DxzYDNnZ.")
+    code.code_type.should eql("IB5")
+    code.id.should eql("000000005112157601")
+    code.value.should eql("978014028678651500")
+  end
+
+  it "should correctly detect valid codes" do
+    CueCat.valid?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGf2.ENr7C3j3C3f7Dxr7DxzYDNnZ.").should be_true
+    CueCat.valid?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7C3T1E3DZDxPWCW.").should be_true
+    CueCat.valid?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.").should be_true
+
+    CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.").valid?.should be_true
+  end
+
+  it "should correctly detect invalid codes" do
+    CueCat.valid?(nil).should be_false
+    CueCat.valid?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG").should be_false
+    CueCat.valid?(1).should be_false
+    CueCat.valid?([0,1,2]).should be_false
+  end
+
+  it "should correctly detect EAN13 codes" do
+    CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.").ean?.should be_true
+    CueCat.new(".C3nZC3nZC3n2CNjXCNz0DxnY.cGf2.ENr7C3j3C3f7Dxr7DxzYDNnZ.").ean?.should be_false
+
+    CueCat.ean?(".C3nZC3nZC3n2CNjXCNz0DxnY.cGen.ENr7CNT3Chz3ENj1CG.").should be_true
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: cuecat
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-03 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ean13
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: a (very) small library for working with cuecat codes
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cuecat.rb
+- MIT-LICENSE
+- README.rdoc
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/yob/cuecat/tree/master
+post_install_message: 
+rdoc_options: 
+- --title
+- CueCat
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: yob-projects
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a (very) small library for working with cuecat codes
+test_files: 
+- spec/cuecat_spec.rb