elibri_connect 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.md

@@ -0,0 +1,50 @@
+# Elibri Connect gem #
+
+## Continuous integration status ##
+### Elibri dependencies:  ###
+Elibri Xml Versions: [![Build Status](https://secure.travis-ci.org/elibri/elibri_xml_versions.png?branch=master)](http://travis-ci.org/elibri/elibri_xml_versions)  
+Elibri Onix Mocks: [![Build Status](https://secure.travis-ci.org/elibri/elibri_onix_mocks.png?branch=master)](http://travis-ci.org/elibri/elibri_onix_mocks)  
+Acts as Elibri Product: [![Build Status](https://secure.travis-ci.org/elibri/acts_as_elibri_product.png?branch=master)](http://travis-ci.org/elibri/acts_as_elibri_product)  
+
+### Elibri Connect: ###
+[![Build Status](https://secure.travis-ci.org/elibri/elibri_connect.png?branch=master)](http://travis-ci.org/elibri/elibri_connect)
+
+
+## Description ##
+
+Gem designed to allow easy addition of elibri based product system to your application.
+Currently tested and support only on REE - due to dependencies.
+
+## Usage ##
+
+* add `gem 'elibri_connect'` to you Gemfile  
+* run `bundle install`  
+
+Now - depending on your situation you may choose one of four options:  
+
+* `rails generate elibri:connect:config` to create only configuration file in initializers, in which you need to supply your own user/password combination.  
+* `rails generate elibri:connect:db_structure` to create db structure and models (product, contributor and product_text), which will have turned on elibri synchronisation.  
+* `rails generate elibri:connect:whenever` to create config/schedule.rb file, which will invoke elibri sync every 6 hours. It will overwrite your actual config/schedule.rb - so please be careful.  
+* `rails generate elibri:connect:install` which will invoke all three previous generators.  
+
+If you have working application, and you need to add support to existing product model - please look here for more information about adding acts_as_elibri_product declaration to model (including traverse vector examples): [elibri/acts_as_elibri_product](https://github.com/elibri/acts_as_elibri_product)
+
+After creation of config file, gem will provide you with rake task: `rake elibri:update_products` which will connect to elibri, download new and update existing product. You can also use it from your code using `Elibri::Connect.update_products!` method.  
+If you need to access raw api client - you can get it by invoking `Elibri::Connect.api_client`.  
+
+Gem has additional mode of operation called test_mode - you can get into it, by setting `test_mode=true` inside configuration file. When using it your application will not connect to elibri, instead it will use elibri_xml_mocks to mock and create product for your app.
+
+## Anatomy of config file ##
+
+Config file looks like this, and needs to be in config/initializers directory (generate command can provide one for you):  
+
+```ruby
+Elibri::Connect.setup do |config|
+  config.login = your elibri api login here
+  config.password = your elibri api password here
+  config.api_version = 'v1' #api_version - doesn't need to be changed
+  config.onix_dialect = '3.0.1' #onix_dialect - doesn't need to be changed
+  config.product_model = :product #if you use other model than product - you need to set different name here
+  config.test_mode = true #- add this line to config if you want to avoid connecting to elibri and use mocked data
+end
+```

data/Rakefile

@@ -0,0 +1,34 @@
+#!/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    = 'ElibriConnect'
+  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/dummy && bundle exec rake db:create:all && bundle exec rake db:migrate && bundle exec rake db:test:prepare && cd .. && bundle exec rspec elibri_connect_spec.rb"
+end
+
+task :default => ["spec"]
+

data/lib/elibri_connect.rb

@@ -0,0 +1,39 @@
+require 'acts_as_elibri_product'
+require 'elibri_api_client'
+require 'elibri_onix_mocks'
+
+require 'elibri_connect/railtie'
+
+module Elibri
+  module Connect
+  
+    class << self
+      attr_accessor :login, :password, :api_version, :onix_dialect, :test_mode, :product_model
+    end
+    
+    def self.setup(&block)
+      yield self
+    end
+    
+    def self.api_client
+      Elibri::ApiClient.new(:login => login, :password => password, 
+                                  :api_version => api_version, :onix_dialect => onix_dialect)
+    end
+    
+    def self.update_products!
+      if test_mode
+        book = Elibri::XmlMocks::Examples.book_example
+        (self.product_model).to_s.capitalize.constantize.batch_create_or_update_from_elibri(Elibri::ONIX::XMLGenerator.new(book).to_s)
+      else
+        api = Elibri::ApiClient.new(:login => login, :password => password, 
+                                    :api_version => api_version, :onix_dialect => onix_dialect)
+        api.refill_all_queues! 
+        while (queue = api.pending_queues.find { |q| q.name == 'meta' })    
+          response = api.pop_from_queue('meta', :count => 25)                            
+          (self.product_model).to_s.capitalize.constantize.batch_create_or_update_from_elibri(response.onix)
+        end
+      end
+    end
+  
+  end
+end

data/lib/elibri_connect/railtie.rb

@@ -0,0 +1,11 @@
+require 'elibri_connect'
+require 'rails'
+module ElibriConnect
+  class Railtie < Rails::Railtie
+    railtie_name :elibri_connect
+
+    rake_tasks do
+      load "tasks/elibri_connect_tasks.rake"
+    end
+  end
+end

data/lib/elibri_connect/version.rb

@@ -0,0 +1,3 @@
+module ElibriConnect
+  VERSION = "0.1"
+end

data/lib/generators/elibri/connect/config/config_generator.rb

@@ -0,0 +1,17 @@
+module Elibri
+  module Connect
+    class ConfigGenerator < Rails::Generators::Base
+      desc "This generator creates an elibri configuration file at config/initializers"
+      def create_config_file
+        create_file "config/initializers/elibri_config.rb", 
+    %Q{Elibri::Connect.setup do |config|
+      config.login = 'login' #INSERT YOUR LOGIN HERE
+      config.password = 'password' #INSERT YOUR PASSWORD HERE
+      config.api_version = 'v1'
+      config.onix_dialect = '3.0.1'
+      config.product_model = :product #IF NEEDED CHANGE MODEL NAME HERE 
+    end}
+      end
+    end
+  end
+end

data/lib/generators/elibri/connect/db_structure/db_structure_generator.rb

@@ -0,0 +1,96 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Elibri
+  module Connect
+    class DbStructureGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "This generator creates basic models and database structure for using elibri"
+      def create_elibri_db_structure
+        create_file "app/models/contributor.rb", 
+    %Q{class Contributor < ActiveRecord::Base
+
+      belongs_to :product, :touch => true
+
+      attr_accessible :import_id, :role_name, :role, :from_language, :full_name, :title, :first_name, 
+                          :last_name_prefix, :last_name, :last_name_postfix, :biography
+    end}
+        create_file "app/models/product_text.rb",
+    %Q{class ProductText < ActiveRecord::Base
+
+      belongs_to :product, :touch => true
+
+      attr_accessible :import_id, :text, :text_type, :text_author, :source_title, :resource_link
+
+    end}
+        create_file "app/models/product.rb",
+    %Q[class Product < ActiveRecord::Base
+
+      with_options :autosave => true, :dependent => :destroy do |product|
+        product.has_many :contributors
+        product.has_many :product_texts
+        product.has_one :imprint
+      end
+
+      attr_accessible :isbn, :title, :full_title, :trade_title, :original_title, :publication_year,
+                      :publication_month, :publication_day, :number_of_pages, :width, :height, 
+                      :cover_type, :edition_statement, :audience_age_from, :audience_age_to, 
+                      :price_amount, :vat, :current_state, :product_form, :old_xml
+
+      #on left side elibri attributes, on right side our name of attribute               
+      acts_as_elibri_product :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,
+             :cover_price => :price_amount,
+             :vat => :vat,
+             :product_form => :product_form,
+             :no_contributor? => :no_contributor,
+             :unnamed_persons? => :unnamed_persons,
+             :contributors => { #name in elibri
+               :contributors => { #name in our db
+                 :id => :import_id,
+                 :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 => {
+               :product_texts => {
+                 :id => :import_id,
+                 :text => :text,
+                 :type_name => :text_type,
+                 :author => :text_author,
+                 :source_title => :source_title,
+                 :source_url => :resource_link
+               }
+             }
+    ]
+        migration_template "create_elibri_structure.rb", "db/migrate/create_elibri_structure.rb"
+      end
+  
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+  
+    end
+  end
+end

data/lib/generators/elibri/connect/db_structure/templates/create_elibri_structure.rb

@@ -0,0 +1,59 @@
+class CreateElibriStructure < ActiveRecord::Migration
+  
+  def change
+    create_table :contributors do |t|
+      t.integer :import_id
+      t.integer :product_id
+      t.string :role_name
+      t.string :role
+      t.string :from_language
+      t.string :full_name
+      t.string :title
+      t.string :first_name
+      t.string :last_name_prefix
+      t.string :last_name
+      t.string :last_name_postfix
+      t.text :biography
+
+      t.timestamps
+    end
+
+    create_table :product_texts do |t|
+      t.integer :import_id
+      t.integer :product_id
+      t.text :text
+      t.string :text_type
+      t.string :text_author
+      t.string :source_title
+      t.string :resource_link
+
+      t.timestamps
+    end
+
+    create_table :products do |t|
+      t.string :record_reference, :null => false
+      t.string :isbn
+      t.string :title
+      t.string :full_title
+      t.string :trade_title
+      t.string :original_title
+      t.integer :number_of_pages
+      t.integer :duration
+      t.integer :width
+      t.integer :height
+      t.string :cover_type
+      t.string :edition_statement
+      t.string :price_amount
+      t.integer :vat
+      t.string :pkwiu
+      t.string :current_state
+      t.string :product_form
+      t.boolean :preview_exists, :default => false
+      t.boolean :no_contributor, :default => false
+      t.boolean :unnamed_persons, :default => false
+      t.text :old_xml
+      t.timestamps
+    end
+        
+  end
+end

data/lib/generators/elibri/connect/install/install_generator.rb

@@ -0,0 +1,14 @@
+module Elibri
+  module Connect
+    class InstallGenerator < Rails::Generators::Base
+  
+      desc "This generator installs and elibri product system in application - including db structure, models and config file"
+      def install
+        Rails::Generators.invoke("elibri:connect:config")
+        Rails::Generators.invoke("elibri:connect:db_structure")
+        Rails::Generators.invoke("elibri:connect:whenever")
+        rake('db:migrate')
+      end
+    end
+  end
+end

data/lib/generators/elibri/connect/whenever/whenever_generator.rb

@@ -0,0 +1,13 @@
+module Elibri
+  module Connect
+    class WheneverGenerator < Rails::Generators::Base
+      desc "This generator creates an elibri whenever file, adding into cron and updating products every 6 hours"
+      def whenever
+        create_file "config/schedule.rb", 
+    %Q{every 6.hours do
+      runner "Elibri::Connect.update_products!"
+    end}
+      end
+    end
+  end
+end

data/lib/tasks/elibri_connect_tasks.rake

@@ -0,0 +1,11 @@
+# desc "Explaining what the task does"
+# task :elibri_connect do
+#   # Task goes here
+# end
+
+namespace :elibri do
+  desc "Load products from elibri - creating and updating product where needed"
+  task :update_products do
+    Elibri::Connect.update_products!
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: elibri_connect
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Piotr Szmielew
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-06 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: acts_as_elibri_product
+  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_api_client
+  type: :runtime
+- !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: elibri_onix_mocks
+  type: :runtime
+- !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: whenever
+  type: :runtime
+- !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
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id007
+  name: rspec
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id008
+  name: rspec-rails
+  type: :development
+description: |-
+  Gem designed to allow easy addition of elibri based product system to your application.
+    Currently tested and support only on REE - due to dependencies.
+email: 
+- p.szmielew@ava.waw.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/elibri_connect/railtie.rb
+- lib/elibri_connect/version.rb
+- lib/elibri_connect.rb
+- lib/generators/elibri/connect/config/config_generator.rb
+- lib/generators/elibri/connect/db_structure/db_structure_generator.rb
+- lib/generators/elibri/connect/db_structure/templates/create_elibri_structure.rb
+- lib/generators/elibri/connect/install/install_generator.rb
+- lib/generators/elibri/connect/whenever/whenever_generator.rb
+- lib/tasks/elibri_connect_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: Gem designed to allow easy addition of elibri based product system to your application.
+test_files: []
+