RubyGems - sapoci - Versions diffs - 0.1.4 - Mend

sapoci 0.1.4

Files changed (10) hide show

data/CHANGELOG.md +21 -0
data/LICENSE +21 -0
data/README.md +14 -0
data/lib/sapoci.rb +16 -0
data/lib/sapoci/core_ext.rb +2 -0
data/lib/sapoci/core_ext/blank.rb +59 -0
data/lib/sapoci/core_ext/try.rb +11 -0
data/lib/sapoci/document.rb +116 -0
data/lib/sapoci/item.rb +139 -0
metadata +102 -0

data/CHANGELOG.md ADDED

@@ -0,0 +1,21 @@
+# 0.1.4, release 2011-07-14
+* Add various before_type_cast methods
+# 0.1.3, release 2011-07-14
+* Ignore whitespace on numeric fields
+# 0.1.2, release 2011-07-05
+* Use Nokogiri 1.5.0
+# 0.1.1, release 2011-04-30
+* Removed version from sources and put it into gemspec only
+# 0.1.0, released 2011-04-29
+* Added a gemspec
+* Initial release on GitHub

data/LICENSE ADDED

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2011 Oliver Eilhard
+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 ADDED

@@ -0,0 +1,14 @@
+# SAP-OCI
+## Description
+Ruby library and Rails plugin for punchout via SAP OCI protocol.
+## Installation
+$ gem install sapoci
+## License
+Released under the MIT License. See the LICENSE file for further
+details.

data/lib/sapoci.rb ADDED

@@ -0,0 +1,16 @@
+# Copyright (C) 2010 Oliver Eilhard
+#
+# This SAP OCI library is freely distributable under
+# the terms of an MIT-style license.
+# See COPYING or http://www.opensource.org/licenses/mit-license.php.
+# This library is for parsing and emitting shopping cart data and
+# behavior in SAP OCI style.
+module SAPOCI
+  VERSION_40    = "4.0"
+  autoload :CoreExt,      'sapoci/core_ext.rb'
+  autoload :Document,     'sapoci/document.rb'
+  autoload :Item,         'sapoci/item.rb'
+end

data/lib/sapoci/core_ext.rb ADDED

	@@ -0,0 +1,2 @@
1	+ require 'sapoci/core_ext/try.rb'
2	+ require 'sapoci/core_ext/blank.rb'

data/lib/sapoci/core_ext/blank.rb ADDED

@@ -0,0 +1,59 @@
+class Object #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      respond_to?(:empty?) ? empty? : !self
+    end
+  end
+end
+class NilClass #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      true
+    end
+  end
+end
+class FalseClass #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      true
+    end
+  end
+end
+class TrueClass #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      false
+    end
+  end
+end
+class Array #:nodoc:
+  unless respond_to?(:blank?)
+    alias_method :blank?, :empty?
+  end
+end
+class Hash #:nodoc:
+  unless respond_to?(:blank?)
+    alias_method :blank?, :empty?
+  end
+end
+class String #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      self !~ /\S/
+    end
+  end
+end
+class Numeric #:nodoc:
+  unless respond_to?(:blank?)
+    def blank?
+      false
+    end
+  end
+end

data/lib/sapoci/core_ext/try.rb ADDED

@@ -0,0 +1,11 @@
+class Object
+  alias_method(:try, :__send__) unless respond_to?(:try)
+end
+class NilClass
+  unless respond_to?(:try)
+    def try(*args)
+      nil
+    end
+  end
+end

data/lib/sapoci/document.rb ADDED

