defender 0.2.0 → 1.0.0beta1

data/lib/defender/version.rb

@@ -0,0 +1,3 @@
+module Defender
+  VERSION = '1.0.0beta1'
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: defender
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: true
+  segments: 
+  - 1
+  - 0
+  - 0beta1
+  version: 1.0.0beta1
 platform: ruby
 authors: 
 - Henrik Hodne
@@ -9,104 +14,97 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 +01:00
+date: 2010-04-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: defensio
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.4.3
-    version: 
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.4.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.2.7
-    version: 
+  version_requirements: *id003
 description: A wrapper of the Defensio spam filtering service.
-email: henrik.hodne@binaryhex.com
+email: 
+- henrik.hodne@binaryhex.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- defender.gemspec
-- lib/defender.rb
 - lib/defender/document.rb
-- lib/defender/statistics.rb
-- spec/defender_spec.rb
-- spec/document_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/statistics_spec.rb
+- lib/defender/version.rb
+- lib/defender.rb
+- LICENSE
+- README.md
 has_rdoc: true
 homepage: http://github.com/dvyjones/defender
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby API wrapper for Defensio
-test_files: 
-- spec/spec_helper.rb
-- spec/document_spec.rb
-- spec/defender_spec.rb
-- spec/statistics_spec.rb
+test_files: []
+

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,23 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-doc
-.yardoc
-
-## PROJECT::SPECIFIC

data/README.rdoc

