action_kit_api 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+credentials.rb

data/.rvmrc

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+environment_id="ruby-1.8.7-p357@actionkitapi"
+
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]; then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]; then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  if ! rvm --create  "$environment_id"; then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+if [[ $- == *i* ]]; then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)"a
+else 
+	echo "Using: $GEM_HOME"
+fi
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Democracy For America
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+## Post-clone Instructions
+To use the spec and cucumber feature tests you need to have valid ActionKit
+API credentials. These credentials need to be places in the file
+/features/support/credentials.rb for RSpec and Cucumber to call. These calls
+will create test users, and eventually pages, sign users up for things and
+otherwise affect potentially live data.
+
+***Please be aware of what the tests are doing before running them.***
+
+Now that you've read the warning this is what the contents of the credentials
+file should look like.
+
+    # These are credentials that need to be set for testing against
+    # live ActionKit. These will never live in the repository
+
+    ACTIONKIT_HOSTNAME=""
+    ACTIONKIT_USERNAME=""
+    ACTIONKIT_PASSWORD=""

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/action_kit_api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "action_kit_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "action_kit_api"
+  s.version     = ActionKitApi::VERSION
+  s.authors     = ["Sam Stelfox"]
+  s.email       = ["sstelfox@democracyforamerica.com"]
+  s.homepage    = "http://democracyforamerica.com/"
+  s.license     = "MIT"
+
+  s.summary     = "Wrapper for the ActionKit API"
+  s.description = "Provides encapsulated object access through the ActionKit API"
+
+  s.rubyforge_project = "action_kit_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "cucumber"
+end

data/features/create_a_user.feature

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,11 @@
+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/features/step_definitions/user_steps.rb

@@ -0,0 +1,25 @@
+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)
+  @user.save
+end
+
+When /^I search for user email "([^"]*)"$/ do |email|
+  @user = ActionKitApi::User.find_by_email(email)
+end
+
+When /^I search for user ID "([^"]*)"$/ do |id|
+  @user = ActionKitApi::User.find_by_id(id)
+end
+
+Then /^I should have a valid user$/ do
+  @user.should be_valid
+end
+
+

data/features/support/env.rb

@@ -0,0 +1,3 @@
+$:.push File.expand_path("../../../lib", __FILE__)
+require "action_kit_api"
+

data/lib/action_kit_api.rb

@@ -0,0 +1,14 @@
+# These are the primary portions of the API wrapper runtime
+require "action_kit_api/connection"
+require "action_kit_api/searchable"
+require "action_kit_api/data_model"
+
+# Extensions to the data model for specific information
+require "action_kit_api/user"
+require "action_kit_api/page"
+
+# Page types
+require "action_kit_api/page_types/petition"
+require "action_kit_api/page_types/signup"
+require "action_kit_api/page_types/unsubscribe"
+require "action_kit_api/page_types/import"

data/lib/action_kit_api/action.rb

@@ -0,0 +1,41 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class Action < ApiDataModel
+    include Searchable
+
+    # Required
+    attr_accessor :id, :page, :user
+
+    # Other/Active
+    attr_accessor :created_at, :created_user, :custom_fields, :link, :mailing,
+                  :opq_id, :referring_mailing, :referring_user, :source, :status,
+                  :subscribed_user, :taf_emails_sent, :updated_at
+
+    def initialize(*args)
+      @required_attrs = [:page, :user]
+      super
+    end
+
+    # 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
+    def act(page, user, args = {})
+      return false unless page.valid? and user.valid?
+
+      # Ensure we have an ActionKit ID before performing the action
+      user.save if user.akid.nil?
+
+      # Include the supplied arguments overiding akid and page name if they
+      # were supplied with those in the page and user
+      act_attrs = args.update({
+        "page" => page.name,
+        "akid" => user.akid,
+      })
+
+      response = ActionKitApi::Connection.call('act', act_attrs)
+
+      self.new(response)
+    end
+  end
+end

data/lib/action_kit_api/actionkit_ca_chain.pem

