paramedic 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c4e97b7c96c2e85cef5daf072af7b7ca46de76f
-  data.tar.gz: d96c454cff95c4df687ac868cfa6f12d77b911ed
+  metadata.gz: 05384eaaef8a30563606ec636ebc18d4212436cb
+  data.tar.gz: ab3c3df45ccf8d10d52b4da661da2453561dca25
 SHA512:
-  metadata.gz: 353aba54ab255a3e9d9195dffd6435152ad83b55bf8dcba2eb527bf3d38d06fddd0e76166633aa69021e356d81cd9e83c3d05418b656e138ea98ce0e7e8e9e1d
-  data.tar.gz: 2e0f063155d72410748917b0a98032dc0e33769af2b2f1c0949f9335e6ac0be12374fc4f2fc218c2d8c318a1f2ad454d608e460afb9f55efde8c2fbcdbb4dc62
+  metadata.gz: ccb93be6473d3eab1579b454d2e25151ed31e67d057d5bc9341ac53617d038fb360f3f73ea3ab85810cbbba64ecf349e50b2f3689efedb88fcfbb4bdb01ffee2
+  data.tar.gz: 32ef855bfaaf76f2a458c516657c6c3588af651abb7c69b00a31d30691e60dcdc6c2a3656032f7c26235ced501f68b22a1a0955f0436c283adc1ce51952963b3

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.idea

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Joseph Jaber
+Copyright (c) 2015 Joseph Jaber, Ryan Cammer
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Paramedic
 
-TODO: Write a gem description
+Paramedic provides parameters with a little extra help in dealing with some finnicky legacy systems.
 
 ## Installation
 
@@ -18,11 +18,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Encoder
+
+Encoder takes a hash of params and their values, and makes them safe for older Microsoft services, like so:
+
+    > params = { CMD: '/cmd?name=bill&id=3' }
+    > Paramedic::Encoder.new(params).to_s
+    => "CMD=%2Fcmd%3Fname%3Dbill%24id%3D3"
+
+### XmlMasseuse
+
+Let's say that you have an XML document assigned to a variable like so:
+
+    > xml = """
+    ...
+    <superheroes>
+      <superman>
+        <name>Clark Kent</name>
+      </superman>
+    </superheroes>
+    ...
+    """
+
+If you want the <superheroes /> element's children to be treated like they're not part of the XML document,
+do the following:
+
+    > Paramedic::XmlMasseuse.new(xml: xml, escape_tags: ['superheroes']).to_xml
+
+The result will be the following string:
+
+    => <superheroes>&lt;superman&gt;&lt;name&gt;Clark Kent&lt;/name&gt;</superheroes>
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/paramedic/fork )
+1. Fork it ( https://github.com/ryancammer/paramedic/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 

data/lib/paramedic/encoder.rb

@@ -28,23 +28,23 @@ module Paramedic
         ':' => '%3A',
         ',' => '%2C',
         ';' => '%3B',
-        '%0A' => '%0D%0A',
         '#' => '%23',
         '&' => '%24',
         '@' => '%40',
-        #'%' => '%25', # Surprisingly, this one doesn't appear to be replaced. We'll need to confirm.
+        #'%' => '%25',    # Surprisingly, this one doesn't appear to be replaced. We'll need to confirm.
         '+' => '%2B',
         '$' => '%26',
         '<' => '%3C',
         '>' => '%3E',
-        #'~' => '%25', $ Tilde too.
+        #'~' => '%25',    # Tilde too.
         '^' => '%5E',
         '`' => '%60',
         ?\ => '%5C',
         '[' => '%5B',
         ']' => '%5D',
         '|' => '%7C',
-        '"' => '%22'
+        '"' => '%22',
+        '%0A' => '%0D%0A' # This converts back to Microsoft's carriage return line feed funness.
       }
     end
 

data/lib/paramedic/version.rb

@@ -1,3 +1,3 @@
 module Paramedic
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/lib/paramedic/xml_masseuse.rb

@@ -0,0 +1,32 @@
+require 'nokogiri'
+require 'cgi'
+
+module Paramedic
+  class XMLMasseuse
+    def initialize(xml, opts={})
+      @xml = xml
+      @escape_tags = opts.fetch(:escape_tags, [])
+    end
+
+    def to_xml
+      xml_document = Nokogiri::XML(xml, &:noblanks)
+      escape_tags.each do |escape_tag|
+        xml_document.css(escape_tag).each do |element|
+          strip_tag_spacing(element)
+          element.inner_html = CGI.escape_html(element.inner_html)
+        end
+      end
+      strip_tag_spacing(xml_document)
+    end
+
+    private
+
+    def strip_tag_spacing(xml)
+      xml.to_xml(
+        save_with: Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS
+      )
+    end
+
+    attr_reader :escape_tags, :xml
+  end
+end

data/lib/paramedic.rb

@@ -1,6 +1,6 @@
-require "paramedic/version"
-require "paramedic/encoder"
-require "paramedic/xml_therapist"
+require_relative 'paramedic/version'
+require_relative 'paramedic/encoder'
+require_relative 'paramedic/xml_masseuse'
 
 module Paramedic
 end

data/paramedic.gemspec

@@ -4,25 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paramedic/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "paramedic"
+  spec.name          = 'paramedic'
   spec.version       = Paramedic::VERSION
-  spec.authors       = ["Joseph Jaber", "Ryan Cammer"]
-  spec.email         = ["mail@josephjaber.com", "ryancammer@gmail.com"]
+  spec.authors       = ['Joseph Jaber', 'Ryan Cammer']
+  spec.email         = %w(mail@josephjaber.com ryancammer@gmail.com)
   spec.summary       = %q{Parameter handler}
   spec.description   = %q{Parameter handler}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.homepage      = 'https://rubygems.org/gems/paramedic'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "nokogiri"
