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 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,77 @@
+# Typograf
+
+Universal tool for preparing russian text for web publishing. Ruby wrapper for typograf.ru webservice
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'typograf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typograf
+
+## Usage
+
+```ruby
+require "typograf"
+
+Typograf.process('text')
+```
+
+You can pass second argument - hash of options.
+
+### Default options
+
+```ruby
+{
+  :tags => 1, # 0 — не расставлять; 1 — расставлять
+  :tags_delete => 0, # 0 — не удалять; 1 — удалять до типографирования; 2 — удалять после типографирования
+  :paragraph => {
+    :insert => 1, # 1 — ставить; 0 — не ставить
+    # теги задают внешний вид обрамления параграфа, начальные и конечные теги соответственно (могут быть пустыми)
+    :start => '<p>',
+    :end => '</p>'
+  },
+  :newline => {
+    :tag => '<br/>',  # теги перевода строки.
+    :insert => 1 # перевод строки: 1 — ставить; 0 — не ставить
+  },
+  :cms_new_line => 0, # Переводы строк <p>&nbsp;</p>
+  :dos_text => 0, # удаляет одинарные переводы строк и переносы: 0 — не удалять; 1 — удалять
+  :nowraped => {
+    :insert => 1, # 1 — ставить; 0 — не ставить
+    :nonbsp => 0, # 0 — не использовать неразрывные конструкции вместо (неразрывного пробела); 1 — наоборот
+    :length => 0, # не объединять в неразрывные конструкции слова, написанные через дефис, с общей длинной больше N знаков. Если 0 то не используется
+    :start  => '<nobr>',
+    :end    => '</nobr>' 
+  },
+  :hanging_punct => 0, # висячая пунктуация: 1 — использовать; 0 — не использовать
+  :hanging_line => 0, # висячие строки: 1 — удалять; 0 — не удалять
+  :minus_sign => '&ndash;', # указывает какой символ использовать вместо знака минус: — &ndash; или &minus;
+  :hyphen => {
+    :insert => 0,
+    :length => 0
+  },
+  :acronym => 1, # выделять сокращения: 1 — выделять; 0 — не выделять
+  :symbols => 0, # как выводить типографированный текст: 0 — буквенными символами (&nbsp;); 1 — числовыми (&#160;)
+  # добавляет дополнительные атрибуты к ссылкам
+  :link => {
+    :target => '',
+    :class => ''
+  }
+}
+```
+
+## 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/lib/typograf.rb

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

