action_kit_api 0.2.1 → 0.2.2

data/README.md

@@ -1,18 +1,47 @@
-## 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.
+# ActionKit API #
+
+This Gem provides a wrapper for the ActionKit API in a way that should feel pretty familiar if you're used to ActiveRecord (though this does not use or require ActiveRecord). I found that none existed and what we were using in our own code base was rough, undocumented and didn't conform to any expectations and it was failing in unusual and unpredictable ways. This is here to solve OUR problems and with any luck other people will be able to get some value out of it as well.
+
+We intend to open up the repository on GitHub as soon as we're sure nothing sensitive leaked into it. In the mean time if you have suggestions for improvements, feature requests, or bug fixes please email me at: sstelfox at democracyforamerica dot com.
+
+## Features ##
+
+Currently implemented:
+
+  * Individual User Searching
+  * Individual Page Searching (any type)
+  * Searching on Page types: Petition, Signup, and Unsubscribe
+  * Creating new Users, PetitionPages, SignupPages, and UnsubscribePages
+  * Updating existing User and Page attributes
+  * Taking Actions
+
+For Future releases:
+
+  * find\_all\_by\_* for all models (currently beta and limited to 1000 results/query)
+  * count on queries
+  * Support for all page types
+  * Validation logic on individual fields (all models)
+
+## Known Issues/Bugs ##
+
+  * Currently overriding parts of XMLRPC standard library for our own ends, this may result in unexpected behaivior for applications that include this Gem and are using XMLRPC directly elsewhere, though the changes are fairly minor (User agent, and error code type validation).
+
+## Usage ##
+
+*Coming Soon*
+
+## Testing Instructions ##
+
+This Gem uses Cucumber for high-level integration and remote requests, while RSpec is for low level functionality and specifications. The RSpec tests do not require access to the actual API, everything is mocked out (with the exception of the certificate verification but that doesn't require credentials). To use **most** of the cucumber tests you need to have valid credentials for use with the ActionKit API. You can get more information on how to setup an API user in ActionKit's documentation. You need to place your credentials in /features/support/credentials.rb from the root of the Gem's directory. The Cucumber tests *WILL* create new users, pages, sign up users for pages and things that might otherwise affect 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.
+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
+    # live ActionKit. This file will never live in the repository.
 
     ACTIONKIT_HOSTNAME=""
     ACTIONKIT_USERNAME=""
     ACTIONKIT_PASSWORD=""
+

data/lib/action_kit_api.rb

@@ -34,7 +34,7 @@ module ActionKitApi
       "akid" => user.akid,
     })
 
-    @@connection.call('act', act_attrs)
+    response = @@connection.call('act', act_attrs)
 
     ActionKitApi::Action.new(response)
   end

data/lib/action_kit_api/action.rb

@@ -8,9 +8,9 @@ module ActionKitApi
     attr_accessor :id, :page, :user
 
     # Other/Active
-    attr_accessor :created_at, :created_user, :custom_fields, :link, :mailing,
+    attr_accessor :created_user, :custom_fields, :link, :mailing,
                   :opq_id, :referring_mailing, :referring_user, :source, :status,
-                  :subscribed_user, :taf_emails_sent, :updated_at
+                  :subscribed_user, :taf_emails_sent
 
     def initialize(*args)
       @required_attrs = [:page, :user]

data/lib/action_kit_api/connection.rb

@@ -1,10 +1,9 @@
 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 :)
-
+# A few minor tweaks to the XMLRPC standard library. There has to be a better way
+# to handle some of what this is doing without going all Chuck Norris on the standard
+# library. Once this library has it's full feature set I'll come back to these and dig
+# deep into the bowels of XMLRPC and find a way to improve this. Suggestions welcome.
 module XMLRPC
   # This seems silly and dangerous right? Overwriting something in the ruby
   # standard libraries? Well ActionKit is doing XMLRPC wrong. This is almost
@@ -37,7 +36,7 @@ module XMLRPC
     USER_AGENT = "DFA Ruby action_kit_api/#{ActionKitApi::VERSION} ( http://code.democracyforamerica.com/ )"
   end
 
-  # This was need to prevent empty responses from the remote
+  # This was needed to prevent an empty response from the remote
   # server from triggering an exception on calls
   module Config
     remove_const(:ENABLE_NIL_PARSER)
@@ -45,6 +44,10 @@ module XMLRPC
   end
 end
 
+# This is 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 Connection
     def initialize(user, password, host)

data/lib/action_kit_api/data_model.rb

@@ -5,6 +5,9 @@ module ActionKitApi
   end
 
   class ApiDataModel
+    # All the different types of objects have at least these
+    attr_accessor :created_at, :updated_at
+
     def initialize(hash = {})
       @required_attrs ||= []
 

data/lib/action_kit_api/user.rb

@@ -8,10 +8,10 @@ module ActionKitApi
     attr_accessor :id, :email, :first_name, :last_name, :zip
     
     # Other/Active
