after_the_deadline 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmYxNGYwNTY3YjJkMTQwNmNkYzNjODRkOTNkNjBmMjY0Yjk0YTAwZg==
+  data.tar.gz: !binary |-
+    NzAyMzk4ODgzNzc5ZGQxMjY0NjA0NmMwNWRiMDA5ZTRhMmFhMWVkZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MzVhNTM3MGY2ZmQwZDViY2JlY2ZjY2Y2YTA4NTllOTc4MTE4ZGY4Y2Y5NWFl
+    YWYzZDVlYzM3MGRmYTc3ZjlkMGY5MmVjMTZiM2NjMWI5YjcyMDZkY2JiZjRi
+    MWQ3OTcxMjdiNjZiYTI3ODk3ZTExZDFkZjg2YjUxNjY1NmFkYjI=
+  data.tar.gz: !binary |-
+    NWIwNWM1NGIxZGIyZDhjYjcxZWJmYTRjM2I1Njc2Yjc0NzUyMDEwZWNmNTMz
+    MzY3YTc0MWY4OThjNGM0NjNiZTNkOGU4NzExNzg3N2YwYjQ1MWU2NjE1OTBm
+    ZGU1Y2U1YzA1ODQ5ZDllZTRlMjVkMmMwM2UyMTE4ZjA0ZTMzNmI=

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Michael J. Sepcot
+
+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,73 @@
+# After The Deadline - Ruby Library
+
+Ruby library for working with After The Deadline service.
+See http://www.afterthedeadline.com/api.slp for the API documentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'after_the_deadline'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install after_the_deadline
+
+## Standard Usage
+
+    require 'after_the_deadline'
+    AfterTheDeadline(nil, nil) # no custom dictionary, accept all error types
+
+### No Errors
+
+    AfterTheDeadline.check 'this text is clean.'
+    => []
+
+### Error: Missing Apostrophe
+
+    AfterTheDeadline.check 'this text isnt clean.'
+    => [#<AfterTheDeadline::Error:0x101614e80 @url=nil, @description="Missing apostrophe", @string="isnt", @suggestions=["isn't"], @type="grammar", @precontext="text">]
+
+### Error: Passive Voice
+
+    errors = AfterTheDeadline.check 'this text should be written in a passive voice.'
+    => [#<AfterTheDeadline::Error:0x1015c1960 @url="http://service.afterthedeadline.com/info.slp?text=should+be&tags=MD%2FVB", @description="Passive voice", @string="should be", @suggestions=[], @type="grammar", @precontext="text">]
+
+### Information on the Passive Voice Error
+
+    errors.first.info
+    => "<h3>Revise <em>should be</em> with active voice</h3>\n\n<p>Active voice makes it clear who is doing what.  In an active sentence, the person that is acting is the subject.  Passive sentences obscure or omit the sentence \nsubject.<br><br>Use passive voice when the sentence object is more important than the subject.  The active voice is generally easier to read.\n<br>\n<br><b>Examples</b> (<i><b>subject</b></i>, <u>object</u>)\n<br>\n<br>Before: <u>Our results</u> will be discussed.\n<br>After: <i><b>We</b></i> will discuss <u>our results</u>.\n<br>\n<br>Before: <i><b>Wolverine</b></i> was made to be a <u>weapon</u>.\n<br>After: <i><b>The government</b></i> made <u>Wolverine</u>. <i><b>Wolverine</b></i> is a <u>weapon</u>. </p>"
+
+### Metrics
+
+    AfterTheDeadline.metrics 'this text should be written in a passive voice. another sentence is used to get more data in the metrics.'
+    => #<AfterTheDeadline::Metrics:0x10159d4e8 @stats={"words"=>"20", "sentences"=>"1"}, @grammer={}, @spell={}, @style={"passive voice"=>"2"}>
+
+## Ignoring Specific Types of Errors
+
+    require 'after_the_deadline'
+    AfterTheDeadline(nil, ['Passive voice'])
+
+### Skip the Passive Voice Error
+
+    errors = AfterTheDeadline.check 'this text should be written in a passive voice.'
+    => []
+
+## Using a Custom Dictionary
+
+    require 'after_the_deadline'
+    AfterTheDeadline(['Sepcot']) # or AfterTheDeadline('path/to/filename')
+    AfterTheDeadline.check "My last name, Sepcot, is very unique."
+    => []
+
+## 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 @@
+require 'bundler/gem_tasks'

data/after_the_deadline.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'after_the_deadline'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Michael J. Sepcot']
+  spec.email         = ['developer@sepcot.com']
+  spec.description   = %q{A ruby library for working with the After The Deadline service.}
+  spec.summary       = %q{A ruby library for working with the After The Deadline service.}
+  spec.homepage      = 'https://github.com/msepcot/after_the_deadline'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'crack'
+end

data/lib/after_the_deadline.rb

@@ -0,0 +1,134 @@
+require 'crack'
+require 'net/http'
+require 'uri'
+
+def AfterTheDeadline(dictionary = nil, types = AfterTheDeadline::DEFAULT_IGNORE_TYPES)
+  AfterTheDeadline.set_custom_dictionary(dictionary)
+  AfterTheDeadline.set_ignore_types(types)
+  nil
+end
+
+class AfterTheDeadline
+  @@custom_dictionary = []
+  @@ignore_types = []
+  @@api_key = nil
+
+  BASE_URI = 'http://service.afterthedeadline.com'
+  DEFAULT_IGNORE_TYPES = ['Bias Language', 'Cliches', 'Complex Expression', 'Diacritical Marks', 'Double Negatives', 'Hidden Verbs', 'Jargon Language', 'Passive voice', 'Phrases to Avoid', 'Redundant Expression']
+
+  class <<self
+    def set_custom_dictionary(dict)
+      if dict.kind_of?(Array)
+        @@custom_dictionary = dict
+      elsif dict.kind_of?(String)
+        File.open(dict) { |f| @@custom_dictionary = f.readlines.map &:strip }
+      end
+    end
+
+    def set_ignore_types(types)
+      @@ignore_types = types if types.kind_of?(Array)
+    end
+
+    def set_api_key(key)
+      @@api_key = key
+    end
+
+    # Invoke the checkDocument service with provided text.
+    #
+    # Returns list of AfterTheDeadline::Error objects.
+    def check(data)
+      results = Crack::XML.parse(perform('/checkDocument', :data => data))['results']
+      return [] if results.nil? # we have no errors in our data
+
+      raise "Server returned an error: #{results['message']}" if results['message']
+      errors = if results['error'].kind_of?(Array)
+        results['error'].map { |e| AfterTheDeadline::Error.new(e) }
+      else
+        [AfterTheDeadline::Error.new(results['error'])]
+      end
+
+      # Remove any error types we don't care about
+      errors.reject! { |e| @@ignore_types.include?(e.description) }
+
+      # Remove spelling errors from our custom dictionary
+      errors.reject! { |e| e.type == 'spelling' && @@custom_dictionary.include?(e.string) }
+      return errors
+    end
+    alias :check_document :check
+
+    # Invoke the stats service with provided text.
+    #
+    # Returns AfterTheDeadline::Metrics object.
+    def metrics(data)
+      results = Crack::XML.parse(perform('/stats', :data => data))['scores']
+      return if results.nil? # we have no stats about our data
+      AfterTheDeadline::Metrics.new results['metric']
+    end
+    alias :stats :metrics
+
+    def perform(action, params)
+      params[:key] = @@api_key if @@api_key
+      response = Net::HTTP.post_form URI.parse(BASE_URI + action), params
+      raise "Unexpected response code from AtD service: #{response.code} #{response.message}" unless response.is_a? Net::HTTPSuccess
+      response.body
+    end
+  end
+
+  private_class_method :perform
+end
+
+class AfterTheDeadline::Error
+  attr_reader :string, :description, :precontext, :type, :suggestions, :url
+
+  def initialize(hash)
+    raise "#{self.class} must be initialized with a Hash" unless hash.kind_of?(Hash)
+    [:string, :description, :precontext, :type, :url].each do |attribute|
+      self.send("#{attribute}=", hash[attribute.to_s])
+    end
+    self.suggestions = hash['suggestions'].nil? ? [] : [*hash['suggestions']['option']]
+  end
+
+  def info(theme = nil)
+    return unless self.url
+    uri = URI.parse self.url
+    uri.query = (uri.query || '') + "&theme=#{theme}"
+    Net::HTTP.get(uri).strip
+  end
+
+  def to_s
+    "#{self.string} (#{self.description})"
+  end
+
+  def eql?(other)
+    self.class.equal?(other.class) &&
+      string == other.string &&
+      description == other.description &&
+      type == other.type
+  end
+  alias_method :==, :eql?
+
+  def hash
+    string.hash ^ description.hash ^ type.hash
+  end
+
+private
+  attr_writer :string, :description, :precontext, :type, :suggestions, :url
+end
+
+class AfterTheDeadline::Metrics
+  attr_reader :spell, :grammer, :stats, :style
+
+  def initialize(array)
+    unless array.kind_of?(Array) && array.all? {|i| i.kind_of?(Hash) }
+      raise "#{self.class} must be initialized with an Array of Hashes"
+    end
+
+    self.spell, self.grammer, self.stats, self.style = {}, {}, {}, {}
+    array.each do |metric|
+      self.send(metric['type'])[metric['key']] = metric['value']
+    end
+  end
+
+private
+  attr_writer :spell, :grammer, :stats, :style
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: after_the_deadline
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael J. Sepcot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: crack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for working with the After The Deadline service.
+email:
+- developer@sepcot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- after_the_deadline.gemspec
+- lib/after_the_deadline.rb
+homepage: https://github.com/msepcot/after_the_deadline
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A ruby library for working with the After The Deadline service.
+test_files: []