aweber 1.2.0 → 1.3.0

data/Gemfile.lock

@@ -23,6 +23,7 @@ GEM
     yard (0.6.4)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/LICENSE

@@ -1,20 +1,25 @@
-Copyright (c) 2010 AWeber Communications, Inc.
+Copyright (c) 2010-2011, AWeber Communications, Inc.
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of AWeber Communications, Inc. nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL AWEBER COMMUNICATIONS, INC. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-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.textile

@@ -109,4 +109,4 @@ h2. Note on Patches/Pull Requests
 
 h2. Copyright
 
-Copyright (c) 2010 AWeber Communications, Inc. See LICENSE for more detail.
+Copyright (c) 2010-2011 AWeber Communications, Inc. See LICENSE for more detail.

data/aweber.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name         = "aweber"
-  s.version      = "1.2.0"
+  s.version      = "1.3.0"
   s.platform     = Gem::Platform::RUBY
   s.summary      = "Ruby interface to AWeber's API"
   s.description  = "Ruby interface to AWeber's API"

data/lib/aweber.rb

@@ -13,6 +13,7 @@ module AWeber
     :clicks               => :Click,
     :links                => :Link,
     :lists                => :List,
+    :custom_fields        => :CustomField,
     :campaigns            => :Campaign,
     :messages             => :Message,
     :opens                => :Open,

data/lib/aweber/base.rb

@@ -20,7 +20,7 @@ module AWeber
     end
     
     def post(uri, body={})
-      oauth.post(uri, body)
+      oauth.post(expand(uri), body)
     end
     
     def put(uri, body={})

data/lib/aweber/collection.rb

@@ -58,6 +58,19 @@ module AWeber
 
       self.class.new(client, @klass, response)
     end
+    
+    def create(attrs={})
+      params   = attrs.merge("ws.op" => "create")
+      response = client.post(path, params)
+      
+      return false unless response.is_a? Net::HTTPCreated
+      
+      response = JSON.parse(response.body)
+      resource = get(response["location"]).merge(:parent => self)
+      resource = @klass.new(client, resource)
+      
+      self[resource.id] = resource
+    end
 
     def [](id)
       @entries[id] ||= fetch_entry(id)

data/lib/aweber/resource.rb

@@ -137,7 +137,7 @@ module AWeber
     end
     
     def inspect
