cxml-ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98317a7d62fb43104dbd038070b78b22981025d0c328a26641a30fa87510e64d
+  data.tar.gz: 39e13fc128347f928599c4420e78dfeda06c5387cf30973181d97f42b50f12ab
+SHA512:
+  metadata.gz: e9d4be0021787dae95673c237463832c46673ab42c74dc0a25eaa7a06fd9a5494720351fe693e24a6389bbceab58c295d1ff5c5eb483b25aa84b11b7c35541b2
+  data.tar.gz: def87ff8ce650f3a2d81237a69e3a0e4fa859df5599cae58ab17327bf62a42ff03a3da25b64b87ac716ecf0534a4168790086b246f0e635b6f46150b8c9dcd4e

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Ruby Specs
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+    - name: Check with Rubocop
+      run: |
+        bundle exec rubocop

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+spec/reports
+tmp
+tmtags

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,175 @@
+AllCops:
+  Exclude:
+    - Gemfile
+    - vendor/**/*
+
+# # Disable checking for block length
+Metrics/BlockLength:
+  Enabled: false
+
+# # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/ModuleLength:
+  Max: 1500
+
+# # Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns: ['\A#', 'def .*# rubocop:disable']
+
+  # Raise the upper branch condition size, default max: 15
+Metrics/AbcSize:
+  Max: 20
+
+# # Too short methods lead to extraction of single-use methods, which can make
+# # the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 30
+
+# # Single quotes being faster is hardly measurable and only affects parse time.
+# # Enforcing double quotes reduces the times where you need to change them
+# # when introducing an interpolation. Use single quotes only if their semantics
+# # are needed.
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+# # We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+# # Mixing the styles looks just silly.
+# Style/HashSyntax:
+#   EnforcedStyle: ruby19_no_mixed_keys
+
+# # has_key? and has_value? are far more readable than key? and value?
+# Style/PreferredHashMethods:
+#   Enabled: false
+
+# Style/CollectionMethods:
+#   Enabled: true
+
+# # Either allow this style or don't. Marking it as safe with parenthesis
+# # is silly. Let's try to live without them for now.
+# Style/ParenthesesAroundCondition:
+#   AllowSafeAssignment: false
+# Lint/AssignmentInCondition:
+#   AllowSafeAssignment: false
+
+# # A specialized exception class will take one or more arguments and construct the message from it.
+# # So both variants make sense.
+# Style/RaiseArgs:
+#   Enabled: false
+
+# # Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# # The argument that fail should be used to abort the program is wrong too,
+# # there's Kernel#abort for that.
+# Style/SignalException:
+#   EnforcedStyle: only_raise
+
+# # do / end blocks should be used for side effects,
+# # methods that run a block for side effects and have
+# # a useful return value are rare, assign the return
+# # value to a local variable for those cases.
+# Style/MethodCalledOnDoEndBlock:
+#   Enabled: true
+
+# # Enforcing the names of variables? To single letter ones? Just no.
+# Style/SingleLineBlockParams:
+#   Enabled: false
+
+# # This is just silly. Calling the argument `other` in all cases makes no sense.
+# Style/OpMethod:
+#   Enabled: false
+
+# # Style preference
+Style/MethodDefParentheses:
+  Enabled: true
+  Exclude: 
+    - spec/**/*
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  Exclude: 
+    - spec/**/*
+
+# Style/WhileUntilModifier:
+#   Enabled: false
+
+# Style/IfUnlessModifier:
+#   Enabled: false
+
+# # Suppressing exceptions can be perfectly fine, and be it to avoid to
+# # explicitly type nil into the rescue since that's what you want to return,
+# # or suppressing LoadError for optional dependencies
+# Lint/HandleExceptions:
+#   Enabled: false
+
+# # Shadowing outer local variables with block parameters is often useful
+# # to not reinvent a new name for the same thing, it highlights the relation
+# # between the outer variable and the parameter. The cases where it's actually
+# # confusing are rare, and usually bad for other reasons already, for example
+# # because the method is too long.
+# Lint/ShadowingOuterLocalVariable:
+#   Enabled: false
+
+# # There are valid cases, for example debugging Cucumber steps,
+# # also they'll fail CI anyway
+# Lint/Debugger:
+#   Enabled: false
+
+# # No space makes the method definition shorter and differentiates
+# # from a regular assignment.
+# Layout/SpaceAroundEqualsInParameterDefault:
+#   EnforcedStyle: no_space
+
+# # Most readable form.
+# Layout/AlignHash:
+#   EnforcedHashRocketStyle: table
+#   EnforcedColonStyle: table
+
+# # Indenting the chained dots beneath each other is not supported by this cop,
+# # see https://github.com/bbatsov/rubocop/issues/1633
+# Layout/MultilineOperationIndentation:
+#   Enabled: false
+
+# Layout/SpaceInsideBlockBraces:
+#   # The space here provides no real gain in readability while consuming
+#   # horizontal space that could be used for a better parameter name.
+#   # Also {| differentiates better from a hash than { | does.
+#   SpaceBeforeBlockParameters: true
+
+# # No trailing space differentiates better from the block:
+# # foo} means hash, foo } means block.
+# Layout/SpaceInsideHashLiteralBraces:
+#   EnforcedStyle: no_space

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) OfficeLuv <development@officeluv.com>
+
+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,94 @@
+# cXML-Ruby
+
+![Ruby Specs](https://github.com/officeluv/cxml/workflows/Ruby%20Specs/badge.svg)
+
+Ruby implementation of the cXML protocol. 
+
+Currently supports these top-level documents in v1.2.037:
+
+- Request
+  - InvoiceDetailRequest
+  - OrderRequest
+  - PunchOutSetupRequest
+  - ConfirmationRequest
+- Response
+  - Status
+  - PunchOutSetupResponse
+- Message
+  - PunchOutOrderMessage
+- Pull requests welcome to support more!
+
+## Usage
+
+```rb
+some_xml = '....'
+doc = CXML::Document.new.from_xml(some_xml)
+# raises CXML::UnknownAttributeError if unknown fields are present
+
+doc.response.status.code
+# => 200
+doc.response.status.success?
+# => true
+
+# initialize docs with a hash
+CXML::Document.new(response: { status: { code: '200' } }).render.to_xml
+# => '<?xml.....'
+
+# initialize docs with instances
+status = CXML::Status.new(code: '200')
+response = CXML::Response.new(status: status)
+CXML::Document.new(response: response).render.to_xml
+# => '<?xml.....'
+
+# Set a different version
+CXML::Document.new(version: '1.1.0', response: { status: { code: '200' } }).render.to_xml
+# => '<?xml.....'
+```
+
+## Installation
+
+Add this line to the application's Gemfile:
+
+```ruby
+gem 'cxml-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cxml-ruby
+
+## Configuration
+
+```rb
+CXML.configure do |config|
+  # Set this to false to log intead of raise exception on unknown elements
+  # defaults to true, raises CXML::UnknownAttributeError
+  config.raise_unknown_elements = true
+
+  # Optionally set a custom logger, used for parsing error logging
+  # defaults to Logger.new(STDOUT, level: :warn)
+  config.logger = Logger.new(STDOUT, level: :warn)
+end
+```
+
+## Running Tests
+
+Install dependencies:
+
+```sh
+bundle install
+```
+
+Run suite:
+
+```sh
+rspec
+```
+
+## Documentation
+
+Procotol specifications could be found here [http://xml.cxml.org/current/cXMLUsersGuide.pdf](http://xml.cxml.org/current/cXMLUsersGuide.pdf)

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require('rspec/core/rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+task(default: :spec)

data/cxml-ruby.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require(File.expand_path('lib/cxml/version', __dir__))
+
+Gem::Specification.new do |s|
+  s.name        = 'cxml-ruby'
+  s.version     = CXML::VERSION
+  s.license     = 'MIT'
+  s.summary     = 'Parse/generate documents with the cXML protocol'
+  s.description = 'Ruby library to parse/generate documents with the cXML protocol'
+  s.homepage    = 'https://github.com/officeluv/cxml'
+  s.authors     = ['Josh Beckman', 'Eleni Chappen']
+  s.email       = ['josh@officeluv.com', 'eleni@officeluv.com']
+
+  s.add_development_dependency('pry', '~> 0.12')
+  s.add_development_dependency('rake', '~> 13.0')
+  s.add_development_dependency('rspec', '~> 3.9')
+  s.add_development_dependency('rubocop', '~> 0.81')
+
+  s.add_dependency('nokogiri', '~> 1.10')
+  s.add_dependency('xml-simple', '~> 1.1')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/cxml/accounting.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CXML
+  # accounting details in item outs
+  class Accounting < DocumentNode
+    accessible_attributes %i[
+      name
+    ]
+    accessible_nodes %i[
+      segments
+    ]
+
+    def initialize_segments(value)
+      value = [value] unless value.is_a?(Array)
+      @segments = value.map do |item|
+        CXML::Segment.new(item)
+      end
+    end
+
+    def initialize_segment(value)
+      value = [value] unless value.is_a?(Array)
+      @segments = value.map do |item|
+        CXML::Segment.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/additional_cost.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  class AdditionalCost < DocumentNode
+    accessible_nodes %i[
+      money
+      percentage
+    ]
+  end
+end

data/lib/cxml/additional_deduction.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CXML
+  class AdditionalDeduction < DocumentNode
+    accessible_nodes %i[
+      money
+      deduction_amount
+      deduction_percent
+      deducted_price
+    ]
+  end
+end

data/lib/cxml/address.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CXML
+  # address, typically in a purchase order message
+  class Address < DocumentNode
+    accessible_attributes %i[
+      address_id
+      iso_country_code
+    ]
+    accessible_nodes %i[
+      email
+      name
+      postal_address
+    ]
+  end
+end

data/lib/cxml/bill_to.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CXML
+  # shipping details object within punchout setup request
+  class BillTo < DocumentNode
+    accessible_nodes %i[
+      address
+    ]
+  end
+end

data/lib/cxml/browser_form_post.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CXML
+  class BrowserFormPost < DocumentNode
+    accessible_nodes %i[
+      url
+    ]
+
+    def render_nodes(node)
+      node.URL(url)
+    end
+  end
+end

data/lib/cxml/charge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class Charge < DocumentNode
+    accessible_nodes %i[
+      money
+    ]
+  end
+end

data/lib/cxml/classification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class Classification < DocumentNode
+    accessible_attributes %i[
+      domain
+    ]
+  end
+end

data/lib/cxml/confirmation_header.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CXML
+  class ConfirmationHeader < DocumentNode
+    accessible_attributes %i[
+      confirm_id
+      operation
+      type
+      notice_date
+      invoice_id
+    ]
+    accessible_nodes %i[
+      contact
+    ]
+  end
+end

data/lib/cxml/confirmation_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CXML
+  class ConfirmationItem < DocumentNode
+    accessible_attributes %i[
+      quantity
+      line_number
+    ]
+    accessible_nodes %i[
+      confirmation_status
+      unit_of_measure
+    ]
+  end
+end

data/lib/cxml/confirmation_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CXML
+  class ConfirmationRequest < DocumentNode
+    accessible_nodes %i[
+      confirmation_header
+      order_reference
+      confirmation_items
+    ]
+
+    def initialize_confirmation_item(value)
+      value = [value] unless value.is_a?(Array)
+      @confirmation_items = value.map do |item|
+        CXML::ConfirmationItem.new(item)
+      end
+    end
+
+    def initialize_confirmation_items(value)
+      value = [value] unless value.is_a?(Array)
+      @confirmation_items = value.map do |item|
+        CXML::ConfirmationItem.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/confirmation_status.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CXML
+  class ConfirmationStatus < DocumentNode
+    accessible_attributes %i[
+      quantity
+      type
+      shipment_date
+      delivery_date
+    ]
+    accessible_nodes %i[
+      comments
+      unit_of_measure
+      unit_price
+      extrinsics
+    ]
+
+    def initialize_extrinsic(value)
+      value = [value] unless value.is_a?(Array)
+      @extrinsics = value.map do |item|
+        Extrinsic.new(item)
+      end
+    end
+
+    def initialize_extrinsics(value)
+      value = [value] unless value.is_a?(Array)
+      @extrinsics = value.map do |item|
+        Extrinsic.new(item)
+      end
+    end
+  end
+end

data/lib/cxml/contact.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CXML
+  # contact object within punchout setup request
+  class Contact < DocumentNode
+    accessible_attributes %i[
+      role
+      address_id
+    ]
+    accessible_nodes %i[
+      email
+      name
+      postal_address
+    ]
+  end
+end

data/lib/cxml/country.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CXML
+  class Country < DocumentNode
+    accessible_attributes %i[
+      iso_country_code
+    ]
+  end
+end

data/lib/cxml/credential.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This element contains identification and authentication values.
+# Credential contains an Identity element and optionally a SharedSecret or a CredentialMac
+# element. The Identity element states who the Credential represents, while the optional
+# authentication elements verify the identity of the party
+#
+# Credential has the following attributes:
+#
+# *domain*
+# Specifies the type of credential. This attribute allows
+# documents to contain multiple types of credentials for multiple
+# authentication domains.
+# For messages sent on the Ariba Supplier Network, for
+# instance, the domain can be AribaNetworkUserId to indicate an
+# email address, DUNS for a D-U-N-S number, or NetworkId for a
+# preassigned ID.
+#
+# *type* - optional
+# Requests to or from a marketplace identify both the
+# marketplace and the member company in From or To Credential
+# elements. In this case, the credential for the marketplace uses
+# the type attribute, which is set to the value “marketplace”
+#
+# *SharedSecred*
+# The SharedSecret element is used when the Sender has a password that the requester recognizes.
+#
+# *CredentialMac*
+# The CredentialMac element is used for the Message Authentication Code (MAC)
+# authentication method. This authentication method is used in situations where the
+# sender must prove to the receiver that it has been authenticated by shared secret by a
+# trusted third party. For example, a direct PunchOut request can travel directly from a
+# buyer to a supplier without going through a network commerce hub, because it
+# contains a MAC (generated by the network commerce hub) that allows the supplier to
+# authenticate it.
+
+module CXML
+  class Credential < DocumentNode
+    accessible_attributes %i[
+      domain
+      type
+    ]
+    accessible_nodes %i[
+      shared_secret
+      identity
+      credential_mac
+    ]
+  end
+end