konstati 0.1.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2011, W3P Projetos Web
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list
+of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, this
+list of conditions and the following disclaimer in the documentation and/or other
+materials provided with the distribution.
+
+Neither the name of W3P Projetos Web nor the names of its contributors may be used
+to endorse or promote products derived from this software without specific prior
+written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.markdown

@@ -0,0 +1,85 @@
+# Konstati Ruby API Client
+
+Konstati is a service that performs realtime antispam tests agains HTML email
+messages. Its main purpose is to provide means to email marketers to verify
+their campaigns before actually sending them.
+
+As of the date of this document, the only available antispam test is based on
+Spamassassin.
+
+This library provides access to the API just like any other activeresource
+client library.
+
+## Installation
+
+Use RubyGems to install this library:
+
+    $ gem install konstati
+
+## Authentication
+
+Konstati uses HTTP basic authentication, which can be setup using:
+
+    Konstati::Base.authenticate(:username => "user", :password => "password")
+
+If authentication fails, Konstati will return 401 Unauhtorized.
+
+## Spamassassin Tests
+
+### Create a New Test
+
+This is a sample request:
+
+    result = Konstati::Tests::Spamassassin.create(
+      :bodyHtml  => "<p>Hello World</p>",  # required
+      :bodyText  => "Hello World",         # optional
+      :subject   => "Free stuff!",         # required
+      :fromEmail => "email@example.com",   # required
+      :fromName  => "John Doe",            # required
+      :lang      => "pt_BR",               # required
+      :customer  => "mycustomerlogin"      # optional
+    )
+
+The result will contain the following data:
+
+    id           # (String)  unique test id, you can use this to query it
+    isSpam       # (Boolean) if the message is spam or not (thresold: 7.0 points)
+    lang         # (String)  language used on the results
+    score        # (Float)   total spam score for the message
+    customer     # (String)  optional customer name/login
+    message      # (Message) contains all message-related parameters specified in the request
+    status       # (String)  status of the spam test (done/processing/error/cancelled)
+    testDuration # (Float)   time it took for the test to be processed (in seconds)
+    matchedRules # (Array)   this Array contains all matched Spamassassin rules,
+                 #           where each object contains "ruleName", "description",
+                 #           "score" and "tips" (may be empty)
+
+### Get a Test Result
+
+    result = Konstati::Tests::Spamassassin.find("4d54f05b898d2994e41dde8b")
+
+If test does not exist, 404 Not Found will be raised.
+
+### List Test Results
+
+    results = Konstati::Tests::Spamassassin.find(:all, :params => {})
+
+Optional parameters in :params may be used to filter results. Available parameters are **lang**,
+**status** and **customer**. Each parameter can be used alone or in a combination with other(s).
+
+Here are some examples:
+
+    # all tests performed by "johndoe"
+    results = Konstati::Tests::Spamassassin.find(:all, :params => {:customer => "johndoe"})
+
+    # all tests in pt_BR by "johndoe"
+    results = Konstati::Tests::Spamassassin.find(:all, :params => {:customer => "johndoe", :lang => "pt_BR"})
+    
+    # all tests with "done" status in "en_EN"
+    results = Konstati::Tests::Spamassassin.find(:all, :params => {:status => "done", :lang => "en_EN"})
+
+You can also perform pagination using **perPage** and **pageNumber** parameters. Default behavior is to
+return the first 20 results. These parameters can also be used together with filters:
+
+    # give me 40 tests performed by "johndoe" in pt_BR
+    results = Konstati::Tests::Spamassassin.find(:all, :params => {:lang => "en_EN", :perPage => 40, :customer => "johndoe"})

data/lib/konstati.rb

@@ -0,0 +1,39 @@
+require "active_resource"
+
+module Konstati
+
+  VERSION = "0.1.0"
+
+  class Base < ActiveResource::Base
+
+    self.format = :json
+    self.site = "http://api.konstati.co/"
+    self.headers['User-Agent'] = "Konstati Ruby Client v0.1"
+
+    def self.authenticate(options)
+      self.user = options[:username]
+      self.password = options[:password]
+    end
+
+    def self.element_path(id, prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}/#{id}#{query_string(query_options)}"
+    end
+
+    def self.collection_path(prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+    end
+  end
+
+  module Tests
+
+    class Spamassassin < Base
+      self.site = "http://api.konstati.co/"
+      self.collection_name = "tests/spamassassin"
+      self.element_name = "tests/spamassassin"
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: konstati
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pedro Padron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-11 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Ruby client to the Konstati API
+email: ppadron@w3p.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- LICENSE
+files: 
+- lib/konstati.rb
+- README.markdown
+- LICENSE
+has_rdoc: true
+homepage: http://konstati.co/
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: konstati
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby client to the Konstati API
+test_files: []
+