-      %(#<AWeber::Resources::#{self.class} id="#{id}" />)
+      %(#<#{self.class} id="#{id}" />)
     end
 
   private

data/lib/aweber/resources.rb

@@ -4,6 +4,7 @@ require "aweber/resources/click"
 require "aweber/resources/followup"
 require "aweber/resources/link"
 require "aweber/resources/list"
+require "aweber/resources/custom_field"
 require "aweber/resources/campaign"
 require "aweber/resources/message"
 require "aweber/resources/open"

data/lib/aweber/resources/list.rb

@@ -12,8 +12,10 @@ module AWeber
       api_attr :subscribers_collection_link
       api_attr :web_forms_collection_link
       api_attr :web_form_split_tests_collection_link
+      api_attr :custom_fields_collection_link
       
       has_many :campaigns
+      has_many :custom_fields
       has_many :subscribers
       has_many :web_forms
       has_many :web_form_split_tests

data/spec/collection_spec.rb

@@ -1,10 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe AWeber::Collection do
-  before :each do
+  before do
     @oauth  = AWeber::OAuth.new("token", "secret")
     @aweber = AWeber::Base.new(@oauth)
-    data    = JSON.parse(fixture("lists.json"))
+    data    = JSON.parse(fixture("lists.json")).merge(:parent => @aweber.account)
     @lists  = AWeber::Collection.new(@aweber, AWeber::Resources::List, data)
   end
   
@@ -38,7 +38,7 @@ describe AWeber::Collection do
   end
   
   it "should have a path to its collection alone" do
-    @lists.path.should == "/lists"
+    @lists.path.should == "/accounts/1/lists"
   end
   
   it "should create resource with itself as a parent" do
@@ -76,4 +76,26 @@ describe AWeber::Collection do
       @collection.search(:name => "default123456").parent.should be @collection.parent
     end
   end
+  
+  describe "when creating" do
+    let(:params) {{ "ws.op" => "create", :name => "foo" }}
+    
+    it "should set the operation to 'create'" do
+      @aweber.should_receive(:post).with(@lists.path, params)
+      @lists.create(:name => "foo")
+    end
+    
+    it "should return false if the create failed" do
+      @oauth.should_receive(:post).and_return(nil)
+      @lists.create(:name => "foo").should == false
+    end
+    
+    it "should return the new object if the create succeeded" do
+      @lists.create(:name => "foo").should be_an AWeber::Resource
+    end
+    
+    it "should have the collection as a parent" do
+      @lists.create(:name => "foo").parent.should == @lists
+    end
+  end
 end

data/spec/fixtures/custom_field.json

@@ -0,0 +1,8 @@
+{
+    "http_etag": "\"356a192b7913b04c54574d18c28d46e6395428ab-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+    "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1/custom_fields/1",
+    "resource_type_link": "https://api.aweber.com/1.0/#custom_field",
+    "id": 1,
+    "name": "Signature",
+    "is_subscriber_updateable": "false"
+}

data/spec/fixtures/custom_fields.json

@@ -0,0 +1,23 @@
+{
+    "total_size": 2,
+    "start": 0,
+    "resource_type_link": "https://api.aweber.com/1.0/#custom_fields",
+    "entries": [
+        {
+            "http_etag": "\"356a192b7913b04c54574d18c28d46e6395428ab-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+            "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1/custom_fields/1",
+            "resource_type_link": "https://api.aweber.com/1.0/#custom_field",
+            "id": 1,
+            "name": "Signature",
+            "is_subscriber_updateable": "false"
+        },
+        {
+            "http_etag": "\"356a192b7913b04c54574d18c28d46e6395428ab-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+            "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1/custom_fields/2",
+            "resource_type_link": "https://api.aweber.com/1.0/#custom_field",
+            "id": 2,
+            "name": "logourl",
+            "is_subscriber_updateable": "false"
+        }
+    ]
+}

data/spec/fixtures/list.json

@@ -7,5 +7,6 @@
     "http_etag": "\"0aaa38a50287df08ccb74c7f13fca8679aab688a-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
     "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679",
     "resource_type_link": "https://api.aweber.com/1.0/#list",
-    "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/web_forms"
+    "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/web_forms",
+    "custom_fields_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/custom_fields"
 }

data/spec/fixtures/lists.json

@@ -11,7 +11,8 @@
         "http_etag": "\"4ab41e60d14ea138a4522b3d2896942b7335c13c - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
         "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1553018",
         "resource_type_link": "https://api.aweber.com/1.0/#list",
-        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1553018/web_forms"
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1553018/web_forms",
+        "custom_fields_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1553018/custom_fields"
     },
     {
         "campaigns_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550685/campaigns",
@@ -22,7 +23,8 @@
         "http_etag": "\"685c00e3983add5e4efb5ca3bc7294e247f6e9fe - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
         "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1550685",
         "resource_type_link": "https://api.aweber.com/1.0/#list",
-        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550685/web_forms"
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550685/web_forms",
+        "custom_fields_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550685/custom_fields"
     },
     {
         "campaigns_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/campaigns",
@@ -33,6 +35,7 @@
         "http_etag": "\"0aaa38a50287df08ccb74c7f13fca8679aab688a - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
         "self_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679",
         "resource_type_link": "https://api.aweber.com/1.0/#list",
-        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/web_forms"
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/web_forms",
+        "custom_fields_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/1550679/custom_fields"
     }]
 }

data/spec/resources/custom_field_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe AWeber::Resources::CustomField do
+  include BaseObjects
+  subject { aweber.account.lists[1].custom_fields[1] }
+  
+  its(:path) { should == "/accounts/1/lists/1/custom_fields/1" }
+  
+  it { should respond_to :name }
+  it { should respond_to :is_subscriber_updateable }
+  it { should respond_to :is_subscriber_updateable? }
+end

data/spec/spec_helper.rb

@@ -11,8 +11,8 @@ def aweber_url(url)
   url =~ /https/ ? url : File.join(AWeber.api_endpoint, "1.0", url)
 end
 
-def route(method, uri, response)
-  FakeWeb.register_uri(method, uri, :body => response)
+def route(method, uri, body="", opts={})
+  FakeWeb.register_uri(method, uri, opts.merge(:body => body))
 end
 
 def fixture(filename)
@@ -40,6 +40,9 @@ route :any, "https://auth.aweber.com/1.0/access_token",  "oauth_token=fake&oauth
 
 route :get, %r[/accounts\?], fixture("accounts.json")
 route :get, %r[/accounts/\d+/lists\?], fixture("lists.json")
+route :get, %r[/accounts/\d+/lists/\d+\?], fixture("list.json")
+route :get, %r[/accounts/\d+/lists/\d+/custom_fields\?], fixture("custom_fields.json")
+route :get, %r[/accounts/\d+/lists/\d+/custom_fields/\d+\?], fixture("custom_field.json")
 route :get, %r[/accounts/\d+/lists/\d+/subscribers\?], fixture("subscribers.json")
 route :get, %r[/accounts/\d+/lists/\d+/web_forms\?], fixture("web_forms.json")
 route :get, %r[/accounts/\d+/lists/\d+/web_form_split_tests\?], fixture("web_form_split_tests.json")
