action_kit_api 0.1.11 → 0.2.1

data/features/connections/establish_a_connection.feature

@@ -0,0 +1,9 @@
+Feature: Establish a Connection
+  In order to use the ActionKitAPI
+  As a developer
+  I want to establish a connection
+
+  Scenario: Connection with valid credentials should success
+    When authenticating with valid credentials
+    Then I can get the remote API version
+

data/features/step_definitions/connection_steps.rb

@@ -0,0 +1,13 @@
+When /^authenticating with valid credentials$/ do
+  # These globals are set in the file features/support/credentials.rb you'll need
+  # to already have a valid API user with ActionKit to use these tests
+  ActionKitApi.connect(ACTIONKIT_USERNAME, ACTIONKIT_PASSWORD, ACTIONKIT_HOSTNAME)
+end
+
+Then /^I can get the remote API version$/ do
+  ActionKitApi.connection.version.should =~ /ActionKit \d\.\d\.\d+/
+end
+
+Given /^I have an active connection$/ do
+  ActionKitApi.connect(ACTIONKIT_USERNAME, ACTIONKIT_PASSWORD, ACTIONKIT_HOSTNAME)
+end

data/features/step_definitions/user_steps.rb

@@ -1,25 +1,57 @@
-When /^I create a user with the email "([^"]*)", first name "([^"]*)", last name "([^"]*)", and zipcode "([^"]*)"$/ do |email, first_name, last_name, zip|
-  attrs = {
-    :email => email,
-    :first_name => first_name,
-    :last_name => last_name,
-    :zip => :zip
-  }
-
-  @user = ActionKitApi::User.new(attrs)
+Given /^I have found an existing user$/ do
+  @user = ActionKitApi::User.find_by_email('arealaddress@ipromise.com')
+end
+
+When /^I create a user with valid attributes$/ do
+  @user = ActionKitApi::User.new({
+      "email" => "arealaddress@ipromise.com",
+      "first_name" => "Real",
+      "last_name" => "Name",
+      "zip" => "00001"
+    })
+end
+
+When /^I save the user$/ do
   @user.save
 end
 
-When /^I search for user email "([^"]*)"$/ do |email|
-  @user = ActionKitApi::User.find_by_email(email)
+When /^I create a user missing an email address$/ do
+  @user = ActionKitApi::User.new({
+      "first_name" => "Real",
+      "last_name" => "Name",
+      "zip" => "00001"
+    })
+end
+
+When /^I change their zip code$/ do
+  @new_zip = @user.zip.reverse
+  @user.zip = @new_zip
+end
+
+When /^I search for a user that doesn't exist$/ do
+  @user = ActionKitApi::User.find_by_email('thisisnteven@arealtld.lorp')
 end
 
-When /^I search for user ID "([^"]*)"$/ do |id|
-  @user = ActionKitApi::User.find_by_id(id)
+When /^I search a user that has already been created$/ do
+  @user = ActionKitApi::User.find_by_email('arealaddress@ipromise.com')
 end
 
-Then /^I should have a valid user$/ do
+Then /^I should receive a valid user$/ do
   @user.should be_valid
 end
 
+Then /^I should get an error when I save$/ do
+  lambda{ @user.save }.should raise_error
+end
+
+Then /^the user should have an ActionKit ID$/ do
+  @user.akid.should_not be_nil
+end
 
+Then /^I should receive nil$/ do
+  @user.should be_nil
+end
+
+Then /^the user should have the new zip code$/ do
+  @user.zip.should eql(@new_zip)
+end

data/features/users/create_a_user.feature

@@ -0,0 +1,15 @@
+Feature: Create a new user through the API
+  In order to track a person's actions
+  As a developer
+  I want to create a user for them
+
+  Scenario: Create a valid user
+    Given I have an active connection
+    When I create a user with valid attributes
+    And I save the user
+    Then the user should have an ActionKit ID
+
+  Scenario: Create an invalid user
+    Given I have an active connection
+    When I create a user missing an email address
+    Then I should get an error when I save

data/features/users/find_a_user.feature

@@ -0,0 +1,14 @@
+Feature: Find a user by email address
+  In order to act on people we already know about
+  As a developer
+  I should be able to find a user using their email address
+
+  Scenario: Find an existing user
+    Given I have an active connection
+    When I search a user that has already been created
+    Then I should receive a valid user
+
+  Scenario: Find a non-existant user
+    Given I have an active connection
+    When I search for a user that doesn't exist
+    Then I should receive nil

data/features/users/update_a_user.feature

@@ -0,0 +1,11 @@
+Feature: Update a user's information in ActionKit
+  In order to keep user's information up to date
+  As a developer
+  I should be able to make persistant changes to a user's instance
+
+  Scenario: Update a user's zip code
+    Given I have an active connection
+    And I have found an existing user
+    When I change their zip code
+    And I save the user
+    Then the user should have the new zip code

