isbnify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ce182ccf75b38d868b634282cbcc0daf145f0f9
+  data.tar.gz: 2db0e7a91ea2e89e09aab45d52a4cf7bae1982f9
+SHA512:
+  metadata.gz: 0b4a6877ee5abcfa908d07f7f8c86272d047ed47c00ee0900ded4ecdddbdfc548dd3df47049cad775b8f20dfbe2262fbf09e68fa9e93d04a461b3918d3354acc
+  data.tar.gz: fa04c7d41f0c2f92171582c1a30795fe5c16d5a7da94be3ac3f0624abef598f5e879adb9c75eabc540d13b0356a7f96e03ab9d35fea13d8b7c95c2241293aa38

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/cassettes
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 2.0.0-p247
+rvm --create gemset use $(basename $(pwd))

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in isbnify.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Christoph Seydel
+
+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,69 @@
+isbnify
+=======
+
+hyphenate, verify and create ISBN13 numbers
+
+### Functionality
+* creates valid ISBN13 fake numbers, allready hyphinated
+* check ISBN13 validity of a given number
+* hyphinate valid ISBN13 number
+
+
+### Implementation
+Include Isbnify into your controller and use the helper actions or call object Isbnify::ISBN class actions.
+
+
+### Functions
+
+``create_isbn`` or ``Isbnify::ISBN.create_isbn``
+
+Returns a random, yet valid fake ISBN allready hyphinated.
+
+``hyphinate_isbn(String)`` or ``Isbnify::ISBN.hyphinate_isbn(String)``
+
+Returns hyphinated ISBN or error message as String.
+
+``valid_isbn?(String)`` or ``Isbnify::ISBN.valid_isbn?(String)``
+
+Returns true or false, whether a given ISBN is valid or not. It can be passed as hyphinated ISBN or not.
+
+
+### Useable method calls
+
+```
+class ApplicationController < ActionController
+  include Isbnify
+
+  def some_method
+    hyphinate_isbn("9783404166695")               # returns "978-3-404-16669-5"
+    Isbnify::ISBN.hyphinate_isbn("9783404166695") # returns "978-3-404-16669-5"
+  end
+
+  def some_other_method
+    valid_isbn?("9783404166695")                  # returns true
+    Isbnify::ISBN.valid_isbn?("9783404166695")    # returns true
+  end
+
+  def some_last_method
+    create_isbn                       # returns random well-formed isbn number
+    Isbnify::ISBN.create_isbn         # returns random well-formed isbn number
+  end
+
+end
+```
+
+### Ruby Versions
+
+This gem was developed and tested with versions 1.9.3 and 2.0.0
+
+### Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Copyright
+
+Copyright (c) 2013 Christoph Seydel. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/isbnify.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'isbnify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "isbnify"
+  spec.version       = Isbnify::VERSION
+  spec.authors       = ["cseydel"]
+  spec.email         = ["christoph.seydel@me.com"]
+  spec.description   = %q{This gem verifies, creates and hyphinates ISBN13 numbers}
+  spec.summary       = %q{This gem verifies, creates and hyphinates ISBN13 numbers}
+  spec.homepage      = "https://github.com/cseydel/isbnify"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", ">= 1.2.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "fakeweb", "~> 1.3.0"
+  spec.add_development_dependency "vcr", "~> 2.6.0"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "simplecov-gem-adapter", "~> 1.0.1"
+end

data/lib/isbnify.rb

@@ -0,0 +1,25 @@
+require "isbnify/version"
+require "isbnify/isbn"
+require "isbnify/iisbna"
+
+module Isbnify
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def hyphinate_isbn(isbn_string = nil)
+      ISBN.hyphinate_isbn(isbn_string)
+    end
+
+    def valid_isbn?(isbn_string = nil)
+      ISBN.valid_isbn?(isbn_string)
+    end
+
+    def create_isbn
+      ISBN.create_isbn
+    end
+
+  end
+end

data/lib/isbnify/iisbna.rb

