aweber 1.0.0 → 1.1.0

data/Gemfile

@@ -1,9 +1,2 @@
 source :rubygems
-gem "oauth"
-gem "json_pure"
-
-group :development do
-  gem "fakeweb"
-  gem "rspec", "2.0.0.beta.22"
-  gem "yard",  "~> 0.6.1"
-end
+gemspec

data/Gemfile.lock

@@ -1,3 +1,10 @@
+PATH
+  remote: .
+  specs:
+    aweber (1.1.0)
+      json_pure
+      oauth
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -5,24 +12,23 @@ GEM
     fakeweb (1.3.0)
     json_pure (1.4.6)
     oauth (0.4.4)
-    rspec (2.0.0.beta.22)
-      rspec-core (= 2.0.0.beta.22)
-      rspec-expectations (= 2.0.0.beta.22)
-      rspec-mocks (= 2.0.0.beta.22)
-    rspec-core (2.0.0.beta.22)
-    rspec-expectations (2.0.0.beta.22)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.22)
-      rspec-core (= 2.0.0.beta.22)
-      rspec-expectations (= 2.0.0.beta.22)
-    yard (0.6.3)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    yard (0.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aweber!
   fakeweb
   json_pure
   oauth
-  rspec (= 2.0.0.beta.22)
-  yard (~> 0.6.1)
+  rspec (~> 2.1.0)
+  yard (~> 0.6.0)

data/README.textile

@@ -10,25 +10,45 @@ h2. Quick Start
 
 First, go to "http://labs.aweber.com":http://labs.aweber.com and sign up for a free AWeber Labs account. This is how you register apps and get OAuth keys.
 
-bc. # Register an app and use it's Consumer key and secret:
+bc.. # Register an app and use it's Consumer key and secret:
 oauth = AWeber::OAuth.new("consumer_key", "consumer_secret")
+
 # Go to the URL the following outputs.
 oauth.request_token.authorize_url 
+
 # Authorize your account and copy the verification code.
 oauth.authorize_with_verifier("verification_code")
-aweber  = AWeber::Base.new(oauth)
-account = aweber.account
-account.lists # Start getting data
 
-Take a look at "examples":http://github.com/aweber/aweber-ruby/tree/master/examples/ for more examples.
+# Grab an AWeber::Base object and get movin'
+aweber = AWeber::Base.new(oauth)
+aweber.account.lists[123456].name
+
+p. Take a look at "examples":http://github.com/aweber/aweber-ruby/tree/master/examples/ for more examples.
 
 h2. Getting Data
 
 Every piece of data from AWeber's API stems from an Account object. From there you access associated resources in the same way you would an ActiveRecord accosication:
 
 bc. account.lists #=> #<AWeber::Collection(AWeber::Resource::List)>
-account.lists[1] #=> #<AWeber::Resource::List>
-account.lists[1].web_forms #=> #<AWeber::Collection(AWeber::Resource::WebForm)>
+account.lists[1]  #=> #<AWeber::Resource::List>
+
+h2. Modifying Subscribers
+
+Currently, only certain attributes of Subscribers are writable:
+
+* name
+* misc_notes
+* email (yes email)
+* status
+* last_followup_message_number_sent
+* custom_fields (Hash of key/value pairs)
+* ad_tracking
+
+h3. Example
+
+bc. subscriber = account.lists[654321].subscribers[123456]
+subscriber.name = "New Name"
+subscriber.save
 
 h2. Note on Patches/Pull Requests
  

data/Rakefile

@@ -1,6 +1,6 @@
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |s|
-  s.rspec_opts = ["--color"]
+  s.rspec_opts = ["--fail-fast", "--color"]
 end
 
 require 'yard'

data/aweber.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name         = "aweber"
-  s.version      = "1.0.0"
+  s.version      = "1.1.0"
   s.platform     = Gem::Platform::RUBY
   s.summary      = "Ruby interface to AWeber's API"
   s.description  = "Ruby interface to AWeber's API"
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
   s.add_dependency "json_pure"
   
   s.add_development_dependency "fakeweb"
-  s.add_development_dependency "rspec", ">= 2.0.0"
-  s.add_development_dependency "yard", "~> 0.6.1"
+  s.add_development_dependency "rspec", "~> 2.1.0"
+  s.add_development_dependency "yard",  "~> 0.6.0"
 end
 

data/lib/aweber/base.rb

@@ -8,15 +8,23 @@ module AWeber
     def account
       accounts.first.last
     end
-
-  private
-
+    
     def get(uri)
       response = oauth.get(expand(uri))
       handle_errors(response, uri)
       parse(response) if response
     end
     
+    def delete(uri)
+      oauth.delete(expand(uri))
+    end
+    
+    def put(uri, body={})
+      oauth.put(uri, body.to_json, {"Content-Type" => "application/json"})
+    end
+
+  private
+    
     def handle_errors(response, uri)
       if response.is_a? Net::HTTPNotFound
         raise NotFoundError, "Invalid resource uri.", caller
@@ -32,9 +40,9 @@ module AWeber
     def expand(uri)
       parsed = URI.parse(uri)
       url = []
-      url << AWeber.api_endpoint unless parsed.host
+      url << AWeber.api_endpoint
       url << API_VERSION unless parsed.path.include? API_VERSION
-      url << uri
+      url << parsed.path
       File.join(*url)
     end
 

data/lib/aweber/resource.rb

@@ -14,9 +14,8 @@ module AWeber
     extend Forwardable
     include Comparable
 
-    def_delegators :client, :get
-
     class << self
+      attr_accessor :writable_attrs
       # Works the same as +alias_method+, but for attributes created via
       # +attr*+ methods.
       #
@@ -24,6 +23,29 @@ module AWeber
         alias_method alias_, attribute
       end
       
+      # Defines an attribute that it either read only or writable.
+      # 
+      # == Example:
+      # 
+      #   # Read-only
+      #   api_attr :name
+      # 
+      #   # Writable
+      #   api_attr :name, :writable => true
+      # 
+      # If an attribute is writable it will be sent with the request when
+      # +save+ is called.
+      # 
+      def api_attr(attr_, opts={})
+        if opts[:writable]
+          attr_accessor attr_
+          @writable_attrs ||= []
+          @writable_attrs << attr_
+        else
+          attr_reader attr_
+        end
+      end
+      
       def has_one(name)
         define_method(name) do
           ivar = instance_variable_get("@#{name}")
@@ -31,7 +53,7 @@ module AWeber
           
           resource_link = instance_variable_get("@#{name}_link")
           klass         = AWeber.get_class(:"#{name}s")
-          collection    = klass.new(client, get(resource_link))
+          collection    = klass.new(client, client.get(resource_link))
           instance_variable_set("@#{name}", collection)
         end
       end
@@ -57,16 +79,16 @@ module AWeber
 
           resource_link = instance_variable_get("@#{name}_collection_link")
           klass         = AWeber.get_class(name)
-          collection    = Collection.new(client, klass, get(resource_link))
+          collection    = Collection.new(client, klass, client.get(resource_link))
           instance_variable_set("@#{name}", collection)
         end
       end
     end
 
-    attr_reader :id
-    attr_reader :http_etag
-    attr_reader :self_link
-    attr_reader :resource_type_link
+    api_attr :id
+    api_attr :http_etag
+    api_attr :self_link
+    api_attr :resource_type_link
 
     alias_attribute :etag, :http_etag
     alias_attribute :link, :self_link
@@ -78,6 +100,22 @@ module AWeber
         instance_variable_set("@#{key}", value) if respond_to? key
       end
     end
+    
+    def delete
+      client.delete(@self_link)
+    end
+    
+    def save
+      body = writable_attrs.inject({}) do |body, attr_|
+        body[attr_] = send(attr_)
+        body
+      end
+      client.put(self_link, body)
+    end
+    
+    def writable_attrs
+      self.class.writable_attrs ||= {}
+    end
 
     def <=>(other)
       @id <=> other.id

data/lib/aweber/resources/account.rb

@@ -1,8 +1,8 @@
 module AWeber
   module Resources
     class Account < Resource
-      attr_reader :lists_collection_link
-      attr_reader :integrations_collection_link
+      api_attr :lists_collection_link
+      api_attr :integrations_collection_link
     
       has_many :lists
       has_many :integrations

data/lib/aweber/resources/broadcast.rb

@@ -1,23 +1,23 @@
 module AWeber
   module Resources
     class Broadcast < Resource
-      attr_reader :click_tracking_enabled
-      attr_reader :content_type
-      attr_reader :is_archived
-      attr_reader :scheduled_at
-      attr_reader :sent_at
-      attr_reader :spam_assassin_score
-      attr_reader :subject
-      attr_reader :total_clicks
-      attr_reader :total_opens
-      attr_reader :total_sent
-      attr_reader :total_spam_complaints
-      attr_reader :total_undelivered
-      attr_reader :total_unsubscribes
-      attr_reader :twitter_account_link
+      api_attr :click_tracking_enabled
+      api_attr :content_type
+      api_attr :is_archived
+      api_attr :scheduled_at
+      api_attr :sent_at
+      api_attr :spam_assassin_score
+      api_attr :subject
+      api_attr :total_clicks
+      api_attr :total_opens
+      api_attr :total_sent
+      api_attr :total_spam_complaints
+      api_attr :total_undelivered
+      api_attr :total_unsubscribes
+      api_attr :twitter_account_link
 
-      attr_reader :links_collection_link
-      attr_reader :messages_collection_link
+      api_attr :links_collection_link
+      api_attr :messages_collection_link
 
       has_many :links
       has_many :messages

data/lib/aweber/resources/click.rb

@@ -1,9 +1,9 @@
 module AWeber
   module Resources
     class Click < Resource
-      attr_reader :event_time
-      attr_reader :is_earliest
-      attr_reader :subscriber_link
+      api_attr :event_time
+      api_attr :is_earliest
+      api_attr :subscriber_link
       
       has_one :subscriber
       

data/lib/aweber/resources/followup.rb

@@ -1,21 +1,21 @@
 module AWeber
   module Resources
     class Followup < Resource
-      attr_reader :click_tracking_enabled
-      attr_reader :content_type
-      attr_reader :message_interval
-      attr_reader :message_number
-      attr_reader :spam_assassin_score
-      attr_reader :subject
-      attr_reader :total_clicked
-      attr_reader :total_opened
-      attr_reader :total_sent
-      attr_reader :total_spam_complaints
-      attr_reader :total_undelivered
-      attr_reader :total_unsubscribes
-      
-      attr_reader :links_collection_link
-      attr_reader :messages_collection_link
+      api_attr :click_tracking_enabled
+      api_attr :content_type
+      api_attr :message_interval
+      api_attr :message_number
+      api_attr :spam_assassin_score
+      api_attr :subject
+      api_attr :total_clicked
+      api_attr :total_opened
+      api_attr :total_sent
+      api_attr :total_spam_complaints
+      api_attr :total_undelivered
+      api_attr :total_unsubscribes
+
+      api_attr :links_collection_link
+      api_attr :messages_collection_link
       
       has_many :links
       has_many :messages

data/lib/aweber/resources/integration.rb

@@ -1,8 +1,8 @@
 module AWeber
   module Resources
     class Integration < Resource
-      attr_reader :login
-      attr_reader :service_name
+      api_attr :login
+      api_attr :service_name
     end
   end
 end

data/lib/aweber/resources/link.rb

@@ -1,10 +1,10 @@
 module AWeber
   module Resources
     class Link < Resource
-      attr_reader :total_clicks
-      attr_reader :total_unique_clicks
-      attr_reader :url
-      attr_reader :clicks_collection_link
+      api_attr :total_clicks
+      api_attr :total_unique_clicks
+      api_attr :url
+      api_attr :clicks_collection_link
       
       has_many :clicks
     end

data/lib/aweber/resources/list.rb

@@ -4,12 +4,12 @@ module AWeber
       FOLLOWUP_TYPE_LINK  = File.join(AWeber.api_url, "#followup_campaign")
       BROADCAST_TYPE_LINK = File.join(AWeber.api_url, "#broadcast_campaign")
       
-      attr_reader :name
-      
-      attr_reader :campaigns_collection_link
-      attr_reader :subscribers_collection_link
-      attr_reader :web_forms_collection_link
-      attr_reader :web_form_split_tests_collection_link
+      api_attr :name
+
+      api_attr :campaigns_collection_link
+      api_attr :subscribers_collection_link
+      api_attr :web_forms_collection_link
+      api_attr :web_form_split_tests_collection_link
       
       has_many :subscribers
       has_many :web_forms
@@ -74,7 +74,7 @@ module AWeber
       end
       
       def _campaigns
-        @_campaigns ||= get(@campaigns_collection_link)
+        @_campaigns ||= client.get(@campaigns_collection_link)
       end
       
       def _entries

data/lib/aweber/resources/message.rb

@@ -1,13 +1,13 @@
 module AWeber
   module Resources
     class Message < Resource
-      attr_reader :event_time
-      attr_reader :last_opened
-      attr_reader :total_opens
-      
-      attr_reader :subscriber_link
-      attr_reader :tracked_events_collection_link
-      attr_reader :opens_collection_link
+      api_attr :event_time
+      api_attr :last_opened
+      api_attr :total_opens
+
+      api_attr :subscriber_link
+      api_attr :tracked_events_collection_link
+      api_attr :opens_collection_link
       
       has_one :subscriber
       

data/lib/aweber/resources/open.rb

@@ -1,8 +1,8 @@
 module AWeber
   module Resources
     class Open < Resource
-      attr_reader :event_time
-      attr_reader :subscriber_link
+      api_attr :event_time
+      api_attr :subscriber_link
       
       has_one :subscriber
     end

data/lib/aweber/resources/subscriber.rb

@@ -1,21 +1,23 @@
 module AWeber
   module Resources
     class Subscriber < Resource
-      attr_reader :ad_tracking
-      attr_reader :email
-      attr_reader :ip_address
-      attr_reader :is_verified
-      attr_reader :last_followup_sent_at
-      attr_reader :misc_notes
-      attr_reader :name
-      attr_reader :status
-      attr_reader :subscribed_at
-      attr_reader :subscription_method
-      attr_reader :subscription_url
-      attr_reader :unsubscribed_at
-      attr_reader :verified_at
+      api_attr :name,          :writable => true
+      api_attr :misc_notes,    :writable => true
+      api_attr :email,         :writable => true
+      api_attr :status,        :writable => true
+      api_attr :custom_fields, :writable => true
+      api_attr :ad_tracking,   :writable => true
+      api_attr :last_followup_message_number_sent, :writable => true
       
-      attr_reader :last_followup_sent_link
+      api_attr :ip_address
+      api_attr :is_verified
+      api_attr :last_followup_sent_at
+      api_attr :subscribed_at
+      api_attr :subscription_method
+      api_attr :subscription_url
+      api_attr :unsubscribed_at
+      api_attr :verified_at
+      api_attr :last_followup_sent_link
       
       has_one :last_followup_sent
       

data/lib/aweber/resources/tracked_event.rb

@@ -1,9 +1,9 @@
 module AWeber
   module Resources
     class TrackedEvent < Resource
-      attr_reader :event_time
-      attr_reader :type
-      attr_reader :subscriber_link
+      api_attr :event_time
+      api_attr :type
+      api_attr :subscriber_link
       
       has_one :subscriber
     

data/lib/aweber/resources/web_form.rb

@@ -1,14 +1,14 @@
 module AWeber
   module Resources
     class WebForm < Resource
-      attr_reader :conversion_percentage
-      attr_reader :is_active
-      attr_reader :name
-      attr_reader :total_displays
-      attr_reader :total_submissions
-      attr_reader :total_unique_displays
-      attr_reader :type
-      attr_reader :unique_conversion_percentage
+      api_attr :conversion_percentage
+      api_attr :is_active
+      api_attr :name
+      api_attr :total_displays
+      api_attr :total_submissions
+      api_attr :total_unique_displays
+      api_attr :type
+      api_attr :unique_conversion_percentage
     end
   end
 end

data/lib/aweber/resources/web_form_split_test.rb

@@ -1,9 +1,9 @@
 module AWeber
   module Resources
     class WebFormSplitTest < Resource
-      attr_reader :components_collection_link
-      attr_reader :is_active
-      attr_reader :name
+      api_attr :components_collection_link
+      api_attr :is_active
+      api_attr :name
       
       has_many :components
     end

data/lib/aweber/resources/web_form_split_test_component.rb

@@ -1,16 +1,16 @@
 module AWeber
   module Resources
     class WebFormSplitTestComponent < Resource
-      attr_reader :conversion_percentage
-      attr_reader :is_active
-      attr_reader :name
-      attr_reader :total_displays
-      attr_reader :total_submissions
-      attr_reader :total_unique_displays
-      attr_reader :type
-      attr_reader :unique_conversion_percentage
-      attr_reader :web_form_link
-      attr_reader :weight
+      api_attr :conversion_percentage
+      api_attr :is_active
+      api_attr :name
+      api_attr :total_displays
+      api_attr :total_submissions
+      api_attr :total_unique_displays
+      api_attr :type
+      api_attr :unique_conversion_percentage
+      api_attr :web_form_link
+      api_attr :weight
       
       has_one :web_form
       

data/spec/fixtures/lists_page_2.json

@@ -0,0 +1,38 @@
+{
+    "total_size": 6,
+    "start": 4,
+    "resource_type_link": "https://api.aweber.com/1.0/#list-page-resource",
+    "entries": [{
+        "campaigns_collection_link": "/accounts/1/lists/4565456/campaigns",
+        "name": "asdsa456464",
+        "web_form_split_tests_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/4565456/web_form_split_tests",
+        "subscribers_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/4565456/subscribers",
+        "id": 4565456,
+        "http_etag": "\"4ab41e60d14ea138a4522b3d2896942b7335c13c - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+        "self_link": "https://api.aweber.com/1.0/accounts/1/lists/4565456",
+        "resource_type_link": "https://api.aweber.com/1.0/#list",
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/4565456/web_forms"
+    },
+    {
+        "campaigns_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/8975612/campaigns",
+        "name": "default8975612",
+        "web_form_split_tests_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/8975612/web_form_split_tests",
+        "subscribers_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/8975612/subscribers",
+        "id": 8975612,
+        "http_etag": "\"685c00e3983add5e4efb5ca3bc7294e247f6e9fe - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+        "self_link": "https://api.aweber.com/1.0/accounts/1/lists/8975612",
+        "resource_type_link": "https://api.aweber.com/1.0/#list",
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/8975612/web_forms"
+    },
+    {
+        "campaigns_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/12357254/campaigns",
+        "name": "default123572549",
+        "web_form_split_tests_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/12357254/web_form_split_tests",
+        "subscribers_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/12357254/subscribers",
+        "id": 12357254,
+        "http_etag": "\"0aaa38a50287df08ccb74c7f13fca8679aab688a - ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+        "self_link": "https://api.aweber.com/1.0/accounts/1/lists/12357254",
+        "resource_type_link": "https://api.aweber.com/1.0/#list",
+        "web_forms_collection_link": "https://api.aweber.com/1.0/accounts/1/lists/12357254/web_forms"
+    }]
+}

data/spec/resource_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 class FakeResource < AWeber::Resource
   attr_accessor :foo
+  api_attr :name, :writable => true
   alias_attribute :bar, :foo
   has_many :lists
 end
@@ -58,4 +59,22 @@ describe AWeber::Resource do
     fake1.should_not == fake3
   end
   
+  it "should be deleted" do
+    fake = FakeResource.new(@aweber, JSON.parse(fixture("account.json")))
+    @oauth.should_receive(:delete).with(fake.link)
+    fake.delete
+  end
+  
+  it "should declare writable attributes" do
+    resource = FakeResource.new(@aweber)
+    resource.writable_attrs.include?(:name).should be_true
+  end
+  
+  it "should send a JSON respresentation of the object on save" do
+    resource = FakeResource.new(@aweber)
+    @oauth.should_receive(:put).with(resource.link, "{\"name\":\"Bob\"}")
+    resource.name = "Bob"
+    resource.save
+  end
+  
 end

data/spec/resources/subscriber_spec.rb

@@ -22,4 +22,12 @@ describe AWeber::Resources::Subscriber do
   it { should respond_to :subscription_url }
   it { should respond_to :unsubscribed_at }
   it { should respond_to :verified_at }
+  
+  its(:writable_attrs) { should include :name }
+  its(:writable_attrs) { should include :misc_notes }
+  its(:writable_attrs) { should include :email }
+  its(:writable_attrs) { should include :status }
+  its(:writable_attrs) { should include :custom_fields }
+  its(:writable_attrs) { should include :ad_tracking }
+  its(:writable_attrs) { should include :last_followup_message_number_sent }
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - AWeber Communications, Inc.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -05:00
+date: 2011-01-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,13 +62,13 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 2
+        - 1
         - 0
-        - 0
-        version: 2.0.0
+        version: 2.1.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -82,8 +82,8 @@ dependencies:
         segments: 
         - 0
         - 6
-        - 1
-        version: 0.6.1
+        - 0
+        version: 0.6.0
   type: :development
   version_requirements: *id005
 description: Ruby interface to AWeber's API
@@ -138,6 +138,7 @@ files:
 - spec/fixtures/links.json
 - spec/fixtures/list.json
 - spec/fixtures/lists.json
+- spec/fixtures/lists_page_2.json
 - spec/fixtures/message.json
 - spec/fixtures/messages.json
 - spec/fixtures/open.json
@@ -215,6 +216,7 @@ test_files:
 - spec/fixtures/links.json
 - spec/fixtures/list.json
 - spec/fixtures/lists.json
+- spec/fixtures/lists_page_2.json
 - spec/fixtures/message.json
 - spec/fixtures/messages.json
 - spec/fixtures/open.json