plagiarism 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a2d2b68d898e809cc3279479ff59a81f81c376
-  data.tar.gz: ce40f54fd1ef40379197ad613f0f982cf16e1ce4
+  metadata.gz: 229afb24431eaea58e146b9ca42b2215f2827462
+  data.tar.gz: af71e20ab04117d27ecb7cabe59b50846f3119f6
 SHA512:
-  metadata.gz: 9eaa6a64ef1b56b0cefca2274ce429eaf70712da7e4327f39a145688412731869fcd3e0709b4681e434fac33f1a176479b1cb905f9fd7411c06d55b0c58abc15
-  data.tar.gz: 8fef4b4322fc19d375be60796c2c695397de89c546ca1327c832f0ef4ec2e98e3dc201fae28eafc37ae9bebfccdf9fc38c1d73ff58ecde6ba563735c30768947
+  metadata.gz: 4cbe99e26c3f9a8a7669053eb2cc0bc842eb3fddb627d760eb0288edd51319828da54d3ba9284a50204ae51c4b6349be33980527a5f26cd8aa5d9e457f36193f
+  data.tar.gz: 2d636a86a296bd32deac03a2b0a494492846ffe7ad2a124b62138ff998c42986f1cff70e6cee5b405dbf750d00e1da9f183154aeb5e9e697dc76cf58395d891f

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/README.md