+  spec.add_dependency 'nokogiri'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
 end

data/spec/paramedic/encoder_spec.rb

@@ -24,7 +24,7 @@ module Paramedic
 
         context 'with xml' do
           let(:value) {
-            XMLTherapist.new.massage(<<-end_of_xml
+            XMLMasseuse.new(<<-end_of_xml
 <?xml version="1.0"?>
 <ViewCommand><GROUP>WEB_RMLEAS</GROUP><PAGE>OCCP</PAGE><COMMAND>SAVE</COMMAND><PARMS>~GROUP=WEB_RMLEAS~MENU=NONE~WHERE=NAME.NAMEID='{{id}}'~INFRAME=Y~PARENTMENUNAME=WEB_RMHOME~PARENTMENUID=MRI_69~PARENTSAVE=Y~PATH=C:\\Program Files (x86)\\MriWeb\\~URL=/mripage.asp~</PARMS>
   <CURRENTKEY>~NAMEID={{id}}~</CURRENTKEY>
@@ -80,7 +80,7 @@ module Paramedic
   <APPLID></APPLID>
 </ViewCommand>
 end_of_xml
-            )
+            ).to_xml
           }
 
           let(:serialized_value) {

data/spec/paramedic/{xml_therapist_spec.rb → xml_masseuse_spec.rb}

@@ -1,10 +1,15 @@
 require 'nokogiri'
 
 module Paramedic
-  describe XMLTherapist do
-    describe '#massage' do
-      let(:xml) {
-        <<-end_of_xml
+  describe XMLMasseuse do
+    describe '#to_xml' do
+      subject{ described_class.new(xml, escape_tags: escape_tags).to_xml }
+
+      context 'with no escape tags specified' do
+        let(:escape_tags) { [] }
+
+        let(:xml) {
+          <<-end_of_xml
 <?xml version="1.0"?>
 <ViewCommand><GROUP>WEB_RMLEAS</GROUP><PAGE>OCCP</PAGE><COMMAND>SAVE</COMMAND><PARMS>~GROUP=WEB_RMLEAS~MENU=NONE~WHERE=NAME.NAMEID='{{id}}'~INFRAME=Y~PARENTMENUNAME=WEB_RMHOME~PARENTMENUID=MRI_69~PARENTSAVE=Y~PATH=C:\\Program Files (x86)\\MriWeb\\~URL=/mripage.asp~</PARMS>
   <CURRENTKEY>~NAMEID={{id}}~</CURRENTKEY>
@@ -59,21 +64,46 @@ module Paramedic
   </COMMENT>
   <APPLID></APPLID>
 </ViewCommand>
-end_of_xml
-      }
+          end_of_xml
+        }
 
-      subject{ described_class.new.massage(xml) }
+        it 'removes all but the first newline in between elements' do
+          expect(subject.scan(/>\n</).count).to be 1
+        end
 
-      it 'removes all but the first newline in between elements' do
-        expect(subject.scan(/>\n</).count).to be 1
+        it 'does not collapse elements' do
+          expect(subject.scan(/<USERQRY><\/USERQRY>/).count).to be 1
+        end
       end
 
-      it 'does not collapse elements' do
-        expect(subject.scan(/<USERQRY><\/USERQRY>/).count).to be 1
-      end
+      context 'with double encode tags specified' do
+        let(:escape_tags) { ['COMMENT'] }
+
+        let(:expected_result) { <<-end_of_xml
+<?xml version="1.0"?>
+<ViewCommand><COMMENT>&lt;html&gt;&lt;body&gt;&lt;p&gt;None&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</COMMENT></ViewCommand>
+end_of_xml
+        }
+
+        let(:xml) {
+          <<-end_of_xml
+<?xml version="1.0"?>
+<ViewCommand>
+  <COMMENT>
+    <html>
+      <body>
+        <p>None</p>
+      </body>
+    </html>
+  </COMMENT>
+</ViewCommand>
+          end_of_xml
+        }
 
-      it 'html escapes specified elements' do
-        expect(subject.scan(/<USERQRY><\/USERQRY>/).count).to be 1
+        it 'html escapes specified elements' do
+          expect(subject).to eq expected_result
+          puts subject
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paramedic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Joseph Jaber
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -106,18 +120,19 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/paramedic.rb
 - lib/paramedic/encoder.rb
 - lib/paramedic/version.rb
-- lib/paramedic/xml_therapist.rb
+- lib/paramedic/xml_masseuse.rb
 - paramedic.gemspec
 - spec/paramedic/encoder_spec.rb
-- spec/paramedic/xml_therapist_spec.rb
+- spec/paramedic/xml_masseuse_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://rubygems.org/gems/paramedic
 licenses:
 - MIT
 metadata: {}
@@ -143,5 +158,5 @@ specification_version: 4
 summary: Parameter handler
 test_files:
 - spec/paramedic/encoder_spec.rb
-- spec/paramedic/xml_therapist_spec.rb
+- spec/paramedic/xml_masseuse_spec.rb
 - spec/spec_helper.rb

data/lib/paramedic/xml_therapist.rb

@@ -1,13 +0,0 @@
-require 'nokogiri'
-
-module Paramedic
-  class XMLTherapist
-    def massage(xml)
-      Nokogiri::XML(xml){
-        |x| x.noblanks
-      }.to_xml(
-        save_with: Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS
-      )
-    end
-  end
-end