-    attr_accessor :address1, :address2, :akid, :city, :country, :created_at,
+    attr_accessor :address1, :address2, :akid, :city, :country,
                   :custom_fields, :lang, :middle_name, :password, :plus4,
                   :postal, :prefix, :rand_id, :region, :state_name, :source,
-                  :state, :subscription_status, :suffix, :token, :updated_at
+                  :state, :subscription_status, :suffix, :token
 
     def initialize(*args)
       @required_attrs = [:email, :first_name, :last_name, :zip]

data/lib/action_kit_api/version.rb

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

data/spec/connection/connection_spec.rb

@@ -6,8 +6,4 @@ describe ActionKitApi::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/page/page_model_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module AKAPageSpecHelper
+  def validPageAttributes
+    {
+      :name => "test_page",
+      :title => "A Test Page",
+      :type => "petition"
+    }
+  end
+end
+
+describe ActionKitApi::Page do
+  include AKAPageSpecHelper
+
+  before(:each) do
+    @page = ActionKitApi::Page.new
+  end
+
+  it "should not have a type" do
+    @page.type.should be_nil
+  end
+
+  it "should be valid with valid attributes" do
+    @page.update(validPageAttributes)
+    @page.should be_valid
+  end
+
+  it "should verify that a name is required" do
+    @page.update(validPageAttributes.except(:name))
+    @page.should_not be_valid
+  end
+
+  it "should verify that a title is required" do
+    @page.update(validPageAttributes.except(:title))
+    @page.should_not be_valid
+  end
+
+  it "should verify that a type is required" do
+    @page.update(validPageAttributes.except(:type))
+    @page.should_not be_valid
+  end
+
+  it "should not allow arbitrary attributes to be added" do
+    @page.update({"fake_attr" => "with some data"})
+    page_hash = @page.to_hash
+
+    page_hash.should_not include("fake_attr")
+  end
+
+  it "should return it's attributes as a hash" do
+    @page.update(validPageAttributes)
+    page_hash = @page.to_hash
+
+    page_hash.should eql(validPageAttributes)
+  end
+
+end

data/spec/page/page_types_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module AKAPageSpecHelper
+  def validPageAttributes
+    {
+      :name => "test_page",
+      :title => "A Test Page",
+    }
+  end
+end
+
+describe ActionKitApi::PetitionPage do
+  include AKAPageSpecHelper
+  
+  before(:each) do
+    @page = ActionKitApi::PetitionPage.new
+  end
+
+  it "should have a type of 'petition'" do
+    @page.type.should eql('petition')
+  end
+
+  it "should be valid with valid attributes" do
+    @page.update(validPageAttributes)
+    @page.should be_valid
+  end
+
+end
+
+describe ActionKitApi::SignupPage do
+  include AKAPageSpecHelper
+  
+  before(:each) do
+    @page = ActionKitApi::SignupPage.new
+  end
+
+  it "should have a type of 'signup'" do
+    @page.type.should eql('signup')
+  end
+  
+  it "should be valid with valid attributes" do
+    @page.update(validPageAttributes)
+    @page.should be_valid
+  end
+
+end
+
+describe ActionKitApi::UnsubscribePage do
+  include AKAPageSpecHelper
+  
+  before(:each) do
+    @page = ActionKitApi::UnsubscribePage.new
+  end
+
+  it "should have a type of 'unsubscribe'" do
+    @page.type.should eql('unsubscribe')
+  end
+  
+  it "should be valid with valid attributes" do
+    @page.update(validPageAttributes)
+    @page.should be_valid
+  end
+
+end
+

data/spec/user/user_model_spec.rb

@@ -18,6 +18,11 @@ describe ActionKitApi::User do
     @user = ActionKitApi::User.new
   end
 
+  it "should be valid with valid attributes" do
+    @user.update(validUserAttributes)
+    @user.should be_valid
+  end
+
   it "should verify that an email is required" do
     @user.update(validUserAttributes.except(:email))
     @user.should_not be_valid

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Sam Stelfox
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-05 00:00:00 -05:00
+date: 2012-03-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,8 @@ files:
 - lib/action_kit_api/user.rb
 - lib/action_kit_api/version.rb
 - spec/connection/connection_spec.rb
+- spec/page/page_model_spec.rb
+- spec/page/page_types_spec.rb
 - spec/remote_certificates_spec.rb
 - spec/spec_helper.rb
 - spec/user/user_model_spec.rb
@@ -121,6 +123,8 @@ test_files:
 - features/users/find_a_user.feature
 - features/users/update_a_user.feature
 - spec/connection/connection_spec.rb
+- spec/page/page_model_spec.rb
+- spec/page/page_types_spec.rb
 - spec/remote_certificates_spec.rb
 - spec/spec_helper.rb
 - spec/user/user_model_spec.rb