viking 1.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'rspec'
+
+require 'viking'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+# See http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html
+class Class
+  def publicize_methods(instance=nil)
+    saved_private_instance_methods = self.private_instance_methods
+    self.class_eval { public *saved_private_instance_methods }
+    yield(instance)
+  ensure
+    self.class_eval { private *saved_private_instance_methods }
+  end
+end
+
+##
+# rSpec Hash additions.
+#
+# From
+#   * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+#   * Neil Rahilly
+class Hash
+  ##
+  # Filter keys out of a Hash.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.except(:a)
+  #   => { :b => 2, :c => 3 }
+  def except(*keys)
+    self.reject { |k,v| keys.include?(k || k.to_sym) }
+  end
+
+  ##
+  # Override some keys.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.with(:a => 4)
+  #   => { :a => 4, :b => 2, :c => 3 }
+  def with(overrides = {})
+    self.merge overrides
+  end
+
+  ##
+  # Returns a Hash with only the pairs identified by +keys+.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.only(:a)
+  #   => { :a => 1 }
+  def only(*keys)
+    self.reject { |k,v| !keys.include?(k || k.to_sym) }
+  end
+end

data/spec/viking/akismet_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Viking::Akismet do
+
+  def valid_options
+    {
+      :blog => 'foo',
+      :api_key => 'bar'
+    }
+  end
+
+  let(:akismet) { Viking.connect('akismet', valid_options) }
+  let(:http) { Net::HTTP.new('url') }
+
+  before do
+    Net::HTTP.stub(:new).and_return(http)
+  end
+
+  describe ".new" do
+
+    it "should not have a verified key when initialized" do
+      akismet.send(:verified_key).should be_false
+    end
+
+  end
+
+  describe '.url' do
+
+    it 'should return an URL for a request' do
+      Viking::Akismet.url('bar').should == '/1.1/bar'
+    end
+
+  end
+
+  describe "#verified?" do
+
+    it "should be verified when all parameters are provided" do
+      http.should_receive(:post).and_return(stub("response", :body => "valid"))
+
+      akismet.should be_verified # #verified? is called twice to make sure #verify_api_key is not called twice
+      akismet.should be_verified
+    end
+
+    it "should not be verified if Akismet doesn't validate" do
+      http.should_receive(:post).and_return(stub("response", :body => "invalid"))
+      akismet.should_not be_verified
+    end
+
+    it "should not be verified if its options are invalid" do
+      Viking.connect('akismet', {}).should_not be_verified
+    end
+
+  end
+
+  describe "#check_comment" do
+
+    it "should be false if the instance has invalid options" do
+      Viking.connect('akismet', {}).check_comment({}).should be_false
+    end
+
+    it "should be spam when the response body isn't a valid response" do
+      http.should_receive(:post).and_return(stub("response", :body => "invalid"))
+      akismet.check_comment(:user_ip => "127.0.0.1", :user_agent => "Mozilla").should == { :message => "invalid", :spam => true }
+    end
+
+    it "should not be spam when the response body is a valid response" do
+      http.should_receive(:post).and_return(stub("response", :body => "false"))
+      akismet.check_comment(:user_ip => "127.0.0.1", :user_agent => "Mozilla").should == { :message => "false", :spam => false }
+    end
+
+  end
+
+  describe "#mark_as_spam" do
+
+    it 'should be false if the instance has invalid options' do
+      Viking.connect('akismet', {}).mark_as_spam({}).should be_false
+    end
+
+    it 'should return the response body' do
+      http.should_receive(:post).and_return(stub('response', :body => "foo"))
+      akismet.mark_as_spam({}).should == { :message => "foo" }
+    end
+
+  end
+
+  describe '#mark_as_ham' do
+
+    it 'should be false if the instance has invalid options' do
+      Viking.connect('akismet', {}).mark_as_ham({}).should be_false
+    end
+
+    it 'should return the response body' do
+      http.should_receive(:post).and_return(stub('response', :body => "foo"))
+      akismet.mark_as_ham({}).should == { :message => "foo" }
+    end
+
+  end
+
+end