@@ -1,3 +1,9 @@
+
+![Build Status](https://api.travis-ci.org/zohlgren/plagiarism.png)  
+![Code Climate](https://codeclimate.com/github/zohlgren/plagiarism.png)
+
+
+
 ## Plagiarism
 
 Search for plagiarism and check the originality of your content with Copyscape.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/plagiarism/request.rb

@@ -6,16 +6,18 @@ module Plagiarism
 
     base_uri "http://www.copyscape.com/api"
 
-    attr_accessor :response, :params
+    attr_accessor :response, :raw_response, :params
 
     def initialize(method, options = {})
       @params = build_params(options)
       if method.eql? :get
-        @response = Response.new self.class.get('/', query: @params)
+        @raw_response = self.class.get('/', query: @params)
+        @response = Response.new(@raw_response)
       elsif method.eql? :post
-        @response = Response.new self.class.post('/', body: @params)
+        @raw_response = self.class.post('/', body: @params)
+        @response = Response.new(@raw_response)
       else
-        raise "Invalid HTTP request method"
+        raise "Invalid or missing HTTP request method"
       end
     end
 

data/lib/plagiarism/search.rb

@@ -10,6 +10,7 @@ module Plagiarism
       @response.success? ? @response.doc.css("count").text.to_i : nil
     end
 
+
     # Return true if any results were found
     #
     def results?
@@ -24,6 +25,7 @@ module Plagiarism
 
 
     # Return true if the search request was successful
+    #
     def success?
       @response && @response.success? ? true : false
     end
@@ -36,17 +38,35 @@ module Plagiarism
     end
 
 
-    # Return the URL for viewing results
+    # Return the number of words matched from the source
     #
-    def results_url
-      if @response.success? && viewing_url = @response.doc.css("allviewurl").text
-        viewing_url != "" ? viewing_url : nil
+    def words_matched
+      if @response.success? && words = @response.doc.css("allwordsmatched").text
+        words != "" ? words.to_i : nil
       else
         nil
       end
     end
 
 
+    # Return the percentage of words matched from the source
+    #
+    def percentage_matched
+      if @response.success? && percentage = @response.doc.css("allpercentmatched").text
+        percentage != "" ? percentage.to_i : nil
+      else
+        nil
+      end
+    end
+
+
+    # Return the URL for viewing results
+    #
+    def results_url
+      @response.doc.css("allviewurl").text if results?
+    end
+
+
   protected
 
 
@@ -55,7 +75,7 @@ module Plagiarism
         o: operation_for_scope(options[:scope]),
         c: options[:full_comparisons] || 0
       }
-      params.merge(e: options[:encoding]) if self.class == TextSearch
+      params.merge!(e: options[:encoding]) if options[:encoding] && self.class == TextSearch
       params
     end
 
@@ -63,9 +83,9 @@ module Plagiarism
     # Map search scope to an api operation
     #
     def operation_for_scope(scope)
-      if scope == "full"
+      if scope && scope.to_sym == :full
         "cpsearch"
-      elsif scope == "private"
+      elsif scope && scope.to_sym == :private
         "psearch"
       else
         "csearch"

data/lib/plagiarism/text_search.rb

@@ -3,7 +3,7 @@ module Plagiarism
 
     def initialize(search_text, options = {})
       validate_text(search_text)
-      params = {e: "UTF-8", t: search_text}.merge(search_params(options))
+      params = {e: "UTF-8", t: search_text}.merge!(search_params(options))
       @request = Request.new(:post, params)
       @response = @request.response
     end
@@ -13,7 +13,8 @@ module Plagiarism
 
 
     def validate_text(text)
-      raise "Invalid search text" if text.class != String || text.nil? || text == ""
+      raise "Invalid or missing search text." if text.class != String || text.nil? || text == ""
+      raise "Search text must be at least 15 words." if text.split(" ").size < 15
     end
 
   end

data/lib/plagiarism/url_search.rb

@@ -14,7 +14,7 @@ module Plagiarism
 
     def validate_url(url)
       uri = URI.parse URI.encode(url)
-      raise "Please provide a valid search URL" unless uri.scheme && uri.host && uri.path
+      raise "Please provide a valid search URL." unless uri.scheme && uri.host && uri.path
     end
 
   end

data/plagiarism.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'plagiarism'
-  gem.version     = '0.1.1'
+  gem.version     = '0.1.3'
   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"
@@ -11,7 +11,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httparty'
   gem.add_dependency 'nokogiri'
   gem.add_dependency 'money'
-  gem.add_development_dependency 'rspec-core'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'excon', '>= 0.22.0'
   gem.add_development_dependency 'webmock', '< 1.12.0'

data/spec/plagiarism/balance_spec.rb

@@ -3,22 +3,8 @@ require 'spec_helper'
 describe Plagiarism::Balance do
 
   before do
-    Plagiarism.configure do |config|
-      config.username = "COPYSCAPE_USERNAME"
-      config.api_key = "COPYSCAPE_API_KEY"
-    end
-  end
-
-
-  it "requires a Copyscape username" do
-    Plagiarism.username = nil
-    expect { Plagiarism::Balance.amount }.to raise_error
-  end
-
-
-  it "requires a Copyscape API key" do
-    Plagiarism.api_key = nil
-    expect { Plagiarism::Balance.amount }.to raise_error
+    Plagiarism.username = "USERNAME"
+    Plagiarism.api_key = "API_KEY"
   end
 
 

data/spec/plagiarism/plagiarism_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe Plagiarism do
 
+describe Plagiarism do
 
 
 end

data/spec/plagiarism/request_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Plagiarism::Request do
+
+  before do
+    Plagiarism.username = "USERNAME"
+    Plagiarism.api_key = "API_KEY"
+  end
+
+
+  it "requires a Copyscape username to be configured" do
+    Plagiarism.username = nil
+    expect {
+      Plagiarism::Request.new(:get)
+    }.to raise_error(RuntimeError, "You must provide your Copyscape username")
+  end
+
+
+  it "requires a Copyscape API key to be configured" do
+    Plagiarism.api_key = nil
+    expect {
+      Plagiarism::Request.new(:get)
+    }.to raise_error(RuntimeError, "You must provide your Copyscape API key")
+  end
+
+
+  it "cannot be created without an HTTP request method" do
+    expect {
+      Plagiarism::Request.new
+    }.to raise_error(ArgumentError)
+  end
+
+
+  it "cannot be created with an invalid request method" do
+    expect {
+      Plagiarism::Request.new(:foobar)
+    }.to raise_error(RuntimeError, "Invalid or missing HTTP request method")
+  end
+
+
+  it "accepts a :get request method" do
+    VCR.use_cassette "empty_get_request" do
+      expect {
+        Plagiarism::Request.new(:get)
+      }.to_not raise_error
+    end
+  end
+
+
+  it "accepts a :post request method" do
+    VCR.use_cassette "empty_post_request" do
+      expect {
+        Plagiarism::Request.new(:post)
+      }.to_not raise_error
+    end
+  end
+
+
+  it "has a params hash after instantiation" do
+    VCR.use_cassette "empty_get_request" do
+      request = Plagiarism::Request.new(:get)
+      request.params.should_not be_nil
+    end
+  end
+
+
+  it "has a raw response object after instantiation" do
+    VCR.use_cassette "empty_get_request" do
+      request = Plagiarism::Request.new(:get)
+      request.raw_response.should_not be_nil
+    end
+  end
+
+
+  it "has a response object after instantiation" do
+    VCR.use_cassette "empty_get_request" do
+      request = Plagiarism::Request.new(:get)
+      request.response.should_not be_nil
+    end
+  end
+
+
+  it "includes the test parameter if test mode is enabled" do
+    VCR.use_cassette "empty_get_request_in_test_mode" do
+      Plagiarism.test_mode = true
+      request = Plagiarism::Request.new(:get)
+      Plagiarism.test_mode = false
+      request.params.keys.index(:x).should_not be_nil
+    end
+  end
+
+
+  it "excludes the test parameter if test mode is disabled" do
+    VCR.use_cassette "empty_get_request" do
+      request = Plagiarism::Request.new(:get)
+      request.params.keys.index(:x).should be_nil
+    end
+  end
+
+end

data/spec/plagiarism/response_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Plagiarism::Response do
+
+  before do
+    Plagiarism.username = "USERNAME"
+    Plagiarism.api_key = "API_KEY"
+    VCR.use_cassette "empty_get_request" do
+      @raw_response = Plagiarism::Request.new(:get).raw_response
+    end
+  end
+
+  it "cannot be created without a response object" do
+    expect {
+      Plagiarism::Response.new
+    }.to raise_error(ArgumentError)
+  end
+
+
+  it "has a response object after instantiation" do
+    response = Plagiarism::Response.new(@raw_response)
+    response.response.should_not be_nil
+  end
+
+
+  it "has a Nokogiri document object after instantiation" do
+    response = Plagiarism::Response.new(@raw_response)
+    response.doc.should_not be_nil
+  end
+
+
+end

data/spec/plagiarism/text_search_spec.rb

@@ -3,50 +3,183 @@ require 'spec_helper'
 describe Plagiarism::TextSearch do
 
   before do
-    Plagiarism.configure do |config|
-      config.username = "COPYSCAPE_USERNAME"
-      config.api_key = "COPYSCAPE_API_KEY"
-    end
+    Plagiarism.username = "USERNAME"
+    Plagiarism.api_key = "API_KEY"
     @search_text = "When in the Course of human events, it becomes necessary for one people to dissolve"
+    @unique_text = "Nonclosely decani unspaced guardlike unporcelainized prewire russki achaian
+      mecisteus nontemporariness tumuli creepfed subsimian hoopoe muddler wels contraste"
   end
 
 
-  it "requires a Copyscape username" do
-    Plagiarism.username = nil
+  it "cannot be created without a search query" do
     expect {
-      Plagiarism::TextSearch.new("http://example.com")
-    }.to raise_error
+      Plagiarism::TextSearch.new
+    }.to raise_error(ArgumentError)
   end
 
 
