plagiarism 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64482e60200493e3f7613948d4ed08d0772ec5a7
-  data.tar.gz: 9e53294f00f5461af8cda5ed27ac83e4efaa582b
+  metadata.gz: 7ade6a7ba134174de6ea534c5af530e9c217fe64
+  data.tar.gz: 76be3b73bd7c18fb59faafa37165e9a123150f61
 SHA512:
-  metadata.gz: 5421a51c67aff972684eb5cd21669f79c9459959a04f52659220d9a4b3de81139f6f8b58dc88edad20bf9078a032888840751a8343d824b89e4063b37711718d
-  data.tar.gz: d0cc144ddb0bc290933dbc56f95769e82506163579455d3812c1c1b7902d674bd5ca093989a75062e9f99621060169618841665895e2293b27d0ba5523b7bc65
+  metadata.gz: e69458e5af8d77b6b6d06b7098c587f8941655c59d6eb568ada3919b7bd6e8e0960db6cafcedf45fdad3dea71191a8f0031e85eed072f1a22d1a4329bac4c819
+  data.tar.gz: d65947e99d90ac5fcc892eca6b622603404c64d9edd41a255254c3ae98c7ef2006fe33ee2804952f8e43a7427eee33b218453a1c77285065bdec02f9d9972482

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Zach Ohlgren
+
+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,78 @@
+## Plagiarism
+
+Search for plagiarism and check the originality of your content with Copyscape.
+
+Plagiarism is a Ruby wrapper for the Copyscape (http://copyscape.com) Premium API.
+
+
+
+### Getting Started
+
+
+    gem install plagiarism
+
+    require 'plagiarism'
+
+
+Once you have your Copyscape username and API key you'll need to configure them.
+
+    Plagiarism.username = "username"
+    Plagiarism.api_key = "123456"
+
+
+You can enable test mode to have Copyscape search against their example page,
+http://www.copyscape.com/example.html.
+
+    Plagiarism.test_mode = true
+
+
+### Usage
+
+
+##### Check a URL for plagiarism
+
+    search = Plagiarism.url_seach("http://example.com")
+
+    if search.results? # => true
+
+      # How many results were found?
+      search.count # => 324
+
+      # Wow! That's a lot of results. Let's take a look...
+      search.results_url # => "http://view.copyscape.com/search/hm2yx3g9kg"
+
+    end
+
+
+
+##### Check some text for plagiarism
+
+    # Some text to search against (15 words minimum)
+    excerpt = "When in the course of human events, it becomes necessary
+      for one people to dissolve the political bands"
+
+    search = Plagiarism.text_seach(excerpt)
+
+    if search.results? # => true
+
+      # How many results were found?
+      search.count # => 324
+
+      # Wow! That's a lot of results. Let's take a look...
+      search.results_url # => "http://view.copyscape.com/search/hm2yx3g9kg"
+
+    end
+
+
+
+##### Check your account balance (in cents)
+
+    Plagiarism.balance # => 9900
+
+
+
+##### Check your remaining search credits
+
+    Plagiarism.credits # => 1980
+
+

data/lib/plagiarism.rb

@@ -1,3 +1,75 @@
+require 'plagiarism/request'
+require 'plagiarism/response'
+require 'plagiarism/balance'
+require 'plagiarism/search'
+require 'plagiarism/url_search'
+require 'plagiarism/text_search'
+
 module Plagiarism
 
+  @test_mode = false
+  @response_format = :xml
+
+
+  class << self
+
+    attr_reader :response_format
+    attr_accessor :username, :api_key, :test_mode
+
+    def configure
+      yield self
+      self
+    end
+
+
+    # Return the current balance (in cents) in your Copyscape account
+    #
+    def balance
+      Balance.amount
+    end
+
+
+    # Return the number remaining credits in your Copyscape account
+    #
+    def credits
+      Balance.credits
+    end
+
+
+    # Search for copies of some text
+    #
+    # Options:
+    #
+    #   encoding:
+    #     UTF-8, ISO-8859-1, etc. (default is UTF-8)
+    #
+    #   scope:
+    #     public, private, full (default is public)
+    #
+    #   full_comparisons:
+    #     number of full-text comparisons to request on matching
+    #     results (default is 0, maximum is 10).
+    #
+    def text_search(text, options = {})
+      TextSearch.new(text, options)
+    end
+
+
+    # Search for copies of a web page
+    #
+    # Options:
+    #
+    #   scope:
+    #     public, private, full (default is public)
+    #
+    #   full_comparisons:
+    #     number of full-text comparisons to request on matching
+    #     results (default is 0, maximum is 10).
+    #
+    def url_search(url, options = {})
+      URLSearch.new(url, options)
+    end
+
+  end
+
 end

data/lib/plagiarism/balance.rb

@@ -0,0 +1,35 @@
+require 'money'
+
+module Plagiarism
+  class Balance < Request
+
+
+    class << self
+
+      # Return the amount (in cents) of your remaining Copyscape account balance
+      #
+      def amount
+        response = Request.new(:get, o: 'balance').response
+        if response.success?
+          Money.parse(response.doc.css('value').text).cents
+        else
+          raise "An error occurred while attempting to retrieve your account balance"
+        end
+      end
+
+
+      # Return search credits remaining for your Copyscape account
+      #
+      def credits
+        response = Request.new(:get, o: 'balance').response
+        if response.success?
+          response.doc.css('total').text.to_i
+        else
+          raise "An error occurred while attempting to retrieve your account balance"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/plagiarism/request.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+
+module Plagiarism
+  class Request
+    include HTTParty
+
+    base_uri "http://www.copyscape.com/api"
+
+    attr_accessor :response, :params
+
+    def initialize(method, options = {})
+      @params = build_params(options)
+      if method.eql? :get
+        @response = Response.new self.class.get('/', query: @params)
+      elsif method.eql? :post
+        @response = Response.new self.class.post('/', body: @params)
+      else
+        raise "Invalid HTTP request method"
+      end
+    end
+
+  protected
+
+    # Build the request parameters
+    def build_params(options = {})
+      raise "You must provide your Copyscape username" unless Plagiarism.username
+      raise "You must provide your Copyscape API key" unless Plagiarism.api_key
+      params = {
+        u: Plagiarism.username,             # Copyscape username
+        k: Plagiarism.api_key,              # Copyscape API key
+        f: Plagiarism.response_format,      # Response format
+      }.merge(options)
+      params.merge!(x: 1) if Plagiarism.test_mode
+      params
+    end
+
+  end
+end

data/lib/plagiarism/response.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+module Plagiarism
+  class Response
+
+    attr_accessor :response, :doc
+
+
+    def initialize(response)
+      @response = response
+      @doc = Nokogiri::XML(response.body) if @response.ok?
+    end
+
+
+    def success?
+      @response.ok? && @doc.css("error").text == ""
+    end
+
+
+    def error?
+      not success?
+    end
+
+  end
+end

data/lib/plagiarism/search.rb

@@ -0,0 +1,76 @@
+module Plagiarism
+  class Search
+
+    attr_accessor :request, :response
+
+
+    # Return the number of results found
+    #
+    def count
+      @response.success? ? @response.doc.css("count").text.to_i : nil
+    end
+
+    # Return true if any results were found
+    #
+    def results?
+      count && count > 0 ? true : false
+    end
+
+    # Return true if an error occurred
+    #
+    def error?
+      @response && @response.error? ? true : false
+    end
+
+
+    # Return true if the search request was successful
+    def success?
+      @response && @response.success? ? true : false
+    end
+
+
+    # Return the number of words checked
+    #
+    def words
+      @response.success? ? @response.doc.css("querywords").text.to_i : nil
+    end
+
+
+    # Return the URL for viewing results
+    #
+    def results_url
+      if @response.success? && viewing_url = @response.doc.css("allviewurl").text
+        viewing_url != "" ? viewing_url : nil
+      else
+        nil
+      end
+    end
+
+
+  protected
+
+
+    def search_params(options)
+      params = {
+        o: operation_for_scope(options[:scope]),
+        c: options[:full_comparisons] || 0
+      }
+      params.merge(e: options[:encoding]) if self.class == TextSearch
+      params
+    end
+
+
+    # Map search scope to an api operation
+    #
+    def operation_for_scope(scope)
+      if scope == "full"
+        "cpsearch"
+      elsif scope == "private"
+        "psearch"
+      else
+        "csearch"
+      end
+    end
+
+  end
+end

data/lib/plagiarism/text_search.rb

@@ -0,0 +1,20 @@
+module Plagiarism
+  class TextSearch < Search
+
+    def initialize(search_text, options = {})
+      validate_text(search_text)
+      params = {e: "UTF-8", t: search_text}.merge(search_params(options))
+      @request = Request.new(:post, params)
+      @response = @request.response
+    end
+
+
+  private
+
+
+    def validate_text(text)
+      raise "Invalid search text" if text.class != String || text.nil? || text == ""
+    end
+
+  end
+end

data/lib/plagiarism/url_search.rb

@@ -0,0 +1,21 @@
+module Plagiarism
+  class URLSearch < Search
+
+    def initialize(search_url, options = {})
+      validate_url(search_url)
+      params = search_params(options).merge(q: search_url)
+      @request = Request.new(:get, params)
+      @response = @request.response
+    end
+
+
+  private
+
+
+    def validate_url(url)
+      uri = URI.parse URI.encode(url)
+      raise "Please provide a valid search URL" unless uri.scheme && uri.host && uri.path
+    end
+
+  end
+end

data/plagiarism.gemspec

@@ -1,12 +1,24 @@
-Gem::Specification.new do |s|
-  s.name        = 'plagiarism'
-  s.version     = '0.0.0'
-  s.summary     = "Wrapper for the Copyscape Premium API"
-  s.description = "Wrapper for the Copyscape Premium API"
-  s.homepage    = "https://github.com/zohlgren/plagiarism"
-  s.authors     = ["Zach Ohlgren"]
-  s.email       = 'zach@ohlgren.me'
-
-  s.files = `git ls-files`.split("\n")
-  s.require_path = "lib"
+Gem::Specification.new do |gem|
+  gem.name        = 'plagiarism'
+  gem.version     = '0.1.0'
+  gem.summary     = "A Ruby wrapper for the Copyscape Premium API"
+  gem.description = "Search for plagiarism and check your content for originality with Copyscape"
+  gem.homepage    = "https://github.com/zohlgren/plagiarism"
+  gem.authors     = ["Zach Ohlgren"]
+  gem.email       = "zach@ohlgren.me"
+  gem.license     = 'MIT'
+
+  gem.add_dependency 'httparty'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'money'
+  gem.add_development_dependency 'rspec-core'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'excon', '>= 0.22.0'
+  gem.add_development_dependency 'webmock', '< 1.12.0'
+
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files    = gem.files.grep(/^spec/)
+  gem.require_path = "lib"
+
 end