@@ -0,0 +1,167 @@
+Certificate:
+    Data:
+        Version: 3 (0x2)
+        Serial Number: 145105 (0x236d1)
+        Signature Algorithm: sha1WithRSAEncryption
+        Issuer: C=US, O=GeoTrust Inc., CN=GeoTrust Global CA
+        Validity
+            Not Before: Feb 19 22:45:05 2010 GMT
+            Not After : Feb 18 22:45:05 2020 GMT
+        Subject: C=US, O=GeoTrust, Inc., CN=RapidSSL CA
+        Subject Public Key Info:
+            Public Key Algorithm: rsaEncryption
+                Public-Key: (2048 bit)
+                Modulus:
+                    00:c7:71:f8:56:c7:1e:d9:cc:b5:ad:f6:b4:97:a3:
+                    fb:a1:e6:0b:50:5f:50:aa:3a:da:0f:fc:3d:29:24:
+                    43:c6:10:29:c1:fc:55:40:72:ee:bd:ea:df:9f:b6:
+                    41:f4:48:4b:c8:6e:fe:4f:57:12:8b:5b:fa:92:dd:
+                    5e:e8:ad:f3:f0:1b:b1:7b:4d:fb:cf:fd:d1:e5:f8:
+                    e3:dc:e7:f5:73:7f:df:01:49:cf:8c:56:c1:bd:37:
+                    e3:5b:be:b5:4f:8b:8b:f0:da:4f:c7:e3:dd:55:47:
+                    69:df:f2:5b:7b:07:4f:3d:e5:ac:21:c1:c8:1d:7a:
+                    e8:e7:f6:0f:a1:aa:f5:6f:de:a8:65:4f:10:89:9c:
+                    03:f3:89:7a:a5:5e:01:72:33:ed:a9:e9:5a:1e:79:
+                    f3:87:c8:df:c8:c5:fc:37:c8:9a:9a:d7:b8:76:cc:
+                    b0:3e:e7:fd:e6:54:ea:df:5f:52:41:78:59:57:ad:
+                    f1:12:d6:7f:bc:d5:9f:70:d3:05:6c:fa:a3:7d:67:
+                    58:dd:26:62:1d:31:92:0c:79:79:1c:8e:cf:ca:7b:
+                    c1:66:af:a8:74:48:fb:8e:82:c2:9e:2c:99:5c:7b:
+                    2d:5d:9b:bc:5b:57:9e:7c:3a:7a:13:ad:f2:a3:18:
+                    5b:2b:59:0f:cd:5c:3a:eb:68:33:c6:28:1d:82:d1:
+                    50:8b
+                Exponent: 65537 (0x10001)
+        X509v3 extensions:
+            X509v3 Key Usage: critical
+                Certificate Sign, CRL Sign
+            X509v3 Subject Key Identifier: 
+                6B:69:3D:6A:18:42:4A:DD:8F:02:65:39:FD:35:24:86:78:91:16:30
+            X509v3 Authority Key Identifier: 
+                keyid:C0:7A:98:68:8D:89:FB:AB:05:64:0C:11:7D:AA:7D:65:B8:CA:CC:4E
+
+            X509v3 Basic Constraints: critical
+                CA:TRUE, pathlen:0
+            X509v3 CRL Distribution Points: 
+
+                Full Name:
+                  URI:http://crl.geotrust.com/crls/gtglobal.crl
+
+            Authority Information Access: 
+                OCSP - URI:http://ocsp.geotrust.com
+
+    Signature Algorithm: sha1WithRSAEncryption
+        ab:bc:bc:0a:5d:18:94:e3:c1:b1:c3:a8:4c:55:d6:be:b4:98:
+        f1:ee:3c:1c:cd:cf:f3:24:24:5c:96:03:27:58:fc:36:ae:a2:
+        2f:8f:f1:fe:da:2b:02:c3:33:bd:c8:dd:48:22:2b:60:0f:a5:
+        03:10:fd:77:f8:d0:ed:96:67:4f:fd:ea:47:20:70:54:dc:a9:
+        0c:55:7e:e1:96:25:8a:d9:b5:da:57:4a:be:8d:8e:49:43:63:
+        a5:6c:4e:27:87:25:eb:5b:6d:fe:a2:7f:38:28:e0:36:ab:ad:
+        39:a5:a5:62:c4:b7:5c:58:2c:aa:5d:01:60:a6:62:67:a3:c0:
+        c7:62:23:f4:e7:6c:46:ee:b5:d3:80:6a:22:13:d2:2d:3f:74:
+        4f:ea:af:8c:5f:b4:38:9c:db:ae:ce:af:84:1e:a6:f6:34:51:
+        59:79:d3:e3:75:dc:bc:d7:f3:73:df:92:ec:d2:20:59:6f:9c:
+        fb:95:f8:92:76:18:0a:7c:0f:2c:a6:ca:de:8a:62:7b:d8:f3:
+        ce:5f:68:bd:8f:3e:c1:74:bb:15:72:3a:16:83:a9:0b:e6:4d:
+        99:9c:d8:57:ec:a8:01:51:c7:6f:57:34:5e:ab:4a:2c:42:f6:
+        4f:1c:89:78:de:26:4e:f5:6f:93:4c:15:6b:27:56:4d:00:54:
+        6c:7a:b7:b7
+-----BEGIN CERTIFICATE-----
+MIID1TCCAr2gAwIBAgIDAjbRMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT
+MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i
+YWwgQ0EwHhcNMTAwMjE5MjI0NTA1WhcNMjAwMjE4MjI0NTA1WjA8MQswCQYDVQQG
+EwJVUzEXMBUGA1UEChMOR2VvVHJ1c3QsIEluYy4xFDASBgNVBAMTC1JhcGlkU1NM
+IENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx3H4Vsce2cy1rfa0
+l6P7oeYLUF9QqjraD/w9KSRDxhApwfxVQHLuverfn7ZB9EhLyG7+T1cSi1v6kt1e
+6K3z8Buxe037z/3R5fjj3Of1c3/fAUnPjFbBvTfjW761T4uL8NpPx+PdVUdp3/Jb
+ewdPPeWsIcHIHXro5/YPoar1b96oZU8QiZwD84l6pV4BcjPtqelaHnnzh8jfyMX8
+N8iamte4dsywPuf95lTq319SQXhZV63xEtZ/vNWfcNMFbPqjfWdY3SZiHTGSDHl5
+HI7PynvBZq+odEj7joLCniyZXHstXZu8W1eefDp6E63yoxhbK1kPzVw662gzxigd
+gtFQiwIDAQABo4HZMIHWMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUa2k9ahhC
+St2PAmU5/TUkhniRFjAwHwYDVR0jBBgwFoAUwHqYaI2J+6sFZAwRfap9ZbjKzE4w
+EgYDVR0TAQH/BAgwBgEB/wIBADA6BgNVHR8EMzAxMC+gLaArhilodHRwOi8vY3Js
+Lmdlb3RydXN0LmNvbS9jcmxzL2d0Z2xvYmFsLmNybDA0BggrBgEFBQcBAQQoMCYw
+JAYIKwYBBQUHMAGGGGh0dHA6Ly9vY3NwLmdlb3RydXN0LmNvbTANBgkqhkiG9w0B
+AQUFAAOCAQEAq7y8Cl0YlOPBscOoTFXWvrSY8e48HM3P8yQkXJYDJ1j8Nq6iL4/x
+/torAsMzvcjdSCIrYA+lAxD9d/jQ7ZZnT/3qRyBwVNypDFV+4ZYlitm12ldKvo2O
+SUNjpWxOJ4cl61tt/qJ/OCjgNqutOaWlYsS3XFgsql0BYKZiZ6PAx2Ij9OdsRu61
+04BqIhPSLT90T+qvjF+0OJzbrs6vhB6m9jRRWXnT43XcvNfzc9+S7NIgWW+c+5X4
+knYYCnwPLKbK3opie9jzzl9ovY8+wXS7FXI6FoOpC+ZNmZzYV+yoAVHHb1c0XqtK
+LEL2TxyJeN4mTvVvk0wVaydWTQBUbHq3tw==
+-----END CERTIFICATE-----
+Certificate:
+    Data:
+        Version: 3 (0x2)
+        Serial Number: 144470 (0x23456)
+        Signature Algorithm: sha1WithRSAEncryption
+        Issuer: C=US, O=GeoTrust Inc., CN=GeoTrust Global CA
+        Validity
+            Not Before: May 21 04:00:00 2002 GMT
+            Not After : May 21 04:00:00 2022 GMT
+        Subject: C=US, O=GeoTrust Inc., CN=GeoTrust Global CA
+        Subject Public Key Info:
+            Public Key Algorithm: rsaEncryption
+                Public-Key: (2048 bit)
+                Modulus:
+                    00:da:cc:18:63:30:fd:f4:17:23:1a:56:7e:5b:df:
+                    3c:6c:38:e4:71:b7:78:91:d4:bc:a1:d8:4c:f8:a8:
+                    43:b6:03:e9:4d:21:07:08:88:da:58:2f:66:39:29:
+                    bd:05:78:8b:9d:38:e8:05:b7:6a:7e:71:a4:e6:c4:
+                    60:a6:b0:ef:80:e4:89:28:0f:9e:25:d6:ed:83:f3:
+                    ad:a6:91:c7:98:c9:42:18:35:14:9d:ad:98:46:92:
+                    2e:4f:ca:f1:87:43:c1:16:95:57:2d:50:ef:89:2d:
+                    80:7a:57:ad:f2:ee:5f:6b:d2:00:8d:b9:14:f8:14:
+                    15:35:d9:c0:46:a3:7b:72:c8:91:bf:c9:55:2b:cd:
+                    d0:97:3e:9c:26:64:cc:df:ce:83:19:71:ca:4e:e6:
+                    d4:d5:7b:a9:19:cd:55:de:c8:ec:d2:5e:38:53:e5:
+                    5c:4f:8c:2d:fe:50:23:36:fc:66:e6:cb:8e:a4:39:
+                    19:00:b7:95:02:39:91:0b:0e:fe:38:2e:d1:1d:05:
+                    9a:f6:4d:3e:6f:0f:07:1d:af:2c:1e:8f:60:39:e2:
+                    fa:36:53:13:39:d4:5e:26:2b:db:3d:a8:14:bd:32:
+                    eb:18:03:28:52:04:71:e5:ab:33:3d:e1:38:bb:07:
+                    36:84:62:9c:79:ea:16:30:f4:5f:c0:2b:e8:71:6b:
+                    e4:f9
+                Exponent: 65537 (0x10001)
+        X509v3 extensions:
+            X509v3 Basic Constraints: critical
+                CA:TRUE
+            X509v3 Subject Key Identifier: 
+                C0:7A:98:68:8D:89:FB:AB:05:64:0C:11:7D:AA:7D:65:B8:CA:CC:4E
+            X509v3 Authority Key Identifier: 
+                keyid:C0:7A:98:68:8D:89:FB:AB:05:64:0C:11:7D:AA:7D:65:B8:CA:CC:4E
+
+    Signature Algorithm: sha1WithRSAEncryption
+        35:e3:29:6a:e5:2f:5d:54:8e:29:50:94:9f:99:1a:14:e4:8f:
+        78:2a:62:94:a2:27:67:9e:d0:cf:1a:5e:47:e9:c1:b2:a4:cf:
+        dd:41:1a:05:4e:9b:4b:ee:4a:6f:55:52:b3:24:a1:37:0a:eb:
+        64:76:2a:2e:2c:f3:fd:3b:75:90:bf:fa:71:d8:c7:3d:37:d2:
+        b5:05:95:62:b9:a6:de:89:3d:36:7b:38:77:48:97:ac:a6:20:
+        8f:2e:a6:c9:0c:c2:b2:99:45:00:c7:ce:11:51:22:22:e0:a5:
+        ea:b6:15:48:09:64:ea:5e:4f:74:f7:05:3e:c7:8a:52:0c:db:
+        15:b4:bd:6d:9b:e5:c6:b1:54:68:a9:e3:69:90:b6:9a:a5:0f:
+        b8:b9:3f:20:7d:ae:4a:b5:b8:9c:e4:1d:b6:ab:e6:94:a5:c1:
+        c7:83:ad:db:f5:27:87:0e:04:6c:d5:ff:dd:a0:5d:ed:87:52:
+        b7:2b:15:02:ae:39:a6:6a:74:e9:da:c4:e7:bc:4d:34:1e:a9:
+        5c:4d:33:5f:92:09:2f:88:66:5d:77:97:c7:1d:76:13:a9:d5:
+        e5:f1:16:09:11:35:d5:ac:db:24:71:70:2c:98:56:0b:d9:17:
+        b4:d1:e3:51:2b:5e:75:e8:d5:d0:dc:4f:34:ed:c2:05:66:80:
+        a1:cb:e6:33
+-----BEGIN CERTIFICATE-----
+MIIDVDCCAjygAwIBAgIDAjRWMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT
+MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i
+YWwgQ0EwHhcNMDIwNTIxMDQwMDAwWhcNMjIwNTIxMDQwMDAwWjBCMQswCQYDVQQG
+EwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEbMBkGA1UEAxMSR2VvVHJ1c3Qg
+R2xvYmFsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2swYYzD9
+9BcjGlZ+W988bDjkcbd4kdS8odhM+KhDtgPpTSEHCIjaWC9mOSm9BXiLnTjoBbdq
+fnGk5sRgprDvgOSJKA+eJdbtg/OtppHHmMlCGDUUna2YRpIuT8rxh0PBFpVXLVDv
+iS2Aelet8u5fa9IAjbkU+BQVNdnARqN7csiRv8lVK83Qlz6cJmTM386DGXHKTubU
+1XupGc1V3sjs0l44U+VcT4wt/lAjNvxm5suOpDkZALeVAjmRCw7+OC7RHQWa9k0+
+bw8HHa8sHo9gOeL6NlMTOdReJivbPagUvTLrGAMoUgRx5aszPeE4uwc2hGKceeoW
+MPRfwCvocWvk+QIDAQABo1MwUTAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTA
+ephojYn7qwVkDBF9qn1luMrMTjAfBgNVHSMEGDAWgBTAephojYn7qwVkDBF9qn1l
+uMrMTjANBgkqhkiG9w0BAQUFAAOCAQEANeMpauUvXVSOKVCUn5kaFOSPeCpilKIn
+Z57QzxpeR+nBsqTP3UEaBU6bS+5Kb1VSsyShNwrrZHYqLizz/Tt1kL/6cdjHPTfS
+tQWVYrmm3ok9Nns4d0iXrKYgjy6myQzCsplFAMfOEVEiIuCl6rYVSAlk6l5PdPcF
+PseKUgzbFbS9bZvlxrFUaKnjaZC2mqUPuLk/IH2uSrW4nOQdtqvmlKXBx4Ot2/Un
+hw4EbNX/3aBd7YdStysVAq45pmp06drE57xNNB6pXE0zX5IJL4hmXXeXxx12E6nV
+5fEWCRE11azbJHFwLJhWC9kXtNHjUStedejV0NxPNO3CBWaAocvmMw==
+-----END CERTIFICATE-----