data/lib/action_kit_api.rb

@@ -16,6 +16,8 @@ require "action_kit_api/page_types/unsubscribe"
 require "action_kit_api/page_types/import"
 
 module ActionKitApi
+  @@connection = nil
+
   # Takes a page object and a user object and a hash of any additional
   # attributes and records the action. Will return a Action object with
   # status information and unique identifiers
@@ -32,8 +34,18 @@ module ActionKitApi
       "akid" => user.akid,
     })
 
-    response = ActionKitApi::Connection.call('act', act_attrs)
+    @@connection.call('act', act_attrs)
 
     ActionKitApi::Action.new(response)
   end
+
+  # Takes username, password, and hostname. This is simply a wrapper to
+  # ActionKitAPi::Connection.connect to make the gem a bit easier to use
+  def self.connect(username, password, hostname)
+    @@connection = ActionKitApi::Connection.new(username, password, hostname)
+  end
+
+  def self.connection
+    @@connection
+  end
 end

data/lib/action_kit_api/connection.rb

@@ -1,11 +1,11 @@
 require 'xmlrpc/client'
 
-module XMLRPC
-  # This file adds the connection information for the ActionKit API
-  # which is used throughout the rest of the Gem (a connection being
-  # required for ... well every operation ... this is a remote API
-  # gem :)
+# This file adds the connection information for the ActionKit API
+# which is used throughout the rest of the Gem (a connection being
+# required for ... well every operation ... this is a remote API
+# gem :)
 
+module XMLRPC
   # This seems silly and dangerous right? Overwriting something in the ruby
   # standard libraries? Well ActionKit is doing XMLRPC wrong. This is almost
   # identical to the Ruby standard library version however it drops the type
@@ -36,22 +36,18 @@ module XMLRPC
     remove_const(:USER_AGENT)
     USER_AGENT = "DFA Ruby action_kit_api/#{ActionKitApi::VERSION} ( http://code.democracyforamerica.com/ )"
   end
-end
 
-module ActionKitApi
-  class NoConnection < Exception
-    # Nothing special, will be raised in the event something
-    # trys to use a connection and one doesn't exist
+  # This was need to prevent empty responses from the remote
+  # server from triggering an exception on calls
+  module Config
+    remove_const(:ENABLE_NIL_PARSER)
+    ENABLE_NIL_PARSER = true
   end
+end
 
+module ActionKitApi
   class Connection
-    # This was need to prevent empty responses from the remote
-    # server from triggering an exception on calls
-    XMLRPC::Config::ENABLE_NIL_PARSER = true
-
-    @@connection = nil
-    
-    def self.connect(user, password, host)
+    def initialize(user, password, host)
       # Build the arguments for the XMLRPC::Client object
       conn_args = {
           :user => user,
@@ -61,29 +57,28 @@ module ActionKitApi
           :path => "/api"
         }
 
-      @@connection = XMLRPC::Client.new_from_hash(conn_args)
+      @connection = XMLRPC::Client.new_from_hash(conn_args)
 
       # Unfortunately XMLRPC::Client does not expose it's SSL settings so
       # we need to dive into it's instance methods to set SSL verification
       # and add a CA to authenticate against
-      @@connection.instance_variable_get("@http").verify_mode = OpenSSL::SSL::VERIFY_PEER
-      @@connection.instance_variable_get("@http").ca_file = File.join(File.dirname(__FILE__), "actionkit_ca_chain.pem")
+      @connection.instance_variable_get("@http").verify_mode = OpenSSL::SSL::VERIFY_PEER
+      @connection.instance_variable_get("@http").ca_file = File.join(File.dirname(__FILE__), "actionkit_ca_chain.pem")
 
       return nil
     end
 
-    def self.call(command, args)
-      raise NoConnection if @@connection.nil?
-
+    def call(command, args)
       # XMLRPC::Client doesn't flush it's IO buffer which occasionally
       # causes a second command on the same connection to fail with an
       # EOFError. Using the _async version of this causes XMLRPC::Client
       # to use a new connection each time eliminating this issue
-      @@connection.call_async(command, args)
+      @connection.call_async(command, args)
     end
 
-    def self.version
-      self.call("version")
+    def version
+      self.call("version", {})
     end
+
   end
 end

data/lib/action_kit_api/data_model.rb

@@ -18,9 +18,12 @@ module ActionKitApi
 
       # TODO: Add blacklisting to the model to prevent read-only attributes from syncing
       # this is a temporary fix.
