elibri_onix_mocks 0.1.0

data/lib/elibri_onix_mocks/onix_helpers.rb

@@ -0,0 +1,160 @@
+# encoding: UTF-8
+
+module OnixHelpers
+  extend ActiveSupport::Concern
+
+  module InstanceMethods
+
+    #zwróć różne poziomy tytułu, w formacie potrzebnym do exportu w ONIX-ie
+    def title_parts
+      [].tap do |res|
+        product_code =  Elibri::ONIX::Dict::Release_3_0::TitleElementLevel::PRODUCT      #01
+        collection_code = Elibri::ONIX::Dict::Release_3_0::TitleElementLevel::COLLECTION #02
+        res << OpenStruct.new(:level => collection_code, :title => collection.name, :part => self.collection_part) if collection
+        res << OpenStruct.new(:level => product_code, :title => self.title, :subtitle => self.subtitle, :part => self.title_part) if self.title.present?
+      end
+    end
+
+
+    # Zwróć datę publikacji w formacie ONIX
+    def publication_date(format = :onix, splitter = nil)
+      publication_year_str = self.publication_year ? "%04d"% self.publication_year : nil
+      publication_month_str = self.publication_month ? "%02d"% self.publication_month : nil
+      publication_day_str = self.publication_day ? "%02d"% self.publication_day : nil
+
+      case format
+        when :onix
+          splitter ||= ''
+          date_string = [publication_year_str, publication_month_str, publication_day_str].compact.join(splitter)
+        when :polish
+          splitter ||= '.'
+          date_string = [publication_day_str, publication_month_str, publication_year_str].compact.join(splitter)
+      end
+      date_string.blank? ? nil : date_string
+    end
+
+
+    def publication_date_with_onix_format_code
+       #lista 55
+       if self.publication_year.present? && self.publication_month.present? && self.publication_day.present?
+         [publication_date, Elibri::ONIX::Dict::Release_3_0::DateFormat::YYYYMMDD]
+       elsif self.publication_year.present? && self.publication_month.present?
+         [self.publication_year.to_s + "%02d" % self.publication_month, Elibri::ONIX::Dict::Release_3_0::DateFormat::YYYYMM] 
+       elsif self.publication_year.present?
+         [self.publication_year.to_s, Elibri::ONIX::Dict::Release_3_0::DateFormat::YYYY]
+       else
+         [nil, nil]
+       end
+    end
+
+
+    # Parsuj datę publikacji z ONIX`a (YYYYMMDD) i uzupełnij odpowiednie pola
+    def publication_date=(date_from_xml)
+      if match = date_from_xml.to_s.match(/ (\d{4}) [\s-]? (\d{2})? [\s-]? (\d{2})? /x)
+        self.publication_year = $1
+        self.publication_month = $2
+        self.publication_day = $3
+      else
+        self.publication_year = self.publication_month = self.publication_day = nil if date_from_xml.blank?
+      end
+    end
+
+
+    # TODO
+    def notification_type
+      if current_state == :private
+        raise "Cannot handle private state"
+      elsif current_state == :announced
+        Elibri::ONIX::Dict::Release_3_0::NotificationType.find_by_onix_code(Elibri::ONIX::Dict::Release_3_0::NotificationType::EARLY_NOTIFICATION)
+      elsif current_state == :preorder
+        Elibri::ONIX::Dict::Release_3_0::NotificationType.find_by_onix_code(Elibri::ONIX::Dict::Release_3_0::NotificationType::ADVANCED_NOTIFICATION)
+      else
+        Elibri::ONIX::Dict::Release_3_0::NotificationType.find_by_onix_code(Elibri::ONIX::Dict::Release_3_0::NotificationType::CONFIRMED_ON_PUBLICATION)
+      end
+    end
+    
+    #hack wynikający z nieobecności maszyny stanów
+    def current_state
+      state
+    end
+
+
+    def publishing_status_onix_code
+      if current_state.to_sym == :private #domyślny stan
+        raise "Cannot handle private state"
+      elsif current_state.to_sym == :announced    #zapowiedź
+        Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::FORTHCOMING
+      elsif current_state.to_sym == :preorder     #przedsprzedaż
+        Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::FORTHCOMING
+      elsif current_state.to_sym == :published    #dostępna na rynku
+        Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::ACTIVE
+      elsif current_state.to_sym == :out_of_print #nakład wyczerpany
+        Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::OUT_OF_PRINT
+      elsif current_state.to_sym == :deleted      #błędnie stworzony rekord
+        Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::UNSPECIFIED
+      else
+        raise "Don't know how to handle state = #{current_state}"
+      end
+    end
+
+    def publishing_status_onix_code=(code)
+      if code.present?
+        if code == Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::ACTIVE
+          self.state = "published"
+        elsif code == Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::OUT_OF_PRINT
+          self.state = "out_of_print"
+        elsif code == Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode::FORTHCOMING
+          self.state = "preorder"
+        else
+          raise "Don't know how to handle publishing_stats_onix_code = #{code}"
+        end
+      end
+    end
+
+    def form
+      Elibri::ONIX::Dict::Release_3_0::ProductFormCode.find_by_onix_code(self.product_form_onix_code)
+    end
+
+    def publishing_status
+      Elibri::ONIX::Dict::Release_3_0::PublishingStatusCode.find_by_onix_code(self.publishing_status_onix_code)
+    end
+
+    def epub_technical_protection
+      Elibri::ONIX::Dict::Release_3_0::EpubTechnicalProtection.find_by_onix_code(self.epub_technical_protection_onix_code)
+    end
+
+    def form_detail
+      Elibri::ONIX::Dict::Release_3_0::ProductFormDetail.find_by_onix_code(self.product_form_detail_onix_code)
+    end
+
+    def audience_range_present?
+      self.audience_age_from.present? or self.audience_age_to.present?
+    end
+
+
+    def authorship_kind
+      value = self.method_missing(:authorship_kind) || ActiveSupport::StringInquirer.new(:user_given.to_s)
+    end
+
+
+   def series_membership_kind
+      value = self.method_missing(:series_membership_kind) || ActiveSupport::StringInquirer.new(:user_given.to_s)
+    end
+
+
+    def series_names
+      self.series_memberships.map {|series_membership| series_membership.publisher_series.try(:name)}.compact
+    end
+
+    def stock_quantity_for_merlin
+      if stock_quantity.nil?
+        0
+      elsif stock_quantity > 50
+        50
+      else
+        stock_quantity
+      end
+    end
+
+  end
+end