data/spec/viking/base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Viking::Base do
+
+  def valid_base_options
+    {
+      :api_key => "1234abc",
+      :blog    => "wiki.mysite.com"
+    }
+  end
+
+  let(:base) { Viking::Base.new({}) }
+
+  describe "#mark_as_spam_or_ham" do
+
+    it "should mark as spam when is_spam is true" do
+      base.should_receive(:mark_as_spam).and_return("I will be spam")
+      base.mark_as_spam_or_ham(true, {}).should == "I will be spam"
+    end
+
+    it "should mark as ham when is_spam is false" do
+      base.should_receive(:mark_as_ham).and_return("I will be ham")
+      base.mark_as_spam_or_ham(false, {}).should == "I will be ham"
+    end
+
+  end
+
+  describe "#invalid_options?" do
+
+    it "should be false if the required options are non-nil" do
+      base.options = valid_base_options
+      base.should_not be_invalid_options
+    end
+
+    it "should be true if the options don't include an API key" do
+      base.options = valid_base_options.except(:api_key)
+      base.should be_invalid_options
+    end
+
+    it "should be true if the options don't include a blog address" do
+      base.options = valid_base_options.except(:blog)
+      base.should be_invalid_options
+    end
+
+  end
+
+end

data/spec/viking/defensio_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+describe Viking::Defensio do
+
+  def valid_options
+    {
+      :blog => 'foo',
+      :api_key => 'bar'
+    }
+  end
+
+  def defensio_with_bad_options
+    Viking.connect('defensio', {})
+  end
+
+  let(:defensio) { Viking.connect('defensio', valid_options) }
+  let(:http) { Net::HTTP.new('url') }
+
+  before do
+    Net::HTTP.stub!(:new).and_return(http)
+  end
+
+  describe '.new' do
+
+    it 'should not have verified options when initialized' do
+      defensio_with_bad_options.send(:verify_options).should == false
+    end
+
+  end
+
+  describe '#verified?' do
+
+    it "should be verified when all parameters are provided" do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  status: success"))
+
+      defensio.should be_verified # called twice to make sure #validate-key is not called twice
+      defensio.should be_verified
+    end
+
+    it "should not be verified if Defensio doesn't validate" do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  status: fail"))
+      defensio.should_not be_verified
+    end
+
+    it "should not be verified if its options are invalid" do
+      defensio_with_bad_options.should_not be_verified
+    end
+
+  end
+
+  describe '#check_article' do
+
+    it 'should be false if its options are invalid' do
+      defensio_with_bad_options.check_article({}).should be_false
+    end
+
+    it 'should check the article with Defensio' do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  foo: bar"))
+      defensio.check_article({})[:foo].should == "bar"
+    end
+
+  end
+
+  describe '#check_comment' do
+
+    it 'should be false if its options are invalid' do
+      defensio_with_bad_options.check_comment({}).should be_false
+    end
+
+    it 'should raise a NoMethodError if options are provided without an article_date that responds to strftime' do
+      http.should_not_receive(:post)
+      expect { defensio.check_comment(:article_date => nil) }.to raise_error(NoMethodError)
+    end
+
+    it 'should check the comment with Defensio' do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  foo: bar"))
+      defensio.check_comment(:article_date => Time.now)[:foo].should == "bar"
+    end
+
+  end
+
+  describe '#mark_as_spam' do
+
+    it 'should be false if its options are invalid' do
+      defensio_with_bad_options.mark_as_spam({}).should be_false
+    end
+
+    it 'should mark the comments whose signatures are provided as spam' do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  foo: bar"))
+      defensio.mark_as_spam(:signatures => "1,2,3")[:foo].should == "bar"
+    end
+
+  end
+
+  describe '#mark_as_ham' do
+
+    it 'should be false if its options are invalid' do
+      defensio_with_bad_options.mark_as_ham({}).should be_false
+    end
+
+    it 'should mark the comments whose signatures are provided as spam' do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n  foo: bar"))
+      defensio.mark_as_ham(:signatures => "1,2,3").should == { :foo => "bar" }
+    end
+
+  end
+
+  describe '#stats' do
+
+    it 'should be false if its options are invalid' do
+      defensio_with_bad_options.stats.should be_false
+    end
+
+    it 'should return stats about the blog' do
+      http.should_receive(:post).and_return(stub("response", :body => "defensio-result:\n foo: bar"))
+      defensio.stats.should == { :foo => "bar" }
+    end
+
+  end
+
+  describe '#url' do
+
+    it 'should return an URL for the specified action' do
+      defensio.url('get-stats').should == '/blog/1.2/get-stats/bar.yaml'
+    end
+
+  end
+
+  describe '#process_response_body' do
+
+    it 'should return the defensio-response portion of the YAML response as a Hash' do
+      Viking::Defensio.publicize_methods do
+        v = Viking.connect('defensio', {})
+        v.process_response_body("defensio-result:\n  foo: bar").should == { :foo => "bar" }
+      end
+    end
+
+    it 'should return the entire response with failure as the status if the response is not as expected' do
+      Viking::Defensio.publicize_methods do
+        v = Viking.connect('defensio', {})
+        v.process_response_body("foo:\n  bar: baz").should == { :data => { 'foo' => { 'bar' => 'baz' } }, :status => "fail" }
+      end
+    end
+
+  end
+
+end

