konstati 0.1.0 → 0.2.0

data/README.markdown

@@ -20,7 +20,8 @@ Use RubyGems to install this library:
 
 Konstati uses HTTP basic authentication, which can be setup using:
 
-    Konstati::Base.authenticate(:username => "user", :password => "password")
+    Konstati.username = "user"
+    Konstati.apikey   = "apikey"
 
 If authentication fails, Konstati will return 401 Unauhtorized.
 
@@ -30,56 +31,54 @@ If authentication fails, Konstati will return 401 Unauhtorized.
 
 This is a sample request:
 
-    result = Konstati::Tests::Spamassassin.create(
+    result = Konstati::Tests.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)
+    id            # (String)  unique test id, you can use this to query it later
+    emailMessage  # (Hash)    contains all message-related parameters specified in the request
+    customer      # (String)  optional customer name/login supplied in the request
+    lang          # (String)  language used on the results
+    type          # (String)  type of test (currently only spamassassin)
+    status        # (String)  status of the spam test (done/processing/error/cancelled)
+    startedAt     # (Float)   when the test was started (in seconds)
+    updatedAt     # (Float)   when the test was last updated (in seconds)
+    totalRuntime  # (Float)   time it took for the test to be processed (in seconds)
+    result        # (Hash)    contains all test result fields (score, isSpam, matchedRules)
 
 ### Get a Test Result
 
-    result = Konstati::Tests::Spamassassin.find("4d54f05b898d2994e41dde8b")
+    result = Konstati::Tests.find("4d54f05b898d2994e41dde8b")
 
 If test does not exist, 404 Not Found will be raised.
 
 ### List Test Results
 
-    results = Konstati::Tests::Spamassassin.find(:all, :params => {})
+    results = Konstati::Tests.find(: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).
+**status** and **customer**. Each parameter can be used alone or with other(s).
 
 Here are some examples:
 
     # all tests performed by "johndoe"
-    results = Konstati::Tests::Spamassassin.find(:all, :params => {:customer => "johndoe"})
+    results = Konstati::Tests.find(:params => {:customer => "johndoe"})
 
-    # all tests in pt_BR by "johndoe"
-    results = Konstati::Tests::Spamassassin.find(:all, :params => {:customer => "johndoe", :lang => "pt_BR"})
+    # all tests in pt by "johndoe"
+    results = Konstati::Tests.find(:params => {:customer => "johndoe", :lang => "pt"})
     
-    # all tests with "done" status in "en_EN"
-    results = Konstati::Tests::Spamassassin.find(:all, :params => {:status => "done", :lang => "en_EN"})
+    # all tests with "done" status in "en"
+    results = Konstati::Tests  .find(:params => {:status => "done", :lang => "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"})
+    # give me 40 tests performed by "johndoe" in pt
+    results = Konstati::Tests.find(:params => {:lang => "en", :perPage => 40, :customer => "johndoe"})

data/examples/account_info.rb

@@ -0,0 +1,11 @@
+require '../lib/konstati'
+require '../lib/konstati/account'
+
+Konstati.username = ''
+Konstati.apikey   = ''
+
+info = Konstati::Account.info
+
+credits = info['rateLimit']['max'] - info['rateLimit']['current']
+
+puts "I still have #{credits} credits left." 

data/examples/create_spamassassin_test.rb

@@ -0,0 +1,17 @@
+require '../lib/konstati'
+
+Konstati.username = ''
+Konstati.apikey   = ''
+
+test = Konstati::Test.create(
+  :type      => "spamassassin",
+  :bodyHtml  => "<p>Hello World</p>",
+  :bodyText  => "Hello World",
+  :subject   => "CHEAP VIAGRA!!!!",
+  :fromEmail => "email@example.com",
+  :fromName  => "John Doe",
+  :lang      => "pt",
+  :customer  => "mycustomerlogin"
+)
+
+puts "This email has scored #{test['result']['score']} points in SpamAssassin."

data/lib/konstati.rb

@@ -1,39 +1,51 @@
-require "active_resource"
+require 'restclient'
+require 'json'
+
+require File.dirname(__FILE__) + '/konstati/account'
+require File.dirname(__FILE__) + '/konstati/tests'
 
 module Konstati
 
-  VERSION = "0.1.0"
+    VERSION = '0.2.0'
 
-  class Base < ActiveResource::Base
+    def self.endpoint
+        @endpoint ||= "https://api.konstati.co/v1"
+    end
 
-    self.format = :json
-    self.site = "http://api.konstati.co/"
-    self.headers['User-Agent'] = "Konstati Ruby Client v0.1"
+    def self.endpoint=(val)
+        @endpoint = val
+    end
 
-    def self.authenticate(options)
-      self.user = options[:username]
-      self.password = options[:password]
+    def self.username
+        @username
     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)}"
+    def self.username=(val)
+        @username = val
     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)}"
+    def self.apikey=(val)
+        @apikey = val
     end
-  end
 
-  module Tests
+    def self.apikey
+        @apikey
+    end
 
-    class Spamassassin < Base
-      self.site = "http://api.konstati.co/"
-      self.collection_name = "tests/spamassassin"
-      self.element_name = "tests/spamassassin"
+    def self.resource(path)
+        RestClient::Resource.new(@endpoint + path, @username, @apikey)
     end
 
-  end
+    def self.request(method, path, params = {})
+        JSON.parse(
+          RestClient::Request.execute(
+            :method   => method,
+            :url      => endpoint + path,
+            :payload  => params,
+            :user     => @username,
+            :password => @apikey
+          )
+        )
+    end
 
 end

data/lib/konstati/account.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+module Konstati
+    class Account
+
+        def self.initialize
+            puts 'bola'
+        end
+
+        def self.info
+            Konstati.request("get", "/account")
+            # RestClient::Resource.new(Konstati::Config.endpoint + '/account', Konstati::Config.username, Konstati::Config.apikey).get
+        end
+    end
+end

data/lib/konstati/tests.rb

@@ -0,0 +1,22 @@
+module Konstati
+
+  class Tests
+
+    def self.create(params)
+      Konstati.request(:post, '/tests', params)
+    end
+
+    def self.find(params = {})
+      Konstati.request(:get, '/tests', params)
+    end
+
+    def self.delete(id)
+      Konstati.request(:delete, '/tests/' + id)
+    end
+
+    def self.get(id)
+      Konstati.request(:get, '/tests/' + id)
+    end
+
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: konstati
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pedro Padron
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-11 00:00:00 -02:00
+date: 2011-08-18 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activeresource
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -32,6 +32,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: restclient
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: Ruby client to the Konstati API
 email: ppadron@w3p.com.br
 executables: []
@@ -41,8 +55,14 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 - LICENSE
+- examples/account_info.rb
+- examples/create_spamassassin_test.rb
 files: 
 - lib/konstati.rb
+- lib/konstati/account.rb
+- lib/konstati/tests.rb
+- examples/account_info.rb
+- examples/create_spamassassin_test.rb
 - README.markdown
 - LICENSE
 has_rdoc: true