art_typograf 0.0.1

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 art_typograf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Stereobooster
+
+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,50 @@
+# ArtTypograf
+
+Universal tool for preparing russian text for web publishing. Ruby wrapper for typograf.artlebedev.ru webservice
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'art_typograf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install art_typograf
+
+## Usage
+
+```ruby
+require "art_typograf"
+
+ArtTypograf.process('text')
+```
+
+You can pass second argument - hash of options.
+
+### Default options
+
+```ruby
+{
+  :entity_type => :no, # :html, :xml, :no, :mixed
+  :use_br => true,
+  :use_p => true,
+  :max_nobr => 3
+}
+```
+
+## TODO
+ - support ruby 1.8 (`force_encoding` missing)
+ - implement missing specs
+
+## Contributing
+
+1. Fork it
+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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/art_typograf.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'art_typograf/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "art_typograf"
+  gem.version       = ArtTypograf::VERSION
+  gem.authors       = ["stereobooster"]
+  gem.email         = ["stereobooster@gmail.com"]
+  gem.description   = %q{Universal tool for preparing russian text for web publishing. Ruby wrapper for typograf.artlebedev.ru webservice}
+  gem.summary       = %q{Universal tool for preparing russian text for web publishing}
+  gem.homepage      = "https://github.com/stereobooster/art_typograf"
+  gem.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/art_typograf.rb

@@ -0,0 +1,8 @@
+require "art_typograf/version"
+require "art_typograf/client"
+
+module ArtTypograf
+  def self.process(text, options = {})
+    Client.new(options).send_request(text)
+  end
+end

data/lib/art_typograf/client.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+require 'net/http'
+
+module ArtTypograf
+
+  class NetworkError < StandardError
+    def initialize(message="", backtrace = nil)
+      super(message)
+      self.set_backtrace(backtrace) if backtrace
+    end
+  end
+
+  class Client
+    URL = 'http://typograf.artlebedev.ru/webservices/typograf.asmx'
+    DEFAULT_PREFERENCES = {
+      :entity_type => :no,
+      :use_br => true,
+      :use_p => true,
+      :max_nobr => 3
+      # :encoding => 'UTF-8'
+    }
+    RESULT = /<ProcessTextResult>\s*((.|\n)*?)\s*<\/ProcessTextResult>/m
+
+    def check_options(options)
+      o = options.dup
+
+      [:use_br, :use_p].each do |key|
+        val = o[key]
+        o[key] = case val
+          when true  then 1
+          when false then 0
+          when 0, 1  then val
+          else raise ArgumentError, "Unknown #{key}: #{val}"
+        end
+      end
+
+      o[:entity_type] = case o[:entity_type]
+        when :html  then 1
+        when :xml   then 2
+        when :no    then 3
+        when :mixed then 4
+        when 1..4   then o[:entity_type]
+        else raise ArgumentError, "Unknown entity_type: #{o[:entity_type]}"
+      end
+
+      o
+    end
+
+    def form_xml(text, options)
+      o = options
+      xml = <<-SOAP_TEMPLATE
+<?xml version="1.0" encoding="UTF-8" ?>
+<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+<soap:Body>
+ <ProcessText xmlns="http://typograf.artlebedev.ru/webservices/">
+  <text>#{text.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')}</text>
+     <entityType>#{o[:entity_type]}</entityType>
+     <useBr>#{o[:use_br]}</useBr>
+     <useP>#{o[:use_p]}</useP>
+     <maxNobr>#{o[:max_nobr]}</maxNobr>
+  </ProcessText>
+ </soap:Body>
+</soap:Envelope>
+SOAP_TEMPLATE
+      xml.gsub(/^\s|\s$/, '')
+    end
+
+    def initialize(options = {})
+      @url = URI.parse(options.delete(:url) || URL)
+      @options = check_options( DEFAULT_PREFERENCES.dup.merge(options) )
+    end
+
+    # Process text with remote web-service
+    def send_request(text)
+      begin
+        request = Net::HTTP::Post.new(@url.path, {
+          'Content-Type' => 'text/xml',
+          'SOAPAction' => '"http://typograf.artlebedev.ru/webservices/ProcessText"'
+        })
+        request.body = form_xml(text, @options)
+
+        response = Net::HTTP.new(@url.host, @url.port).start do |http|
+          http.request(request)
+        end
+      rescue StandardError => exception
+        raise NetworkError.new(exception.message, exception.backtrace)
+      end
+
+      if !response.is_a?(Net::HTTPOK)
+        raise NetworkError, "#{response.code}: #{response.message}"
+      end
+
+      if RESULT =~ response.body
+        body = $1.gsub(/&gt;/, '>').gsub(/&lt;/, '<').gsub(/&amp;/, '&')
+        body.force_encoding("UTF-8").chomp
+      else
+        raise NetworkError, "Can't match result #{response.body}"
+      end
+    end
+  end
+end

data/lib/art_typograf/version.rb

@@ -0,0 +1,3 @@
+module ArtTypograf
+  VERSION = "0.0.1"
+end

data/spec/art_typograf_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'art_typograf'
+require 'rspec'
+
+describe ArtTypograf do
+  it ".process" do
+    ArtTypograf.process("- Это \"Типограф\"?\n— Нет, это «Типограф»!").should eq "<p>— Это «Типограф»?<br />\n— Нет, это «Типограф»!<br />\n</p>"
+  end
+
+  it "should raise 404 error" do
+    lambda {ArtTypograf.process("Тест", :url => 'http://typograf.artlebedev.ru/404')}.should raise_error ArtTypograf::NetworkError
+  end
+
+  it "should raise host not found error" do
+    lambda {ArtTypograf.process("Тест", :url => 'http://www')}.should raise_error ArtTypograf::NetworkError
+  end
+
+  # TODO: mock server for offline testing, for detecting service change
+  # TODO: test every option
+end
+
+describe ArtTypograf::Client do
+  it ".form_xml" do
+    pending "TODO"
+  end
+
+  it ".check_options" do
+    pending "TODO"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: art_typograf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- stereobooster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Universal tool for preparing russian text for web publishing. Ruby wrapper
+  for typograf.artlebedev.ru webservice
+email:
+- stereobooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- art_typograf.gemspec
+- lib/art_typograf.rb
+- lib/art_typograf/client.rb
+- lib/art_typograf/version.rb
+- spec/art_typograf_spec.rb
+homepage: https://github.com/stereobooster/art_typograf
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -618060813
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -618060813
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Universal tool for preparing russian text for web publishing
+test_files:
+- spec/art_typograf_spec.rb