chubasaweber 0.0.0

data/lib/aweber/resources/followup.rb

@@ -0,0 +1,24 @@
+module AWeber
+  module Resources
+    class Followup < Resource
+      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
+    end
+  end
+end

data/lib/aweber/resources/integration.rb

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

data/lib/aweber/resources/link.rb

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

data/lib/aweber/resources/list.rb

@@ -0,0 +1,86 @@
+module AWeber
+  module Resources
+    class List < Resource
+      FOLLOWUP_TYPE_LINK  = File.join(AWeber.api_url, "#followup_campaign")
+      BROADCAST_TYPE_LINK = File.join(AWeber.api_url, "#broadcast_campaign")
+      
+      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
+      has_many :web_form_split_tests
+      
+      def initialize(*args)
+        super(*args)
+        @campaigns  = {}
+        @followups  = nil
+        @broadcasts = nil
+      end
+      
+      def campaigns
+        return @campaigns unless @campaigns == {}
+        create_followups
+        create_broadcasts
+        populate_campaigns
+        @campaigns
+      end
+      
+      def broadcasts
+        campaigns if @broadcasts.nil?
+        @broadcasts
+      end
+      
+      def followups
+        campaigns if @followups.nil?
+        @followups
+      end
+      
+    private
+      
+      def create_followups
+        followups  = _entries.select { |entry| is_followup? entry }
+        @followups = Collection.new(client, Followup, {
+          "entries"            => followups, 
+          "total_size"         => followups.length,
+          "resource_type_link" => FOLLOWUP_TYPE_LINK
+        })
+      end
+      
+      def create_broadcasts
+        broadcasts  = _entries.select { |entry| is_broadcast? entry }
+        @broadcasts = Collection.new(client, Broadcast, {
+          "entries"            => broadcasts, 
+          "total_size"         => broadcasts.length,
+          "resource_type_link" => BROADCAST_TYPE_LINK
+        })
+      end
+      
+      def populate_campaigns
+        @followups.each  { |id, followup|  @campaigns[id] = followup  }
+        @broadcasts.each { |id, broadcast| @campaigns[id] = broadcast }
+      end
+      
+      def is_followup?(entry)
+        entry["resource_type_link"].split("#").last =~ /^followup/
+      end
+      
+      def is_broadcast?(entry)
+        entry["resource_type_link"].split("#").last =~ /^broadcast/
+      end
+      
+      def _campaigns
+        @_campaigns ||= client.get(@campaigns_collection_link)
+      end
+      
+      def _entries
+        _campaigns["entries"]
+      end
+      
+    end
+  end
+end

data/lib/aweber/resources/message.rb

@@ -0,0 +1,20 @@
+module AWeber
+  module Resources
+    class Message < Resource
+      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
+      
+      has_many :tracked_events
+      has_many :opens
+      
+      alias_attribute :events, :tracked_events
+    end
+  end
+end

data/lib/aweber/resources/open.rb

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

data/lib/aweber/resources/subscriber.rb

@@ -0,0 +1,28 @@
+module AWeber
+  module Resources
+    class Subscriber < Resource
+      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
+      
+      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
+      
+      alias_attribute :is_verified?, :is_verified
+      alias_attribute :notes, :misc_notes
+    end
+  end
+end

data/lib/aweber/resources/tracked_event.rb

@@ -0,0 +1,13 @@
+module AWeber
+  module Resources
+    class TrackedEvent < Resource
+      api_attr :event_time
+      api_attr :type
+      api_attr :subscriber_link
+      
+      has_one :subscriber
+    
+      alias_attribute :time, :event_time
+    end
+  end
+end

data/lib/aweber/resources/web_form.rb

@@ -0,0 +1,14 @@
+module AWeber
+  module Resources
+    class WebForm < Resource
+      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

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

data/lib/aweber/resources/web_form_split_test_component.rb

@@ -0,0 +1,20 @@
+module AWeber
+  module Resources
+    class WebFormSplitTestComponent < Resource
+      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
+      
+      alias_attribute :is_active?, :is_active
+    end
+  end
+end

data/lib/chubasaweber.rb

@@ -0,0 +1,66 @@
+require "forwardable"
+require "oauth"
+
+module AWeber
+  API_VERSION  = "1.0".freeze
+  AUTH_VERSION = "1.0".freeze
+
+  # Used for +has_many+ and +has_one+ relationships.
+  #
+  INFLECTIONS  = {
+    :accounts             => :Account,
+    :clicks               => :Click,
+    :links                => :Link,
+    :lists                => :List,
+    :messages             => :Message,
+    :opens                => :Open,
+    :subscribers          => :Subscriber,
+    :tracked_events       => :TrackedEvent,
+    :integrations         => :Integration,
+    :web_forms            => :WebForm,
+    :components           => :WebFormSplitTestComponent,
+    :web_form_split_tests => :WebFormSplitTest,
+    :last_followup_sents  => :Followup
+  }
+
+  class << self
+    # @param [String] Base URL of the API server
+    #
+    attr_accessor :api_endpoint
+
+    # @param [String] Base URL of the Auth server
+    #
+    attr_accessor :auth_endpoint
+
+    def api_url
+      File.join api_endpoint, API_VERSION
+    end
+
+    def auth_url
+      File.join auth_endpoint, AUTH_VERSION
+    end
+
+    # Retrieves the Resource class based on the
+    # +INFLECTIONS+ map and +name+.
+    #
+    # @param [Symbol] name Collection name
+    #
+    def get_class(name)
+      Resources.const_get(INFLECTIONS[name])
+    end
+  end
+
+  @api_endpoint  = "https://api.aweber.com"
+  @auth_endpoint = "https://auth.aweber.com"
+
+  class OAuthError < Exception; end
+  class NotFoundError < Exception; end
+  class UnknownRequestError < Exception; end
+end
+
+$LOAD_PATH << File.dirname(__FILE__) unless $LOAD_PATH.include?(File.dirname(__FILE__))
+require "aweber/oauth"
+require "aweber/base"
+require "aweber/resource"
+require "aweber/resources"
+require "aweber/collection"