@@ -1,22 +0,0 @@
-= defender
-
-This is a Ruby wrapper of the Defensio[http://defensio.com] spam filtering API. To use this library, you need an API key from Defensio. Go ahead and {get one}[http://defensio.com/signup/].
-
-Thanks to Defensio for the excellent documentation, the documentation in the code is more or less copied from them.
-
-Defender follows the {Semantic Versioning}[http://semver.org/] spec.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-  bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009-2010 Henrik Hodne. See LICENSE for details.

data/Rakefile

@@ -1,74 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "defender"
-    gem.summary = %Q{Ruby API wrapper for Defensio}
-    gem.description = %Q{A wrapper of the Defensio spam filtering service.}
-    gem.email = "henrik.hodne@binaryhex.com"
-    gem.homepage = "http://github.com/dvyjones/defender"
-    gem.authors = ["Henrik Hodne"]
-    gem.add_dependency "httparty", "~> 0.4.3"
-    gem.add_development_dependency "rspec", "~> 1.2.9"
-    gem.add_development_dependency "yard", "~> 0.4.0" 
-    gem.add_development_dependency "fakeweb", "~> 1.2.7"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-begin
-  require 'reek/adapters/rake_task'
-  Reek::RakeTask.new do |t|
-    t.verbose = false
-    t.source_files = 'lib/**/*.rb'
-  end
-rescue LoadError
-  task :reek do
-    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
-  end
-end
-
-begin
-  require 'roodi'
-  require 'roodi_task'
-  RoodiTask.new do |t|
-    t.verbose = false
-  end
-rescue LoadError
-  task :roodi do
-    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
-  end
-end
-
-task :default => :spec
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new do |conf|
-    #conf.options = ["-mmarkdown"]
-    conf.files = ["lib/**/*.rb", "-", "LICENSE"]
-  end
-rescue LoadError
-  task :yard do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end

data/VERSION

@@ -1 +0,0 @@
-0.2.0

data/defender.gemspec

@@ -1,70 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{defender}
-  s.version = "0.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Henrik Hodne"]
-  s.date = %q{2010-01-20}
-  s.description = %q{A wrapper of the Defensio spam filtering service.}
-  s.email = %q{henrik.hodne@binaryhex.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "defender.gemspec",
-     "lib/defender.rb",
-     "lib/defender/document.rb",
-     "lib/defender/statistics.rb",
-     "spec/defender_spec.rb",
-     "spec/document_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "spec/statistics_spec.rb"
-  ]
-  s.homepage = %q{http://github.com/dvyjones/defender}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Ruby API wrapper for Defensio}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/document_spec.rb",
-     "spec/defender_spec.rb",
-     "spec/statistics_spec.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, ["~> 0.4.3"])
-      s.add_development_dependency(%q<rspec>, ["~> 1.2.9"])
-      s.add_development_dependency(%q<yard>, ["~> 0.4.0"])
-      s.add_development_dependency(%q<fakeweb>, ["~> 1.2.7"])
-    else
-      s.add_dependency(%q<httparty>, ["~> 0.4.3"])
-      s.add_dependency(%q<rspec>, ["~> 1.2.9"])
-      s.add_dependency(%q<yard>, ["~> 0.4.0"])
-      s.add_dependency(%q<fakeweb>, ["~> 1.2.7"])
-    end
-  else
-    s.add_dependency(%q<httparty>, ["~> 0.4.3"])
-    s.add_dependency(%q<rspec>, ["~> 1.2.9"])
-    s.add_dependency(%q<yard>, ["~> 0.4.0"])
-    s.add_dependency(%q<fakeweb>, ["~> 1.2.7"])
-  end
-end
-

data/lib/defender/statistics.rb

@@ -1,176 +0,0 @@
-module Defender
-  class Statistics
-    class Extended
-      ##
-      # The starting date.
-      #
-      # @return [String] Is in the format YYYY-MM-DD.
-      attr_reader :from
-
-      ##
-      # The ending date.
-      #
-      # @return [String] Is in the form YYYY-MM-DD.
-      attr_reader :to
-
-      ##
-      # Provides a set of URLs that chart the data provided in the data array.
-      #
-      # The Hash returned will have the keys `:accuracy`, `:unwanted` and
-      # `:legitimate`, which all refer to the same fields in the {#data} hash.
-      #
-      # @return [Hash{Symbol => String}]
-      attr_reader :chart_urls
-
-      ##
-      # The set of dates within the retrieved period.
-      #
-      # The keys are the date in YYYY-MM-DD format.
-      #
-      # Each date has the following keys:
-      #
-      # * `:false_negatives` - The number of false negatives for the specified
-      #   date.
-      # * `:false_positives` - The number of false positives for the specified
-      #   date.
-      # * `:legitimate` - The number of legitimate documents processed on the
-      #   specified date.
-      # * `:accuracy` - How accurate Defensio has recently been for the current
-      #   user on the specified date. This is returned as a Float between 0
-      #   and 1. For example, 0.9525 means 95.25% accurate.
-      # * `:unwanted` - The number of unwanted documents processed on the
-      #   specified date.
-      #
-      # @return [Hash{String => Hash{Symbol => Object}}]
-      attr_reader :data
-
-      ##
-      # Retrieves extended statistics from a given date to another one.
-      #
-      # @param [#strftime, #to_s] from The starting date.
-      # @param [#strftime, #to_s] to The ending date.
-      def initialize(from, to)
-        @from = from.respond_to?(:strftime) ? from.strftime('%Y-%m-%d') : from.to_s
-        @to = to.respond_to?(:strftime) ? to.strftime('%Y-%m-%d') : to.to_s
-
-        response = Defender.get("/#{Defender.api_key}/extended-stats.json", :from => @from, :to => @to)['defensio-result']
-        if response['status'] == 'success'
-          @chart_urls = {
-            :accuracy => response['chart-urls']['recent-accuracy'],
-            :unwanted => response['chart-urls']['total-unwanted'],
-            :legitimate => response['chart-urls']['total-legitimate']
-          }
-
-          @data = {}
-          response['data'].each do |data|
-            @data[data['date']] = {
-              :false_negatives => data['false-negatives'],
-              :false_positives => data['false-positives'],
-              :legitimate => data['legitimate'],
-              :accuracy => data['recent-accuracy'],
-              :unwanted => data['unwanted']
-            }
-          end
-        else
-          raise StandardError, response['message']
-        end
-      end
-    end
-
-    ##
-    # The version of the Defensio API being used. Should be the same as
-    # {Defender::API_VERSION}.
-    #
-    # @return [String]
-    attr_reader :api_version
-
-    ##
-    # The number of documents that have been allowed but that should have been
-    # blocked.
-    #
-    # @return [Fixnum]
-    attr_reader :false_negatives
-
-    ##
-    # The number of documents that have been blocked but that should have been
-    # allowed.
-    #
-    # @return [Fixnum]
-    attr_reader :false_positives
-
-    ##
-    # Whether Defensio is learning from the documents you post.
-    #
-    # @return [Boolean]
-    attr_reader :learning
-
-    ##
-    # A message explaining why Defensio is in learning mode.
-    #
-    # @return [String]
-    attr_reader :learning_status
-
-    ##
-    # The total number of legitimate documents analyzed.
-    #
-    # @return [Fixnum]
-    attr_reader :legitimate_total
-
-    ##
-    # How accurate Defensio has recently been for this user.
-    #
-    # This returns a floating point value between 0 and 1. For example, 0.9525
-    # means 95.25% accurate.
-    #
-    # @return [Float<0..1>]
-    attr_reader :recent_accuracy
-
-    ##
-    # The number of documents containing malicious content.
-    #
-    # @return [Fixnum]
-    attr_reader :unwanted_malicious
-
-    ##
-    # The number of spam documents analyzed.
-    #
-    # @return [Fixnum]
-    attr_reader :unwanted_spam
-
-    ##
-    # The total number of unwanted documents.
-    #
-    # @return [Fixnum]
-    attr_reader :unwanted_total
-
-    ##
-    # Initialize the object and retrieve basic statistics.
-    #
-    # @raise StandardError if any of the calls to the server during retrieving
-    #   of statistics fail.
-    def initialize
-      retrieve_basic_stats
-    end
-
-    private
-
-    def retrieve_basic_stats
-      response = Defender.get("/#{Defender.api_key}/basic-stats.json")['defensio-result']
-
-      if response['status'] == 'success'
-        @api_version = response["api-version"]
-        @false_negatives = response["false-negatives"]
-        @false_positives = response["false-positives"]
-        @learning = response["learning"]
-        @learning_status = response["learning-status"]
-        @legitimate_total = response["legitimate"]["total"]
-        @recent_accuracy = response["recent-accuracy"]
-        @unwanted_malicious = response["unwanted"]["malicious"]
-        @unwanted_spam = response["unwanted"]["spam"]
-        @unwanted_total = response["unwanted"]["total"]
-      else
-        raise StandardError, response['message']
-      end
-    end
-  end
-end