@@ -0,0 +1,168 @@
+require 'nokogiri'
+require 'open-uri'
+
+module Isbnify
+  class IISBNA
+
+    attr_accessor :country_group, :group_hash, :isbn, :prefix, :publisher, :range_hash
+
+    def initialize(isbn = "")
+      @isbn       = isbn.to_s
+      @range_hash = xml_parse
+    end
+
+    def hyphinate
+      return "invalid international ISBN13 number" unless valid_prefix? && valid_group? && valid_publisher?
+      hyphinate_with_values
+    end
+
+    def create_valid_isbn
+      random_group = range_hash[:"ISBNRangeMessage"][:"RegistrationGroups"][:"Group"].shuffle[0]
+      group        = random_group[:Prefix]
+      rule         = random_group[:Rules][:Rule].is_a?(Array) ? random_group[:Rules][:Rule].shuffle[0] : random_group[:Rules][:Rule]
+      r_publisher  = random_publisher(rule)
+      create_isbn(group, r_publisher)
+    end
+
+
+    private
+
+    def create_isbn(group, r_publisher)
+      product_size  = 12 - group.gsub("-","").size - r_publisher.size
+      product       = "9999999999"[0..(product_size - 1)]
+      checksum      = Isbnify::ISBN.create_isbn_checksum(group.gsub("-","") + r_publisher + product)
+      return "#{group}-#{r_publisher}-#{product}-#{checksum}"
+    end
+
+    def group_prefix_included?(prefix, checkstring)
+      5.times do |n|
+        return true if prefix == "#{@prefix}-#{checkstring[0..(n-1)]}"
+      end
+      false
+    end
+
+    def hyphinate_with_values
+      product_id = isbn.gsub(/#{@prefix}#{@country_group}#{@publisher}/, "")
+      return "#{@prefix}-#{@country_group}-#{@publisher}-#{product_id[0..-2]}-#{product_id[-1]}"
+    end
+
+    def in_range?(rule, string)
+      truncated_range(rule[:Range], rule[:Length], string[valid_range(rule[:Length])])
+    end
+
+    def open_url_with_file_fallback
+      begin
+        xml_to_hash(open("http://www.isbn-international.org/agency?rmxml=1").read)
+      rescue
+        xml_to_hash(open(File.expand_path("../../../vendor/lib/RangeMessage.xml",  __FILE__)).read)
+      end
+    end
+
+    def random_publisher(rule)
+      array = rule[:Range].split("-")
+      new_publisher  = (rand(array[1].to_i - array[0].to_i) + array[0].to_i).to_s
+      return new_publisher[valid_range(rule[:Length])]
+    end
+
+    def truncated_range(range, length, needle)
+      array = range.split("-")
+      needle.to_i.between?((array[0][valid_range(length)]).to_i, (array[1][valid_range(length)]).to_i)
+    end
+
+    def valid_group?
+      sanitized_string = isbn.gsub(/^#{@prefix}/, "")
+      range_hash[:"ISBNRangeMessage"][:"RegistrationGroups"][:"Group"].each do |group_hash|
+        if group_prefix_included?(group_hash[:Prefix], sanitized_string)
+          @group_hash = group_hash
+          return @country_group = group_hash[:Prefix].gsub(/^#{@prefix}-/, "")
+        end
+      end
+      false
+    end
+
+    def valid_prefix?
+      range_hash[:"ISBNRangeMessage"][:"EAN.UCCPrefixes"][:"EAN.UCC"].each do |prefix_hash|
+        return @prefix = prefix_hash[:Prefix] if prefix_hash.has_value?(isbn[0..2])
+      end
+      false
+    end
+
+    def valid_publisher?
+      sanitized_string = isbn.gsub(/#{@prefix}#{@country_group}/, "")
+      @group_hash[:Rules][:Rule].each do |rule|
+        return @publisher = sanitized_string[valid_range(rule[:Length])] if in_range?(rule, sanitized_string)
+      end
+    end
+
+    def valid_range(length)
+      (0..(length.to_i - 1))
+    end
+
+
+    # XML parser methods
+    # modified from http://stackoverflow.com/questions/1230741/convert-a-nokogiri-document-to-a-ruby-hash/1231297#123129
+    #
+
+    def xml_parse
+      open_url_with_file_fallback.to_hash
+    end
+
+    def xml_to_hash(xml_io)
+      result = Nokogiri::XML(xml_io)
+      return { result.root.name.to_sym => xml_node_to_hash(result.root)}
+    end
+
+    def xml_node_to_hash(node)
+      if node.element?
+        parse_element(node)
+      else
+        return node.content.to_s
+      end
+    end
+
+    def parse_element(node)
+      result_hash = {}
+      attributes = parse_attributes(node)
+      if node.children.size > 0
+        return result_hash = parse_children(node, attributes, result_hash)
+      else
+        return attributes
+      end
+    end
+
+    def parse_attributes(node)
+      if node.attributes != {}
+        attributes = {}
+        node.attributes.keys.each do |key|
+          attributes[node.attributes[key].name.to_sym] = node.attributes[key].value
+        end
+      end
+      attributes
+    end
+
+    def parse_children(node, attributes, result_hash)
+      node.children.each do |child|
+        result = xml_node_to_hash(child)
+        if child.name == "text"
+          unless child.next_sibling || child.previous_sibling
+            return result unless attributes
+            result_hash[child.name.to_sym] = result
+          end
+        elsif result_hash[child.name.to_sym]
+          if result_hash[child.name.to_sym].is_a?(Object::Array)
+             result_hash[child.name.to_sym] << result
+          else
+             result_hash[child.name.to_sym] = [result_hash[child.name.to_sym]] << result
+          end
+        else
+          result_hash[child.name.to_sym] = result
+        end
+      end
+      if attributes
+        result_hash = attributes.merge(result_hash)
+      end
+      return result_hash
+    end
+
+  end
+end

data/lib/isbnify/isbn.rb

@@ -0,0 +1,106 @@
+module Isbnify
+  class ISBN
+
+    attr_accessor :param
+
+    def initialize(param = nil)
+      @param = param
+    end
+
+    class << self
+      def create_isbn
+        self.new.create_isbn
+      end
+
+      def create_isbn_checksum(number = nil)
+        self.new(number).create_isbn_checksum
+      end
+
+      def hyphinate_isbn(isbn_string = nil)
+        self.new(isbn_string).hyphinate_isbn
+      end
+
+      def valid_isbn?(isbn_string = nil)
+        self.new(isbn_string).valid_isbn?
+      end
+    end
+
+    def create_isbn
+      Isbnify::IISBNA.new.create_valid_isbn
+    end
+
+    def create_isbn_checksum
+      checksum_argument_validation(param)
+      return calculate_checksum(param)
+    end
+
+    def hyphinate_isbn
+      string_argument_validations(param)
+      return "invalid ISBN given" unless valid_isbn?
+      Isbnify::IISBNA.new(param).hyphinate
+    end
+
+    def valid_isbn?
+      string_argument_validations(param)
+      validate_checksum
+    end
+
+
+    private
+
+    def calculate_checksum(string)
+      (10 - (inject_with_index(string_to_array(string)) % 10)) % 10
+    end
+
+    def calculate_sum(sum, number, index)
+      sum + exponate_number_with_index(number, index)
+    end
+
+    def checksum_argument_validation(isbn_string)
+      validate_presence_of_attribute(isbn_string)
+      validate_type_of_attribute(isbn_string, "String")
+    end
+
+    def exponate_number_with_index(number, index)
+      number * (3 ** ((index + 1) % 2))
+    end
+
+    def inject_with_index(array)
+      array.each_index.inject(0){ |sum, index| calculate_sum(sum, array[index].to_i, index + 1) }
+    end
+
+    def sanitize_isbn_string
+      param.gsub(/[^0-9]/, "")
+    end
+
+    def string_argument_validations(isbn_string)
+      validate_presence_of_attribute(isbn_string)
+      validate_type_of_attribute(isbn_string, "String")
+      validates_isbn13_length
+    end
+
+    def string_to_array(string)
+      string[0..-2].split("")
+    end
+
+    def validate_checksum
+      validate_with_sanitized_string(sanitize_isbn_string)
+    end
+
+    def validate_with_sanitized_string(sanitized_string)
+      sanitized_string[-1].to_i == calculate_checksum(sanitized_string)
+    end
+
+    def validates_isbn13_length
+      raise ArgumentError, "expected argument to include exactly 13 digits" unless sanitize_isbn_string.length == 13
+    end
+
+    def validate_presence_of_attribute(attribute)
+      raise ArgumentError, "expected argument not to be nil" if attribute.nil?
+    end
+
+    def validate_type_of_attribute(attribute, type)
+      raise ArgumentError, "expected argument to be #{type}" unless attribute.is_a?(Module.const_get(type))
+    end
+  end
+end