data/spec/base_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AWeber::Base do
+  before :each do
+    @oauth  = AWeber::OAuth.new("token", "secret")
+    @aweber = AWeber::Base.new(@oauth)
+  end
+  
+  it "should have an account" do
+    @aweber.account.should be_an AWeber::Resources::Account
+  end
+  
+  it "should expand uris to full paths" do
+    resp = @oauth.get("https://api.aweber.com/1.0/accounts")
+    @oauth.should_receive(:get).with("https://api.aweber.com/1.0/accounts").and_return(resp)
+    @aweber.account
+  end
+  
+  it "should delegate to the oauth object" do
+    @oauth.should_receive(:get).with("https://api.aweber.com/1.0/foo")
+    @aweber.send(:get, "/foo")
+  end
+end

data/spec/collection_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AWeber::Collection do
+  
+  before :each do
+    @oauth  = AWeber::OAuth.new("token", "secret")
+    @aweber = AWeber::Base.new(@oauth)
+    data    = ActiveSupport::JSON.decode(fixture("lists.json"))
+    @lists  = AWeber::Collection.new(@aweber, AWeber::Resources::List, data)
+  end
+  
+  it "should create classes from the one passed into initialize" do
+    @lists[1].should be_an AWeber::Resources::List
+  end
+  
+  it "should be iterable" do
+    @lists.should respond_to :each
+    @lists.map { |id, l| id }.should be_an Array
+  end
+  
+  it "should be accessible via id in normal Hash form" do
+    @lists[1].id.should == 1
+  end
+  
+  it "should retrieve more resources, if needed, when being iterated over" do
+    list_ids = @lists.map{ |id, list| list }
+    list_ids.length.should == 3
+    list_ids.all? { |e| e.is_a? AWeber::Resources::List }.should == true
+  end
+  
+  it "should return single entries with dynamic find_by methods" do
+    @lists.find_by_id(1).should be_an AWeber::Resources::List
+    @lists.find_by_id(1).id.should == 1
+  end
+  
+  it "should return Hashes of entries when find_by methods match many" do
+    lists = @lists.find_by_resource_type_link("https://api.aweber.com/1.0/#list")
+    lists.length.should == 3
+  end
+end

data/spec/fixtures/account.json

@@ -0,0 +1,8 @@
+{
+    "http_etag": "\"356a192b7913b04c54574d18c28d46e6395428ab-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+    "lists_collection_link": "https://api.aweber.com/1.0/accounts/1/lists",
+    "self_link": "https://api.aweber.com/1.0/accounts/1",
+    "resource_type_link": "https://api.aweber.com/1.0/#account",
+    "id": 1,
+    "integrations_collection_link": "https://api.aweber.com/1.0/accounts/1/integrations"
+}

data/spec/fixtures/accounts.json

@@ -0,0 +1,13 @@
+{
+    "total_size": 1,
+    "start": 0,
+    "resource_type_link": "https://api.aweber.com/1.0/#accounts",
+    "entries": [{
+        "http_etag": "\"356a192b7913b04c54574d18c28d46e6395428ab-ca5feee2b7fbb6febfca8af5541541ea960aaedb\"",
+        "lists_collection_link": "https://api.aweber.com/1.0/accounts/1/lists",
+        "self_link": "https://api.aweber.com/1.0/accounts/1",
+        "resource_type_link": "https://api.aweber.com/1.0/#account",
+        "id": 1,
+        "integrations_collection_link": "https://api.aweber.com/1.0/accounts/1/integrations"
+    }]
+}

data/spec/fixtures/campaign.json

@@ -0,0 +1,23 @@
+{
+    "click_tracking_enabled": 0,
+    "sent_date": null,
+    "is_archived": true,
+    "spam_assassin_score": null,
+    "http_etag": "\"14a1a033beff462b137a8222f595af4622875d44-ccadae5b53f02d3db0cc83ca57ae75ac804b2b98\"",
+    "total_undeliverable": null,
+    "twitter_account_link": null,
+    "total_opens": 0,
+    "links_collection_link": "http://api.apitest.lab/1.0/accounts/1/lists/1/campaigns/b2/links",
+    "total_clicks": 0,
+    "published_to_archive": null,
+    "messages_collection_link": "http://api.apitest.lab/1.0/accounts/1/lists/1/campaigns/b2/messages",
+    "send_date": "2010-22-12T22:15:00-07:00",
+    "content_type": "HTML",
+    "total_sent": 0,
+    "self_link": "http://api.apitest.lab/1.0/accounts/1/lists/1/campaigns/b2",
+    "subject": "Something about stuff.",
+    "resource_type_link": "http://api.apitest.lab/1.0/#broadcast_campaign",
+    "id": 2,
+    "total_unsubscribes": 0,
+    "total_spam_complaints": null
+}