data/lib/action_kit_api/connection.rb

@@ -0,0 +1,50 @@
+require 'xmlrpc/client'
+
+# 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 ActionKitApi
+  class NoConnection < Exception
+    # Nothing special, will be raised in the event something
+    # trys to use a connection and one doesn't exist
+  end
+
+  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)
+      # Build the arguments for the XMLRPC::Client object
+      conn_args = {
+          :user => user,
+          :password => password,
+          :host => host,
+          :use_ssl => true,
+          :path => "/api"
+        }
+
+      @@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")
+    end
+
+    def self.call(command, args = {})
+      raise NoConnection if @@connection.nil?
+      
+      @@connection.call(command, args)
+    end
+
+    def self.version
+      self.call("version")
+    end
+  end
+end

data/lib/action_kit_api/data_model.rb

@@ -0,0 +1,64 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class MissingRequiredAttributeException < Exception
+  end
+
+  class ApiDataModel
+
+    def initialize(hash = {})
+      @required_attrs = []
+
+      self.update(hash)
+    end
+    
+    def save
+      class_name = self.class.to_s.split("::").last
+
+      raise MissingRequiredAttributeException "Unable to save incomplete object" unless self.valid?
+
+      response = ActionKitApi::Connection.call("#{class_name}.save_or_create", self.to_hash)
+
+      # Update ourselves to include the data that the server populated 
+      self.update(response)
+    end
+
+    # Updates all the instance variables in our local object with
+    # the values in the hash. This will selectively update only the
+    # keys in the hash that is passed, and will not update/add non-existant
+    # attributes
+    def update(hash = {})
+      hash.each do |k,v|
+        # The name of the setter for the value of k
+        setter = "#{k}="
+
+        # Check if there is a matching setter
+        if self.respond_to?(setter)
+          # Yes, there is. Call the setter with the value
+          self.send(setter, v)
+        end
+      end
+    end
+
+    def valid?
+      @required_attrs.each do |k|
+        return false if self.send(k).nil?
+      end
+
+      true
+    end
+
+    def to_hash
+      user_hash = {}
+
+      self.instance_variables.each do |iv|
+        key = iv.delete("@").to_sym
+        next if key == :required_attrs
+        user_hash[key] = self.instance_variable_get(iv)
+      end
+
+      user_hash
+    end
+  end 
+end
+

