pdsphil-ruby-whatcounts 0.1.0

data/lib/whatcounts/spec/api_request_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include API::Base
+include API::WhatCounts
+
+describe OneOffMessageRequest do
+  include RequestSpecHelper
+  
+  it "should initialize with an API url to call" do
+    OneOffMessageRequest.new.url.should eql("https://secure.whatcounts.com/bin/api_web")
+  end
+  
+  it "should accept data for the message and store internally in the data hash" do
+    test_attrs = {:pwd => 'test', :list_id => 1, :realm => 'test', :format => 1, :to => 'test@test.com', :template_id => 1, :data => {:first => 'Test'}}
+    
+    message_request = OneOffMessageRequest.new
+    message_request.set_data(mock_one_off_message)
+    
+    message_request.data.should == test_attrs.merge({:cmd => 'send'}) # the 'send' command is added internallly for the API call
+  end
+  
+end

data/lib/whatcounts/spec/api_response_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include API::Base
+include API::WhatCounts
+
+describe OneOffMessageResponse do
+  include ResponseSpecHelper
+  
+  it "should initialize and determine if the result is a success" do
+    OneOffMessageResponse.new(mock_success_response).result.should eql(true)
+  end
+  
+  it "should initialize and determine if the result is a failure" do
+    OneOffMessageResponse.new(mock_failure_response).result.should eql(false)
+  end
+  
+  it "should handle and unknown result" do
+    OneOffMessageResponse.new("some unknown response that makes no sense").result.should eql(false)
+  end
+  
+  it "should store the raw_response" do
+    OneOffMessageResponse.new(mock_success_response).raw_response.should eql("SUCCESS: mail will be sent to test@example.com")
+  end
+end

data/lib/whatcounts/spec/base_spec.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+include API::Base
+include API::WhatCounts
+
+describe Service do
+  include ResponseSpecHelper
+  include RequestSpecHelper
+  
+  before(:each) do
+    @service = API::WhatCounts::Service.new
+  end
+  
+  it "should be able to handle an Exception in send_one_off_message() when calling the API" do
+    @service.stub!(:ssl_post).and_raise(Exception)
+    lambda { @service.send_one_off_message(mock_one_off_message) }.should raise_error(ServiceError)
+  end
+  
+  it "should be able to handle a successful API response" do
+    @service.stub!(:ssl_post).and_return(mock_success_response)
+    
+    @service.send_one_off_message(mock_one_off_message).should be_an_instance_of(API::WhatCounts::OneOffMessageResponse)
+    @service.api_message_response.should be_an_instance_of(API::WhatCounts::OneOffMessageResponse)
+  end
+
+  it "should be able to handle a failed API response" do
+    @service.stub!(:ssl_post).and_return(mock_failure_response)
+    
+    @service.send_one_off_message(mock_one_off_message).should be_an_instance_of(API::WhatCounts::OneOffMessageResponse)
+    @service.api_message_response.should be_an_instance_of(API::WhatCounts::OneOffMessageResponse)
+  end
+
+
+end
+
+
+describe OneOffMessage do
+  include ResponseSpecHelper
+  include RequestSpecHelper
+  
+  before(:each) do
+    @test_attrs = {:pwd => 'test', :list_id => 1, :realm => 'test', :format => 1, :to => 'test@test.com', :template_id => 1, :data => {:first => 'Test'}}
+  end
+  
+  it "should initialize with configuration values in a hash" do
+    msg = OneOffMessage.new(@test_attrs)
+    
+    msg.api_service.should be_an_instance_of(API::WhatCounts::Service)
+    msg.pwd.should eql(@test_attrs[:pwd])
+    msg.list_id.should eql(@test_attrs[:list_id])
+    msg.realm.should eql(@test_attrs[:realm])
+    msg.format.should eql(@test_attrs[:format])
+    msg.to.should eql(@test_attrs[:to])
+    msg.template_id.should eql(@test_attrs[:template_id])
+    msg.data.should eql('first^Test')
+  end
+  
+  it "should raise and exception if the requried values are not present on initialization" do
+    lambda { OneOffMessage.new }.should raise_error(ServiceError)
+  end
+  
+  it "should receive a true value back from a succesful message sent" do
+    serv = API::WhatCounts::Service.new
+    serv.stub!(:ssl_post).and_return(mock_success_response)
+    msg = OneOffMessage.new(@test_attrs)
+    msg.api_service = serv
+    
+    msg.send.should be_true
+  end
+  
+  it "should receive a false value back from a failed message sent" do
+    serv = API::WhatCounts::Service.new
+    serv.stub!(:ssl_post).and_return(mock_failure_response)
+    msg = OneOffMessage.new(@test_attrs)
+    msg.api_service = serv
+    
+    msg.send.should be_false
+  end
+  
+  it "sould receive a false value back from an error during message sending" do
+    serv = API::WhatCounts::Service.new
+    serv.stub!(:send_one_off_message).and_raise(ServiceError)
+    msg = OneOffMessage.new(@test_attrs)
+    msg.api_service = serv
+    
+    msg.send.should be_false
+  end
+  
+end

data/lib/whatcounts/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + "/../../ruby-whatcounts"
+
+module ResponseSpecHelper
+  
+  def mock_success_response
+    "SUCCESS: mail will be sent to test@example.com"
+  end
+
+  def mock_failure_response
+    "FAILURE: Something went wrong"
+  end
+  
+  def mock_invalid_password_response
+    "Password (asdf) doesn't match entry for API user credentials in database"
+  end
+  
+end
+
+module RequestSpecHelper
+  
+  def mock_one_off_message
+    test_attrs = {:pwd => 'test', :list_id => 1, :realm => 'test', :format => 1, :to => 'test@test.com', :template_id => 1, :data => {:first => 'Test'}}
+    message = mock("message", test_attrs)
+    
+    return message
+  end
+  
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: pdsphil-ruby-whatcounts
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Phil Ripperger, Kevin Weller
+autorequire: ruby-whatcounts
+bindir: bin
+cert_chain: []
+
+date: 2008-06-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This library allows you to send a message using the WhatCounts HTTP API. It uses the One-Off-Message 'send' method.
+email: pdsphil@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/ruby-whatcounts.rb
+- lib/whatcounts
+- lib/whatcounts/api.rb
+- lib/whatcounts/api_request.rb
+- lib/whatcounts/api_response.rb
+- lib/whatcounts/base.rb
+- lib/whatcounts/certs
+- lib/whatcounts/certs/cacert.pem
+- lib/whatcounts/log
+- lib/whatcounts/log/error.log
+- lib/whatcounts/spec
+- lib/whatcounts/spec/api_request_spec.rb
+- lib/whatcounts/spec/api_response_spec.rb
+- lib/whatcounts/spec/base_spec.rb
+- lib/whatcounts/spec/spec_helper.rb
+- README
+has_rdoc: true
+homepage: http://github.com/pdsphil/ruby-whatcounts
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ruby library for the WhatCounts HTTP API
+test_files: []
+