acts_as_elibri_product 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Piotr Szmielew
+
+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,96 @@
+[![Build Status](https://secure.travis-ci.org/elibri/acts_as_elibri_product.png?branch=master)](http://travis-ci.org/elibri/acts_as_elibri_product)
+
+Gem designed to allow easy addition of eLibri based product to your application.
+
+Currently only tested and supported under REE.
+
+Usage guide:  
+
+* Add `'acts_as_elibri_product'` to your Gemfile
+
+* Run `rails g add_acts_as_elibri_product [YOUR_PRODUCT_MODEL_NAME]`
+
+* Run `rake db:migrate`
+
+* Add `acts_as_elibri_product TRAVERSE_VECTOR` to your product_model
+
+* Schedule (for example in cron) regular calls to `ProductModel.batch_create_or_update_from_elibri` providing `xml_string` from eLibri API as an argument.
+
+TRAVERSE_VECTOR is a structure containing information about mapping elibri arguments to your model arguments. Attributes not specified here, will be ignored during data import.
+
+Structure is build using hashes, general rule is:  
+```ruby
+{
+:elibri_attribute_name => :application_attribute_name,  
+:another_elibri_attribute_name => :another_application_attribute_name
+}
+```
+
+When dealing with embedded objects and relations, you should use embedded hashes:  
+
+```ruby
+:elibri_embedded_object_name =>  
+  { :application_relations_name =>    
+    {  
+      :embedded_object_elibri_attribute_name => :application_relation_object_attribute_name,  
+      :another_embedded_object_elibri_attribute_name => :another_application_relation_object_attribute_name     
+    }      
+  }
+```
+
+In embedded object, id may change, however import_id and/or record_reference will always remain unchanged.
+  
+example vector:
+
+```ruby
+:record_reference => :record_reference,
+:isbn13 => :isbn,
+:title => :title,
+:full_title => :full_title,
+:trade_title => :trade_title,
+:original_title => :original_title,
+:number_of_pages => :number_of_pages,
+:duration => :duration,
+:width => :width,
+:height => :height,
+:cover_type => :cover_type,
+:pkwiu => :pkwiu,
+:edition_statement => :edition_statement,
+:reading_age_from => :audience_age_from,
+:reading_age_to => :audience_age_to,
+:cover_price => :price_amount,
+:vat => :vat,
+:product_form => :product_form,
+:no_contributor? => :no_contributor,
+:unnamed_persons? => :unnamed_persons,
+:contributors => { #embedded name in elibri
+ :contributors => { #embedded name in elibri
+   :id => :import_id, #name transition atrybutow elibri => our app
+   :role_name => :role_name,
+   :role => :role,
+   :from_language => :from_language,
+   :person_name => :full_name,
+   :titles_before_names => :title,
+   :names_before_key => :first_name,
+   :prefix_to_key => :last_name_prefix,
+   :key_names => :last_name,
+   :names_after_key => :last_name_postfix,
+   :biographical_note => :biography
+ }
+},
+:text_contents => { #embedded name in elibri
+ :product_texts => { #embedded name in elibri
+   :id => :import_id, #name transition atrybutow elibri => our app
+   :text => :text,
+   :type_name => :text_type,
+   :author => :text_author,
+   :source_title => :source_title,
+   :source_url => :resource_link
+ }
+},
+:imprint => {
+ :imprint => {
+   :name => :name
+ }
+}
+```

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsElibriProduct'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+desc "Running specs"
+task :spec do |t|
+  exec "cd spec/ && bundle exec rspec acts_as_elibri_product_spec.rb"
+end
+
+task :default => ["spec"]

data/lib/acts_as_elibri_product/version.rb

@@ -0,0 +1,3 @@
+module ActsAsElibriProduct
+  VERSION = "0.1.0"
+end

data/lib/acts_as_elibri_product.rb

@@ -0,0 +1,144 @@
+require 'elibri_onix_mocks'
+require 'elibri_xml_versions'
+require 'ostruct'
+
+module ActsAsElibriProduct
+  extend ActiveSupport::Concern
+  
+  included do
+  end
+
+  module ClassMethods
+    
+    def self.traverse_vector
+      @@traverse_vector
+    end
+    
+    @@traverse_vector = {}
+        
+    def acts_as_elibri_product(traverse_vector = {})
+      @@traverse_vector = traverse_vector
+    end
+    
+    def create_from_elibri(xml_string)
+      product = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(xml_string).products.first
+      db_product = self.new
+      @@traverse_vector.each_pair do |k, v|
+        if v.is_a?(Symbol)
+          db_product.send(:write_attribute, v, product.send(k))
+        elsif v.is_a?(Hash)
+          object = db_product.send(v.keys.first)
+          ActsAsElibriProduct.set_objects_from_array(k, v.keys.first, v.values.first, product.send(k), db_product) if product.send(k)
+        end
+      end
+      db_product.old_xml = xml_string
+      db_product.save
+    end
+
+    def create_or_update_from_elibri(xml_string)
+      recreated_product = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(xml_string).products.first
+      if Product.find(:first, :conditions => {:record_reference => recreated_product.record_reference})
+      #update
+        Product.find(:first, :conditions => {:record_reference => recreated_product.record_reference}).update_product_from_elibri(xml_string)
+      else
+        Product.create_from_elibri(xml_string)
+      end
+    end
+    
+    def batch_create_or_update_from_elibri(xml_string)
+      recreated_products = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(xml_string)
+      recreated_products.products.each do |product|
+        xml = product.to_xml.to_s
+        dialect = product.elibri_dialect
+        header = "<?xml version='1.0' encoding='UTF-8'?>
+                  <ONIXMessage xmlns:elibri='http://elibri.com.pl/ns/extensions' xmlns='`http://www.editeur.org/onix/3.0/reference' release='3.0'>
+                      <elibri:Dialect>#{dialect}</elibri:Dialect>"
+
+        xml = header + xml + "</ONIXMessage>"
+        create_or_update_from_elibri(xml)
+      end
+    end
+    
+  end
+  
+  def update_product_from_elibri(new_xml)
+    product = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(read_attribute :old_xml).products.first
+    product_updated = Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(new_xml).products.first
+    elibri_xml_versions = Elibri::XmlVersions.new(product, product_updated)
+    details = elibri_xml_versions.diff
+    details[:changes].each do |change|
+      if change.is_a?(Symbol) && traverse_vector[change]
+        write_attribute(traverse_vector[change], product_updated.send(change))
+      elsif change.is_a?(Hash) && traverse_vector[change.keys.first]        
+        change.values.first.each do |elibri_attrib|
+          db_attrib = traverse_vector[change.keys.first].values.first[elibri_attrib]
+          object = self.send(traverse_vector[change.keys.first].keys.first)
+          elibri_object = product_updated.send(change.keys.first)
+          object.send(:write_attribute, db_attrib, elibri_object.send(elibri_attrib))
+        end
+    #    read_attribute(traverse_vector[change.keys.first]).send("#{traverse_vector[change[keys.first]]}=", product_updated.send(change.keys.first).send(change[keys.first]))
+      else
+        #nieistotne :)
+      end
+    details[:deleted].each do |deleted|
+      if traverse_vector[deleted.keys.first] && traverse_vector[deleted.keys.first].keys.first       
+        deleted.each_pair do |dele_key, dele|
+          dele.each do |del|
+            self.send(traverse_vector[dele_key].keys.first).each { |x| x if x.send(traverse_vector[dele_key].values.first[:id]) == del.id }.compact.each(&:delete)
+          end
+        end
+      end
+    end
+    details[:added].each do |added|
+      if traverse_vector[added.keys.first] && traverse_vector[added.keys.first].keys.first
+        ActsAsElibriProduct.set_objects_from_array(traverse_vector[added.keys.first], traverse_vector[added.keys.first].keys.first, traverse_vector[added.keys.first].values.first, added.values.first, self)
+ #       object = self.send(traverse_vector[added.keys.first].keys.first)
+#        ActsAsElibriProduct.set_objects_from_array(traverse_vector[added.keys.first].keys.fir, v.keys.first, v.values.first, product.send(k), db_product)
+      end
+    end
+    write_attribute(:old_xml, new_xml)
+    self.save
+  
+  end
+  
+end
+  
+  def traverse_vector
+    ActsAsElibriProduct::ClassMethods.traverse_vector
+  end
+  
+  def self.set_objects_from_array(elibri_object_name, db_object_name, object_traverse_vector, elibri_objects, db_product)
+    if elibri_objects.is_a?(Array)
+      elibri_objects.each do |elibri_object|
+        db_product.send(db_object_name).build.tap do |inner_object|
+      #    db_product.send
+          object_traverse_vector.each_pair do |k, v|
+            if v.is_a?(Hash)
+              #TODO
+             # set_objects_from_array(object.send(v.keys.first), v.values.first, product, k)
+            else
+              inner_object.send(:write_attribute, v, elibri_object.send(k))
+            end
+          end
+        end
+      end
+    else
+      db_product.send("build_#{db_object_name}").tap do |inner_object|
+    #    db_product.send
+        object_traverse_vector.each_pair do |k, v|
+          if v.is_a?(Hash)
+            #TODO
+           # set_objects_from_array(object.send(v.keys.first), v.values.first, product, k)
+          else
+            inner_object.send(:write_attribute, v, elibri_objects.send(k))
+          end
+        end
+        inner_object.save
+      end
+    end
+  end
+      
+end
+
+
+ActiveRecord::Base.send :include, ActsAsElibriProduct

data/lib/generators/add_acts_as_elibri_product/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate add_acts_as_elibri_product Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/add_acts_as_elibri_product/add_acts_as_elibri_product_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class AddActsAsElibriProductGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  argument :model_name, :type => :string
+  
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+  
+  def migration 
+    migration_template "add_old_xml_to_model.rb", "db/migrate/add_old_xml_to_#{model_name.underscore}_model.rb"
+  end
+  
+  private
+  
+  def table_name
+    model_name.pluralize.underscore
+  end
+  
+end

data/lib/generators/add_acts_as_elibri_product/templates/add_old_xml_to_model.rb

@@ -0,0 +1,9 @@
+class AddOldXmlTo<%= model_name %>Model < ActiveRecord::Migration
+  def up
+    add_column :<%= table_name %>, :old_xml, :text
+  end
+
+  def down
+    remove_column :<%= table_name %>, :old_xml
+  end
+end

data/lib/tasks/acts_as_elibri_product_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_elibri_product do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_elibri_product
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Piotr Szmielew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  version_requirements: *id001
+  name: rails
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id002
+  name: elibri_xml_versions
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id003
+  name: elibri_onix_mocks
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rspec
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id005
+  name: rspec-rails
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id006
+  name: sqlite3
+  type: :development
+description: Gem designed to allow easy addition of eLibri based product to your application. Currently only tested under REE.
+email: 
+- p.szmielew@ava.waw.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/acts_as_elibri_product/version.rb
+- lib/acts_as_elibri_product.rb
+- lib/generators/add_acts_as_elibri_product/add_acts_as_elibri_product_generator.rb
+- lib/generators/add_acts_as_elibri_product/templates/add_old_xml_to_model.rb
+- lib/generators/add_acts_as_elibri_product/USAGE
+- lib/tasks/acts_as_elibri_product_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://elibri.com.pl
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Easy addition of eLibri based product to your application
+test_files: []
+