interspire 0.1.0 → 0.1.1

data/README.md

@@ -20,7 +20,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The API class requires 3 parameters; the API URL of your Interspire installation, a username, and that username's token.
+This information can be found under the 'Users & Groups' menu on your Interspire installation.
+You might have to enable API access for the user.
+
+    api_url = 'http://example.com/xml.php'
+    user    = 'luser'
+    token   = 'some_valid_api_token'
+
+    api = Interspire::API.new(api_url, user, token)
+
+    # Get an array of Interspire::ContactList objects:
+    api.get_lists  # => [#<Interspire::ContactList:0x8bc6cb0 @id="7", @name="List Foo", ...
+
+See the {Interspire::API} class for documentation on the available methods.
 
 ## Contributing
 

data/lib/interspire.rb

@@ -4,5 +4,5 @@ require "interspire/interspire_exception"
 require "interspire/subscriber"
 
 module Interspire
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/interspire/api.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'nokogiri'
 
 module Interspire
+  # TODO: The methods expecting a list ID should also accept a ContactList object.
   class API
 
     # @param api_url [String] The XML API of your Interspire installation; ex. http://example.com/xml.php
@@ -142,7 +143,7 @@ module Interspire
 
       if success?(response)
         subscribers = {}
-        subscribers[:count] = response.xpath('response/data/count').first.content
+        subscribers[:count] = response.xpath('response/data/count').first.content.to_i
         subscribers[:subscribers] = []
 
         response.xpath('response/data').each do |data|

data/spec/interspire/api_spec.rb

@@ -47,6 +47,7 @@ describe Interspire::API do
 
       # Make sure there's a count.
       subscribers[:count].should_not be_nil
+      subscribers[:count].should be_a(Integer)
 
       # Make sure the required values are there:
       subscribers[:subscribers].each do |subscriber|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: interspire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &82085980 !ruby/object:Gem::Requirement
+  requirement: &80803630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *82085980
+  version_requirements: *80803630
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &82085610 !ruby/object:Gem::Requirement
+  requirement: &80803380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82085610
+  version_requirements: *80803380
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &82085360 !ruby/object:Gem::Requirement
+  requirement: &80803110 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82085360
+  version_requirements: *80803110
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &82085080 !ruby/object:Gem::Requirement
+  requirement: &80802850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *82085080
+  version_requirements: *80802850
 description: Ruby library for the Interspire API.
 email:
 - oshuma@gmail.com
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 942893455
+      hash: 316495037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 942893455
+      hash: 316495037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10