data/lib/typograf/client.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+require 'net/http'
+
+module Typograf
+  class NetworkError < StandardError
+    def initialize(message="", backtrace = nil)
+      super(message)
+      self.set_backtrace(backtrace) if backtrace
+    end
+  end
+
+  class Client
+    URL = 'http://www.typograf.ru/webservice/'
+    DEFAULT_PREFERENCES = {
+      :tags => 1, # 0 — не расставлять; 1 — расставлять
+      :tags_delete => 0, # 0 — не удалять; 1 — удалять до типографирования; 2 — удалять после типографирования
+      :paragraph => {
+        :insert => 1, # 1 — ставить; 0 — не ставить
+        # теги задают внешний вид обрамления параграфа, начальные и конечные теги соответственно (могут быть пустыми)
+        :start => '<p>',
+        :end => '</p>'
+      },
+      :newline => {
+        :tag => '<br />',  # теги перевода строки.
+        :insert => 1 # перевод строки: 1 — ставить; 0 — не ставить
+      },
+      :cms_new_line => 0, # Переводы строк <p>&nbsp;</p>
+      :dos_text => 0, # удаляет одинарные переводы строк и переносы: 0 — не удалять; 1 — удалять
+      :nowraped => {
+        :insert => 1, # 1 — ставить; 0 — не ставить
+        :nonbsp => 0, # 0 — не использовать неразрывные конструкции вместо (неразрывного пробела); 1 — наоборот
+        :length => 0, # не объединять в неразрывные конструкции слова, написанные через дефис, с общей длинной больше N знаков. Если 0 то не используется
+        :start  => '<nobr>',
+        :end    => '</nobr>' 
+      },
+      :hanging_punct => 0, # висячая пунктуация: 1 — использовать; 0 — не использовать
+      :hanging_line => 0, # висячие строки: 1 — удалять; 0 — не удалять
+      :minus_sign => '&ndash;', # указывает какой символ использовать вместо знака минус: — &ndash; или &minus;
+      :hyphen => {
+        :insert => 0,
+        :length => 0
+      },
+      :acronym => 1, # выделять сокращения: 1 — выделять; 0 — не выделять
+      :symbols => 0, # как выводить типографированный текст: 0 — буквенными символами (&nbsp;); 1 — числовыми (&#160;)
+      # добавляет дополнительные атрибуты к ссылкам
+      :link => {
+        :target => '',
+        :class => ''
+      }
+    }
+
+    def form_xml(options)
+      o = options
+      xml = <<-XML_TEMPLATE
+      <?xml version="1.0" encoding="windows-1251" ?>
+      <preferences>
+        <tags delete="#{o[:tags_delete]}">#{o[:tags]}</tags>
+        <paragraph insert="#{o[:paragraph][:insert]}">
+          <start><![CDATA[#{o[:paragraph][:start]}]]></start>
+          <end><![CDATA[#{o[:paragraph][:end]}]]></end>
+        </paragraph>
+        <newline insert="#{o[:newline][:insert]}"><![CDATA[#{o[:newline][:tag]}]]></newline>
+        <cmsNewLine valid="#{o[:cms_new_line]}" />
+        <dos-text delete="#{o[:dos_text]}" />
+        <nowraped insert="#{o[:nowraped][:insert]}" nonbsp="#{o[:nowraped][:nobsp]}" length="#{o[:nowraped][:length]}">
+          <start><![CDATA[#{o[:nowraped][:start]}]]></start>
+          <end><![CDATA[#{o[:nowraped][:end]}]]></end>
+        </nowraped>
+        <hanging-punct insert="#{o[:hanging_punct]}" />
+        <hanging-line delete="#{o[:hanging_line]}" />
+        <minus-sign><![CDATA[#{o[:minus_sign]}]]></minus-sign>
+        <hyphen insert="#{o[:hyphen][:insert]}" length="#{o[:hyphen][:length]}" />
+        <acronym insert="#{o[:acronym]}"></acronym>
+        <symbols type="#{o[:symbols]}" />
+        <link target="#{o[:link][:target]}" class="#{o[:link][:class]}" />
+      </preferences>
+      XML_TEMPLATE
+      xml.gsub(/^\s|\s$/, '')
+    end
+
+    def deep_merge(first, second)
+      target = first.dup
+      second.keys.each do |key|
+        if second[key].is_a?(Hash) && target[key].is_a?(Hash)
+          target[key] = deep_merge(target[key], second[key])
+          next
+        elsif second[key].is_a?(Hash) or target[key].is_a?(Hash)
+          raise ArgumentError, "Can't merge hashes"
+        end
+        target[key] = second[key]
+      end
+      target
+    end
+
+    def initialize(options = {})
+      @url = URI.parse(options.delete(:url) || URL)
+      # @chr = options.delete(:chr) || 'UTF-8'
+      @xml = if options.keys.length > 0
+        form_xml( deep_merge(DEFAULT_PREFERENCES, options) )
+      end
+    end
+
+    # Process text with remote web-service
+    def send_request(text)
+      params = {
+        'text' => text.encode("cp1251"),
+      }
+      params['xml'] = @xml if @xml
+      # params['chr'] = @chr if @chr
+      params = URI.encode_www_form params
+      request = Net::HTTP::Post.new(@url.path + '?' + params)
+
+      begin
+        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
+
+      body = response.body.dup.force_encoding("cp1251")
+
+      # error = "\xCE\xF8\xE8\xE1\xEA\xE0: \xE2\xFB \xE7\xE0\xE1\xFB\xEB\xE8 \xEF\xE5\xF0\xE5\xE4\xE0\xF2\xFC \xF2\xE5\xEA\xF1\xF2"
+      # error.force_encoding("ASCII-8BIT") if error.respond_to?(:force_encoding)
+      if body == "Ошибка: вы забыли передать текст"
+        raise NetworkError, "Ошибка: вы забыли передать текст"
+      end
+
+      body.encode("utf-8").chomp
+    end
+  end
+end

data/lib/typograf/version.rb

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

data/spec/typograf_spec.rb

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

data/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 'typograf/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "typograf"
+  gem.version       = Typograf::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.ru webservice}
+  gem.summary       = %q{Universal tool for preparing russian text for web publishing}
+  gem.homepage      = "https://github.com/stereobooster/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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: typograf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- stereobooster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 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.ru webservice
+email:
+- stereobooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/typograf.rb
+- lib/typograf/client.rb
+- lib/typograf/version.rb
+- spec/typograf_spec.rb
+- typograf.gemspec
+homepage: https://github.com/stereobooster/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: -1019651219
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1019651219
+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/typograf_spec.rb