data/lib/action_kit_api/page.rb

@@ -0,0 +1,24 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  # Please note that this class should almost never be directly called
+  # every 'real' page is a specific sub-page type that should extend this
+  # class. Please refer to the ActionKit API documentation for more
+  # information about pages
+  class Page < ApiDataModel
+    include Searchable
+
+    # Required
+    attr_accessor :id, :name, :title
+    attr_reader :type   # Page type can't change
+
+    # Other/Active
+    attr_accessor :goal, :goal_type, :lang, :list, :required_fields,
+                  :status, :tags, :url
+
+    def initialize(*args)
+      @required_attrs = [:name, :title, :type]
+      super
+    end
+  end
+end

data/lib/action_kit_api/page_types/import.rb

@@ -0,0 +1,14 @@
+#require 'action_kit_api'
+
+# This page is a bit more complicated and might be the one that we want
+# unfotunately, I need to read through ActionKitApi's "Importing User Data"
+# notes before implementing this page type
+
+#module ActionKitApi
+#  class ImportPage < Page
+#    def initialize(*args)
+#      @type = 'import'
+#      super
+#    end
+#  end
+#end

data/lib/action_kit_api/page_types/petition.rb

@@ -0,0 +1,10 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class PetitionPage < Page
+    def initialize(*args)
+      @type = 'petition'
+      super
+    end
+  end
+end