-      hash = self.to_hash
-      hash.delete("subscription_status")
-      response = ActionKitApi::Connection.call("#{class_name}.save_or_create", hash)
+      attrs_hash = self.to_hash
+      attrs_hash.delete_if do |k, v| 
+        k == :subscription_status
+      end
+
+      response = ActionKitApi.connection.call("#{class_name}.save_or_create", attrs_hash)
 
       # Update ourselves to include the data that the server populated 
       self.update(response)
@@ -62,7 +65,7 @@ module ActionKitApi
 
       # XMLRPC::Client doesn't like empty values
       user_hash.delete_if do |k, v|
-        v.to_s.empty?
+        v.to_s.empty? || v.nil?
       end
 
       user_hash

data/lib/action_kit_api/searchable.rb

@@ -25,7 +25,7 @@ module ActionKitApi
         search = self.parse_attributes(attrs, args)
 
         begin
-          response = ActionKitApi::Connection.call("#{class_name}.get", search)
+          response = ActionKitApi.connection.call("#{class_name}.get", search)
         rescue XMLRPC::FaultException => exception
           if exception.faultCode == "DoesNotExist"
             return nil
@@ -56,7 +56,7 @@ module ActionKitApi
         search["limit"] = 1000
         #search["offset"] = 0
 
-        response = ActionKitApi::Connection.call("#{class_name}.get", search)
+        response = ActionKitApi.connection.call("#{class_name}.get", search)
 
         response_objects = []
         response.each do |obj|
@@ -67,7 +67,7 @@ module ActionKitApi
       end
 
       #def class_name.count(search)
-      #  ActionKitApi::Connection.call("#{class_name}.count", search)
+      #  ActionKitApi.connection.call("#{class_name}.count", search)
       #end
 
       # Helper method for method_missing and the find_* virtual methods that

data/lib/action_kit_api/version.rb

@@ -1,3 +1,3 @@
 module ActionKitApi
-  VERSION = "0.1.11"
+  VERSION = "0.2.1"
 end

data/spec/connection/connection_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ActionKitApi::Connection do
+  
+  it "should raise an error when there is no connection" do
+    lambda { ActionKitApi.connection.version }.should raise_error
+  end
+
+  it "should use asynchronous calls on the remote API" do
+    pending
+  end
+
+end

data/spec/spec_helper.rb

@@ -3,8 +3,19 @@ require 'action_kit_api'
 require 'features/support/credentials'
 
 RSpec.configure do |config|
-  config.filter_run_excluding :certificates => true, :remote => true
-
   config.color_enabled    = true
   config.formatter        = 'documentation'
 end
+
+# This was taken from Rails master commit 1eecd94, it's so useful for testing and
+# I was so sad to find it was not a part of the Ruby native Hash implementation
+class Hash
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end

data/spec/user/user_model_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module AKAUserSpecHelper
+  def validUserAttributes
+    {
+      :email => "tuser@example.org",
+      :first_name => "Test",
+      :last_name => "User",
+      :zip => "00001"
+    }
+  end
+end
+
+describe ActionKitApi::User do
+  include AKAUserSpecHelper
+
+  before(:each) do
+    @user = ActionKitApi::User.new
+  end
+
+  it "should verify that an email is required" do
+    @user.update(validUserAttributes.except(:email))
+    @user.should_not be_valid
+  end
+
+  it "should verify that a zip is required" do
+    @user.update(validUserAttributes.except(:zip))
+    @user.should_not be_valid
+  end
+
+  it "should verify that first_name is required" do
+    @user.update(validUserAttributes.except(:first_name))
+    @user.should_not be_valid
+  end
+
+  it "should verify that last_name is required" do
+    @user.update(validUserAttributes.except(:last_name))
+    @user.should_not be_valid
+  end
+
+  it "should not allow arbitrary attributes to be added" do
+    @user.update({"fake_attr" => "with some data"})
+    user_hash = @user.to_hash
+
+    user_hash.should_not include("fake_attr")
+  end
+
+  it "should return it's attributes as a hash" do
+    @user.update(validUserAttributes)
+    user_hash = @user.to_hash
+
+    user_hash.should eql(validUserAttributes)
+  end
+
+  it "should not try to save subscription_status" do
+    pending
+  end
+
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 2
   - 1
-  - 11
-  version: 0.1.11
+  version: 0.2.1
 platform: ruby
 authors: 
 - Sam Stelfox
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-27 00:00:00 -05:00
+date: 2012-03-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,13 +58,13 @@ files:
 - README.md
 - Rakefile
 - action_kit_api.gemspec
-- features/create_a_user.feature
-- features/find_a_page.feature
-- features/find_a_user.feature
-- features/step_definitions/general_api_steps.rb
-- features/step_definitions/page_steps.rb
+- features/connections/establish_a_connection.feature
+- features/step_definitions/connection_steps.rb
 - features/step_definitions/user_steps.rb
 - features/support/env.rb