data/lib/elibri_onix_mocks/version.rb

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

data/lib/elibri_onix_mocks/xml_variant.rb

@@ -0,0 +1,122 @@
+# encoding: UTF-8
+require 'set'
+
+module Elibri
+
+  # Klasa implementująca logikę wariantów XML produktów. Gdy klient zapłaci za pełne informacje
+  # o produkcie, to dostaje bogatszy XML. Poniższa klasa jest tylko helperem, który upraszcza
+  # i redukuje kod w innych miejscach aplikacji.
+  class XmlVariant
+    attr_reader :features
+
+    # Wyjątek zgłaszany przy nieprawidłowej kombinacji wariantu:
+    class InvalidFeature < Exception; end
+
+    FEATURES_SEPARATOR = ':'
+
+    # Dostępne elementy XML produktu. Gdy nic nie będzie wybrane, XML będzie zawierał
+    # tylko RecordReference.
+    FEATURES = ActiveSupport::OrderedHash.new
+    FEATURES[:basic_meta] = 'podstawowe meta-dane produktów'
+    FEATURES[:media_files] = 'linki do załączników (okładki, fragmenty treści)'
+    FEATURES[:other_texts] = 'opisy szczegółowe (spis treści, recenzje)'
+    FEATURES[:stocks] = 'stany magazynowe dostawców'
+
+    #jeśli ostatni argument to true, to nie waliduj, czy kobinacja jest prawidłowa,
+    #a więc jest jedną z ALL_FEATURES_COMBINATIONS
+    def initialize(*features)
+      @features = Array(features).flatten
+      if @features[-1] === true
+        ignore_unknow_combinations = true
+        @features.pop
+      else
+        ignore_unknow_combinations = false
+      end
+      @features = @features.reject(&:blank?).map(&:to_sym).to_set
+
+      unless (@features - FEATURES.keys).empty?
+        raise InvalidFeature.new("Unknown xml features #{@features.inspect}")
+      end
+      unless ignore_unknow_combinations
+        if @features.present? and !ALL_FEATURES_COMBINATIONS.map(&:features).include?(@features)
+          raise InvalidFeature.new("Unknow combination of xml features #{@features.inspect}")
+        end
+      end
+    end
+
+    # Wszystkie możliwe kombinacje wariantów XML - zbiór uzupełniany na końcu klasy.
+    # Upraszcza kod odświeżacza XML. W celu odświeżenia wszystkich możliwych wariantów XML
+    # dla produktu, po prostu iteruję po tej kolekcji.
+    ALL_FEATURES_COMBINATIONS = Set.new
+    ALL_FEATURES_COMBINATIONS << XmlVariant.new([:basic_meta, :media_files, :other_texts], true)
+    ALL_FEATURES_COMBINATIONS << XmlVariant.new([:basic_meta, :media_files, :other_texts, :stocks], true)
+    ALL_FEATURES_COMBINATIONS << XmlVariant.new([:stocks], true)
+
+
+    # Fabryka budująca instancę XmlVariant ze stringu 'basic_meta:media_files:other_texts:stocks'
+    def self.deserialize(features_str, ignore_unknow_combinations = false)
+      if ignore_unknow_combinations
+        XmlVariant.new(features_str.to_s.split(FEATURES_SEPARATOR), true)
+      else
+        XmlVariant.new(features_str.to_s.split(FEATURES_SEPARATOR))
+      end
+    end
+
+    def except(*features)
+      excluded_features = Array(features).flatten.map(&:to_sym)
+      XmlVariant.new( (self.features - excluded_features).to_a )
+    end
+
+
+    def ==(other_xml_variant)
+      self.features == other_xml_variant.features
+    end
+
+
+    def eql?(other_xml_variant)
+      self == other_xml_variant
+    end
+
+
+    def equal?(other_xml_variant)
+      self == other_xml_variant
+    end
+
+
+    # Żeby działało porównywanie w Set`ach
+    def hash
+      self.features.hash
+    end
+
+
+    def feature_included?(feature)
+      self.features.include?(feature.to_sym)
+    end
+
+
+    FEATURES.keys.each do |feature_sym|
+      self.class_eval %Q{
+        def includes_#{feature_sym}?              #  def includes_other_texts?               
+          feature_included?(:#{feature_sym})      #    feature_included?(:other_texts)
+        end                                       #  end
+      }, __FILE__, __LINE__
+    end  
+
+
+    # Wykorzystywane do utworzenia nazwy pliku XML oraz serializacji wariantu w MySQL.
+    # Zwraca np. 'basic_meta:media_files:other_texts:stocks'
+    def serialize
+      # features muszą być posortowane, aby za każdym razem generować tę samą nazwę - Set nie gwarantuje kolejności.
+      self.features.map(&:to_s).sort.join(FEATURES_SEPARATOR) 
+    end
+
+
+    def to_s
+      "#<Elibri::XmlVariant: features=#{self.features.inspect}>"
+    end
+
+    # Wariant zawierający wszystkie możliwe dane:
+    FULL_VARIANT = self.new(FEATURES.keys)
+  end
+
+end

data/spec/elibri_onix_mocks_spec.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+$VERBOSE = nil #temp: supress id warnings
+
+describe Elibri::XmlMocks::Examples do
+  
+  [
+  :basic_product, :book_example, :onix_record_identifiers_example, :onix_product_form_example,
+  :onix_epub_details_example, :onix_categories_example, :onix_languages_example,
+  :onix_measurement_example, :onix_sale_restrictions_example, :onix_audience_range_example,
+  :onix_publisher_info_example, :onix_subjects_example, :onix_edition_example, :onix_ebook_extent_example,
+  :onix_audiobook_extent_example, :onix_no_contributors_example, :onix_collective_work_example,
+  :onix_contributors_example, :onix_announced_product_example, :onix_preorder_product_example,
+  :onix_published_product_example, :onix_out_of_print_product_example, :onix_titles_example,
+  :onix_title_with_collection_example, :onix_texts_example, :onix_related_products_example,
+  :onix_supply_details_example, :onix_series_memberships_example, :onix_supporting_resources_example,
+  :onix_elibri_extensions_example, :contributor_mock, :review_mock, :supply_detail_mock, :imprint_mock,
+  :description_mock
+  ].each do |symbol|
+  
+    it "should create #{symbol} xml and parse it properly" do
+      Elibri::XmlMocks::Examples.send(symbol, {}).should_not be_nil
+      Elibri::ONIX::XMLGenerator.new(Elibri::XmlMocks::Examples.send(symbol, {})).should_not be_nil
+      Elibri::ONIX::Release_3_0::ONIXMessage.from_xml(Elibri::ONIX::XMLGenerator.new(Elibri::XmlMocks::Examples.send(symbol, {})).to_s)
+    end
+  
+  end
+  
+  #more tests to add
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+
+require 'elibri_onix_mocks'
+require 'rspec'
+require 'ostruct'
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: elibri_onix_mocks
+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 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: elibri_onix_dict
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: elibri_api_client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: "Usage: Elibri::XmlGenerator.basic_product etc"
+email: 
+- p.szmielew@ava.waw.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- elibri_onix_mocks.gemspec
+- lib/elibri_onix_mocks.rb
+- lib/elibri_onix_mocks/generators/xml_generator.rb
+- lib/elibri_onix_mocks/generators/xml_tags.yml
+- lib/elibri_onix_mocks/mocks/mock_method_missing.rb
+- lib/elibri_onix_mocks/mocks/xml_mocks.rb
+- lib/elibri_onix_mocks/onix_helpers.rb
+- lib/elibri_onix_mocks/version.rb
+- lib/elibri_onix_mocks/xml_variant.rb
+- spec/elibri_onix_mocks_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+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: elibri_onix_mocks
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Gem that allows you to mock eLibri style xmls
+test_files: 
+- spec/elibri_onix_mocks_spec.rb
+- spec/spec_helper.rb