sendgrid-parse 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sendgrid-parse.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rob Forman
+
+MIT License
+
+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,47 @@
+# Sendgrid::Parse
+
+Gem to dynamically set or change the encoding type for fields, ie params from SendGrid Parse API (http://docs.sendgrid.com/documentation/api/parse-api-2/)
+
+Requires JSON for parsing 'charsets' envelope.
+
+Works on 1.8.x via Iconv, and 1.9.x via built-in encoding support.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid-parse'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid-parse
+
+## Usage
+
+```ruby
+require 'sendgrid-parse'
+
+# Example from SendGrid
+params = {
+  :charsets => '{"text":"windows-1252"}',
+  :text => "Hello Euro \x80"
+}
+
+new_params = Sendgrid::Parse::EncodableHash.new(params)
+new_params.encode!('UTF-8')
+
+new_params[:text]           # => "Hello Euro €"
+new_params[:text].encoding  # => #<Encoding:UTF-8>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sendgrid-parse.rb

@@ -0,0 +1,2 @@
+require "sendgrid-parse/version"
+require "sendgrid-parse/encodable_hash"

data/lib/sendgrid-parse/encodable_hash.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'delegate'
+require 'iconv' unless RUBY_VERSION >= '1.9'
+
+
+module Sendgrid
+  module Parse
+    class EncodableHash < SimpleDelegator
+      attr_accessor :component
+
+      def class
+        __getobj__.class
+      end
+
+      def initialize(component)
+        raise 'Missing required key :charsets for encoding.' unless component.has_key?(:charsets)
+        super
+      end
+
+      def encode(to_encoding, ignore=[])
+        component = __getobj__.dup
+        ignore.each { |e| component.delete(e) if component.has_key?(e)}
+
+        # Parse and symbolize charsets dictionary
+        charsets = JSON.parse(component[:charsets])
+        charsets.keys.each { |key| charsets[(key.to_sym rescue key) || key] = charsets.delete(key) }
+
+        # Set and/or change all fields according to charsets
+        component.each do |key, value|
+          if charsets.has_key?(key)
+            from_encoding = charsets[key]
+            component[key] = _encode(component[key], from_encoding, to_encoding)
+            charsets[key] = to_encoding
+          else
+            # If we weren't told, set it to the target encoding type.
+            component[key] = _encode(component[key], to_encoding, to_encoding)
+          end
+        end
+
+        component[:charsets] = charsets.to_json
+        component
+      end
+
+      def encode!(to_encoding, ignore=[])
+        __setobj__ encode(to_encoding, ignore)
+      end
+
+    protected
+      def _encode(value, from, to)
+        if RUBY_VERSION >= '1.9'
+          value = value.force_encoding(from)
+          value = value.encode(to, :invalid => :replace, :undef => :replace, :replace => '')
+        else
+          value = Iconv.conv("#{to}//IGNORE", from, value)
+        end
+
+        value
+      end
+    end
+  end
+end

data/lib/sendgrid-parse/version.rb

@@ -0,0 +1,5 @@
+module Sendgrid
+  module Parse
+    VERSION = "0.1.0"
+  end
+end

data/sendgrid-parse.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sendgrid-parse/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rob Forman"]
+  gem.email         = ["rob@robforman.com"]
+  gem.description   = %q{Library to dynamically set or change the encoding type for fields, ie params from SendGrid Parse API.}
+  gem.summary       = %q{Library to dynamically set or change the encoding type for fields, ie params from SendGrid Parse API.}
+  gem.homepage      = "https://github.com/robforman/sendgrid-parse"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sendgrid-parse"
+  gem.require_paths = ["lib"]
+  gem.version       = Sendgrid::Parse::VERSION
+  gem.add_dependency "json", "~> 1.7.3"
+  gem.add_dependency "iconv", "~> 0.1" unless RUBY_VERSION >= '1.9'
+  gem.add_development_dependency "rspec", "~> 2.10.0"
+end

data/spec/sendgrid-parse_spec.rb

@@ -0,0 +1,114 @@
+# encoding: UTF-8
+require 'sendgrid-parse'
+
+describe Sendgrid::Parse::EncodableHash do
+  test_string_1 = "Hello €"
+  test_string_1_windows1252_encoded = "Hello \x80"
+  test_string_1_utf8_encoded = "Hello \xE2\x82\xAC"
+
+  it "windows-1252 should encode to utf-8" do
+    params = {
+      :charsets => '{"text":"WINDOWS-1252"}',
+      :text => test_string_1_windows1252_encoded
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+    new_params[:text].should eql(test_string_1)
+  end
+
+  it "utf-8 should encode to utf-8" do
+    params = {
+      :charsets => '{"text":"UTF-8"}',
+      :text => test_string_1_utf8_encoded
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+    new_params[:text].should eql(test_string_1)
+  end
+
+  it "should not change same encoding strings" do
+    params = {
+      :charsets => '{"text":"UTF-8"}',
+      :text => test_string_1
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+    new_params[:text].should eql(test_string_1)
+  end
+
+  it "should strip unconvertible characters" do
+    params = {
+      :charsets => '{"text":"UTF-8"}',
+      :text => "Résumé"
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("ASCII")
+    new_params[:text].should_not eql("Résumé")
+    new_params[:text].should eql("Rsum")
+  end
+
+  its "encode should be non-destructive" do
+    params = {
+      :charsets => '{"text":"UTF-8"}',
+      :text => "Résumé"
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("ASCII")
+    new_params[:text].should eql("Rsum")
+
+    params[:text].should eql("Résumé")
+  end
+
+  its "encode! should be destructive" do
+    params = {
+      :charsets => '{"text":"UTF-8"}',
+      :text => "Résumé"
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params)
+    new_params.encode!("ASCII")
+    new_params[:text].should eql("Rsum")
+  end
+
+  it "should re-write the charsets json envelope upon encoding" do
+    params = {
+      :charsets => '{"text":"WINDOWS-1252"}',
+      :text => test_string_1_windows1252_encoded
+    }
+
+    new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+    new_params[:text].should eql(test_string_1)
+    new_params[:charsets].should eql "{\"text\":\"UTF-8\"}"
+  end
+
+  if RUBY_VERSION >= '1.9'
+    it "should correctly change encoding types of charsets" do
+      params = {
+        :charsets => '{"text":"WINDOWS-1252"}',
+        :text => test_string_1_windows1252_encoded
+      }
+
+      new_params = Sendgrid::Parse::EncodableHash.new(params).encode("WINDOWS-1252")
+      new_params[:text].encoding.should eql(Encoding::Windows_1252)
+
+      new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+      new_params[:text].encoding.should eql(Encoding::UTF_8)
+    end
+
+    it "should correctly force encoding types of non-specified fields" do
+      params = {
+        :charsets => '{"text":"WINDOWS-1252"}',
+        :text => test_string_1_windows1252_encoded,
+        :subject => "Test subject"
+      }
+
+      new_params = Sendgrid::Parse::EncodableHash.new(params).encode("WINDOWS-1252")
+      new_params[:text].encoding.should eql(Encoding::Windows_1252)
+      new_params[:subject].encoding.should eql(Encoding::Windows_1252)
+
+      new_params = Sendgrid::Parse::EncodableHash.new(params).encode("UTF-8")
+      new_params[:text].encoding.should eql(Encoding::UTF_8)
+      new_params[:subject].encoding.should eql(Encoding::UTF_8)
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: sendgrid-parse
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rob Forman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 7
+        - 3
+        version: 1.7.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: iconv
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id003
+description: Library to dynamically set or change the encoding type for fields, ie params from SendGrid Parse API.
+email: 
+- rob@robforman.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sendgrid-parse.rb
+- lib/sendgrid-parse/encodable_hash.rb
+- lib/sendgrid-parse/version.rb
+- sendgrid-parse.gemspec
+- spec/sendgrid-parse_spec.rb
+homepage: https://github.com/robforman/sendgrid-parse
+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.24
+signing_key: 
+specification_version: 3
+summary: Library to dynamically set or change the encoding type for fields, ie params from SendGrid Parse API.
+test_files: 
+- spec/sendgrid-parse_spec.rb