+- features/users/create_a_user.feature
+- features/users/find_a_user.feature
+- features/users/update_a_user.feature
 - lib/action_kit_api.rb
 - lib/action_kit_api/action.rb
 - lib/action_kit_api/actionkit_ca_chain.pem
@@ -78,9 +78,10 @@ files:
 - lib/action_kit_api/searchable.rb
 - lib/action_kit_api/user.rb
 - lib/action_kit_api/version.rb
-- spec/connections/action_kit_api_connection_spec.rb
+- spec/connection/connection_spec.rb
 - spec/remote_certificates_spec.rb
 - spec/spec_helper.rb
+- spec/user/user_model_spec.rb
 has_rdoc: true
 homepage: http://code.democracyforamerica.com/
 licenses: 
@@ -112,13 +113,14 @@ signing_key:
 specification_version: 3
 summary: Wrapper for the ActionKit API
 test_files: 
-- features/create_a_user.feature
-- features/find_a_page.feature
-- features/find_a_user.feature
-- features/step_definitions/general_api_steps.rb
-- features/step_definitions/page_steps.rb
+- features/connections/establish_a_connection.feature
+- features/step_definitions/connection_steps.rb
 - features/step_definitions/user_steps.rb
 - features/support/env.rb
-- spec/connections/action_kit_api_connection_spec.rb
+- features/users/create_a_user.feature
+- features/users/find_a_user.feature
+- features/users/update_a_user.feature
+- spec/connection/connection_spec.rb
 - spec/remote_certificates_spec.rb
 - spec/spec_helper.rb
+- spec/user/user_model_spec.rb

data/features/create_a_user.feature

@@ -1,11 +0,0 @@
-Feature: Create a user
-  In order to add a user to a mailing lists
-  As a developer
-  I should be able to create a user through the API
-
-  Scenario: Create a user
-    Given I have instantiated the API
-    When I create a user with the email "tuser@example.org", first name "Test", last name "User", and zipcode "12345"
-    And I search for user email "tuser@example.org"
-    Then I should have a valid user
-

data/features/find_a_page.feature

@@ -1,14 +0,0 @@
-Feature: Find a page
-  In order to act on page
-  As a developer
-  I should be able to find a page
-
-  Scenario: Find a page by name
-    Given I have instantiated the API
-    When I search for page name "jstreetdonation"
-    Then I should have a valid page
-
-  Scenario: Find a page by id
-    Given I have instantiated the API
-    When I search for page ID "1"
-    Then I should have a valid page

data/features/find_a_user.feature

@@ -1,15 +0,0 @@
-Feature: Find a user
-  In order to update a user
-  As a developer
-  I should be able to find a user
-
-  Scenario: Find a user by email
-    Given I have instantiated the API
-    When I search for user email "tuser@example.org"
-    Then I should have a valid user
-
-  Scenario: Find a user by ID
-    Given I have instantiated the API
-    When I search for user ID "39221"
-    Then I should have a valid user
-

data/features/step_definitions/general_api_steps.rb

@@ -1,6 +0,0 @@
-Given /^I have instantiated the API$/ do
-  # Uses information provided in credential file to setup the API's connection
-  ActionKitApi::Connection.connect(ACTIONKIT_USERNAME,
-      ACTIONKIT_PASSWORD, ACTIONKIT_HOSTNAME)
-end
-

data/features/step_definitions/page_steps.rb

@@ -1,11 +0,0 @@
-When /^I search for page name "([^"]*)"$/ do |name|
-  @page = ActionKitApi::Page.find_by_name(name)
-end
-
-When /^I search for page ID "([^"]*)"$/ do |id|
-  @page = ActionKitApi::Page.find_by_id(id)
-end
-
-Then /^I should have a valid page$/ do
-  @page.should be_valid
-end

data/spec/connections/action_kit_api_connection_spec.rb

@@ -1,24 +0,0 @@
-require "spec_helper.rb"
-
-describe "ActionKitApi Connection" do
-  it "should be able to create a new connection" do
-    ActionKitApi::Connection.connect('testuser', 'testpass',
-                'host.example.local')
-  end
-
-  describe "Tests That Need a Connection", :remote => true do
-    before(:all) do
-      ActionKitApi::Connection.connect(ACTIONKIT_USERNAME,
-                ACTIONKIT_PASSWORD, ACTIONKIT_HOSTNAME)
-    end
-
-    it "should be able to ask ActionKit for the version of it's API" do
-      ActionKitApi::Connection.version.should =~ /ActionKit \d\.\d\.\d+/
-    end
-
-    it "should be able to make arbitrary calls to the remote API" do
-      ActionKitApi::Connection.call("version").should =~ /ActionKit \d\.\d\.\d+/
-    end
-  end
-end
-