@@ -52,4 +55,5 @@ route :get, %r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages\?], fixture("m
 route :get, %r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages/\d+/opens\?], fixture("opens.json")
 route :get, %r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages/\d+/tracked_events\?], fixture("tracked_events.json")
 
-route :post, %r[/accounts/\d+/lists/\d+/subscribers/\d+], "201 Created"
+route :post, %r[/accounts/\d+/lists\?], %[{"location":"https://api.aweber.com/1.0/accounts/1/lists/1550679"}], :status => ["201", "Created"]
+route :post, %r[/accounts/\d+/lists/\d+/subscribers/\d+], "201 Created", :status => ["201", "Created"]

data/spec/support/spec_routing.rb

@@ -0,0 +1,46 @@
+module SpecRouting
+  def self.included(base)
+    SpecRouting.setup_fixtures
+  end
+
+  class << self
+    def get(uri, &block)
+      FakeWeb.register_uri(:get, uri, :body => block.call)
+    end
+
+    def any(uri, &block)
+      FakeWeb.register_uri(:any, uri, :body => block.call)
+    end
+
+    def resource(name)
+      fixture(name, "resources")
+    end
+
+    def fixture(name, subdir="")
+      fixtures = Pathname.new(File.dirname(__FILE__) + "/fixtures/#{subdir}")
+      fixtures += "#{name}.json"
+      fixtures.read.gsub(/[\s\n]/, '')
+    end
+
+    def setup_fixtures
+      any("https://auth.aweber.com/1.0/request_token") { "oauth_token=fake&oauth_token_secret=fake" }
+      any("https://auth.aweber.com/1.0/access_token")  { "oauth_token=fake&oauth_token_secret=fake" }
+
+      get(%r[/cars]) { fixture(:cars) }
+
+      get(%r[/accounts\?])                                                             { resource(:accounts) }
+      get(%r[/accounts/\d+/integrations\?])                                            { resource(:integrations) }
+      get(%r[/accounts/\d+/lists\?])                                                   { resource(:lists) }
+      get(%r[/accounts/\d+/lists/\d+/subscribers\?])                                   { resource(:subscribers) }
+      get(%r[/accounts/\d+/lists/\d+/web_forms\?])                                     { resource(:web_forms) }
+      get(%r[/accounts/\d+/lists/\d+/web_form_split_tests\?])                          { resource(:web_form_split_tests) }
+      get(%r[/accounts/\d+/lists/\d+/web_form_split_tests/\d+/components\?])           { resource(:web_form_split_test_components) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns\?])                                     { resource(:campaigns) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/links\?])                       { resource(:links) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/links/\d+/clicks\?])            { resource(:clicks) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages\?])                    { resource(:messages) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages/\d+/opens\?])          { resource(:opens) }
+      get(%r[/accounts/\d+/lists/\d+/campaigns/[\d\w]+/messages/\d+/tracked_events\?]) { resource(:tracked_events) }
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - AWeber Communications, Inc.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 -04:00
+date: 2011-04-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -132,6 +132,8 @@ files:
 - spec/fixtures/campaigns.json
 - spec/fixtures/click.json
 - spec/fixtures/clicks.json
+- spec/fixtures/custom_field.json
+- spec/fixtures/custom_fields.json
 - spec/fixtures/integration.json
 - spec/fixtures/integrations.json
 - spec/fixtures/link.json
@@ -157,6 +159,7 @@ files:
 - spec/resources/account_spec.rb
 - spec/resources/campaign_spec.rb
 - spec/resources/click_spec.rb
+- spec/resources/custom_field_spec.rb
 - spec/resources/integration_spec.rb
 - spec/resources/link_spec.rb
 - spec/resources/list_spec.rb
@@ -169,6 +172,7 @@ files:
 - spec/resources/web_form_split_test_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_classes.rb
+- spec/support/spec_routing.rb
 has_rdoc: true
 homepage: http://github.com/aweber/AWeber-API-Ruby-Library
 licenses: []
@@ -210,6 +214,8 @@ test_files:
 - spec/fixtures/campaigns.json
 - spec/fixtures/click.json
 - spec/fixtures/clicks.json
+- spec/fixtures/custom_field.json
+- spec/fixtures/custom_fields.json
 - spec/fixtures/integration.json
 - spec/fixtures/integrations.json
 - spec/fixtures/link.json
@@ -235,6 +241,7 @@ test_files:
 - spec/resources/account_spec.rb
 - spec/resources/campaign_spec.rb
 - spec/resources/click_spec.rb
+- spec/resources/custom_field_spec.rb
 - spec/resources/integration_spec.rb
 - spec/resources/link_spec.rb
 - spec/resources/list_spec.rb
@@ -247,3 +254,4 @@ test_files:
 - spec/resources/web_form_split_test_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_classes.rb
+- spec/support/spec_routing.rb