data/lib/action_kit_api/page_types/signup.rb

@@ -0,0 +1,10 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class SignupPage < Page
+    def initialize(*args)
+      @type = 'signup'
+      super
+    end
+  end
+end

data/lib/action_kit_api/page_types/unsubscribe.rb

@@ -0,0 +1,10 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class UnsubscribePage < Page
+    def initialize(*args)
+      @type = 'unsubscribe'
+      super
+    end
+  end
+end

data/lib/action_kit_api/searchable.rb

@@ -0,0 +1,84 @@
+module ActionKitApi
+  module Searchable
+    # This layer is needed to have the methods added at a class level
+    # rather than an instance level
+    def self.included(class_name)
+
+      # Override's method missing to dynamically add find_by_* and
+      # find_all_by_*.
+      def class_name.method_missing(method, *args, &block)
+        case method.to_s
+          when /^find_by_(.+)$/
+            run_find_by_method($1, *args)
+          when /^find_all_by_(.+)$/
+            run_find_all_by_method($1, *args, &block)
+        else
+          super
+        end
+      end
+
+      # Perform an API search for an individual object
+      def class_name.run_find_by_method(attrs, *args)
+        # Get the name of the class that this module has been mixed into
+        class_name = self.to_s.split("::").last
+
+        search = parse_attributes(attrs, args)
+        response = ActionKitApi::Connection.call("#{class_name}.get", search)
+
+        # Build a new object with the response, this might be an empty
+        # object if the search failed or was invalid
+        self.new(response)
+      end
+
+      # Perform an API search for all objects that match the criteria, remote
+      # API limit is 1000 results per request so this is added explicitely to
+      # the call to prevent errors, in the future this request probably could
+      # be paginated in a loop and using count to get all of the results that
+      # match.
+      def class_name.run_find_all_by_method(attrs, *args, &block)
+        # Get the name of the class that this module has been mixed into
+        class_name = self.to_s.split("::").last
+
+        search = parse_attributes(attrs, args)
+        
+        # For when I get to retrieving all results, through pagination
+        # Would be a good candidate for yielding (probably in batches of 50-100)
+        #response_count = ActionKitApi::Connection.call("#{class_name}.count", search)
+        search["limit"] = 1000
+        #search["offset"] = 0
+
+        response = ActionKitApi::Connection.call("#{class_name}.get", search)
+
+        response_objects = []
+        response.each do |obj|
+          response_objects << self.new(obj)
+        end
+
+        response_objects
+      end
+
+      # Helper method for method_missing and the find_* virtual methods that
+      # parses part of a method name and arguments into a hash usuable for the
+      # API calls
+      def class_name.parse_attributes(attrs, args)
+        attrs = attrs.split('_and_')
+        attrs_with_args = attrs.zip(args)
+        Hash[attrs_with_args]
+      end
+
+      # Provide a means to check if the searchable module can respond to
+      # virtual methods, could be more accurate by checking to ensure the
+      # attributes exist
+      def class_name.respond_to?(method)
+        case method.to_s
+          when /^find_by_(.*)$/
+            true
+          when /^find_all_by_(.*)$/
+            true
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/action_kit_api/user.rb