data/spec/viking/viking_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Viking do
+
+  it { should respond_to :logger }
+  it { should respond_to :default_engine }
+  it { should respond_to :connect_options }
+  it { should respond_to :default_instance }
+
+  describe ".connect" do
+
+    it "should load the Defensio engine" do
+      Viking.connect('defensio', {}).should be_a_kind_of(Viking::Defensio)
+    end
+
+    it "should load the Akismet engine" do
+      Viking.connect('akismet', {}).should be_a_kind_of(Viking::Akismet)
+    end
+
+    it "should be nil if the engine is nil" do
+      Viking.connect(nil, {}).should be_nil
+    end
+
+    it "should be nil if the engine is blank" do
+      Viking.connect('', {}).should be_nil
+    end
+
+  end
+
+  describe ".enabled?" do
+
+    it "should not be enabled if a default instance has not be initialized" do
+      Viking.should_not be_enabled
+    end
+
+    it "should be enabled if a default instance has been initialized" do
+      Viking.default_engine  = 'defensio'
+      Viking.connect_options = '1234abc'
+      Viking.should be_enabled
+    end
+
+  end
+
+end

data/viking.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'viking/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "viking"
+  gem.version       = Viking::VERSION
+  gem.authors       = ["Risk Danger Olson", "James Herdman", "Pierre-Louis Gottfrois"]
+  gem.email         = ["pl.gottfrois@dimelo.com"]
+  gem.description   = %q{Modernized gem version of the Viking plugin}
+  gem.summary       = %q{Modernized gem version of the Viking plugin}
+  gem.homepage      = "https://github.com/dimelo/viking"
+
+  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(%q{rspec}, ['~> 2.12.0'])
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: viking
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Risk Danger Olson
+- James Herdman
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Modernized gem version of the Viking plugin
+email:
+- pl.gottfrois@dimelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_ext/object.rb
+- lib/core_ext/transformations.rb
+- lib/viking.rb
+- lib/viking/akismet.rb
+- lib/viking/base.rb
+- lib/viking/defensio.rb
+- lib/viking/version.rb
+- spec/core_ext/object_spec.rb
+- spec/core_ext/transformations_spec.rb
+- spec/spec_helper.rb
+- spec/viking/akismet_spec.rb
+- spec/viking/base_spec.rb
+- spec/viking/defensio_spec.rb
+- spec/viking/viking_spec.rb
+- viking.gemspec
+homepage: https://github.com/dimelo/viking
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Modernized gem version of the Viking plugin
+test_files:
+- spec/core_ext/object_spec.rb
+- spec/core_ext/transformations_spec.rb
+- spec/spec_helper.rb
+- spec/viking/akismet_spec.rb
+- spec/viking/base_spec.rb
+- spec/viking/defensio_spec.rb
+- spec/viking/viking_spec.rb