@@ -0,0 +1,116 @@
+# encoding: utf-8
+require 'rubygems' unless RUBY_VERSION >= '1.9'
+require 'nokogiri'
+require 'sapoci/core_ext'
+module SAPOCI
+  # SAPOCI::Document is for parsing and emitting SAP OCI compliant
+  # data.
+  #
+  # Open a +Document+ by feeding it a string:
+  #
+  #   doc = SAPOCI::Document.from_html("<html>...</html>")
+  #
+  # Open a +Document+ by parsing a Rails-/Rack compatible +Hash+:
+  #
+  #   doc = SAPOCI::Document.from_params({ "NEW_ITEM-DESCRIPTION"=>{"1"=>"Standard Visitenkarte deutsch 200 St."} })
+  #
+  class Document
+    def initialize(items)
+      @items = items
+    end
+    # Create a new document from a HTML string.
+    def self.from_html(html)
+      html_doc = Nokogiri::HTML(html)
+      doc = Document.new(parse_html(html_doc))
+      yield doc if block_given?
+      doc
+    end
+    # Create a new document from a Rails-/Rack-compatible
+    # params hash.
+    def self.from_params(params)
+      doc = Document.new(parse_params(params))
+      yield doc if block_given?
+      doc
+    end
+    # All +Item+ instances.
+    attr_reader :items
+    # Returns all +items+ as HTML hidden field tags.
+    def to_html(options = {})
+      html = []
+      self.items.each do |item|
+        html << item.to_html(options)
+      end
+      html.join
+    end
+  private
+    # Parses a Nokogiri HTML document and returns
+    # +Item+ instances in an array.
+    def self.parse_html(doc)
+      items = {}
+      doc.xpath("//input[starts-with(@name, 'NEW_ITEM-')]").each do |item_node|
+        name = item_node.attribute("name")
+        if /NEW_ITEM-(\w+)\[(\d+)\]/.match(name)
+          property = $1
+          index = $2.to_i - 1
+          value = item_node.attribute("value").value
+          items[index] = Item.new(index) unless items[index]
+          items[index].send((property+'=').downcase.to_sym, value)
+        end
+      end
+      items.inject([]) { |memo, (key, value)| memo << value }.sort_by(&:index)
+    end
+    # Parses a Rails-/Rack-compatible params hash and returns
+    # +Item+ instances in an array.
+    def self.parse_params(params)
+      items = {}
+      (params || {}).each do |oci_name, oci_values|
+        if oci_name =~ /NEW_ITEM-/
+          # Parse anything but NEW_ITEM-LONGTEXT (which is special, see below)
+          oci_values.each do |index, value|
+            index = index.to_i - 1 rescue next
+            property = /NEW_ITEM-(\w+)/.match(oci_name)[1]
+            next if property =~ /LONGTEXT/
+            method = (property+'=').downcase.to_sym
+            items[index] = Item.new(index) unless items[index]
+            items[index].send(method, value) if items[index].respond_to?(method)
+          end if oci_values && oci_values.respond_to?(:each)
+          # LONGTEXT is a special case because it doesn't follow the conventions
+          # Format is:
+          #   NEW_ITEM-LONTEXT_n:132[]
+          # But shops use other (invalid) formats as well (and we're ready to accept them):
+          #   NEW_ITEM-LONGTEXT_n:132[n]
+          #   NEW_ITEM_LONGTEXT_n:132
+          #
+          if /NEW_ITEM-LONGTEXT_(\d+):132/.match(oci_name)
+            index = $1.to_i - 1
+            if oci_values.is_a?(Array)
+              # NEW_ITEM-LONGTEXT_1:132[]
+              items[index] = Item.new(index) unless items[index]
+              items[index].longtext = oci_values.first
+            elsif oci_values.is_a?(String)
+              # NEW_ITEM-LONGTEXT_1:132 <= invalid but parsed!
+              items[index] = Item.new(index) unless items[index]
+              items[index].longtext = oci_values
+            elsif oci_values.is_a?(Hash)
+              # NEW_ITEM-LONGTEXT_1:132[1] <= invalid but parsed!
+              items[index] = Item.new(index) unless items[index]
+              items[index].longtext = oci_values.first.last
+            end
+          end if oci_values
+        end # oci_name =~ /NEW_ITEM-/
+      end
+      items.inject([]) { |memo, (key, value)| memo << value }.sort_by(&:index)
+    end
+  end
+end

