spin_rewriter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ffd891a5f62bc5699038efba40312dd9d453615f8045ac944bcd2ddc819386e
+  data.tar.gz: fcb656252eecc41a050e4a726262404f76e5b73349bf4bea065de0a4514cef52
+SHA512:
+  metadata.gz: 064b924a77c1a96d4fd4ee5517e3f6e76d1f4222bef74b54a5a9fa0bc872f54c9a1f9f22609d2b45268ba4c87c0ced83b4eed9c327362c1944c22097881e414c
+  data.tar.gz: 8e421a8fc6e085e6b8384dcfeb8a51fa235326174ee34d35c008a0654a1c1b13499ac1f97d79fe717125c9d90a2558bc5698463ffbc105f099a5f2d00e1e0a7a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in spin_rewriter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    spin_rewriter (0.1.1)
+      httparty (~> 0.18.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.18.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0425)
+    minitest (5.10.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  spin_rewriter!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Christoph Wagner
+
+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,67 @@
+# SpinRewriter Ruby Gem
+
+[Spin Rewriter](http://www.spinrewriter.com/) is an online
+service for spinning text (synonym substitution) that creates unique version(s)
+of existing text. This package provides a way to easily interact with
+[SpinRewriter API](http://www.spinrewriter.com/api). Usage requires an
+account, [get one here](http://www.spinrewriter.com/registration).
+
+This gem is basically a direct port of the official [Python client](https://github.com/niteoweb/spinrewriter), including a few idiosyncracies found in the original.
+It's not exactly the greatest Ruby code, but it works.
+
+## Features
+
+- Supports all available API calls (`api_quota`, `text_with_spintax`, `unique_variation`, `unique_variation_from_spintax`)
+- Supports the same options as the Python module
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'spin_rewriter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spin_rewriter
+
+## Usage
+
+After installing it, this is how you use it::
+
+Initialize SpinRewriter.
+
+    > require 'spin_rewriter'
+    > rewriter = SpinRewriter::Api.new('username', 'api_key')
+
+Request processed spun text with spintax.
+
+    > text = "This is the text we want to spin."
+    > rewriter.text_with_spintax(text)
+    "{This is|This really is|That is|This can be} some text that we'd {like to
+    |prefer to|want to|love to} spin."
+
+Request a unique variation of processed given text.
+
+    > rewriter.unique_variation(text)
+    "This really is some text that we'd love to spin."
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PandaWhisperer/spin_rewriter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spin_rewriter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spin_rewriter.rb

@@ -0,0 +1,6 @@
+require "spin_rewriter/errors"
+require "spin_rewriter/version"
+require "spin_rewriter/api"
+
+module SpinRewriter
+end

data/lib/spin_rewriter/api.rb

@@ -0,0 +1,299 @@
+require 'httparty'
+require 'json'
+
+module SpinRewriter
+  class Api
+    include HTTParty
+
+    class << self
+      private
+
+      # Helper method to create named tuples
+      def named_tuple(name, keys, values = keys)
+        Struct.new(name, *keys.map(&:to_sym)).new(*values.map(&:to_s))
+      end
+    end
+
+    # URL for invoking the API
+    URL = 'http://www.spinrewriter.com/action/api'
+
+    # collection of possible values for the action parameter
+    ACTION = named_tuple('ACTION', ['api_quota', 'text_with_spintax',
+      'unique_variation', 'unique_variation_from_spintax'])
+
+    # collection of possible values for the confidence_level parameter
+    CONFIDENCE_LVL = named_tuple('CONFIDENCE_LVL', ['low', 'medium', 'high'])
+
+    # collection of possible values for the spintax_format parameter
+    SPINTAX_FORMAT = named_tuple('SPINTAX_FORMAT',
+      ['pipe_curly', 'tilde_curly', 'pipe_square', 'spin_tag'],
+      ['{|}', '{~}', '[|]', '[spin]']
+    )
+
+    # collection of all request parameters' names
+    REQUEST_PARAMS = named_tuple('REQUEST_PARAMS',
+      ['email_address', 'api_key', 'action', 'text', 'protected_terms',
+       'confidence_level', 'nested_spintax', 'spintax_format'])
+
+    # collection of all response fields' names
+    RESPONSE_PARAMS = named_tuple('RESP_P_NAMES',
+      ['status', 'response', 'api_requests_made', 'api_requests_available',
+       'protected_terms', 'confidence_level'])
+
+    # possible response status strings returned by API
+    STATUS = named_tuple('STATUS', ['ok', 'error'], ['OK', 'ERROR'])
+
+    attr_reader :email_address, :api_key
+
+    def initialize(email_address, api_key)
+      @email_address = email_address
+      @api_key       = api_key
+    end
+
+    # Return the number of made and remaining API calls for the 24-hour period.
+    # @return: remaining API quota
+    # @rtype: dictionary
+    def api_quota
+      params = {
+        REQUEST_PARAMS.email_address => self.email_address,
+        REQUEST_PARAMS.api_key       => self.api_key,
+        REQUEST_PARAMS.action        => ACTION.api_quota,
+      }
+      send_request(params)
+    end
+
+    # Return processed spun text with spintax.
+    #
+    # @param text: original text that needs to be changed
+    # @type text: string
+    # @param protected_terms: (optional) keywords and key phrases that
+    #     should be left intact
+    # @type protected_terms: list of strings
+    # @param confidence_level: (optional) the confidence level of
+    #     the One-Click Rewrite process
+    # @type confidence_level: string
+    # @param nested_spintax: (optional) whether or not to also spin
+    #     single words inside already spun phrases
+    # @type nested_spintax: boolean
+    # @param spintax_format: (optional) spintax format to use in returned text
+    # @type spintax_format: string
+    # @return: processed text and some other meta info
+    # @rtype: dictionary
+    def text_with_spintax(text,
+      protected_terms:  nil,
+      confidence_level: CONFIDENCE_LVL.medium,
+      nested_spintax:   false,
+      spintax_format:   SPINTAX_FORMAT.pipe_curly
+    )
+
+      response = transform_plain_text(
+        ACTION.text_with_spintax, text,
+        protected_terms:  protected_terms,
+        confidence_level: confidence_level,
+        nested_spintax:   nested_spintax,
+        spintax_format:   spintax_format
+      )
+
+      if response[RESPONSE_PARAMS.status] == STATUS.error
+        raise_error(response)
+      else
+        response
+      end
+    end
+
+    # Return a unique variation of the given text.
+    #
+    # @param text: original text that needs to be changed
+    # @type text: string
+    # @param protected_terms: (optional) keywords and key phrases that
+    #    should be left intact
+    # @type protected_terms: list of strings
+    # @param confidence_level: (optional) the confidence level of
+    #    the One-Click Rewrite process
+    # @type confidence_level: string
+    # @param nested_spintax: (optional) whether or not to also spin
+    #    single words inside already spun phrases
+    # @type nested_spintax: boolean
+    # @param spintax_format: (optional) (probably not relevant here?
+    #    But API documentation not clear here ...)
+    # @type spintax_format: string
+    # @return: processed text and some other meta info
+    # @rtype: dictionary
+    def unique_variation(text,
+      protected_terms:  nil,
+      confidence_level: CONFIDENCE_LVL.medium,
+      nested_spintax:   false,
+      spintax_format:   SPINTAX_FORMAT.pipe_curly
+    )
+      response = transform_plain_text(
+        ACTION.unique_variation, text,
+        protected_terms:  protected_terms,
+        confidence_level: confidence_level,
+        nested_spintax:   nested_spintax,
+        spintax_format:   spintax_format
+      )
+
+      if response[RESPONSE_PARAMS.status] == STATUS.error
+        raise_error(response)
+      else
+        response
+      end
+    end
+
+    # Return a unique variation of an already spun text.
+    #
+    # @param text: text to process
+    # @type text: string
+    # @param nested_spintax: whether or not to also spin single words
+    #    inside already spun phrases
+    # @type nested_spintax: boolean
+    # @param spintax_format: (probably not relevant here?
+    #    But API documentation not clear here ...)
+    # @type spintax_format: string
+    # @return: processed text and some other meta info
+    # @rtype: dictionary
+    def unique_variation_from_spintax(text,
+      nested_spintax: false,
+      spintax_format: SPINTAX_FORMAT.pipe_curly
+    )
+      params = {
+        REQUEST_PARAMS.email_address  => self.email_address,
+        REQUEST_PARAMS.api_key        => self.api_key,
+        REQUEST_PARAMS.action         => ACTION.unique_variation_from_spintax,
+        REQUEST_PARAMS.text           => text.encode('utf-8'),
+        REQUEST_PARAMS.nested_spintax => nested_spintax,
+        REQUEST_PARAMS.spintax_format => spintax_format,
+      }
+      response = send_request(params)
+
+      if response[RESPONSE_PARAMS.status] == STATUS.error
+        raise_error(response)
+      else
+        response
+      end
+    end
+
+    private
+
+    # Invoke Spin Rewriter API with given parameters and return its response.
+    # @param params: parameters to pass along with the request
+    # @type params: tuple of 2-tuples
+    # @return: API's response (already JSON-decoded)
+    # @rtype: dictionary
+    def send_request(params)
+      response = self.class.post(URL, body: params)
+      JSON.parse response.body
+    end
+
+    # Examine the API response and raise exception of the appropriate type.
+    # NOTE: usage of this method only makes sense when API response's status
+    # indicates an error
+    # @param api_response: API's response fileds
+    # :type api_response: dictionary
+    def raise_error(api_response)
+      error_msg = api_response[RESPONSE_PARAMS.response]
+
+      case error_msg
+      when %r{Authentication failed. No user with this email address found.}i,
+           %r{Authentication failed. Unique API key is not valid for this user.}i,
+           %r{This user does not have a valid Spin Rewriter subscription.}i
+        raise AuthenticationError, error_msg
+
+      when %r{API quota exceeded. You can make \d+ requests per day.}i
+        raise QuotaLimitError, error_msg
+
+      when %r{You can only submit entirely new text for analysis once every \d+ seconds.}i
+        raise UsageFrequencyError, error_msg
+
+      when %r{Requested action does not exist.}i
+        # NOTE: This should never occur unless
+        # there is a bug in the API library.
+        raise UnknownActionError, error_msg
+
+      when %r{Email address and unique API key are both required.}i
+        # NOTE: This should never occur unless
+        # there is a bug in the API library.
+        raise MissingParameterError, error_msg
+
+      when %r{Original text too short.}i,
+           %r{Original text too long. Text can have up to 4,000 words.}i,
+           %r{Original text after analysis too long. Text can have up to 4,000 words.}i,
+           %r{
+             Spinning syntax invalid.
+             With this action you should provide text with existing valid'
+             {first option|second option} spintax.
+           }ix,
+           %r{
+             The {first|second} spinning syntax invalid.
+             Re-check the syntax, i.e. curly brackets and pipes\.
+           }ix,
+           %r{Spinning syntax invalid.}i
+        raise ParamValueError, error_msg
+
+      when
+        %r{Analysis of your text failed. Please inform us about this.}i,
+        %r{Synonyms for your text could not be loaded. Please inform us about this.}i,
+        %r{Unable to load your new analyzed project.}i,
+        %r{Unable to load your existing analyzed project.}i,
+        %r{Unable to find your project in the database.}i,
+        %r{Unable to load your analyzed project.}i,
+        %r{One-Click Rewrite failed.}i
+        raise InternalApiError, error_msg
+
+      else
+        raise UnknownApiError, error_msg
+      end # case
+    end # def _raise_error
+
+    # Transform plain text using SpinRewriter API.
+    #
+    # Pack parameters into format as expected by the _send_request method and
+    # invoke the action method to get transformed text from the API.
+    #
+    # @param action: name of the action that will be requested from API
+    # @type action: string
+    # @param text: text to process
+    # @type text: string
+    # @param protected_terms: keywords and key phrases that should be left intact
+    # @type protected_terms: list of strings
+    # @param confidence_level: the confidence level of the One-Click Rewrite
+    #     process
+    # @type confidence_level: string
+    # @param nested_spintax: whether or not to also spin single words inside
+    #    already spun phrases
+    # @type nested_spintax: boolean
+    # @param spintax_format: spintax format to use in returned text
+    # @type spintax_format: string
+    # @return: processed text and some other meta info
+    # @rtype: dictionary
+    def transform_plain_text(
+        action,
+        text,
+        protected_terms:,
+        confidence_level:,
+        nested_spintax:,
+        spintax_format:
+    )
+      if protected_terms
+        # protected_terms could be separated by other characters too, like commas
+        protected_terms = protected_terms.map { |term| term.encode('utf-8') }.join('\n')
+      else
+        protected_terms = ''
+      end
+
+      params = {
+        REQUEST_PARAMS.email_address    => self.email_address,
+        REQUEST_PARAMS.api_key          => self.api_key,
+        REQUEST_PARAMS.action           => action,
+        REQUEST_PARAMS.text             => text.encode('utf-8'),
+        REQUEST_PARAMS.protected_terms  => protected_terms,
+        REQUEST_PARAMS.confidence_level => confidence_level,
+        REQUEST_PARAMS.nested_spintax   => nested_spintax,
+        REQUEST_PARAMS.spintax_format   => spintax_format,
+      }
+
+      send_request(params)
+    end # def transform_plain_text
+
+  end # class Api
+end # module SpinRewriter

data/lib/spin_rewriter/errors.rb

@@ -0,0 +1,78 @@
+module SpinRewriter
+
+  # Base class for exceptions in Spin Rewriter module.
+  class ApiError < StandardError
+    attr_reader :api_error_msg
+
+    def initialize(api_error_msg)
+      super
+      # api_error_msg respresents raw error string as returned by API server
+      @api_error_msg = api_error_msg
+    end
+  end
+
+
+  # Raised when authentication error occurs.
+  class AuthenticationError < ApiError
+    def message
+      'Authentication with Spin Rewriter API failed.'
+    end
+  end
+
+
+  # Raised when API quota limit is reached.
+  class QuotaLimitError < ApiError
+    def message
+      'Quota limit for API calls reached.'
+    end
+  end
+
+
+  # Raised when subsequent API requests are made in a too short time interval.
+  class UsageFrequencyError < ApiError
+    def message
+      'Not enough time passed since last API request.'
+    end
+  end
+
+
+  # Raised when unknown API action is requested.
+  class UnknownActionError < ApiError
+    def message
+      'Unknown API action requested.'
+    end
+  end
+
+
+  # Raised when required parameter is not provided.
+  class MissingParameterError < ApiError
+    def message
+      'Required parameter not present in API request.'
+    end
+  end
+
+
+  # Raised when parameter passed to API call has an invalid value.
+  class ParamValueError < ApiError
+    def message
+      'Invalid parameter value passed to API.'
+    end
+  end
+
+
+  # Raised when unexpected error occurs on the API server when processing a request.
+  class InternalApiError < ApiError
+    def message
+      'Internal error occured on API server when processing request.'
+    end
+  end
+
+
+  # Raised when API call results in an unrecognized error.
+  class UnknownApiError < ApiError
+    def message
+      "Unrecognized API error message received: #{api_error_msg}"
+    end
+  end
+
+end

data/lib/spin_rewriter/version.rb

@@ -0,0 +1,3 @@
+module SpinRewriter
+  VERSION = "0.1.1"
+end

data/spin_rewriter.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spin_rewriter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spin_rewriter"
+  spec.version       = SpinRewriter::VERSION
+  spec.authors       = ["Christoph Wagner"]
+  spec.email         = ["github@pandawhisperer.net"]
+
+  spec.summary       = %q{A Ruby interface to SpinRewriter.com}
+  spec.description   = %q{SpinRewriter API client}
+  spec.homepage      = "https://github.com/PandaWhisperer/spin_rewriter"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.18.0"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: spin_rewriter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christoph Wagner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: SpinRewriter API client
+email:
+- github@pandawhisperer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/spin_rewriter.rb
+- lib/spin_rewriter/api.rb
+- lib/spin_rewriter/errors.rb
+- lib/spin_rewriter/version.rb
+- spin_rewriter.gemspec
+homepage: https://github.com/PandaWhisperer/spin_rewriter
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to SpinRewriter.com
+test_files: []