-  it "requires a Copyscape API key" do
-    Plagiarism.api_key = nil
+  it "cannot be created with an invalid search query" do
     expect {
-      Plagiarism::TextSearch.new("http://example.com")
-    }.to raise_error
+      Plagiarism::TextSearch.new(12345)
+    }.to raise_error(RuntimeError, "Invalid or missing search text.")
   end
 
 
-  it "must have a valid search query" do
-    expect { Plagiarism::TextSearch.new }.to raise_error
+  it "must have a search query of at least 15 words" do
+    expect {
+      invalid_query = "one two three four five six seven eight nine ten eleven twelve thirteen fourteen"
+      Plagiarism::TextSearch.new(invalid_query)
+    }.to raise_error(RuntimeError, "Search text must be at least 15 words.")
   end
 
 
   it "will execute with a valid search query" do
-    VCR.use_cassette "valid_text_search_with_results" do
+    VCR.use_cassette "valid_text_csearch_with_results" do
       search = Plagiarism::TextSearch.new(@search_text)
       search.success?.should be_true
     end
   end
 
 
-  context "when results are found" do
-    it "will have a result count > 0" do
-      VCR.use_cassette "valid_text_search_with_results" do
+  it "uses UTF-8 encoding by default" do
+    VCR.use_cassette "valid_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text)
+      search.request.params[:e].should eq("UTF-8")
+    end
+  end
+
+
+  it "allows a different encoding to be specified" do
+    VCR.use_cassette "valid_latin_encoded_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text, encoding: "ISO-8859-1")
+      search.request.params[:e].should eq("ISO-8859-1")
+    end
+  end
+
+
+  it "doesn't use full comparisons by default" do
+    VCR.use_cassette "valid_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text)
+      search.request.params[:c].should eq(0)
+    end
+  end
+
+
+  it "allows a number of full comparisons to be specified" do
+    VCR.use_cassette "valid_full_comparision_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text, full_comparisons: 3)
+      search.request.params[:c].should eq(3)
+    end
+  end
+
+
+  it "uses public search scope (csearch) by default" do
+    VCR.use_cassette "valid_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text)
+      search.request.params[:o].should eq("csearch")
+    end
+  end
+
+
+  it "allows a private index search to be used" do
+    VCR.use_cassette "valid_text_psearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text, scope: :private)
+      search.request.params[:o].should eq("psearch")
+    end
+  end
+
+
+  it "allows both public and private index search to be used" do
+    VCR.use_cassette "valid_text_cpsearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text, scope: :full)
+      search.request.params[:o].should eq("cpsearch")
+    end
+  end
+
+
+  it "returns the number source words checked" do
+    VCR.use_cassette "valid_text_csearch_with_results" do
+      search = Plagiarism::TextSearch.new(@search_text)
+      search.words.should eq(1340)
+    end
+  end
+
+
+  context "with 1 or more results found" do
+
+    it "returns the a url to review results" do
+      VCR.use_cassette "valid_text_csearch_with_results" do
+        search = Plagiarism::TextSearch.new(@search_text)
+        search.results_url.should eq("http://view.copyscape.com/search/0tkw0spask")
+      end
+    end
+
+    it "returns a result count greater than zero" do
+      VCR.use_cassette "valid_text_csearch_with_results" do
         search = Plagiarism::TextSearch.new(@search_text)
         search.count.should satisfy{|count| count > 0}
       end
     end