@@ -0,0 +1,41 @@
+require 'action_kit_api'
+
+module ActionKitApi
+  class User < ApiDataModel
+    include Searchable
+    
+    # Required
+    attr_accessor :id, :email, :first_name, :last_name, :zip
+    
+    # Other/Active
+    attr_accessor :address1, :address2, :akid, :city, :country, :created_at,
+                  :custom_fields, :lang, :middle_name, :password, :plus4,
+                  :postal, :prefix, :rand_id, :region, :state_name, :source,
+                  :state, :subscription_status, :suffix, :token, :updated_at
+
+    def initialize(*args)
+      @required_attrs = [:email, :first_name, :last_name, :zip]
+      super
+    end
+
+    # Below are methods that haven't been completed yet, but shouldn't
+    # be difficult the functionality is all there in the API, they just weren't
+    # important for us to use RIGHT NOW
+
+    #def subscribed?(list_id = nil)
+    #end
+
+    #def subscriptions
+    #end
+
+    #def subscription_history
+    #end
+
+    #def unsubscribe(list_id)
+    #end
+
+    #def unsubscribe_all
+    #end
+  end 
+end
+

data/lib/action_kit_api/version.rb

@@ -0,0 +1,3 @@
+module ActionKitApi
+  VERSION = "0.1.0"
+end

