defender 1.0.0beta1 → 1.0.0

data/README.md

@@ -22,6 +22,13 @@ spam and malicious content in the documents.
 A document contains content to be analyzed by Defensio, or that has been
 analyzed.
 
+Before starting to use Defender, you need to retrieve an API key from
+[Defensio][4]. After getting an API key, you need to let Defender know
+what it is by doing something like this somewhere in your code (before
+doing anything like saving documents):
+
+    Defender.api_key = 'my-api-key'
+
 Submitting documents to Defensio is really easy. Here's a barebones
 example:
 
@@ -122,11 +129,13 @@ This project uses [Semantic Versioning][sv].
 Author
 ------
 
-Henrik Hodne :: dvyjones@binaryhex.com :: @dvyjones
+Henrik Hodne :: <dvyjones@binaryhex.com> :: @[dvyjones][5]
 
 [0]: http://defensio.com
 [1]: http://help.github.com/forking/
 [2]: http://github.com/dvyjones/defender/issues
 [3]: http://defensio.com/api
+[4]: http://defensio.com/signup/
+[5]: http://twitter.com/dvyjones
 [sv]: http://semver.org
 [cb]: http://wiki.github.com/dvyjones/defender/contributing

data/lib/defender.rb

@@ -21,4 +21,20 @@ module Defender
     require 'defensio'
     @defensio ||= Defensio.new(Defender.api_key, "Defender | #{VERSION} | Henrik Hodne | dvyjones@binaryhex.com")
   end
+
+  ##
+  # Calls a defensio method and wraps in error handling.
+  #
+  # Returns false if the method failed, otherwise returns whatever the method returns
+  #
+  # @param [Symbol] method Which method to call.
+  # @return [false, Array(Fixnum, Hash)]
+  def self.call(method, *args)
+    code, data = defensio.send(method, *args)
+    if code == 200 && data['status'] == 'success'
+      [code, data]
+    else
+      false
+    end
+  end
 end

data/lib/defender/document.rb

@@ -1,4 +1,7 @@
 module Defender
+  ##
+  # A document contains data to be analyzed by Defensio, or that has been
+  # analyzed.
   class Document
     ##
     # Whether the document should be published on your Web site or not.
@@ -38,15 +41,19 @@ module Defender
     # content of the request (all of the data in the {#data} hash).
     #
     # @param [String] signature The signature of the document to retrieve
-    # @return [Document] The document to retrieve
+    # @return [Document,nil] The document to retrieve, or nil
     def self.find(signature)
       document = new
-      _code, data = Defender.defensio.get_document(signature)
-      document.instance_variable_set(:@saved, true)
-      document.instance_variable_set(:@allow, data['allow'])
-      document.instance_variable_set(:@signature, signature)
+      ret = Defender.call(:get_document, signature)
+      if ret
+        document.instance_variable_set(:@saved, true)
+        document.instance_variable_set(:@allow, ret.last['allow'])
+        document.instance_variable_set(:@signature, signature)
 
-      document
+        document
+      else
+        nil
+      end
     end
 
     ##
@@ -71,19 +78,39 @@ module Defender
     # this).
     #
     # @see #saved?
+    # @return [Boolean] Whether the save succeded or not.
     def save
       if saved?
-        _code, data = Defender.defensio.put_document(@signature, {:allow => @allow})
+        ret = Defender.call(:put_document, @signature, {:allow => @allow})
       else
-        data = {}
-        @data.each { |k,v|
-          data[k.to_s.gsub('_','-')] = v.to_s
-        }
-        _code, data = Defender.defensio.post_document(@data)
-        @allow = data['allow']
-        @signature = data['signature']
-        @saved = true
+        ret = Defender.call(:post_document, self.class.normalize_data(@data))
       end
+      return false if ret == false
+      return true if saved?
+
+      data = ret.last
+      @allow = data['allow']
+      @signature = data['signature']
+
+      @saved = true # This will also return true, since nothing failed as we got here
+    end
+
+
+    ##
+    # Normalizes a data hash to submit to defensio.
+    #
+    # @param [Hash] hsh The hash to be normalized
+    # @return [Hash{String => String}] The normalized hash
+    def self.normalize_data(data)
+      normalized = {}
+      data.each { |key, value|
+        if value.respond_to?(:strftime)
+          value = value.strftime('%Y-%m-%d')
+        end
+        normalized[key.to_s.gsub('_','-')] = value.to_s
+      }
+      
+      normalized
     end
   end
 end

data/lib/defender/version.rb

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

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: defender
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 1
   - 0
-  - 0beta1
-  version: 1.0.0beta1
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Henrik Hodne
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-06 00:00:00 +02:00
+date: 2010-04-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,20 @@ dependencies:
         version: 0.5.0
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id004
 description: A wrapper of the Defensio spam filtering service.
 email: 
 - henrik.hodne@binaryhex.com