+
+  end
+
+
+  context "with no results found" do
+
+    it "returns nil for results_url" do
+      VCR.use_cassette "valid_text_csearch_without_results" do
+        search = Plagiarism::TextSearch.new(@unique_text)
+        search.results_url.should be_nil
+      end
+    end
+
+    it "returns a results count of zero" do
+      VCR.use_cassette "valid_text_csearch_without_results" do
+        search = Plagiarism::TextSearch.new(@search_text)
+        search.count.should eq(0)
+      end
+    end
+
   end
 
+
+  context "with full text comparisons enabled" do
+
+    it "returns the percentage of source text matched" do
+      VCR.use_cassette "valid_full_comparision_text_csearch_with_results" do
+        search = Plagiarism::TextSearch.new(@search_text, full_comparisons: 3)
+        search.percentage_matched.should eq(98)
+      end
+    end
+
+
+    it "returns the number of source words matched" do
+      VCR.use_cassette "valid_full_comparision_text_csearch_with_results" do
+        search = Plagiarism::TextSearch.new(@search_text, full_comparisons: 3)
+        search.words_matched.should eq(1324)
+      end
+    end
+
+  end
+
+  context "with full text comparisons disabled" do
+
+    it "should return nil for percentage_matched" do
+      VCR.use_cassette "valid_csearch_with_results" do
+        search = Plagiarism::TextSearch.new(@search_text)
+        search.percentage_matched.should be_nil
+      end
+    end
+
+
+    it "should return nil for words_matched" do
+      VCR.use_cassette "valid_csearch_with_results" do
+        search = Plagiarism::TextSearch.new(@search_text)
+        search.words_matched.should be_nil
+      end
+    end
+
+  end
+
+
 end