data/spec/connections/action_kit_api_connection_spec.rb

@@ -0,0 +1,24 @@
+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
+

data/spec/remote_certificates_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+# These are tricky because they don't really verify much on our end and use
+# command line utilities to do the verification, however if we aren't checking
+# this if ActionKit changes their server certificate it will break our gem and
+# need to be fixed by supplying new Certificate Authority information.
+
+# These tests are not run by default. To run them add the --tag @certificates
+
+describe "Remote API Server Certificate", :certificates => true do
+  it "should be valid using system's certificates" do
+    command_output = `echo "" | 
+      openssl s_client -connect dfa.actionkit.com:443 2>&1 | 
+      grep "Verify return code"`
+    command_output =~ /[a-zA-Z]+: ([0-9]+)/
+    $1.to_i.should == 0
+  end
+
+  it "should be valid using this gem's certificates" do
+    command_output = `echo "" |
+      openssl s_client -CAfile lib/action_kit_api/actionkit_ca_chain.pem -connect dfa.actionkit.com:443 2>&1 |
+      grep "Verify return code"`
+    command_output =~ /[a-zA-Z]+: ([0-9]+)/
+    $1.to_i.should == 0
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+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

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: action_kit_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sam Stelfox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Provides encapsulated object access through the ActionKit API
+email: 
+- sstelfox@democracyforamerica.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- 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/step_definitions/user_steps.rb
+- features/support/env.rb
+- lib/action_kit_api.rb
+- lib/action_kit_api/action.rb
+- lib/action_kit_api/actionkit_ca_chain.pem
+- lib/action_kit_api/connection.rb
+- lib/action_kit_api/data_model.rb
+- lib/action_kit_api/page.rb
+- lib/action_kit_api/page_types/import.rb
+- lib/action_kit_api/page_types/petition.rb
+- lib/action_kit_api/page_types/signup.rb
+- lib/action_kit_api/page_types/unsubscribe.rb
+- 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/remote_certificates_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://democracyforamerica.com/
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: action_kit_api
+rubygems_version: 1.3.6
+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/step_definitions/user_steps.rb
+- features/support/env.rb
+- spec/connections/action_kit_api_connection_spec.rb
+- spec/remote_certificates_spec.rb
+- spec/spec_helper.rb