data/lib/sapoci/item.rb ADDED

@@ -0,0 +1,139 @@
+# encoding: utf-8
+require 'rubygems' unless RUBY_VERSION >= '1.9'
+require 'nokogiri'
+require 'sapoci/core_ext'
+require 'bigdecimal'
+module SAPOCI
+  class Item
+    attr_reader :index
+    attr_accessor :description
+    attr_accessor :matnr
+    attr_accessor :quantity
+    attr_accessor :unit
+    attr_accessor :price
+    attr_accessor :currency
+    attr_accessor :priceunit
+    attr_accessor :leadtime
+    attr_accessor :longtext
+    attr_accessor :vendor
+    attr_accessor :vendormat
+    attr_accessor :manufactcode
+    attr_accessor :manufactmat
+    attr_accessor :matgroup
+    attr_accessor :service
+    attr_accessor :contract
+    attr_accessor :contract_item
+    attr_accessor :ext_quote_id
+    attr_accessor :ext_quote_item
+    attr_accessor :ext_product_id
+    attr_accessor :attachment
+    attr_accessor :attachment_title
+    attr_accessor :attachment_purpose
+    attr_accessor :ext_schema_type
+    attr_accessor :ext_category_id
+    attr_accessor :ext_category
+    attr_accessor :sld_sys_name
+    attr_accessor :cust_field1
+    attr_accessor :cust_field2
+    attr_accessor :cust_field3
+    attr_accessor :cust_field4
+    attr_accessor :cust_field5
+    # Initializes the item.
+    def initialize(index)
+      @index = index
+    end
+    def quantity
+      BigDecimal.new("0#{@quantity.to_s.strip}")
+    end
+    def quantity_before_type_cast
+      @quantity
+    end
+    def price
+      BigDecimal.new("0#{@price.to_s.strip}")
+    end
+    def price_before_type_cast
+      @price
+    end
+    def priceunit
+      BigDecimal.new("0#{@priceunit.to_s.strip}")
+    end
+    def priceunit_before_type_cast
+      @priceunit
+    end
+    def leadtime
+      @leadtime.to_i if @leadtime
+    end
+    def leadtime_before_type_cast
+      @leadtime
+    end
+    def service?
+      self.service == "X"
+    end
+    # Returns the item properties as HTML hidden field tags.
+    def to_html(options = {})
+      html = []
+      html << hidden_field_tag("DESCRIPTION",     self.description)     unless self.description.blank?
+      html << hidden_field_tag("MATNR",           self.matnr)           unless self.matnr.blank?
+      html << hidden_field_tag("QUANTITY",        "%015.3f" % self.quantity)
+      html << hidden_field_tag("UNIT",            self.unit)            unless self.unit.blank?
+      html << hidden_field_tag("PRICE",           "%015.3f" % self.price)
+      html << hidden_field_tag("CURRENCY",        self.currency)        unless self.currency.blank?
+      html << hidden_field_tag("PRICEUNIT",       self.priceunit.to_i)  if self.priceunit.to_i > 0
+      html << hidden_field_tag("LEADTIME",        "%05d" % self.leadtime) if self.leadtime.to_i > 0
+      html << hidden_field_tag("VENDOR",          self.vendor)          unless self.vendor.blank?
+      html << hidden_field_tag("VENDORMAT",       self.vendormat)       unless self.vendormat.blank?
+      html << hidden_field_tag("MANUFACTCODE",    self.manufactcode)    unless self.manufactcode.blank?
+      html << hidden_field_tag("MANUFACTMAT",     self.manufactmat)     unless self.manufactmat.blank?
+      html << hidden_field_tag("MATGROUP",        self.matgroup)        unless self.matgroup.blank?
+      html << hidden_field_tag("SERVICE",         "X")                  if     self.service?
+      html << hidden_field_tag("CONTRACT",        self.contract)        unless self.contract.blank?
+      html << hidden_field_tag("CONTRACT_ITEM",   self.contract_item)   unless self.contract_item.blank?
+      html << hidden_field_tag("EXT_QUOTE_ID",    self.ext_quote_id)    unless self.ext_quote_id.blank?
+      html << hidden_field_tag("EXT_QUOTE_ITEM",  self.ext_quote_item)  unless self.ext_quote_item.blank?
+      html << hidden_field_tag("EXT_PRODUCT_ID",  self.ext_product_id)  unless self.ext_product_id.blank?
+      html << hidden_field_tag("ATTACHMENT",      self.attachment)      unless self.attachment.blank?
+      html << hidden_field_tag("ATTACHMENT_TITLE", self.attachment_title) unless self.attachment_title.blank?
+      html << hidden_field_tag("ATTACHMENT_PURPOSE", self.attachment_purpose) unless self.attachment_purpose.blank?
+      html << hidden_field_tag("EXT_SCHEMA_TYPE", self.ext_schema_type) unless self.ext_schema_type.blank?
+      html << hidden_field_tag("EXT_CATEGORY_ID", self.ext_category_id) unless self.ext_category_id.blank?
+      html << hidden_field_tag("EXT_CATEGORY",    self.ext_category)    unless self.ext_category.blank?
+      html << hidden_field_tag("SLD_SYS_NAME",    self.sld_sys_name)    unless self.sld_sys_name.blank?
+      html << hidden_field_tag("CUST_FIELD1",     self.cust_field1)     unless self.cust_field1.blank?
+      html << hidden_field_tag("CUST_FIELD2",     self.cust_field2)     unless self.cust_field2.blank?
+      html << hidden_field_tag("CUST_FIELD3",     self.cust_field3)     unless self.cust_field3.blank?
+      html << hidden_field_tag("CUST_FIELD4",     self.cust_field4)     unless self.cust_field4.blank?
+      html << hidden_field_tag("CUST_FIELD5",     self.cust_field5)     unless self.cust_field5.blank?
+      html << "<input type=\"hidden\" name=\"NEW_ITEM-LONGTEXT_#{index + 1}:132[]\" value=\"#{escape_html(self.longtext)}\" />" unless self.longtext.blank?
+      html.join
+    end
+  private
+    def hidden_field_tag(name, value, options = {})
+      "<input type=\"hidden\" name=\"NEW_ITEM-#{name}[#{index + 1}]\" value=\"#{escape_html(value)}\" />"
+    end
+    ESCAPE_HTML	=	{ "&" => "&amp;", "<" => "&lt;", ">" => "&gt;", "'" => "&#39;", '"' => "&quot;", }
+    ESCAPE_HTML_PATTERN	=	Regexp.union(ESCAPE_HTML.keys)
+    # Shamelessly borrowed from Rack::Utils.escape_html(s)
+    def escape_html(s)
+      s.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sapoci
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+  prerelease:
+platform: ruby
+authors:
+- Oliver Eilhard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-08-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70261606168780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261606168780
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70261606168260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70261606168260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70261606167780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70261606167780
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70261606166980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *70261606166980
+description: Ruby library and Rails plugin for punchout via SAP OCI protocol.
+email:
+- oliver.eilhard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- lib/sapoci.rb
+- lib/sapoci/core_ext.rb
+- lib/sapoci/core_ext/blank.rb
+- lib/sapoci/core_ext/try.rb
+- lib/sapoci/document.rb
+- lib/sapoci/item.rb
+- CHANGELOG.md
+- LICENSE
+- README.md
+homepage: http://github.com/meplato/sapoci
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.7
+signing_key:
+specification_version: 3
+summary: Ruby library and Rails plugin for punchout via SAP OCI protocol.
+test_files: []